Multiple API changes

Add template_name parameter to BaseEmailMessage constructor
Add context tests
Add mock for python 2.7 to tox dependencies
Update set_context_data into get_context_data
Update render to be invoked on send
Update tests for API changes

Author: pszpetkowski

templated_mail/mail.py

@@ -1,3 +1,5 @@
+from copy import deepcopy
+
 from django.contrib.sites.shortcuts import get_current_site
 from django.core import mail
 from django.template.context import make_context
@@ -14,36 +16,57 @@ class BaseEmailMessage(mail.EmailMultiAlternatives):
     }
     template_name = None
 
-    def __init__(self, request, context=None, *args, **kwargs):
+    def __init__(self, request=None, context=None, template_name=None,
+                 *args, **kwargs):
         super(BaseEmailMessage, self).__init__(*args, **kwargs)
 
         self.request = request
         self.context = {} if context is None else context
         self.html = None
 
-        if request is not None:
-            self.set_context_data()
-        self.render()
+        if template_name is not None:
+            self.template_name = template_name
 
-    def set_context_data(self):
-        site = get_current_site(self.request)
-        self.context.update({
-            'domain': getattr(settings, 'DOMAIN', '') or site.domain,
-            'protocol': self.context.get('protocol') or (
-                'https' if self.request.is_secure() else 'http'),
-            'site_name': getattr(settings, 'SITE_NAME', '') or site.name,
-            'user': self.context.get('user') or self.request.user,
+    def get_context_data(self):
+        context = deepcopy(self.context)
+        if self.request:
+            site = get_current_site(self.request)
+            domain = context.get('domain') or (
+                getattr(settings, 'DOMAIN', '') or site.domain
+            )
+            protocol = context.get('protocol') or (
+                'https' if self.request.is_secure() else 'http'
+            )
+            site_name = context.get('site_name') or (
+                getattr(settings, 'SITE_NAME', '') or site.name
+            )
+            user = context.get('user') or self.request.user
+        else:
+            domain = context.get('domain') or getattr(settings, 'DOMAIN', '')
+            protocol = context.get('protocol') or 'http'
+            site_name = context.get('site_name') or getattr(
+                settings, 'SITE_NAME', ''
+            )
+            user = context.get('user')
+
+        context.update({
+            'domain': domain,
+            'protocol': protocol,
+            'site_name': site_name,
+            'user': user
         })
+        return context
 
     def render(self):
-        context = make_context(self.context, request=self.request)
+        context = make_context(self.get_context_data(), request=self.request)
         template = get_template(self.template_name)
         with context.bind_template(template.template):
             for node in template.template.nodelist:
                 self._process_node(node, context)
         self._attach_body()
 
     def send(self, to, cc=None, bcc=None, *args, **kwargs):
+        self.render()
         self.to = to
         if cc:
             self.cc = cc

tests/test_mail.py

@@ -1,25 +1,83 @@
+from unittest import mock
+
 from django.contrib.auth.models import AnonymousUser
+from django.contrib.sites.shortcuts import get_current_site
 from django.core import mail
 from django.test import RequestFactory, TestCase
 
 from templated_mail.mail import BaseEmailMessage
 
 
-class EmailMessage(BaseEmailMessage):
-    pass
-
-
 class TestBaseEmailMessage(TestCase):
     def setUp(self):
         self.factory = RequestFactory()
         self.recipients = ['foo@bar.tld']
 
+    @mock.patch('django.core.handlers.wsgi.WSGIRequest.is_secure')
+    def test_get_context_data_with_insecure_request(self, is_secure_mock):
+        is_secure_mock.return_value = False
+
+        request = self.factory.get('/')
+        request.user = AnonymousUser()
+
+        email_message = BaseEmailMessage(
+            request=request, template_name='text_mail.html'
+        )
+        context = email_message.get_context_data()
+        site = get_current_site(request)
+
+        self.assertEquals(context['domain'], site.domain)
+        self.assertEquals(context['protocol'], 'http')
+        self.assertEquals(context['site_name'], site.name)
+        self.assertEquals(context['user'], request.user)
+
+    @mock.patch('django.core.handlers.wsgi.WSGIRequest.is_secure')
+    def test_get_context_data_with_secure_request(self, is_secure_mock):
+        is_secure_mock.return_value = True
+
+        request = self.factory.get('/')
+        request.user = AnonymousUser()
+
+        email_message = BaseEmailMessage(
+            request=request, template_name='text_mail.html'
+        )
+        context = email_message.get_context_data()
+        site = get_current_site(request)
+
+        self.assertEquals(context['domain'], site.domain)
+        self.assertEquals(context['protocol'], 'https')
+        self.assertEquals(context['site_name'], site.name)
+        self.assertEquals(context['user'], request.user)
+
+    def test_get_context_data_without_request_no_context(self):
+        email_message = BaseEmailMessage(template_name='text_mail.html')
+        context = email_message.get_context_data()
+
+        self.assertEquals(context['domain'], '')
+        self.assertEquals(context['protocol'], 'http')
+        self.assertEquals(context['site_name'], '')
+        self.assertEquals(context['user'], None)
+
+    def test_get_context_data_without_request_user_context(self):
+        user = AnonymousUser()
+        email_message = BaseEmailMessage(
+            context={'user': user}, template_name='text_mail.html'
+        )
+        context = email_message.get_context_data()
+
+        self.assertEquals(context['domain'], '')
+        self.assertEquals(context['protocol'], 'http')
+        self.assertEquals(context['site_name'], '')
+        self.assertEquals(context['user'], user)
+
     def test_text_mail_contains_valid_data(self):
         request = self.factory.get('/')
         request.user = AnonymousUser()
 
-        EmailMessage.template_name = 'text_mail.html'
-        EmailMessage(request=request).send(to=self.recipients)
+        BaseEmailMessage(
+            request=request, template_name='text_mail.html'
+        ).send(to=self.recipients)
+
         self.assertEqual(len(mail.outbox), 1)
         self.assertEqual(mail.outbox[0].recipients(), self.recipients)
         self.assertEqual(mail.outbox[0].subject, 'Text mail subject')
@@ -31,8 +89,10 @@ def test_html_mail_contains_valid_data(self):
         request = self.factory.get('/')
         request.user = AnonymousUser()
 
-        EmailMessage.template_name = 'html_mail.html'
-        EmailMessage(request=request).send(to=self.recipients)
+        BaseEmailMessage(
+            request=request, template_name='html_mail.html'
+        ).send(to=self.recipients)
+
         self.assertEqual(len(mail.outbox), 1)
         self.assertEqual(mail.outbox[0].recipients(), self.recipients)
         self.assertEqual(mail.outbox[0].subject, 'HTML mail subject')
@@ -44,8 +104,10 @@ def test_text_and_html_mail_contains_valid_data(self):
         request = self.factory.get('/')
         request.user = AnonymousUser()
 
-        EmailMessage.template_name = 'text_and_html_mail.html'
-        EmailMessage(request=request).send(to=self.recipients)
+        BaseEmailMessage(
+            request=request, template_name='text_and_html_mail.html'
+        ).send(to=self.recipients)
+
         self.assertEqual(len(mail.outbox), 1)
         self.assertEqual(mail.outbox[0].recipients(), self.recipients)
         self.assertEqual(mail.outbox[0].subject, 'Text and HTML mail subject')
@@ -57,8 +119,10 @@ def test_text_and_html_mail_contains_valid_data(self):
         self.assertEqual(mail.outbox[0].content_subtype, 'plain')
 
     def test_can_send_mail_with_none_request(self):
-        EmailMessage.template_name = 'text_mail.html'
-        EmailMessage(request=None).send(to=self.recipients)
+        BaseEmailMessage(
+            request=None, template_name='text_mail.html'
+        ).send(to=self.recipients)
+
         self.assertEqual(len(mail.outbox), 1)
         self.assertEqual(mail.outbox[0].recipients(), self.recipients)
         self.assertEqual(mail.outbox[0].subject, 'Text mail subject')
@@ -72,8 +136,10 @@ def test_mail_cc_is_sent_to_valid_cc(self):
 
         cc = ['email@example.tld']
 
-        EmailMessage.template_name = 'text_mail.html'
-        EmailMessage(request=request).send(to=self.recipients, cc=cc)
+        BaseEmailMessage(
+            request=request, template_name='text_mail.html'
+        ).send(to=self.recipients, cc=cc)
+
         self.assertEqual(len(mail.outbox), 1)
         self.assertEqual(mail.outbox[0].to, self.recipients)
         self.assertEqual(mail.outbox[0].cc, cc)
@@ -88,8 +154,10 @@ def test_mail_bcc_is_sent_to_valid_bcc(self):
 
         bcc = ['email@example.tld']
 
-        EmailMessage.template_name = 'text_mail.html'
-        EmailMessage(request=request).send(to=self.recipients, bcc=bcc)
+        BaseEmailMessage(
+            request=request, template_name='text_mail.html'
+        ).send(to=self.recipients, bcc=bcc)
+
         self.assertEqual(len(mail.outbox), 1)
         self.assertEqual(mail.outbox[0].to, self.recipients)
         self.assertEqual(mail.outbox[0].bcc, bcc)

tox.ini

@@ -32,6 +32,7 @@ deps =
     django110: django>=1.10,<1.11
     django111: django>=1.11,<2.0
     djangomaster: git+git://github.com/django/django.git
+    py27: mock
     -rrequirements/test
 commands =
     py.test --ds=tests.settings --capture=no --cov-report term-missing --cov-report html --cov=templated_mail tests