Feature/contact (#1)

* add contact funcionality

* update repo url

* rename template folder to app dir

* rename template folder to app dir

* ignore *.egg-info

* update setup.py, README and MANIFEST

* remove unused files

* cleanup forms and mixins and use bleach library

* add enquiry_email field to the ContentMixin

* add tests

* update app name in app config

* add a standalone test runner

* add more tests

Author: msomierick

.gitignore

@@ -0,0 +1,3 @@
+*.pyc
+*.egg-info
+__pycache__

MANIFEST.in

@@ -0,0 +1,3 @@
+include LICENSE
+include README.rst
+recursive-include wagtailcontact/templates *

README.md

@@ -0,0 +1,33 @@
+Provide a simple mixin which bakes a contact form(send emails on submit) into the inheriting classes, specifically Wagtail pages.
+
+The mixin is an abstract Django model which has an enquiry_email field.
+This field is also added to the content_panels.
+
+### Install
+`pip install https://github.com/regulusweb/wagtail-contact/archive/master.zip`
+
+Be sure to add `honeypot` and `wagtailcontact` to INSTALLED_APPS in settings.py.
+The contact form uses `django-honeypot` to prevent automated form spam.
+
+
+`django-honeypot` also requires a few settings to be declared in settings.py.
+See [django-honeypot](https://github.com/jamesturk/django-honeypot) for more information.
+
+
+### Usage
+The Wagtail page you want to add this functionality should extend
+`wagtailcontact.mixins.ContactMixin`.
+
+When rendering the form in your page template be sure to add the honeypot field using the
+`render_honeypot_field` tag. Otherwise a HTTP BadRequest will explode when you try to submit the form without this.
+
+Like so:
+
+`{% load honeypot %}`
+
+And then within the form include the honeypot field:
+
+`{% render_honeypot_field %}`
+
+### Tests
+You can either invoke `python runtests.py`, or `python setup.py test`

runtests.py

@@ -0,0 +1,20 @@
+#!/usr/bin/env python
+import os
+import sys
+
+import django
+from django.conf import settings
+from django.test.utils import get_runner
+
+
+def run_tests():
+    os.environ['DJANGO_SETTINGS_MODULE'] = 'tests.test_settings'
+    django.setup()
+    TestRunner = get_runner(settings)
+    test_runner = TestRunner()
+    failures = test_runner.run_tests(["tests"])
+    sys.exit(bool(failures))
+
+
+if __name__ == "__main__":
+    run_tests()

setup.py

@@ -0,0 +1,41 @@
+import os
+from setuptools import find_packages, setup
+
+with open(os.path.join(os.path.dirname(__file__), 'README.md')) as readme:
+    README = readme.read()
+
+# allow setup.py to be run from any path
+os.chdir(os.path.normpath(os.path.join(os.path.abspath(__file__), os.pardir)))
+
+setup(
+    name='wagtail-contact',
+    version='0.1',
+    packages=find_packages(),
+    test_suite='runtests.run_tests',
+    include_package_data=True,
+    license='MIT License',
+    description='A simple Wagtail contact app.',
+    long_description=README,
+    url='https://github.com/regulusweb/wagtail-contact',
+    author='Regulus Ltd',
+    author_email='info@regulusweb.com',
+    install_requires=[
+        'django-honeypot==0.6.0',
+        'bleach==2.0.0',
+        'wagtail>=1.12'
+    ],
+    classifiers=[
+        'Environment :: Web Environment',
+        'Framework :: Django',
+        'Framework :: Django :: 1.11',
+        'Intended Audience :: Developers',
+        'License :: OSI Approved :: MIT License',
+        'Operating System :: OS Independent',
+        'Programming Language :: Python',
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.5',
+        'Programming Language :: Python :: 3.6',
+        'Topic :: Internet :: WWW/HTTP',
+        'Topic :: Internet :: WWW/HTTP :: Dynamic Content',
+    ],
+)

tests/__init__.py

@@ -0,0 +1,64 @@
+from unittest.mock import Mock
+
+from django.core import mail
+from django.test import TestCase
+
+from wagtailcontact.forms import ContactForm
+
+
+class ContactFormTestCase(TestCase):
+
+    valid_data = {'name': 'test', 'email': 't@t.com', 'message': 'Hi'}
+
+    def test_required_fields(self):
+        form = ContactForm()
+        self.assertTrue(
+            all([
+                form.fields['email'].required,
+                form.fields['name'].required,
+                form.fields['message'].required
+            ])
+        )
+
+    def test_email_subject_prefix_added_to_ctx(self):
+        form = ContactForm(data=self.valid_data.copy())
+        form.is_valid()
+        ctx = form.get_email_context()
+        self.assertEqual(ctx['subject_prefix'], 'Admin')
+
+    def test_form_valid(self):
+        form = ContactForm(data=self.valid_data.copy())
+        self.assertTrue(form.is_valid())
+
+    def test_send_email(self):
+        data = self.valid_data.copy()
+        data['message'] = 'Hello good people'
+        form = ContactForm(data=data)
+        form.is_valid()  # trigger to populate cleaned_data
+        reply_to = [form.cleaned_data['email']]
+        form.send_email(['to@g.com'], form.subject_template, form.txt_template, reply_to)
+
+        self.assertEqual(len(mail.outbox), 1)
+        self.assertIn('Hello good people', mail.outbox[0].body)
+
+    def test_go_to_with_enquiryemail(self):
+        form = ContactForm()
+        page = Mock()
+        page.enquiry_email = 'e@e.com'
+        to = form.get_to(page)
+        self.assertEqual(to, ['e@e.com'])
+
+    def test_go_to_without_enquiryemail(self):
+        form = ContactForm()
+        page = Mock()
+        page.enquiry_email = ''
+        to = form.get_to(page)
+        self.assertEqual(to, ['admin@localhost.com'])
+
+    def test_save(self):
+        form = ContactForm()
+        form.cleaned_data = self.valid_data.copy()
+        page = Mock()
+        page.enquiry_email = 'e@e.com'
+        form.save(page)
+        self.assertEqual(len(mail.outbox), 1)

tests/test_forms.py

@@ -0,0 +1,38 @@
+import os
+
+BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+
+SECRET_KEY = 'secret'
+INSTALLED_APPS = [
+    "wagtailcontact",
+]
+
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.sqlite3',
+        'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
+    }
+}
+
+
+TEMPLATES = [
+    {
+        'BACKEND': 'django.template.backends.django.DjangoTemplates',
+        'DIRS': [],
+        'APP_DIRS': True,
+        'OPTIONS': {
+            'context_processors': [
+                'django.template.context_processors.debug',
+                'django.template.context_processors.request',
+                'django.contrib.auth.context_processors.auth',
+                'django.contrib.messages.context_processors.messages',
+            ],
+        },
+    },
+]
+
+MANAGERS = [
+    ('admin', 'admin@localhost.com')
+]
+
+EMAIL_SUBJECT_PREFIX = 'Admin'

