sandwitches 1.0.3__py3-none-any.whl → 1.2.0__py3-none-any.whl

sandwitches/models.py

@@ -1,11 +1,42 @@
 from django.db import models
-from django.urls import reverse
 from django.utils.text import slugify
 from .storage import HashedFilenameStorage
 from simple_history.models import HistoricalRecords
+from django.contrib.auth import get_user_model
+from django.db.models import Avg
+from .tasks import email_users
+from django.conf import settings
+import logging
+from django.urls import reverse
+
+from imagekit.models import ImageSpecField
+from imagekit.processors import ResizeToFill
 
 hashed_storage = HashedFilenameStorage()
 
+User = get_user_model()
+
+
+class Profile(models.Model):
+    user = models.OneToOneField(User, on_delete=models.CASCADE, related_name="profile")
+    avatar = models.ImageField(upload_to="avatars", blank=True, null=True)
+    avatar_thumbnail = ImageSpecField(
+        source="avatar",
+        processors=[ResizeToFill(100, 50)],
+        format="JPEG",
+        options={"quality": 60},
+    )
+    bio = models.TextField(blank=True)
+    created_at = models.DateTimeField(auto_now_add=True)
+    updated_at = models.DateTimeField(auto_now=True)
+
+    class Meta:
+        verbose_name = "Profile"
+        verbose_name_plural = "Profiles"
+
+    def __str__(self):
+        return f"{self.user.username}'s Profile"  # ty:ignore[possibly-missing-attribute]
+
 
 class Tag(models.Model):
     name = models.CharField(max_length=50, unique=True)
@@ -21,7 +52,7 @@ class Tag(models.Model):
             base = slugify(self.name)[:55]
             slug = base
             n = 1
-            while Tag.objects.filter(slug=slug).exclude(pk=self.pk).exists():
+            while Tag.objects.filter(slug=slug).exclude(pk=self.pk).exists():  # ty:ignore[unresolved-attribute]
                 slug = f"{base}-{n}"
                 n += 1
             self.slug = slug
@@ -37,16 +68,44 @@ class Recipe(models.Model):
     description = models.TextField(blank=True)
     ingredients = models.TextField(blank=True)
     instructions = models.TextField(blank=True)
+    uploaded_by = models.ForeignKey(
+        User,
+        related_name="recipes",
+        on_delete=models.SET_NULL,
+        null=True,
+        blank=True,
+    )
     image = models.ImageField(
-        upload_to="recipes/",  # storage will replace with hashed path
+        upload_to="recipes/",
         storage=hashed_storage,
         blank=True,
         null=True,
     )
-
-    # ManyToMany: tags are reusable and shared between recipes
+    image_thumbnail = ImageSpecField(
+        source="image",
+        processors=[ResizeToFill(150, 150)],
+        format="JPEG",
+        options={"quality": 70},
+    )
+    image_small = ImageSpecField(
+        source="image",
+        processors=[ResizeToFill(400, 300)],
+        format="JPEG",
+        options={"quality": 75},
+    )
+    image_medium = ImageSpecField(
+        source="image",
+        processors=[ResizeToFill(700, 500)],
+        format="JPEG",
+        options={"quality": 85},
+    )
+    image_large = ImageSpecField(
+        source="image",
+        processors=[ResizeToFill(1200, 800)],
+        format="JPEG",
+        options={"quality": 95},
+    )
     tags = models.ManyToManyField(Tag, blank=True, related_name="recipes")
-
     created_at = models.DateTimeField(auto_now_add=True)
     updated_at = models.DateTimeField(auto_now=True)
     history = HistoricalRecords()
@@ -57,19 +116,39 @@ class Recipe(models.Model):
         verbose_name_plural = "Recipes"
 
     def save(self, *args, **kwargs):
+        is_new = self._state.adding
+
         if not self.slug:
             base = slugify(self.title)[:240]
             slug = base
             n = 1
-            while Recipe.objects.filter(slug=slug).exclude(pk=self.pk).exists():
+            while Recipe.objects.filter(slug=slug).exclude(pk=self.pk).exists():  # ty:ignore[unresolved-attribute]
                 slug = f"{base}-{n}"
                 n += 1
             self.slug = slug
+
         super().save(*args, **kwargs)
 
