Merge pull request #65 from resulto-admin/ISSUE-56

Added support for attachments. Resolves #56

Author: richleland

docs/resources/transmissions.rst

@@ -54,6 +54,33 @@ Using inline templates and/or recipients
     )
 
 
+Sending an attachment
+*********************
+
+.. code-block:: python
+
+    from sparkpost import SparkPost
+
+    sp = SparkPost()
+
+    sp.transmission.send(
+        recipients=['[email protected]'],
+        text="Hello world",
+        html='<p>Hello world</p>',
+        from_email='[email protected]',
+        subject='Hello from python-sparkpost',
+        track_opens=True,
+        track_clicks=True,
+        attachments=[
+            {
+                "name": "test.txt",
+                "type": "text/plain",
+                "filename": "/home/sparkpost/a-file.txt"
+            }
+        ]
+    )
+
+
 Using a stored template
 ***********************
 

sparkpost/transmissions.py

@@ -1,3 +1,4 @@
+import base64
 import json
 
 from .base import Resource
@@ -50,8 +51,31 @@ def _translate_keys(self, **kwargs):
             recipients = kwargs.get('recipients', [])
             model['recipients'] = self._extractRecipients(recipients)
 
+        attachments = kwargs.get('attachments', [])
+        model['content']['attachments'] = self._extract_attachments(
+            attachments)
+
         return model
 
+    def _extract_attachments(self, attachments):
+        formatted_attachments = []
+        for attachment in attachments:
+            formatted_attachment = {}
+            formatted_attachment['type'] = attachment.get('type')
+            formatted_attachment['name'] = attachment.get('name')
+            if 'filename' in attachment:
+                formatted_attachment['data'] = self._get_base64_from_file(
+                    attachment['filename'])
+            else:
+                formatted_attachment['data'] = attachment.get('data')
+            formatted_attachments.append(formatted_attachment)
+        return formatted_attachments
+
+    def _get_base64_from_file(self, filename):
+        with open(filename, "rb") as a_file:
+            encoded_string = base64.b64encode(a_file.read()).decode("ascii")
+        return encoded_string
+
     def _extractRecipients(self, recipients):
         formatted_recipients = []
         for recip in recipients:
@@ -86,6 +110,11 @@ def send(self, **kwargs):
         :param dict substitution_data: Corresponds to substitutions in
             html/text content. See `substitutions reference
             <https://www.sparkpost.com/docs/substitutions-reference>`_.
+        :param dict attachments: Corresponds to attachments.
+            See `Attachment Attributes reference
+            <https://developers.sparkpost.com/api/#/reference/transmissions>`_.
+            Replace `data` by `filename` if you want the library to perform
+            the base64 conversion. Example: `"filename": "/full/path/test.txt"`
         :param str start_time: Delay generation of messages until this
             datetime. Format YYYY-MM-DDTHH:MM:SS+-HH:MM. Example:
             '2015-02-11T08:00:00-04:00'.

test/test_transmissions.py

@@ -1,5 +1,11 @@
+import base64
+import json
+import os
+import tempfile
+
 import pytest
 import responses
+import six
 
 from sparkpost import SparkPost
 from sparkpost import Transmissions
@@ -37,6 +43,58 @@ def test_success_send():
     assert results == 'yay'
 
 
+@responses.activate
+def test_success_send_with_attachments():
+    try:
+        # Let's compare unicode for Python 2 / 3 compatibility
+        test_content = six.u("Hello \nWorld\n")
+        (_, temp_file_path) = tempfile.mkstemp()
+        with open(temp_file_path, "w") as temp_file:
+            temp_file.write(test_content)
+
+        responses.add(
+            responses.POST,
+            'https://api.sparkpost.com/api/v1/transmissions',
+            status=200,
+            content_type='application/json',
+            body='{"results": "yay"}'
+        )
+        sp = SparkPost('fake-key')
+
+        attachment = {
+            "name": "test.txt",
+            "type": "text/plain",
+            "filename": temp_file_path
+        }
+        results = sp.transmission.send(attachments=[attachment])
+
+        request_params = json.loads(responses.calls[0].request.body)
+        content = base64.b64decode(
+            request_params["content"]["attachments"][0]["data"])
+        # Let's compare unicode for Python 2 / 3 compatibility
+        assert test_content == content.decode("ascii")
+
+        assert results == 'yay'
+
+        attachment = {
+            "name": "test.txt",
+            "type": "text/plain",
+            "data": base64.b64encode(
+                test_content.encode("ascii")).decode("ascii")
+        }
+        results = sp.transmission.send(attachments=[attachment])
+
+        request_params = json.loads(responses.calls[1].request.body)
+        content = base64.b64decode(
+            request_params["content"]["attachments"][0]["data"])
+        # Let's compare unicode for Python 2 / 3 compatibility
+        assert test_content == content.decode("ascii")
+
+        assert results == 'yay'
+    finally:
+        os.unlink(temp_file_path)
+
+
 @responses.activate
 def test_fail_send():
     responses.add(