Mailchimp integration (#76)

coderedcms/api/mailchimp.py

@@ -0,0 +1,74 @@
+from wagtail.core.models import Site
+from coderedcms.models.wagtailsettings_models import MailchimpApiSettings
+
+import requests
+
+class MailchimpApi:
+    user_string = "Website"
+    proto_base_url = "https://{0}.api.mailchimp.com/3.0/"
+
+    def __init__(self, site=None):
+        self.set_access_token(site=None)
+
+    def set_access_token(self, site=None):
+        site = site or Site.objects.get(is_default_site=True)
+        self.access_token = MailchimpApiSettings.for_site(site).mailchimp_api_key
+        if self.access_token:
+            self.set_base_url()
+            self.is_active = True
+        else:
+            self.is_active = False
+
+    def set_base_url(self):
+        """
+        The base url for the mailchimip api is dependent on the api key.
+        """
+        key, datacenter = self.access_token.split('-')
+        self.base_url = self.proto_base_url.format(datacenter)
+
+    def default_headers(self):
+        return {
+            "Content-Type": "application/json",
+        }
+
+    def default_auth(self):
+        return (self.user_string, self.access_token)
+
+    def get_lists(self):
+        endpoint = "lists?fields=lists.name,lists.id"
+        json_response = self._get(endpoint)
+        return json_response
+
+    def get_merge_fields_for_list(self, list_id):
+        endpoint = "lists/{0}/merge-fields?fields=merge_fields.tag,merge_fields.merge_id,merge_fields.name".format(list_id)
+        json_response = self._get(endpoint)
+        return json_response
+
+    def get_interest_categories_for_list(self, list_id):
+        endpoint = "lists/{0}/interest-categories?fields=categories.id,categories.title".format(list_id)
+        json_response = self._get(endpoint)
+        return json_response
+
+    def get_interests_for_interest_category(self, list_id, interest_category_id):
+        endpoint = "lists/{0}/interest-categories/{1}/interests?fields=interests.id,interests.name".format(list_id, interest_category_id)
+        json_response = self._get(endpoint)
+        return json_response
+
+    def add_user_to_list(self, list_id, data):
+        endpoint = "lists/{0}".format(list_id)
+        json_response = self._post(endpoint, data=data)
+        return json_response
+
+    def _get(self, endpoint, data={}, auth=None, headers=None, **kwargs):
+        auth = auth or self.default_auth()
+        headers = headers or self.default_headers()
+        full_url = "{0}{1}".format(self.base_url, endpoint)
+        r = requests.get(full_url, auth=auth, headers=headers, data=data, **kwargs)
+        return r.json()
+
+    def _post(self, endpoint, data={}, auth=None, headers=None, **kwargs):
+        auth = auth or self.default_auth()
+        headers = headers or self.default_headers()
+        full_url = "{0}{1}".format(self.base_url, endpoint)
+        r = requests.post(full_url, auth=auth, headers=headers, data=data, **kwargs)
+        return r.json()

coderedcms/migrations/0006_mailchimpapisettings.py

@@ -0,0 +1,26 @@
+# Generated by Django 2.1.5 on 2019-01-08 19:41
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('wagtailcore', '0040_page_draft_title'),
+        ('coderedcms', '0005_auto_20181214_2214'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='MailchimpApiSettings',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('mailchimp_api_key', models.CharField(blank=True, help_text='The API Key used for Mailchimp.', max_length=255, verbose_name='Mailchimp API Key')),
+                ('site', models.OneToOneField(editable=False, on_delete=django.db.models.deletion.CASCADE, to='wagtailcore.Site')),
+            ],
+            options={
+                'verbose_name': 'Mailchimp API Settings',
+            },
+        ),
+    ]

coderedcms/migrations/0007_auto_20190114_1515.py

@@ -0,0 +1,21 @@
+# Generated by Django 2.1.5 on 2019-01-14 20:15
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('coderedcms', '0006_mailchimpapisettings'),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name='googleapisettings',
+            options={'verbose_name': 'Google API'},
+        ),
+        migrations.AlterModelOptions(
+            name='mailchimpapisettings',
+            options={'verbose_name': 'Mailchimp API'},
+        ),
+    ]

