vintasend-django 0.1.0__tar.gz

vintasend_django-0.1.0/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Vinta Serviços e Soluções Tecnológicas Ltda
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

vintasend_django-0.1.0/PKG-INFO

@@ -0,0 +1,21 @@
+Metadata-Version: 2.3
+Name: vintasend-django
+Version: 0.1.0
+Summary: A flexible package for implementing transactional notifications
+License: MIT
+Author: Hugo bessa
+Author-email: hugo@vinta.com.br
+Requires-Python: >=3.10,<3.13
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: django (>=3.2,<5.3)
+Requires-Dist: django-model-utils (>=5.0.0,<6.0.0)
+Requires-Dist: vintasend
+Description-Content-Type: text/markdown
+
+# VintaSend Django
+
+Django implementations for VintaSend

vintasend_django-0.1.0/README.md

@@ -0,0 +1,3 @@
+# VintaSend Django
+
+Django implementations for VintaSend

vintasend_django-0.1.0/pyproject.toml

@@ -0,0 +1,171 @@
+[tool.poetry]
+name = "vintasend-django"
+version = "0.1.0"
+description = "A flexible package for implementing transactional notifications"
+authors = ["Hugo bessa <hugo@vinta.com.br>"]
+license = "MIT"
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = "<3.13,>=3.10"
+django = "<5.3,>=3.2"
+vintasend = "*"
+django-model-utils = "^5.0.0"
+
+
+[tool.poetry.group.dev.dependencies]
+freezegun = "^1.5.1"
+coverage = "^7.6.4"
+django-stubs = {version = "^5.1.1", extras=["compatible-mypy"]}
+tox = "^4.23.2"
+pytest = "^8.3.3"
+pytest-xdist = {version = "^3.6.1", extras=["psutil"]}
+coveralls = "^4.0.1"
+pytest-cov = "^6.0.0"
+pytest-django = "^4.9.0"
+model-bakery = "^1.20.0"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.mypy]
+plugins = ["mypy_django_plugin.main"]
+
+[tool.django-stubs]
+django_settings_module = "settings.test"
+
+[tool.ruff]
+select = [
+    # pycodestyle
+    "E",
+    # Pyflakes
+    "F",
+    # pep8-naming
+    "N",
+    # pyupgrade
+    "UP",
+    # flake8-bugbear
+    "B",
+    # flake8-bandit
+    "S",
+    # flake8-blind-except
+    "BLE",
+    # flake8-builtins
+    "A",
+    # flake8-django
+    "DJ",
+    # isort
+    "I",
+    # flake8-logging-format
+    "G",
+    # flake8-no-pep420
+    "INP",
+    # Ruff-specific rules
+    "RUF",
+]
+exclude = [
+    ".bzr",
+    ".direnv",
+    ".eggs",
+    ".git",
+    ".git-rewrite",
+    ".hg",
+    ".mypy_cache",
+    ".nox",
+    ".pants.d",
+    ".pytype",
+    ".ruff_cache",
+    ".svn",
+    ".tox",
+    ".venv",
+    "__pypackages__",
+    "_build",
+    "buck-out",
+    "build",
+    "dist",
+    "node_modules",
+    "venv",
+    "virtualenvs",
+    "*/migrations/*",
+]
+ignore = [
+    # Disable eradicate (commented code removal)
+    "ERA001",
+    # Disable Conflicting lint rules,
+    # see https://docs.astral.sh/ruff/formatter/#conflicting-lint-rules
+    "W191",
+    "E501",
+    "E111",
+    "E117",
+    "D206",
+    "D300",
+    "Q000",
+    "Q001",
+    "Q002",
+    "Q003",
+    "COM812",
+    "COM819",
+    "ISC001",
+    "ISC002",
+    # Allow `except Exception`:
+    "BLE001",
+    # Disable unused `noqa` directive
+    "RUF100",
+    # Disable pyupgrade UP rules that conflict with django-ninja
+    "UP006",
+    "UP035",
+    "UP037",
+    "UP040",
+]
+line-length = 100
+indent-width = 4
+target-version = "py312"
+# Allow unused variables when underscore-prefixed:
+dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+
+[tool.ruff.pycodestyle]
+ignore-overlong-task-comments = true
+
+[tool.ruff.lint.isort]
+section-order = [
+    "future",
+    "standard-library",
+    "django",
+    "third-party",
+    "first-party",
+    "local-folder",
+]
+lines-after-imports = 2
+
+[tool.ruff.lint.isort.sections]
+# Group all Django imports into a separate section.
+"django" = ["django"]
+
+[tool.ruff.per-file-ignores]
+# Ignore "E402", "F403", "F405" (import violations) in __init__.py files.
+# Ignore "S" (flake8-bandit) and "N802" (function name should be lowercase) in tests and docs.
+# Ignore "RUF" (Ruff-specific rules) and "I" (isort) in migrations.
+"__init__.py" = ["E402", "F403", "F405"]
+"**/{tests,docs}/*" = ["E402", "F403", "F405", "S", "N802"]
+"**/*test*.py" = ["E402", "F403", "F405", "S", "N802"]
+"**/{settings}/*" = ["E402", "F403", "F405"]
+"**/migrations/*" = ["RUF", "I"]
+
+[tool.coverage.run]
+branch = true
+source = ["backend"]
+omit = [
+    "**/venv/*",
+    "**/env/*",
+    "**/virtualenvs/*",
+    "**/node_modules/*",
+    "**/migrations/*",
+    "**/settings/*",
+    "**/tests/*",
+]
+
+[tool.pytest.ini_options]
+DJANGO_SETTINGS_MODULE = "settings.test"
+python_files = ["test_*.py"]
+addopts = "--dist=loadscope"