+        send_email = getattr(settings, "SEND_EMAIL")
+        logging.debug(f"SEND_EMAIL is set to {send_email}")
+
+        if is_new or settings.DEBUG:
+            if send_email:
+                email_users.enqueue(recipe_id=self.pk)
+            else:
+                logging.warning(
+                    "Email sending is disabled; not sending email notification, make sure SEND_EMAIL is set to True in settings."
+                )
+        else:
+            logging.debug(
+                "Existing recipe saved (update); skipping email notification."
+            )
+
+    def get_absolute_url(self):
+        return reverse("recipe_detail", kwargs={"slug": self.slug})
+
     def tag_list(self):
-        # returns list of tag names
-        return list(self.tags.values_list("name", flat=True))
+        return list(self.tags.values_list("name", flat=True))  # ty:ignore[possibly-missing-attribute]
 
     def set_tags_from_string(self, tag_string):
         """
@@ -79,16 +158,34 @@ class Recipe(models.Model):
         names = [t.strip() for t in (tag_string or "").split(",") if t.strip()]
         tags = []
         for name in names:
-            tag = Tag.objects.filter(name__iexact=name).first()
+            tag = Tag.objects.filter(name__iexact=name).first()  # ty:ignore[unresolved-attribute]
             if not tag:
-                tag = Tag.objects.create(name=name)
+                tag = Tag.objects.create(name=name)  # ty:ignore[unresolved-attribute]
             tags.append(tag)
-        # replace existing tags with these
-        self.tags.set(tags)
-        return self.tags.all()
+        self.tags.set(tags)  # ty:ignore[possibly-missing-attribute]
+        return self.tags.all()  # ty:ignore[possibly-missing-attribute]
 
-    def get_absolute_url(self):
-        return reverse("recipe_detail", kwargs={"pk": self.pk, "slug": self.slug})
+    def average_rating(self):
+        agg = self.ratings.aggregate(avg=Avg("score"))  # ty:ignore[unresolved-attribute]
+        return agg["avg"] or 0
+
+    def rating_count(self):
+        return self.ratings.count()  # ty:ignore[unresolved-attribute]
 
     def __str__(self):
         return self.title
+
+
+class Rating(models.Model):
+    recipe = models.ForeignKey(Recipe, related_name="ratings", on_delete=models.CASCADE)
+    user = models.ForeignKey(User, related_name="ratings", on_delete=models.CASCADE)
+    score = models.PositiveSmallIntegerField(choices=[(i, i) for i in range(1, 6)])
+    created_at = models.DateTimeField(auto_now_add=True)
+    updated_at = models.DateTimeField(auto_now=True)
+
+    class Meta:
+        unique_together = ("recipe", "user")
+        ordering = ("-updated_at",)
+
+    def __str__(self):
+        return f"{self.recipe} — {self.score} by {self.user}"

sandwitches/settings.py

@@ -12,18 +12,47 @@ https://docs.djangoproject.com/en/5.2/ref/settings/
 
 from pathlib import Path
 import os
+from django.core.exceptions import ImproperlyConfigured
+from . import storage
 
+DEBUG = bool(os.environ.get("DEBUG", default=0))  # ty:ignore[no-matching-overload]
 
 SECRET_KEY = os.environ.get("SECRET_KEY")
-DEBUG = bool(os.environ.get("DEBUG", default=0))
-ALLOWED_HOSTS = os.environ.get("ALLOWED_HOSTS", "127.0.0.1").split(",")
+if not SECRET_KEY:
+    raise ImproperlyConfigured(
+        "The SECRET_KEY environment variable must be set in production."
+    )
+
+ALLOWED_HOSTS = os.environ.get("ALLOWED_HOSTS", "127.0.0.1, localhost").split(",")
 CSRF_TRUSTED_ORIGINS = os.environ.get("CSRF_TRUSTED_ORIGINS", "").split(",")
+DATABASE_FILE = Path(os.environ.get("DATABASE_FILE", default="/db/db.sqlite3"))  # ty:ignore[no-matching-overload]
+
+storage.is_database_readable(DATABASE_FILE)
+storage.is_database_writable(DATABASE_FILE)
+
 
 # Build paths inside the project like this: BASE_DIR / 'subdir'.
 BASE_DIR = Path(__file__).resolve().parent.parent
 
-# Application definition
 
+TASKS = {
+    "default": {
+        "BACKEND": "django_tasks.backends.database.DatabaseBackend",
+        "QUEUES": ["default", "emails"],
+        "OPTIONS": {
+            "queues": {
+                "low_priority": {
+                    "max_attempts": 5,
+                }
+            },
+            "max_attempts": 10,
+            "backoff_factor": 3,
+            "purge": {"finished": "10 days", "unfinished": "20 days"},
+        },
+    }
+}
+
+# Application definition
 INSTALLED_APPS = [
     "django.contrib.admin",
     "django.contrib.auth",
@@ -32,13 +61,18 @@ INSTALLED_APPS = [
     "django.contrib.messages",
     "django.contrib.staticfiles",
     "sandwitches",
+    "django_tasks",
+    "django_tasks.backends.database",
     "debug_toolbar",
+    "imagekit",
     "simple_history",
 ]
 
 MIDDLEWARE = [
     "django.middleware.security.SecurityMiddleware",
+    "whitenoise.middleware.WhiteNoiseMiddleware",
     "django.contrib.sessions.middleware.SessionMiddleware",
+    "django.middleware.locale.LocaleMiddleware",
     "django.middleware.common.CommonMiddleware",
     "django.middleware.csrf.CsrfViewMiddleware",
     "django.contrib.auth.middleware.AuthenticationMiddleware",
@@ -61,6 +95,7 @@ TEMPLATES = [
                 "django.contrib.auth.context_processors.auth",
                 "django.contrib.messages.context_processors.messages",
                 "django.template.context_processors.csrf",
+                "django.template.context_processors.i18n",
             ],
         },
     },
@@ -68,17 +103,30 @@ TEMPLATES = [
 
 WSGI_APPLICATION = "sandwitches.wsgi.application"
 
-
-# Database
-# https://docs.djangoproject.com/en/5.2/ref/settings/#databases
-
 DATABASES = {
     "default": {
         "ENGINE": "django.db.backends.sqlite3",
-        "NAME": Path("/config/db.sqlite3"),
+        "NAME": DATABASE_FILE,
     }
 }
 
+LOGGING = {
+    "version": 1,
+    "disable_existing_loggers": False,
+    "handlers": {
+        "console": {
+            "class": "logging.StreamHandler",
+        },
+    },
+    "loggers": {
+        "django": {
+            "handlers": ["console"],
+            "level": os.getenv("LOG_LEVEL", "INFO"),
+            "propagate": False,
+        },
+    },
+}
+
 
 # Password validation
 # https://docs.djangoproject.com/en/5.2/ref/settings/#auth-password-validators
@@ -105,16 +153,20 @@ MEDIA_ROOT = Path("/config/media")
 
 # Static (for CSS etc)
 STATIC_URL = "/static/"
-STATIC_ROOT = Path("/config/staticfiles")
-
-# Internationalization
-# https://docs.djangoproject.com/en/5.2/topics/i18n/
+STATIC_ROOT = Path("/tmp/staticfiles")
+STATIC_URL = "static/"
 
-LANGUAGE_CODE = "en-us"
+STATICFILES_DIRS = [BASE_DIR / "static", MEDIA_ROOT]
 
+LANGUAGE_CODE = "en"
 TIME_ZONE = "UTC"
-
 USE_I18N = True
+LANGUAGES = [
+    ("en", "English"),
+    ("nl", "Nederlands"),
+]
+
+LOCALE_PATHS = [BASE_DIR / "locale"]
 
 USE_TZ = True
 
@@ -122,11 +174,32 @@ INTERNAL_IPS = [
     "127.0.0.1",
 ]
 
+STORAGES = {
+    "default": {
+        "BACKEND": "django.core.files.storage.FileSystemStorage",
+    },
+    "staticfiles": {
+        "BACKEND": "whitenoise.storage.CompressedManifestStaticFilesStorage",
+    },
+}
 
-# Static files (CSS, JavaScript, Images)
-# https://docs.djangoproject.com/en/5.2/howto/static-files/
-
-STATIC_URL = "static/"
+EMAIL_BACKEND = "django.core.mail.backends.smtp.EmailBackend"
+EMAIL_USE_TLS = os.environ.get("SMTP_USE_TLS")
+EMAIL_HOST = os.environ.get("SMTP_HOST")
+EMAIL_HOST_USER = os.environ.get("SMTP_USER")
+EMAIL_HOST_PASSWORD = os.environ.get("SMTP_PASSWORD")
+EMAIL_PORT = os.environ.get("SMTP_PORT")
+EMAIL_FROM_ADDRESS = os.environ.get("SMTP_FROM_EMAIL")
+SEND_EMAIL = all(
+    v is not None
+    for v in [
+        EMAIL_HOST,
+        EMAIL_HOST_USER,
+        EMAIL_HOST_PASSWORD,
+        EMAIL_PORT,
+        EMAIL_FROM_ADDRESS,
+    ]
+)
 
 # Default primary key field type
 # https://docs.djangoproject.com/en/5.2/ref/settings/#default-auto-field

sandwitches/storage.py

@@ -2,6 +2,9 @@ import hashlib
 import os
 from django.core.files.base import ContentFile
 from django.core.files.storage import FileSystemStorage
+from pathlib import Path
+from django.conf import settings
+import logging
 
 
 class HashedFilenameStorage(FileSystemStorage):
@@ -11,19 +14,69 @@ class HashedFilenameStorage(FileSystemStorage):
     """
 
     def _save(self, name, content):
