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

django_spire/notification/email/tests/test_querysets.py

@@ -0,0 +1,43 @@
+from __future__ import annotations
+
+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
+from django_spire.notification.email.models import EmailNotification
+from django_spire.notification.email.tests.factories import create_test_email_notification
+
+
+class EmailNotificationQuerySetTests(BaseTestCase):
+    def setUp(self):
+        super().setUp()
+        self.user = create_user(username='test_email_queryset_user')
+        self.email_notification = create_test_email_notification(
+            user=self.user,
+            status=NotificationStatusChoices.SENT
+        )
+
+    def test_by_user(self):
+        other_user = create_user(username='other_user')
+        other_notification = create_test_email_notification(user=other_user)
+
+        result = EmailNotification.objects.by_user(self.user)
+        assert self.email_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_email_notification(user=other_user)
+
+        result = EmailNotification.objects.by_users([self.user, other_user])
+        assert self.email_notification in result
+        assert other_notification in result
+
+    def test_is_sent(self):
+        pending_notification = create_test_email_notification(
+            user=self.user,
+            status=NotificationStatusChoices.PENDING
+        )
+
+        result = EmailNotification.objects.is_sent()
+        assert self.email_notification in result
+        assert pending_notification not in result

django_spire/notification/exceptions.py

@@ -1,5 +1,20 @@
-from django_spire.exceptions import DjangoSpireException
+from __future__ import annotations
 
+from typing import TYPE_CHECKING
 
-class NotificationException(DjangoSpireException):
+from django_spire.exceptions import DjangoSpireError
+
+if TYPE_CHECKING:
+    from django_spire.notification.choices import NotificationTypeChoices
+
+
+class NotificationError(DjangoSpireError):
     pass
+
+
+class InvalidNotificationTypeError(NotificationError):
+    def __init__(self, expected_type: NotificationTypeChoices, actual_type: NotificationTypeChoices) -> None:
+        super().__init__(
+            f'Expected notification type {expected_type}, '
+            f'but received {actual_type}'
+        )

django_spire/notification/managers.py

@@ -1,9 +1,15 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
 from django_spire.notification.app.processor import AppNotificationProcessor
 from django_spire.notification.email.processor import EmailNotificationProcessor
-from django_spire.notification.models import Notification
 from django_spire.notification.processors.notification import NotificationProcessor
 from django_spire.notification.sms.processor import SMSNotificationProcessor
 
+if TYPE_CHECKING:
+    from django_spire.notification.models import Notification
+
 
 class NotificationManager:
     @staticmethod

django_spire/notification/maps.py

@@ -1,12 +1,15 @@
+from __future__ import annotations
+
 from django_spire.notification.app.models import AppNotification
 from django_spire.notification.choices import NotificationTypeChoices
 from django_spire.notification.email.models import EmailNotification
 from django_spire.notification.push.models import PushNotification
 from django_spire.notification.sms.models import SmsNotification
 
+
 NOTIFICATION_TYPE_CHOICE_TO_MODEL_MAP: dict[NotificationTypeChoices, type] = {
     NotificationTypeChoices.APP: AppNotification,
     NotificationTypeChoices.EMAIL: EmailNotification,
     NotificationTypeChoices.PUSH: PushNotification,
     NotificationTypeChoices.SMS: SmsNotification
-}
+}

django_spire/notification/mixins.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from django.contrib.contenttypes.fields import GenericRelation
 from django.db import models
 

django_spire/notification/models.py

@@ -8,7 +8,9 @@ from django.contrib.contenttypes.fields import GenericForeignKey
 
 from django_spire.history.mixins import HistoryModelMixin
 from django_spire.notification.choices import (
-    NotificationTypeChoices, NotificationPriorityChoices, NotificationStatusChoices,
+    NotificationPriorityChoices,
+    NotificationStatusChoices,
+    NotificationTypeChoices
 )
 from django_spire.notification.querysets import NotificationQuerySet
 

