SMTAPI is wrapped inside of Mail object instead of inherited. Version

bump

Author: elbuo8

README.rst

@@ -4,6 +4,11 @@ SendGrid-Python
 This library allows you to quickly and easily send emails through
 SendGrid using Python.
 
+Warning
+-------
+
+If you upgrade to version ``1.2.x``, the ``add_to`` method behaves differently. In the past this method defaulted to using the ``SMTPAPI`` header. Now you must explicitly call the ``smtpapi.add_to`` method. More on the ``SMTPAPI`` section.
+
 Install
 -------
 
@@ -148,45 +153,63 @@ If you wish to use the X-SMTPAPI on your own app, you can use the
 
 There are implementations for setter methods too.
 
+`Recipients`_
+~~~~~~~~~~~~~
+
+.. code:: python
+
+    message = sendgrid.Mail()
+    message.smtpapi.add_to('example@email.com')
+
 `Substitution`_
 ~~~~~~~~~~~~~~~
 
 .. code:: python
 
     message = sendgrid.Mail()
-    message.add_substitution("key", "value")
+    message.smtpapi.add_substitution('key', 'value')
+    # or
+    message.add_substitution('key', 'value')
 
 `Section`_
 ~~~~~~~~~~
 
 .. code:: python
 
     message = sendgrid.Mail()
-    message.add_section("section", "value")
+    message.smtpapi.add_section('section', 'value')
+    # or
+    message.add_section('section', 'value')
 
 `Category`_
 ~~~~~~~~~~~
 
 .. code:: python
 
     message = sendgrid.Mail()
-    message.add_category("category")
+    message.smtpapi.add_category('category')
+    # or
+    message.add_category('category')
 
 `Unique Arguments`_
 ~~~~~~~~~~~~~~~~~~~
 
 .. code:: python
 
     message = sendgrid.Mail()
-    message.add_unique_arg("key", "value")
+    message.smtpapi.add_unique_arg('key', 'value')
+    # or
+    message.add_unique_arg('key', 'value')
 
 `Filter`_
 ~~~~~~~~~
 
 .. code:: python
 
     message = sendgrid.Mail()
-    message.add_filter("filter", "setting", "value")
+    message.smtpapi.add_filter('filter', 'setting', 'value')
+    # or
+    message.add_filter('filter', 'setting', 'value')
 
 
 Tests

sendgrid/message.py

@@ -7,7 +7,7 @@
 from smtpapi import SMTPAPIHeader
 
 
-class Mail(SMTPAPIHeader):
+class Mail():
 
     """SendGrid Message."""
 
@@ -29,7 +29,6 @@ def __init__(self, **opts):
             headers: Set headers
             files: Attachments
         """
-        super(Mail, self).__init__()
         self.to = []
         self.to_name = []
         self.cc = []
@@ -48,9 +47,9 @@ def __init__(self, **opts):
         self.headers = opts.get('headers', '')
         self.date = opts.get('date', rfc822.formatdate())
         self.content = opts.get('content', {})
+        self.smtpapi = opts.get('smtpapi', SMTPAPIHeader())
 
     def parse_and_add(self, to):
-        super(Mail, self).add_to(to)
         name, email = rfc822.parseaddr(to.replace(',', ''))
         if email:
             self.to.append(email)
@@ -144,3 +143,35 @@ def set_headers(self, headers):
 
     def set_date(self, date):
         self.date = date
+
+    # SMTPAPI Wrapper methods
+
+    def add_substitution(self, key, value):
+        self.smtpapi.add_substitution(key, value)
+
+    def set_substitutions(self, subs):
+        self.smtpapi.set_substitutions(subs)
+
+    def add_unique_arg(self, key, value):
+        self.smtpapi.add_unique_arg(key, value)
+
+    def set_unique_args(self, args):
+        self.smtpapi.set_unique_args(args)
+
+    def add_category(self, cat):
+        self.smtpapi.add_category(cat)
+
+    def set_categories(self, cats):
+        self.smtpapi.set_categories(cats)
+
+    def add_section(self, key, value):
+        self.smtpapi.add_section(key, value)
+
+    def set_sections(self, sections):
+        self.smtpapi.set_sections(sections)
+
+    def add_filter(self, filterKey, setting, value):
+        self.smtpapi.add_filter(filterKey, setting, value)
+
+    def json_string(self):
+        return self.smtpapi.json_string()

sendgrid/sendgrid.py

@@ -54,7 +54,7 @@ def _build_body(self, message):
         values = {
             'api_user': self.username,
             'api_key': self.password,
-            'to[]': message.to,
+            'to[]': message.to if message.to else [message.from_email],
             'toname[]': message.to_name,
             'cc[]': message.cc,
             'bcc[]': message.bcc,

sendgrid/version.py

@@ -1,2 +1,2 @@
-version_info = (1, 1, 2)
+version_info = (1, 2, 0)
 __version__ = '.'.join(str(v) for v in version_info)

test/__init__.py

@@ -66,7 +66,6 @@ def test_send(self):
             ''')
         test_url['x-smtpapi'] = json.dumps(json.loads('''
             {
-                "to" : ["John, Doe <john@email.com>"],
                 "sub": {
                     "subKey": ["subValue"]
                 },
@@ -110,6 +109,32 @@ def test__build_body_unicode(self):
         self.assertEqual(html, url['html'])
 
 
+    def test_smtpapi_add_to(self):
+        '''Test that message.to gets a dummy address for the header to work'''
+        m = Mail()
+        m.smtpapi.add_to('test@email.com')
+        m.set_from('jon@doe.com')
+        m.set_subject('test')
+        url = self.sg._build_body(m)
+        url.pop('api_key', None)
+        url.pop('api_user', None)
+        url.pop('date', None)
+        test_url = json.loads('''
+            {
+                "to[]": ["jon@doe.com"],
+                "subject": "test",
+                "from": "jon@doe.com"
+            }
+            ''')
+        test_url['x-smtpapi'] = json.dumps(json.loads('''
+            {
+                "to": ["test@email.com"]
+            }
+            '''))
+        self.assertEqual(url, test_url)
+
+
+
 class SendGridClientUnderTest(SendGridClient):
 
     def _make_request(self, message):