-        # ensure we read bytes
         try:
             content.seek(0)
         except Exception:
             pass
 
         data = content.read()
-        # compute hash (use first 32 hex chars to keep names shorter)
         h = hashlib.sha256(data).hexdigest()[:32]
         ext = os.path.splitext(name)[1].lower() or ""
-        # store all recipe images under recipes/
         name = f"recipes/{h}{ext}"
 
-        # wrap bytes into a ContentFile so Django storage works consistently
         content = ContentFile(data)
         return super()._save(name, content)
+
+
+def is_database_readable(path=None) -> bool:
+    """
+    Check whether the database file exists and is readable.
+
+    If `path` is None, uses `django.conf.settings.DATABASE_FILE` by default.
+
+    Returns:
+        bool: True if the file exists and is readable by the current process, False otherwise.
+    """
+
+    if path is None:
+        path = getattr(settings, "DATABASE_FILE", None)
+
+    if not path:
+        return False
+
+    p = Path(path)
+    logging.debug(f"Checking database file readability at: {p}")
+    readable = p.is_file() and os.access(p, os.R_OK)
+    if not readable:
+        logging.error(f"Database file at {p} is not readable or does not exist.")
+        return False
+    else:
+        logging.debug(f"Database file at {p} is readable.")
+        return readable
+
+
+def is_database_writable(path=None) -> bool:
+    """
+    Check whether the database file exists and is writable.
+
+    If `path` is None, uses `django.conf.settings.DATABASE_FILE` by default.
+
+    Returns:
+        bool: True if the file exists and is writable by the current process, False otherwise.
+    """
+
+    if path is None:
+        path = getattr(settings, "DATABASE_FILE", None)
+
+    if not path:
+        return False
+
+    p = Path(path)
+    logging.debug(f"Checking database file writability at: {p}")
+    writable = p.is_file() and os.access(p, os.W_OK)
+    if not writable:
+        logging.error(f"Database file at {p} is not writable or does not exist.")
+        return False
+    else:
+        logging.debug(f"Database file at {p} is writable.")
+    return writable