django_spire/notification/processors/notification.py

@@ -1,10 +1,14 @@
+from __future__ import annotations
+
 from collections import defaultdict
 
 from django_spire.notification.app.processor import AppNotificationProcessor
-from django_spire.notification.choices import NotificationStatusChoices, \
+from django_spire.notification.choices import (
+    NotificationStatusChoices,
     NotificationTypeChoices
+)
 from django_spire.notification.email.processor import EmailNotificationProcessor
-from django_spire.notification.exceptions import NotificationException
+from django_spire.notification.exceptions import NotificationError
 from django_spire.notification.models import Notification
 from django_spire.notification.processors.processor import BaseNotificationProcessor
 from django_spire.notification.sms.processor import SMSNotificationProcessor
@@ -13,10 +17,13 @@ from django_spire.notification.sms.processor import SMSNotificationProcessor
 class NotificationProcessor(BaseNotificationProcessor):
     def process(self, notification: Notification):
         processor = self._get_processor(notification.type)
+
         if processor is None:
             notification.status = NotificationStatusChoices.FAILED
             notification.save()
-            raise NotificationException(f'Unknown notification type: {notification.type}')
+
+            message = f'Unknown notification type: {notification.type}'
+            raise NotificationError(message)
 
         processor().process(notification)
 
@@ -45,10 +52,10 @@ class NotificationProcessor(BaseNotificationProcessor):
         if notification_type == NotificationTypeChoices.APP:
             return AppNotificationProcessor
 
-        elif notification_type == NotificationTypeChoices.EMAIL:
+        if notification_type == NotificationTypeChoices.EMAIL:
             return EmailNotificationProcessor
 
-        elif notification_type == NotificationTypeChoices.SMS:
+        if notification_type == NotificationTypeChoices.SMS:
             return SMSNotificationProcessor
 
         return None

django_spire/notification/processors/processor.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from abc import ABC, abstractmethod
 
 from django_spire.notification.choices import NotificationStatusChoices

django_spire/notification/processors/tests/test_notification.py

@@ -0,0 +1,106 @@
+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.app.models import AppNotification
+from django_spire.notification.choices import (
+    NotificationStatusChoices,
+    NotificationTypeChoices,
+)
+from django_spire.notification.exceptions import NotificationError
+from django_spire.notification.models import Notification
+from django_spire.notification.processors.notification import NotificationProcessor
+
+
+class NotificationProcessorTests(BaseTestCase):
+    def setUp(self):
+        super().setUp()
+
+        self.user = create_user(username='test_processor_user')
+        self.processor = NotificationProcessor()
+
+    def _create_notification(self, **kwargs) -> Notification:
+        data = {
+            'user': self.user,
+            'type': NotificationTypeChoices.APP,
+            'title': 'Test Notification',
+            'body': 'Test body',
+            'status': NotificationStatusChoices.PENDING,
+        }
+        data.update(kwargs)
+        notification = Notification.objects.create(**data)
+
+        if data['type'] == NotificationTypeChoices.APP:
+            AppNotification.objects.create(notification=notification)
+
+        return notification
+
+    @patch('django_spire.notification.processors.notification.AppNotificationProcessor')
+    def test_process_app_notification(self, mock_processor_class: MagicMock):
+        mock_processor = MagicMock()
+        mock_processor_class.return_value = mock_processor
+
+        notification = self._create_notification(type=NotificationTypeChoices.APP)
+
+        self.processor.process(notification)
+
+        mock_processor.process.assert_called_once_with(notification)
+
+    @patch('django_spire.notification.processors.notification.EmailNotificationProcessor')
+    def test_process_email_notification(self, mock_processor_class: MagicMock):
+        mock_processor = MagicMock()
+        mock_processor_class.return_value = mock_processor
+
+        notification = self._create_notification(type=NotificationTypeChoices.EMAIL)
+
+        self.processor.process(notification)
+
+        mock_processor.process.assert_called_once_with(notification)
+
+    @patch('django_spire.notification.processors.notification.SMSNotificationProcessor')
+    def test_process_sms_notification(self, mock_processor_class: MagicMock):
+        mock_processor = MagicMock()
+        mock_processor_class.return_value = mock_processor
+
+        notification = self._create_notification(type=NotificationTypeChoices.SMS)
+
+        self.processor.process(notification)
+
+        mock_processor.process.assert_called_once_with(notification)
+
+    def test_process_unknown_type_raises_error(self):
+        notification = self._create_notification()
+        notification.type = 'unknown'
+
+        with pytest.raises(NotificationError):
+            self.processor.process(notification)
+
+    def test_process_unknown_type_sets_status_failed(self):
+        notification = self._create_notification()
+        notification.type = 'unknown'
+
+        with pytest.raises(NotificationError):
+            self.processor.process(notification)
+
+        notification.refresh_from_db()
+        assert notification.status == NotificationStatusChoices.FAILED
+
+    @patch('django_spire.notification.processors.notification.AppNotificationProcessor')
+    def test_process_list_groups_by_type(self, mock_processor_class: MagicMock):
+        mock_processor = MagicMock()
+        mock_processor_class.return_value = mock_processor
+
+        notifications = [
+            self._create_notification(type=NotificationTypeChoices.APP),
+            self._create_notification(type=NotificationTypeChoices.APP),
+        ]
+
+        self.processor.process_list(notifications)
+
+        mock_processor.process_list.assert_called_once()
+        call_args = mock_processor.process_list.call_args[0][0]
+        assert len(call_args) == 2