coderedcms/models/__init__.py

@@ -4,6 +4,7 @@ into files based on their purpose, but provide them all via
 a single `models` module.
 """
 
+from .integration_models import * #noqa
 from .page_models import * #noqa
 from .snippet_models import * #noqa
 from .wagtailsettings_models import * #noqa

coderedcms/models/integration_models.py

@@ -0,0 +1,162 @@
+from django.db import models
+from django.forms.widgets import Select, Input
+from django.template import Context, Template
+from django.template.loader import render_to_string
+from django.utils.translation import ugettext_lazy as _
+
+from wagtail.admin.edit_handlers import FieldPanel
+from wagtail.core import hooks
+from wagtail.core.models import Orderable, Page
+from modelcluster.fields import ParentalKey
+
+from coderedcms.api.mailchimp import MailchimpApi
+
+from ast import literal_eval
+import json
+
+
+class MailchimpSubscriberIntegrationWidget(Input):
+    template_name = 'coderedcms/formfields/mailchimp/subscriber_integration_widget.html'
+    js_template_name = 'coderedcms/formfields/mailchimp/subscriber_integration_js.html'
+
+    def get_context(self, name, value, attrs):
+        ctx = super(MailchimpSubscriberIntegrationWidget, self).get_context(name, value, attrs)
+
+        json_value = self.get_json_value(value)
+        list_library = self.build_list_library()
+        ctx['widget']['value'] = json.dumps(json_value)
+        ctx['widget']['extra_js'] = self.render_js(name, list_library, json_value)
+        ctx['widget']['selectable_mailchimp_lists'] = self.get_selectable_mailchimp_lists(list_library)
+        ctx['widget']['stored_mailchimp_list'] = self.get_stored_mailchimp_list(json_value)
+
+        return ctx
+
+    def render_js(self, name, list_library, json_value):
+        ctx = {
+            'widget_name': name,
+            'widget_js_name' : name.replace('-', '_'),
+            'list_library' : list_library,
+            'stored_mailchimp_list': self.get_stored_mailchimp_list(json_value),
+            'stored_merge_fields' : self.get_stored_merge_fields(json_value),
+        }
+
+        return render_to_string(self.js_template_name, ctx)
+
+
+    def get_json_value(self, value):
+        if value:
+            json_value = json.loads(value)
+        else:
+            json_value = json.loads('{}')
+        if 'list_id' not in json_value:
+            json_value['list_id'] = ""
+        if 'merge_fields' not in json_value:
+            json_value['merge_fields'] = {}
+        if 'email_field' not in json_value:
+            json_value['email_field'] = ""
+        if 'interest_categories' not in json_value:
+            json_value['interest_categories'] = {}
+        return json_value
+
+    def get_stored_mailchimp_list(self, value):
+        if 'list_id' in value:
+            return str(value['list_id'])
+
+    def get_stored_merge_fields(self, value):
+        if 'merge_fields' in value:
+            return json.dumps(value['merge_fields'])
+        return json.dumps({})
+
+    def get_selectable_mailchimp_lists(self, library):
+        selectable_lists = [('', 'Please select one of your Mailchimp Lists.')]
+        for k, v in library.items():
+            selectable_lists.append((k, v['name']))
+
+        return selectable_lists
+
+    def build_list_library(self):
+        mailchimp = MailchimpApi()
+        list_library = {}
+        if mailchimp.is_active:
+            lists = mailchimp.get_lists()
+            for l in lists['lists']:
+                list_library[l['id']] = {
+                    'name': l['name'],
+                    'merge_fields': {},
+                    'interest_categories': {}
+                }
+                
+                list_library[l['id']]['merge_fields'] = mailchimp.get_merge_fields_for_list(l['id'])['merge_fields']
+                list_library[l['id']]['interest_categories'] = mailchimp.get_interest_categories_for_list(l['id'])['categories']
+
+                for category in list_library[l['id']]['interest_categories']:
+                    category['interests'] = mailchimp.get_interests_for_interest_category(l['id'], category['id'])['interests']
+
+        return list_library
+
+class MailchimpSubscriberIntegration(models.Model):
+    class Meta:
+        abstract=True
+
+    subscriber_json_data = models.TextField(
+        blank=True,
+        verbose_name=_("List")
+    )
+
+    def integration_operation(self, instance, **kwargs):
+        mailchimp = MailchimpApi()
+        if mailchimp.is_active:
+            rendered_dictionary = self.render_dictionary(self.format_form_submission(kwargs['form_submission']))
+            mailchimp.add_user_to_list(list_id=self.get_list_id(), data=rendered_dictionary)
+
+    def format_form_submission(self, form_submission):
+        formatted_form_data = {}
+        for k, v in literal_eval(form_submission.form_data).items():
+            formatted_form_data[k.replace('-', '_')] = v
+        return formatted_form_data
+
+    def get_data(self):
+        return json.loads(self.subscriber_json_data)
+
+    def get_merge_fields(self):
+        if 'merge_fields' in self.get_data():
+            return self.get_data()['merge_fields']
+        return {}
+
+    def get_list_id(self):
+        if 'list_id' in self.get_data():
+            return self.get_data()['list_id']
+
+    def combine_interest_categories(self):
+        interest_dict = {}
+        for category_id, value in self.get_data()['interest_categories'].items():
+            interest_dict.update(value['interests'])
+
+        return interest_dict
+
+    def render_dictionary(self, form_submission):
+        rendered_dictionary_template = json.dumps({
+            'members': [
+                {
+                    'email_address': self.get_data()['email_field'],
+                    'merge_fields': self.get_data()['merge_fields'],
+                    'interests': self.combine_interest_categories(),
+                    'status': 'subscribed',
+                }
+            ]
+        })
+
+
+        rendered_dictionary = Template(rendered_dictionary_template).render(Context(form_submission))
+        return rendered_dictionary
+
+    panels = [
+        FieldPanel('subscriber_json_data', widget=MailchimpSubscriberIntegrationWidget)
+    ]
+
+@hooks.register('form_page_submit')
+def run_mailchimp_subscriber_integrations(instance, **kwargs):
+    if hasattr(instance, 'integration_panels'):
+        for panel in instance.integration_panels:
+            for integration in getattr(instance, panel.relation_name).all():
+                integration.integration_operation(instance, **kwargs)

coderedcms/models/page_models.py

@@ -37,6 +37,7 @@ from wagtail.admin.edit_handlers import (
     PageChooserPanel,
     StreamFieldPanel,
     TabbedInterface)
+from wagtail.core import hooks
 from wagtail.core.fields import StreamField
 from wagtail.core.models import Orderable, PageBase, Page, Site
 from wagtail.core.utils import resolve_model_string
@@ -402,6 +403,8 @@ class CoderedPage(Page, metaclass=CoderedPageMeta):
         StreamFieldPanel('content_walls'),
     ]
 
+    integration_panels = []
+
     def __init__(self, *args, **kwargs):
         """
         Inject custom choices and defalts into the form fields
