[TOOLSLIBS-2831] Adds support for arbitrary base_url (#210)

* adds support for arbitrary base_url

* adds tests for urls

Author: aschuman0

tests/client/test_urls.py

@@ -0,0 +1,39 @@
+import unittest
+
+from urbanairship.urls import Urls
+
+
+class TestAirshipUrls(unittest.TestCase):
+    def setUp(self):
+        self.test_url = "https://something.tld"
+        return super().setUp()
+
+    def test_no_location(self):
+        urls = Urls()
+        # use of apid_url is arbitrary
+        self.assertIn("urbanairship.com", urls.apid_url)
+
+    def test_no_location_oauth(self):
+        urls = Urls(oauth_base=True)
+        self.assertIn("asnapius.com", urls.apid_url)
+
+    def test_us_location(self):
+        urls = Urls(location="us")
+        self.assertIn("urbanairship.com", urls.apid_url)
+
+    def test_us_location_oauth(self):
+        urls = Urls(location="us", oauth_base=True)
+        self.assertIn("asnapius.com", urls.apid_url)
+
+    def test_eu_location(self):
+        urls = Urls(location="eu")
+        self.assertIn("airship.eu", urls.apid_url)
+
+    def test_eu_location_oauth(self):
+        urls = Urls(location="eu", oauth_base=True)
+        self.assertIn("asnapieu.com", urls.apid_url)
+
+    def test_base_url(self):
+        urls = Urls(base_url=self.test_url)
+        self.assertEqual(urls.base_url, self.test_url)
+        self.assertIn(self.test_url, urls.apid_url)

urbanairship/client.py

@@ -32,6 +32,8 @@ class BaseClient:
         May be 'us' or 'eu'. Defaults to 'us'.
     :param timeout: [optional]  An integer specifying the number of seconds used
         for a response timeout threshold
+    :param base_url: [optional] A string defining an arbitrary base_url to use
+        for requests to the Airship API. To be used in place of location.
     :param retries: [optional] An integer specifying the number of times to retry a
         failed request. Retried requests use exponential backoff between requests.
         Defaults to 0, no retry.
@@ -43,12 +45,14 @@ def __init__(
         location: str = "us",
         timeout: int = DEFAULT_REQ_TIMEOUT_S,
         retries: int = 0,
+        base_url: Optional[str] = None,
     ) -> None:
         self.key = key
         self.location = location
         self.timeout = timeout
         self.retries = retries
-        self.urls: Urls = Urls(self.location)
+        self.base_url = base_url
+        self.urls: Urls = Urls(location=self.location, base_url=self.base_url)
         self.session = requests.Session()
 
     @property

urbanairship/core.py

@@ -25,6 +25,7 @@ def __init__(
         token: Optional[str] = None,
         location: str = "us",
         timeout: Optional[int] = None,
+        base_url: Optional[str] = None,
         retries: int = 0,
     ):
         """Main client class for interacting with the Airship API.
@@ -37,14 +38,16 @@ def __init__(
         with. Possible values: 'us', 'eu'. Defaults to 'us'.
         :param: timeout: [optional] An integer specifying the number of seconds used
         for a response timeout threshold
+        :param base_url: [optional] A string defining an arbitrary base_url to use
+        for requests to the Airship API. To be used in place of location.
         :param retries: [optional] An integer specifying the number of times to retry a
         failed request. Retried requests use exponential backoff between requests.
         Defaults to 0, no retry.
         """
         warnings.warn(
             category=DeprecationWarning,
             message="The Airship client class is deprecated. Use a client class from \
-                the client module. This class will be removed in version 7.0",
+                the client module. This class will be removed in version 8.0",
         )
 
         self.key: str = key
@@ -53,7 +56,7 @@ def __init__(
         self.location: str = location
         self.timeout: Optional[int] = timeout
         self.retries = retries
-        self.urls: Urls = Urls(self.location)
+        self.urls: Urls = Urls(location=self.location, base_url=base_url)
 
         if all([secret, token]):
             raise ValueError("One of token or secret must be used, not both")

urbanairship/urls.py

@@ -3,9 +3,14 @@
 
 class Urls:
     def __init__(
-        self, location: Optional[str] = None, oauth_base: bool = False
+        self,
+        location: Optional[str] = None,
+        base_url: Optional[str] = None,
+        oauth_base: bool = False,
     ) -> None:
-        if not location or location.lower() == "us":
+        if base_url:
+            self.base_url = base_url
+        elif not location or location.lower() == "us":
             if oauth_base:
                 self.base_url = "https://api.asnapius.com/api/"
             else: