Updates to Sponsors app from review. (#1968)

* update account nav to include Sponsorships and remove some old cruft

* make labels on asset form more visible

* update notification templates for sponsor deadline notifications

* document available template tags for sponsorship notification emails

* render file assets as a download link

* add a "RequiredResponse" for yes/no questions of sponsors

Author: ewdurbin

sponsors/admin.py

@@ -75,6 +75,9 @@ class RequiredImgAssetConfigurationInline(StackedPolymorphicInline.Child):
     class RequiredTextAssetConfigurationInline(StackedPolymorphicInline.Child):
         model = RequiredTextAssetConfiguration
 
+    class RequiredResponseAssetConfigurationInline(StackedPolymorphicInline.Child):
+        model = RequiredResponseAssetConfiguration
+
     class ProvidedTextAssetConfigurationInline(StackedPolymorphicInline.Child):
         model = ProvidedTextAssetConfiguration
 
@@ -88,6 +91,7 @@ class ProvidedFileAssetConfigurationInline(StackedPolymorphicInline.Child):
         EmailTargetableConfigurationInline,
         RequiredImgAssetConfigurationInline,
         RequiredTextAssetConfigurationInline,
+        RequiredResponseAssetConfigurationInline,
         ProvidedTextAssetConfigurationInline,
         ProvidedFileAssetConfigurationInline,
     ]
@@ -692,4 +696,9 @@ def nullify_contract_view(self, request, pk):
 
 @admin.register(SponsorEmailNotificationTemplate)
 class SponsorEmailNotificationTemplateAdmin(BaseEmailTemplateAdmin):
-    pass
+    def get_form(self, request, obj=None, **kwargs):
+        help_texts = {
+            "content": SPONSOR_TEMPLATE_HELP_TEXT,
+        }
+        kwargs.update({"help_texts": help_texts})
+        return super().get_form(request, obj, **kwargs)

sponsors/forms.py

@@ -22,6 +22,7 @@
     SponsorEmailNotificationTemplate,
     RequiredImgAssetConfiguration,
     BenefitFeature,
+    SPONSOR_TEMPLATE_HELP_TEXT,
 )
 
 
@@ -487,7 +488,11 @@ class SendSponsorshipNotificationForm(forms.Form):
         required=False,
     )
     subject = forms.CharField(max_length=140, required=False)
-    content = forms.CharField(widget=forms.widgets.Textarea(), required=False)
+    content = forms.CharField(
+        widget=forms.widgets.Textarea(),
+        required=False,
+        help_text=SPONSOR_TEMPLATE_HELP_TEXT,
+    )
 
     def clean(self):
         cleaned_data = super().clean()
@@ -629,9 +634,9 @@ def __init__(self, *args, **kwargs):
             field = required_asset.as_form_field(required=required, initial=value)
 
             if required_asset.due_date and not bool(value):
-                field.label = mark_safe(f"{field.label} <b>(Required by {required_asset.due_date})</b>")
+                field.label = mark_safe(f"<big><b>{field.label}</b></big><br><b>(Required by {required_asset.due_date})</b>")
             if bool(value):
-                field.label = mark_safe(f"{field.label} <small>(Fulfilled, thank you!)</small>")
+                field.label = mark_safe(f"<big><b>{field.label}</b></big><br><small>(Fulfilled, thank you!)</small>")
 
             fields[f_name] = field
 

sponsors/management/commands/check_sponsorship_assets_due_date.py

@@ -58,7 +58,7 @@ def handle(self, **options):
 
         notification = AssetCloseToDueDateNotificationToSponsors()
         for sponsorship in sponsorships_to_notify:
-            kwargs = {"sponsorship": sponsorship, "due_date": target_date}
+            kwargs = {"sponsorship": sponsorship, "days": num_days, "due_date": target_date}
             notification.notify(**kwargs)
 
         print("Notifications sent!")

sponsors/migrations/0073_auto_20220128_1906.py