django_spire/notification/push/admin.py

@@ -1,3 +1,12 @@
+from __future__ import annotations
+
 from django.contrib import admin
 
-# Register your models here.
+from django_spire.notification.push.models import PushNotification
+
+
+@admin.register(PushNotification)
+class PushNotificationAdmin(admin.ModelAdmin):
+    list_display = ('id', 'created_datetime', 'is_active', 'is_deleted')
+    list_filter = ('is_active', 'is_deleted')
+    ordering = ('-created_datetime',)

django_spire/notification/push/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 NotificationPushConfig(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/push/models.py

@@ -1,11 +1,10 @@
-from django.db import models
+from __future__ import annotations
 
 from django_spire.history.mixins import HistoryModelMixin
 
 
 class PushNotification(HistoryModelMixin):
-
     class Meta:
         db_table = 'django_spire_notification_push'
         verbose_name = 'Push Notification'
-        verbose_name_plural = 'Push Notifications'
+        verbose_name_plural = 'Push Notifications'

django_spire/notification/push/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.push.apps import NotificationPushConfig
+
+
+class NotificationPushConfigTests(BaseTestCase):
+    def test_app_name(self):
+        assert NotificationPushConfig.name == 'django_spire.notification.push'
+
+    def test_app_label(self):
+        assert NotificationPushConfig.label == 'django_spire_notification_push'
+
+    def test_default_auto_field(self):
+        assert NotificationPushConfig.default_auto_field == 'django.db.models.BigAutoField'
+
+    def test_required_apps(self):
+        expected = ('django_spire_core', 'django_spire_notification')
+        assert expected == NotificationPushConfig.REQUIRED_APPS
+
+    def test_app_is_installed(self):
+        assert apps.is_installed('django_spire.notification.push')

django_spire/notification/push/tests/test_models.py

@@ -0,0 +1,28 @@
+from __future__ import annotations
+
+from django_spire.core.tests.test_cases import BaseTestCase
+from django_spire.notification.push.models import PushNotification
+
+
+class PushNotificationModelTests(BaseTestCase):
+    def setUp(self):
+        super().setUp()
+        self.push_notification = PushNotification.objects.create()
+
+    def test_created_datetime_auto_set(self):
+        assert self.push_notification.created_datetime is not None
+
+    def test_is_active_default_true(self):
+        assert self.push_notification.is_active is True
+
+    def test_is_deleted_default_false(self):
+        assert self.push_notification.is_deleted is False
+
+    def test_meta_verbose_name(self):
+        assert PushNotification._meta.verbose_name == 'Push Notification'
+
+    def test_meta_verbose_name_plural(self):
+        assert PushNotification._meta.verbose_name_plural == 'Push Notifications'
+
+    def test_meta_db_table(self):
+        assert PushNotification._meta.db_table == 'django_spire_notification_push'

django_spire/notification/querysets.py

@@ -1,7 +1,9 @@
+from __future__ import annotations
+
 from collections import defaultdict
+from typing import TYPE_CHECKING
 
 from django.contrib.admin.options import get_content_type_for_model
-from django.contrib.auth.models import User
 from django.db.models import QuerySet, Q, Model
 from django.utils.timezone import now
 
@@ -12,6 +14,9 @@ from django_spire.notification.choices import (
     NotificationPriorityChoices,
 )
 
+if TYPE_CHECKING:
+    from django.contrib.auth.models import User
+
 
 class NotificationQuerySet(HistoryQuerySet):
     def app_notifications(self):
@@ -108,6 +113,7 @@ class NotificationContentObjectQuerySet(QuerySet):
             ].append(content_object.pk)
 
         queries = Q()
