vintasend-sqlalchemy 0.1.0__tar.gz

vintasend_sqlalchemy-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_sqlalchemy-0.1.0/PKG-INFO

@@ -0,0 +1,23 @@
+Metadata-Version: 2.3
+Name: vintasend-sqlalchemy
+Version: 0.1.0
+Summary: SQLAlchemy backend implementation 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: alembic (>=1.14.0,<2.0.0)
+Requires-Dist: greenlet (>=3.1.1,<4.0.0)
+Requires-Dist: pytest-asyncio (>=0.24.0,<0.25.0)
+Requires-Dist: sqlalchemy (>=2.0.36,<3.0.0)
+Requires-Dist: vintasend
+Description-Content-Type: text/markdown
+
+# VintaSend SQLAlchemy
+
+SQLAlchemy implementations for VintaSend

vintasend_sqlalchemy-0.1.0/README.md

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

vintasend_sqlalchemy-0.1.0/pyproject.toml

@@ -0,0 +1,153 @@
+[tool.poetry]
+name = "vintasend-sqlalchemy"
+version = "0.1.0"
+description = "SQLAlchemy backend implementation for VintaSend"
+authors = ["Hugo bessa <hugo@vinta.com.br>"]
+license = "MIT"
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = "<3.13,>=3.10"
+sqlalchemy = "^2.0.36"
+vintasend = "*"
+alembic = "^1.14.0"
+pytest-asyncio = "^0.24.0"
+greenlet = "^3.1.1"
+
+
+[tool.poetry.group.dev.dependencies]
+aiosqlite = "^0.20.0"
+freezegun = "^1.5.1"
+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
+    "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",
+]
+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_sqlalchemy-0.1.0/vintasend_sqlalchemy/alembic_initial_migration_ops.py

@@ -0,0 +1,34 @@
+import datetime
+
+import sqlalchemy as sa
+from alembic import op
+
+
+def create_notification_table(user_id_type: type):
+    return op.create_table('notifications',
+        sa.Column("id", sa.BigInteger().with_variant(sa.Integer, "sqlite"), primary_key=True),
+        sa.Column('notification_type', sa.String(50), nullable=False),
+        sa.Column('title', sa.String(255), nullable=False),
+        sa.Column('status', sa.String(50), nullable=False, default="PENDING_SEND"),
+        sa.Column('body_template', sa.String(255), nullable=False),
+        sa.Column(
+            'created', sa.DateTime, default=lambda: datetime.datetime.now(datetime.timezone.utc)
+        ),
+        sa.Column(
+            'updated', 
+            sa.DateTime,
+            default=lambda: datetime.datetime.now(datetime.timezone.utc),
+            onupdate=lambda: datetime.datetime.now(datetime.timezone.utc),
+        ),
+        sa.Column('subject_template', sa.String(255), nullable=True, default=""),
+        sa.Column('preheader_template', sa.String(255), nullable=True, default=""),
+        sa.Column('context_name', sa.String(255), nullable=True, default=""),
+        sa.Column('context_kwargs', sa.JSON, default=dict),
+        sa.Column('context_used', sa.JSON, nullable=True),
+        sa.Column('adapter_used', sa.String(255), nullable=True),
+        sa.Column('adapter_extra_parameters', sa.JSON, nullable=True),
+        sa.Column('send_after', sa.DateTime(), nullable=True),
+        sa.Column('user_id', user_id_type(), nullable=False),
+        sa.PrimaryKeyConstraint('id'),
+        sa.ForeignKeyConstraint(['user_id'], ['users.id'])
+    )

vintasend_sqlalchemy-0.1.0/vintasend_sqlalchemy/model_factory.py

