django-spire 0.23.7__py3-none-any.whl → 0.23.9__py3-none-any.whl

django_spire/notification/app/tests/test_querysets.py

@@ -0,0 +1,90 @@
+from __future__ import annotations
+
+from django.contrib.contenttypes.models import ContentType
+from django.utils.timezone import now
+
+from django_spire.auth.user.tests.factories import create_user
+from django_spire.core.tests.test_cases import BaseTestCase
+from django_spire.history.viewed.models import Viewed
+from django_spire.notification.app.models import AppNotification
+from django_spire.notification.app.tests.factories import create_test_app_notification
+from django_spire.notification.choices import NotificationStatusChoices
+
+
+class AppNotificationQuerySetTests(BaseTestCase):
+    def setUp(self):
+        super().setUp()
+        self.user = create_user(username='test_app_notification_user')
+        self.app_notification = create_test_app_notification(user=self.user)
+
+    def _create_viewed_for_notification(self, app_notification: AppNotification, user):
+        content_type = ContentType.objects.get_for_model(AppNotification)
+        Viewed.objects.create(
+            user=user,
+            object_id=app_notification.id,
+            content_type=content_type
+        )
+
+    def test_by_user(self):
+        other_user = create_user(username='other_user')
+        other_notification = create_test_app_notification(user=other_user)
+
+        result = AppNotification.objects.by_user(self.user)
+        assert self.app_notification in result
+        assert other_notification not in result
+
+    def test_by_users(self):
+        other_user = create_user(username='other_user')
+        other_notification = create_test_app_notification(user=other_user)
+
+        result = AppNotification.objects.by_users([self.user, other_user])
+        assert self.app_notification in result
+        assert other_notification in result
+
+    def test_is_sent(self):
+        pending_notification = create_test_app_notification(
+            user=self.user,
+            status=NotificationStatusChoices.PENDING
+        )
+
+        result = AppNotification.objects.is_sent()
+        assert self.app_notification in result
+        assert pending_notification not in result
+
+    def test_exclude_viewed_by_user(self):
+        self._create_viewed_for_notification(self.app_notification, self.user)
+
+        result = AppNotification.objects.exclude_viewed_by_user(self.user)
+        assert self.app_notification not in result
+
+    def test_annotate_is_viewed_by_user_false(self):
+        result = AppNotification.objects.annotate_is_viewed_by_user(self.user).first()
+        assert result.viewed is False
+
+    def test_annotate_is_viewed_by_user_true(self):
+        self._create_viewed_for_notification(self.app_notification, self.user)
+
+        result = AppNotification.objects.annotate_is_viewed_by_user(self.user).first()
+        assert result.viewed is True
+
+    def test_ordered_by_priority_and_sent_datetime(self):
+        same_time = now()
+        high_priority = create_test_app_notification(
+            user=self.user,
+            priority='high',
+            sent_datetime=same_time
+        )
+        low_priority = create_test_app_notification(
+            user=self.user,
+            priority='low',
+            sent_datetime=same_time
+        )
+
+        result = list(
+            AppNotification.objects
+            .filter(pk__in=[high_priority.pk, low_priority.pk])
+            .ordered_by_priority_and_sent_datetime()
+        )
+
+        assert result[0].pk == high_priority.pk
+        assert result[1].pk == low_priority.pk

django_spire/notification/app/tests/test_views/test_json_views.py

@@ -0,0 +1,48 @@
+from __future__ import annotations
+
+from django.urls import reverse
+
+from django_spire.core.tests.test_cases import BaseTestCase
+from django_spire.notification.app.tests.factories import create_test_app_notification
+
+
+class AppNotificationJsonViewsTests(BaseTestCase):
+    def setUp(self):
+        super().setUp()
+        self.app_notification = create_test_app_notification(user=self.super_user)
+
+    def test_check_new_notifications_ajax_view(self):
+        response = self.client.get(
+            reverse('django_spire:notification:app:json:check_new')
+        )
+
+        assert response.status_code == 200
+        assert 'has_new_notifications' in response.json()
+
+    def test_check_new_notifications_returns_true_when_unviewed(self):
+        response = self.client.get(
+            reverse('django_spire:notification:app:json:check_new')
+        )
+
+        data = response.json()
+        assert data['has_new_notifications'] is True
+
+    def test_set_notifications_as_viewed_ajax_view(self):
+        response = self.client.get(
+            reverse('django_spire:notification:app:json:set_viewed')
+        )
+
+        assert response.status_code == 200
+        assert response.json()['status'] == 200
+
+    def test_set_notifications_as_viewed_marks_as_viewed(self):
+        self.client.get(
+            reverse('django_spire:notification:app:json:set_viewed')
+        )
+
+        check_response = self.client.get(
+            reverse('django_spire:notification:app:json:check_new')
+        )
+
+        data = check_response.json()
+        assert data['has_new_notifications'] is False