vintasend_django-0.1.0/vintasend_django/apps.py

@@ -0,0 +1,5 @@
+from django.apps import AppConfig
+
+
+class NotificationsConfig(AppConfig):
+    name = "vintasend_django"

vintasend_django-0.1.0/vintasend_django/constants.py

@@ -0,0 +1,18 @@
+from vintasend.constants import NotificationStatus, NotificationTypes
+from django.utils.translation import gettext_lazy as _
+from django.db.models import TextChoices
+
+
+class NotificationStatusChoices(TextChoices):
+    PENDING_SEND = NotificationStatus.PENDING_SEND.value, _("Pending Send")
+    SENT = NotificationStatus.SENT.value, _("Sent")
+    CANCELLED = NotificationStatus.CANCELLED.value, _("Cancelled")
+    FAILED = NotificationStatus.FAILED.value, _("Failed")
+    READ = NotificationStatus.READ.value, _("Read")
+
+
+class NotificationTypesChoices(TextChoices):
+    EMAIL = NotificationTypes.EMAIL.value, _("Email")
+    IN_APP = NotificationTypes.IN_APP.value, _("In App")
+    SMS = NotificationTypes.SMS.value, _("SMS")
+    PUSH = NotificationTypes.PUSH.value, _("Push")

vintasend_django-0.1.0/vintasend_django/migrations/0001_initial.py

@@ -0,0 +1,116 @@
+# Generated by Django 5.1.3 on 2024-11-09 16:09
+
+import django.db.models.deletion
+import django.utils.timezone
+import model_utils.fields
+from django.conf import settings
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="Notification",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                (
+                    "notification_type",
+                    models.CharField(
+                        choices=[
+                            ("EMAIL", "Email"),
+                            ("IN_APP", "In App"),
+                            ("SMS", "SMS"),
+                            ("PUSH", "Push"),
+                        ],
+                        max_length=50,
+                    ),
+                ),
+                ("title", models.CharField(max_length=255)),
+                (
+                    "status",
+                    models.CharField(
+                        choices=[
+                            ("PENDING_SEND", "Pending Send"),
+                            ("SENT", "Sent"),
+                            ("CANCELLED", "Cancelled"),
+                            ("FAILED", "Failed"),
+                            ("READ", "Read"),
+                        ],
+                        default="PENDING_SEND",
+                        max_length=50,
+                    ),
+                ),
+                ("body_template", models.CharField(max_length=255)),
+                ("subject_template", models.CharField(blank=True, max_length=255)),
+                ("preheader_template", models.CharField(blank=True, max_length=255)),
+                ("context_name", models.CharField(blank=True, max_length=255)),
+                ("context_kwargs", models.JSONField(default=dict)),
+                ("send_after", models.DateTimeField(null=True)),
+                (
+                    "created",
+                    model_utils.fields.AutoCreatedField(
+                        db_index=True,
+                        default=django.utils.timezone.now,
+                        editable=False,
+                        verbose_name="created",
+                    ),
+                ),
+                (
+                    "modified",
+                    model_utils.fields.AutoLastModifiedField(
+                        db_index=True,
+                        default=django.utils.timezone.now,
+                        editable=False,
+                        verbose_name="modified",
+                    ),
+                ),
+                (
+                    "context_used",
+                    models.JSONField(
+                        null=True,
+                        verbose_name="context used when notification was sent",
+                    ),
+                ),
+                (
+                    "user",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        to=settings.AUTH_USER_MODEL,
+                    ),
+                ),
+                (
+                    "adapter_extra_parameters",
+                    models.JSONField(
+                        null=True,
+                        verbose_name="Extra parameters for the notification adapter",
+                    ),
+                ),
+                (
+                    "adapter_used",
+                    models.CharField(
+                        max_length=255,
+                        null=True,
+                        verbose_name="Adapter used to send the notification",
+                    ),
+                ),
+            ],
+            options={
+                "ordering": ("-created",),
+            },
+        ),
+    ]