sandwitches/tasks.py

@@ -0,0 +1,99 @@
+# from gunicorn.http.wsgi import log
+import logging
+
+# from django.core.mail import send_mail
+from django_tasks import task
+from django.contrib.auth import get_user_model
+
+from django.core.mail import EmailMultiAlternatives
+from django.conf import settings
+
+
+import textwrap
+
+
+@task(takes_context=True, priority=2, queue_name="emails")
+def email_users(context, recipe_id):
+    logging.debug(
+        f"Attempt {context.attempt} to send users an email. Task result id: {context.task_result.id}."
+    )
+
+    User = get_user_model()
+    emails = list(
+        User.objects.exclude(email__isnull=True)
+        .exclude(email="")
+        .values_list("email", flat=True)
+    )
+
+    if not emails:
+        logging.warning("No users with valid emails found.")
+        return 0
+
+    send_emails(recipe_id, emails)
+
+    return True
+
+
+def send_emails(recipe_id, emails):
+    from .models import Recipe
+
+    logging.debug(f"Preparing to send email to: {emails}")
+    recipe = Recipe.objects.get(pk=recipe_id)  # ty:ignore[unresolved-attribute]
+    from_email = getattr(settings, "EMAIL_FROM_ADDRESS")
+
+    recipe_slug = recipe.get_absolute_url()
+    base_url = (
+        settings.CSRF_TRUSTED_ORIGINS[0]
+        if settings.CSRF_TRUSTED_ORIGINS
+        else "http://localhost"
+    ).rstrip("/")
+
+    raw_message = f"""
+    Hungry? We just added <strong>{recipe.title}</strong> to our collection.
+    
+    It's a delicious recipe that you won't want to miss!
+    {recipe.description}
+
+    Check out the full recipe, ingredients, and steps here:
+    {base_url}{recipe_slug}
+
+    Happy Cooking!
+
+    The Sandwitches Team
+    """
+    wrapped_message = textwrap.fill(textwrap.dedent(raw_message), width=70)
+
+    html_content = f"""
+    <div style="font-family: 'Helvetica', sans-serif; max-width: 600px; margin: auto; border: 1px solid #eee; padding: 20px;">
+        <h2 style="color: #d35400; text-align: center;">New Recipe: {recipe.title} by {recipe.uploaded_by}</h2>
+        <div style="text-align: center; margin: 20px 0;">
+            <img src="{base_url}{recipe.image.url}" alt="{recipe.title}" style="width: 100%; border-radius: 8px;">
+        </div>
+        <p style="font-size: 16px; line-height: 1.5; color: #333;">
+            Hungry? We just added <strong>{recipe.title}</strong> to our collection.
+            <br>
+            It's a delicious recipe that you won't want to miss!
+            <br>
+            {recipe.description}
+            <br>
+            Check out the full recipe, ingredients, and steps here:
+            Click the button below to see how to make it!
+            <br>
+            Happy Cooking!
+            <br>
+            The Sandwitches Team
+        </p>
+        <div style="text-align: center; margin-top: 30px;">
+            <a href="{base_url}{recipe_slug}" style="background-color: #e67e22; color: white; padding: 12px 25px; text-decoration: none; border-radius: 5px; font-weight: bold;">VIEW RECIPE</a>
+        </div>
+    </div>
+    """
+
+    msg = EmailMultiAlternatives(
+        subject=f"Sandwitches - New Recipe: {recipe.title} by {recipe.uploaded_by}",
+        body=wrapped_message,
+        from_email=from_email,
+        bbc=emails,
+    )
+    msg.attach_alternative(html_content, "text/html")
+    msg.send()