@@ -420,17 +423,23 @@ class CoderedPage(Page, metaclass=CoderedPageMeta):
             self.index_order_by = self.index_order_by_default
             self.index_show_subpages = self.index_show_subpages_default
 
+
     @classmethod
     def get_edit_handler(cls):
         """
         Override to "lazy load" the panels overriden by subclasses.
         """
-        return TabbedInterface([
+        panels = [
             ObjectList(cls.content_panels + cls.body_content_panels + cls.bottom_content_panels, heading='Content'),
             ObjectList(cls.layout_panels, heading='Layout'),
             ObjectList(cls.promote_panels, heading='SEO', classname="seo"),
             ObjectList(cls.settings_panels, heading='Settings', classname="settings"),
-        ]).bind_to_model(cls)
+        ]
+
+        if cls.integration_panels:
+            panels.append(ObjectList(cls.integration_panels, heading='Integrations', classname='integrations'))
+
+        return TabbedInterface(panels).bind_to_model(cls)
 
     def get_struct_org_name(self):
         """
@@ -1050,6 +1059,7 @@ class CoderedFormPage(CoderedWebPage):
         )
     ]
 
+
     @property
     def form_live(self):
         """
@@ -1180,6 +1190,9 @@ class CoderedFormPage(CoderedWebPage):
                 message.content_subtype = 'html'
                 message.send()
 
