Merge pull request #21 from notificationapi-com/IJetJhKv/2974-not-all-send-code-samples-change-for-the-eu-region

Update SDK to work with CA, EU and US (default) regions

Author: GreyNewfie

notificationapi_python_server_sdk/__init__.py

@@ -2,4 +2,9 @@
 
 __author__ = """Sahand Seifi"""
 __email__ = "[email protected]"
-__version__ = "1.2.0"
+__version__ = "2.0.0"
+
+# Region constants
+US_REGION = "https://api.notificationapi.com"
+EU_REGION = "https://api.eu.notificationapi.com"
+CA_REGION = "https://api.ca.notificationapi.com"

notificationapi_python_server_sdk/notificationapi.py

@@ -3,12 +3,14 @@
 import hashlib
 import base64
 import urllib.parse
+from . import US_REGION
 
 __client_id = ""
 __client_secret = ""
+__base_url = US_REGION
 
 
-def init(client_id, client_secret):
+def init(client_id, client_secret, base_url=None):
     if not client_id:
         raise Exception("Bad client_id")
 
@@ -19,10 +21,15 @@ def init(client_id, client_secret):
     __client_id = client_id
     global __client_secret
     __client_secret = client_secret
+    global __base_url
+    if base_url:
+        __base_url = base_url
+    else:
+        __base_url = US_REGION
 
 
 async def request(method, uri, data=None, custom_auth=None, queryStrings=None):
-    api_url = "https://api.notificationapi.com/" + __client_id + "/" + uri
+    api_url = f"{__base_url}/{__client_id}/{uri}"
 
     headers = {}
     if custom_auth:
@@ -46,6 +53,7 @@ async def request(method, uri, data=None, custom_auth=None, queryStrings=None):
             response.text,
             data,
         )
+    return response
 
 
 async def send(params):

setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 1.2.0
+current_version = 2.0.0
 commit = True
 tag = True
 
@@ -23,4 +23,3 @@ test = pytest
 
 [tool:pytest]
 collect_ignore = ['setup.py']
-

setup.py

@@ -52,6 +52,6 @@
     test_suite="tests",
     tests_require=test_requirements,
     url="https://github.com/notificationapi-com/notificationapi_python_server_sdk",
-    version="1.2.0",
+    version="2.0.0",
     zip_safe=False,
 )

tests/test_notificationapi_regions.py

@@ -0,0 +1,39 @@
+#!/usr/bin/env python
+
+"""Tests for region support in `notificationapi_python_server_sdk` package."""
+
+import pytest
+import httpx
+from notificationapi_python_server_sdk import notificationapi, US_REGION, EU_REGION, CA_REGION
+
+client_id = "client_id"
+client_secret = "client_secret"
+
+
+def test_init_with_default_region():
+    notificationapi.init(client_id, client_secret)
+    # Access the private variable directly - it's defined at module level
+    assert notificationapi.__base_url == US_REGION
+
+
+def test_init_with_eu_region():
+    notificationapi.init(client_id, client_secret, EU_REGION)
+    assert notificationapi.__base_url == EU_REGION
+
+
+def test_init_with_ca_region():
+    notificationapi.init(client_id, client_secret, CA_REGION)
+    assert notificationapi.__base_url == CA_REGION
+
+
+@pytest.mark.asyncio
+async def test_request_uses_correct_region_url(respx_mock):
+    # Test with EU region
+    eu_api_url = f"{EU_REGION}/{client_id}/sender"
+    route = respx_mock.post(eu_api_url).mock(return_value=httpx.Response(200))
+
+    notificationapi.init(client_id, client_secret, EU_REGION)
+    await notificationapi.send({"notificationId": "test", "user": {"id": "user1"}})
+
+    assert route.called
+    assert route.calls.last.request.url == eu_api_url

tests/test_notificationapi_send.py

@@ -5,7 +5,7 @@
 import pytest
 import json
 from httpx import Response
-from notificationapi_python_server_sdk import notificationapi
+from notificationapi_python_server_sdk import notificationapi, US_REGION
 
 client_id = "client_id"
 client_secret = "client_secret"
@@ -17,7 +17,7 @@
 userId = "userId"
 notification_id = "notification_id"
 api_paths = {
-    "send": f"https://api.notificationapi.com/{client_id}/sender",
+    "send": f"{US_REGION}/{client_id}/sender",
 }