feat: geolocation setter in sendgrid-python for GDPR compliance

Author: manisha1997

examples/dataresidency/set_region.py

@@ -1,5 +1,4 @@
 import sendgrid
-import os
 
 from sendgrid import Email, To, Content, Mail
 

sendgrid/base_interface.py

@@ -1,5 +1,6 @@
 import python_http_client
 
+region_host_dict = {'eu':'https://api.eu.sendgrid.com','global':'https://api.sendgrid.com'}
 
 class BaseInterface(object):
     def __init__(self, auth, host, impersonate_subuser, region='global'):
@@ -27,7 +28,7 @@ def __init__(self, auth, host, impersonate_subuser, region='global'):
         if host is not None and region == 'global':
             self.set_host(host)
         else:
-            self.set_region(region)
+            self.set_data_residency(region)
         self.impersonate_subuser = impersonate_subuser
         self.version = __version__
         self.useragent = 'sendgrid/{};python'.format(self.version)
@@ -69,7 +70,7 @@ def send(self, message):
     def set_host(self,host):
         self.host = host
 
-    def set_region(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.
@@ -81,7 +82,6 @@ def set_region(self,region):
         :param region:
         :return:
         """
-        region_host_dict = {'eu':'https://api.eu.sendgrid.com','global':'https://api.sendgrid.com'}
         if region in region_host_dict.keys():
             self.host = region_host_dict[region]
         else:

test/unit/test_sendgrid.py

@@ -8,23 +8,23 @@ def test_host_with_no_region(self):
 
     def test_host_with_eu_region(self):
         sg = sendgrid.SendGridAPIClient(api_key='MY_API_KEY')
-        sg.set_region("eu")
+        sg.set_data_residency("eu")
         self.assertEqual("https://api.eu.sendgrid.com",sg.host)
 
     def test_host_with_global_region(self):
         sg = sendgrid.SendGridAPIClient(api_key='MY_API_KEY')
-        sg.set_region("global")
+        sg.set_data_residency("global")
         self.assertEqual("https://api.sendgrid.com",sg.host)
 
     def test_host_with_host_first_eu_region_second(self):
         sg = sendgrid.SendGridAPIClient(api_key='MY_API_KEY')
         sg.set_host("https://sendgrid.com")
-        sg.set_region("eu")
+        sg.set_data_residency("eu")
         self.assertEqual("https://api.eu.sendgrid.com",sg.host)
 
     def test_host_with_eu_first_host_second(self):
         sg = sendgrid.SendGridAPIClient(api_key='MY_API_KEY')
-        sg.set_region("eu")
+        sg.set_data_residency("eu")
         sg.set_host("https://sendgrid.com")
         self.assertEqual("https://sendgrid.com",sg.host)
 
@@ -35,9 +35,9 @@ def test_host_using_constructor(self):
     def test_with_region_is_none(self):
         sg = sendgrid.SendGridAPIClient(api_key='MY_API_KEY')
         with self.assertRaises(ValueError):
-            sg.set_region("")
+            sg.set_data_residency(None)
 
-    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_region("abc")
+            sg.set_data_residency("abc")