Add email dashboard

This allows admins to:

* Preview emails in the dashboard
* Send preview emails
* Save emails

Fixes #359

.vagrant

@@ -0,0 +1 @@
+{"active":{"default":"21412894-03d1-4be4-bf6d-d4eca2a5662f"}}

oscar/__init__.py

@@ -55,6 +55,7 @@ OSCAR_CORE_APPS = [
     'oscar.apps.dashboard.offers',
     'oscar.apps.dashboard.ranges',
     'oscar.apps.dashboard.vouchers',
+    'oscar.apps.dashboard.communications',
     # 3rd-party apps that oscar depends on
     'haystack',
     'treebeard',

oscar/apps/customer/abstract_models.py

@@ -34,27 +34,37 @@ class AbstractEmail(models.Model):
 
 
 class AbstractCommunicationEventType(models.Model):
+    """
+    A 'type' of communication.  Like a order confirmation email.
+    """
 
     # Code used for looking up this event programmatically.
     # eg. PASSWORD_RESET
     code = models.SlugField(_('Code'), max_length=128)
 
     # Name is the friendly description of an event for use in the admin
-    name = models.CharField(_('Name'), max_length=255)
+    name = models.CharField(
+        _('Name'), max_length=255,
+        help_text=_("This is just used for organisational purposes"))
 
     # We allow communication types to be categorised
     ORDER_RELATED = _('Order related')
     USER_RELATED = _('User related')
-    category = models.CharField(_('Category'), max_length=255, default=ORDER_RELATED)
+    category = models.CharField(_('Category'), max_length=255,
+                                default=ORDER_RELATED)
 
     # Template content for emails
-    email_subject_template = models.CharField(_('Email Subject Template'), max_length=255, blank=True)
-    email_body_template = models.TextField(_('Email Body Template'), blank=True, null=True)
-    email_body_html_template = models.TextField(_('Email Body HTML Temlate'), blank=True, null=True,
+    email_subject_template = models.CharField(
+        _('Email Subject Template'), max_length=255, blank=True, null=True)
+    email_body_template = models.TextField(
+        _('Email Body Template'), blank=True, null=True)
+    email_body_html_template = models.TextField(
+        _('Email Body HTML Template'), blank=True, null=True,
         help_text=_("HTML template"))
 
     # Template content for SMS messages
-    sms_template = models.CharField(_('SMS Template'), max_length=170, blank=True, help_text=_("SMS template"))
+    sms_template = models.CharField(_('SMS Template'), max_length=170,
+                                    blank=True, help_text=_("SMS template"))
 
     date_created = models.DateTimeField(_("Date Created"), auto_now_add=True)
     date_updated = models.DateTimeField(_("Date Updated"), auto_now=True)
@@ -69,8 +79,8 @@ class AbstractCommunicationEventType(models.Model):
 
     class Meta:
         abstract = True
-        verbose_name = _("Communication Event Type")
-        verbose_name_plural = _("Communication Event Types")
+        verbose_name = _("Communication event type")
+        verbose_name_plural = _("Communication event types")
 
     def get_messages(self, ctx=None):
         """
@@ -81,14 +91,14 @@ class AbstractCommunicationEventType(models.Model):
         """
         code = self.code.lower()
 
-        # Build a dict of message name to Template instance
+        # Build a dict of message name to Template instances
         templates = {'subject': 'email_subject_template',
                      'body': 'email_body_template',
                      'html': 'email_body_html_template',
                      'sms': 'sms_template'}
         for name, attr_name in templates.items():
             field = getattr(self, attr_name, None)
-            if field:
+            if field is not None:
                 # Template content is in a model field
                 templates[name] = Template(field)
             else:
@@ -99,10 +109,12 @@ class AbstractCommunicationEventType(models.Model):
                 except TemplateDoesNotExist:
                     templates[name] = None
 
+
         # Pass base URL for serving images within HTML emails
         if ctx is None:
             ctx = {}
-        ctx['static_base_url'] = getattr(settings, 'OSCAR_STATIC_BASE_URL', None)
+        ctx['static_base_url'] = getattr(settings,
+                                         'OSCAR_STATIC_BASE_URL', None)
 
         messages = {}
         for name, template in templates.items():

oscar/apps/customer/forms.py

@@ -2,6 +2,7 @@ import string
 import random
 
 from django.contrib.auth.forms import AuthenticationForm
+from django.core.urlresolvers import reverse
 from django.utils.translation import ugettext_lazy as _
 from django.core.exceptions import ObjectDoesNotExist
 from django import forms
@@ -34,7 +35,8 @@ def generate_username():
 class PasswordResetForm(auth_forms.PasswordResetForm):
     communication_type_code = "PASSWORD_RESET"
 
-    def save(self, subject_template_name='registration/password_reset_subject.txt',
+    def save(self, domain_override=None,
+             subject_template_name='registration/password_reset_subject.txt',
              email_template_name='registration/password_reset_email.html',
              use_https=False, token_generator=default_token_generator,
              from_email=None, request=None, **kwargs):
@@ -42,40 +44,23 @@ class PasswordResetForm(auth_forms.PasswordResetForm):
         Generates a one-use only link for resetting password and sends to the
         user.
         """
+        site = get_current_site(request)
+        if domain_override is not None:
+            site.domain = site.name = domain_override
         for user in self.users_cache:
-            current_site = get_current_site(request)
+            # Build reset url
+            reset_url = "%s://%s%s" % (
+                'https' if use_https else 'http',
+                site.domain,
+                reverse('password-reset-confirm', kwargs={
+                    'uidb36': int_to_base36(user.id),
+                    'token': token_generator.make_token(user)}))
             ctx = {
-                'email': user.email,
-                'domain': current_site.domain,
-                'site_name': current_site.name,
-                'uid': int_to_base36(user.id),
-                'token': token_generator.make_token(user),
-                'protocol': use_https and 'https' or 'http',
-                'site': current_site,
-            }
-            self.send_reset_email(user, ctx)
-
-    def send_reset_email(self, user, extra_context=None):
-        code = self.communication_type_code
-        ctx = {
-            'user': user,
-        }
-
-        if extra_context:
-            ctx.update(extra_context)
-
-        try:
-            event_type = CommunicationEventType.objects.get(code=code)
-        except CommunicationEventType.DoesNotExist:
-            # No event in database, attempt to find templates for this type
-            messages = CommunicationEventType.objects.get_and_render(code, ctx)
-        else:
-            # Create order event
-            messages = event_type.get_messages(ctx)
-
-        if messages and messages['body']:
-            dispatcher = Dispatcher()
-            dispatcher.dispatch_user_messages(user, messages)
+                'site': site,
+                'reset_url': reset_url}
+            messages = CommunicationEventType.objects.get_and_render(
+                code=self.communication_type_code, context=ctx)
+            Dispatcher().dispatch_user_messages(user, messages)
 
 
 class EmailAuthenticationForm(AuthenticationForm):

oscar/apps/customer/migrations/0004_auto__chg_field_communicationeventtype_email_subject_template.py

@@ -0,0 +1,218 @@
+# encoding: utf-8
+import datetime
+from south.db import db
+from south.v2 import SchemaMigration
+from django.db import models
+
+class Migration(SchemaMigration):
+
+    def forwards(self, orm):
+
+        # Changing field 'CommunicationEventType.email_subject_template'
+        db.alter_column('customer_communicationeventtype', 'email_subject_template', self.gf('django.db.models.fields.CharField')(max_length=255, null=True))
+
+
+    def backwards(self, orm):
+
+        # Changing field 'CommunicationEventType.email_subject_template'
+        db.alter_column('customer_communicationeventtype', 'email_subject_template', self.gf('django.db.models.fields.CharField')(default='', max_length=255))
+
+
+    models = {
+        'auth.group': {
+            'Meta': {'object_name': 'Group'},
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'name': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '80'}),
+            'permissions': ('django.db.models.fields.related.ManyToManyField', [], {'to': "orm['auth.Permission']", 'symmetrical': 'False', 'blank': 'True'})
+        },
+        'auth.permission': {
+            'Meta': {'ordering': "('content_type__app_label', 'content_type__model', 'codename')", 'unique_together': "(('content_type', 'codename'),)", 'object_name': 'Permission'},
+            'codename': ('django.db.models.fields.CharField', [], {'max_length': '100'}),
+            'content_type': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['contenttypes.ContentType']"}),
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'name': ('django.db.models.fields.CharField', [], {'max_length': '50'})
+        },
+        'auth.user': {
+            'Meta': {'object_name': 'User'},
+            'date_joined': ('django.db.models.fields.DateTimeField', [], {'default': 'datetime.datetime(2012, 10, 15, 17, 40, 13, 532212)'}),
+            'email': ('django.db.models.fields.EmailField', [], {'max_length': '75', 'blank': 'True'}),
+            'first_name': ('django.db.models.fields.CharField', [], {'max_length': '30', 'blank': 'True'}),
+            'groups': ('django.db.models.fields.related.ManyToManyField', [], {'to': "orm['auth.Group']", 'symmetrical': 'False', 'blank': 'True'}),
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'is_active': ('django.db.models.fields.BooleanField', [], {'default': 'True'}),
+            'is_staff': ('django.db.models.fields.BooleanField', [], {'default': 'False'}),
+            'is_superuser': ('django.db.models.fields.BooleanField', [], {'default': 'False'}),
+            'last_login': ('django.db.models.fields.DateTimeField', [], {'default': 'datetime.datetime(2012, 10, 15, 17, 40, 13, 532113)'}),
+            'last_name': ('django.db.models.fields.CharField', [], {'max_length': '30', 'blank': 'True'}),
+            'password': ('django.db.models.fields.CharField', [], {'max_length': '128'}),
+            'user_permissions': ('django.db.models.fields.related.ManyToManyField', [], {'to': "orm['auth.Permission']", 'symmetrical': 'False', 'blank': 'True'}),
+            'username': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '30'})
+        },
+        'catalogue.attributeentity': {
+            'Meta': {'object_name': 'AttributeEntity'},
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'name': ('django.db.models.fields.CharField', [], {'max_length': '255'}),
+            'slug': ('django.db.models.fields.SlugField', [], {'db_index': 'True', 'max_length': '255', 'blank': 'True'}),
+            'type': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'entities'", 'to': "orm['catalogue.AttributeEntityType']"})
+        },
+        'catalogue.attributeentitytype': {
+            'Meta': {'object_name': 'AttributeEntityType'},
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'name': ('django.db.models.fields.CharField', [], {'max_length': '255'}),
+            'slug': ('django.db.models.fields.SlugField', [], {'db_index': 'True', 'max_length': '255', 'blank': 'True'})
+        },
+        'catalogue.attributeoption': {
+            'Meta': {'object_name': 'AttributeOption'},
+            'group': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'options'", 'to': "orm['catalogue.AttributeOptionGroup']"}),
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'option': ('django.db.models.fields.CharField', [], {'max_length': '255'})
+        },
+        'catalogue.attributeoptiongroup': {
+            'Meta': {'object_name': 'AttributeOptionGroup'},
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'name': ('django.db.models.fields.CharField', [], {'max_length': '128'})
+        },
+        'catalogue.category': {
+            'Meta': {'ordering': "['full_name']", 'object_name': 'Category'},
+            'depth': ('django.db.models.fields.PositiveIntegerField', [], {}),
+            'description': ('django.db.models.fields.TextField', [], {'null': 'True', 'blank': 'True'}),
+            'full_name': ('django.db.models.fields.CharField', [], {'max_length': '1024', 'db_index': 'True'}),
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'image': ('django.db.models.fields.files.ImageField', [], {'max_length': '100', 'null': 'True', 'blank': 'True'}),
+            'name': ('django.db.models.fields.CharField', [], {'max_length': '255', 'db_index': 'True'}),
+            'numchild': ('django.db.models.fields.PositiveIntegerField', [], {'default': '0'}),
+            'path': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '255'}),
+            'slug': ('django.db.models.fields.SlugField', [], {'max_length': '1024', 'db_index': 'True'})
+        },
+        'catalogue.option': {
+            'Meta': {'object_name': 'Option'},
+            'code': ('django.db.models.fields.SlugField', [], {'unique': 'True', 'max_length': '128', 'db_index': 'True'}),
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'name': ('django.db.models.fields.CharField', [], {'max_length': '128'}),
+            'type': ('django.db.models.fields.CharField', [], {'default': "'Required'", 'max_length': '128'})
+        },
+        'catalogue.product': {
+            'Meta': {'ordering': "['-date_created']", 'object_name': 'Product'},
+            'attributes': ('django.db.models.fields.related.ManyToManyField', [], {'to': "orm['catalogue.ProductAttribute']", 'through': "orm['catalogue.ProductAttributeValue']", 'symmetrical': 'False'}),
+            'categories': ('django.db.models.fields.related.ManyToManyField', [], {'to': "orm['catalogue.Category']", 'through': "orm['catalogue.ProductCategory']", 'symmetrical': 'False'}),
+            'date_created': ('django.db.models.fields.DateTimeField', [], {'auto_now_add': 'True', 'blank': 'True'}),
+            'date_updated': ('django.db.models.fields.DateTimeField', [], {'auto_now': 'True', 'db_index': 'True', 'blank': 'True'}),
+            'description': ('django.db.models.fields.TextField', [], {'null': 'True', 'blank': 'True'}),
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'is_discountable': ('django.db.models.fields.BooleanField', [], {'default': 'True'}),
+            'parent': ('django.db.models.fields.related.ForeignKey', [], {'blank': 'True', 'related_name': "'variants'", 'null': 'True', 'to': "orm['catalogue.Product']"}),
+            'product_class': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['catalogue.ProductClass']", 'null': 'True'}),
+            'product_options': ('django.db.models.fields.related.ManyToManyField', [], {'to': "orm['catalogue.Option']", 'symmetrical': 'False', 'blank': 'True'}),
+            'recommended_products': ('django.db.models.fields.related.ManyToManyField', [], {'to': "orm['catalogue.Product']", 'symmetrical': 'False', 'through': "orm['catalogue.ProductRecommendation']", 'blank': 'True'}),
+            'related_products': ('django.db.models.fields.related.ManyToManyField', [], {'symmetrical': 'False', 'related_name': "'relations'", 'blank': 'True', 'to': "orm['catalogue.Product']"}),
+            'score': ('django.db.models.fields.FloatField', [], {'default': '0.0', 'db_index': 'True'}),
+            'slug': ('django.db.models.fields.SlugField', [], {'max_length': '255', 'db_index': 'True'}),
+            'status': ('django.db.models.fields.CharField', [], {'db_index': 'True', 'max_length': '128', 'null': 'True', 'blank': 'True'}),
+            'title': ('django.db.models.fields.CharField', [], {'max_length': '255', 'null': 'True', 'blank': 'True'}),
+            'upc': ('django.db.models.fields.CharField', [], {'max_length': '64', 'unique': 'True', 'null': 'True', 'blank': 'True'})
+        },
+        'catalogue.productattribute': {
+            'Meta': {'ordering': "['code']", 'object_name': 'ProductAttribute'},
+            'code': ('django.db.models.fields.SlugField', [], {'max_length': '128', 'db_index': 'True'}),
+            'entity_type': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['catalogue.AttributeEntityType']", 'null': 'True', 'blank': 'True'}),
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'name': ('django.db.models.fields.CharField', [], {'max_length': '128'}),
+            'option_group': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['catalogue.AttributeOptionGroup']", 'null': 'True', 'blank': 'True'}),
+            'product_class': ('django.db.models.fields.related.ForeignKey', [], {'blank': 'True', 'related_name': "'attributes'", 'null': 'True', 'to': "orm['catalogue.ProductClass']"}),
+            'required': ('django.db.models.fields.BooleanField', [], {'default': 'False'}),
+            'type': ('django.db.models.fields.CharField', [], {'default': "'text'", 'max_length': '20'})
+        },
+        'catalogue.productattributevalue': {
+            'Meta': {'object_name': 'ProductAttributeValue'},
+            'attribute': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['catalogue.ProductAttribute']"}),
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'product': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'attribute_values'", 'to': "orm['catalogue.Product']"}),
+            'value_boolean': ('django.db.models.fields.BooleanField', [], {'default': 'False'}),
+            'value_date': ('django.db.models.fields.DateField', [], {'null': 'True', 'blank': 'True'}),
+            'value_entity': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['catalogue.AttributeEntity']", 'null': 'True', 'blank': 'True'}),
+            'value_float': ('django.db.models.fields.FloatField', [], {'null': 'True', 'blank': 'True'}),
+            'value_integer': ('django.db.models.fields.IntegerField', [], {'null': 'True', 'blank': 'True'}),
+            'value_option': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['catalogue.AttributeOption']", 'null': 'True', 'blank': 'True'}),
+            'value_richtext': ('django.db.models.fields.TextField', [], {'null': 'True', 'blank': 'True'}),
+            'value_text': ('django.db.models.fields.CharField', [], {'max_length': '255', 'null': 'True', 'blank': 'True'})
+        },
+        'catalogue.productcategory': {
+            'Meta': {'ordering': "['-is_canonical']", 'object_name': 'ProductCategory'},
+            'category': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['catalogue.Category']"}),
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'is_canonical': ('django.db.models.fields.BooleanField', [], {'default': 'False', 'db_index': 'True'}),
+            'product': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['catalogue.Product']"})
+        },
+        'catalogue.productclass': {
+            'Meta': {'ordering': "['name']", 'object_name': 'ProductClass'},
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'name': ('django.db.models.fields.CharField', [], {'max_length': '128'}),
+            'options': ('django.db.models.fields.related.ManyToManyField', [], {'to': "orm['catalogue.Option']", 'symmetrical': 'False', 'blank': 'True'}),
+            'requires_shipping': ('django.db.models.fields.BooleanField', [], {'default': 'True'}),
+            'slug': ('django.db.models.fields.SlugField', [], {'unique': 'True', 'max_length': '128', 'db_index': 'True'}),
+            'track_stock': ('django.db.models.fields.BooleanField', [], {'default': 'True'})
+        },
+        'catalogue.productrecommendation': {
+            'Meta': {'object_name': 'ProductRecommendation'},
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'primary': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'primary_recommendations'", 'to': "orm['catalogue.Product']"}),
+            'ranking': ('django.db.models.fields.PositiveSmallIntegerField', [], {'default': '0'}),
+            'recommendation': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['catalogue.Product']"})
+        },
+        'contenttypes.contenttype': {
+            'Meta': {'ordering': "('name',)", 'unique_together': "(('app_label', 'model'),)", 'object_name': 'ContentType', 'db_table': "'django_content_type'"},
+            'app_label': ('django.db.models.fields.CharField', [], {'max_length': '100'}),
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'model': ('django.db.models.fields.CharField', [], {'max_length': '100'}),
+            'name': ('django.db.models.fields.CharField', [], {'max_length': '100'})
+        },
+        'customer.communicationeventtype': {
+            'Meta': {'object_name': 'CommunicationEventType'},
+            'category': ('django.db.models.fields.CharField', [], {'default': "u'Order related'", 'max_length': '255'}),
+            'code': ('django.db.models.fields.SlugField', [], {'max_length': '128', 'db_index': 'True'}),
+            'date_created': ('django.db.models.fields.DateTimeField', [], {'auto_now_add': 'True', 'blank': 'True'}),
+            'date_updated': ('django.db.models.fields.DateTimeField', [], {'auto_now': 'True', 'blank': 'True'}),
+            'email_body_html_template': ('django.db.models.fields.TextField', [], {'null': 'True', 'blank': 'True'}),
+            'email_body_template': ('django.db.models.fields.TextField', [], {'null': 'True', 'blank': 'True'}),
+            'email_subject_template': ('django.db.models.fields.CharField', [], {'max_length': '255', 'null': 'True', 'blank': 'True'}),
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'name': ('django.db.models.fields.CharField', [], {'max_length': '255'}),
+            'sms_template': ('django.db.models.fields.CharField', [], {'max_length': '170', 'blank': 'True'})
+        },
+        'customer.email': {
+            'Meta': {'object_name': 'Email'},
+            'body_html': ('django.db.models.fields.TextField', [], {'null': 'True', 'blank': 'True'}),
+            'body_text': ('django.db.models.fields.TextField', [], {}),
+            'date_sent': ('django.db.models.fields.DateTimeField', [], {'auto_now_add': 'True', 'blank': 'True'}),
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'subject': ('django.db.models.fields.TextField', [], {'max_length': '255'}),
+            'user': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'emails'", 'to': "orm['auth.User']"})
+        },
+        'customer.notification': {
+            'Meta': {'ordering': "('-date_sent',)", 'object_name': 'Notification'},
+            'body': ('django.db.models.fields.TextField', [], {}),
+            'category': ('django.db.models.fields.CharField', [], {'max_length': '255', 'null': 'True'}),
+            'date_read': ('django.db.models.fields.DateTimeField', [], {'null': 'True'}),
+            'date_sent': ('django.db.models.fields.DateTimeField', [], {'auto_now_add': 'True', 'blank': 'True'}),
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'location': ('django.db.models.fields.CharField', [], {'default': "'Inbox'", 'max_length': '32'}),
+            'recipient': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'notifications'", 'to': "orm['auth.User']"}),
+            'sender': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['auth.User']", 'null': 'True'}),
+            'subject': ('django.db.models.fields.CharField', [], {'max_length': '255'})
+        },
+        'customer.productalert': {
+            'Meta': {'object_name': 'ProductAlert'},
+            'date_cancelled': ('django.db.models.fields.DateTimeField', [], {'null': 'True', 'blank': 'True'}),
+            'date_closed': ('django.db.models.fields.DateTimeField', [], {'null': 'True', 'blank': 'True'}),
+            'date_confirmed': ('django.db.models.fields.DateTimeField', [], {'null': 'True', 'blank': 'True'}),
+            'date_created': ('django.db.models.fields.DateTimeField', [], {'auto_now_add': 'True', 'blank': 'True'}),
+            'email': ('django.db.models.fields.EmailField', [], {'db_index': 'True', 'max_length': '75', 'null': 'True', 'blank': 'True'}),
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'key': ('django.db.models.fields.CharField', [], {'max_length': '128', 'null': 'True', 'db_index': 'True'}),
+            'product': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['catalogue.Product']"}),
+            'status': ('django.db.models.fields.CharField', [], {'default': "'Active'", 'max_length': '20'}),
+            'user': ('django.db.models.fields.related.ForeignKey', [], {'blank': 'True', 'related_name': "'alerts'", 'null': 'True', 'to': "orm['auth.User']"})
+        }
+    }
+
+    complete_apps = ['customer']

oscar/apps/customer/views.py

@@ -185,18 +185,10 @@ class AccountRegistrationView(TemplateView):
         code = self.communication_type_code
         ctx = {'user': user,
                'site': get_current_site(self.request)}
-        try:
-            event_type = CommunicationEventType.objects.get(code=code)
-        except CommunicationEventType.DoesNotExist:
-            # No event in database, attempt to find templates for this type
-            messages = CommunicationEventType.objects.get_and_render(code, ctx)
-        else:
-            # Create order event
-            messages = event_type.get_messages(ctx)
-
+        messages = CommunicationEventType.objects.get_and_render(
+            code, ctx)
         if messages and messages['body']:
-            dispatcher = Dispatcher()
-            dispatcher.dispatch_user_messages(user, messages)
+            Dispatcher().dispatch_user_messages(user, messages)
 
     def get(self, request, *args, **kwargs):
         context = self.get_context_data(*args, **kwargs)

oscar/apps/dashboard/app.py

@@ -12,6 +12,7 @@ from oscar.apps.dashboard.offers.app import application as offers_app
 from oscar.apps.dashboard.ranges.app import application as ranges_app
 from oscar.apps.dashboard.reviews.app import application as reviews_app
 from oscar.apps.dashboard.vouchers.app import application as vouchers_app
+from oscar.apps.dashboard.communications.app import application as comms_app
 from oscar.apps.dashboard import views
 
 
@@ -29,6 +30,7 @@ class DashboardApplication(Application):
     ranges_app = ranges_app
     reviews_app = reviews_app
     vouchers_app = vouchers_app
+    comms_app = comms_app
 
     def get_urls(self):
         urlpatterns = patterns('',
@@ -43,6 +45,7 @@ class DashboardApplication(Application):
             url(r'^ranges/', include(self.ranges_app.urls)),
             url(r'^reviews/', include(self.reviews_app.urls)),
             url(r'^vouchers/', include(self.vouchers_app.urls)),
+            url(r'^comms/', include(self.comms_app.urls)),
         )
         return self.post_process_urls(urlpatterns)
 

oscar/apps/dashboard/communications/app.py

@@ -0,0 +1,31 @@
+from django.conf.urls import patterns, url
+from django.utils.translation import ugettext_lazy as _
+from django.contrib.admin.views.decorators import staff_member_required
+
+from oscar.core.application import Application
+from oscar.apps.dashboard.communications import views
+from oscar.apps.dashboard.nav import register, Node
+
+node = Node(_('Communications'))
+node.add_child(Node(_('Emails'), 'dashboard:comms-list'))
+register(node, 35)
+
+
+class CommsDashboardApplication(Application):
+    name = None
+    list_view = views.ListView
+    update_view = views.UpdateView
+
+    def get_urls(self):
+        urlpatterns = patterns('',
+            url(r'^$', self.list_view.as_view(), name='comms-list'),
+            url(r'^(?P<code>\w+)/$', self.update_view.as_view(),
+                name='comms-update'),
+        )
+        return self.post_process_urls(urlpatterns)
+
+    def get_url_decorator(self, url_name):
+        return staff_member_required
+
+
+application = CommsDashboardApplication()

oscar/apps/dashboard/communications/forms.py

@@ -0,0 +1,86 @@
+from django import forms
+from django.db.models import get_model
+from django.template import Template, TemplateSyntaxError
+from django.utils.translation import ugettext_lazy as _
+
+from oscar.forms import widgets
+
+CommunicationEventType = get_model('customer', 'CommunicationEventType')
+Order = get_model('order', 'Order')
+
+
+class CommunicationEventTypeForm(forms.ModelForm):
+    email_subject_template = forms.CharField(
+        label=_("Email subject template"))
+    email_body_template = forms.CharField(
+        label=_("Email body text template"), required=True,
+        widget=forms.widgets.Textarea(attrs={'class': 'plain'}))
+    email_body_html_template = forms.CharField(
+        label=_("Email body HTML template"), required=True,
+        widget=widgets.WYSIWYGTextArea)
+
+    preview_order_number = forms.CharField(
+        label=_("Order number"), required=False)
+    preview_email = forms.EmailField(label=_("Preview email"),
+                                     required=False)
+
+    def __init__(self, data=None, *args, **kwargs):
+        self.show_preview = False
+        self.send_preview = False
+        if data:
+            self.show_preview = 'show_preview' in data
+            self.send_preview = 'send_preview' in data
+        super(CommunicationEventTypeForm, self).__init__(data, *args, **kwargs)
+
+    def validate_template(self, value):
+        try:
+            Template(value)
+        except TemplateSyntaxError, e:
+            raise forms.ValidationError(e.message)
+
+    def clean_email_subject_template(self):
+        subject = self.cleaned_data['email_subject_template']
+        self.validate_template(subject)
+        return subject
+
+    def clean_email_body_template(self):
+        body = self.cleaned_data['email_body_template']
+        self.validate_template(body)
+        return body
+
+    def clean_email_body_html_template(self):
+        body = self.cleaned_data['email_body_html_template']
+        self.validate_template(body)
+        return body
+
+    def clean_preview_order_number(self):
+        number = self.cleaned_data['preview_order_number'].strip()
+        if not self.instance.is_order_related():
+            return number
+        if not self.show_preview and not self.send_preview:
+            return number
+        try:
+            self.preview_order = Order.objects.get(number=number)
+        except Order.DoesNotExist:
+            raise forms.ValidationError(_(
+                "No order found with this number"))
+        return number
+
+    def clean_preview_email(self):
+        email = self.cleaned_data['preview_email'].strip()
+        if not self.send_preview:
+            return email
+        if not email:
+            raise forms.ValidationError(_(
+                "Please enter an email address"))
+        return email
+
+    def get_preview_context(self):
+        ctx = {}
+        if hasattr(self, 'preview_order'):
+            ctx['order'] = self.preview_order
+        return ctx
+
+    class Meta:
+        model = CommunicationEventType
+        exclude = ('code', 'category', 'sms_template')

oscar/apps/dashboard/communications/views.py

@@ -0,0 +1,89 @@
+from django.conf import settings
+from django.contrib import messages
+from django.contrib.sites.models import get_current_site
+from django.db.models import get_model
+from django.shortcuts import get_object_or_404
+from django.template import TemplateSyntaxError
+from django.utils.translation import ugettext_lazy as _
+from django.views import generic
+
+from oscar.core.loading import get_class
+
+CommunicationEventType = get_model('customer', 'CommunicationEventType')
+CommunicationEventTypeForm = get_class('dashboard.communications.forms',
+                                       'CommunicationEventTypeForm')
+Dispatcher = get_class('customer.utils', 'Dispatcher')
+
+
+class ListView(generic.ListView):
+    model = CommunicationEventType
+    template_name = 'dashboard/comms/list.html'
+    context_object_name = 'commtypes'
+
+
+class UpdateView(generic.UpdateView):
+    model = CommunicationEventType
+    form_class = CommunicationEventTypeForm
+    template_name = 'dashboard/comms/detail.html'
+    context_object_name = 'commtype'
+    success_url = '.'
+
+    def get_object(self, **kwargs):
+        return get_object_or_404(self.model,
+                                 code=self.kwargs['code'].upper())
+
+    def form_invalid(self, form):
+        messages.error(self.request,
+            _("The submitted form was not valid, please correct "
+              "the errors and resubmit"))
+        return super(UpdateView, self).form_invalid(form)
+
+    def form_valid(self, form):
+        if 'send_preview' in self.request.POST:
+            return self.send_preview(form)
+        if 'show_preview' in self.request.POST:
+            return self.show_preview(form)
+        messages.success(self.request, _("Email saved"))
+        return super(UpdateView, self).form_valid(form)
+
+    def get_messages_context(self, form):
+        ctx = {'user': self.request.user,
+               'site': get_current_site(self.request)}
+        ctx.update(form.get_preview_context())
+        return ctx
+
+    def show_preview(self, form):
+        ctx = super(UpdateView, self).get_context_data()
+        ctx['form'] = form
+
+        commtype = form.save(commit=False)
+        commtype_ctx = self.get_messages_context(form)
+        try:
+            msgs = commtype.get_messages(commtype_ctx)
+        except TemplateSyntaxError, e:
+            form.errors['__all__'] = form.error_class([e.message])
+            return self.render_to_response(ctx)
+
+        ctx['show_preview'] = True
+        ctx['preview'] = msgs
+        return self.render_to_response(ctx)
+
+    def send_preview(self, form):
+        ctx = super(UpdateView, self).get_context_data()
+        ctx['form'] = form
+
+        commtype = form.save(commit=False)
+        commtype_ctx = self.get_messages_context(form)
+        try:
+            msgs = commtype.get_messages(commtype_ctx)
+        except TemplateSyntaxError, e:
+            form.errors['__all__'] = form.error_class([e.message])
+            return self.render_to_response(ctx)
+
+        email = form.cleaned_data['preview_email']
+        dispatch = Dispatcher()
+        dispatch.send_email_messages(email, msgs)
+        messages.success(self.request,
+                         _("A preview email has been sent to %s") % email)
+
+        return self.render_to_response(ctx)

oscar/forms/widgets.py

@@ -1,4 +1,5 @@
 from django.conf import settings
+from django import forms
 from django.template import Context
 from django.forms.widgets import FileInput
 from django.utils.encoding import force_unicode
@@ -43,3 +44,12 @@ class ImageInput(FileInput):
             'image_url': image_url,
             'image_id': "%s-image" % final_attrs['id'],
         }))
+
+
+class WYSIWYGTextArea(forms.Textarea):
+
+    def __init__(self, *args, **kwargs):
+        kwargs.setdefault('attrs', {})
+        kwargs['attrs'].setdefault('class', '')
+        kwargs['attrs']['class'] += ' wysiwyg'
+        super(WYSIWYGTextArea, self).__init__(*args, **kwargs)

oscar/static/oscar/js/oscar/dashboard.js

@@ -21,7 +21,7 @@ oscar.dashboard = {
         var options = {
             "html": true
         };
-        $('form.wysiwyg textarea').wysihtml5(options);
+        $('form.wysiwyg textarea, textarea.wysiwyg').wysihtml5(options);
 
         $('.scroll-pane').jScrollPane();
 

oscar/static/oscar/less/dashboard.less

@@ -635,6 +635,7 @@ caption {
  .jspVerticalBar .jspArrow:focus{outline:0}
  .jspCorner{background:#eeeef4;float:left;height:100%}
  * html .jspCorner{margin:0 -3px 0 0}
+
 /* Changes for wysihtml5 */
 textarea {
 	width: 500px;
@@ -653,3 +654,7 @@ textarea {
 .wysihtml5-toolbar {
   .clearfix();
 }
+
+textarea.plain {
+	font-family: monospace;
+}

oscar/templates/oscar/customer/emails/commtype_order_placed_subject.txt

@@ -1 +1 @@
-{% load i18n %}{% blocktrans %}Confirmation of order {{ order.number }}{% endblocktrans %}
+{% load i18n %}{% blocktrans with number=order.number %}Confirmation of order {{ number }}{% endblocktrans %}

oscar/templates/oscar/customer/emails/commtype_password_reset_body.html

@@ -1,13 +1,12 @@
 {% load i18n %}{% load url from future %}{% autoescape off %}
-{% blocktrans %}You're receiving this e-mail because you requested a password reset for your user account at {{ site_name }}.{% endblocktrans %}
+<p>
+	{% blocktrans with name=site.name %}You're receiving this e-mail because you requested a password reset for your user account at {{ name }}.{% endblocktrans %}
+</p>
 
-{% trans "Please go to the following page and choose a new password:" %}
-{% block reset_link %}
-{{ protocol }}://{{ domain }}{% url 'django.contrib.auth.views.password_reset_confirm' uidb36=uid token=token %}
-{% endblock %}
+<p>{% trans "Please go to the following page and choose a new password:" %}</p>
+{{ reset_url }}
 
-{% trans "Thanks for using our site!" %}
-
-{% blocktrans %}The {{ site_name }} team{% endblocktrans %}
+<p>{% trans "Thanks for using our site!" %}</p>
+<p>{% blocktrans with name=site.name %}The {{ name }} team{% endblocktrans %}</p>
 
 {% endautoescape %}

oscar/templates/oscar/customer/emails/commtype_password_reset_body.txt

@@ -1,13 +1,10 @@
 {% load i18n %}{% load url from future %}{% autoescape off %}
-{% blocktrans %}You're receiving this e-mail because you requested a password reset for your user account at {{ site_name }}.{% endblocktrans %}
+{% blocktrans with name=site.name %}You're receiving this e-mail because you requested a password reset for your user account at {{ name }}.{% endblocktrans %}
 
 {% trans "Please go to the following page and choose a new password:" %}
-{% block reset_link %}
-{{ protocol }}://{{ domain }}{% url 'django.contrib.auth.views.password_reset_confirm' uidb36=uid token=token %}
-{% endblock %}
+{{ reset_url }}
 
 {% trans "Thanks for using our site!" %}
-
-{% blocktrans %}The {{ site_name }} team{% endblocktrans %}
+{% blocktrans with name=site.name %}The {{ name }} team{% endblocktrans %}
 
 {% endautoescape %}

oscar/templates/oscar/customer/emails/commtype_registration_body.html

@@ -1 +1 @@
-{% load i18n %}{% trans 'Thank you for registering.' %}
+{% load i18n %}<p>{% trans 'Thank you for registering.' %}</p>

oscar/templates/oscar/dashboard/comms/detail.html

@@ -0,0 +1,96 @@
+{% extends 'dashboard/layout.html' %}
+{% load i18n %}
+
+{% block title %}
+{{ commtype.name }} | {{ block.super }}
+{% endblock %}
+
+{% block breadcrumbs %}
+<ul class="breadcrumb">
+    <li>
+        <a href="{% url dashboard:index %}">{% trans "Dashboard" %}</a>
+        <span class="divider">/</span>
+    </li>
+    <li>
+        <a href="{% url dashboard:comms-list %}">{% trans "Emails" %}</a>
+        <span class="divider">/</span>
+    </li>
+    <li class="active"><a href=".">{{ commtype.name }}</a></li>
+</ul>
+{% endblock %}
+
+{% block dashboard_content %}
+
+<div class="sub-header">
+    <h2>{{ commtype.name }}</h2>
+</div>
+
+<form method="post" action="." class="form-horizontal">
+<div class="tabbable">
+     {% if preview %}
+     <ul class="nav nav-tabs">
+         <li><a href="#email_form" data-toggle="tab">{% trans "Edit" %}</a></li>
+         <li class="active"><a href="#email_preview" data-toggle="tab">{% trans "Preview" %}</a></li>
+     </ul>
+     {% endif %}
+     <div class="tab-content">
+         <div class="tab-pane {% if not preview %}active{% endif %}" id="email_form">
+             {% csrf_token %}
+             {% include 'partials/form_field.html' with field=form.name %}
+             <div class="well">
+				 <h4>{% trans "Email content" %}</h4>
+				 <p>{% trans "These fields are rendered using Django's template system." %}</p>
+				 <p>{% trans "You can use the following variables:" %}</p>
+                 <dl>
+                     <dt><code>{% templatetag openvariable %} user.get_full_name {% templatetag closevariable %}</code></dt>
+					 <dd>{% trans "The full name of the user (if they have one)" %}</dd>
+                     <dt><code>{% templatetag openvariable %} user.email {% templatetag closevariable %}</code></dt>
+					 <dd>{% trans "The user's email address" %}</dd>
+                     <dt><code>{% templatetag openvariable %} site.name {% templatetag closevariable %}</code></dt>
+					 <dd>{% trans "The name of the site (eg example.com)" %}</dd>
+                     {% if commtype.is_order_related %}
+                        <dt><code>{% templatetag openvariable %} order.number {% templatetag closevariable %}</code></dt>
+						<dd>{% trans "Order number" %}</dd>
+                     {% endif %}
+                 </dl>
+             </div>
+             {% include 'partials/form_field.html' with field=form.email_subject_template %}
+             {% include 'partials/form_field.html' with field=form.email_body_template %}
+             {% include 'partials/form_field.html' with field=form.email_body_html_template %}
+             <div class="well">
+                 <h3>Preview</h3>
+                 {% if commtype.is_order_related %}
+				 <p>{% trans "View a preview of this email using order:" %}</p>
+                 {% include 'partials/form_field.html' with field=form.preview_order_number %}
+                 {% endif %}
+                 <button type="submit" class="btn btn-primary btn-large" name="show_preview">{% trans "View preview" %}</button>
+				 <p>{% trans "or send a preview to:" %}</p>
+                 {% include 'partials/form_field.html' with field=form.preview_email %}
+                 <button type="submit" class="btn btn-primary btn-large" name="send_preview">{% trans "Send preview email" %}</button>
+             </div>
+         </div>
+         <div class="tab-pane {% if preview %}active{% endif %}" id="email_preview">
+             <table>
+                 <tr>
+                     <th>{% trans "Subject" %}</th>
+                     <td>{{ preview.subject }}</td>
+                 </tr>
+                 <tr>
+                     <th>{% trans "Body text" %}</th>
+                     <td><pre>{{ preview.body }}</pre></td>
+                 </tr>
+                 <tr>
+                     <th>{% trans "Body HTML" %}</th>
+                     <td>{{ preview.html }}</td>
+                 </tr>
+             </table>
+         </div>
+     </div>
+</div>
+<div class="well">
+    <button type="submit" class="btn btn-primary btn-large">{% trans "Save" %}</button>
+    {% trans "or" %} <a href="{% url dashboard:comms-list %}">{% trans "cancel" %}</a>.
+</div>
+</form>
+
+{% endblock dashboard_content %}

oscar/templates/oscar/dashboard/comms/list.html

@@ -0,0 +1,49 @@
+{% extends 'dashboard/layout.html' %}
+{% load i18n %}
+
+{% block title %}
+	{% trans "Emails" %} | {{ block.super }}
+{% endblock %}
+
+{% block breadcrumbs %}
+<ul class="breadcrumb">
+    <li>
+	<a href="{% url dashboard:index %}">{% trans "Dashboard" %}</a>
+        <span class="divider">/</span>
+    </li>
+	<li class="active"><a href=".">{% trans "Emails" %}</a></li>
+</ul>
+{% endblock %}
+
+{% block dashboard_content %}
+<div class="sub-header">
+	<h2>{% trans "Emails" %}</h2>
+</div>
+{% if commtypes %}
+<table class="table table-striped table-bordered">
+	<thead>
+		<tr>
+			<th>{% trans "Code" %}</th>
+			<th>{% trans "Name" %}</th>
+			<th>{% trans "Category" %}</th>
+			<th></th>
+		</tr>
+	</thead>
+	<tbody>
+		{% for commtype in commtypes %}
+		<tr>
+			<td>{{ commtype.code }}</td>
+			<td>{{ commtype.name }}</td>
+			<td>{{ commtype.category }}</td>
+			<td>
+				<a class="btn btn-success" href="{% url dashboard:comms-update commtype.code|lower %}">{% trans "Edit" %}</a>
+			</td>
+		</tr>
+		{% endfor %}
+	</tbody>
+</table>
+{% include "partials/pagination.html" %}
+{% else %}
+<p>{% trans "There are no defined emails to edit." %}</p>
+{% endif %}
+{% endblock dashboard_content %}

oscar/templates/oscar/dashboard/pages/index.html

@@ -3,6 +3,7 @@
 {% load i18n %}
 
 {% block body_class %}pages{% endblock %}
+
 {% block title %}
 {% trans "Pages" %} | {{ block.super }}
 {% endblock %}

oscar/templates/oscar/registration/password_reset_done.html

@@ -15,7 +15,10 @@
 
 {% block content %}
 
-    <h1>{% trans 'Password reset successful' %}</h1>
+    <div class="sub-header">
+        <h2>{% trans "Password reset successful" %}</h2>
+    </div>
+
     <p>{% trans "We've e-mailed you instructions for setting your password to the e-mail address you submitted. You should be receiving it shortly." %}</p>
 
 {% endblock %}

oscar/templates/oscar/registration/password_reset_form.html

@@ -19,27 +19,13 @@
         <h2>{% trans "Password reset" %}</h2>
     </div>
 
-    <form id="password_reset_form" action="" method="post" class="form-stacked well">
-    {% csrf_token %}
-
+    <form id="password_reset_form" action="." method="post" class="form-horizontal">
+		{% csrf_token %}
         <p>{% trans "Forgotten your password? Enter your e-mail address below, and we'll e-mail instructions for setting a new one." %}</p>
-
-        <div class="control-group {% for error in form.email.errors %}error{% endfor %}">
-            <label for="id_email" class="control-label {% if form.email.field.required %}required{% endif %}">{% trans 'E-mail address:' %}{% if form.email.field.required %} <span>*</span>{% endif %}</label>
-            <div class="controls">
-                {{ form.email }}
-                {% for error in form.email.errors %}
-                    <span class="help-block">
-                        {{ error|escape }}
-                    </span>
-                {% endfor %}
-            </div>
-        </div>
-
+		{% include 'partials/form_fields.html' %}
         <div class="form-actions">
-             <input type="submit" class="btn btn-primary" value="{% trans 'Reset my password' %}" />
+			<button type="submit" class="btn btn-primary btn-large">{% trans 'Send reset email' %}</button>
         </div>
-
     </form>
 
 {% endblock %}

sites/_fixtures/comms.json

@@ -0,0 +1,32 @@
+[
+    {
+        "pk": 1,
+        "model": "customer.communicationeventtype",
+        "fields": {
+            "category": "User related",
+            "email_body_html_template": "<p>Thank you for registering</p>",
+            "code": "REGISTRATION",
+            "sms_template": "",
+            "name": "Newly registered user",
+            "email_subject_template": "Welcome to {{ site.name }}",
+            "date_updated": "2012-10-16T10:23:23.059Z",
+            "email_body_template": "Thank you for registering",
+            "date_created": "2012-10-11T15:09:56.317Z"
+        }
+    },
+    {
+        "pk": 2,
+        "model": "customer.communicationeventtype",
+        "fields": {
+            "category": "User related",
+            "email_body_html_template": "<p>You're receiving this e-mail because you requested a password reset for your user account at {{ site.name }}.</p>\r\n\r\n<p>Please go to the following page and choose a new password:</p>\r\n{{ reset_url }} \r\n\r\n<p>Thanks for using our site!</p>\r\n<p>The {{ site.name }} team</p>",
+            "code": "PASSWORD_RESET",
+            "sms_template": "",
+            "name": "Forgotten password",
+            "email_subject_template": "Resetting your password at {{ site.name }}",
+            "date_updated": "2012-10-16T10:21:32.909Z",
+            "email_body_template": "You're receiving this e-mail because you requested a password reset for your user account at {{ site.name }}.\r\n\r\nPlease go to the following page and choose a new password:\r\n{{ reset_url }} \r\n\r\nThanks for using our site!\r\nThe {{ site.name }} team",
+            "date_created": "2012-10-16T09:47:43.471Z"
+        }
+    }
+]

sites/puppet/manifests/site.pp

@@ -0,0 +1,23 @@
+# Set default path for all Exec tasks
+Exec {
+	path => "/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin",
+}
+
+node precise64 {
+	include userconfig
+
+	# Memcached
+	class {"memcached": max_memory => 64 }
+
+	# Python
+	$virtualenv = "/var/www/virtualenv"
+	include python::dev
+	include python::venv
+	python::venv::isolate { $virtualenv:
+	    requirements => "/vagrant/requirements.txt"
+	}
+    exec {"install-oscar":
+	    command => "$virtualenv/bin/python /vagrant/setup.py develop",
+		require => Python::Venv::Isolate[$virtualenv]
+	}
+}

sites/puppet/modules/memcached/Modulefile

@@ -0,0 +1,8 @@
+name    'saz-memcached'
+version '2.0.2'
+source 'git://github.com/saz/puppet-memcached.git'
+author 'saz'
+license 'Apache License, Version 2.0'
+summary 'UNKNOWN'
+description 'Manage memcached via Puppet'
+project_page 'https://github.com/saz/puppet-memcached'

sites/puppet/modules/memcached/README-DEVELOPER

@@ -0,0 +1,9 @@
+In order to run tests:
+  - puppet and facter must be installed and available in Ruby's LOADPATH
+  - the latest revision of rspec-puppet must be installed
+  - rake, and rspec2 must be install
+
+  - the name of the module directory needs to be memcached
+
+to run all tests:
+  rake spec

sites/puppet/modules/memcached/README.md

@@ -0,0 +1,29 @@
+
+# puppet-memcached
+
+Manage memcached via Puppet
+
+## How to use
+
+### Use roughly 90% of memory
+
+```
+    class { 'memcached': }
+```
+
+### Set a fixed memory limit in MB
+
+```
+    class { 'memcached':
+      max_memory => 2048
+    }
+```
+
+### Other class parameters
+
+* $logfile = '/var/log/memcached.log'
+* $listen_ip = '0.0.0.0'
+* $tcp_port = 11211
+* $udp_port = 11211
+* $user = '' (OS specific setting, see params.pp)
+* $max_connections = 8192

sites/puppet/modules/memcached/Rakefile

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'rake'
+require 'rspec/core/rake_task'
+
+task :default => [:spec]
+
+desc "Run all module spec tests (Requires rspec-puppet gem)"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = ['--color']
+  # ignores fixtures directory.
+  t.pattern = 'spec/{classes,defines,unit}/**/*_spec.rb'
+end
+
+desc "Build package"
+task :build do
+  system("puppet-module build")
+end

sites/puppet/modules/memcached/manifests/init.pp

@@ -0,0 +1,33 @@
+class memcached(
+  $package_ensure  = 'present',
+  $logfile         = '/var/log/memcached.log',
+  $max_memory      = false,
+  $listen_ip       = '0.0.0.0',
+  $tcp_port        = 11211,
+  $udp_port        = 11211,
+  $user            = $::memcached::params::user,
+  $max_connections = '8192',
+  $verbosity       = undef,
+  $unix_socket     = undef
+) inherits memcached::params {
+
+  package { $memcached::params::package_name:
+    ensure => $package_ensure,
+  }
+
+  file { $memcached::params::config_file:
+    owner   => 'root',
+    group   => 'root',
+    mode    => '0644',
+    content => template($memcached::params::config_tmpl),
+    require => Package[$memcached::params::package_name],
+  }
+
+  service { $memcached::params::service_name:
+    ensure     => running,
+    enable     => true,
+    hasrestart => true,
+    hasstatus  => false,
+    subscribe  => File[$memcached::params::config_file],
+  }
+}

sites/puppet/modules/memcached/manifests/params.pp

@@ -0,0 +1,21 @@
+class memcached::params {
+  case $::osfamily {
+    'Debian': {
+      $package_name = 'memcached'
+      $service_name = 'memcached'
+      $config_file  = '/etc/memcached.conf'
+      $config_tmpl  = "${module_name}/memcached.conf.erb"
+      $user = 'nobody'
+    }
+    'RedHat': {
+      $package_name = 'memcached'
+      $service_name = 'memcached'
+      $config_file  = '/etc/sysconfig/memcached'
+      $config_tmpl  = "${module_name}/memcached_sysconfig.erb"
+      $user = 'memcached'
+    }
+    default: {
+      fail("Unsupported platform: ${::osfamily}")
+    }
+  }
+}

sites/puppet/modules/memcached/metadata.json

@@ -0,0 +1,31 @@
+{
+  "license": "Apache License, Version 2.0",
+  "source": "git://github.com/saz/puppet-memcached.git",
+  "description": "Manage memcached via Puppet",
+  "dependencies": [
+
+  ],
+  "summary": "UNKNOWN",
+  "types": [
+
+  ],
+  "author": "saz",
+  "version": "2.0.2",
+  "name": "saz-memcached",
+  "checksums": {
+    "templates/memcached_sysconfig.erb": "fdcbb4381b08683291fe7da542a6435f",
+    "templates/memcached.conf.erb": "c86e1c762e655461c0651e16e094b52e",
+    "README-DEVELOPER": "d45048731ddb158a56a1b26293fb5dbf",
+    "spec/fixtures/manifests/site.pp": "d41d8cd98f00b204e9800998ecf8427e",
+    "spec/classes/memcached_spec.rb": "abaa4afe238f7cf599bea859a8d37bfa",
+    "tests/init.pp": "e798f4999ba392f3c0fce0d5290c263f",
+    "Rakefile": "5e1b5fb743446de634dbba3093a255cf",
+    "README.md": "02b0390847cb84c98c2c53c042f97b62",
+    "spec/spec.opts": "a600ded995d948e393fbe2320ba8e51c",
+    "manifests/params.pp": "6eafeac3502dec0a85b13aa9b7b2bac2",
+    "Modulefile": "41b0bfec37d8a4d807352b7d94b2e76e",
+    "manifests/init.pp": "0030a2858c6866425183adbd651d17e7",
+    "spec/spec_helper.rb": "983ae671e9a03e34b55b16e0476bf1c8"
+  },
+  "project_page": "https://github.com/saz/puppet-memcached"
+}

sites/puppet/modules/memcached/spec/classes/memcached_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+describe 'memcached' do
+
+  let :default_params do
+    {
+      :package_ensure  => 'present',
+      :logfile         => '/var/log/memcached.log',
+      :max_memory      => false,
+      :listen_ip       => '0.0.0.0',
+      :tcp_port        => '11211',
+      :udp_port        => '11211',
+      :user            => 'nobody',
+      :max_connections => '8192'
+    }
+  end
+
+  [ {},
+    {
+      :package_ensure  => 'latest',
+      :logfile         => '/var/log/memcached.log',
+      :max_memory      => '2',
+      :listen_ip       => '127.0.0.1',
+      :tcp_port        => '11212',
+      :udp_port        => '11213',
+      :user            => 'somebdy',
+      :max_connections => '8193'
+    }
+  ].each do |param_set|
+    describe "when #{param_set == {} ? "using default" : "specifying"} class parameters" do
+
+      let :param_hash do
+        default_params.merge(param_set)
+      end
+
+      let :params do
+        param_set
+      end
+
+      ['Debian'].each do |osfamily|
+
+        let :facts do
+          {
+            :osfamily => osfamily,
+            :memorysize => '1',
+            :processorcount => '1',
+          }
+        end
+
+        describe "on supported osfamily: #{osfamily}" do
+
+          it { should contain_class('memcached::params') }
+
+          it { should contain_package('memcached').with_ensure(param_hash[:package_ensure]) }
+
+          it { should contain_file('/etc/memcached.conf').with(
+            'owner'   => 'root',
+            'group'   => 'root'
+          )}
+
+          it { should contain_service('memcached').with(
+            'ensure'     => 'running',
+            'enable'     => true,
+            'hasrestart' => true,
+            'hasstatus'  => false
+          )}
+
+          it 'should compile the template based on the class parameters' do
+            content = param_value(
+              subject,
+              'file',
+              '/etc/memcached.conf',
+              'content'
+            )
+            expected_lines = [
+              "logfile #{param_hash[:logfile]}",
+              "-l #{param_hash[:listen_ip]}",
+              "-p #{param_hash[:tcp_port]}",
+              "-U #{param_hash[:udp_port]}",
+              "-u #{param_hash[:user]}",
+              "-c #{param_hash[:max_connections]}",
+              "-t #{facts[:processorcount]}"
+            ]
+            if(param_hash[:max_memory])
+              expected_lines.push("-m #{param_hash[:max_memory]}")
+            else
+              expected_lines.push("-m #{((facts[:memorysize].to_f*1024)*0.95).floor}")
+            end
+            (content.split("\n") & expected_lines).should =~ expected_lines
+          end
+        end
+      end
+      ['Redhat'].each do |osfamily|
+        describe 'on supported platform' do
+          it 'should fail' do
+
+          end
+        end
+      end
+    end
+  end
+end

sites/puppet/modules/memcached/spec/spec.opts

@@ -0,0 +1,6 @@
+--format
+s
+--colour
+--loadby
+mtime
+--backtrace

sites/puppet/modules/memcached/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'puppet'
+require 'rubygems'
+require 'rspec-puppet'
+
+# get the value of a certain parameter
+def param_value(subject, type, title, param)
+  subject.resource(type, title).send(:parameters)[param.to_sym]
+end
+
+RSpec.configure do |c|
+  c.module_path = File.join(File.dirname(__FILE__), '../../')
+  c.manifest_dir = File.expand_path(File.join(File.dirname(__FILE__), 'fixtures/manifests'))
+end

sites/puppet/modules/memcached/templates/memcached.conf.erb

@@ -0,0 +1,46 @@
+# File managed by puppet
+
+# Run memcached as a daemon.
+-d
+
+# pidfile
+-P /var/run/memcached.pid
+
+# Log memcached's output
+logfile <%= logfile %>
+
+<% if @verbosity -%>
+# Verbosity
+-<%= verbosity %>
+<% end -%>
+
+# Use <num> MB memory max to use for object storage.
+<% if max_memory -%>
+-m <%= max_memory %>
+<% else -%>
+-m <%= ((memorysize.to_f*1024)*0.95).floor %>
+<% end -%>
+
+<% if @unix_socket -%>
+# UNIX socket path to listen on
+-s <%= unix_socket %>
+<% else -%>
+
+# IP to listen on
+-l <%= listen_ip %>
+
+# TCP port to listen on
+-p <%= tcp_port %>
+
+# UDP port to listen on
+-U <%= udp_port %>
+<% end -%>
+
+# Run daemon as user
+-u <%= user %>
+
+# Limit the number of simultaneous incoming connections.
+-c <%= max_connections %>
+
+# Number of threads to use to process incoming requests.
+-t <%= processorcount %>

sites/puppet/modules/memcached/templates/memcached_sysconfig.erb

@@ -0,0 +1,5 @@
+PORT="<%= udp_port %>"
+USER="<%= user %>"
+MAXCONN="<%= max_connections %>"
+CACHESIZE="<%= max_memory %>"
+OPTIONS=""

sites/puppet/modules/memcached/tests/init.pp

@@ -0,0 +1 @@
+include memcached

sites/puppet/modules/python

@@ -0,0 +1 @@
+Subproject commit d12cc81c170e5dbc78973f30a35e1b36da667a89

sites/puppet/modules/userconfig

@@ -0,0 +1 @@
+Subproject commit a6faba58ebfeef2ea84b6614853da24b383e1409

tests/functional/dashboard/communication_tests.py

@@ -0,0 +1,40 @@
+from django_dynamic_fixture import G
+from django.contrib.auth.models import User
+from django.core.urlresolvers import reverse
+from django.core import mail
+
+from oscar.test import WebTestCase
+from oscar.apps.customer.models import CommunicationEventType
+
+
+class TestAnAdmin(WebTestCase):
+
+    def setUp(self):
+        self.staff = G(User, is_staff=True, username='1234')
+        self.commtype = CommunicationEventType.objects.create(
+            code='PASSWORD_RESET', name="Password reset",
+            category=CommunicationEventType.USER_RELATED)
+
+    def test_can_preview_an_email(self):
+        list_page = self.app.get(reverse('dashboard:comms-list'),
+                                 user=self.staff)
+        update_page = list_page.click('Edit')
+        form = update_page.form
+        form['email_subject_template'] = 'Hello {{ user.username }}'
+        form['email_body_template'] = 'Hello {{ user.username }}'
+        form['email_body_html_template'] = 'Hello {{ user.username }}'
+        preview = form.submit('show_preview')
+        self.assertTrue('Hello 1234' in preview.content)
+
+    def test_can_send_a_preview_email(self):
+        list_page = self.app.get(reverse('dashboard:comms-list'),
+                                 user=self.staff)
+        update_page = list_page.click('Edit')
+        form = update_page.form
+        form['email_subject_template'] = 'Hello {{ user.username }}'
+        form['email_body_template'] = 'Hello {{ user.username }}'
+        form['email_body_html_template'] = 'Hello {{ user.username }}'
+        form['preview_email'] = 'testing@example.com'
+        form.submit('send_preview')
+
+        self.assertEqual(len(mail.outbox), 1)