Add article link to notification emails (DOI or URL fallback)

Author: BharatVe

publications/tasks.py

@@ -36,6 +36,11 @@
 DOI_REGEX = re.compile(r'10\.\d{4,9}/[-._;()/:A-Z0-9]+', re.IGNORECASE)
 CACHE_DIR = Path(tempfile.gettempdir()) / 'optimap_cache'
 
+def _get_article_link(pub):
+    """
+    Return the DOI resolver URL if pub.doi is set, otherwise fall back to pub.url.
+    """
+    return f"https://doi.org/{pub.doi}" if pub.doi else pub.url
 
 def generate_data_dump_filename(extension: str) -> str:
     ts = datetime.now(dt_timezone.utc).strftime("%Y%m%dT%H%M%S")
@@ -247,15 +252,20 @@ def harvest_oai_endpoint(source_id: int, user=None) -> None:
 
 
 def send_monthly_email(trigger_source='manual', sent_by=None):
-    recipients = User.objects.filter(userprofile__notify_new_manuscripts=True).values_list('email', flat=True)
+    recipients = User.objects.filter(userprofile__notify_new_manuscripts=True) \
+                             .values_list('email', flat=True)
     last_month = timezone.now().replace(day=1) - timedelta(days=1)
     new_manuscripts = Publication.objects.filter(creationDate__month=last_month.month)
 
     if not recipients.exists() or not new_manuscripts.exists():
         return
 
     subject = "📚 New Manuscripts This Month"
-    content = "Here are the new manuscripts:\n" + "\n".join([pub.title for pub in new_manuscripts])
+    lines = []
+    for pub in new_manuscripts:
+        link = _get_article_link(pub)
+        lines.append(f"- {pub.title}: {link}")
+    content = "Here are the new manuscripts:\n" + "\n".join(lines)
 
     for recipient in recipients:
         try:
@@ -267,14 +277,25 @@ def send_monthly_email(trigger_source='manual', sent_by=None):
                 fail_silently=False,
             )
             EmailLog.log_email(
-                recipient, subject, content, sent_by=sent_by, trigger_source=trigger_source, status="success"
+                recipient,
+                subject,
+                content,
+                sent_by=sent_by,
+                trigger_source=trigger_source,
+                status="success"
             )
             time.sleep(settings.EMAIL_SEND_DELAY)
         except Exception as e:
             error_message = str(e)
             logger.error(f"Failed to send monthly email to {recipient}: {error_message}")
             EmailLog.log_email(
-                recipient, subject, content, sent_by=sent_by, trigger_source=trigger_source, status="failed", error_message=error_message
+                recipient,
+                subject,
+                content,
+                sent_by=sent_by,
+                trigger_source=trigger_source,
+                status="failed",
+                error_message=error_message
             )
 
 def send_subscription_based_email(trigger_source='manual', sent_by=None, user_ids=None):
