Merge pull request #132 from sendgrid/global-suppressions

Added ASM Global Suppressions GET method

Author: thinkingserious

README.rst

@@ -305,6 +305,19 @@ Delete a recipient email from the suppressions list for a group.
 
     status, msg = client.asm_suppressions.delete(<group_id>,<email_address>)
 
+ASM Global Suppressions
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Global Suppressions are email addresses that will not receive any emails.
+
+Check if a given email is on the global suppression list.
+
+.. code:: python
+    
+    client = sendgrid.SendGridAPIClient(os.environ.get('SENDGRID_API_KEY'))
+    email = ['[email protected]']
+    status, msg = client.asm_global_suppressions.get(email)
+
 SendGrid's `X-SMTPAPI`_
 -----------------------
 

example_v2_test.py

@@ -13,7 +13,7 @@
 message.set_subject('Testing from the Python library')
 message.set_html('<b>This was a successful test!</b>')
 message.set_text('This was a successful test!')
-message.set_from('Elmer Thomas <elmer@thinkingserious.com>')
+message.set_from('Elmer Thomas <dx@sendgrid.com>')
 status, msg = sg.send(message)
 print status
 print msg

example_v3_test.py

@@ -8,20 +8,30 @@
         if len(var) == 2:
             os.environ[var[0]] = var[1]
 
-
-
 client = sendgrid.SendGridAPIClient(os.environ.get('SENDGRID_API_KEY'))
 
-status, msg = client.asm_suppressions.delete(67,'[email protected]')
+# In the global suppression list
+status, msg = client.asm_global_suppressions.get('[email protected]')
+print status
+print msg
+
+# Not in the global suppression list
+status, msg = client.asm_global_suppressions.get('[email protected]')
 print status
 print msg
 
 """
+status, msg = client.apikeys.get()
+print status
+print msg
 
-status, msg = client.asm_suppressions.post(60, ['[email protected]', '[email protected]'])
+status, msg = client.asm_suppressions.delete(67,'[email protected]')
 print status
 print msg
 
+status, msg = client.asm_suppressions.post(60, ['[email protected]', '[email protected]'])
+print status
+print msg
 
 status, msg = client.asm_suppressions.get(None,'[email protected]')
 print status

sendgrid/client.py

@@ -14,6 +14,7 @@
 from .resources.api_keys import APIKeys
 from .resources.asm_groups import ASMGroups
 from .resources.asm_suppressions import ASMSuppressions
+from .resources.asm_global_suppressions import ASMGlobalSuppressions
 
 class SendGridAPIClient(object):
 
@@ -36,6 +37,7 @@ def __init__(self, apikey, **opts):
         self.apikeys = APIKeys(self)
         self.asm_groups = ASMGroups(self)
         self.asm_suppressions = ASMSuppressions(self)
+        self.asm_global_suppressions = ASMGlobalSuppressions(self)
 
     @property
     def apikey(self):

sendgrid/resources/asm_global_suppressions.py

@@ -0,0 +1,40 @@
+class ASMGlobalSuppressions(object):
+    """Advanced Suppression Manager (ASM) gives your recipients more control over the types of emails they want to receive 
+       by letting them opt out of messages from a certain type of email.
+       
+       Global Suppressions are email addresses that will not receive any emails.
+       """
+    
+    def __init__(self, client, **opts):
+        """
+        Constructs SendGrid ASM suppressions object.
+        
+        See https://sendgrid.com/docs/API_Reference/Web_API_v3/Advanced_Suppression_Manager/index.html and
+        https://sendgrid.com/docs/API_Reference/Web_API_v3/Suppression_Management/global_suppressions.html
+        """
+        self._name = None
+        self._base_endpoint = "/v3/asm/suppressions/global"
+        self._endpoint = "/v3/asm/suppressions/global"
+        self._client = client
+
+    @property
+    def base_endpoint(self):
+        return self._base_endpoint
+
+    @property
+    def endpoint(self):
+        endpoint = self._endpoint
+        return endpoint
+
+    @endpoint.setter
+    def endpoint(self, value):
+        self._endpoint = value
+
+    @property
+    def client(self):
+        return self._client
+        
+    # Determine if an email belongs to the global suppression group
+    def get(self, email=None):
+        self._endpoint = self._base_endpoint + '/' + email
+        return self.client.get(self)

test/test_asm_global_suppressions.py

@@ -0,0 +1,34 @@
+from .base_test import BaseTest, MockSendGridAPIClientRequest
+import os
+try:
+    import unittest2 as unittest
+except ImportError:
+    import unittest
+try:
+    from StringIO import StringIO
+except ImportError:  # Python 3
+    from io import StringIO
+
+import sendgrid
+from sendgrid.client import SendGridAPIClient
+from sendgrid.version import __version__
+
+SG_KEY  = os.getenv('SG_KEY') or 'SENDGRID_APIKEY'
+
+class TestASMGroups(unittest.TestCase):
+    def setUp(self):
+        SendGridAPIClient = MockSendGridAPIClientRequest
+        self.client = SendGridAPIClient(SG_KEY)
+        
+    def test_asm_global_suppressions_init(self):
+        self.asm_global_suppressions = self.client.asm_global_suppressions
+        self.assertEqual(self.asm_global_suppressions.base_endpoint, "/v3/asm/suppressions/global")
+        self.assertEqual(self.asm_global_suppressions.endpoint, "/v3/asm/suppressions/global")
+        self.assertEqual(self.asm_global_suppressions.client, self.client)
+
+    def test_asm_suppressions_get(self):
+        status, msg = self.client.asm_global_suppressions.get('[email protected]')
+        self.assertEqual(status, 200)
+
+if __name__ == '__main__':
+    unittest.main()