+        for fn in hooks.get_hooks('form_page_submit'):
+            fn(instance=self, form_submission=form_submission)
+
         return processed_data
 
     def send_summary_mail(self, request, form, processed_data):

coderedcms/models/wagtailsettings_models.py

@@ -367,10 +367,10 @@ class SeoSettings(BaseSetting):
 @register_setting(icon='fa-puzzle-piece')
 class GoogleApiSettings(BaseSetting):
     """
-    Settings for Google API services..
+    Settings for Google API services.
     """
     class Meta:
-        verbose_name = _('Google API Settings')
+        verbose_name = _('Google API')
 
     google_maps_api_key = models.CharField(
         blank=True,
@@ -378,3 +378,19 @@ class GoogleApiSettings(BaseSetting):
         verbose_name=_('Google Maps API Key'),
         help_text=_('The API Key used for Google Maps.')
     )
+
+
+@register_setting(icon='fa-puzzle-piece')
+class MailchimpApiSettings(BaseSetting):
+    """
+    Settings for Mailchimp API services.
+    """
+    class Meta:
+        verbose_name = _('Mailchimp API')
+
+    mailchimp_api_key = models.CharField(
+        blank=True,
+        max_length=255,
+        verbose_name=_('Mailchimp API Key'),
+        help_text=_('The API Key used for Mailchimp.')
+    )

coderedcms/project_template/website/models.py

