add email subscribe functionality

shoshincollege · May 25, 2024 · 521833a · 521833a
1 parent 9e007bb
commit 521833a
Show file tree

Hide file tree

Showing 11 changed files with 163 additions and 11 deletions.
diff --git a/main/admin.py b/main/admin.py
@@ -50,5 +50,15 @@ class ArticleAdmin(admin.ModelAdmin):
  "updated_at",
  )
  list_display_links = ("id", "title", "slug")
+ ordering = ["-id"]
+
 
+@admin.register(models.Subscription)
+class SubscriptionAdmin(admin.ModelAdmin):
+ list_display = (
+ "id",
+ "email",
+ "created_at",
+ )
+ list_display_links = ("id", "email")
  ordering = ["-id"]
diff --git a/main/forms.py b/main/forms.py
@@ -0,0 +1,9 @@
+from django import forms
+
+from main import models
+
+
+class Subscription(forms.ModelForm):
+ class Meta:
+ model = models.Subscription
+ fields = ["email"]
diff --git a/main/migrations/0003_subscription.py b/main/migrations/0003_subscription.py
@@ -0,0 +1,31 @@
+# Generated by Django 5.0.6 on 2024-05-25 11:02
+
+import uuid
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+ dependencies = [
+ ("main", "0002_article"),
+ ]
+
+ operations = [
+ migrations.CreateModel(
+ name="Subscription",
+ fields=[
+ (
+ "id",
+ models.BigAutoField(
+ auto_created=True,
+ primary_key=True,
+ serialize=False,
+ verbose_name="ID",
+ ),
+ ),
+ ("email", models.EmailField(max_length=254, unique=True)),
+ ("created_at", models.DateTimeField(auto_now_add=True)),
+ ("unsubscribe_key", models.UUIDField(default=uuid.uuid4, unique=True)),
+ ],
+ ),
+ ]
diff --git a/main/migrations/0004_alter_subscription_email.py b/main/migrations/0004_alter_subscription_email.py
@@ -0,0 +1,17 @@
+# Generated by Django 5.0.6 on 2024-05-25 11:27
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+ dependencies = [
+ ("main", "0003_subscription"),
+ ]
+
+ operations = [
+ migrations.AlterField(
+ model_name="subscription",
+ name="email",
+ field=models.EmailField(max_length=254),
+ ),
+ ]
diff --git a/main/models.py b/main/models.py
@@ -1,3 +1,5 @@
+import uuid
+
 import mistune
 from django.conf import settings
 from django.contrib.auth.models import AbstractUser
@@ -49,3 +51,16 @@ def get_absolute_url(self):
 
  def __str__(self):
  return f"{self.id}: {self.title}"
+
+
+class Subscription(models.Model):
+ email = models.EmailField()
+ created_at = models.DateTimeField(auto_now_add=True)
+ unsubscribe_key = models.UUIDField(default=uuid.uuid4, unique=True)
+
+ def get_unsubscribe_url(self):
+ path = reverse("unsubscribe_key", args={self.unsubscribe_key})
+ return f"{settings.CANONICAL_URL}{path}"
+
+ def __str__(self):
+ return f"{self.id}: {self.email}"
diff --git a/main/templates/assets/style.css b/main/templates/assets/style.css
@@ -33,6 +33,12 @@
 html, body { margin: 0; }
 body { font-family: InterVariable, sans-serif; line-height: 1.3; }
 a { color: black; }
+aside {
+ text-align: center;
+ padding-top: 24px;
+ text-transform: none;
+ color: salmon;
+}
 
 /* all pages */
 section { max-width: 640px; margin: 0 auto 64px; font-size: 20px; }
@@ -59,6 +65,24 @@ section blockquote {
 }
 section blockquote p { padding: 0; }
 
+/* all pages: forms */
+form { max-width: 300px; margin: 0 auto; }
+label { display: block; margin-bottom: 8px; user-select: none; }
+input[type="email"] { box-sizing: border-box; display: block; width: 100%; }
+input[type="submit"] {
+ cursor: pointer;
+ display: block;
+ width: 100%;
+ background: white;
+ border: 1px solid black;
+ padding: 8px 0;
+}
+input[type="submit"]:hover {
+ background: black;
+ color: white;
+}
+.errorlist { font-size: 18px; }
+
 /* articles / news / ideas / blog sections */
 #articles .article-list-title {
  font-family: 'Grenette Variable Pro';