@@ -0,0 +1,67 @@
+# Generated by Django 2.2.24 on 2022-01-28 19:06
+
+from django.db import migrations, models
+import django.db.models.deletion
+import sponsors.models.benefits
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('sponsors', '0072_auto_20220125_2005'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='RequiredResponseAsset',
+            fields=[
+                ('benefitfeature_ptr', models.OneToOneField(auto_created=True, on_delete=django.db.models.deletion.CASCADE, parent_link=True, primary_key=True, serialize=False, to='sponsors.BenefitFeature')),
+                ('related_to', models.CharField(choices=[('sponsor', 'Sponsor'), ('sponsorship', 'Sponsorship')], help_text='To which instance (Sponsor or Sponsorship) should this asset relate to.', max_length=30, verbose_name='Related To')),
+                ('internal_name', models.CharField(db_index=True, help_text='Unique name used internally to control if the sponsor/sponsorship already has the asset', max_length=128, verbose_name='Internal Name')),
+                ('label', models.CharField(help_text="What's the title used to display the input to the sponsor?", max_length=256)),
+                ('help_text', models.CharField(blank=True, default='', help_text='Any helper comment on how the input should be populated', max_length=256)),
+                ('due_date', models.DateField(blank=True, default=None, null=True)),
+            ],
+            options={
+                'verbose_name': 'Require Response',
+                'verbose_name_plural': 'Required Responses',
+                'abstract': False,
+                'base_manager_name': 'objects',
+            },
+            bases=(sponsors.models.benefits.RequiredAssetMixin, 'sponsors.benefitfeature', models.Model),
+        ),
+        migrations.CreateModel(
+            name='RequiredResponseAssetConfiguration',
+            fields=[
+                ('benefitfeatureconfiguration_ptr', models.OneToOneField(auto_created=True, on_delete=django.db.models.deletion.CASCADE, parent_link=True, primary_key=True, serialize=False, to='sponsors.BenefitFeatureConfiguration')),
+                ('related_to', models.CharField(choices=[('sponsor', 'Sponsor'), ('sponsorship', 'Sponsorship')], help_text='To which instance (Sponsor or Sponsorship) should this asset relate to.', max_length=30, verbose_name='Related To')),
+                ('internal_name', models.CharField(db_index=True, help_text='Unique name used internally to control if the sponsor/sponsorship already has the asset', max_length=128, verbose_name='Internal Name')),
+                ('label', models.CharField(help_text="What's the title used to display the input to the sponsor?", max_length=256)),
+                ('help_text', models.CharField(blank=True, default='', help_text='Any helper comment on how the input should be populated', max_length=256)),
+                ('due_date', models.DateField(blank=True, default=None, null=True)),
+            ],
+            options={
+                'verbose_name': 'Require Response Configuration',
+                'verbose_name_plural': 'Require Response Configurations',
+                'abstract': False,
+                'base_manager_name': 'objects',
+            },
+            bases=(sponsors.models.benefits.AssetConfigurationMixin, 'sponsors.benefitfeatureconfiguration', models.Model),
+        ),
+        migrations.CreateModel(
+            name='ResponseAsset',
+            fields=[
+                ('genericasset_ptr', models.OneToOneField(auto_created=True, on_delete=django.db.models.deletion.CASCADE, parent_link=True, primary_key=True, serialize=False, to='sponsors.GenericAsset')),
+                ('response', models.CharField(choices=[('YES', 'Yes'), ('NO', 'No')], max_length=32, null=True)),
+            ],
+            options={
+                'verbose_name': 'Response Asset',
+                'verbose_name_plural': 'Response Assets',
+            },
+            bases=('sponsors.genericasset',),
+        ),
+        migrations.AddConstraint(
+            model_name='requiredresponseassetconfiguration',
+            constraint=models.UniqueConstraint(fields=('internal_name',), name='uniq_response_asset_cfg'),
+        ),
+    ]

sponsors/models/__init__.py

@@ -5,12 +5,12 @@
 """
 
 from .assets import GenericAsset, ImgAsset, TextAsset
-from .notifications import SponsorEmailNotificationTemplate
+from .notifications import SponsorEmailNotificationTemplate, SPONSOR_TEMPLATE_HELP_TEXT
 from .sponsors import Sponsor, SponsorContact, SponsorBenefit
 from .benefits import BaseLogoPlacement, BaseTieredQuantity, BaseEmailTargetable, BenefitFeatureConfiguration, \
     LogoPlacementConfiguration, TieredQuantityConfiguration, EmailTargetableConfiguration, BenefitFeature, \
     LogoPlacement, EmailTargetable, TieredQuantity, RequiredImgAsset, RequiredImgAssetConfiguration, \
-    RequiredTextAssetConfiguration, RequiredTextAsset, ProvidedTextAssetConfiguration, ProvidedTextAsset, \
-    ProvidedFileAssetConfiguration, ProvidedFileAsset
+    RequiredTextAssetConfiguration, RequiredTextAsset, RequiredResponseAssetConfiguration, RequiredResponseAsset, \
+    ProvidedTextAssetConfiguration, ProvidedTextAsset, ProvidedFileAssetConfiguration, ProvidedFileAsset
 from .sponsorship import Sponsorship, SponsorshipProgram, SponsorshipBenefit, Sponsorship, SponsorshipPackage
 from .contract import LegalClause, Contract, signed_contract_random_path

sponsors/models/assets.py

@@ -3,6 +3,7 @@
 from Sponsors or Sponsorships
 """
 import uuid