@@ -217,7 +217,8 @@ label {
 .tab-nav li.settings a {
     padding:0.5em 1.5em;
 }
-.tab-nav li.seo a::before {
+.tab-nav li.seo a::before, 
+.tab-nav li.integrations a::before {
     -webkit-font-smoothing: antialiased;
     -moz-osx-font-smoothing: grayscale;
     font-family: "FontAwesome";
@@ -229,6 +230,10 @@ label {
     font-weight: 400;
 }
 
+.tab-nav li.integrations a::before {
+    content: "\f12e";
+}
+
 .logo {
     margin: 0 auto;
     padding: 15px;

coderedcms/templates/coderedcms/formfields/mailchimp/subscriber_integration_js.html

@@ -0,0 +1,127 @@
+<script>
+    var mailchimp_master_library = {{ list_library|safe }};
+    $(document).ready(function(){
+        populate_fields_for_{{ widget_js_name }}("{{ stored_mailchimp_list }}");
+    });
+
+    function populate_fields_for_{{ widget_js_name }}(list_id_as_str){
+        populate_merge_fields_for_{{ widget_js_name }}(list_id_as_str);
+        populate_email_fields_for_{{ widget_js_name }}(list_id_as_str);
+        populate_interest_categories_for_{{ widget_js_name }}(list_id_as_str);
+    }
+
+    function populate_merge_fields_for_{{ widget_js_name }}(list_id_as_str){
+        var subscriber_data = get_subscriber_json_data_for_{{ widget_js_name }}();
+        var populated_merge_fields = [];
+        var merge_field_html = '';
+
+        if(list_id_as_str != ""){
+
+            if(mailchimp_master_library[list_id_as_str]['merge_fields'].length > 0){
+                merge_field_html = '<br /><div><strong>MERGE FIELDS</h3></div>';
+            }
+
+            for(var i=0; i < mailchimp_master_library[list_id_as_str]['merge_fields'].length; i++){
+                var merge_field = mailchimp_master_library[list_id_as_str]['merge_fields'][i];
+                merge_field_html += '<label style="float:left;">' + merge_field['name'] + '</label>';
+                if(subscriber_data['merge_fields'].hasOwnProperty(merge_field['tag'])){
+                    merge_field_html += '<div class="input"><input type="text" name="' + merge_field['tag'] + '"" value="' + subscriber_data['merge_fields'][merge_field['tag']] + '"></div>';
+                } else {
+                    merge_field_html += '<div class="input"><input type="text" name="' + merge_field['tag'] + '"" value=""></div>';                
+                }
+                merge_field_html += "<br />";
+            }
+        }
+
+        $("div[name='merge-fields-{{ widget_name }}']").html(merge_field_html);
+
+    }
+
+    function populate_email_fields_for_{{ widget_js_name }}(list_id_as_str){
+        var subscriber_data = get_subscriber_json_data_for_{{ widget_js_name }}(list_id_as_str);
+        $("input[name='email-{{ widget_name }}").val(subscriber_data['email_field']);
+    }
+
+    function populate_interest_categories_for_{{ widget_js_name }}(list_id_as_str){
+
+        function is_interest_checked(interest_category_library, interest_category_id, interest_id){
+            if(interest_category_library.hasOwnProperty(interest_category_id)){
+                if(interest_category_library[interest_category_id].hasOwnProperty('interests')){
+                    if(interest_category_library[interest_category_id]['interests'].hasOwnProperty(interest_id)){
+                        return interest_category_library[interest_category_id]['interests'][interest_id]
+                    }
+                } 
+            }
+            return false;
+        }
+        var subscriber_data = get_subscriber_json_data_for_{{ widget_js_name }}();
+        var interest_category_field_html = '';
+
+        if(list_id_as_str != ""){
+            if(mailchimp_master_library[list_id_as_str]['interest_categories'].length > 0){
+                interest_category_field_html += '<br /><div><strong>GROUPS</strong></div>';
+            }
+
+            for(var i in mailchimp_master_library[list_id_as_str]['interest_categories']){
+                var interest_category = mailchimp_master_library[list_id_as_str]['interest_categories'][i];
+                interest_category_field_html += '<br /><label style="float:left;">' + interest_category['title'] + '</label>';
+                for(var j in interest_category['interests']){
+                    var interest = interest_category['interests'][j];
+                    if(is_interest_checked(subscriber_data['interest_categories'], interest_category['id'], interest['id']) == true){
+                        interest_category_field_html += '<div class="input"><input type="checkbox" data-category-id="' + interest_category['id'] +'" name="' + interest['id'] + '" checked value="true">' + interest['name'] + '</span>';
+                    } else {
+                        interest_category_field_html += '<div class="input"><input type="checkbox" data-category-id="' + interest_category['id'] + '" name="' + interest['id'] + '" value="true"><span>' + interest['name'] + '</span>';
+                    }
+                    interest_category_field_html += '<br />'
+                }
+            }
+        }
+
+        $("div[name='interest-categories-{{ widget_name }}']").html(interest_category_field_html);
+    }
+
+    function get_subscriber_json_data_for_{{ widget_js_name }}(){
+        return JSON.parse($("input[name='{{ widget_name }}']").val());
+    }
+
+    function set_subscriber_json_data_for_{{ widget_js_name }}(json_data){
+        $("input[name='{{ widget_name }}']").val(JSON.stringify(json_data));
+    }
+
+    $("select[name='list-selection-{{ widget_name }}']").change(function(){
+        populate_fields_for_{{ widget_js_name }}($(this).val());
+    });
+
+    $("div[name='merge-fields-{{ widget_name }}']").on('input', 'input', function(){
+        var subscriber_data = get_subscriber_json_data_for_{{ widget_js_name }}();
+        subscriber_data['merge_fields'][$(this).attr('name')] = $(this).val();
+        set_subscriber_json_data_for_{{ widget_js_name }}(subscriber_data);
+    });
+
+    $("div[name='email-field-{{ widget_name }}']").on('input', 'input', function(){
+        var subscriber_data = get_subscriber_json_data_for_{{ widget_js_name }}();
+        subscriber_data['email_field'] = $(this).val();
+        set_subscriber_json_data_for_{{ widget_js_name }}(subscriber_data);
+    });
+
+    $("div[name='interest-categories-{{ widget_name }}']").on('change', 'input', function(){
+        var subscriber_data = get_subscriber_json_data_for_{{ widget_js_name }}();
+        var checked;
+        var category_id = $(this).data("category-id").toString();
+        var interest_id = $(this).attr("name").toString();
+
+        if($(this).is(':checked')){
+            checked = true;
+        } else {
+            checked = false;
+        }
+
+        if(!subscriber_data['interest_categories'].hasOwnProperty(category_id)){
+            subscriber_data['interest_categories'][category_id] = {};
+            subscriber_data['interest_categories'][category_id]['interests'] = {};
+        }
+
+        subscriber_data['interest_categories'][category_id]['interests'][interest_id] = checked;
+        set_subscriber_json_data_for_{{ widget_js_name }}(subscriber_data);
+    });
+</script>

coderedcms/templates/coderedcms/formfields/mailchimp/subscriber_integration_widget.html

@@ -0,0 +1,20 @@
+
+<input type="hidden" name="{{ widget.name }}"{% if widget.value != None %} value="{{ widget.value }}"{% endif %}{% include "django/forms/widgets/attrs.html" %}>
+<select name="list-selection-{{ widget.name }}">
+    {% for list_id, list_name in widget.selectable_mailchimp_lists %}
+        <option value="{{ list_id }}" {% if list_id == widget.stored_mailchimp_list %}selected{% endif %}>{{ list_name }}</option>
+    {% endfor %}
+</select>
+<div name="email-field-{{ widget.name }}">
+    <br />
+    <label style="float:left;">Email Address</label>
+    <div class="input">
+        <input type="text" name="email-{{ widget.name }}" value="" />
+    </div>
+</div>
+<div name="merge-fields-{{ widget.name }}"></div>
+<div name="interest-categories-{{widget.name}}"></div>
+
+
+
+{{ widget.extra_js|safe }}

coderedcms/templatetags/coderedcms_tags.py

@@ -6,4 +6,5 @@ Features
 
     events
     import_export
+    mailchimp
     store_locator

docs/features/mailchimp.rst

@@ -0,0 +1,59 @@
+Mailchimp Integration
+=====================
+
+Implementations of the abstract `CoderedFormPage` can add their form submissions to a Mailchimp list.
+When this functionality is enabled, you can map form submission variables to merge variables and add 
+form submissions to specific interest groups.
+
+Implementation
+~~~~~~~~~~~~~~
+
+By default, when you generate a website, you will get an implementation of `CoderedFormPage`.
+To get the functionality working, you need to do the following:
+
+- Implmenet the abstract `MailchimpSubscriberIntegration` class with a `ParentalKey` that points to your `FormPage`
+- Add an `integrations_panels` variable to `FormPage` that holds an `InlinePanel` for your implemented `MailchimpSubscriberIntegration` class
+
+Here is what the resulting code will look like in ``website/models.py``::
+
+    from modelcluster.fields import ParentalKey
+    from coderedcms.models import CoderedFormPage, MailchimpSubscriberIntegration
+    from wagtail.admin.edit_handlers import InlinePanel
+
+    class FormPageMailchimpSubscriberIntegration(MailchimpSubscriberIntegration):
+        page = ParentalKey('FormPage', related_name='mailchimp_subscriber_integrations', on_delete=models.CASCADE)
+
+
+    class FormPage(CoderedFormPage):
+        """
+        A page with an html <form>.
+        """
+        class Meta:
+            verbose_name = 'Form'
+
+        template = 'coderedcms/pages/form_page.html'
+
+        integration_panels = [
+            InlinePanel('mailchimp_subscriber_integrations',
+                heading="Mailchimp Subscriber Integrations",
+            )
+        ]
+
+
+Next run ``python manage.py makemigrations website`` and ``python manage.py migrate`` to
+make the changes to your project.  You will also need to add your api key to the Mailchimp API settings in the CMS.
+
+How to Use
+~~~~~~~~~~
+When you make or edit a `FormPage`, you will now see an "Integrations" tab.  Clicking the plus icon will instantiate an integration. 
+You can add as many of these integraitons objects as you need.  This is useful if you want to send a submission to more than one list.
+When you select a list, the instance will load in the merge variables and interest categories.  The interest categories are straightforward.
+You just select the interests you want the submission to have.
+
+The merge variables are a bit more complex.  They work similarly to the emails that are sent after a form submission.  
+You can decide what values from your form are put into which merge variables.  These values will get rendered by the Django renderer, as such
+they use the same syntax.  The context for the render will be your form submission fields.  For example, if you have fields named "Email Address",
+"First Name", "Phone", the context variables will be `email_address`, `first_name`, `phone`.  So if you have a merge variable, FIRSTNAME, you would want
+to input `{{ first_name }}` into that field.
+
+That's it.  Whenever a user fills out the form on the front end, they will be subscribed to your Mailchimp list with the merge fields and interest categories that you configure.