Implement sending the invitation letter via email

Author: marcoacierno

backend/notifications/migrations/0020_alter_emailtemplate_identifier.py

@@ -0,0 +1,18 @@
+# Generated by Django 5.1.4 on 2025-02-06 23:10
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('notifications', '0019_alter_emailtemplate_identifier'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='emailtemplate',
+            name='identifier',
+            field=models.CharField(choices=[('proposal_accepted', 'Proposal accepted'), ('proposal_rejected', 'Proposal rejected'), ('proposal_in_waiting_list', 'Proposal in waiting list'), ('proposal_scheduled_time_changed', 'Proposal scheduled time changed'), ('proposal_received_confirmation', 'Proposal received confirmation'), ('speaker_communication', 'Speaker communication'), ('voucher_code', 'Voucher code'), ('reset_password', '[System] Reset password'), ('grant_application_confirmation', 'Grant application confirmation'), ('grant_approved', 'Grant approved'), ('grant_rejected', 'Grant rejected'), ('grant_waiting_list', 'Grant waiting list'), ('grant_waiting_list_update', 'Grant waiting list update'), ('grant_voucher_code', 'Grant voucher code'), ('sponsorship_brochure', 'Sponsorship brochure'), ('visa_invitation_letter_download', 'Visa invitation letter download'), ('custom', 'Custom')], max_length=200, verbose_name='identifier'),
+        ),
+    ]

backend/notifications/models.py

@@ -48,6 +48,11 @@ class EmailTemplateIdentifier(models.TextChoices):
 
     sponsorship_brochure = "sponsorship_brochure", _("Sponsorship brochure")
 
+    visa_invitation_letter_download = (
+        "visa_invitation_letter_download",
+        _("Visa invitation letter download"),
+    )
+
     custom = "custom", _("Custom")
 
 
@@ -154,6 +159,11 @@ class EmailTemplate(TimeStampedModel):
             "brochure_url",
             "conference_name",
         ],
+        EmailTemplateIdentifier.visa_invitation_letter_download: [
+            *BASE_PLACEHOLDERS,
+            "invitation_letter_download_url",
+            "conference_name",
+        ],
     }
 
     conference = models.ForeignKey(

backend/pycon/urls.py

@@ -32,6 +32,7 @@
     path("", include("healthchecks.urls")),
     path("", include("files_upload.urls")),
     path("", include("notifications.urls")),
+    path("visa/", include("visa.urls")),
 ] + static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)
 
 

backend/visa/admin.py

@@ -78,7 +78,10 @@ def save_form(self, request, form, change):
         obj = super().save_form(request, form, change)
 
         if "_process_now" in form.data:
-            obj.schedule()
+            obj.process()
+
+        if "_send_via_email" in form.data:
+            obj.send_via_email()
 
         return obj
 
@@ -112,6 +115,11 @@ def response_post_save_change(self, request, obj):
                 reverse("admin:visa_invitationletterrequest_change", args=[obj.id])
             )
 
+        if "_send_via_email" in request.POST:
+            return HttpResponseRedirect(
+                reverse("admin:visa_invitationletterrequest_change", args=[obj.id])
+            )
+
         return self._response_post_save(request, obj)
 
 

backend/visa/models.py

@@ -138,7 +138,7 @@ def user(self):
 
         return self.requester
 
-    def schedule(self):
+    def process(self):
         from visa.tasks import process_invitation_letter_request
 
         transaction.on_commit(
@@ -147,6 +147,15 @@ def schedule(self):
             )
         )
 
+    def send_via_email(self):
+        from visa.tasks import send_invitation_letter_via_email
+
+        transaction.on_commit(
+            lambda: send_invitation_letter_via_email.delay(
+                invitation_letter_request_id=self.id
+            )
+        )
+
     def get_config(self):
         return self.conference.invitation_letter_config
 

backend/visa/tasks.py

@@ -1,4 +1,6 @@
 from django.urls import reverse
+from notifications.models import EmailTemplate, EmailTemplateIdentifier
+from pycon.signing import sign_path
 from integrations import slack
 import time
 from django.template import Template, Context
@@ -231,3 +233,33 @@ def notify_new_invitation_letter_request_on_slack(
         oauth_token=conference.get_slack_oauth_token(),
         channel_id=conference.slack_new_invitation_letter_request_channel_id,
     )
+
+
+@app.task
+def send_invitation_letter_via_email(*, invitation_letter_request_id: int):
+    invitation_letter_request = InvitationLetterRequest.objects.get(
+        id=invitation_letter_request_id
+    )
+
+    conference = invitation_letter_request.conference
+
+    download_invitation_letter_path = reverse(
+        "download-invitation-letter", args=[invitation_letter_request.id]
+    )
+    signed_path = sign_path(download_invitation_letter_path)
+
+    invitation_letter_download_url = f"https://admin.pycon.it{signed_path}"
+
+    email_template = EmailTemplate.objects.for_conference(conference).get_by_identifier(
+        EmailTemplateIdentifier.visa_invitation_letter_download
+    )
+    email_template.send_email(
+        recipient_email=invitation_letter_request.email,
+        placeholders={
+            "invitation_letter_download_url": invitation_letter_download_url,
+            "conference_name": conference.name.localize("en"),
+        },
+    )
+
+    invitation_letter_request.status = InvitationLetterRequestStatus.SENT
+    invitation_letter_request.save(update_fields=["status"])

