Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Added

- Membership `started`/`until` are dates; membership runs one year from joining and early renewal extends from the current end date (admins can edit both dates). Existing rows migrate to `until = Dec 31 of the stored year`.
- Membership records `organization` and `organization_type`; existing members are asked to fill them in on their next visit (`/membership/details`).
- Membership admin lists name, last name, first name, email, organization, type and dates; filters, search and the Excel export are extended.
- Renewal reminders (60/30 days before, on expiry, 30/60 days after) sent by a Celery beat task; `manage.py send_membership_reminders --dry-run` previews them.
- `RegistrationOption.membership_until` (date) replaces `membership_end_year`; `Payment.mark_paid` still accepts the legacy key in stored payment data.
- Private team calendar at `/team-calendar/`, served behind login (`@login_required`).

## [0.1.0] - 2022-03-22
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ sequenceDiagram

## Membership

DdS membership runs per calendar year, from January 1st to December 31st. Signing up for DdS membership requires a valid user account.
DdS membership runs for one year from the day of joining; renewing early adds a year to the current end date, and both dates can be adjusted in the admin. Renewal reminders go out automatically 60 and 30 days before the end date, on the day, and 30 and 60 days after (see `deployment.md`, Celery section). Signing up for DdS membership requires a valid user account.

```mermaid
sequenceDiagram
Expand Down
18 changes: 18 additions & 0 deletions conftest.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,25 @@
"SLACK_REGISTRATIONS_WEBHOOK": "",
"SENTRY_DSN": "",
"DEFAULT_FROM_EMAIL": "test@example.com",
"CELERY_TASK_ALWAYS_EAGER": "True",
"CELERY_BROKER_URL": "memory://",
}

for _key, _value in _TEST_ENV_DEFAULTS.items():
os.environ.setdefault(_key, _value)


def pytest_configure(config):
"""Run Celery tasks inline during tests.

pytest-django imports the settings module before this conftest runs, so the
env defaults above do not reach import-time settings such as the Celery
block; configure the app object directly instead.
"""
from django.conf import settings

# Celery resolves the namespaced Django name (CELERY_*) before its own conf
# overrides, so the attributes have to change on the settings object itself.
settings.CELERY_TASK_ALWAYS_EAGER = True
settings.CELERY_TASK_EAGER_PROPAGATES = True
settings.CELERY_BROKER_URL = "memory://"
3 changes: 3 additions & 0 deletions dds_registration/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,13 @@
__timetag__ = "240430-1501"


from .celery import app as celery_app # noqa: E402

__all__ = (
__version__,
__timestamp__,
__timetag__,
"celery_app",
)


Expand Down
80 changes: 63 additions & 17 deletions dds_registration/admin.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
from .models import (
Event,
Membership,
MembershipReminder,
Message,
Payment,
Registration,
Expand Down Expand Up @@ -63,9 +64,9 @@ def lookups(self, request, model_admin):

def queryset(self, request, queryset):
if self.value() == "1":
return queryset.filter(until__gte=date.today().year)
return queryset.filter(until__gte=date.today())
if self.value() == "0":
return queryset.filter(until__lt=date.today().year)
return queryset.filter(until__lt=date.today())


class UserAdmin(BaseUserAdmin):
Expand Down Expand Up @@ -139,41 +140,85 @@ def email_selected_users(self, request, queryset):
# mailing_list = models.BooleanField(default=False)


class MembershipReminderInline(admin.TabularInline):
model = MembershipReminder
extra = 0
can_delete = False
readonly_fields = ["until", "stage", "sent_at"]

def has_add_permission(self, request, obj=None):
return False


@admin.register(Membership)
class MembershipAdmin(admin.ModelAdmin):
fieldsets = (
(None, {"fields": ("user", "membership_type")}),
("Member", {"fields": ("user", "membership_type", "organization", "organization_type")}),
("Validity", {"fields": ("started", "until")}),
("Communication", {"fields": ("mailing_list",)}),
)

inlines = [MembershipReminderInline]
list_display = [
"user",
"started",
"until",
# "paid",
"active",
"full_name",
"last_name",
"first_name",
"email",
"organization",
"organization_type",
"membership_type",
"started_iso",
"until_iso",
"active",
]
search_fields = [
"user__username",
]
list_filter = [IsActiveFilter, "membership_type"]
list_select_related = ["user"]
search_fields = ["user__email", "user__first_name", "user__last_name", "organization"]
list_filter = [IsActiveFilter, "membership_type", "organization_type"]
actions = ["export_current_member_list"]

@admin.display(description="Name", ordering="user__last_name")
def full_name(self, obj):
return obj.user.get_full_name() or obj.user.email

@admin.display(description="Last name", ordering="user__last_name")
def last_name(self, obj):
return obj.user.last_name

@admin.display(description="First name", ordering="user__first_name")
def first_name(self, obj):
return obj.user.first_name

@admin.display(description="Email", ordering="user__email")
def email(self, obj):
return obj.user.email

@admin.display(description="Started", ordering="started")
def started_iso(self, obj):
return obj.started.isoformat()

@admin.display(description="Until", ordering="until")
def until_iso(self, obj):
return obj.until.isoformat()

@admin.display(description="Active", boolean=True, ordering="until")
def active(self, obj):
return obj.active

@admin.action(description="Export all current members to excel")
def export_current_member_list(self, request, queryset):
queryset = Membership.objects.filter(until__gte=date.today().year)
queryset = Membership.objects.filter(until__gte=date.today()).select_related("user")
df = pd.DataFrame(
[
{
"email": obj.user.email,
"id": obj.user.id,
"name": obj.user.get_full_name(),
"first_name": obj.user.first_name,
"last_name": obj.user.last_name,
"organization": obj.organization,
"organization_type": obj.get_organization_type_display(),
"started": obj.started,
"unit": obj.until,
"until": obj.until,
"on_mailing_list": obj.mailing_list,
"type": str(obj.membership_type),
"type": obj.get_membership_type_display(),
}
for obj in queryset
]
Expand All @@ -190,6 +235,7 @@ def export_current_member_list(self, request, queryset):
response["Content-Disposition"] = "attachment; filename=memberships.xlsx"
return response


@admin.register(Registration)
class RegistrationAdmin(admin.ModelAdmin):
readonly_fields = [
Expand Down
11 changes: 11 additions & 0 deletions dds_registration/celery.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
"""Celery application; the worker and beat run ``celery -A dds_registration``."""

import os

from celery import Celery

os.environ.setdefault("DJANGO_SETTINGS_MODULE", "dds_registration.settings")

app = Celery("dds_registration")
app.config_from_object("django.conf:settings", namespace="CELERY")
app.autodiscover_tasks()
3 changes: 2 additions & 1 deletion dds_registration/core/helpers/create_pdf.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
payment_recipient_address,
payment_recipient_name,
)
from ..membership.validity import until_label

__all__ = [
"create_invoice_pdf_from_payment",
Expand Down Expand Up @@ -253,7 +254,7 @@ def get_common_pdf_table_items(payment: Model) -> (list, tuple):
(
user.get_full_name(),
payment.data["membership"]["label"],
str(payment.data["until"]) + "-12-31",
until_label(payment.data["until"]),
payment.data["price"],
),
("", "", "**Total**", payment.data["price"]),
Expand Down
10 changes: 10 additions & 0 deletions dds_registration/core/helpers/dates.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,19 @@
from datetime import date

from ..membership.validity import add_one_year


def this_year():
return date.today().year


def next_year():
return this_year() + 1


def one_year_from_today():
return add_one_year(date.today())


def end_of_this_year():
return date(this_year(), 12, 31)
Empty file.
93 changes: 93 additions & 0 deletions dds_registration/core/membership/reminders.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
"""Which members get a renewal reminder today, and sending one.

Stages fire at fixed offsets from the membership end date. For a given member only
the latest stage that is already due is considered, so a backlog never produces a
burst of stale emails. Each send is logged in ``MembershipReminder`` keyed on the
end date it was about, which keeps sends idempotent and lets next year's cycle start
clean once the end date moves.
"""

from datetime import date, timedelta
from typing import Iterator

from django.template.loader import render_to_string
from loguru import logger

from ...models import Membership, MembershipReminder
from ..helpers.email import send_email

STAGES = (
("before_60", -60),
("before_30", -30),
("expiry", 0),
("after_30", 30),
("after_60", 60),
)
WINDOW_DAYS = 60
PENDING_PAYMENT_STATUSES = ("CREATED", "ISSUED")
RENEW_URL = "https://events.d-d-s.ch/membership/apply"
SUBJECT_TEMPLATE = "dds_registration/membership/reminder/subject.txt"
BODY_TEMPLATE = "dds_registration/membership/reminder/body.txt"


def stage_due(until: date, today: date) -> str | None:
"""Latest stage whose fire date is on or before ``today``; None when nothing is due yet."""
due = None
for name, offset in STAGES:
if until + timedelta(days=offset) <= today:
due = name
return due


def _has_pending_renewal(membership: Membership) -> bool:
"""A renewal invoice is already out: issued within this end date's reminder window, unpaid."""
payment = membership.payment
return bool(
payment
and payment.status in PENDING_PAYMENT_STATUSES
and payment.data.get("kind") == "membership"
and payment.created >= membership.until - timedelta(days=WINDOW_DAYS)
)


def due_reminders(today: date) -> Iterator[tuple[Membership, str]]:
"""Yield ``(membership, stage)`` pairs that should be emailed today."""
window = (
Membership.objects.filter(
until__gte=today - timedelta(days=WINDOW_DAYS),
until__lte=today + timedelta(days=WINDOW_DAYS),
)
.exclude(membership_type="HONORARY")
.select_related("user", "payment")
.order_by("until", "pk")
)
for membership in window:
stage = stage_due(membership.until, today)
if stage is None or _has_pending_renewal(membership):
continue
if MembershipReminder.objects.filter(membership=membership, until=membership.until, stage=stage).exists():
continue
yield membership, stage


def send_reminder(membership_id: int, until: date, stage: str, today: date | None = None) -> bool:
"""Render and send one reminder; return False when it was already sent."""
today = today or date.today()
membership = Membership.objects.select_related("user").get(pk=membership_id)
if MembershipReminder.objects.filter(membership=membership, until=until, stage=stage).exists():
return False
context = {
"user": membership.user,
"membership": membership,
"until": until,
"stage": stage,
"days_left": (until - today).days,
"expired": until < today,
"renew_url": RENEW_URL,
}
subject = " ".join(render_to_string(SUBJECT_TEMPLATE, context).split())
body = render_to_string(BODY_TEMPLATE, context)
send_email(recipient_address=membership.user.email, subject=subject, message=body)
MembershipReminder.objects.create(membership=membership, until=until, stage=stage)
logger.info("Membership reminder {} sent to {}", stage, membership.user.email)
return True
38 changes: 38 additions & 0 deletions dds_registration/core/membership/validity.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
"""Pure date rules for DdS membership validity and renewal.

A membership runs for one year from its start. Renewing while still active
extends from the current end date; renewing after a lapse restarts from today.
"""

from datetime import date, timedelta


def add_one_year(day: date) -> date:
"""Same calendar date next year; Feb 29 becomes Feb 28."""
try:
return day.replace(year=day.year + 1)
except ValueError:
return day.replace(year=day.year + 1, day=28)


def renewal_until(current_until: date | None, today: date) -> date:
"""End date after a renewal submitted on ``today``."""
if current_until is None or current_until < today:
return add_one_year(today)
return add_one_year(current_until)


def within_renewal_window(current_until: date | None, today: date, window_days: int) -> bool:
"""True when a member may renew: no membership, lapsed, or ending within ``window_days``."""
if current_until is None:
return True
return current_until - today <= timedelta(days=window_days)


def until_label(value) -> str:
"""ISO date for an ``until`` value stored as date, ISO string, or legacy year int."""
if isinstance(value, date):
return value.isoformat()
if isinstance(value, int):
return date(value, 12, 31).isoformat()
return str(value)
Loading
Loading