diff --git a/main/templates/main/index.html b/main/templates/main/index.html
@@ -137,9 +137,9 @@ <h2>
 
 <div id="newsletter">
  <h2>Stay In Touch</h2>
- <form method="post">
+ <form method="post" action="{% url 'subscribe' %}">
  {% csrf_token %}
- <input type="email" title="email" placeholder="email">
+ <input type="email" name="email" placeholder="email">
  </form>
 </div>
 

diff --git a/main/templates/main/layout.html b/main/templates/main/layout.html
@@ -14,21 +14,22 @@
  </head>
 
  <body>
- {% if messages %}
- <aside>
- {% for message in messages %}
- <div {% if message.tags %}class="alert-{{ message.tags }}"{% endif %}>{{ message|safe }}</div>
- {% endfor %}
- </aside>
- {% endif %}
-
  <nav>
  <a href="{% url 'index' %}" style="color: #3D6D75;">Shoshin College</a>
  <a href="{% url 'index' %}">Home</a>
  <a href="{% url 'about' %}">About</a>
  <a target="_blank" href="https://shoshincollege.notion.site/Classes-Fall-2024-72c20e12164e4f13b4c3d6182fe74f0d">Classes ↗</a>
  <a href="{% url 'news_list' %}">News</a>
+
+ {% if messages %}
+ <aside>
+ {% for message in messages %}
+ <div {% if message.tags %}class="alert-{{ message.tags }}"{% endif %}>{{ message|safe }}</div>
+ {% endfor %}
+ </aside>
+ {% endif %}
  </nav>
+
  {% block content %}
  {% endblock %}
  </body>

diff --git a/main/templates/main/subscribe.html b/main/templates/main/subscribe.html
@@ -0,0 +1,22 @@
+{% extends 'main/layout.html' %}
+
+{% block content %}
+<div id="section-title">
+ <h1>Stay In Touch</h1>
+</div>
+
+<section>
+ <form method="post" action="{% url 'subscribe' %}">
+ <p>
+ <label for="email">Email:</label>
+ {{ form.email.errors }}
+ <input type="email" id="email" name="email" required>
+ </p>
+
+ {% csrf_token %}
+
+ <input type="submit" value="Submit">
+ </form>
+</section>
+
+{% endblock %}
diff --git a/main/urls.py b/main/urls.py
@@ -5,6 +5,7 @@
 urlpatterns = [
  path("", views.index, name="index"),
  path("about/", views.about, name="about"),
+ path("subscribe/", views.Subscribe.as_view(), name="subscribe"),
  path("news/", views.NewsList.as_view(), name="news_list"),
  path("news/<slug:slug>/", views.NewsDetail.as_view(), name="news_detail"),
 ]
diff --git a/main/views.py b/main/views.py
@@ -1,7 +1,10 @@
+from django.contrib.messages.views import SuccessMessageMixin
 from django.shortcuts import render
+from django.urls import reverse_lazy
 from django.views.generic import DetailView, ListView
+from django.views.generic.edit import FormView
 
-from main import models
+from main import forms, models
 
 
 def index(request):
@@ -23,3 +26,22 @@ def get_queryset(self):
 
 class NewsDetail(DetailView):
  model = models.Article
+
+
+class Subscribe(SuccessMessageMixin, FormView):
+ form_class = forms.Subscription
+ template_name = "main/subscribe.html"
+ success_url = reverse_lazy("index")
+ success_message = "thanks! we've noted down your email address"
+
+ def form_valid(self, form):
+ # Handle case: already subscribed
+ if models.Subscription.objects.filter(
+ email=form.cleaned_data.get("email")
+ ).exists():
+ self.success_message = "thanks! you are already subscribed but whatever"
+ return super().form_valid(form)
+
+ # Handle happy path: email is new
+ self.object = form.save()
+ return super().form_valid(form)