backend/visa/tests/factories.py

@@ -6,6 +6,7 @@
     InvitationLetterDocument,
     InvitationLetterRequest,
     InvitationLetterConferenceConfig,
+    InvitationLetterRequestStatus,
 )
 import factory
 import factory.fuzzy
@@ -39,6 +40,11 @@ class Meta:
         model = InvitationLetterRequest
 
 
+class SentInvitationLetterRequestFactory(InvitationLetterRequestFactory):
+    status = InvitationLetterRequestStatus.SENT
+    invitation_letter = factory.django.FileField()
+
+
 class InvitationLetterConferenceConfigFactory(DjangoModelFactory):
     conference = factory.SubFactory(ConferenceFactory)
 

backend/visa/tests/test_models.py

@@ -84,6 +84,6 @@ def test_schedule_processing(django_capture_on_commit_callbacks, mocker):
     )
 
     with django_capture_on_commit_callbacks(execute=True):
-        request.schedule()
+        request.process()
 
     mock_task.delay.assert_called_once_with(invitation_letter_request_id=request.id)

backend/visa/tests/test_views.py

@@ -0,0 +1,105 @@
+import pytest
+from django.core.signing import Signer
+from visa.models import InvitationLetterRequestStatus
+from visa.tests.factories import (
+    InvitationLetterRequestFactory,
+    SentInvitationLetterRequestFactory,
+)
+from pytest import mark
+from django.urls import reverse
+
+pytestmark = mark.django_db
+
+
+def test_download_invitation_letter_without_signature_fails(client):
+    invitation_letter_request = InvitationLetterRequestFactory(
+        status=InvitationLetterRequestStatus.SENT
+    )
+    response = client.get(
+        reverse("download-invitation-letter", args=[invitation_letter_request.id])
+    )
+
+    assert response.status_code == 403
+    assert response.content.decode() == "Missing signature."
+
+
+def test_download_invitation_letter_with_invalid_signature_fails(client):
+    signer = Signer()
+    signature = signer.sign("something-else").split(signer.sep)[-1]
+
+    invitation_letter_request = InvitationLetterRequestFactory(
+        status=InvitationLetterRequestStatus.SENT
+    )
+    response = client.get(
+        reverse("download-invitation-letter", args=[invitation_letter_request.id])
+        + f"?sig={signature}"
+    )
+
+    assert response.status_code == 403
+    assert response.content.decode() == "Invalid signature."
+
+
+def test_download_invitation_letter(client):
+    invitation_letter_request = SentInvitationLetterRequestFactory()
+
+    url_path = reverse(
+        "download-invitation-letter", args=[invitation_letter_request.id]
+    )
+
+    signer = Signer()
+    signature = signer.sign(url_path).split(signer.sep)[-1]
+    response = client.get(url_path + f"?sig={signature}")
+
+    assert response.status_code == 302
+    assert response.url == invitation_letter_request.invitation_letter.url
+
+
+@pytest.mark.parametrize(
+    "status",
+    [
+        InvitationLetterRequestStatus.PENDING,
+        InvitationLetterRequestStatus.PROCESSING,
+        InvitationLetterRequestStatus.PROCESSED,
+        InvitationLetterRequestStatus.FAILED_TO_GENERATE,
+        InvitationLetterRequestStatus.REJECTED,
+    ],
+)
+def test_cannot_download_non_sent_invitation_letter_request(client, status):
+    invitation_letter_request = InvitationLetterRequestFactory(status=status)
+
+    url_path = reverse(
+        "download-invitation-letter", args=[invitation_letter_request.id]
+    )
+
+    signer = Signer()
+    signature = signer.sign(url_path).split(signer.sep)[-1]
+    response = client.get(url_path + f"?sig={signature}")
+
+    assert response.status_code == 404
+    assert (
+        response.content.decode("utf-8")
+        == "We can't find this invitation letter request. Please contact us."
+    )
+
+
+def test_cannot_download_non_existent_invitation_letter_request(client):
+    invitation_letter_request = InvitationLetterRequestFactory(
+        status=InvitationLetterRequestStatus.REJECTED
+    )
+
+    url_path = reverse(
+        "download-invitation-letter", args=[invitation_letter_request.id]
+    )
+
+    signer = Signer()
+    signature = signer.sign(url_path).split(signer.sep)[-1]
+
+    invitation_letter_request.delete()
+
+    response = client.get(url_path + f"?sig={signature}")
+
+    assert response.status_code == 404
+    assert (
+        response.content.decode("utf-8")
+        == "We can't find this invitation letter request. Please contact us."
+    )

backend/visa/urls.py

@@ -0,0 +1,11 @@
+from django.urls import path
+
+from visa.views import download_invitation_letter
+
+urlpatterns = [
+    path(
+        "download-invitation-letter/<int:id>",
+        download_invitation_letter,
+        name="download-invitation-letter",
+    ),
+]