@@ -0,0 +1,115 @@
+import datetime
+import uuid
+from typing import Any, Generic, TypeVar
+
+from sqlalchemy import JSON, BigInteger, DateTime, ForeignKey, Integer, String, null
+from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column, relationship
+from sqlalchemy.orm.decl_api import DeclarativeAttributeIntercept
+
+
+class Base(DeclarativeBase):
+    pass
+    
+
+class NotificationMixin(Base):
+    __abstract__ = True
+    id: Mapped[int] = mapped_column("id", BigInteger().with_variant(Integer, "sqlite"), primary_key=True)  # noqa: A003
+    notification_type: Mapped[str] = mapped_column("notification_type", String(50), nullable=False)
+    title: Mapped[str] = mapped_column("title", String(255), nullable=False)
+    status: Mapped[str] = mapped_column("status", String(50), nullable=False, default="PENDING_SEND")
+    body_template: Mapped[str] = mapped_column("body_template", String(255), nullable=False)
+    created: Mapped[datetime.datetime] = mapped_column(
+        "created", DateTime, default=lambda: datetime.datetime.now(datetime.timezone.utc)
+    )
+    updated: Mapped[datetime.datetime] = mapped_column(
+        "updated",
+        DateTime,
+        default=lambda: datetime.datetime.now(datetime.timezone.utc),
+        onupdate=lambda: datetime.datetime.now(datetime.timezone.utc),
+    )
+
+    # Email specific fields
+    subject_template: Mapped[str] = mapped_column("subject_template", String(255), nullable=True, default="")
+    preheader_template: Mapped[str] = mapped_column("preheader_template", String(255), nullable=True, default="")
+    context_name: Mapped[str] = mapped_column("context_name", String(255), nullable=True, default="")
+    context_kwargs: Mapped[dict] = mapped_column("context_kwargs", JSON, default=dict)
+    adapter_used: Mapped[str] = mapped_column("adapter_used", String(255), nullable=True)
+    context_used: Mapped[dict | None] = mapped_column("context_used", JSON, nullable=True)
+    adapter_extra_parameters: Mapped[dict | None] = mapped_column("adapter_extra_parameters", JSON, nullable=True)
+
+    send_after = mapped_column("send_after", DateTime, nullable=True)
+
+    def __str__(self):
+        return f"{self.get_user()} - {self.notification_type} - {self.title} - {self.status}{f' (scheduled to {self.send_after})' if self.send_after else ''}"
+
+    def get_user(self) -> Any:
+        raise NotImplementedError
+
+    def get_user_id(self) -> Any:
+        raise NotImplementedError
+    
+    def get_user_email(self) -> str:
+        raise NotImplementedError
+
+    @staticmethod
+    def get_user_id_attr_name() -> str:
+        raise NotImplementedError
+
+    @staticmethod
+    def get_user_attr_name() -> str:
+        raise NotImplementedError
+
+    def set_user_id(self, user_id: Any):
+        raise NotImplementedError
+
+
+UserType = TypeVar('UserType', bound=DeclarativeBase)
+UserPrimaryKeyType = TypeVar('UserPrimaryKeyType', int, str, uuid.UUID)
+
+
+class NotificationMeta(DeclarativeAttributeIntercept):
+    def __new__(cls, name, bases, dct, user_model, user_primary_key_field_name, user_primary_key_field_type):
+        if user_primary_key_field_type == int:
+            dct['user_id'] = mapped_column(ForeignKey(getattr(user_model, user_primary_key_field_name)))
+            dct['set_user_id'] = lambda self, user_id: setattr(self, 'user_id', user_id)
+        elif user_primary_key_field_type == str:
+            dct['user_id'] = mapped_column(ForeignKey(getattr(user_model, user_primary_key_field_name)))
+            dct['set_user_id'] = lambda self, user_id: setattr(self, 'user_id', user_id)
+        elif user_primary_key_field_type == uuid.UUID:
+            dct['user_id'] = mapped_column(ForeignKey(getattr(user_model, user_primary_key_field_name)))
+            dct['set_user_id'] = lambda self, user_id: setattr(self, 'user_id', user_id)
+        
+        dct['user'] = relationship(user_model, backref="notifications")
+        dct['get_user_id'] = lambda self: self.user_id
+        dct['get_user'] = lambda self: self.user
+        dct['__tablename__'] = "notifications"
+        dct['__tableargs__'] = {"extend_existing": True}
+        
+        return super().__new__(cls, name, bases, dct)
+
+
+class GenericNotification(
+    NotificationMixin, 
+    Generic[UserType, UserPrimaryKeyType],     
+):
+    __abstract__ = True
+
+    user: Mapped[UserType]
+    user_id: Mapped[UserPrimaryKeyType]
+    
+    def get_user_id(self) -> UserPrimaryKeyType:
+        raise NotImplementedError
+
+    def set_user_id(self, user_id: UserPrimaryKeyType) -> None:
+        raise NotImplementedError
+    
+    def get_user(self) -> UserType:
+        raise NotImplementedError
+
+    @staticmethod
+    def get_user_id_attr_name() -> str:
+        return "user_id"
+
+    @staticmethod
+    def get_user_attr_name() -> str:
+        return "user"