@@ -284,19 +305,24 @@ def send_subscription_based_email(trigger_source='manual', sent_by=None, user_id
 
     for subscription in query:
         user_email = subscription.user.email
-
         new_publications = Publication.objects.filter(
             geometry__intersects=subscription.region,
         )
-
         if not new_publications.exists():
             continue
 
-        unsubscribe_specific = f"{BASE_URL}{reverse('optimap:unsubscribe')}?search={quote(subscription.search_term)}"
+        unsubscribe_specific = (
+            f"{BASE_URL}{reverse('optimap:unsubscribe')}?search="
+            f"{quote(subscription.search_term)}"
+        )
         unsubscribe_all = f"{BASE_URL}{reverse('optimap:unsubscribe')}?all=true"
 
         subject = f"📚 New Manuscripts Matching '{subscription.search_term}'"
-        bullet_list = "\n".join([f"- {pub.title}" for pub in new_publications])
+        lines = []
+        for pub in new_publications:
+            link = _get_article_link(pub)
+            lines.append(f"- {pub.title}: {link}")
+        bullet_list = "\n".join(lines)
         content = f"""Dear {subscription.user.username},
 Here are the latest manuscripts matching your subscription:
 
@@ -311,17 +337,27 @@ def send_subscription_based_email(trigger_source='manual', sent_by=None, user_id
             email = EmailMessage(subject, content, settings.EMAIL_HOST_USER, [user_email])
             email.send()
             EmailLog.log_email(
-                user_email, subject, content, sent_by=sent_by, trigger_source=trigger_source, status="success"
+                user_email,
+                subject,
+                content,
+                sent_by=sent_by,
+                trigger_source=trigger_source,
+                status="success"
             )
             time.sleep(settings.EMAIL_SEND_DELAY)
         except Exception as e:
             error_message = str(e)
             logger.error(f"Failed to send subscription email to {user_email}: {error_message}")
             EmailLog.log_email(
-                user_email, subject, content, sent_by=sent_by, trigger_source=trigger_source, status="failed", error_message=error_message
+                user_email,
+                subject,
+                content,
+                sent_by=sent_by,
+                trigger_source=trigger_source,
+                status="failed",
+                error_message=error_message
             )
 
-# ... (the rest of the file remains unchanged)
 
 def schedule_monthly_email_task(sent_by=None):
     if not Schedule.objects.filter(func='publications.tasks.send_monthly_email').exists():

tests/test_email.py

@@ -11,7 +11,7 @@
 from django.contrib.auth import get_user_model
 User = get_user_model()
 
-os.environ.setdefault("DJANGO_SETTINGS_MODULE", "optimap.settings") 
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "optimap.settings")
 django.setup()
 
 @override_settings(EMAIL_BACKEND='django.core.mail.backends.locmem.EmailBackend')
@@ -21,17 +21,18 @@ def setUp(self):
         Publication.objects.all().delete()
         EmailLog.objects.all().delete()
         User.objects.all().delete()
-        
-        self.user = User.objects.create_user(username="testuser1", email="test@example.com", password="testpass")
-        self.user_profile = UserProfile.objects.get(user=self.user)
 
+        self.user = User.objects.create_user(
+            username="testuser1", email="test@example.com", password="testpass"
+        )
+        self.user_profile = UserProfile.objects.get(user=self.user)
         self.user_profile.notify_new_manuscripts = True
         self.user_profile.save()
 
     def test_send_monthly_email_with_publications(self):
         """Test if the monthly email is sent when publications exist"""
-
-        last_month = now().replace(day=1) - timedelta(days=1)  
+        # create one publication with a DOI
+        last_month = now().replace(day=1) - timedelta(days=1)
         publication = Publication.objects.create(
             title="Point Test",
             abstract="Publication with a single point inside a collection.",
@@ -41,38 +42,48 @@ def test_send_monthly_email_with_publications(self):
             doi="10.1234/test-doi-1",
             geometry=GeometryCollection(Point(12.4924, 41.8902)),
         )
-
+        # ensure creationDate falls in last month
         Publication.objects.filter(id=publication.id).update(creationDate=last_month)
-
         publication.refresh_from_db()
- 
+
+        # no emails before sending
         self.assertEqual(len(mail.outbox), 0)
 
+        # send and assert
         send_monthly_email(sent_by=self.user)
-
         self.assertEqual(len(mail.outbox), 1)
-
         sent_email = mail.outbox[0]
 
+        # title and DOI-based link should both appear
         self.assertIn(publication.title, sent_email.body)
+        expected_link = f"https://doi.org/{publication.doi}"
+        self.assertIn(expected_link, sent_email.body)
 
+        # recipient and log correctness
         self.assertEqual(sent_email.to, ["test@example.com"])
-
-        email_log = EmailLog.objects.latest('sent_at')  
+        email_log = EmailLog.objects.latest('sent_at')
         self.assertEqual(email_log.recipient_email, "test@example.com")
         self.assertEqual(email_log.sent_by, self.user)
 
-
-    def test_send_monthly_email_without_publications(self):
-        """Test that no email is sent when no new publications exist"""
-
-        self.assertEqual(len(mail.outbox), 0)
+    def test_send_monthly_email_fallback_to_url_when_no_doi(self):
+        """Test monthly email falls back to publication.url when no DOI"""
+        last_month = now().replace(day=1) - timedelta(days=1)
+        pub = Publication.objects.create(
+            title="No DOI Paper",
+            abstract="No DOI here.",
+            url="https://example.com/nodoi",
+            status="p",
+            publicationDate=last_month,
+            doi=None,
+            geometry=GeometryCollection(Point(0, 0)),
+        )
+        Publication.objects.filter(id=pub.id).update(creationDate=last_month)
+        mail.outbox.clear()
 
         send_monthly_email(sent_by=self.user)
+        self.assertEqual(len(mail.outbox), 1)
+        body = mail.outbox[0].body
 
-        self.assertEqual(len(mail.outbox), 0)
-
-        self.assertFalse(EmailLog.objects.exists())
-
-
-
+        # should include URL fallback instead of DOI
+        self.assertIn(pub.title, body)
+        self.assertIn(pub.url, body)

tests/test_subscription_email.py

@@ -12,19 +12,21 @@
 @override_settings(EMAIL_BACKEND='django.core.mail.backends.locmem.EmailBackend')
 class SubscriptionEmailTest(TestCase):
     def setUp(self):
-        self.user = User.objects.create_user(username="subuser", email="subuser@example.com", password="testpass")
+        self.user = User.objects.create_user(
+            username="subuser", email="subuser@example.com", password="testpass"
+        )
         UserProfile.objects.get_or_create(user=self.user)
-
         self.subscription = Subscription.objects.create(
             user=self.user,
             name="Test Subscription",
             search_term="AI",
-            region=GeometryCollection(Point(12.4924, 41.8902)), 
+            region=GeometryCollection(Point(12.4924, 41.8902)),
             subscribed=True
         )
 
     def test_subscription_email_sent_when_publication_matches(self):
-        # Create a publication within the region
+        """Email is sent and includes a DOI link when a pub matches the region"""
+        # publication with DOI inside region
         pub = Publication.objects.create(
             title="Rome AI Paper",
             abstract="Test abstract",
@@ -34,30 +36,54 @@ def test_subscription_email_sent_when_publication_matches(self):
             doi="10.1234/sub-doi",
             geometry=GeometryCollection(Point(12.4924, 41.8902)),
         )
-
+        # trigger
         send_subscription_based_email(sent_by=self.user)
 
+        # one email, contains title, unsubscribe, and DOI link
         self.assertEqual(len(mail.outbox), 1)
-        self.assertIn(pub.title, mail.outbox[0].body)
-        self.assertIn("unsubscribe", mail.outbox[0].body.lower())
+        body = mail.outbox[0].body.lower()
+        self.assertIn(pub.title.lower(), body)
+        self.assertIn("unsubscribe", body)
+        expected_link = f"https://doi.org/{pub.doi}"
+        self.assertIn(expected_link, mail.outbox[0].body)
 
+        # log entry
         log = EmailLog.objects.latest("sent_at")
         self.assertEqual(log.recipient_email, self.user.email)
         self.assertEqual(log.sent_by, self.user)
 
+    def test_subscription_email_fallback_to_url_when_no_doi(self):
+        """Email falls back to pub.url when DOI is missing"""
+        pub = Publication.objects.create(
+            title="No DOI Sub Paper",
+            abstract="Test abstract",
+            url="https://example.com/no-doi-sub",
+            status="p",
+            publicationDate=now() - timedelta(days=2),
+            doi=None,
+            geometry=GeometryCollection(Point(12.4924, 41.8902)),
+        )
+        mail.outbox.clear()
+
+        send_subscription_based_email(sent_by=self.user)
+        self.assertEqual(len(mail.outbox), 1)
+        body = mail.outbox[0].body
+        self.assertIn(pub.title, body)
+        # should include URL fallback
+        self.assertIn(pub.url, body)
+
     def test_subscription_email_not_sent_if_no_publication_matches(self):
-        # Create publication OUTSIDE subscription region
+        """No email or log if no pubs intersect the region"""
         Publication.objects.create(
             title="Outside Region Paper",
             abstract="Should not match",
             url="https://example.com/outside",
             status="p",
             publicationDate=now(),
             doi="10.1234/outside-doi",
-            geometry=GeometryCollection(Point(0, 0)),  # Outside region
+            geometry=GeometryCollection(Point(0, 0)),
         )
 
         send_subscription_based_email(sent_by=self.user)
-
         self.assertEqual(len(mail.outbox), 0)
         self.assertFalse(EmailLog.objects.exists())