Merge pull request #38 from aydrian/ISSUE-34

Renamed transmission to transmissions retaining backwards compatibility

README.rst

@@ -67,7 +67,7 @@ Here at SparkPost, our messages are known as transmissions. Let's use the underl
 
     sp = SparkPost()
 
-    response = sp.transmission.send(
+    response = sp.transmissions.send(
         recipients=['someone@somedomain.com'],
         html='<p>Hello world</p>',
         from_email='test@sparkpostbox.com',

sparkpost/__init__.py

@@ -2,7 +2,7 @@
 
 from .exceptions import SparkPostException
 from .metrics import Metrics
-from .transmission import Transmission
+from .transmissions import Transmissions
 
 
 __version__ = '1.0.0.dev1'
@@ -26,4 +26,7 @@ def __init__(self, api_key=None, base_uri='https://api.sparkpost.com',
         self.api_key = api_key
 
         self.metrics = Metrics(self.base_uri, self.api_key)
-        self.transmission = Transmission(self.base_uri, self.api_key)
+        self.transmissions = Transmissions(self.base_uri, self.api_key)
+        # Keeping self.transmission for backwards compatibility.
+        # Will be removed in a future release.
+        self.transmission = self.transmissions

sparkpost/transmission.py → sparkpost/transmissions.py

@@ -3,7 +3,7 @@
 from .base import Resource
 
 
-class Transmission(Resource):
+class Transmissions(Resource):
     """
     Transmission class used to send, list and get transmissions. For detailed
     request and response formats, see the `Transmissions API documentation

test/test_transmission.py → test/test_transmissions.py

@@ -2,12 +2,12 @@
 import responses
 
 from sparkpost import SparkPost
-from sparkpost import Transmission
+from sparkpost import Transmissions
 from sparkpost.exceptions import SparkPostAPIException
 
 
 def test_translate_keys_with_list():
-    t = Transmission('uri', 'key')
+    t = Transmissions('uri', 'key')
     results = t._translate_keys(recipient_list='test')
     assert results['return_path'] == 'default@sparkpostmail.com'
     assert results['options']['open_tracking'] is True
@@ -17,7 +17,7 @@ def test_translate_keys_with_list():
 
 
 def test_translate_keys_with_recips():
-    t = Transmission('uri', 'key')
+    t = Transmissions('uri', 'key')
     results = t._translate_keys(recipients=['test',
                                             {'key': 'value'}, 'foobar'])
     assert results['recipients'] == [{'address': {'email': 'test'}},