Postmark templates feature refactor

nicholasserra · nicholasserra · commit f39ccfd7060c · 2017-11-02T13:33:30.000-04:00
diff --git a/README.md b/README.md
@@ -88,9 +88,9 @@ Using templates in python-postmark is straightforward:
 
 3. Make a dict in python that contains the values of the template variables. Postmark calls this the "TemplateModel"
 
-4. Instantiate PMMail with the the appropriate kwargs, including "template_id" and "template_model". NOTE: do not set the "subject" kwarg.
+4. Instantiate PMMail with the the appropriate kwargs, including "template_id" and "template_model". NOTE: "subject" kwarg is ignored.
 
-5. Call the send_with_template() method
+5. Call the send() method
 
 Here is an example:
 
@@ -118,7 +118,7 @@ template_model = {
 }
 pm = PMMail(to='groucho.marx@gmail.com', sender='harpo.marx@gmail.com',
             template_id=123456, template_model=template_model)
-    pm.send_with_template()
+    pm.send()
 ```
 
 
diff --git a/postmark/core.py b/postmark/core.py
@@ -64,7 +64,7 @@ def __init__(self, **kwargs):
         bcc:            Who to blind copy the email to, in either
                         "name@email.com" or "First Last <name@email.com>" format
                         Can be multiple values separated by commas (limit 20)
-        subject:        Subject of the email. ***DO NOT SET if using Postmark templates
+        subject:        Subject of the email, ignored if using Postmark templates
         tag:            Use for adding categorizations to your email
         html_body:      Email message in HTML
         text_body:      Email message in plain text
@@ -328,7 +328,7 @@ def _set_attachments(self, value):
     #####################
 
 
-    def _check_values(self, endpoint='email'):
+    def _check_values(self):
         '''
         Make sure all values are of the appropriate
         type and are not missing.
@@ -339,13 +339,11 @@ def _check_values(self, endpoint='email'):
             raise PMMailMissingValueException('Cannot send an e-mail without a sender (.sender field)')
         elif not self.__to:
             raise PMMailMissingValueException('Cannot send an e-mail without at least one recipient (.to field)')
-        elif endpoint == 'email/withTemplate/' and (not self.__template_id or not self.__template_model):
+        elif (self.__template_id or self.__template_model) and not all([self.__template_id, self.__template_model]):
             raise PMMailMissingValueException(
                 'Cannot send a template e-mail without a both template_id and template_model set')
-        elif not self.__subject and endpoint == 'email':
+        elif not any([self.__template_id, self.__template_model, self.__subject]):
             raise PMMailMissingValueException('Cannot send an e-mail without a subject')
-        elif self.__template_id and self.__subject:
-            raise PMMailMissingValueException('If using Postmark templates, do not set the subject value')
         elif not self.__html_body and not self.__text_body and not self.__template_id:
             raise PMMailMissingValueException('Cannot send an e-mail without either an HTML or text version of your e-mail body')
         if self.__track_opens and not self.__html_body:
@@ -429,16 +427,13 @@ def to_json_message(self):
 
         return json_message
 
-    def send(self, endpoint='email', test=None):
+    def send(self, test=None):
         '''
         Send the email through the Postmark system.
         Pass test=True to just print out the resulting
         JSON message being sent to Postmark
-
-        endpoint: the name of the Postmark API endpoints
-
         '''
-        self._check_values(endpoint=endpoint)
+        self._check_values()
 
         # Set up message dictionary
         json_message = self.to_json_message()
@@ -460,9 +455,14 @@ def send(self, endpoint='email', test=None):
             print('JSON message is:\n%s' % json.dumps(json_message, cls=PMJSONEncoder))
             return
 
+        if self.__template_id:
+            endpoint_url = __POSTMARK_URL__ + 'email/withTemplate/'
+        else:
+            endpoint_url = __POSTMARK_URL__ + 'email'
+
         # Set up the url Request
         req = Request(
-            __POSTMARK_URL__ + endpoint,
+            endpoint_url,
             json.dumps(json_message, cls=PMJSONEncoder).encode('utf8'),
             {
                 'Accept': 'application/json',
@@ -509,9 +509,6 @@ def send(self, endpoint='email', test=None):
             else:
                 raise PMMailURLException('URLError: The server couldn\'t fufill the request. (See "inner_exception" for details)', err)
 
-    def send_with_template(self, **kwargs):
-        self.send(endpoint='email/withTemplate/', **kwargs)
-
 
 # Simple utility that returns a generator to chunk up a list into equal parts
 def _chunks(l, n):
diff --git a/tests.py b/tests.py
@@ -60,15 +60,16 @@ def assert_missing_value_exception(self, message_func, error_message):
             message_func()
         self.assertEqual(error_message, cm.exception.parameter)
 
-    def test_send_with_template(self):
-        # Confirm send() still works as before send_with_template() was added
+    def test_send(self):
+        # Confirm send() still works as before use_template was added
         message = PMMail(sender='from@example.com', to='to@example.com',
             subject='Subject', text_body='Body', api_key='test')
 
         with mock.patch('postmark.core.urlopen', side_effect=HTTPError('',
             200, '', {}, None)):
-            self.assertTrue(message.send)
+            message.send()
 
+    def test_missing_subject(self):
         # No subject should raise exception when using send()
         message = PMMail(sender='from@example.com', to='to@example.com',
                          text_body='Body', api_key='test')
@@ -77,31 +78,21 @@ def test_send_with_template(self):
             'Cannot send an e-mail without a subject'
         )
 
-        # Test new _check_values()
-        # Try sending with template without a template ID or template model
-        for kwargs in [{'subject': 'Subject', 'text_body': 'Body'},
-                       {'template_id': 1},
-                       {'template_model': {'junk': 'more junk'}}]:
-            message = PMMail(api_key='test', sender='from@example.com', to='to@example.com', **kwargs)
-            self.assert_missing_value_exception(
-                message.send_with_template,
-                'Cannot send a template e-mail without a both template_id and template_model set'
-            )
-
-        # Both template_id and template_model are set, so send_with_template should work.
+    def test_check_values_bad_template_data(self):
+        # Try sending with template ID only
+        message = PMMail(api_key='test', sender='from@example.com', to='to@example.com', template_id=1)
+        self.assert_missing_value_exception(
+            message.send,
+            'Cannot send a template e-mail without a both template_id and template_model set'
+        )
+
+    def test_send_with_template(self):
+        # Both template_id and template_model are set, so send should work.
         message = PMMail(api_key='test', sender='from@example.com', to='to@example.com',
                          template_id=1, template_model={'junk': 'more junk'})
         with mock.patch('postmark.core.urlopen', side_effect=HTTPError('',
             200, '', {}, None)):
-            self.assertTrue(message.send_with_template)
-
-        # Setting a subject with a template should raise an error
-        message = PMMail(api_key='test', sender='from@example.com', to='to@example.com',
-                         template_id=1, template_model={'junk': 'more junk'}, subject='Subject')
-        self.assert_missing_value_exception(
-            message.send_with_template,
-            'If using Postmark templates, do not set the subject value'
-        )
+            message.send()
 
     def test_inline_attachments(self):
         image = MIMEImage(b'image_file', 'png', name='image.png')