tests/test_settings.py

@@ -0,0 +1,14 @@
+from django.test import TestCase
+
+from wagtailcontact.templatetags.wagtailcontact_tags import bleachclean
+
+
+class WagtailContactTagsTestCase(TestCase):
+
+    def test_bleanclean_cleandata(self):
+        cleaned = bleachclean('Hello')
+        self.assertEqual(cleaned, 'Hello')
+
+    def test_bleanclean_strips(self):
+        cleaned = bleachclean('<script>evil</script>')
+        self.assertEqual(cleaned, 'evil')

tests/test_tags.py

@@ -0,0 +1,5 @@
+from django.apps import AppConfig
+
+
+class ContactConfig(AppConfig):
+    name = 'wagtailcontact'

wagtailcontact/__init__.py

@@ -0,0 +1,48 @@
+from django import forms
+from django.conf import settings
+from django.core.mail import EmailMessage
+from django.template import loader
+
+
+class ContactForm(forms.Form):
+
+    subject_template = "wagtailcontact/email/subject.txt"
+    txt_template = "wagtailcontact/email/message.txt"
+
+    name = forms.CharField(max_length=100, required=True)
+    email = forms.EmailField(required=True)
+    message = forms.CharField(
+        widget=forms.Textarea(attrs={'rows': 4, 'cols': False}),
+        required=True,
+    )
+
+    def get_email_context(self):
+        ctx = self.cleaned_data
+        ctx['subject_prefix'] = settings.EMAIL_SUBJECT_PREFIX
+        return ctx
+
+    def send_email(self, to, subject_template, txt_template, reply_to):
+        context = self.get_email_context()
+        from_email = settings.DEFAULT_FROM_EMAIL
+        subject = loader.render_to_string(subject_template, context)
+        message = loader.render_to_string(txt_template, context)
+        msg = EmailMessage(
+            subject.strip(),
+            message,
+            from_email,
+            to,
+            reply_to=reply_to
+        )
+        msg.send()
+
+    def get_to(self, page):
+        if page.enquiry_email:
+            return [page.enquiry_email]
+        else:
+            return [e for _, e in settings.MANAGERS]
+
+    def save(self, page):
+        # Forward enquiry
+        to = self.get_to(page)
+        reply_to = [self.cleaned_data['email']]
+        self.send_email(to, self.subject_template, self.txt_template, reply_to)