+
         for content_type, object_ids in content_type_to_object_ids.items():
             queries |= Q(
                 notification__content_type=content_type,

django_spire/notification/sms/admin.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from django.contrib import admin
 from django.urls import reverse
 from django.utils.html import format_html

django_spire/notification/sms/apps.py

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

django_spire/notification/sms/automations.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from django_spire.notification.sms.models import SmsTemporaryMedia
 from django_spire.notification.sms.tools import update_unsent_notification_status_for_deleted_temporary_media
 

django_spire/notification/sms/choices.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from django.db import models
 
 

django_spire/notification/sms/exceptions.py

@@ -1,17 +1,31 @@
-from django_spire.exceptions import DjangoSpireException
+from __future__ import annotations
 
+from django_spire.exceptions import DjangoSpireError
 
-class SmsNotificationException(DjangoSpireException):
+
+class SmsNotificationError(DjangoSpireError):
     pass
 
 
-class SmsTemporaryMediaException(SmsNotificationException):
+class SmsTemporaryMediaError(SmsNotificationError):
     pass
 
 
-class TwilioException(Exception):
+class TwilioError(Exception):
     pass
 
 
-class TwilioAPIConcurrentException(TwilioException):
+class InvalidPhoneNumberError(TwilioError):
+    def __init__(self, phone_number: str) -> None:
+        super().__init__(f'Invalid phone number format: {phone_number}')
+
+
+class TwilioResponseError(TwilioError):
+    def __init__(self, error_code: int | None, error_message: str | None) -> None:
+        super().__init__(
+            f'Twilio Error: code={error_code}, message={error_message}'
+        )
+
+
+class TwilioAPIConcurrentError(TwilioError):
     pass

django_spire/notification/sms/helper.py

@@ -1,17 +1,27 @@
+from __future__ import annotations
+
 import time
+
 from collections import defaultdict
 
 from django.utils.timezone import now
-from twilio.rest.api.v2010.account.message import MessageInstance
-from twilio.rest import Client
 
 from django.conf import settings
 
 from django_spire.notification.choices import NotificationStatusChoices
-from django_spire.notification.models import Notification
 from django_spire.notification.sms.consts import TWILIO_UNSUCCESSFUL_STATUSES
-from django_spire.notification.sms.exceptions import TwilioException, \
-    TwilioAPIConcurrentException
+from django_spire.notification.sms.exceptions import (
+    InvalidPhoneNumberError,
+    TwilioAPIConcurrentError,
+    TwilioError,
+    TwilioResponseError
+)
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from django_spire.notification.models import Notification
+    from twilio.rest.api.v2010.account.message import MessageInstance
+    from twilio.rest import Client
 
 
 class BulkTwilioSMSHelper:
@@ -31,6 +41,7 @@ class BulkTwilioSMSHelper:
         self._find_notification_segments()
 
         sent_segments = 0
+
         for notification, segments in self.notification_segments.items():
             try:
                 TwilioSMSHelper(notification, self.client).send()
@@ -44,18 +55,17 @@ class BulkTwilioSMSHelper:
                     sent_segments = 0
 
             except Exception as e:
-                if isinstance(e, TwilioAPIConcurrentException):
+                if isinstance(e, TwilioAPIConcurrentError):
                     notification.status = NotificationStatusChoices.PENDING
 
-                if isinstance(e, TwilioException):
+                if isinstance(e, TwilioError):
                     notification.status_message = str(e)
                     notification.status = NotificationStatusChoices.ERRORED
-                    raise e
+                    raise
 
-                else:
-                    notification.status_message = str(e)
-                    notification.status = NotificationStatusChoices.FAILED
-                    raise e
+                notification.status_message = str(e)
+                notification.status = NotificationStatusChoices.FAILED
+                raise
 
 
 class TwilioSMSHelper:
@@ -69,14 +79,17 @@ class TwilioSMSHelper:
 
     def _attempt_send(self) -> MessageInstance:
         try:
+            media_url = self.notification.sms.media_url
+
             return self.client.messages.create(
                 to=self.to_phone_number,
                 from_=settings.TWILIO_PHONE_NUMBER,
                 body=self.message,
-                media_url=[self.notification.sms.media_url] if self.notification.sms.media_url else [],
+                media_url=[media_url] if media_url else [],
             )
         except Exception as e:
-            raise TwilioException(f'Twilio Exception: {str(e)}')
+            message = f'Twilio Error: {e!s}'
+            raise TwilioError(message) from e
 
     def send(self):
         response = self._attempt_send()
@@ -84,16 +97,15 @@ class TwilioSMSHelper:
 
     def _handle_response(self, response: MessageInstance):
         if response.error_code == 429:
-            raise TwilioAPIConcurrentException(
-                'Twilio API concurrent request limit exceeded.'
-            )
+            raise TwilioAPIConcurrentError
+
         if response.status in TWILIO_UNSUCCESSFUL_STATUSES:
             retry_response = self._attempt_send()
 
             if retry_response.status in TWILIO_UNSUCCESSFUL_STATUSES:
-                raise TwilioException(
-                    f'Twilio Exception: code={retry_response.error_code}, '
-                    f'message={retry_response.error_message}'
+                raise TwilioResponseError(
+                    retry_response.error_code,
+                    retry_response.error_message
                 )
 
     @staticmethod
@@ -105,8 +117,6 @@ class TwilioSMSHelper:
         elif len(cleaned_number) == 11 and cleaned_number.startswith('1'):
             formatted_number = cleaned_number
         else:
-            raise TwilioException(
-                f'Invalid phone number format: {phone_number}.'
-            )
+            raise InvalidPhoneNumberError(phone_number)
 
         return '+' + formatted_number

django_spire/notification/sms/models.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from django.contrib.sites.models import Site
 from django.db import models
 from django.urls import reverse
@@ -5,8 +7,10 @@ from django.utils.timezone import now
 
 from django_spire.notification.models import Notification
 from django_spire.notification.sms.choices import SmsMediaContentTypeChoices
-from django_spire.notification.sms.querysets import SmsNotificationQuerySet, \
+from django_spire.notification.sms.querysets import (
+    SmsNotificationQuerySet,
     SmsTemporaryMediaQuerySet
+)
 
 
 class SmsTemporaryMedia(models.Model):