django_spire/notification/app/tests/test_views/test_page_views.py

@@ -0,0 +1,19 @@
+from __future__ import annotations
+
+from django.urls import reverse
+
+from django_spire.core.tests.test_cases import BaseTestCase
+from django_spire.notification.app.tests.factories import create_test_app_notification
+
+
+class AppNotificationPageViewsTests(BaseTestCase):
+    def setUp(self):
+        super().setUp()
+        self.app_notification = create_test_app_notification(user=self.super_user)
+
+    def test_app_notification_list_view_status_code(self):
+        response = self.client.get(
+            reverse('django_spire:notification:app:page:list')
+        )
+
+        assert response.status_code == 200

django_spire/notification/app/urls/__init__.py

@@ -1,7 +1,9 @@
+from __future__ import annotations
+
 from django.urls import include, path
 
-app_name = 'app'
 
+app_name = 'app'
 
 urlpatterns = [
     path('json/', include('django_spire.notification.app.urls.json_urls', namespace='json')),

django_spire/notification/app/urls/json_urls.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from django.urls import path
 
 from django_spire.notification.app.views import json_views
@@ -7,10 +9,10 @@ app_name = 'django_spire_notification'
 
 urlpatterns = [
     path('check/notification/ajax/',
-         json_views.check_new_notifications_ajax_view,
-         name='check_new'),
+        json_views.check_new_notifications_ajax_view,
+        name='check_new'),
 
     path('set_viewed/notification/ajax/',
-         json_views.set_notifications_as_viewed_ajax,
-         name='set_viewed'),
+        json_views.set_notifications_as_viewed_ajax,
+        name='set_viewed'),
 ]

django_spire/notification/app/urls/page_urls.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from django.urls import path
 
 from django_spire.notification.app.views import page_views
@@ -7,7 +9,6 @@ app_name = 'django_spire_notification'
 
 urlpatterns = [
     path('django_spire/notification/list/',
-         view=page_views.app_notification_list_view,
-         name='list'
-    )
+        view=page_views.app_notification_list_view,
+        name='list')
 ]

django_spire/notification/app/urls/template_urls.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from django.urls import path
 
 from django_spire.notification.app.views import template_views
@@ -7,6 +9,6 @@ app_name = 'django_spire_notification'
 
 urlpatterns = [
     path('notficiation/dropdown/template/',
-         template_views.notification_dropdown_template_view,
-         name='notification_dropdown')
+        template_views.notification_dropdown_template_view,
+        name='notification_dropdown')
 ]

django_spire/notification/apps.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from django.apps import AppConfig
 from django.conf import settings
 
@@ -17,6 +19,7 @@ class NotificationConfig(AppConfig):
 
     def ready(self) -> None:
         if not isinstance(getattr(settings, NOTIFICATION_THROTTLE_RATE_PER_MINUTE_SETTINGS_NAME), int):
-            raise ValueError(f'"{NOTIFICATION_THROTTLE_RATE_PER_MINUTE_SETTINGS_NAME}" must be set in the django settings when using "{self.label}".')
+            message = f'"{NOTIFICATION_THROTTLE_RATE_PER_MINUTE_SETTINGS_NAME}" must be set in the django settings when using "{self.label}".'
+            raise TypeError(message)
 
         check_required_apps(self.label)

django_spire/notification/email/admin.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from django.contrib import admin
 
 from django_spire.notification.email.models import EmailNotification
@@ -6,5 +8,7 @@ from django_spire.notification.email.models import EmailNotification
 @admin.register(EmailNotification)
 class EmailNotificationAdmin(admin.ModelAdmin):
     list_display = (
-        'id', 'notification', 'to_email_address'
+        'id',
+        'notification',
+        'to_email_address'
     )

django_spire/notification/email/apps.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from django.apps import AppConfig
 
 from django_spire.utils import check_required_apps
