code challenge: setup daily reminder emails

Author: usrbinsam

CodeChallenge/api/eb.py

@@ -1,11 +1,6 @@
-from hmac import compare_digest
-
-import requests
-from flask import Blueprint, request, current_app, render_template
-from flask_mail import Message
+from flask import Blueprint, current_app
 
 from .. import core
-from ..mail import mail
 from ..mailgun import mg_send
 from ..models import Users
 
@@ -18,42 +13,6 @@ def eb_health_check():
  return "OK", 200
 
 
-# POST request from an AWS Lambda function once per day
-# any daily tasks should be placed here
-@bp.route("/worker", methods=["POST"])
-def worker():
- try:
- password = request.json["password"]
- except (TypeError, KeyError):
- return "", 400
-
- if not compare_digest(password, current_app.config["WORKER_PASSWORD"]):
- return "", 401
-
- # send daily reminder emails only while challenge is active, up until the first day of the final challenge
- if 1 <= core.day_number() <= core.max_rank():
- msg = Message(
- "New code challenge question is unlocked!",
- sender=current_app.config["MAIL_DEFAULT_SENDER"],
- recipients=[current_app.config["MG_LIST"]],
- )
-
- msg.html = render_template(
- "challenge_daily_email.html",
- name="%recipient_fname%",
- external_url=current_app.config["EXTERNAL_URL"],
- )
- msg.extra_headers = {"List-Unsubscribe": "%unsubscribe_email%"}
-
- mail.send(msg)
-
- elif core.challenge_ended():
- # TODO: email everyone individually how many votes they have
- pass
-
- return "", 200
-
-
 @bp.route("/teacher/progress", methods=["POST"])
 def teacher_progress():
  """Send daily emails to teachers of their student's progress."""
@@ -64,3 +23,11 @@ def teacher_progress():
  mg_send([teacher.parent_email], "Code Challenge Student Progress", body)
 
  return "", 200
+
+
+@bp.route("/daily", methods=["POST"])
+def daily_email():
+ if current_app.config["DAILY_EMAILS"] and 1 <= core.day_number() <= core.max_rank():
+ # Users.fire_daily_reminder()
+ return "OK", 200
+ return "Challenge not active", 200

CodeChallenge/cli/email.py

@@ -4,7 +4,8 @@
 from flask import Blueprint, current_app, render_template
 from flask_mail import Message
 from jinja2 import Environment, FileSystemLoader, meta
-
+from CodeChallenge.mailgun import mg_list_delete, mg_bulk_add, mg_create_list
+from CodeChallenge.models import Users
 from ..mail import mail
 
 bp = Blueprint("emailcli", __name__, cli_group="email")
@@ -24,9 +25,11 @@ def get_template_variables(filename):
 @click.argument("subject")
 @click.argument("template")
 def email_send(to, subject, template):
- msg = Message(subject=subject,
- recipients=[to],
- sender=current_app.config["MAIL_DEFAULT_SENDER"])
+ msg = Message(
+ subject=subject,
+ recipients=[to],
+ sender=current_app.config["MAIL_DEFAULT_SENDER"],
+ )
  msg.extra_headers = {"List-Unsubscribe": "%unsubscribe_email%"}
 
  filled_vars = {}
@@ -42,3 +45,44 @@ def email_send(to, subject, template):
  mail.send(msg)
 
  click.secho("message sent", fg="green")
+
+
+@bp.cli.command("build-list")
+def build_mg_list():
+ list_name = current_app.config["MG_LIST"]
+
+ if list_name is None:
+ click.secho("MG_LIST not set in config", fg="red", err=True)
+ return
+
+ page = 0
+ size = 500
+
+ click.secho(f"(re)creating list: {list_name}", fg="blue")
+
+ try:
+ mg_list_delete(list_name)
+ mg_create_list(list_name)
+ except Exception as e:
+ click.secho(f"list recreation failed: {str(e)}", err=True, fg="red")
+ return
+
+ while True:
+ offset = page * size
+ click.secho(f"loading page {page} offset {offset}", fg="blue")
+
+ click.secho(f"generating recipient-variables", fg="blue")
+ members = []
+ for user in Users.query.limit(size).offset(offset).all():
+ members.extend(user.mg_member())
+
+ click.secho(f"uploading batch to Mailgun")
+ click.secho(str(mg_bulk_add(list_name, members)), fg="magenta")
+
+ if len(members) < size:
+ click.secho("no more pages to load", fg="yellow")
+ break
+
+ page += 1
+
+ click.secho("Done", fg="green")

CodeChallenge/config.py

