django-spire 0.23.4__py3-none-any.whl

django_spire/notification/admin.py

@@ -0,0 +1,32 @@
+from django.contrib import admin
+from django.utils.html import format_html
+
+from django_spire.notification import models
+
+
+@admin.register(models.Notification)
+class NotificationAdmin(admin.ModelAdmin):
+    list_display = (
+        'id', 'title', 'type', 'user', 'view_body_snippet', 'url_link', 'status',
+        'status_message', 'priority', 'sent_datetime', 'publish_datetime',
+        'content_type', 'object_id', 'is_deleted'
+    )
+    list_filter = ('type',)
+    search_fields = ('id', 'title', 'type')
+
+    def view_body_snippet(self, notification: models.Notification) -> str:
+        return (
+            notification.body[:20] + '...'
+            if len(notification.body) > 20
+            else notification.body
+        )
+
+    view_body_snippet.short_description = 'Body Snippet'
+
+    def url_link(self, notification: models.Notification) -> str:
+        if notification.url:
+            return format_html(f'<a href="{notification.url}" target="_blank">Link</a>')
+
+        return 'No URL'
+
+    url_link.short_description = 'Notification URL'

django_spire/notification/app/admin.py

@@ -0,0 +1,10 @@
+from django.contrib import admin
+
+from django_spire.notification.app.models import AppNotification
+
+
+@admin.register(AppNotification)
+class AppNotificationAdmin(admin.ModelAdmin):
+    list_display = (
+        'id', 'notification', 'created_datetime', 'is_deleted'
+    )

django_spire/notification/app/apps.py

@@ -0,0 +1,14 @@
+from django.apps import AppConfig
+
+from django_spire.utils import check_required_apps
+
+
+class NotificationAppConfig(AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
+    name = 'django_spire.notification.app'
+    label = 'django_spire_notification_app'
+
+    REQUIRED_APPS = ('django_spire_core', 'django_spire_notification')
+
+    def ready(self) -> None:
+        check_required_apps(self.label)

django_spire/notification/app/context_data.py

@@ -0,0 +1,36 @@
+from __future__ import annotations
+
+import json
+
+from typing import TYPE_CHECKING
+
+from django_spire.notification.app.models import AppNotification
+
+if TYPE_CHECKING:
+    from django.core.handlers.wsgi import WSGIRequest
+
+
+def app_notification_dropdown_context_data(user: WSGIRequest) -> dict:
+    app_notification_list = (
+        AppNotification.objects.active()
+        .annotate_is_viewed_by_user(user)
+        .order_by('-created_datetime')
+        .select_related('notification')
+        .distinct()
+    )
+
+    formatted_notification_data = [
+        {
+            'id': app_notification.id,
+            'title': app_notification.notification.title,
+            'body': app_notification.notification.message,
+            'url': app_notification.notification.url,
+            'time_since_delivered': app_notification.verbose_time_since_delivered,
+            'viewed': app_notification.viewed
+        }
+        for app_notification in app_notification_list
+    ]
+
+    return {
+        'notification_list_json': json.dumps(formatted_notification_data),
+    }

django_spire/notification/app/exceptions.py

@@ -0,0 +1,5 @@
+from django_spire.exceptions import DjangoSpireException
+
+
+class AppNotificationException(DjangoSpireException):
+    pass

django_spire/notification/app/migrations/0001_initial.py

@@ -0,0 +1,34 @@
+# Generated by Django 5.2.1 on 2025-05-15 20:20
+
+import django.db.models.deletion
+import django.utils.timezone
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        ('django_spire_notification', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='AppNotification',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('is_active', models.BooleanField(default=True, editable=False)),
+                ('is_deleted', models.BooleanField(default=False, editable=False)),
+                ('created_datetime', models.DateTimeField(default=django.utils.timezone.localtime, editable=False)),
+                ('template', models.TextField(default='django_spire/notification/app/item/notification_item.html')),
+                ('context_data', models.JSONField(default=dict)),
+                ('notification', models.OneToOneField(editable=False, on_delete=django.db.models.deletion.CASCADE, related_name='app', related_query_name='app', to='django_spire_notification.notification')),
+            ],
+            options={
+                'verbose_name': 'App Notification',
+                'verbose_name_plural': 'App Notifications',
+                'db_table': 'django_spire_notification_app',
+            },
+        ),
+    ]

django_spire/notification/app/models.py

