Merge pull request #160 from wooyek/feature/django-backend-headers-support

Support for EmailMessage.extra_headers and transactional option

Author: jgzamora

AUTHORS.rst

@@ -21,4 +21,5 @@ Patches and suggestions
 - `@gnarvaja <https://github.com/gnarvaja>`_
 - `@pegler <https://github.com/pegler>`_
 - `@puttu <https://github.com/puttu>`_
+- Janusz Skonieczny `@wooyek <https://github.com/wooyek>`_
 - ADD YOURSELF HERE (and link to your github page)

sparkpost/django/message.py

@@ -90,4 +90,12 @@ def __init__(self, message):
         if hasattr(message, 'campaign'):
             formatted['campaign'] = message.campaign
 
+        if message.extra_headers:
+            formatted['custom_headers'] = message.extra_headers
+            if 'X-MSYS-API' in message.extra_headers:
+                import json
+                msys_api = json.loads(message.extra_headers['X-MSYS-API'])
+                if msys_api and msys_api.get('options', {}).get('transactional', False):  # noqa: E501
+                    formatted['transactional'] = True
+
         super(SparkPostMessage, self).__init__(formatted)

sparkpost/exceptions.py

@@ -5,14 +5,16 @@ class SparkPostException(Exception):
 class SparkPostAPIException(SparkPostException):
     "Handle 4xx and 5xx errors from the SparkPost API"
     def __init__(self, response, *args, **kwargs):
+        # noinspection PyBroadException
         try:
             errors = response.json()['errors']
             error_template = "{message} Code: {code} Description: {desc} \n"
             errors = [error_template.format(message=e.get('message', ''),
                                             code=e.get('code', 'none'),
                                             desc=e.get('description', 'none'))
                       for e in errors]
-        except:
+        # TODO: select exception to catch here
+        except:  # noqa: E722
             errors = [response.text or ""]
         self.status = response.status_code
         self.response = response

sparkpost/tornado/base.py

@@ -20,9 +20,11 @@ def request(self, method, uri, headers, **kwargs):
             raise gen.Return(True)
         if response.code == 200:
             result = None
+            # noinspection PyBroadException
             try:
                 result = json.loads(response.body.decode("utf-8"))
-            except:
+            # TODO: select exception to catch here
+            except:  # noqa: E722
                 pass
             if result:
                 if 'results' in result:

sparkpost/tornado/exceptions.py

@@ -6,13 +6,15 @@
 class SparkPostAPIException(RequestsSparkPostAPIException):
     def __init__(self, response, *args, **kwargs):
         errors = None
+        # noinspection PyBroadException
         try:
             data = json.loads(response.body.decode("utf-8"))
             if data:
                 errors = data['errors']
                 errors = [e['message'] + ': ' + e.get('description', '')
                           for e in errors]
-        except:
+        # TODO: select exception to catch here
+        except:  # noqa: E722
             pass
         if not errors:
             errors = [response.body.decode("utf-8") or ""]

sparkpost/transmissions.py

@@ -251,7 +251,8 @@ def send(self, **kwargs):
         """
 
         payload = self._translate_keys(**kwargs)
-        results = self.request('POST', self.uri, data=json.dumps(payload))
+        data = json.dumps(payload)
+        results = self.request('POST', self.uri, data=data)
         return results
 
     def _fetch_get(self, transmission_id):

test/django/test_message.py

@@ -228,3 +228,30 @@ def test_reply_to():
 
         assert message(reply_to=['replyone@example.com',
                                  'replytwo@example.com']) == expected
+
+
+def test_extra_headers():
+    email_message = EmailMessage(**base_options)
+    email_message.extra_headers['FOO'] = 'bar'
+
+    actual = SparkPostMessage(email_message)
+    expected = dict(
+        custom_headers={'FOO': 'bar'},
+    )
+    expected.update(base_expected)
+    assert actual == expected
+
+
+def test_transactional():
+    email_message = EmailMessage(**base_options)
+    import json
+    msys_api = json.dumps({'options': {'transactional': True}})
+    email_message.extra_headers['X-MSYS-API'] = msys_api
+
+    actual = SparkPostMessage(email_message)
+    expected = dict(
+        custom_headers={'X-MSYS-API': msys_api},
+        transactional=True,
+    )
+    expected.update(base_expected)
+    assert actual == expected

test/test_templates.py

@@ -1,6 +1,7 @@
 try:
     from urllib.parse import urlparse
-except:
+# TODO: select exception to catch here
+except:  # noqa: E722
     from urlparse import urlparse
 
 import pytest