+from enum import Enum
 from pathlib import Path
 
 from django.db import models
@@ -25,13 +26,14 @@ class GenericAsset(PolymorphicModel):
     """
     Base class used to add required assets to Sponsor or Sponsorship objects
     """
+
     # UUID can't be the object ID because Polymorphic expects default django integer ID
     uuid = models.UUIDField(default=uuid.uuid4, editable=False)
     # The next 3 fields are required by Django to enable and set up generic relations
     # pointing the asset to a Sponsor or Sponsorship object
     content_type = models.ForeignKey(ContentType, on_delete=models.CASCADE)
     object_id = models.PositiveIntegerField()
-    content_object = GenericForeignKey('content_type', 'object_id')
+    content_object = GenericForeignKey("content_type", "object_id")
 
     # must match with internal_name from benefits configuration which describe assets
     internal_name = models.CharField(
@@ -113,3 +115,33 @@ def value(self):
     @value.setter
     def value(self, value):
         self.file = value
+
+
+class Response(Enum):
+    YES = "Yes"
+    NO = "No"
+
+    @classmethod
+    def choices(cls):
+        return tuple((i.name, i.value) for i in cls)
+
+
+class ResponseAsset(GenericAsset):
+    response = models.CharField(
+        max_length=32, choices=Response.choices(), blank=False, null=True
+    )
+
+    def __str__(self):
+        return f"Response Asset: {self.internal_name}"
+
+    class Meta:
+        verbose_name = "Response Asset"
+        verbose_name_plural = "Response Assets"
+
+    @property
+    def value(self):
+        return self.response
+
+    @value.setter
+    def value(self, value):
+        self.response = value

sponsors/models/benefits.py

@@ -7,8 +7,12 @@
 from django.urls import reverse
 from polymorphic.models import PolymorphicModel
 
-from sponsors.models.assets import ImgAsset, TextAsset, FileAsset
-from sponsors.models.enums import PublisherChoices, LogoPlacementChoices, AssetsRelatedTo
+from sponsors.models.assets import ImgAsset, TextAsset, FileAsset, ResponseAsset, Response
+from sponsors.models.enums import (
+    PublisherChoices,
+    LogoPlacementChoices,
+    AssetsRelatedTo,
+)
 
 ########################################
 # Benefit features abstract classes
@@ -174,6 +178,13 @@ class Meta(BaseRequiredAsset.Meta):
         abstract = True
 
 
+class BaseRequiredResponseAsset(BaseRequiredAsset):
+    ASSET_CLASS = ResponseAsset
+
+    class Meta(BaseRequiredAsset.Meta):
+        abstract = True
+
+
 class BaseProvidedTextAsset(BaseProvidedAsset):
     ASSET_CLASS = TextAsset
 
@@ -423,8 +434,27 @@ def benefit_feature_class(self):
         return RequiredTextAsset
 
 
-class ProvidedTextAssetConfiguration(AssetConfigurationMixin, BaseProvidedTextAsset,
-                                     BenefitFeatureConfiguration):
+class RequiredResponseAssetConfiguration(
+    AssetConfigurationMixin, BaseRequiredResponseAsset, BenefitFeatureConfiguration
+):
+    class Meta(BaseRequiredResponseAsset.Meta, BenefitFeatureConfiguration.Meta):
+        verbose_name = "Require Response Configuration"
+        verbose_name_plural = "Require Response Configurations"
+        constraints = [
+            UniqueConstraint(fields=["internal_name"], name="uniq_response_asset_cfg")
+        ]
+
+    def __str__(self):
+        return f"Require response configuration"
+
+    @property
+    def benefit_feature_class(self):
+        return RequiredResponseAsset
+
+
+class ProvidedTextAssetConfiguration(
+    AssetConfigurationMixin, BaseProvidedTextAsset, BenefitFeatureConfiguration
+):
     class Meta(BaseProvidedTextAsset.Meta, BenefitFeatureConfiguration.Meta):
         verbose_name = "Provided Text Configuration"
         verbose_name_plural = "Provided Text Configurations"
@@ -547,6 +577,21 @@ def as_form_field(self, **kwargs):
         return forms.CharField(required=required, help_text=help_text, label=label, widget=widget, **kwargs)
 
 
+class RequiredResponseAsset(RequiredAssetMixin, BaseRequiredResponseAsset, BenefitFeature):
+    class Meta(BaseRequiredTextAsset.Meta, BenefitFeature.Meta):
+        verbose_name = "Require Response"
+        verbose_name_plural = "Required Responses"
+
+    def __str__(self):
+        return f"Require response"
+
+    def as_form_field(self, **kwargs):
+        help_text = kwargs.pop("help_text", self.help_text)
+        label = kwargs.pop("label", self.label)
+        required = kwargs.pop("required", False)
+        return forms.ChoiceField(required=required, choices=Response.choices(), widget=forms.RadioSelect, help_text=help_text, label=label, **kwargs)
+
+
 class ProvidedTextAsset(ProvidedAssetMixin, BaseProvidedTextAsset, BenefitFeature):
     class Meta(BaseProvidedTextAsset.Meta, BenefitFeature.Meta):
         verbose_name = "Provided Text"

sponsors/models/notifications.py

@@ -2,6 +2,16 @@
 
 from mailing.models import BaseEmailTemplate
 
+SPONSOR_TEMPLATE_HELP_TEXT = (
+    "<br>"
+    "You can use the following template variables in the Subject and Content:"
+    "  <pre>{{ sponsor_name }}</pre>"
+    "  <pre>{{ sponsorship_level }}</pre>"
+    "  <pre>{{ sponsorship_start_date }}</pre>"
+    "  <pre>{{ sponsorship_end_date }}</pre>"
+    "  <pre>{{ sponsorship_status }}</pre>"
+)
+
 
 #################################
 # Sponsor Email Notifications

sponsors/notifications.py

@@ -221,7 +221,7 @@ def notify(self, *args, **kwargs):
 class AssetCloseToDueDateNotificationToSponsors(BaseEmailSponsorshipNotification):
     subject_template = "sponsors/email/sponsor_expiring_assets_subject.txt"
     message_template = "sponsors/email/sponsor_expiring_assets.txt"
-    email_context_keys = ["sponsorship", "required_assets", "due_date"]
+    email_context_keys = ["sponsorship", "required_assets", "due_date", "days"]
 
     def get_recipient_list(self, context):
         return context["sponsorship"].verified_emails

sponsors/tests/test_notifications.py

@@ -455,11 +455,11 @@ def setUp(self):
         self.content_template = "sponsors/email/sponsor_expiring_assets.txt"
 
     def test_send_email_using_correct_templates(self):
-        context = {"sponsorship": self.sponsorship}
+        context = {"sponsorship": self.sponsorship, "days": 7}
         expected_subject = render_to_string(self.subject_template, context).strip()
         expected_content = render_to_string(self.content_template, context).strip()
 
-        self.notification.notify(sponsorship=self.sponsorship)
+        self.notification.notify(sponsorship=self.sponsorship, days=7)
         self.assertTrue(mail.outbox)
 
         email = mail.outbox[0]
@@ -479,9 +479,9 @@ def test_list_required_assets_in_email_context(self):
         cfg = baker.make(RequiredTextAssetConfiguration, internal_name='input')
         benefit = baker.make(SponsorBenefit, sponsorship=self.sponsorship)
         asset = cfg.create_benefit_feature(benefit)
-        base_context = {"sponsorship": self.sponsorship, "due_date": date.today()}
+        base_context = {"sponsorship": self.sponsorship, "due_date": date.today(), "days": 7}
         context = self.notification.get_email_context(**base_context)
-        self.assertEqual(3, len(context))
+        self.assertEqual(4, len(context))
         self.assertEqual(self.sponsorship, context["sponsorship"])
         self.assertEqual(1, len(context["required_assets"]))
         self.assertEqual(date.today(), context["due_date"])