Sponsorship placement tweaks (#1914)

* add an anchor link for each sponsor on the sponsorship page

* add options to alter link/description of sponsor logo placements

* implement overrides for sponsor url/description in placements per configuration

* fix tests

Author: ewdurbin

sponsors/api.py

@@ -1,3 +1,6 @@
+from django.utils.text import slugify
+from django.urls import reverse
+
 from rest_framework import permissions
 from rest_framework import serializers
 from rest_framework.authentication import TokenAuthentication
@@ -56,6 +59,10 @@ def get(self, request, *args, **kwargs):
                 placement = base_data.copy()
                 placement["publisher"] = logo.publisher
                 placement["flight"] = logo.logo_place
+                if logo.describe_as_sponsor:
+                    placement["description"] = f"{sponsor.name} is a {sponsorship.level_name} sponsor of the Python Software Foundation."
+                if logo.link_to_sponsors_page:
+                    placement["sponsor_url"] = request.build_absolute_uri(reverse('psf-sponsors') + f"#{slugify(sponsor.name)}")
                 placements.append(placement)
 
         serializer = LogoPlacementSerializer(placements, many=True)

sponsors/migrations/0060_auto_20211111_1526.py

@@ -0,0 +1,33 @@
+# Generated by Django 2.2.24 on 2021-11-11 15:26
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('sponsors', '0059_auto_20211029_1503'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='logoplacement',
+            name='describe_as_sponsor',
+            field=models.BooleanField(default=False),
+        ),
+        migrations.AddField(
+            model_name='logoplacement',
+            name='link_to_sponsors_page',
+            field=models.BooleanField(default=False),
+        ),
+        migrations.AddField(
+            model_name='logoplacementconfiguration',
+            name='describe_as_sponsor',
+            field=models.BooleanField(default=False),
+        ),
+        migrations.AddField(
+            model_name='logoplacementconfiguration',
+            name='link_to_sponsors_page',
+            field=models.BooleanField(default=False),
+        ),
+    ]

sponsors/migrations/0061_auto_20211111_1529.py

@@ -0,0 +1,33 @@
+# Generated by Django 2.2.24 on 2021-11-11 15:29
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('sponsors', '0060_auto_20211111_1526'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='logoplacement',
+            name='describe_as_sponsor',
+            field=models.BooleanField(default=False, help_text='Override description with "SPONSOR_NAME is a SPONSOR_LEVEL sponsor of the Python Software Foundation".'),
+        ),
+        migrations.AlterField(
+            model_name='logoplacement',
+            name='link_to_sponsors_page',
+            field=models.BooleanField(default=False, help_text='Override URL in placement to the PSF Sponsors Page, rather than the sponsor landing page url.'),
+        ),
+        migrations.AlterField(
+            model_name='logoplacementconfiguration',
+            name='describe_as_sponsor',
+            field=models.BooleanField(default=False, help_text='Override description with "SPONSOR_NAME is a SPONSOR_LEVEL sponsor of the Python Software Foundation".'),
+        ),
+        migrations.AlterField(
+            model_name='logoplacementconfiguration',
+            name='link_to_sponsors_page',
+            field=models.BooleanField(default=False, help_text='Override URL in placement to the PSF Sponsors Page, rather than the sponsor landing page url.'),
+        ),
+    ]

sponsors/models/benefits.py

@@ -25,6 +25,14 @@ class BaseLogoPlacement(models.Model):
         verbose_name="Logo Placement",
         help_text="Where the logo should be placed?"
     )
+    link_to_sponsors_page = models.BooleanField(
+        default=False,
+        help_text="Override URL in placement to the PSF Sponsors Page, rather than the sponsor landing page url.",
+    )
+    describe_as_sponsor = models.BooleanField(
+        default=False,
+        help_text='Override description with "SPONSOR_NAME is a SPONSOR_LEVEL sponsor of the Python Software Foundation".',
+    )
 
     class Meta:
         abstract = True

sponsors/tests/baker_recipes.py

@@ -49,3 +49,9 @@
     publisher=PublisherChoices.FOUNDATION.value,
     logo_place=LogoPlacementChoices.SPONSORS_PAGE.value,
 )
+
+logo_at_pypi_feature = Recipe(
+    LogoPlacement,
+    publisher=PublisherChoices.PYPI.value,
+    logo_place=LogoPlacementChoices.SIDEBAR.value,
+)

sponsors/tests/test_api.py

@@ -1,11 +1,12 @@
 from django.contrib.auth.models import Permission
 from django.urls import reverse_lazy
+from django.utils.text import slugify
 from model_bakery import baker
 from rest_framework.authtoken.models import Token
 from rest_framework.test import APITestCase
 
 from sponsors.models import Sponsor