@@ -11,4 +13,4 @@ class NotificationEmailConfig(AppConfig):
     REQUIRED_APPS = ('django_spire_core', 'django_spire_notification')
 
     def ready(self) -> None:
-        check_required_apps(self.label)
+        check_required_apps(self.label)

django_spire/notification/email/exceptions.py

@@ -1,5 +1,7 @@
-from django_spire.exceptions import DjangoSpireException
+from __future__ import annotations
 
+from django_spire.exceptions import DjangoSpireError
 
-class EmailNotificationException(DjangoSpireException):
+
+class EmailNotificationError(DjangoSpireError):
     pass

django_spire/notification/email/helper.py

@@ -1,10 +1,12 @@
 from __future__ import annotations
 
+from typing import TYPE_CHECKING
+
 from django.conf import settings
 from django.core.mail import EmailMessage
 
-from django_spire.file.models import File
-from django_spire.notification.models import Notification
+if TYPE_CHECKING:
+    from django_spire.notification.models import Notification
 
 
 class EmailHelper:
@@ -29,6 +31,7 @@ class EmailHelper:
         self.fail_silently = fail_silently
 
         self.attachments = []
+
         for attachment in list(email.attachments.all()):
             with attachment.file.open('rb') as f:
                 self.attachments.append((attachment.name, f.read(), attachment.type))
@@ -44,7 +47,6 @@ class SendGridEmailHelper(EmailHelper):
 
         if notification.email.template_id == '':
             self.template_id = settings.SENDGRID_TEMPLATE_ID
-
         else:
             self.template_id = notification.email.template_id
 

django_spire/notification/email/models.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from django.db import models
 
 from django_spire.file.models import File
@@ -9,7 +11,9 @@ class EmailNotification(models.Model):
     """
     It is important to note size limits for email content contained in this model. E.g., Sendgrid has a hard total email
     limit of 30mb (and a recommended limit of 10mb for attachments): https://www.twilio.com/docs/sendgrid/ui/sending-email/attachments-with-digioh#-Limitations
+
     """