@@ -0,0 +1,63 @@
+import json
+
+from django.db import models
+from django.utils.timezone import localtime
+
+from django_spire.history.mixins import HistoryModelMixin
+from django_spire.history.viewed.mixins import ViewedModelMixin
+from django_spire.notification.app.querysets import AppNotificationQuerySet
+from django_spire.notification.models import Notification
+
+
+class AppNotification(ViewedModelMixin, HistoryModelMixin):
+    notification = models.OneToOneField(
+        Notification,
+        editable=False,
+        on_delete=models.CASCADE,
+        related_name='app',
+        related_query_name='app',
+    )
+    template = models.TextField(default='django_spire/notification/app/item/notification_item.html')
+    context_data = models.JSONField(default=dict)
+
+    objects = AppNotificationQuerySet.as_manager()
+
+    def __str__(self):
+        return f'{self.notification.title}'
+
+    @property
+    def verbose_time_since_delivered(self) -> str:
+        delta = localtime() - self.notification.sent_datetime
+
+        seconds = abs(delta.total_seconds())
+        minutes = seconds // 60
+        hours = minutes // 60
+        days = hours // 24
+
+        if days > 0:
+            return f"{int(days)} day{'s' if days != 1 else ''} ago"
+        elif hours > 0:
+            return f"{int(hours)} hour{'s' if hours != 1 else ''} ago"
+        elif minutes > 0:
+            return f"{int(minutes)} minute{'s' if minutes != 1 else ''} ago"
+        else:
+            return "just now"
+
+    def as_dict(self) -> dict:
+        return {
+            'id': self.id,
+            'title': self.notification.title,
+            'body': self.notification.body,
+            'context_data': self.context_data,
+            'priority': self.notification.priority,
+            'url': self.notification.url,
+            'time_since_delivered': self.verbose_time_since_delivered,
+        }
+
+    def as_json(self) -> str:
+        return json.dumps(self.as_dict())
+
+    class Meta:
+        db_table = 'django_spire_notification_app'
+        verbose_name = 'App Notification'
+        verbose_name_plural = 'App Notifications'

django_spire/notification/app/processor.py

@@ -0,0 +1,74 @@
+from django.utils.timezone import now
+
+from django_spire.notification.app.exceptions import AppNotificationException
+from django_spire.notification.choices import NotificationTypeChoices, \
+    NotificationStatusChoices
+from django_spire.notification.exceptions import NotificationException
+from django_spire.notification.models import Notification
+from django_spire.notification.processors.processor import BaseNotificationProcessor
+
+
+class AppNotificationProcessor(BaseNotificationProcessor):
+    def process(self, notification: Notification):
+        try:
+            if notification.type != NotificationTypeChoices.APP:
+                raise NotificationException(
+                    f'AppNotificationProcessor only processes '
+                    f'App notifications. Was provided {notification.type}'
+                )
+
+            if notification.user_id is None:
+                raise AppNotificationException(
+                    'AppNotifications must have a user associated with them'
+                )
+
+        except Exception as e:
+            notification.status = NotificationStatusChoices.ERRORED
+            notification.status_message = str(e)
+            notification.save()
+            raise e
+
+        notification.status = NotificationStatusChoices.SENT
+        notification.sent_datetime = now()
+
+        notification.save()
+
+    def process_list(self, notifications: list):
+        self._update_notifications_to_processing(notifications)
+
+        for notification in notifications:
+            try:
+                if notification.type != NotificationTypeChoices.APP:
+                    raise NotificationException(
+                        f'AppNotificationProcessor only processes '
+                        f'App notifications. Was provided {notification.type}'
+                    )
+
+                if notification.user_id is None:
+                    raise AppNotificationException(
+                        'AppNotifications must have a user associated with them'
+                    )
+
+                notification.status = NotificationStatusChoices.SENT
+                notification.sent_datetime = now()
+
+            except Exception as e:
+                notification.status = NotificationStatusChoices.ERRORED
+                notification.status_message = str(e)
+
+                Notification.objects.bulk_update(
+                    notifications,
+                    ['status', 'sent_datetime', 'status_message']
+                )
+                raise e
+
+        Notification.objects.bulk_update(
+            notifications,
+            ['status', 'sent_datetime', 'status_message']
+        )
+
+    def process_ready(self):
+        self.process_list(Notification.objects.app_notifications().ready_to_send().active())
+
+    def process_errored(self):
+        self.process_list(Notification.objects.app_notifications().errored().active())

