Merge pull request #1071 from torchbox/feature/register-your-interest

#7346 - WEB FORM | Register your interest - UK & IRE Data

Author: patrickcuagan

.isort.cfg

@@ -5,4 +5,4 @@ force_grid_wrap=0
 use_parentheses=True
 line_length=88
 
-known_third_party = bs4,captcha,dj_database_url,django,django_countries,factory,faker,freezegun,gunicorn,import_export,invoke,mailchimp_marketing,modelcluster,pattern_library,phonenumber_field,requests,rest_framework,taggit,wagtail,wagtail_factories,wagtailcaptcha,wagtailorderable
+known_third_party = bs4,captcha,dj_database_url,django,django_countries,factory,faker,freezegun,gunicorn,import_export,invoke,modelcluster,pattern_library,phonenumber_field,requests,rest_framework,taggit,wagtail,wagtail_factories,wagtailcaptcha,wagtailorderable

docs/integrations.md

@@ -1,55 +1,5 @@
 # Integrations
 
-## Mailchimp
-
-We make use of Mailchimp's API to subscribe people as members when they submit a sign up form (rca.enquire_to_study.views.EnquireToStudyFormView).
-
-There are two fields used to provide the enquire to study form with values we can use to better integrate with mailchimp, the `mailchimp_group_name` on programme pages and the `mailchimp_label` field within StartDate snippets.
-
-More details on the MailChimp client [here](https://github.com/mailchimp/mailchimp-marketing-python).
-
-### Developing
-
-If wanting to update the mailchimp integration, request access to the mailchimp account and ask which audience list to use. They have a `Test` list which may be worth using on staging, providing that the mailchimp sign up forms match the list you wish to use on production.
-
-#### API keys & IDs
-
-You can get the `MAILCHIMP_API_KEY` from their mailchimp account or from the heroku config.
-For info on finding the `MAILCHIMP_LIST_ID` read this [article](https://mailchimp.com/help/find-audience-id/).
-To get the `MAILCHIMP_PROGRAMMES_INTEREST_CATEGORY_ID` value which is used to map values from the `mailchimp_group_name` field to values within a mailchimp "group", you will have to use the snippet below as group ids are currently only available via the API.
-
-```python
-from mailchimp_marketing import Client
-mailchimp = Client()
-mailchimp.set_config(
-    {
-        "api_key": settings.MAILCHIMP_API_KEY,
-        "server": settings.MAILCHIMP_API_KEY.split("-")[-1],
-    }
-)
-mailchimp.get_list_interest_categories(MAILCHIMP_LIST_ID)
-```
-
-You're interested in the `id` value for which `title` matches the one in mailchimp i.e. 'Programme of interest'. Set `MAILCHIMP_PROGRAMMES_INTEREST_CATEGORY_ID` to this value (i.e. `0da07d9429`).
-
-Example response:
-
-```python
-'categories':
-    [
-        {
-            'list_id': '07bbaca3ef',
-            'id': '0da07d9429',
-            'title': 'Programme of interest',
-    ...
-```
-
-You an use the endpoint below to confirm the ID works.
-
-```python
-mailchimp.lists.list_interest_category_interests(settings.MAILCHIMP_LIST_ID, MAILCHIMP_PROGRAMMES_INTEREST_CATEGORY_ID)
-```
-
 ## Azure AD SSO
 
 To add SSO functionality, we used `social-auth-app-django`. All of the configurations and necessary keys can be seen in the `Azure AD (SSO)` and `Social Auth (SSO)` sections in the base settings. Logging in via SSO is optional. Users can still login via the standard Wagtail login form.

docs/support-runbook.md

@@ -32,11 +32,6 @@ The Azure environment is handled by RCA. If we need to update keys or redirect U
 
 ### 1. Check the data
 
-The enquire to study form has 2 integrations:
-
-1. Form data from user outside UK is sent to 'QS'
-2. Form data from user inside UK is sent to Mailchimp
-
 The programme values the user select on the form have 'qs_code` values in Wagtail. As do some of the taxonomies. These 'qs_codes' and to lookup data from the QS endpoint. Usually the form throws 500s if these values change on the QS side but aren't updated in Wagtail. You can view the QS endpoint and inspect what codes a course should have - the endpoint is set as an env var in heroku.
 
 If it turns out a programme/course has the wrong QS code, update it in wagtail with the right one from the endpoint.

mkdocs.yml

@@ -13,7 +13,6 @@ markdown_extensions:
 nav:
   - 'Home': 'index.md'
   - 'Front end tooling': 'front-end-tooling.md'
-  - 'Mailchimp integration': 'mailchimp-integration.md'
   - Implementation Specs:
       - 'Rebuild Approach': 'implementation-specs/finalised-rebuild-approach.md'
       - 'Programme Page': 'implementation-specs/programme-page.md'

poetry.lock

@@ -41,7 +41,6 @@ coverage = "^7.6.10"
 freezegun = "^1.5.1"
 html5lib = "^1.1"
 lxml = "^5.3.0"
-mailchimp-marketing = "^3.0.80"
 scout-apm = "~3.2"
 sentry-sdk = "^2.19.2"
 tblib = "^3.0.0"

pyproject.toml

@@ -0,0 +1,17 @@
+# Generated by Django 4.2.17 on 2025-03-05 10:21
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("enquire_to_study", "0014_enquiretostudysettings_intro_heading_and_more"),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name="startdate",
+            name="mailchimp_label",
+        ),
+    ]