wagtailcontact/apps.py

@@ -0,0 +1,58 @@
+from django.contrib import messages
+from django.db import models
+from django.http import HttpResponseRedirect
+from django.utils.decorators import method_decorator
+
+from honeypot.decorators import check_honeypot
+from wagtail.wagtailadmin.edit_handlers import FieldPanel
+from wagtail.wagtailcore.models import Page
+
+from .forms import ContactForm
+
+
+class ContactMixin(models.Model):
+    form_class = ContactForm
+    success_url = None
+    success_message = 'Thank you! We will get back to you as soon as possible.'
+
+    enquiry_email = models.EmailField(
+        blank=True,
+        help_text="Email address that will receive enquiries",
+        null=True,
+    )
+
+    content_panels = Page.content_panels + [
+        FieldPanel('enquiry_email'),
+    ]
+
+    class Meta:
+        abstract = True
+
+    def get_form(self, request):
+        return self.form_class(request.POST or None)
+
+    @method_decorator(check_honeypot)
+    def serve(self, request, *args, **kwargs):
+        self.form = self.get_form(request)
+        if request.method == 'POST':
+            if self.form.is_valid():
+                self.form.save(page=self)  # Save triggers an email
+                # Add a message to be displayed to the user
+                messages.add_message(
+                    request, messages.INFO,
+                    self.get_success_message())
+                # Redirect to the current page, to prevent resubmissions
+                return HttpResponseRedirect(self.get_success_url())
+
+        return super().serve(request, *args, **kwargs)
+
+    def get_context(self, request):
+        ctx = super().get_context(request)
+        ctx['form'] = self.form
+        return ctx
+
+    def get_success_url(self):
+        return self.success_url or self.url
+
+    def get_success_message(self):
+        return self.success_message

wagtailcontact/forms.py

@@ -0,0 +1,7 @@
+{% load wagtailcontact_tags %}
+
+{% autoescape off %}
+Enquiry from {{ name }} ({{ email }}):
+{% endautoescape %}
+
+{{ message|bleachclean }}

wagtailcontact/mixins.py

@@ -0,0 +1 @@
+{{ subject_prefix }}Enquiry from {{ name }}

wagtailcontact/templates/wagtailcontact/email/message.txt

@@ -0,0 +1,10 @@
+from django import template
+
+import bleach
+
+register = template.Library()
+
+
+@register.filter
+def bleachclean(value):
+    return bleach.clean(value, strip=True)