Sponsorship dashboard (#1892)

* Sort apps by name

* Add missing migration after help text change

* Add new app to handle custom email dispatching

* Add new model to configure sponsor notifications

* Minimal admin

* Update admin form to validate content as django template

* Add button to preview how template will render

* Add new benefit configuration to flag email targeatable

* Add method to filter sponsorships by included features

* Enable user to select which notification template to use

* Rename variable

* Display warning message if selected sponsorships aren't targetable

* Introduce indirection with use case to send the emails

* Implement method to create a EmailMessage from a notification template

* Display non targetable sponsorship as checkbox instead of text

* Add select all/delete all links

* Filter emails by benefits, not feature configuration

* Better display for notification objects

* Add checkbox to select contact type

* Update get_message method to accept boolean flags to control recipients

* Rename form field  name

* Send notification to sponsors

* Register email dispatch with admin log entry activity

* Add input for custom email content

* Display input for custom email content

* UC expects sponsorship object, not PK

* Consider email subject as a template as well

* Refactor to move specific email building part to mailing app

* Remove warning message

* Optimizes sponsorship admin query

* Add option to preview notification

* Fix parameters names

* Organize sections as divs

* Remove unused imports and optimize query

* Minimal working code to list user sponsorships

* Change Sponsorships button to redirect user to sponsorships dashboard

* Update HTML to list active/finalized sponsorships

* Move sponsorship detail view to users app

* Minimal view to update sponsor info

* Inline display sponsor contacts

* Reuse style from sponsorships application form to edit sponsor information

* Improve fields display

* Add link to edit sponsor information from sponsorship detail page

* Display sponsor information in sponsorship detail page

* Do not list the sponsors at sponsorship dashboard page

* Add JS to handle with the inline contact forms

* TODO note with my tests' checklist

* Move button to right

* Display fields as readonly

* Add unit tests

* Remove file inputs

* Better organize sponsorships

* Revert "Remove file inputs"

This reverts commit d7f9047.

* Do not allow user to clear file inputs

* Do not change file input background

* Run code linter

* Remove unecessary br

* File inputs should be required

Author: berinhard

pydotorg/context_processors.py

@@ -34,10 +34,12 @@ def user_nav_bar_links(request):
     nav = {}
     if request.user.is_authenticated:
         user = request.user
-        sponsorship_urls = [
-            {"url": sp.detail_url, "label": f"{sp.sponsor.name}'s sponsorship"}
-            for sp in user.sponsorships
-        ]
+        sponsorship_url = None
+        if user.sponsorships.exists():
+            sponsorship_url = reverse("users:user_sponsorships_dashboard")
+
+        # if the section has a urls key, the section buttion will work as a drop-down menu
+        # if the section has only a url key, the button will be a link instead
         nav = {
             "account": {
                 "label": "Your Account",
@@ -54,8 +56,8 @@ def user_nav_bar_links(request):
                 ],
             },
             "sponsorships": {
-                "label": "Sponsorships",
-                "urls": sponsorship_urls,
+                "label": "Sponsorships Dashboard",
+                "url": sponsorship_url
             }
         }
 

pydotorg/tests/test_context_processors.py

@@ -52,8 +52,8 @@ def test_user_nav_bar_links_for_non_psf_members(self):
                 ],
             },
             "sponsorships": {
-                "label": "Sponsorships",
-                "urls": [],
+                "label": "Sponsorships Dashboard",
+                "url": None,
             }
         }
 
@@ -84,8 +84,8 @@ def test_user_nav_bar_links_for_psf_members(self):
                 ],
             },
             "sponsorships": {
-                "label": "Sponsorships",
-                "urls": [],
+                "label": "Sponsorships Dashboard",
+                "url": None,
             }
         }
 
@@ -97,18 +97,15 @@ def test_user_nav_bar_links_for_psf_members(self):
     def test_user_nav_bar_sponsorship_links(self):
         request = self.factory.get('/about/')
         request.user = baker.make(settings.AUTH_USER_MODEL, username='foo')