django_spire/notification/app/querysets.py

@@ -0,0 +1,43 @@
+from __future__ import annotations
+from typing import TYPE_CHECKING
+from django.db.models import QuerySet, Value, When, Case, BooleanField, IntegerField
+
+from django_spire.history.querysets import HistoryQuerySet
+from django_spire.notification.choices import NotificationStatusChoices, NotificationPriorityChoices
+from django_spire.notification.querysets import NotificationContentObjectQuerySet
+
+if TYPE_CHECKING:
+    from django.contrib.auth.models import User
+
+
+class AppNotificationQuerySet(HistoryQuerySet, NotificationContentObjectQuerySet):
+    def annotate_is_viewed_by_user(self, user: User) -> QuerySet:
+        return self.by_user(user=user).annotate(viewed=Case(
+            When(views__user=user, then=Value(True)),
+            default=Value(False),
+            output_field=BooleanField()
+        ))
+
+    def ordered_by_priority_and_sent_datetime(self):
+        priority_order = Case(
+            When(notification__priority=NotificationPriorityChoices.LOW, then=Value(3)),
+            When(notification__priority=NotificationPriorityChoices.MEDIUM, then=Value(2)),
+            When(notification__priority=NotificationPriorityChoices.HIGH, then=Value(1)),
+            output_field=IntegerField(),
+        )
+        return self.annotate(priority_order=priority_order).order_by(
+            '-notification__sent_datetime',
+            'priority_order'
+        )
+
+    def by_user(self, user: User) -> QuerySet:
+        return self.filter(notification__user=user)
+
+    def by_users(self, users: list[User]):
+        return self.filter(notification__user__in=users)
+
+    def exclude_viewed_by_user(self, user: User) -> QuerySet:
+        return self.by_user(user=user).exclude(views__user=user)
+
+    def is_sent(self) -> QuerySet:
+        return self.filter(notification__status=NotificationStatusChoices.SENT)

django_spire/notification/app/templates/django_spire/notification/app/card/list_card.html

@@ -0,0 +1,11 @@
+{% extends 'django_spire/card/title_card.html' %}
+
+{% block card_title %}
+    Notification List
+{% endblock %}
+
+{% block card_title_content %}
+    {% for app_notification in notification_list %}
+        {% include app_notification.template %}
+    {% endfor %}
+{% endblock %}

django_spire/notification/app/templates/django_spire/notification/app/dropdown/notification_dropdown.html

@@ -0,0 +1,48 @@
+{% extends "django_spire/dropdown/dropdown.html" %}
+
+{% block dropdown_trigger %}
+    <div x-data="{
+        new_notification: false,
+        async init(){
+            await this.check_new_notifications()
+            setInterval(await this.check_new_notifications, 30000);
+        },
+
+        async check_new_notifications(){
+            let url = '{% url "django_spire:notification:app:json:check_new" %}'
+            let response = await django_glue_fetch(url)
+            this.new_notification = response.has_new_notifications
+        },
+
+        async render_dropdown(){
+            let dropdown_content = new ViewGlue(
+                url='{% url "django_spire:notification:app:template:notification_dropdown" %}',
+                shared_payload={app_notification_list_url: '{{ app_notification_list_url|default:"" }}'}
+            )
+            await dropdown_content.render_inner($refs.spire_notification_dropdown_content)
+            await this.mark_notifications_as_viewed()
+        },
+
+        async mark_notifications_as_viewed(){
+            let response = await django_glue_fetch('{% url "django_spire:notification:app:json:set_viewed" %}')
+            this.new_notification = false
+        }
+
+    }"
+    class="position-relative">
+        <span @click='await render_dropdown()'>
+            {% block notification_dropdown_trigger %}
+                <i x-bind='trigger' class="bi bi-bell-fill fs-4 cursor-pointer position-absolute"></i>
+                <span x-show="new_notification"  x-cloak style="width: 10px; height: 10px; top: -1px; right: -24px;" class="bg-danger rounded-circle position-absolute"></span>
+            {% endblock  %}
+        </span>
+    </div>
+
+{% endblock %}
+
+{% block dropdown_style %}z-index: 100 !important;{% endblock  %}
+{% block dropdown_position %}top-100 end-50{% endblock %}
+
+{% block dropdown_content %}
+    <div x-ref="spire_notification_dropdown_content"></div>
+{% endblock %}

