feat: geolocation setter in sendgrid-python for GDPR compliance

Author: manisha1997

examples/dataresidency/set_region.py

@@ -5,7 +5,6 @@
 
 # Example 1
 # setting region to be "global"
-# sg = sendgrid.SendGridAPIClient(api_key=os.environ.get('SENDGRID_API_KEY'))
 
 sg = sendgrid.SendGridAPIClient(api_key=os.environ.get('SENDGRID_API_KEY'))
 sg.set_data_residency("global")

sendgrid/base_interface.py

@@ -25,10 +25,13 @@ def __init__(self, auth, host, impersonate_subuser, region='global'):
         """
         from . import __version__
         self.auth = auth
-        self.host = host
         self.impersonate_subuser = impersonate_subuser
         self.version = __version__
         self.useragent = 'sendgrid/{};python'.format(self.version)
+        if region is None:
+            self.host = host
+        else:
+            self.set_data_residency(region=region)
 
         self.client = python_http_client.Client(
             host=self.host,
@@ -64,30 +67,29 @@ def send(self, message):
 
         return self.client.mail.send.post(request_body=message)
 
-    def set_host(self,host):
+    def set_host(self, host):
         self.host = host
         self.client = python_http_client.Client(
             host=self.host,
             request_headers=self._default_headers,
             version=3)
 
-    def set_data_residency(self,region):
+    def set_data_residency(self, region):
         """
-        * Client libraries contain setters for specifying region/edge.
-        * This allows support global and eu regions only. This set will likely expand in the future.
-        * Global should be the default
-        * Global region means the message should be sent through:
-        * HTTP: api.sendgrid.com
-        * EU region means the message should be sent through:
-        * HTTP: api.eu.sendgrid.com
+        Client libraries contain setters for specifying region/edge.
+        This supports global and eu regions only. This set will likely expand in the future.
+        Global is the default residency (or region)
+        Global region means the message will be sent through https://api.sendgrid.com
+        EU region means the message will be sent through https://api.eu.sendgrid.com
         :param region:
         :return:
         """
         if region in region_host_dict.keys():
             self.host = region_host_dict[region]
-            self.client = python_http_client.Client(
-                host=self.host,
-                request_headers=self._default_headers,
-                version=3)
+            if self._default_headers is not None:
+                self.client = python_http_client.Client(
+                    host=self.host,
+                    request_headers=self._default_headers,
+                    version=3)
         else:
             raise ValueError("region can only be \"eu\" or \"global\"")

sendgrid/sendgrid.py

@@ -33,7 +33,7 @@ def __init__(
             self,
             api_key=None,
             host='https://api.sendgrid.com',
-            region='global',
+            region=None,
             impersonate_subuser=None):
         """
         Construct the Twilio SendGrid v3 API object.

test/unit/test_sendgrid.py

@@ -40,4 +40,8 @@ def test_with_region_is_none(self):
     def test_with_region_is_invalid(self):
         sg = sendgrid.SendGridAPIClient(api_key='MY_API_KEY')
         with self.assertRaises(ValueError):
-            sg.set_data_residency("abc")
+            sg.set_data_residency("abc")
+
+    def test_host_with_both_host_and_region_in_constructor(self):
+        sg = sendgrid.SendGridAPIClient(api_key='MY_API_KEY',host="https://example.com",region="eu")
+        self.assertEqual("https://api.eu.sendgrid.com",sg.client.host)