vintasend_django-0.1.0/vintasend_django/models.py

@@ -0,0 +1,43 @@
+from django.contrib.auth import get_user_model
+from django.db import models
+from django.utils.translation import gettext_lazy as _
+
+from model_utils.fields import AutoCreatedField, AutoLastModifiedField
+
+from vintasend_django.constants import NotificationStatusChoices, NotificationTypesChoices
+
+
+User = get_user_model()
+
+class Notification(models.Model):
+    user = models.ForeignKey(User, on_delete=models.CASCADE)
+    notification_type = models.CharField(max_length=50, choices=NotificationTypesChoices)
+    title = models.CharField(max_length=255)
+    status = models.CharField(
+        max_length=50, choices=NotificationStatusChoices, default=NotificationStatusChoices.PENDING_SEND
+    )
+    body_template = models.CharField(max_length=255)
+
+    # Email specific fields
+    subject_template = models.CharField(max_length=255, blank=True)
+    preheader_template = models.CharField(max_length=255, blank=True)
+    context_name = models.CharField(max_length=255, blank=True)
+    context_kwargs = models.JSONField(default=dict)
+
+    send_after = models.DateTimeField(null=True)
+
+    created = AutoCreatedField(_("created"), db_index=True)
+    modified = AutoLastModifiedField(_("modified"), db_index=True)
+
+    adapter_extra_parameters = models.JSONField(_("adapter_extra_parameters"), null=True)
+
+    context_used = models.JSONField(_("context used when notification was sent"), null=True)
+    adapter_used = models.CharField(_("adapter used to send the notification"), max_length=255, null=True)
+
+    objects: models.Manager["Notification"]
+
+    class Meta:
+        ordering = ("-created",)
+
+    def __str__(self):
+        return f"{self.user} - {self.notification_type} - {self.title} - {self.status}{f' (scheduled to {self.send_after})' if self.send_after else ''}"

vintasend_django-0.1.0/vintasend_django/services/notification_adapters/django_email.py

@@ -0,0 +1,61 @@
+from typing import TYPE_CHECKING, Generic, TypeVar
+
+from django.contrib.auth import get_user_model
+from django.core.mail import EmailMessage
+
+from vintasend.constants import NotificationTypes
+
+from vintasend.services.dataclasses import Notification
+from vintasend.services.notification_backends.base import BaseNotificationBackend
+from vintasend.services.notification_adapters.base import BaseNotificationAdapter
+from vintasend.services.notification_template_renderers.base_templated_email_renderer import BaseTemplatedEmailRenderer
+from vintasend.app_settings import NotificationSettings
+
+
+if TYPE_CHECKING:
+    from vintasend.services.notification_service import NotificationContextDict
+
+
+User = get_user_model()
+
+
+B = TypeVar("B", bound=BaseNotificationBackend)
+T = TypeVar("T", bound=BaseTemplatedEmailRenderer)
+
+class DjangoEmailNotificationAdapter(Generic[B, T], BaseNotificationAdapter[B, T]):
+    notification_type = NotificationTypes.EMAIL
+
+    def send(
+        self,
+        notification: Notification,
+        context: "NotificationContextDict",
+        headers: dict[str, str] | None = None,
+    ) -> None:
+        """
+        Send the notification to the user through email.
+
+        :param notification: The notification to send.
+        :param context: The context to render the notification templates.
+        """
+        notification_settings = NotificationSettings()
+
+        user_email = self.backend.get_user_email_from_notification(notification.id)
+        to = [user_email]
+        bcc = [email for email in notification_settings.NOTIFICATION_DEFAULT_BCC_EMAILS] or []
+
+        context_with_base_url: "NotificationContextDict" = context.copy()
+        context_with_base_url["base_url"] = f"{notification_settings.NOTIFICATION_DEFAULT_BASE_URL_PROTOCOL}://{notification_settings.NOTIFICATION_DEFAULT_BASE_URL_DOMAIN}"
+
+        template = self.template_renderer.render(notification, context_with_base_url)
+
+        email = EmailMessage(
+            subject=template.subject.strip(),
+            body=template.body,
+            from_email=notification_settings.NOTIFICATION_DEFAULT_FROM_EMAIL,
+            to=to,
+            bcc=bcc,
+            headers=headers,
+        )
+        email.content_subtype = "html"
+
+        email.send()