sandwitches/templates/base.html

@@ -1,5 +1,6 @@
+{% load i18n %}
 <!DOCTYPE html>
-<html lang="en">
+<html lang="{% get_current_language as LANGUAGE_CODE %}{{ LANGUAGE_CODE }}">
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width,initial-scale=1.0" />

sandwitches/templates/base_pico.html

@@ -1,4 +1,4 @@
-{% extends "base.html" %} {% block extra_head %}
+{% extends "base.html" %} {% load i18n static %} {% block extra_head %}
 <!-- Pico.css (CDN) -->
 <link
   rel="stylesheet"
@@ -128,6 +128,7 @@
     }
   }
 </style>
+<link rel="icon" type="image/svg+xml" href="{% static "icons/favicon.svg" %}">
 {% endblock %} {% block navbar %}
 <header class="container">
   <nav>
@@ -168,11 +169,26 @@
       </li>
     </ul>
     <ul>
+      <li>
+        <form method="post" action="{% url 'set_language' %}">
+          {% csrf_token %}
+          <select name="language" onchange="this.form.submit()" aria-label="{% trans 'Language' %}">
+            {% get_current_language as LANGUAGE_CODE %}
+            {% get_available_languages as LANGUAGES %}
+            {% for code,name in LANGUAGES %}
+              <option value="{{ code }}"{% if code == LANGUAGE_CODE %} selected{% endif %}>{{ name }}</option>
+            {% endfor %}
+          </select>
+          <input type="hidden" name="next" value="{{ request.get_full_path }}" />
+        </form>
+      </li>
+      <li><a href="api/docs">{% trans "Docs" %}</a></li>
       {% if user.is_authenticated %}
-      <li><a href="{% url 'admin:index' %}">Admin</a></li>
-      <li><a href="{% url 'admin:logout' %}">Logout</a></li>
+      <li><a href="{% url 'admin:index' %}">{% trans "Admin" %}</a></li>
+      <li><a href="{% url 'admin:logout' %}">{% trans "Logout" %}</a></li>
       {% else %}
-      <li><a href="{% url 'admin:login' %}">Login</a></li>
+      <li><a href="{% url 'admin:login' %}">{% trans "Login" %}</a></li>
+      <li><a href="{% url 'signup' %}">{% trans "Sign up" %}</a></li>
       {% endif %}
     </ul>
   </nav>