Merge pull request #1 from vintasoftware/feat/attachments-and-one-off-notifications

Implement Attachments and one-off notifications

Author: hugobessa

.github/workflows/ci.yml

@@ -1,6 +1,6 @@
 name: CI
 
-on: [push, pull_request]
+on: [push]
 
 jobs:
   build-python:

.github/workflows/publish.yml

@@ -0,0 +1,100 @@
+name: Publish Package
+
+on:
+  push:
+    tags:
+      - 'v*'  # Triggers on tags like v1.0.0, v2.1.3, etc.
+
+jobs:
+  test-before-publish:
+    name: Run tests before publishing
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install poetry
+          poetry install
+
+      - name: Run tests
+        run: poetry run tox
+        env:
+          OPENAI_API_KEY: "sk-fake-test-key-123"
+
+  # Make sure tests pass before publishing
+  check-tests:
+    name: Check that tests pass
+    runs-on: ubuntu-latest
+    needs: test-before-publish
+    steps:
+      - name: Tests passed
+        run: echo "All tests passed successfully"
+
+  # Publish only after tests pass
+  publish-release:
+    name: Publish release
+    needs: [test-before-publish, check-tests]
+    runs-on: ubuntu-latest
+    if: ${{ needs.test-before-publish.result == 'success' }}
+
+    permissions:
+      contents: write  # Needed to create GitHub releases
+      id-token: write  # Needed for trusted publishing to PyPI
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # Fetch full history for proper version detection
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"  # Use a stable Python version for publishing
+
+      - name: Install Poetry
+        uses: snok/install-poetry@v1
+        with:
+          version: latest
+          virtualenvs-create: true
+          virtualenvs-in-project: true
+
+      - name: Cache Poetry dependencies
+        uses: actions/cache@v4
+        with:
+          path: .venv
+          key: poetry-${{ runner.os }}-${{ hashFiles('**/poetry.lock') }}
+
+      - name: Install dependencies
+        run: poetry install --only=main
+
+      - name: Build package
+        run: poetry build
+
+      - name: Verify package contents
+        run: |
+          # List the built packages
+          ls -la dist/
+          # Check package contents
+          poetry run pip install twine
+          poetry run twine check dist/*
+
+      - name: Publish to PyPI
+        env:
+          POETRY_PYPI_TOKEN_PYPI: ${{ secrets.PYPI_API_TOKEN }}
+        run: |
+          poetry config pypi-token.pypi $POETRY_PYPI_TOKEN_PYPI
+          poetry publish

RELEASE_NOTES.md

@@ -0,0 +1,15 @@
+# Release Notes
+
+## Version 1.0.0 (2025-09-16)
+
+### 🚀 Major Features
+
+* Upgrade vintasend to version 1.0.0
+* Support one-off notifications (without user)
+* Support attachements
+
+---
+
+## Version 0.1.4 (Initial Release)
+
+Initial version of VintaSend with core notification functionality.

poetry.lock

@@ -13,7 +13,7 @@ include = [
 [tool.poetry.dependencies]
 python = "<3.14,>=3.10"
 django = "<5.3,>=3.2"
-vintasend = "0.1.4"
+vintasend = "1.0.0"
 django-model-utils = "^5.0.0"
 
 

pyproject.toml

@@ -0,0 +1,88 @@
+# Generated by Django 5.2.6 on 2025-09-16 18:23
+
+import django.db.models.deletion
+from django.conf import settings
+from django.db import migrations, models
+import model_utils.fields
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("vintasend_django", "0001_initial"),
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="notification",
+            name="email_or_phone",
+            field=models.CharField(blank=True, max_length=255),
+        ),
+        migrations.AddField(
+            model_name="notification",
+            name="first_name",
+            field=models.CharField(blank=True, max_length=255),
+        ),
+        migrations.AddField(
+            model_name="notification",
+            name="last_name",
+            field=models.CharField(blank=True, max_length=255),
+        ),
+        migrations.AlterField(
+            model_name="notification",
+            name="user",
+            field=models.ForeignKey(
+                blank=True,
+                null=True,
+                on_delete=django.db.models.deletion.CASCADE,
+                to=settings.AUTH_USER_MODEL,
+            ),
+        ),
+        migrations.CreateModel(
+            name="Attachment",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("file", models.FileField(upload_to="notifications/attachments/")),
+                ("name", models.CharField(max_length=255)),
+                ("mime_type", models.CharField(blank=True, max_length=255)),
+                ("size", models.PositiveIntegerField(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",
+                    ),
+                ),
+                (
+                    "notification",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="attachments",
+                        to="vintasend_django.notification",
+                    ),
+                ),
+            ],
+            options={
+                "ordering": ("-created",),
+            },
+        ),
+    ]

vintasend_django/migrations/0002_notification_email_or_phone_notification_first_name_and_more.py

@@ -10,7 +10,10 @@
 User = get_user_model()
 
 class Notification(models.Model):
-    user = models.ForeignKey(User, on_delete=models.CASCADE)
+    user = models.ForeignKey(User, on_delete=models.CASCADE, null=True, blank=True)
+    email_or_phone = models.CharField(max_length=255, blank=True)
+    first_name = models.CharField(max_length=255, blank=True)
+    last_name = models.CharField(max_length=255, blank=True)
     notification_type = models.CharField(max_length=50, choices=NotificationTypesChoices)
     title = models.CharField(max_length=255)
     status = models.CharField(
@@ -41,3 +44,22 @@ class Meta:
 
     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 ''}"
+
+
+class Attachment(models.Model):
+    notification = models.ForeignKey(Notification, on_delete=models.CASCADE, related_name="attachments")
+    file = models.FileField(upload_to="notifications/attachments/")
+    name = models.CharField(max_length=255)
+    mime_type = models.CharField(max_length=255, blank=True)
+    size = models.PositiveIntegerField(null=True)
+
+    created = AutoCreatedField(_("created"), db_index=True)
+    modified = AutoLastModifiedField(_("modified"), db_index=True)
+
+    objects: models.Manager["Attachment"]
+
+    class Meta:
+        ordering = ("-created",)
+
+    def __str__(self):
+        return f"{self.name} ({self.notification})"

vintasend_django/models.py

@@ -0,0 +1,46 @@
+from typing import BinaryIO
+
+from vintasend.services.dataclasses import AttachmentFile
+
+from vintasend_django.models import Attachment
+
+
+class DjangoAttachmentFile(AttachmentFile):
+    """Django-specific implementation for file access"""
+
+    def __init__(self, attachment: Attachment):
+        self.attachment = attachment
+
+    @property
+    def name(self) -> str:
+        """Get the attachment name"""
+        return self.attachment.name
+
+    @property
+    def mime_type(self) -> str:
+        """Get the attachment MIME type"""
+        return self.attachment.mime_type
+
+    def read(self) -> bytes:
+        """Read the entire file content"""
+        self.attachment.file.seek(0)
+        return self.attachment.file.read()
+
+    def stream(self) -> BinaryIO:
+        """
+        Return a new file stream for large files.
+
+        Each call to this method opens a new file handle. 
+        The caller is responsible for closing the returned stream to prevent resource leaks.
+        """
+        return self.attachment.file.open('rb')
+
+    def url(self, expires_in: int = 3600) -> str:
+        """Generate temporary URL if supported"""
+        return self.attachment.file.url
+
+    def delete(self) -> None:
+        """Delete from storage"""
+        if self.attachment.file:
+            self.attachment.file.delete(save=False)
+        self.attachment.delete()