-from sponsors.models.enums import LogoPlacementChoices
+from sponsors.models.enums import LogoPlacementChoices, PublisherChoices
 
 
 class LogoPlacementeAPIListTests(APITestCase):
@@ -17,7 +18,7 @@ def setUp(self):
         self.permission = Permission.objects.get(name='Can access sponsor placement API')
         self.user.user_permissions.add(self.permission)
         self.authorization = f'Token {token.key}'
-        self.sponsors = baker.make(Sponsor, _create_files=True, _quantity=2)
+        self.sponsors = baker.make(Sponsor, _create_files=True, _quantity=3)
 
     def tearDown(self):
         for sponsor in Sponsor.objects.all():
@@ -27,20 +28,39 @@ def tearDown(self):
                 sponsor.print_logo.delete()
 
     def test_list_logo_placement_as_expected(self):
-        sp1, sp2 = baker.make_recipe("sponsors.tests.finalized_sponsorship", sponsor=iter(self.sponsors), _quantity=2)
+        sp1, sp2, sp3 = baker.make_recipe("sponsors.tests.finalized_sponsorship", sponsor=iter(self.sponsors), _quantity=3)
         baker.make_recipe("sponsors.tests.logo_at_download_feature", sponsor_benefit__sponsorship=sp1)
         baker.make_recipe("sponsors.tests.logo_at_sponsors_feature", sponsor_benefit__sponsorship=sp1)
         baker.make_recipe("sponsors.tests.logo_at_sponsors_feature", sponsor_benefit__sponsorship=sp2)
+        baker.make_recipe("sponsors.tests.logo_at_pypi_feature", sponsor_benefit__sponsorship=sp3, link_to_sponsors_page=True, describe_as_sponsor=True)
 
         response = self.client.get(self.url, HTTP_AUTHORIZATION=self.authorization)
         data = response.json()
 
         self.assertEqual(200, response.status_code)
-        self.assertEqual(3, len(data))
+        self.assertEqual(4, len(data))
         self.assertEqual(2, len([p for p in data if p["flight"] == LogoPlacementChoices.SPONSORS_PAGE.value]))
         self.assertEqual(1, len([p for p in data if p["flight"] == LogoPlacementChoices.DOWNLOAD_PAGE.value]))
+        self.assertEqual(1, len([p for p in data if p["flight"] == LogoPlacementChoices.SIDEBAR.value]))
         self.assertEqual(2, len([p for p in data if p["sponsor"] == self.sponsors[0].name]))
         self.assertEqual(1, len([p for p in data if p["sponsor"] == self.sponsors[1].name]))
+        self.assertEqual(1, len([p for p in data if p["sponsor"] == self.sponsors[2].name]))
+        self.assertEqual(
+            None,
+            [p for p in data if p["publisher"] == PublisherChoices.FOUNDATION.value][0]['sponsor_url']
+        )
+        self.assertEqual(
+            f"http://testserver/psf/sponsors/#{slugify(sp3.sponsor.name)}",
+            [p for p in data if p["publisher"] == PublisherChoices.PYPI.value][0]['sponsor_url']
+        )
+        self.assertCountEqual(
+            [sp1.sponsor.description, sp1.sponsor.description, sp2.sponsor.description],
+            [p['description'] for p in data if p["publisher"] == PublisherChoices.FOUNDATION.value]
+        )
+        self.assertEqual(
+            [f"{sp3.sponsor.name} is a {sp3.level_name} sponsor of the Python Software Foundation."],
+            [p['description'] for p in data if p["publisher"] == PublisherChoices.PYPI.value]
+        )
 
     def test_invalid_token(self):
         Token.objects.all().delete()

templates/sponsors/partials/sponsors-list.html

@@ -21,7 +21,7 @@ <h1 style="font-size: {% if forloop.first %}350%{% else %}300%{% endif %}">{{ pa
 
     <div style="display: grid; grid-gap: 2em; grid-template-columns: repeat(auto-fit, minmax({{ dimension }}px, 0fr)); grid-template-rows: repeat(1, minmax({{ dimension }}px, 0fr)); align-items: center; justify-content: center;">
       {% for sponsorship in placement_info.sponsorships %}
-      <div>
+      <div id={{ sponsorship.sponsor.name|slugify }}>
         <a href="{{ sponsorship.sponsor.landing_page_url }}">
          {% thumbnail sponsorship.sponsor.web_logo thumbnail_res format="PNG" quality=100 as im %}
              <img src="{{ im.url }}" alt="{{ sponsorship.sponsor.name }} logo" style="max-height:{{ im.height }}px;max-width:{{ im.width }}px;height:auto;width:auto;">