@@ -34,6 +34,7 @@ class DefaultConfig:
  SLACK_SIGNING_SECRET = os.getenv("SLACK_SIGNING_SECRET")
  SLACK_OAUTH_TOKEN = os.getenv("SLACK_OAUTH_TOKEN")
  SLACK_CHANNEL = os.getenv("SLACK_CHANNEL")
+ DAILY_EMAILS = False
 
  # no trailing /
  EXTERNAL_URL = "https://challenge.codewizardshq.com"
@@ -79,6 +80,7 @@ class ProductionConfig(DefaultConfig):
  MG_LIST = os.getenv("MG_LIST")
  ANSWER_ATTEMPT_LIMIT = "5 per 1 minutes"
  VOTING_DISABLED = True
+ DAILY_EMAILS = os.getenv("DAILY_EMAILS") != ""
 
 
 class DevelopmentConfig(ProductionConfig):
@@ -96,6 +98,7 @@ class DevelopmentConfig(ProductionConfig):
  MAIL_SUPPRESS_SEND = False
  TESTING = True
  TEST_EMAIL_RECIPIENT = "sam@codewizardshq.com"
+ MG_LIST = "codechallenge-test@school.codewizardshq.com"
 
  @property
  def DIST_DIR(self):

CodeChallenge/mailgun.py

@@ -33,6 +33,17 @@ def mg_list_add(email_address, name, data=None):
  return r
 
 
+def mg_list_delete(list_address: str):
+ """Delete the given Mailing List name from Mailgun."""
+ response = requests.delete(
+ f"https://api.mailgun.net/v3/lists/{list_address}",
+ auth=__auth(),
+ )
+
+ if not response.ok and response.status_code != 404:
+ response.raise_for_status()
+
+
 def mg_validate(email_address):
  r = requests.get(
  "https://api.mailgun.net/v4/address/validate",
@@ -135,3 +146,23 @@ def mg_lists():
  response.raise_for_status()
 
  return response.json()["items"]
+
+
+def mg_bulk_add(list_name: str, users: list):
+ response = requests.post(
+ f"https://api.mailgun.net/v3/lists/{list_name}/members.json",
+ auth=__auth(),
+ data={"upsert": True, "members": json.dumps(users)},
+ )
+ response.raise_for_status()
+ return response.json()
+
+
+def mg_create_list(list_name: str):
+ response = requests.post(
+ "https://api.mailgun.net/v3/lists",
+ auth=__auth(),
+ data={"address": list_name, "description": "Code Challenge Participants"},
+ )
+ response.raise_for_status()
+ return response.json()

CodeChallenge/models.py

@@ -315,7 +315,7 @@ def send_confirmation_email(self, password=None):
  password=password,
  )
 
- def _mg_vars(self):
+ def mg_recipient_vars(self):
  return dict(
  codeChallengeUsername=self.username,
  studentEmail=self.student_email,
@@ -325,21 +325,33 @@ def _mg_vars(self):
  parentFirstName=self.parent_first_name,
  parentLastName=self.parent_last_name,
  parentName=f"{self.parent_first_name} {self.parent_last_name}",
- userId=self.id,
- studentDOB=self.dob,
- type="",
  )
 
  def add_to_mailing_list(self, list_name: str):
- for i, addr in enumerate(self._mail_recipients()):
- mg_vars = self._mg_vars()
-
- if i == 0:
- mg_vars["type"] = "parent"
- else:
- mg_vars["type"] = "student"
+ for addr in self._mail_recipients():
+ mg_list_add(addr, list_name, self.mg_recipient_vars())
+
+ def mg_member(self) -> list[dict]:
+ mg_vars = self.mg_recipient_vars()
+
+ members = [
+ {
+ "name": self.parent_first_name,
+ "address": self.parent_email,
+ "vars": mg_vars,
+ }
+ ]
+
+ if self.student_email:
+ members.append(
+ {
+ "name": self.student_first_name,
+ "address": self.student_email,
+ "vars": mg_vars,
+ }
+ )
 
-  mg_list_add(addr, list_name, mg_vars)
+ return members
 
  def generate_password(self):
  """Generate a random password. Set's the user's password to the generated_students value,
@@ -457,6 +469,14 @@ def to_csv(self) -> Tuple[str, ...]:
  def lookup_teacher(cls, email: str):
  return cls.query.filter_by(is_teacher=True, parent_email=email).first()
 
+ @classmethod
+ def fire_daily_reminder(cls):
+ mg_send(
+ [current_app.config["MG_LIST"]],
+ "New code challenge question is unlocked!",
+ render_template("challenge_daily.html"),
+ )
+
  def render_progress_report(self):
  assert self.is_teacher
  students = Users.query.filter_by(teacher_id=self.id).all()