rca/enquire_to_study/migrations/0015_remove_mailchimp_integration.py

@@ -38,15 +38,6 @@ class StartDate(models.Model):
         blank=True,
         null=True,
     )
-    mailchimp_label = models.CharField(
-        max_length=255,
-        help_text=(
-            "This value needs to match the options specified in the 'Intended year of study' "
-            "field within mailchimps sign-up form , E.G 2021/22"
-        ),
-        blank=True,
-        null=True,
-    )
 
     class Meta:
         verbose_name = "Enquiry form start date"

rca/enquire_to_study/models.py

@@ -1,4 +1,3 @@
-import json
 import logging
 from datetime import timedelta
 
@@ -14,10 +13,7 @@
 from django.utils.decorators import method_decorator
 from django.views.decorators.csrf import csrf_exempt
 from django.views.generic import FormView, TemplateView
-from django_countries import countries
 from django_countries.ioc_data import IOC_TO_ISO
-from mailchimp_marketing import Client
-from mailchimp_marketing.api_client import ApiClientError
 from wagtail.admin import messages
 
 from rca.utils.views import MetaTitleMixin
@@ -29,11 +25,7 @@
 
 
 class EnquireToStudyFormView(MetaTitleMixin, FormView):
-    """Custom form with integrations to Mailchimp and QS
-
-    On form submission, the post data is sent to different services depending
-    on the 'country_of_residence' value. For the moment only QS is receiving
-    post data, Mailchimp is incoming.
+    """Custom form with integrations to QS
 
     Keys can be seen here:
     https://qs-enrolment-solutions.screenstepslive.com/s/Help/m/enquiryapi/l/889815-application-endpoints#student-enquiry
@@ -76,102 +68,6 @@ class EnquireToStudyFormView(MetaTitleMixin, FormView):
     def dispatch(self, *args, **kwargs):
         return super().dispatch(*args, **kwargs)
 
