Refactor email reminder code
- Pull out email generation into a new module so that the email message itself can be tested. - Add a "backdoor" for the email login screen that writes emails to text files under test_emails/ instead of sending them. - Add a GNU expect script to automate email reminder testing using the above features.
This commit is contained in:
Charlie Wang
parent
6ed3c35554
commit
bff0abf3aa
|
|
@ -1,2 +1,3 @@
|
|||
*.pyc
|
||||
/build-library/
|
||||
/test_emails/
|
||||
|
|
|
|||
1
TODO
1
TODO
|
|
@ -36,6 +36,7 @@ Support UTF-8 for everything
|
|||
Search ignores Case (for lowercase search strings)
|
||||
Text entry supports longer string
|
||||
Home and End navigate to top and bottom of catalogue respectively.
|
||||
Email reminders for signed-out books
|
||||
|
||||
Support for multiple copies
|
||||
- books will have their book_id written in pencil on inside cover
|
||||
|
|
|
|||
|
|
@ -0,0 +1,34 @@
|
|||
def format_reminder_email(quest_id: str,
|
||||
days_signed_out: int,
|
||||
librarian_name: str,
|
||||
book_name) -> str:
|
||||
"""
|
||||
Formats an email as a plain string for sending out email reminders
|
||||
for signed out books.
|
||||
|
||||
Example: _send_email("s455wang", "2017-02-04", 30, "csfmurph", "How to Design Programs")
|
||||
"""
|
||||
|
||||
email_message_body = \
|
||||
"""Hi {},
|
||||
|
||||
Our records indicate that you have had the book {} signed out for {} days.
|
||||
|
||||
Please return the book to the CS Club office (MC 3036) at your earliest convenience.
|
||||
|
||||
Thanks,
|
||||
|
||||
{}
|
||||
Computer Science Club | University of Waterloo
|
||||
librarian@csclub.uwaterloo.ca""".format(
|
||||
quest_id,
|
||||
book_name,
|
||||
days_signed_out,
|
||||
librarian_name
|
||||
)
|
||||
|
||||
email_message_subject = "Overdue book: {}".format(book_name)
|
||||
email_message = "Subject: {}\n\n{}".format(email_message_subject,
|
||||
email_message_body)
|
||||
return email_message
|
||||
|
||||
|
|
@ -8,7 +8,7 @@ import argparse
|
|||
import sys
|
||||
|
||||
#Import datetime and time to check dates
|
||||
from datetime import date
|
||||
from datetime import datetime
|
||||
import time
|
||||
|
||||
#Import getpass for password input
|
||||
|
|
@ -21,12 +21,17 @@ import subprocess
|
|||
from library import permissions
|
||||
from library.exceptions import *
|
||||
import library.database as db
|
||||
from library.interface.form import FormWindow,BookForm, LoginForm, catch_error_with, error_form
|
||||
from library.interface.form import FormWindow, BookForm, LoginForm, catch_error_with, error_form
|
||||
from library.emails import format_reminder_email
|
||||
|
||||
# email testing folder creation
|
||||
import os
|
||||
|
||||
#Constants
|
||||
DEFAULT_DAY_VALUE = 21
|
||||
MAX_LOGIN_ATTEMPTS = 3
|
||||
|
||||
|
||||
class DaysForm(FormWindow):
|
||||
caption = "Enter the max number of days a book can be signed out for"
|
||||
blabel = "Enter"
|
||||
|
|
@ -47,35 +52,40 @@ class NameForm(FormWindow):
|
|||
else:
|
||||
return self.entries[0].value
|
||||
|
||||
#Private functions
|
||||
def _send_email(quest_id: str, signed_out_date: str, max_days_can_be_signed_out:int, librarianName: str, book_name_list) -> None:
|
||||
"""Sends an email to quest_id@csclub.uwaterloo.ca if the date the book
|
||||
was signed out exceeds the days it is supposed to be signed out for"""
|
||||
|
||||
#Private functions
|
||||
def _send_email(quest_id: str,
|
||||
signed_out_date: str,
|
||||
max_days_can_be_signed_out: int,
|
||||
librarian_name: str,
|
||||
book_name_list,
|
||||
testing=False) -> None:
|
||||
"""Sends an email to quest_id@csclub.uwaterloo.ca if the date the book
|
||||
was signed out exceeds the days it is supposed to be signed out for.
|
||||
|
||||
Set testing to true to output emails to the current directory, instead
|
||||
of actually sending them.
|
||||
"""
|
||||
|
||||
# Determine the days the book has been signed out
|
||||
d = datetime.strptime(signed_out_date, "%Y-%m-%d")
|
||||
days_signed_out = (d.today() - d).days
|
||||
|
||||
if days_signed_out > max_days_can_be_signed_out:
|
||||
email_address = quest_id + "@csclub.uwaterloo.ca"
|
||||
book_name = "".join(book_name_list)
|
||||
|
||||
#Determine the days the book has been signed out
|
||||
date_tokens = signed_out_date.split("-")
|
||||
date_signed_out = date(int(date_tokens[0]), int(date_tokens[1]), int(date_tokens[2]))
|
||||
days_signed_out = date.fromtimestamp(time.time()) - date_signed_out
|
||||
|
||||
if days_signed_out.days > max_days_can_be_signed_out:
|
||||
email_message_body = ("Hi " + quest_id + ",\n\n" + "Our records indicate that you "
|
||||
"have had the book " + book_name + " signed out for " + str(str(days_signed_out).split(" ")[:1])[2:-2] +
|
||||
" days.\n\n" + "Please return the book to the CS Club office "
|
||||
"(MC 3036) at your earliest convenience.\n\n" + "Thanks,\n\n" +
|
||||
librarianName + "\n" + "Computer Science Club | University of Waterloo\n"
|
||||
"librarian@csclub.uwaterloo.ca")
|
||||
|
||||
email_message_subject = "Overdue book: {}".format(book_name)
|
||||
email_message = "Subject: {}\n\n{}".format(email_message_subject, email_message_body)
|
||||
|
||||
email_message = format_reminder_email(quest_id, days_signed_out, librarian_name, book_name)
|
||||
if testing:
|
||||
os.makedirs("test_emails", exist_ok=True)
|
||||
with open("test_emails/{}_{}.txt".format(quest_id, book_name), 'w') as f:
|
||||
print(email_message, file=f)
|
||||
else:
|
||||
server.sendmail("librarian@csclub.uwaterloo.ca", email_address, email_message)
|
||||
|
||||
|
||||
#Public functions
|
||||
@permissions.check_permissions(permissions.PERMISSION_LIBCOM)
|
||||
@catch_error_with(lambda w, hb, *args : (w, hb, None))
|
||||
@catch_error_with(lambda w, hb, *args: (w, hb, None))
|
||||
def sendemails_procedure(w, hb, cy, cx, mx):
|
||||
"""Procedure to send emails to those with overdue books
|
||||
|
||||
|
|
@ -85,9 +95,9 @@ def sendemails_procedure(w, hb, cy, cx, mx):
|
|||
"""
|
||||
|
||||
#Get the max days a book can be signed out for
|
||||
step1 = DaysForm(w,hb,width=mx-20)
|
||||
(r,c)=w.getmaxyx()
|
||||
w.mvwin(cy-r//2,cx-c//2)
|
||||
step1 = DaysForm(w, hb, width=mx - 20)
|
||||
(r, c) = w.getmaxyx()
|
||||
w.mvwin(cy - r // 2, cx - c // 2)
|
||||
days = step1.event_loop()
|
||||
step1.clear()
|
||||
|
||||
|
|
@ -96,9 +106,9 @@ def sendemails_procedure(w, hb, cy, cx, mx):
|
|||
days = DEFAULT_DAY_VALUE
|
||||
|
||||
#Get the name of the librarain
|
||||
step2 = NameForm(w,hb,width=mx-20)
|
||||
(r,c)=w.getmaxyx()
|
||||
w.mvwin(cy-r//2,cx-c//2)
|
||||
step2 = NameForm(w, hb, width=mx - 20)
|
||||
(r, c) = w.getmaxyx()
|
||||
w.mvwin(cy - r // 2, cx - c // 2)
|
||||
librarianName = step2.event_loop()
|
||||
step2.clear()
|
||||
|
||||
|
|
@ -106,20 +116,27 @@ def sendemails_procedure(w, hb, cy, cx, mx):
|
|||
global server
|
||||
server = smtplib.SMTP_SSL("mail.csclub.uwaterloo.ca", 465)
|
||||
|
||||
# don't send out emails if this is true
|
||||
testing = False
|
||||
|
||||
#Attempt to login 3 times
|
||||
loginAttempts = 0
|
||||
while loginAttempts < MAX_LOGIN_ATTEMPTS:
|
||||
|
||||
#Get the user's login info to login to the mail server
|
||||
step3 = LoginForm(w,hb,width=mx-20)
|
||||
(r,c)=w.getmaxyx()
|
||||
w.mvwin(cy-r//2,cx-c//2)
|
||||
step3 = LoginForm(w, hb, width=mx - 20)
|
||||
(r, c) = w.getmaxyx()
|
||||
w.mvwin(cy - r // 2, cx - c // 2)
|
||||
loginInfo = step3.event_loop()
|
||||
step3.clear()
|
||||
|
||||
csclubID = loginInfo[0]
|
||||
csclubPwd = loginInfo[1]
|
||||
|
||||
if csclubID == "TESTING12345":
|
||||
testing = True
|
||||
break
|
||||
|
||||
try:
|
||||
server.login(csclubID, csclubPwd)
|
||||
break
|
||||
|
|
@ -138,11 +155,12 @@ def sendemails_procedure(w, hb, cy, cx, mx):
|
|||
date = str(data["date"]).split(" ")[0]
|
||||
book_name_with_spaces = data["title"]
|
||||
|
||||
_send_email(str(quest_id), str(date), days, str(librarianName), book_name_with_spaces)
|
||||
_send_email(
|
||||
str(quest_id),
|
||||
str(date), days, str(librarianName), book_name_with_spaces,
|
||||
testing)
|
||||
|
||||
#Exit from the email server
|
||||
server.quit()
|
||||
|
||||
return ""
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,92 @@
|
|||
#!/usr/bin/expect -f
|
||||
|
||||
# Run this to test out email sending. Writes emails to text files
|
||||
# under the "test_emails" directory.
|
||||
|
||||
# To do this manually, use the UI to send emails normally but put
|
||||
# "TESTING12345" as the username. The password is thrown away.
|
||||
|
||||
#
|
||||
# This Expect script was generated by autoexpect on Sat Feb 4 11:41:53 2017
|
||||
# Expect and autoexpect were both written by Don Libes, NIST.
|
||||
#
|
||||
# Note that autoexpect does not guarantee a working script. It
|
||||
# necessarily has to guess about certain things. Two reasons a script
|
||||
# might fail are:
|
||||
#
|
||||
# 1) timing - A surprising number of programs (rn, ksh, zsh, telnet,
|
||||
# etc.) and devices discard or ignore keystrokes that arrive "too
|
||||
# quickly" after prompts. If you find your new script hanging up at
|
||||
# one spot, try adding a short sleep just before the previous send.
|
||||
# Setting "force_conservative" to 1 (see below) makes Expect do this
|
||||
# automatically - pausing briefly before sending each character. This
|
||||
# pacifies every program I know of. The -c flag makes the script do
|
||||
# this in the first place. The -C flag allows you to define a
|
||||
# character to toggle this mode off and on.
|
||||
|
||||
set force_conservative 0 ;# set to 1 to force conservative mode even if
|
||||
;# script wasn't run conservatively originally
|
||||
if {$force_conservative} {
|
||||
set send_slow {1 .1}
|
||||
proc send {ignore arg} {
|
||||
sleep .1
|
||||
exp_send -s -- $arg
|
||||
}
|
||||
}
|
||||
|
||||
#
|
||||
# 2) differing output - Some programs produce different output each time
|
||||
# they run. The "date" command is an obvious example. Another is
|
||||
# ftp, if it produces throughput statistics at the end of a file
|
||||
# transfer. If this causes a problem, delete these patterns or replace
|
||||
# them with wildcards. An alternative is to use the -p flag (for
|
||||
# "prompt") which makes Expect only look for the last line of output
|
||||
# (i.e., the prompt). The -P flag allows you to define a character to
|
||||
# toggle this mode off and on.
|
||||
#
|
||||
# Read the man page for more info.
|
||||
#
|
||||
# -Don
|
||||
|
||||
|
||||
set timeout 5
|
||||
spawn ./librarian
|
||||
match_max 100
|
||||
send -- "OB"
|
||||
send -- "OB"
|
||||
send -- "OB"
|
||||
send -- "OB"
|
||||
send -- "OB"
|
||||
send -- "OB"
|
||||
send -- "OB"
|
||||
send -- "\r"
|
||||
send -- "0"
|
||||
send -- ""
|
||||
send -- "1"
|
||||
send -- "\r"
|
||||
send -- "\r"
|
||||
send -- "T"
|
||||
send -- "E"
|
||||
send -- "S"
|
||||
send -- "T"
|
||||
send -- "\r"
|
||||
send -- "\r"
|
||||
send -- "T"
|
||||
send -- "E"
|
||||
send -- "S"
|
||||
send -- "T"
|
||||
send -- "I"
|
||||
send -- "N"
|
||||
send -- "G"
|
||||
send -- "1"
|
||||
send -- "2"
|
||||
send -- "3"
|
||||
send -- "4"
|
||||
send -- "5"
|
||||
send -- "\r"
|
||||
send -- "\r"
|
||||
send -- "\r"
|
||||
send -- "q"
|
||||
expect eof
|
||||
|
||||
send_user -- "Check the test_emails directory\n"
|
||||
Loading…
Reference in New Issue