Add unsubscribe functionality at backend (#236)

backend/djangoindia/api/urls/communication.py

@@ -1,9 +1,14 @@
 from django.urls import path
 
-from djangoindia.api.views.communication import ContactUsAPIView, SubscriberAPIView
+from djangoindia.api.views.communication import (
+    ContactUsAPIView,
+    SubscriberAPIView,
+    UnsubscribeAPIView,
+)
 
 
 urlpatterns = [
     path("subscriber/", SubscriberAPIView.as_view(), name="subscriber"),
+    path("unsubscribe/<uuid:token>/", UnsubscribeAPIView.as_view(), name="unsubscribe"),
     path("contact-us/", ContactUsAPIView.as_view(), name="contact-us"),
 ]

backend/djangoindia/api/views/communication.py

@@ -2,6 +2,8 @@
 from rest_framework.mixins import CreateModelMixin
 from rest_framework.response import Response
 
+from django.shortcuts import get_object_or_404
+
 from djangoindia.api.serializers.communication import (
     ContactUsSerializer,
     SubscriberSerializer,
@@ -33,6 +35,29 @@ def post(self, request, *args, **kwargs):
             )
 
 
+class UnsubscribeAPIView(generics.GenericAPIView):
+    def delete(self, request, token=None):
+        try:
+            unsubscribe_token = token
+            if not unsubscribe_token:
+                return Response(
+                    {"message": "Unsubscribe token is required."},
+                    status=status.HTTP_400_BAD_REQUEST,
+                )
+            subscriber = get_object_or_404(
+                Subscriber, unsubscribe_token=unsubscribe_token
+            )
+            subscriber.delete()
+            return Response(
+                {"message": "You have been unsubscribed. We're sad to see you go. 😢"},
+                status=status.HTTP_200_OK,
+            )
+        except Exception as e:
+            return Response(
+                {"message": str(e)}, status=status.HTTP_500_INTERNAL_SERVER_ERROR
+            )
+
+
 class ContactUsAPIView(generics.GenericAPIView, CreateModelMixin):
     def post(self, request):
         try:

backend/djangoindia/bg_tasks/send_update.py

@@ -1,4 +1,5 @@
 import logging
+import os
 
 from celery import shared_task
 
@@ -31,9 +32,15 @@ def send_mass_update_email_task(update_id):
 
     for recipient in recipients:
         try:
+            if not recipient.unsubscribe_token:
+                recipient.generate_unsubscribe_token()
+
+            api_url = os.environ.get("API_URL")
+            unsubscribe_url = f"{api_url}{recipient.unsubscribe_token}/"
+
             html_content = render_to_string(
                 "admin/update_mail.html",
-                {"body": mark_safe(update.email_body), "subscriber": recipient},
+                {"body": mark_safe(update.email_body), "subscriber": recipient, "unsubscribe_url": unsubscribe_url},
             )
             plain_text_content = strip_tags(html_content)
 

backend/djangoindia/db/migrations/0013_subscriber_unsubscribe_token.py

@@ -0,0 +1,18 @@
+# Generated by Django 5.1.2 on 2024-12-10 16:07
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('db', '0012_rename_html_template_update_email_body_and_more'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='subscriber',
+            name='unsubscribe_token',
+            field=models.CharField(blank=True, max_length=255, null=True, unique=True),
+        ),
+    ]

backend/djangoindia/db/models/communication.py

@@ -1,3 +1,5 @@
+import uuid
+
 from django.db import models
 
 from .base import BaseModel
@@ -6,10 +8,17 @@
 class Subscriber(BaseModel):
     name = models.CharField(max_length=100)
     email = models.EmailField()
+    unsubscribe_token = models.CharField(
+        max_length=255, unique=True, blank=True, null=True
+    )
 
     def __str__(self):
         return self.email
 
+    def generate_unsubscribe_token(self):
+        self.unsubscribe_token = uuid.uuid4().hex
+        self.save()
+
 
 class ContactUs(BaseModel):
     first_name = models.CharField(max_length=100)

backend/templates/admin/update_mail.html

@@ -71,6 +71,7 @@
         </div>
         <div class="footer">
             <p>&copy; 2024 Django India Community. All rights reserved.</p>
+            <a href={{unsubscribe_url}}>Unsubscribe</a>
             <div class="social-links-container">
                 <ul class="social-links">
                     <li><a href="https://www.twitter.com/djangoindiaa" target="_blank">Twitter</a></li>