vintasend-fastapi-mail 0.1.0__tar.gz

vintasend_fastapi_mail-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_fastapi_mail-0.1.0/PKG-INFO

@@ -0,0 +1,20 @@
+Metadata-Version: 2.3
+Name: vintasend-fastapi-mail
+Version: 0.1.0
+Summary: FastAPI Mail adapter for VintaSend
+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: fastapi-mail (>=1.4.2,<2.0.0)
+Requires-Dist: vintasend
+Description-Content-Type: text/markdown
+
+# VintaSend FastAPI Mail
+
+FastAPI Mail adapter for VintaSend

vintasend_fastapi_mail-0.1.0/README.md

@@ -0,0 +1,3 @@
+# VintaSend FastAPI Mail
+
+FastAPI Mail adapter for VintaSend

vintasend_fastapi_mail-0.1.0/pyproject.toml

@@ -0,0 +1,153 @@
+[tool.poetry]
+name = "vintasend-fastapi-mail"
+version = "0.1.0"
+description = "FastAPI Mail adapter for VintaSend"
+authors = ["Hugo bessa <hugo@vinta.com.br>"]
+license = "MIT"
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = "<3.13,>=3.10"
+vintasend = "*"
+fastapi-mail = "^1.4.2"
+
+
+[tool.poetry.group.dev.dependencies]
+coverage = "^7.6.4"
+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"
+
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[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",
+    # 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",
+    "third-party",
+    "first-party",
+    "local-folder",
+]
+lines-after-imports = 2
+
+[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]
+python_files = ["test_*.py"]
+addopts = "--dist=loadscope"

vintasend_fastapi_mail-0.1.0/vintasend_fastapi_mail/services/notification_adapters/fastapi_mail.py

@@ -0,0 +1,63 @@
+from typing import TYPE_CHECKING, Generic, TypeVar
+
+from fastapi_mail import FastMail, MessageSchema, ConnectionConfig
+
+from vintasend.constants import NotificationTypes
+
+from vintasend.services.dataclasses import Notification
+from vintasend.services.notification_backends.asyncio_base import AsyncIOBaseNotificationBackend
+from vintasend.services.notification_adapters.asyncio_base import AsyncIOBaseNotificationAdapter
+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
+
+
+B = TypeVar("B", bound=AsyncIOBaseNotificationBackend)
+T = TypeVar("T", bound=BaseTemplatedEmailRenderer)
+
+class FastAPIMailNotificationAdapter(Generic[B, T], AsyncIOBaseNotificationAdapter[B, T]):
+    notification_type = NotificationTypes.EMAIL
+    config: ConnectionConfig
+    fm: FastMail
+
+    def __init__(
+        self, *args, **kwargs
+    ) -> None:
+        super().__init__(*args, **kwargs)
+        self.fm = FastMail(self.config)
+
+    async 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 = await 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)
+
+        message = MessageSchema(
+            subject=template.subject.strip(),
+            recipients=to,
+            body=template.body,
+            subtype="html",
+            bcc=bcc,
+            headers=headers,
+        )
+        await self.fm.send_message(message)

vintasend_fastapi_mail-0.1.0/vintasend_fastapi_mail/services/tests/test_adapters.py

@@ -0,0 +1,105 @@
+import uuid
+import pytest
+import base64
+from unittest import IsolatedAsyncioTestCase
+
+from fastapi_mail import ConnectionConfig
+
+from vintasend.constants import NotificationStatus, NotificationTypes
+from vintasend.exceptions import (
+    NotificationTemplateRenderingError,
+)
+from vintasend.services.dataclasses import Notification
+from vintasend.services.notification_backends.stubs.fake_backend import FakeAsyncIOFileBackend, FakeFileBackend
+from vintasend_fastapi_mail.services.notification_adapters.fastapi_mail import FastAPIMailNotificationAdapter
+
+
+
+class FastAPIMailNotificationAdapterTestCase(IsolatedAsyncioTestCase):
+    def setup_method(self, method) -> None:
+        self.config = ConnectionConfig(
+            MAIL_USERNAME="test",
+            MAIL_PASSWORD="test",  # type: ignore
+            MAIL_FROM="foo@example.com",
+            MAIL_PORT=587,
+            MAIL_SERVER="smtp.example.com",
+            MAIL_STARTTLS=False,
+            MAIL_SSL_TLS=False,
+            TEMPLATE_FOLDER=None,
+            SUPPRESS_SEND=True,
+        )
+
+        super().setUp()
+
+    def teardown_method(self, method) -> None:
+        FakeFileBackend(database_file_name="fastapi-mail-adapter-test-notifications.json").clear()
+    
+    def teardown_class(self) -> None:
+        FakeFileBackend(database_file_name="fastapi-mail-adapter-test-notifications.json").clear()
+
+    def create_notification(self):
+        return Notification(
+            id=uuid.uuid4(),
+            user_id=uuid.uuid4(),
+            notification_type=NotificationTypes.EMAIL.value,
+            title="Test Notification",
+            body_template="Test Body",
+            context_name="test_context",
+            context_kwargs={"test": "test"},
+            send_after=None,
+            subject_template="Test Subject",
+            preheader_template="Test Preheader",
+            status=NotificationStatus.PENDING_SEND.value,
+        )
+
+    def create_notification_context(self):
+        return {"foo": "bar"}
+
+    @pytest.mark.asyncio
+    async def test_send_notification(self):
+        notification = self.create_notification()
+        context = self.create_notification_context()
+
+        backend = FakeAsyncIOFileBackend(database_file_name="fastapi-mail-adapter-test-notifications.json")
+        backend.notifications.append(notification)
+        await backend._store_notifications()
+
+        adapter = FastAPIMailNotificationAdapter(
+            "vintasend.services.notification_template_renderers.stubs.fake_templated_email_renderer.FakeTemplateRenderer",
+            "vintasend.services.notification_backends.stubs.fake_backend.FakeAsyncIOFileBackend",
+            backend_kwargs={"database_file_name": "fastapi-mail-adapter-test-notifications.json"},
+            config=self.config
+        )
+
+        with adapter.fm.record_messages() as outbox:
+            await adapter.send(notification, context)
+
+        assert len(outbox) == 1
+        email = outbox[0]
+        payload = email.get_payload(0).get_payload()
+        email_body = base64.b64decode(payload).decode("utf-8")
+        assert email["Subject"] == notification.subject_template
+        assert email_body == notification.body_template
+        assert email["To"] == "testemail@example.com"  # This is the email that the FakeFileBackend returns
+        assert email["From"] == "foo@example.com"  # This is the email that the FakeFileBackend returns
+
+    @pytest.mark.asyncio
+    async def test_send_notification_with_render_error(self):
+        notification = self.create_notification()
+        context = self.create_notification_context()
+
+        backend = FakeAsyncIOFileBackend(database_file_name="fastapi-mail-adapter-test-notifications.json")
+        backend.notifications.append(notification)
+        await backend._store_notifications()
+
+        adapter = FastAPIMailNotificationAdapter(
+            "vintasend.services.notification_template_renderers.stubs.fake_templated_email_renderer.FakeTemplateRendererWithException",
+            "vintasend.services.notification_backends.stubs.fake_backend.FakeAsyncIOFileBackend",
+            backend_kwargs={"database_file_name": "fastapi-mail-adapter-test-notifications.json"},
+            config=self.config
+        )
+        with adapter.fm.record_messages() as outbox:
+            with pytest.raises(NotificationTemplateRenderingError):
+                await adapter.send(notification, context)
+
+        assert len(outbox) == 0