django_spire/notification/app/templates/django_spire/notification/app/dropdown/notification_dropdown_content.html

@@ -0,0 +1,33 @@
+<div
+    :style="window.innerWidth < 768
+    ? 'width: 350px; position: fixed; top: 5%; left: 50%; transform: translateX(-50%);'
+    : 'width: 350px'"
+    class="container border rounded-2 bg-app-layer-two"
+>
+    <div class="col-12 w-100">
+        <h6 class="mt-2 ms-2 text-center">Notifications</h6>
+        <hr class="m-0">
+    </div>
+
+    <div
+        style="max-height: 300px !important;"
+        class="text-start overflow-y-scroll overflow-x-hidden"
+    >
+        {% for app_notification in app_notification_list %}
+            <div class="col-12">
+                {% include app_notification.template %}
+            </div>
+        {% empty %}
+            No Notifications
+        {% endfor %}
+    </div>
+    <div class="col-12">
+        <hr class="m-0">
+    </div>
+    <div class="col-12 fs-7 text-center py-1">
+        {% if not app_notification_list_url %}
+            {% url "django_spire:notification:app:page:list" as app_notification_list_url %}
+        {% endif %}
+        <a href='{{ app_notification_list_url }}' class="text-decoration-none text-app-secondary my-2">View All</a>
+    </div>
+</div>

django_spire/notification/app/templates/django_spire/notification/app/element/notification_bell.html

@@ -0,0 +1,8 @@
+{% extends "django_spire/notification/app/dropdown/notification_dropdown.html" %}
+
+{% block notification_dropdown_trigger %}
+    <div class="dropdown">
+        <i x-bind='trigger' class="bi bi-bell-fill fs-2 cursor-pointer mx-2"></i>
+        <span x-show="new_notification" x-cloak x-transition style="width: 10px; height: 10px; top: 8px; right: 10px; position: absolute;" class="bg-danger rounded-circle"></span>
+    </div>
+{% endblock %}

django_spire/notification/app/templates/django_spire/notification/app/item/notification_item.html

@@ -0,0 +1,25 @@
+<div class="row pt-1 px-3">
+    <div class="col-12">
+            <div class="row bg-app-layer-two-hover rounded">
+                {% if app_notification.notification.url %}
+                    <a href="{{ app_notification.notification.url }}" class="col-12">
+                {% endif %}
+                        <div class="col-12">
+                            <div>
+                                <span class="fs-7 fw-semibold">{{ app_notification.notification.title }}</span>
+                                {% if not app_notification.viewed %}
+                                    {% include 'django_spire/badge/primary_badge.html' with badge_text='New' %}
+                                {% endif %}
+                            </div>
+                            <span class="fs--1">{{ app_notification.notification.body }}</span><br>
+                            <span class="text-app-secondary text-muted fs--2">{{ app_notification.verbose_time_since_delivered }}</span>
+                        </div>
+                {% if app_notification.notification.url %}
+                    </a>
+                {% endif %}
+            </div>
+    </div>
+    {% if not forloop.last %}
+        <hr class="m-0 mt-1">
+    {% endif %}
+</div>

django_spire/notification/app/templates/django_spire/notification/app/page/list_page.html

@@ -0,0 +1,5 @@
+{% extends 'django_spire/page/full_page.html' %}
+
+{% block full_page_content %}
+    {% include "django_spire/notification/app/card/list_card.html" %}
+{% endblock  %}

django_spire/notification/app/tests.py

@@ -0,0 +1,3 @@
+from django.test import TestCase
+
+# Create your tests here.

django_spire/notification/app/urls/__init__.py

@@ -0,0 +1,10 @@
+from django.urls import include, path
+
+app_name = 'app'
+
+
+urlpatterns = [
+    path('json/', include('django_spire.notification.app.urls.json_urls', namespace='json')),
+    path('page/', include('django_spire.notification.app.urls.page_urls', namespace='page')),
+    path('template/', include('django_spire.notification.app.urls.template_urls', namespace='template')),
+]

django_spire/notification/app/urls/json_urls.py

