[#2065] Confirm and decline instructor signups

Makefile

@@ -29,10 +29,10 @@ dev_database :
 	${MANAGE} migrate
 	${MANAGE} loaddata amy/autoemails/fixtures/templates_triggers.json
 	${MANAGE} loaddata amy/communityroles/fixtures/inactivations.json
+	${MANAGE} create_superuser
 	${MANAGE} fake_database
 	${MANAGE} loaddata amy/communityroles/fixtures/configs.json
 	${MANAGE} createinitialrevisions
-	${MANAGE} create_superuser
 
 ## node_modules : install front-end dependencies using Yarn
 node_modules : package.json

Pipfile

@@ -48,6 +48,8 @@ flake8 = "*"
 mypy = "*"
 black = "*"
 pre-commit = "*"
+django-stubs = "*"
+djangorestframework-stubs = "*"
 
 [requires]
 python_version = "3.9"

amy/autoemails/actions.py

@@ -2,17 +2,14 @@
 
 from datetime import date, datetime, timedelta
 import logging
-from typing import Any, Dict, Iterable, List, Mapping, Optional, Tuple, Type
+from typing import Iterable, Optional, Type
 
 from django.conf import settings
 from django.contrib.sites.models import Site
 from django.core.mail import EmailMultiAlternatives
-from django.db.models.query import QuerySet
-from django.http.request import HttpRequest
 from django.template.exceptions import TemplateDoesNotExist, TemplateSyntaxError
 import django_rq
 
-from autoemails.base_views import ActionManageMixin
 from autoemails.models import EmailTemplate, Trigger
 from autoemails.utils import compare_emails
 from consents.models import Term
@@ -24,40 +21,6 @@
 DAY_IN_SECONDS = 86400
 
 
-def send_bulk_email(
-    request: HttpRequest,
-    action_class: Type[BaseAction],
-    triggers: QuerySet[Trigger],
-    emails: List[str],
-    additional_context_objects: Mapping[Any, Any],
-    object_: Any,
-):
-    emails_to_send = [
-        emails[i : i + settings.BULK_EMAIL_LIMIT]  # noqa
-        for i in range(0, len(emails), settings.BULK_EMAIL_LIMIT)
-    ]
-    for emails in emails_to_send:
-        jobs, rqjobs = ActionManageMixin.add(
-            action_class=action_class,
-            logger=logger,
-            scheduler=scheduler,
-            triggers=triggers,
-            context_objects=dict(
-                person_emails=emails,
-                **additional_context_objects,
-            ),
-            object_=object_,
-        )
-        if triggers and jobs:
-            ActionManageMixin.bulk_schedule_message(
-                request=request,
-                num_emails=len(emails),
-                trigger=triggers[0],
-                job=jobs[0],
-                scheduler=scheduler,
-            )
-
-
 class BaseAction:
     """
     Base class interface for actions triggered by our predefined triggers.
@@ -70,9 +33,9 @@ class BaseAction:
     # Keeps the default timestamp for the job to run
     launch_at: Optional[timedelta] = None
     # Stores additional contextual data for the trigger/template
-    additional_context: Optional[Dict] = None
+    additional_context: Optional[dict] = None
 
-    def __init__(self, trigger: Trigger, objects: Optional[Dict] = None):
+    def __init__(self, trigger: Trigger, objects: Optional[dict] = None):
         # save parameters just in case
         self.trigger = trigger
         # TODO: perhaps save in dict?
@@ -145,7 +108,7 @@ def bcc_recipients(self) -> Optional[str]:
         Action."""
         return None
 
-    def reply_to(self) -> Optional[Tuple[str]]:
+    def reply_to(self) -> Optional[tuple[str]]:
         """Overwrite in order to set own reply-to from descending Action."""
         return None
 
@@ -167,7 +130,7 @@ def all_recipients(self) -> str:
         """If available, return string of all recipients."""
         return ""
 
-    def get_merge_data(self) -> Optional[Dict]:
+    def get_merge_data(self) -> Optional[dict]:
         """If available return a dict containing per user customizations
         See https://anymail.readthedocs.io/en/stable/sending/templates/#anymail.message.AnymailMessage.merge_data # noqa
 
@@ -177,7 +140,7 @@ def get_merge_data(self) -> Optional[Dict]:
         """
         return None
 
-    def _context(self, additional_context: Optional[Dict] = None) -> Dict:
+    def _context(self, additional_context: Optional[dict] = None) -> dict:
         """Prepare general context for lazy-evaluated email message used later
         on."""
         context = dict(site=Site.objects.get_current())
@@ -245,7 +208,7 @@ def __call__(self, *args, **kwargs):
             self.logger.debug("Error occurred: {}", str(e))
             return False
 
-    def repeated_job_emails(self) -> Optional[List[str]]:
+    def repeated_job_emails(self) -> Optional[list[str]]:
         """
         For repeated jobs, do a query for
         the emails needed to send at this time.
@@ -1235,13 +1198,13 @@ def check(term: Term):
     def get_additional_context(self, objects, *args, **kwargs):
         return dict()
 
-    def get_merge_data(self) -> Optional[Dict]:
+    def get_merge_data(self) -> Optional[dict]:
         # Returning an empty dictionary is necessary
         # if you want to send an individual email to each recipient
         # but have no per-user configuration
         return {}
 
-    def reply_to(self) -> Optional[Tuple[str]]:
+    def reply_to(self) -> Optional[tuple[str]]:
         """Overwrite in order to set own reply-to from descending Action."""
         return (settings.ADMIN_NOTIFICATION_CRITERIA_DEFAULT,)
 
@@ -1258,7 +1221,7 @@ class ProfileUpdateReminderAction(BaseAction):
 
     launch_at = timedelta(hours=1)
 
-    def recipients(self) -> Optional[Tuple[str]]:
+    def recipients(self) -> Optional[tuple[str]]:
         """Assuming self.context is ready, overwrite email's recipients
         with selected ones."""
         try:
@@ -1274,7 +1237,7 @@ def all_recipients(self) -> str:
             return ", ".join(recipients)
         return ""
 
-    def reply_to(self) -> Optional[Tuple[str]]:
+    def reply_to(self) -> Optional[tuple[str]]:
         """Overwrite in order to set own reply-to from descending Action."""
         return (settings.ADMIN_NOTIFICATION_CRITERIA_DEFAULT,)
 
@@ -1311,6 +1274,8 @@ class UpdateProfileReminderRepeatedAction(BaseRepeatedAction):
     EMAIL_ACTION_CLASS = ProfileUpdateReminderAction
 
     def __call__(self, *args, **kwargs):
+        from autoemails.base_views import ActionManageMixin
+
         people = self.get_people_with_anniversary()
         triggers = Trigger.objects.filter(
             active=True,

amy/autoemails/base_views.py

@@ -1,13 +1,22 @@
+from __future__ import annotations
+
+from logging import Logger
+from typing import Optional, Sequence, Type, Union
+
 from django.contrib import messages
+from django.db.models.query import QuerySet
+from django.http import HttpRequest
 from django.urls import reverse
 from django.utils.html import format_html
 from django_rq.queues import DjangoScheduler
+from redis import Redis, StrictRedis
 from rq.exceptions import NoSuchJobError
 
+from autoemails.actions import BaseAction
+from autoemails.job import Job
+from autoemails.mixins import RQJobsMixin
 from autoemails.models import RQJob, Trigger
-
-from .job import Job
-from .utils import check_status, scheduled_execution_time
+from autoemails.utils import check_status, scheduled_execution_time
 
 
 class ActionManageMixin:
@@ -33,14 +42,14 @@ def objects(self):
 
     @staticmethod
     def add(
-        action_class,
-        logger,
-        scheduler,
-        triggers,
-        context_objects,
-        object_=None,
-        request=None,
-    ):
+        action_class: Type[BaseAction],
+        logger: Logger,
+        scheduler: DjangoScheduler,
+        triggers: QuerySet[Trigger],
+        context_objects: dict,
+        object_: Optional[RQJobsMixin] = None,
+        request: Optional[HttpRequest] = None,
+    ) -> tuple[list[Job], list[RQJob]]:
         Action = action_class
         action_name = Action.__name__
 
@@ -111,11 +120,10 @@ def add(
                     request,
                     format_html(
                         "New email ({}) was scheduled to run "
-                        '<relative-time datetime="{}">{}</relative-time>: '
-                        '<a href="{}">{}</a>.',
+                        '<relative-time datetime="{}"></relative-time>: '
+                        '<a href="{}"><code>{}</code></a>.',
                         trigger.get_action_display(),
                         scheduled_at.isoformat(),
-                        "{:%Y-%m-%d %H:%M}".format(scheduled_at),
                         reverse("admin:autoemails_rqjob_preview", args=[rqj.pk]),
                         job.id,
                     ),
@@ -148,14 +156,14 @@ def bulk_schedule_message(
 
     @staticmethod
     def remove(
-        action_class,
-        logger,
-        scheduler,
-        connection,
-        jobs,
-        object_,
-        request=None,
-    ):
+        action_class: Type[BaseAction],
+        logger: Logger,
+        scheduler: DjangoScheduler,
+        connection: Union[Redis, StrictRedis],
+        jobs: Sequence[str],
+        object_: RQJobsMixin,
+        request: Optional[HttpRequest] = None,
+    ) -> None:
         Action = action_class
         action_name = Action.__name__
 
@@ -196,8 +204,8 @@ def remove(
                     messages.info(
                         request,
                         format_html(
-                            "Scheduled email {} was removed because action "
-                            "conditions have changed. "
+                            "Scheduled email <code>{}</code> was removed because "
+                            "action conditions have changed. "
                             '<a href="{}">See other scheduled jobs</a>.',
                             job,
                             reverse("admin:autoemails_rqjob_changelist"),

amy/autoemails/bulk_email.py

@@ -0,0 +1,50 @@
+from __future__ import annotations
+
+import logging
+from typing import Any, Type
+
+from django.conf import settings
+from django.db.models.query import QuerySet
+from django.http.request import HttpRequest
+import django_rq
+
+from autoemails.actions import BaseAction
+from autoemails.base_views import ActionManageMixin
+from autoemails.models import Trigger
+
+logger = logging.getLogger("amy.signals")
+scheduler = django_rq.get_scheduler("default")
+
+
+def send_bulk_email(
+    request: HttpRequest,
+    action_class: Type[BaseAction],
+    triggers: QuerySet[Trigger],
+    emails: list[str],
+    additional_context_objects: dict,
+    object_: Any,
+):
+    emails_to_send = [
+        emails[i : i + settings.BULK_EMAIL_LIMIT]  # noqa
+        for i in range(0, len(emails), settings.BULK_EMAIL_LIMIT)
+    ]
+    for emails in emails_to_send:
+        jobs, rqjobs = ActionManageMixin.add(
+            action_class=action_class,
+            logger=logger,
+            scheduler=scheduler,
+            triggers=triggers,
+            context_objects=dict(
+                person_emails=emails,
+                **additional_context_objects,
+            ),
+            object_=object_,
+        )
+        if triggers and jobs:
+            ActionManageMixin.bulk_schedule_message(
+                request=request,
+                num_emails=len(emails),
+                trigger=triggers[0],
+                job=jobs[0],
+                scheduler=scheduler,
+            )

amy/autoemails/tests/test_action.py

@@ -9,7 +9,8 @@
 from django.test import TestCase, override_settings
 from django.test.client import RequestFactory
 
-from autoemails.actions import BaseAction, send_bulk_email
+from autoemails.actions import BaseAction
+from autoemails.bulk_email import send_bulk_email
 from autoemails.models import EmailTemplate, RQJob, Trigger
 from consents.models import Term
 

amy/consents/util.py

@@ -1,4 +1,5 @@
-from autoemails.actions import NewConsentRequiredAction, send_bulk_email
+from autoemails.actions import NewConsentRequiredAction
+from autoemails.bulk_email import send_bulk_email
 from autoemails.models import Trigger
 from consents.models import Consent, Term
 from workshops.models import Person

amy/dashboard/views.py

@@ -282,6 +282,7 @@ class UpcomingTeachingOpportunitiesList(
     def get_queryset(self):
         self.queryset = (
             InstructorRecruitment.objects.select_related("event")
+            .filter(status="o")
             .prefetch_related(
                 "event__curricula",
                 Prefetch(

amy/recruitment/forms.py

@@ -11,3 +11,11 @@ class InstructorRecruitmentCreateForm(forms.ModelForm):
     class Meta:
         model = InstructorRecruitment
         fields = ("notes",)
+
+
+class InstructorRecruitmentSignupChangeStateForm(forms.Form):
+    ALLOWED_ACTIONS = (
+        ("confirm", "Confirm"),
+        ("decline", "Decline"),
+    )
+    action = forms.ChoiceField(choices=ALLOWED_ACTIONS)