-        sponsorships = baker.make("sponsors.Sponsorship", submited_by=request.user, _quantity=2, _fill_optional=True)
-
-        expected_sponsorships = {
-            "label": "Sponsorships",
-            "urls": [
-                {"url": sp.detail_url, "label": f"{sp.sponsor.name}'s sponsorship"}
-                for sp in request.user.sponsorships
-            ]
+        baker.make("sponsors.Sponsorship", submited_by=request.user, _quantity=2, _fill_optional=True)
+
+        expected_section = {
+            "label": "Sponsorships Dashboard",
+            "url": reverse("users:user_sponsorships_dashboard")
         }
 
         self.assertEqual(
-            expected_sponsorships,
+            expected_section,
             context_processors.user_nav_bar_links(request)['USER_NAV_BAR']['sponsorships']
         )
 

sponsors/forms.py

@@ -463,3 +463,66 @@ def get_notification(self):
             subject=self.cleaned_data["subject"],
         )
         return self.cleaned_data.get("notification") or default_notification
+
+
+class SponsorUpdateForm(forms.ModelForm):
+    READONLY_FIELDS = [
+        "name",
+    ]
+
+    web_logo = forms.ImageField(
+        widget=forms.widgets.FileInput,
+        help_text="For display on our sponsor webpage. High resolution PNG or JPG, smallest dimension no less than 256px",
+        required=False,
+    )
+    print_logo = forms.ImageField(
+        widget=forms.widgets.FileInput,
+        help_text="For printed materials, signage, and projection. SVG or EPS",
+        required=False,
+    )
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        formset_kwargs = {"prefix": "contact", "instance": self.instance}
+        factory = forms.inlineformset_factory(
+            Sponsor,
+            SponsorContact,
+            form=SponsorContactForm,
+            extra=0,
+            min_num=1,
+            validate_min=True,
+            can_delete=True,
+            can_order=False,
+            max_num=5,
+        )
+        if self.data:
+            self.contacts_formset = factory(self.data, **formset_kwargs)
+        else:
+            self.contacts_formset = factory(**formset_kwargs)
+        # display fields as read-only
+        for disabled in self.READONLY_FIELDS:
+            self.fields[disabled].widget.attrs['readonly'] = True
+
+    class Meta:
+        exclude = ["created", "updated", "creator", "last_modified_by"]
+        model = Sponsor
+
+    def clean(self):
+        cleaned_data = super().clean()
+
+        if not self.contacts_formset.is_valid():
+            msg = "Errors with contact(s) information"
+            if not self.contacts_formset.errors:
+                msg = "You have to enter at least one contact"
+            raise forms.ValidationError(msg)
+
+        has_primary_contact = any(
+            f.cleaned_data.get("primary") for f in self.contacts_formset.forms
+        )
+        if not has_primary_contact:
+            msg = "You have to mark at least one contact as the primary one."
+            raise forms.ValidationError(msg)
+
+    def save(self, *args, **kwargs):
+        super().save(*args, **kwargs)
+        self.contacts_formset.save()

sponsors/models.py

@@ -1,6 +1,7 @@
 import uuid
 from itertools import chain
 from num2words import num2words
+from datetime import date
 from django.conf import settings
 from django.core.exceptions import ObjectDoesNotExist
 from django.db import models, transaction
@@ -433,6 +434,13 @@ def agreed_fee(self):
         except SponsorshipPackage.DoesNotExist:  # sponsorship level names can change over time
             return None
 
+    @property
+    def is_active(self):
+        conditions = [
+            self.status == self.FINALIZED,
+            self.end_date and self.end_date > date.today()
+        ]
+
     def reject(self):
         if self.REJECTED not in self.next_status:
             msg = f"Can't reject a {self.get_status_display()} sponsorship."
@@ -492,7 +500,7 @@ def contract_admin_url(self):
 
     @property
     def detail_url(self):
-        return reverse("sponsorship_application_detail", args=[self.pk])
+        return reverse("users:sponsorship_application_detail", args=[self.pk])
 
     @cached_property
     def package_benefits(self):
@@ -620,39 +628,39 @@ class Sponsor(ContentManageable):
 
     name = models.CharField(
         max_length=100,
-        verbose_name="Sponsor name",
+        verbose_name="Name",
         help_text="Name of the sponsor, for public display.",
     )
     description = models.TextField(
-        verbose_name="Sponsor description",
+        verbose_name="Description",
         help_text="Brief description of the sponsor for public display.",
     )
     landing_page_url = models.URLField(
         blank=True,
         null=True,
-        verbose_name="Sponsor landing page",
-        help_text="Sponsor landing page URL. This may be provided by the sponsor, however the linked page may not contain any sales or marketing information.",
+        verbose_name="Landing page URL",
+        help_text="Landing page URL. This may be provided by the sponsor, however the linked page may not contain any sales or marketing information.",
     )
     twitter_handle = models.CharField(
         max_length=32,  # Actual limit set by twitter is 15 characters, but that may change?
         blank=True,
         null=True,
-        verbose_name="Sponsor twitter hanlde",
+        verbose_name="Twitter handle",
     )
     web_logo = models.ImageField(
         upload_to="sponsor_web_logos",
-        verbose_name="Sponsor web logo",
+        verbose_name="Web logo",
         help_text="For display on our sponsor webpage. High resolution PNG or JPG, smallest dimension no less than 256px",
     )
     print_logo = models.FileField(
         upload_to="sponsor_print_logos",
         blank=True,
         null=True,
-        verbose_name="Sponsor print logo",
+        verbose_name="Print logo",
         help_text="For printed materials, signage, and projection. SVG or EPS",
     )
 