@@ -0,0 +1,16 @@
+from django.urls import path
+
+from django_spire.notification.app.views import json_views
+
+
+app_name = 'django_spire_notification'
+
+urlpatterns = [
+    path('check/notification/ajax/',
+         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'),
+]

django_spire/notification/app/urls/page_urls.py

@@ -0,0 +1,13 @@
+from django.urls import path
+
+from django_spire.notification.app.views import page_views
+
+
+app_name = 'django_spire_notification'
+
+urlpatterns = [
+    path('django_spire/notification/list/',
+         view=page_views.app_notification_list_view,
+         name='list'
+    )
+]

django_spire/notification/app/urls/template_urls.py

@@ -0,0 +1,12 @@
+from django.urls import path
+
+from django_spire.notification.app.views import template_views
+
+
+app_name = 'django_spire_notification'
+
+urlpatterns = [
+    path('notficiation/dropdown/template/',
+         template_views.notification_dropdown_template_view,
+         name='notification_dropdown')
+]

django_spire/notification/app/views/json_views.py

@@ -0,0 +1,52 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from django.http import JsonResponse
+from django.contrib.contenttypes.models import ContentType
+from django.contrib.auth.decorators import login_required
+
+from django_spire.notification.app.models import AppNotification
+from django_spire.history.viewed.models import Viewed
+
+if TYPE_CHECKING:
+    from django.core.handlers.wsgi import WSGIRequest
+
+
+@login_required()
+def check_new_notifications_ajax_view(request: WSGIRequest) -> JsonResponse:
+    notifications = (
+        AppNotification.objects
+        .active()
+        .is_sent()
+        .exclude_viewed_by_user(request.user)
+    )
+
+    return JsonResponse({
+        'status': 200,
+        'has_new_notifications': bool(notifications)
+    })
+
+
+@login_required()
+def set_notifications_as_viewed_ajax(request: WSGIRequest) -> JsonResponse:
+    notification_list = (
+        AppNotification.objects
+        .active()
+        .is_sent()
+        .by_user(request.user)
+        .exclude_viewed_by_user(request.user)
+    )
+    ctype = ContentType.objects.get_for_model(AppNotification)
+    viewed_model_objects = [
+        Viewed(
+            user=request.user,
+            object_id=notification.id,
+            content_type=ctype
+        )
+        for notification in notification_list
+    ]
+
+    Viewed.objects.bulk_create(viewed_model_objects)
+
+    return JsonResponse({'status': 200, 'message': 'Notifications succesfully marked as viewed.'})

django_spire/notification/app/views/page_views.py

@@ -0,0 +1,32 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from django.contrib.auth.decorators import login_required
+
+from django_spire.contrib.generic_views import portal_views
+
+from django_spire.notification.app.models import AppNotification
+
+if TYPE_CHECKING:
+    from django.core.handlers.wsgi import WSGIRequest
+    from django.template.response import TemplateResponse
+
+
+@login_required()
+def app_notification_list_view(request: WSGIRequest) -> TemplateResponse:
+    app_notification_list = (
+        AppNotification.objects.active()
+        .is_sent()
+        .annotate_is_viewed_by_user(request.user)
+        .select_related('notification')
+        .distinct()
+        .ordered_by_priority_and_sent_datetime()
+    )
+
+    return portal_views.list_view(
+        request,
+        context_data={'notification_list': app_notification_list},
+        model=AppNotification,
+        template='django_spire/notification/app/page/list_page.html'
+    )

django_spire/notification/app/views/template_views.py

@@ -0,0 +1,39 @@
+from __future__ import annotations
+
+import json
+
+from typing import TYPE_CHECKING
+
+from django.contrib.auth.models import AnonymousUser
+from django.template.response import TemplateResponse
+
+from django_spire.notification.app.models import AppNotification
+
+if TYPE_CHECKING:
+    from django.core.handlers.wsgi import WSGIRequest
+
+
+def notification_dropdown_template_view(request: WSGIRequest) -> TemplateResponse:
+    if isinstance(request.user, AnonymousUser):
+        app_notification_list = []
+
+    else:
+        app_notification_list = (
+            AppNotification.objects.active()
+            .is_sent()
+            .annotate_is_viewed_by_user(request.user)
+            .select_related('notification')
+            .distinct()
+            .ordered_by_priority_and_sent_datetime()
+        )
+
+    body_data = json.loads(request.body.decode('utf-8'))
+
+    return TemplateResponse(
+        request,
+        context={
+            'app_notification_list': app_notification_list,
+            'app_notification_list_url': body_data.get('app_notification_list_url'),
+        },
+        template='django_spire/notification/app/dropdown/notification_dropdown_content.html'
+    )