-    def get_mailchimp_interests_and_map_to_programmes(self, mailchimp, programmes):
-        try:
-            response = mailchimp.lists.list_interest_category_interests(
-                settings.MAILCHIMP_LIST_ID,
-                settings.MAILCHIMP_PROGRAMMES_INTEREST_CATEGORY_ID,
-                count=500,
-            )
-            mailchimp_interest_ids = {}
-            mapped_user_interests = {}
-            try:
-                for interest in response["interests"]:
-                    mailchimp_interest_ids.update({interest["name"]: interest["id"]})
-            except ValueError:
-                return {}
-            for program in programmes:
-                if program.mailchimp_group_name:
-                    try:
-                        interest_id = mailchimp_interest_ids[
-                            program.mailchimp_group_name
-                        ]
-                        mapped_user_interests.update({interest_id: True})
-                    except KeyError:
-                        logger.warning(
-                            f"Mailchimp: Unable to map mailchimp_group_name for program page {program} - {program.id}"
-                        )
-                        pass
-            return mapped_user_interests
-        except ApiClientError as error:
-            logger.exception(error.text)
-            return {}
-
-    def post_mailchimp(self, form_data):
-        mailchimp = Client()
-        mailchimp.set_config(
-            {
-                "api_key": settings.MAILCHIMP_API_KEY,
-                "server": settings.MAILCHIMP_API_KEY.split("-")[-1],
-            }
-        )
-
-        interests = {}
-        if (
-            form_data["programmes"]
-            and settings.MAILCHIMP_PROGRAMMES_INTEREST_CATEGORY_ID
-        ):
-            interests = self.get_mailchimp_interests_and_map_to_programmes(
-                mailchimp, form_data["programmes"]
-            )
-        elif not settings.MAILCHIMP_PROGRAMMES_INTEREST_CATEGORY_ID:
-            logger.warning(
-                "Mailchimp: Set MAILCHIMP_PROGRAMMES_INTEREST_CATEGORY_ID to assign users to groups"
-            )
-
-        country = dict(countries)[form_data["country_of_residence"]]
-
-        member_info = {
-            "merge_fields": {
-                "FNAME": form_data["first_name"],
-                "LNAME": form_data["last_name"],
-                "PHONE": str(form_data["phone_number"]),
-                "MMERGE6": form_data["start_date"].mailchimp_label or "",
-                "MMERGE7": form_data["country_of_citizenship"],
-                "ADDRESS": {
-                    "addr1": "N/A",
-                    "addr2": "N/A",
-                    "city": form_data["city"],
-                    "state": "N/A",
-                    "zip": "N/A",
-                    "country": country,
-                },
-                "MMERGE8": form_data["country_of_residence"],
-                "MMERGE9": form_data["city"],
-                "MMERGE10": form_data["enquiry_reason"].reason,
-                "MMERGE11": form_data["enquiry_questions"],
-            },
-            "interests": interests,
-            "email_address": form_data["email"],
-            "status": "subscribed",
-        }
-
-        try:
-            return mailchimp.lists.add_list_member(
-                settings.MAILCHIMP_LIST_ID, member_info
-            )
-        except ApiClientError as error:
-            try:
-                error_json = json.loads(error.text)
-                if error_json["title"] and error_json["title"] == "Member Exists":
-                    logger.info("Mailchimp: User tried to re-register to signup form")
-                    return
-            except ValueError:
-                logger.warning("Mailchimp: failed to decode error message")
-                return
-            logger.exception(error.text)
-            return
-
     def get_qs_data(self, query):
         return requests.get(
             f"{settings.QS_API_ENDPOINT}/{query}",
@@ -307,9 +203,8 @@ def set_session_data(self, form_data, enquiry_submission):
 
     def form_valid(self, form):
         country_of_residence = form.cleaned_data["country_of_residence"]
-        if country_of_residence in ["GB", "IE"] and settings.MAILCHIMP_API_KEY:
-            self.post_mailchimp(form.cleaned_data)
-        elif settings.QS_API_PASSWORD:
+
+        if settings.QS_API_PASSWORD:
             self.post_qs(form.cleaned_data)
 
         enquiry_submission = form.save()

rca/enquire_to_study/views.py

@@ -0,0 +1,17 @@
+# Generated by Django 4.2.17 on 2025-03-05 10:21
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("programmes", "0095_remove_programme_type_field"),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name="programmepage",
+            name="mailchimp_group_name",
+        ),
+    ]