User workflow for sponsorship applications (#1667)

* Initial sponsor application modeling

* Form to create a new sponsor application

* Simple view to display new sponsor application form

* Use cookie to store selected benefits

* Redirect user back to benefits form if no data in cookie

* Simple template view to work as the final step

* Move helper test method to utils

* Make sure wokflow finishes as expected

* Create sponsorship using information, benefits and package

* Post also creates sponsorship

* Use the package amount as sponsorship fee

* Inform users about why they are being redirect

* Clean up cookies after creating sponsorship

* View to preview sponsorship

* Remove old TODO note

* Trailing slashes

* Clean up current Sponsor model implementation

* SponsorInformation is now the Sponsor model

* Create select field for user to pick existing sponsors

* Create formset for contacts

* Refactor sponsorship application form to use contacts formset

* Remove deprecated comment

* Better determine primary and user contact

* Install django widget tweaks

* Render form fields manually

* Better display for contacts form

* Implement missing __str__

* JS to control contact field sets

* Hide/show logic if user has previous sponsor

* Fix CSS error with upload inputs

* Display SponsorContact in the admin

* Unit test new property

* New sponsor fields are only required if no sponsor was selected

* Display message with sponsorship information

* Check benefits if already selected

* Display form errors

* Fix test to properly force error

* Checkbox to select primary contacts

* Force order to avoid tests inconsistency

* Display price preview

* CSS fix for contacts form

* Display the form if errors

* Refactor how contacts are being structured so they fit well if errors

* Implement logic to check if application is for a modified package

* Add status field to Sponsorship

* allow reordering sponsorship programs in django admin

* apply black formatting

* add indicator for benefits marked as new

Co-authored-by: Ernest W. Durbin III <ewdurbin@gmail.com>

Author: berinhard

base-requirements.txt

@@ -37,3 +37,4 @@ django-waffle==0.14
 djangorestframework==3.8.2
 django-filter==1.1.0
 django-ordered-model==3.4.1
+django-widget-tweaks==1.4.8

pydotorg/settings/base.py

@@ -152,6 +152,7 @@
     'honeypot',
     'waffle',
     'ordered_model',
+    'widget_tweaks',
 
     'users',
     'boxes',

sponsors/admin.py

@@ -1,13 +1,28 @@
-from django.contrib import admin
 from ordered_model.admin import OrderedModelAdmin
 
-from .models import SponsorshipPackage, SponsorshipProgram, SponsorshipBenefit, Sponsor
+from django.urls import path, reverse
+from django.contrib import admin
+from django.utils.html import mark_safe
+from django.shortcuts import get_object_or_404, render
+
+from .models import (
+    SponsorshipPackage,
+    SponsorshipProgram,
+    SponsorshipBenefit,
+    Sponsor,
+    Sponsorship,
+    SponsorContact,
+)
 from cms.admin import ContentManageableModelAdmin
 
 
 @admin.register(SponsorshipProgram)
 class SponsorshipProgramAdmin(OrderedModelAdmin):
-    pass
+    ordering = ("order",)
+    list_display = [
+        "name",
+        "move_up_down_links",
+    ]
 
 
 @admin.register(SponsorshipBenefit)
@@ -58,14 +73,49 @@ class SponsorshipPackageAdmin(OrderedModelAdmin):
     list_display = ["name", "move_up_down_links"]
 
 
+class SponsorContactInline(admin.TabularInline):
+    model = SponsorContact
+    extra = 0
+
+
 @admin.register(Sponsor)
 class SponsorAdmin(ContentManageableModelAdmin):
-    raw_id_fields = ["company"]
+    inlines = [SponsorContactInline]
+
+
+@admin.register(Sponsorship)
+class SponsorshipAdmin(admin.ModelAdmin):
+    list_display = [
+        "sponsor",
+        "applied_on",
+        "approved_on",
+        "start_date",
+        "end_date",
+        "display_sponsorship_link",
+    ]
+
+    def get_queryset(self, *args, **kwargs):
+        qs = super().get_queryset(*args, **kwargs)
+        return qs.select_related("sponsor")
+
+    def display_sponsorship_link(self, obj):
+        url = reverse("admin:sponsors_sponsorship_preview", args=[obj.pk])
+        return mark_safe(f'<a href="{url}" target="_blank">Click to preview</a>')
+
+    display_sponsorship_link.short_description = "Preview sponsorship"
 
-    def get_list_filter(self, request):
-        fields = list(super().get_list_filter(request))
-        return fields + ["is_published"]
+    def preview_sponsorship_view(self, request, pk):
+        sponsorship = get_object_or_404(self.get_queryset(request), pk=pk)
+        ctx = {"sponsorship": sponsorship}
+        return render(request, "sponsors/admin/preview-sponsorship.html", context=ctx)
 
-    def get_list_display(self, request):
-        fields = list(super().get_list_display(request))
-        return fields + ["is_published"]
+    def get_urls(self, *args, **kwargs):
+        urls = super().get_urls(*args, **kwargs)
+        custom_urls = [
+            path(
+                "<int:pk>/preview",
+                self.admin_site.admin_view(self.preview_sponsorship_view),
+                name="sponsors_sponsorship_preview",
+            ),
+        ]
+        return custom_urls + urls

sponsors/cookies.py

@@ -0,0 +1,22 @@
+import json
+
+BENEFITS_COOKIE_NAME = "sponsorship_selected_benefits"
+
+
+def get_sponsorship_selected_benefits(request):
+    sponsorship_selected_benefits = request.COOKIES.get(BENEFITS_COOKIE_NAME)
+    if sponsorship_selected_benefits:
+        try:
+            return json.loads(sponsorship_selected_benefits)
+        except json.JSONDecodeError:
+            pass
+    return {}
+
+
+def set_sponsorship_selected_benefits(response, data):
+    max_age = 60 * 60 * 24  # one day
+    response.set_cookie(BENEFITS_COOKIE_NAME, json.dumps(data), max_age=max_age)
+
+
+def delete_sponsorship_selected_benefits(response):
+    response.delete_cookie(BENEFITS_COOKIE_NAME)

sponsors/forms.py

@@ -2,8 +2,15 @@
 from django import forms
 from django.utils.text import slugify
 from django.utils.translation import ugettext_lazy as _
+from django.utils.functional import cached_property
 
-from sponsors.models import SponsorshipBenefit, SponsorshipPackage, SponsorshipProgram
+from sponsors.models import (
+    SponsorshipBenefit,
+    SponsorshipPackage,
+    SponsorshipProgram,
+    Sponsor,
+    SponsorContact,
+)
 
 
 class PickSponsorshipBenefitsField(forms.ModelMultipleChoiceField):
@@ -13,6 +20,23 @@ def label_from_instance(self, obj):
         return obj.name
 
 
+class SponsorContactForm(forms.ModelForm):
+    class Meta:
+        model = SponsorContact
+        fields = ["name", "email", "phone", "primary"]
+
+
+SponsorContactFormSet = forms.formset_factory(
+    SponsorContactForm,
+    extra=0,
+    min_num=1,
+    validate_min=True,
+    can_delete=False,
+    can_order=False,
+    max_num=5,
+)
+
+
 class SponsorshiptBenefitsForm(forms.Form):
     package = forms.ModelChoiceField(
         queryset=SponsorshipPackage.objects.all(),
@@ -54,6 +78,9 @@ def get_benefits(self, cleaned_data=None):
             chain(*(cleaned_data.get(bp.name) for bp in self.benefits_programs))
         )
 
+    def get_package(self):
+        return self.cleaned_data.get("package")
+
     def _clean_benefits(self, cleaned_data):
         """
         Validate chosen benefits. Invalid scenarios are:
@@ -100,3 +127,130 @@ def _clean_benefits(self, cleaned_data):
     def clean(self):
         cleaned_data = super().clean()
         return self._clean_benefits(cleaned_data)
+
+
+class SponsorshipApplicationForm(forms.Form):
+    name = forms.CharField(
+        max_length=100,
+        label="Sponsor name",
+        help_text="Name of the sponsor, for public display.",
+        required=False,
+    )
+    description = forms.CharField(
+        label="Sponsor description",
+        help_text="Brief description of the sponsor for public display.",
+        required=False,
+        widget=forms.TextInput,
+    )
+    landing_page_url = forms.URLField(
+        label="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.",
+        required=False,
+    )
+    web_logo = forms.ImageField(
+        label="Sponsor web logo",
+        help_text="For display on our sponsor webpage. High resolution PNG or JPG, smallest dimension no less than 256px",
+        required=False,
+    )
+    print_logo = forms.FileField(
+        label="Sponsor print logo",
+        help_text="For printed materials, signage, and projection. SVG or EPS",
+        required=False,
+    )
+
+    primary_phone = forms.CharField(
+        label="Sponsor Primary Phone", max_length=32, required=False,
+    )
+    mailing_address = forms.CharField(
+        label="Sponsor Mailing/Billing Address", widget=forms.TextInput, required=False,
+    )
+
+    def __init__(self, *args, **kwargs):
+        self.user = kwargs.pop("user", None)
+        super().__init__(*args, **kwargs)
+        qs = Sponsor.objects.none()
+        if self.user:
+            sponsor_ids = SponsorContact.objects.filter(user=self.user).values_list(
+                "sponsor", flat=True
+            )
+            qs = Sponsor.objects.filter(id__in=sponsor_ids)
+        self.fields["sponsor"] = forms.ModelChoiceField(queryset=qs, required=False)
+
+        formset_kwargs = {"prefix": "contact"}
+        if self.data:
+            self.contacts_formset = SponsorContactFormSet(self.data, **formset_kwargs)
+        else:
+            self.contacts_formset = SponsorContactFormSet(**formset_kwargs)
+
+    def clean(self):
+        cleaned_data = super().clean()
+        sponsor = self.data.get("sponsor")
+        if not sponsor and 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)
+        elif not sponsor:
+            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 clean_name(self):
+        name = self.cleaned_data.get("name", "")
+        sponsor = self.data.get("sponsor")
+        if not sponsor and not name:
+            raise forms.ValidationError("This field is required.")
+        return name.strip()
+
+    def clean_web_logo(self):
+        web_logo = self.cleaned_data.get("web_logo", "")
+        sponsor = self.data.get("sponsor")
+        if not sponsor and not web_logo:
+            raise forms.ValidationError("This field is required.")
+        return web_logo
+
+    def clean_primary_phone(self):
+        primary_phone = self.cleaned_data.get("primary_phone", "")
+        sponsor = self.data.get("sponsor")
+        if not sponsor and not primary_phone:
+            raise forms.ValidationError("This field is required.")
+        return primary_phone.strip()
+
+    def clean_mailing_address(self):
+        mailing_address = self.cleaned_data.get("mailing_address", "")
+        sponsor = self.data.get("sponsor")
+        if not sponsor and not mailing_address:
+            raise forms.ValidationError("This field is required.")
+        return mailing_address.strip()
+
+    def save(self):
+        selected_sponsor = self.cleaned_data.get("sponsor")
+        if selected_sponsor:
+            return selected_sponsor
+
+        sponsor = Sponsor.objects.create(
+            name=self.cleaned_data["name"],
+            web_logo=self.cleaned_data["web_logo"],
+            primary_phone=self.cleaned_data["primary_phone"],
+            mailing_address=self.cleaned_data["mailing_address"],
+            description=self.cleaned_data.get("description", ""),
+            landing_page_url=self.cleaned_data.get("landing_page_url", ""),
+            print_logo=self.cleaned_data.get("print_logo"),
+        )
+        contacts = [f.save(commit=False) for f in self.contacts_formset.forms]
+        for contact in contacts:
+            if self.user and self.user.email.lower() == contact.email.lower():
+                contact.user = self.user
+            contact.sponsor = sponsor
+            contact.save()
+
+        return sponsor
+
+    @cached_property
+    def user_with_previous_sponsors(self):
+        if not self.user:
+            return False
+        return self.fields["sponsor"].queryset.exists()

sponsors/migrations/0001_initial.py

@@ -91,10 +91,7 @@ class Migration(migrations.Migration):
                     ),
                 ),
             ],
-            options={
-                "verbose_name": "sponsor",
-                "verbose_name_plural": "sponsors",
-            },
+            options={"verbose_name": "sponsor", "verbose_name_plural": "sponsors",},
             bases=(models.Model,),
         ),
     ]

sponsors/migrations/0004_auto_20201014_1622.py

@@ -40,10 +40,7 @@ class Migration(migrations.Migration):
                     ),
                 ),
             ],
-            options={
-                "ordering": ("order",),
-                "abstract": False,
-            },
+            options={"ordering": ("order",), "abstract": False,},
         ),
         migrations.CreateModel(
             name="SponsorshipLevel",
@@ -66,10 +63,7 @@ class Migration(migrations.Migration):
                 ("name", models.CharField(max_length=64)),
                 ("sponsorship_amount", models.PositiveIntegerField()),
             ],
-            options={
-                "ordering": ("order",),
-                "abstract": False,
-            },
+            options={"ordering": ("order",), "abstract": False,},
         ),
         migrations.CreateModel(
             name="SponsorshipProgram",
@@ -92,10 +86,7 @@ class Migration(migrations.Migration):
                 ("name", models.CharField(max_length=64)),
                 ("description", models.TextField(blank=True, null=True)),
             ],
-            options={
-                "ordering": ("order",),
-                "abstract": False,
-            },
+            options={"ordering": ("order",), "abstract": False,},
         ),
         migrations.AddField(
             model_name="sponsorshipbenefit",

sponsors/migrations/0006_auto_20201016_1517.py

@@ -11,17 +11,10 @@ class Migration(migrations.Migration):
 
     operations = [
         migrations.RenameModel(
-            old_name="SponsorshipLevel",
-            new_name="SponsorshipPackage",
-        ),
-        migrations.RemoveField(
-            model_name="sponsorshipbenefit",
-            name="levels",
-        ),
-        migrations.RemoveField(
-            model_name="sponsorshipbenefit",
-            name="minimum_level",
+            old_name="SponsorshipLevel", new_name="SponsorshipPackage",
         ),
+        migrations.RemoveField(model_name="sponsorshipbenefit", name="levels",),
+        migrations.RemoveField(model_name="sponsorshipbenefit", name="minimum_level",),
         migrations.AddField(
             model_name="sponsorshipbenefit",
             name="new",