feat: #40 Add unsubscribe and verify commands

Author: payamnj

django_email_learning/migrations/0005_alter_enrollment_activation_code.py

@@ -0,0 +1,20 @@
+# Generated by Django 6.0 on 2026-01-07 10:39
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        (
+            "django_email_learning",
+            "0004_remove_lesson_is_published_remove_quiz_is_published_and_more",
+        ),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="enrollment",
+            name="activation_code",
+            field=models.CharField(blank=True, max_length=6, null=True),
+        ),
+    ]

django_email_learning/models.py

@@ -293,6 +293,13 @@ class EnrollmentStatus(StrEnum):
     DEACTIVATED = "deactivated"
 
 
+class DeactivationReason(StrEnum):
+    CANCELED = "canceled"
+    BLOCKED = "blocked"
+    FAILED = "failed"
+    INACTIVE = "inactive"
+
+
 class Enrollment(models.Model):
     state_transitions = {
         EnrollmentStatus.UNVERIFIED: [
@@ -323,14 +330,14 @@ class Enrollment(models.Model):
         null=True,
         blank=True,
         choices=[
-            ("canceled", "Canceled"),
-            ("blocked", "Blocked"),
-            ("failed", "Failed"),
-            ("inactive", "Inactive"),
+            (DeactivationReason.CANCELED, "Canceled"),
+            (DeactivationReason.BLOCKED, "Blocked"),
+            (DeactivationReason.FAILED, "Failed"),
+            (DeactivationReason.INACTIVE, "Inactive"),
         ],
         max_length=50,
     )
-    activation_code = models.CharField(max_length=100, null=True, blank=True)
+    activation_code = models.CharField(max_length=6, null=True, blank=True)
 
     def save(self, *args, **kwargs) -> None:  # type: ignore[no-untyped-def]
         if self.pk:

django_email_learning/services/command_models/enroll_command.py

@@ -1,6 +1,9 @@
 from django_email_learning.services.command_models.abstract_command import (
     AbstractCommand,
 )
+from django_email_learning.services.command_models.exceptions.invalid_course_slug_error import (
+    InvalidCourseSlugError,
+)
 from django_email_learning.models import (
     BlockedEmail,
     Learner,
@@ -18,10 +21,6 @@
 from typing import Literal
 
 
-class InvalidCourseSlugError(Exception):
-    pass
-
-
 class EnrollCommand(AbstractCommand):
     command_name: Literal["enroll"]
     email: str
@@ -109,7 +108,6 @@ def execute(self) -> None:
             template_context,
         )
 
-        from_email = settings.DJANGO_EMAIL_LEARNING["FROM_EMAIL"]
         to_emails = [self.email]
 
         html_content = render_to_string(
@@ -120,7 +118,10 @@ def execute(self) -> None:
         # TODO: Add AMP content/type to activate directly in email clients that support it
 
         email = EmailMultiAlternatives(
-            subject=subject, body=body, from_email=from_email, to=to_emails
+            subject=subject,
+            body=body,
+            from_email=email_service.from_email,
+            to=to_emails,
         )
         email.attach_alternative(html_content, "text/html")
         email_service.send(email)

django_email_learning/services/command_models/exceptions/__init__.py

@@ -0,0 +1,4 @@
+class InvalidCourseSlugError(Exception):
+    """Exception raised when a course slug is invalid."""
+
+    pass

django_email_learning/services/command_models/exceptions/invalid_course_slug_error.py

@@ -0,0 +1,4 @@
+class InvalidEnrollmentError(Exception):
+    """Exception raised when an enrollment is invalid."""
+
+    pass

django_email_learning/services/command_models/exceptions/invalid_enrollment_error.py

@@ -0,0 +1,4 @@
+class InvalidVerificationCodeError(Exception):
+    """Exception raised when a verification code is invalid."""
+
+    pass

django_email_learning/services/command_models/exceptions/invalid_verification_code_error.py

@@ -1,7 +1,17 @@
 from typing import Literal
+from django_email_learning.models import (
+    Course,
+    Enrollment,
+    Learner,
+    EnrollmentStatus,
+    DeactivationReason,
+)
 from django_email_learning.services.command_models.abstract_command import (
     AbstractCommand,
 )
+from django_email_learning.services.command_models.exceptions.invalid_course_slug_error import (
+    InvalidCourseSlugError,
+)
 
 
 class UnsubscribeCommand(AbstractCommand):
@@ -11,6 +21,36 @@ class UnsubscribeCommand(AbstractCommand):
     organization_id: int
 
     def execute(self) -> None:
-        print(
-            f"Unsubscribing {self.email} from course {self.course_slug} for organization {self.organization_id}"
+        try:
+            course = Course.objects.get(
+                slug=self.course_slug, organization_id=self.organization_id
+            )
+        except Course.DoesNotExist:
+            self.logger.error(
+                f"Unsubscribe Failed: Invalid course slug '{self.course_slug}' for organization ID {self.organization_id}"
+            )
+            raise InvalidCourseSlugError(
+                f"Course with slug '{self.course_slug}' does not exist for organization ID {self.organization_id}"
+            )
+
+        try:
+            learner = Learner.objects.get(email=self.email)
+        except Learner.DoesNotExist:
+            self.logger.warning(
+                f"Unsubscribe Skipped: No learner found with email {self.email}"
+            )
+            return
+
+        enrollments = Enrollment.objects.filter(learner=learner, course=course).exclude(
+            status=EnrollmentStatus.DEACTIVATED
+        )
+        if not enrollments.exists():
+            self.logger.warning(
+                f"Unsubscribe Skipped: No active enrollment found for learner {learner.id} in course {course.slug}"
+            )
+            return
+
+        enrollments.update(
+            status=EnrollmentStatus.DEACTIVATED,
+            deactivation_reason=DeactivationReason.CANCELED,
         )

django_email_learning/services/command_models/unsubscribe_command.py

@@ -0,0 +1,82 @@
+from django_email_learning.services.command_models.abstract_command import (
+    AbstractCommand,
+)
+from django_email_learning.models import Enrollment, EnrollmentStatus
+from pydantic import Field
+
+from django_email_learning.services.command_models.exceptions.invalid_enrollment_error import (
+    InvalidEnrollmentError,
+)
+from django_email_learning.services.command_models.exceptions.invalid_verification_code_error import (
+    InvalidVerificationCodeError,
+)
+from django_email_learning.services.email_sender_service import EmailSenderService
+from django.core.mail import EmailMultiAlternatives
+from django.template.loader import render_to_string
+
+
+class VerifyEnrollmentCommand(AbstractCommand):
+    command_name: str = "verify_enrollment"
+    enrollment_id: int = Field(..., gt=0)
+    verification_code: int = Field(..., ge=100000, le=999999)
+
+    def execute(self) -> None:
+        try:
+            enrollment = Enrollment.objects.get(
+                id=self.enrollment_id, status=EnrollmentStatus.UNVERIFIED
+            )
+        except Enrollment.DoesNotExist:
+            self.logger.error(
+                f"Verification Failed: No unverified enrollment found with ID {self.enrollment_id}"
+            )
+            raise InvalidEnrollmentError(
+                f"No unverified enrollment found with ID {self.enrollment_id}"
+            )
+
+        if str(enrollment.activation_code) != str(self.verification_code):
+            self.logger.error(
+                f"Verification Failed: Invalid verification code for Enrollment ID {self.enrollment_id}"
+            )
+            raise InvalidVerificationCodeError(
+                f"Invalid verification code for Enrollment ID {self.enrollment_id}"
+            )
+
+        enrollment.status = EnrollmentStatus.ACTIVE
+        enrollment.activation_code = None
+        enrollment.save()
+        self.logger.info(
+            f"Enrollment Verified: Enrollment ID {self.enrollment_id} has been activated"
+        )
+
+        enrollment.schedule_first_content_delivery()
+        self.logger.info(
+            f"Content Delivery Scheduled: First content delivery scheduled for Enrollment ID {self.enrollment_id}"
+        )
+
+        # Send confirmation email
+        email_service = EmailSenderService()
+        subject = "Enrollment Verified"
+        body = render_to_string(
+            "emails/enrollment_verified.txt",
+            {
+                "course_title": enrollment.course.title,
+                "organization_name": enrollment.course.organization.name,
+            },
+        )
+
+        email = EmailMultiAlternatives(
+            subject=subject,
+            body=body,
+            from_email=email_service.from_email,
+            to=[enrollment.learner.email],
+        )
+        html_content = render_to_string(
+            "emails/enrollment_verified.html",
+            {
+                "course_title": enrollment.course.title,
+                "organization_name": enrollment.course.organization.name,
+            },
+        )
+        email.attach_alternative(html_content, "text/html")
+
+        email_service.send(email=email)

django_email_learning/services/command_models/verify_enrollment_command.py

@@ -0,0 +1,22 @@
+{% extends "emails/base.html" %}
+
+{% block content %}
+<P>Hello there,<br /></P>
+
+<p><strong>Congratulations!</strong> Your enrollment for "<strong style="color: {{ brand_color }};">{{ course_title }}</strong>" has been successfully verified and confirmed.</p>
+
+<p>We're excited to have you join our learning community. Here's what you can expect:</p>
+
+<ul>
+    <li>Course materials will be delivered directly to this email address</li>
+    <li>You'll receive structured lessons and assignments on a regular schedule</li>
+    <li>Interactive content and assessments will help track your progress</li>
+</ul>
+
+<p>Your learning adventure begins soon! Keep an eye on your inbox for the first lesson and welcome materials.</p>
+
+<h3>Welcome aboard!</h3>
+
+<p>Best regards,<br>
+The <strong>{{ organization_name }}</strong> Team</p>
+{% endblock %}