-    primary_phone = models.CharField("Sponsor Primary Phone", max_length=32)
+    primary_phone = models.CharField("Primary Phone", max_length=32)
     mailing_address_line_1 = models.CharField(
         verbose_name="Mailing Address line 1", max_length=128, default=""
     )

sponsors/tests/test_views.py

@@ -317,42 +317,3 @@ def test_redirect_user_back_to_benefits_selection_if_post_without_valid_set_of_b
         self.client.cookies["sponsorship_selected_benefits"] = "invalid"
         r = self.client.post(self.url, data=self.data)
         self.assertRedirects(r, reverse("select_sponsorship_application_benefits"))
-
-
-class SponsorshipDetailViewTests(TestCase):
-
-    def setUp(self):
-        self.user = baker.make(settings.AUTH_USER_MODEL)
-        self.client.force_login(self.user)
-        self.sponsorship = baker.make(
-            Sponsorship, submited_by=self.user, status=Sponsorship.APPLIED, _fill_optional=True
-        )
-        self.url = reverse(
-            "sponsorship_application_detail", args=[self.sponsorship.pk]
-        )
-
-    def test_display_template_with_sponsorship_info(self):
-        response = self.client.get(self.url)
-        context = response.context
-
-        self.assertTemplateUsed(response, "sponsors/sponsorship_detail.html")
-        self.assertEqual(context["sponsorship"], self.sponsorship)
-
-    def test_404_if_sponsorship_does_not_exist(self):
-        self.sponsorship.delete()
-        response = self.client.get(self.url)
-        self.assertEqual(response.status_code, 404)
-
-    def test_login_required(self):
-        login_url = settings.LOGIN_URL
-        redirect_url = f"{login_url}?next={self.url}"
-        self.client.logout()
-
-        r = self.client.get(self.url)
-
-        self.assertRedirects(r, redirect_url)
-
-    def test_404_if_sponsorship_does_not_belong_to_user(self):
-        self.client.force_login(baker.make(settings.AUTH_USER_MODEL))  # log in with a new user
-        response = self.client.get(self.url)
-        self.assertEqual(response.status_code, 404)

sponsors/urls.py

@@ -10,9 +10,4 @@
     path('application/', views.SelectSponsorshipApplicationBenefitsView.as_view(),
         name="select_sponsorship_application_benefits",
     ),
-    path(
-        "application/<int:pk>/detail/",
-        views.SponsorshipDetailView.as_view(),
-        name="sponsorship_application_detail",
-    ),
 ]

sponsors/views.py

@@ -1,23 +1,18 @@
-import json
 from itertools import chain
 from django.conf import settings
 from django.contrib import messages
 from django.contrib.auth.decorators import login_required
-from django.contrib.auth.mixins import LoginRequiredMixin
 from django.db import transaction
 from django.forms.utils import ErrorList
-from django.http import JsonResponse
 from django.shortcuts import redirect, render
 from django.urls import reverse_lazy, reverse
 from django.utils.decorators import method_decorator
-from django.views.generic import ListView, FormView, DetailView
+from django.views.generic import FormView, DetailView, RedirectView
 
 from .models import (
-    Sponsor,
     SponsorshipBenefit,
     SponsorshipPackage,
     SponsorshipProgram,
-    Sponsorship,
 )
 
 from sponsors import cookies
@@ -174,12 +169,3 @@ def form_valid(self, form):
         )
         cookies.delete_sponsorship_selected_benefits(response)
         return response
-
-
-@method_decorator(login_required(login_url=settings.LOGIN_URL), name="dispatch")
-class SponsorshipDetailView(DetailView):
-    context_object_name = 'sponsorship'
-    template_name = 'sponsors/sponsorship_detail.html'
-
-    def get_queryset(self):
-        return self.request.user.sponsorships