+
     notification = models.OneToOneField(
         Notification,
         editable=False,

django_spire/notification/email/processor.py

@@ -1,25 +1,30 @@
+from __future__ import annotations
+
 from django.utils.timezone import now
+
 from sendgrid import SendGridException
 
-from django_spire.notification.choices import NotificationTypeChoices, \
-    NotificationStatusChoices
+from django_spire.notification.choices import (
+    NotificationStatusChoices,
+    NotificationTypeChoices
+)
 from django_spire.notification.email.helper import SendGridEmailHelper
-from django_spire.notification.exceptions import NotificationException
+from django_spire.notification.exceptions import InvalidNotificationTypeError
 from django_spire.notification.models import Notification
 from django_spire.notification.processors.processor import BaseNotificationProcessor
 
 
 class EmailNotificationProcessor(BaseNotificationProcessor):
+    def _validate_notification_type(self, notification: Notification):
+        if notification.type != NotificationTypeChoices.EMAIL:
+            raise InvalidNotificationTypeError(NotificationTypeChoices.EMAIL, notification.type)
+
     def process(self, notification: Notification):
         notification.status = NotificationStatusChoices.PROCESSING
         notification.save()
 
         try:
-            if notification.type != NotificationTypeChoices.EMAIL:
-                raise NotificationException(
-                    f"EmailNotificationProcessor only processes "
-                    f"Email notifications. Was provided {notification.type}"
-                )
+            self._validate_notification_type(notification)
 
             SendGridEmailHelper(notification).send()
 
@@ -27,11 +32,12 @@ class EmailNotificationProcessor(BaseNotificationProcessor):
             notification.sent_datetime = now()
         except Exception as e:
             notification.status_message = str(e)
+
             if isinstance(e, SendGridException):
                 notification.status = NotificationStatusChoices.ERRORED
             else:
                 notification.status = NotificationStatusChoices.FAILED
-                raise e
+                raise
         finally:
             notification.save()
 
@@ -40,11 +46,7 @@ class EmailNotificationProcessor(BaseNotificationProcessor):
 
         for notification in notifications:
             try:
-                if notification.type != NotificationTypeChoices.EMAIL:
-                    raise NotificationException(
-                        f"EmailNotificationProcessor only processes "
-                        f"Email notifications. Was provided {notification.type}"
-                    )
+                self._validate_notification_type(notification)
 
                 SendGridEmailHelper(notification).send()
 
@@ -56,11 +58,13 @@ class EmailNotificationProcessor(BaseNotificationProcessor):
                     notification.status = NotificationStatusChoices.ERRORED
                 else:
                     notification.status = NotificationStatusChoices.FAILED
+
                     Notification.objects.bulk_update(
                         notifications,
                         ['status', 'sent_datetime', 'status_message']
                     )
-                    raise e
+
+                    raise
 
         Notification.objects.bulk_update(
             notifications,

django_spire/notification/email/querysets.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
+
 from typing import TYPE_CHECKING
+
 from django.db.models import QuerySet, Value, When, Case, BooleanField
 
 from django_spire.history.querysets import HistoryQuerySet
@@ -9,6 +11,7 @@ from django_spire.notification.querysets import NotificationContentObjectQuerySe
 if TYPE_CHECKING:
     from django.contrib.auth.models import User
 
+
 class EmailNotificationQuerySet(HistoryQuerySet, NotificationContentObjectQuerySet):
     def annotate_is_viewed_by_user(self, user: User) -> QuerySet:
         return self.by_user(user=user).annotate(viewed=Case(

django_spire/notification/email/tests/factories.py

@@ -0,0 +1,35 @@
+from __future__ import annotations
+
+from django.contrib.auth.models import User
+
+from django_spire.notification.choices import (
+    NotificationStatusChoices,
+    NotificationTypeChoices,
+)
+from django_spire.notification.email.models import EmailNotification
+from django_spire.notification.models import Notification
+
+
+def create_test_email_notification(**kwargs) -> EmailNotification:
+    if 'notification' not in kwargs:
+        user = kwargs.pop('user', None) or User.objects.first()
+        notification = Notification.objects.create(
+            user=user,
+            type=NotificationTypeChoices.EMAIL,
+            title=kwargs.pop('title', 'Test Email Notification'),
+            body=kwargs.pop('body', 'This is a test email notification.'),
+            url=kwargs.pop('url', 'https://example.com'),
+            status=kwargs.pop('status', NotificationStatusChoices.PENDING),
+            priority=kwargs.pop('priority', 'low'),
+        )
+        kwargs['notification'] = notification
+
+    data = {
+        'to_email_address': 'test@example.com',
+        'template_id': '',
+        'context_data': {},
+        'cc': [],
+        'bcc': [],
+    }
+    data.update(kwargs)
+    return EmailNotification.objects.create(**data)

django_spire/notification/email/tests/test_apps.py

@@ -0,0 +1,24 @@
+from __future__ import annotations
+
+from django.apps import apps
+
+from django_spire.core.tests.test_cases import BaseTestCase
+from django_spire.notification.email.apps import NotificationEmailConfig
+
+
+class NotificationEmailConfigTests(BaseTestCase):
+    def test_app_name(self):
+        assert NotificationEmailConfig.name == 'django_spire.notification.email'
+
+    def test_app_label(self):
+        assert NotificationEmailConfig.label == 'django_spire_notification_email'
+
+    def test_default_auto_field(self):
+        assert NotificationEmailConfig.default_auto_field == 'django.db.models.BigAutoField'
+
+    def test_required_apps(self):
+        expected = ('django_spire_core', 'django_spire_notification')
+        assert NotificationEmailConfig.REQUIRED_APPS == expected
+
+    def test_app_is_installed(self):
+        assert apps.is_installed('django_spire.notification.email')

django_spire/notification/email/tests/test_models.py

@@ -0,0 +1,52 @@
+from __future__ import annotations
+
+from django_spire.core.tests.test_cases import BaseTestCase
+from django_spire.notification.email.tests.factories import create_test_email_notification
+from django_spire.notification.models import Notification
+
+
+class EmailNotificationModelTests(BaseTestCase):
+    def setUp(self):
+        super().setUp()
+        self.email_notification = create_test_email_notification()
+
+    def test_str(self):
+        expected = f'{self.email_notification.notification.title} - {self.email_notification.to_email_address}'
+        assert str(self.email_notification) == expected
+
+    def test_notification_relationship(self):
+        assert self.email_notification.notification is not None
+        assert isinstance(self.email_notification.notification, Notification)
+
+    def test_default_template_id(self):
+        assert self.email_notification.template_id == ''
+
+    def test_default_context_data(self):
+        assert self.email_notification.context_data == {}
+
+    def test_default_cc(self):
+        assert self.email_notification.cc == []
+
+    def test_default_bcc(self):
+        assert self.email_notification.bcc == []
+
+    def test_to_email_address(self):
+        assert self.email_notification.to_email_address == 'test@example.com'
+
+    def test_with_cc(self):
+        email_notification = create_test_email_notification(
+            cc=['cc1@example.com', 'cc2@example.com']
+        )
+        assert email_notification.cc == ['cc1@example.com', 'cc2@example.com']
+
+    def test_with_bcc(self):
+        email_notification = create_test_email_notification(
+            bcc=['bcc1@example.com', 'bcc2@example.com']
+        )
+        assert email_notification.bcc == ['bcc1@example.com', 'bcc2@example.com']
+
+    def test_with_context_data(self):
+        email_notification = create_test_email_notification(
+            context_data={'key': 'value'}
+        )
+        assert email_notification.context_data == {'key': 'value'}

django_spire/notification/email/tests/test_processor.py

@@ -0,0 +1,92 @@
+from __future__ import annotations
+
+from unittest.mock import MagicMock, patch
+
+import pytest
+
+from django_spire.auth.user.tests.factories import create_user
+from django_spire.core.tests.test_cases import BaseTestCase
+from django_spire.notification.choices import (
+    NotificationStatusChoices,
+    NotificationTypeChoices,
+)
+from django_spire.notification.email.models import EmailNotification
+from django_spire.notification.email.processor import EmailNotificationProcessor
+from django_spire.notification.email.tests.factories import create_test_email_notification
+from django_spire.notification.exceptions import NotificationError
+from django_spire.notification.models import Notification
+
+
+class EmailNotificationProcessorTests(BaseTestCase):
+    def setUp(self):
+        super().setUp()
+        self.user = create_user(username='test_email_processor_user')
+        self.processor = EmailNotificationProcessor()
+
+    @patch('django_spire.notification.email.processor.SendGridEmailHelper')
+    def test_process_sets_status_to_sent(self, mock_helper_class: MagicMock):
+        mock_helper = MagicMock()
+        mock_helper_class.return_value = mock_helper
+
+        email_notification = create_test_email_notification(user=self.user)
+        notification = email_notification.notification
+
+        self.processor.process(notification)
+
+        notification.refresh_from_db()
+        assert notification.status == NotificationStatusChoices.SENT
+
+    @patch('django_spire.notification.email.processor.SendGridEmailHelper')
+    def test_process_sets_sent_datetime(self, mock_helper_class: MagicMock):
+        mock_helper = MagicMock()
+        mock_helper_class.return_value = mock_helper
+
+        email_notification = create_test_email_notification(user=self.user)
+        notification = email_notification.notification
+
+        self.processor.process(notification)
+
+        notification.refresh_from_db()
+        assert notification.sent_datetime is not None
+
+    @patch('django_spire.notification.email.processor.SendGridEmailHelper')
+    def test_process_calls_send(self, mock_helper_class: MagicMock):
+        mock_helper = MagicMock()
+        mock_helper_class.return_value = mock_helper
+
+        email_notification = create_test_email_notification(user=self.user)
+        notification = email_notification.notification
+
+        self.processor.process(notification)
+
+        mock_helper.send.assert_called_once()
+
+    def test_process_raises_error_for_wrong_type(self):
+        notification = Notification.objects.create(
+            user=self.user,
+            type=NotificationTypeChoices.APP,
+            title='Test',
+            body='Test',
+            status=NotificationStatusChoices.PENDING,
+        )
+
+        with pytest.raises(NotificationError):
+            self.processor.process(notification)
+
+    @patch('django_spire.notification.email.processor.SendGridEmailHelper')
+    def test_process_list(self, mock_helper_class: MagicMock):
+        mock_helper = MagicMock()
+        mock_helper_class.return_value = mock_helper
+
+        notifications = [
+            create_test_email_notification(user=self.user).notification
+            for _ in range(3)
+        ]
+
+        self.processor.process_list(notifications)
+
+        for notification in notifications:
+            notification.refresh_from_db()
+            assert notification.status == NotificationStatusChoices.SENT
+
+        assert mock_helper.send.call_count == 3