switch-api 0.6.28__tar.gz → 0.6.29__tar.gz

{switch_api-0.6.28 → switch_api-0.6.29}/HISTORY.md

@@ -1,5 +1,17 @@
 # History
 
+#0.6.29
+
+### Changed
+
+In the `authentication` module:
+
+- Added optional `data_center` support to `initialize()`, with `AU` and `US` as the supported values.
+- Authentication login-context and user-profile requests now use the endpoint associated with the selected data center.
+- Interactive production authentication now uses the B2C authority associated with the portfolio's resolved data center (`AustraliaEast` or `CentralUs`).
+- When `data_center` is omitted, authentication defaults to `US` and logs a warning to preserve backward compatibility.
+- Invalid data-center values now raise a `ValueError` with the supported options.
+
 #0.6.18
 ### Changed
 In the `realtime` module:

{switch_api-0.6.28 → switch_api-0.6.29}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: switch_api
-Version: 0.6.28
+Version: 0.6.29
 Summary: A complete package for data ingestion into the Switch Automation Platform.
 Author: Switch Automation Pty Ltd.
 License: MIT License
@@ -58,6 +58,18 @@ pip install switch_api
 
 # History
 
+#0.6.29
+
+### Changed
+
+In the `authentication` module:
+
+- Added optional `data_center` support to `initialize()`, with `AU` and `US` as the supported values.
+- Authentication login-context and user-profile requests now use the endpoint associated with the selected data center.
+- Interactive production authentication now uses the B2C authority associated with the portfolio's resolved data center (`AustraliaEast` or `CentralUs`).
+- When `data_center` is omitted, authentication defaults to `US` and logs a warning to preserve backward compatibility.
+- Invalid data-center values now raise a `ValueError` with the supported options.
+
 #0.6.18
 ### Changed
 In the `realtime` module:

{switch_api-0.6.28 → switch_api-0.6.29}/setup.py

@@ -16,7 +16,7 @@ setup(
     long_description_content_type='text/markdown',
     license='MIT License',
     name="switch_api",
-    version="0.6.28",
+    version="0.6.29",
     packages=find_packages(include=["switch_api", "switch_api.*"]),
     install_requires=['pandas==1.5.3', 'requests', 'azure-storage-blob', 'pandera[io]==0.7.1', 'azure-servicebus',
                       'msal>=1.11.0', 'paho-mqtt==1.6.1', 'uvicorn==0.22.0', 'fastapi==0.98.0', 'pyodbc==4.0.39', 'cachetools==5.5.0', 

{switch_api-0.6.28 → switch_api-0.6.29}/switch_api/__init__.py

@@ -44,4 +44,4 @@ from . import _guide
 # log.addHandler(_ch)
 # https://dev.to/joaomcteixeira/setting-up-python-logging-for-a-library-app-6ml
 
-__version__ = "0.6.28"
+__version__ = "0.6.29"

{switch_api-0.6.28 → switch_api-0.6.29}/switch_api/_authentication/_authentication.py

@@ -5,13 +5,14 @@
 # --------------------------------------------------------------------------
 import logging
 import sys
+from typing import Optional
 from uuid import UUID
 from msal.oauth2cli.oidc import decode_id_token
 import requests
 from ._credentials_store._credentials_store import SwitchCredentials, store_credentials
 from ._credentials_store._credentials_store import read_credentials
 from ._msal._custom_application import CustomPublicClientApplication
-from .._utils._constants import AUTH_ENDPOINT_DEV, AUTH_ENDPOINT_PROD, SWITCH_ENVIRONMENT
+from .._utils._constants import AUTH_ENDPOINTS, DATA_CENTER, SWITCH_ENVIRONMENT
 
 logger = logging.getLogger(__name__)
 logger.setLevel(logging.DEBUG)
@@ -30,8 +31,14 @@ _authority = {
         "base_url": "https://switchdevb2c.b2clogin.com/switchdevb2c.onmicrosoft.com",
     },
     "prod": {
-        "base_url": "https://switchautomation.b2clogin.com/switchautomation.onmicrosoft.com",
-        "uitemplateid": "default"
+        "AustraliaEast": {
+            "base_url": "https://switchautomationapac.b2clogin.com/7d5aa686-9840-42a5-9334-084b75385e24",
+            "uitemplateid": "default"
+        },
+        "CentralUs": {
+            "base_url": "https://switchautomation.b2clogin.com/switchautomation.onmicrosoft.com",
+            "uitemplateid": "default"
+        }
     }
 }
 
@@ -69,7 +76,17 @@ def _validate_credentials(creds: SwitchCredentials, version: str):
         return False
 
 
-def get_switch_credentials(environment: SWITCH_ENVIRONMENT, portfolio_id, port: int):
+def _resolve_data_center(data_center: Optional[DATA_CENTER]) -> DATA_CENTER:
+    if data_center is None:
+        logger.warning('No data center was provided. Defaulting to US.')
+        return 'US'
+    if data_center not in AUTH_ENDPOINTS:
+        raise ValueError("data_center must be either 'AU' or 'US'.")
+    return data_center
+
+
+def get_switch_credentials(environment: SWITCH_ENVIRONMENT, portfolio_id, port: int,
+                           data_center: Optional[DATA_CENTER] = None):
     """Read Credentials
 
     Reads credentials from credential store
@@ -82,6 +99,8 @@ def get_switch_credentials(environment: SWITCH_ENVIRONMENT, portfolio_id, port:
         Get credentials for the given portfolio id
     port: int
         Port used for instantiating local server for authentication
+    data_center
+        Data center hosting the portfolio. Defaults to US with a warning when omitted.
 
     Returns
     -------
@@ -90,8 +109,9 @@ def get_switch_credentials(environment: SWITCH_ENVIRONMENT, portfolio_id, port:
 
     """
 
+    data_center = _resolve_data_center(data_center)
     login_context = fetch_login_context(
-        environment=environment, api_project_id=portfolio_id)[1]
+        environment=environment, api_project_id=portfolio_id, data_center=data_center)[1]
 
     # Fetch from credentials store if it's already been cached
     iot_endpoint = 'https://realtime-au.switchautomation.com/iot'
@@ -109,11 +129,11 @@ def get_switch_credentials(environment: SWITCH_ENVIRONMENT, portfolio_id, port:
 
     # Credentials do not exist, take user through browser auth journey
     config_env = 'dev' if environment == 'Development' else 'prod'
-    authority = f"{_authority[config_env]['base_url']}/{login_context['policyName']}"
+    authority = f"{_authority[config_env][datacenter]['base_url']}/{login_context['policyName']}"
     app = CustomPublicClientApplication(
         login_context['applicationId'], authority=authority)
 
-    uitemplateid = _authority[config_env]['uitemplateid']
+    uitemplateid = _authority[config_env][datacenter]['uitemplateid']
     prompt = login_context['prompt'] if login_context['prompt'] != '' else None
     auth_response = app.acquire_token_interactive_custom(scopes=[], prompt=prompt, port=port,
                                                          auth_params={
@@ -127,9 +147,8 @@ def get_switch_credentials(environment: SWITCH_ENVIRONMENT, portfolio_id, port:
 
     id_token = auth_response['id_token']
 
-    api_base_url = AUTH_ENDPOINT_DEV if environment == 'Development' else AUTH_ENDPOINT_PROD
     _, profile = fetch_user_profile_details(
-        api_base_url, id_token, environment, portfolio_id)
+        id_token, environment, portfolio_id, data_center)
 
     if profile is None:
         raise Exception(
@@ -145,20 +164,21 @@ def get_switch_credentials(environment: SWITCH_ENVIRONMENT, portfolio_id, port:
     return credentials
 
 
-def fetch_user_profile_details(api_base_url: str, token: str, environment: SWITCH_ENVIRONMENT, api_project_id: UUID):
+def fetch_user_profile_details(token: str, environment: SWITCH_ENVIRONMENT, api_project_id: UUID,
+                               data_center: Optional[DATA_CENTER] = None):
     """
     Fetch User Profile details with respect to the given environment and portfolio
 
     Parameters
     ----------
-    api_base_url
-        User Profile base url
     token
         Switch token for authentication
     environment
         Either development or production environment
     api_project_id
         Get UserProfile with respect to this portfolio id
+    data_center
+        Data center hosting the portfolio. Allowed values are AU and US. Defaults to US with a warning when omitted.
 
     Returns
     -------
@@ -166,6 +186,9 @@ def fetch_user_profile_details(api_base_url: str, token: str, environment: SWITC
         Returns the User Profile details containing information to call Switch APIs
     """
 
+    data_center = _resolve_data_center(data_center)
+    api_base_url = AUTH_ENDPOINTS[data_center]
+
     payload = {}
     headers = {
         'Content-Type': 'application/json; charset=utf-8',
@@ -188,7 +211,8 @@ def fetch_user_profile_details(api_base_url: str, token: str, environment: SWITC
     return response_status, response.json()
 
 
-def fetch_login_context(environment: SWITCH_ENVIRONMENT, api_project_id: UUID):
+def fetch_login_context(environment: SWITCH_ENVIRONMENT, api_project_id: UUID,
+                        data_center: Optional[DATA_CENTER] = None):
     """
     Fetches login context to assist SSO with Switch Platform
 
@@ -198,6 +222,8 @@ def fetch_login_context(environment: SWITCH_ENVIRONMENT, api_project_id: UUID):
         Either development or production environment
     api_project_id
         Get UserProfile with respect to this portfolio id
+    data_center
+        Data center hosting the portfolio. Allowed values are AU and US. Defaults to US with a warning when omitted.
 
     Returns
     -------
@@ -205,7 +231,8 @@ def fetch_login_context(environment: SWITCH_ENVIRONMENT, api_project_id: UUID):
         Returns the Login Context containing information to authenticate with Switch
     """
 
-    base_url = AUTH_ENDPOINT_DEV if environment == 'Development' else AUTH_ENDPOINT_PROD
+    data_center = _resolve_data_center(data_center)
+    base_url = AUTH_ENDPOINTS[data_center]
 
     payload = {}
     headers = {

{switch_api-0.6.28 → switch_api-0.6.29}/switch_api/_utils/_constants.py

@@ -10,8 +10,9 @@ is not directly referenced by end users.
 from typing import Literal
 __all__ = ['api_prefix', 'argus_prefix', 'DATETIME_COL_FMT', 'DEPLOY_TYPE', 'EXPECTED_DELIVERY', 'WORK_ORDER_PRIORITY',
            'WORK_ORDER_STATUS', 'WORK_ORDER_CATEGORY', 'ERROR_TYPE', 'MAPPING_ENTITIES', 'QUEUE_NAME', 'QUERY_LANGUAGE',
-           'ACCOUNT', 'PROCESS_STATUS', 'AUTH_ENDPOINT_DEV', 'AUTH_ENDPOINT_PROD', 'SCHEDULE_TIMEZONE',
-           'SWITCH_ENVIRONMENT', 'INTEGRATION_SETTINGS_EDITORS', 'DATA_INGESTION_CONTAINER', 'CACHE_SCOPE', 'TAG_LEVEL']
+           'ACCOUNT', 'PROCESS_STATUS', 'AUTH_ENDPOINTS', 'SCHEDULE_TIMEZONE',
+           'SWITCH_ENVIRONMENT', 'DATA_CENTER', 'INTEGRATION_SETTINGS_EDITORS', 'DATA_INGESTION_CONTAINER',
+           'CACHE_SCOPE', 'TAG_LEVEL']
 
 # @deprecated suggestion: Up for deprecation as this is not used anymore in the API
 # api_prefix = "http://localhost:7071/api/SwitchApi/"
@@ -21,8 +22,10 @@ api_prefix = "https://pivotstreams.azurewebsites.net/api/SwitchApi/"
 # argus_prefix = "http://localhost:7071/api/"
 argus_prefix = "https://arguslogicv4b.azurewebsites.net/api/"
 
-AUTH_ENDPOINT_DEV = "https://restapi-dev.switchautomation.com/auth"
-AUTH_ENDPOINT_PROD = "https://restapi-us.switchautomation.com/auth"
+AUTH_ENDPOINTS = {
+    'AU': 'https://restapi-ae.switchautomation.com/auth',
+    'US': 'https://restapi-us.switchautomation.com/auth'
+}
 
 DATETIME_COL_FMT = Literal['DateTime', 'Date', 'Time']
 
@@ -68,6 +71,8 @@ SCHEDULE_TIMEZONE = Literal['Local', 'Utc']
 
 SWITCH_ENVIRONMENT = Literal['Development', 'Staging', 'Testing', 'Production']
 
+DATA_CENTER = Literal['AU', 'US']
+
 SUPPORT_PAYLOAD_TYPE = Literal['Sites', 'Sensors', 'Portfolio']
 
 INTEGRATION_SETTINGS_EDITORS = Literal['text_box', 'numeric_stepper', 'custom_combo', 'tag_groups_combo',
@@ -101,4 +106,4 @@ WS_DEFAULT_PORT = 443
 WS_MQTT_CONNECTION_TIMEOUT = 180
 WS_MQTT_DEFAULT_MAX_TIMEOUT = 180
 WS_MQTT_WAIT_TIME_INTERVAL = 0.1
-WS_MQTT_MESSAGE_WAIT_TIME_INTERVAL = 0.1
+WS_MQTT_MESSAGE_WAIT_TIME_INTERVAL = 0.1

{switch_api-0.6.28 → switch_api-0.6.29}/switch_api/initialize.py

@@ -6,10 +6,11 @@
 import sys
 import uuid
 import logging
+from typing import Optional
 
 from ._authentication._authentication import get_switch_credentials
 from ._utils._utils import ApiInputs, ApiHeaders
-from ._utils._constants import SWITCH_ENVIRONMENT
+from ._utils._constants import DATA_CENTER, SWITCH_ENVIRONMENT
 
 logger = logging.getLogger(__name__)
 logger.setLevel(logging.DEBUG)
@@ -23,7 +24,8 @@ formatter = logging.Formatter('%(asctime)s  switch_api.%(module)s.%(funcName)s
 consoleHandler.setFormatter(formatter)
 
 
-def initialize(api_project_id: uuid.UUID, environment: SWITCH_ENVIRONMENT = 'Production', custom_port: int = 51796) -> ApiInputs:
+def initialize(api_project_id: uuid.UUID, environment: SWITCH_ENVIRONMENT = 'Production', custom_port: int = 51796,
+               data_center: Optional[DATA_CENTER] = None) -> ApiInputs:
     """
     Initialize session with API when running scripts on your local machine.
 
@@ -35,6 +37,8 @@ def initialize(api_project_id: uuid.UUID, environment: SWITCH_ENVIRONMENT = 'Pro
         (Optional) The Switch API environment to interact with
     custom_port: int
         (Optional) Custom network port to initialize instance of the server when authenticating
+    data_center: DATA_CENTER
+        (Optional) Data center hosting the portfolio. Defaults to US with a warning when omitted.
 
     Returns
     -------
@@ -48,7 +52,7 @@ def initialize(api_project_id: uuid.UUID, environment: SWITCH_ENVIRONMENT = 'Pro
             f"Invalid value provided '{api_project_id}'- please provide a valid api_project_id. ")
         return False
 
-    creds = get_switch_credentials(environment, api_project_id, custom_port)
+    creds = get_switch_credentials(environment, api_project_id, custom_port, data_center)
 
     logger.info("Successfully initialized.")
     api_base_url = f"https://{creds.api_endpoint}/api/1.0"

{switch_api-0.6.28 → switch_api-0.6.29}/switch_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: switch_api
-Version: 0.6.28
+Version: 0.6.29
 Summary: A complete package for data ingestion into the Switch Automation Platform.
 Author: Switch Automation Pty Ltd.
 License: MIT License
@@ -58,6 +58,18 @@ pip install switch_api
 
 # History
 
+#0.6.29
+
+### Changed
+
+In the `authentication` module:
+
+- Added optional `data_center` support to `initialize()`, with `AU` and `US` as the supported values.
+- Authentication login-context and user-profile requests now use the endpoint associated with the selected data center.
+- Interactive production authentication now uses the B2C authority associated with the portfolio's resolved data center (`AustraliaEast` or `CentralUs`).
+- When `data_center` is omitted, authentication defaults to `US` and logs a warning to preserve backward compatibility.
+- Invalid data-center values now raise a `ValueError` with the supported options.
+
 #0.6.18
 ### Changed
 In the `realtime` module:

{switch_api-0.6.28 → switch_api-0.6.29}/switch_api.egg-info/SOURCES.txt

@@ -68,6 +68,7 @@ switch_api/realtime/__init__.py
 switch_api/realtime/_mqtt.py
 switch_api/realtime/_redis.py
 switch_api/realtime/realtime.py
+tests/test_authentication.py
 tests/test_dataset.py
 tests/test_error_handlers.py
 tests/test_initialize.py

switch_api-0.6.29/tests/test_authentication.py

@@ -0,0 +1,57 @@
+import logging
+import unittest
+from unittest.mock import Mock, patch
+from uuid import uuid4
+
+from switch_api._authentication._authentication import fetch_login_context, fetch_user_profile_details
+
+
+class FetchLoginContextTests(unittest.TestCase):
+    @staticmethod
+    def _response():
+        response = Mock(status_code=200, reason='OK', text='{}')
+        response.json.return_value = {}
+        return response
+
+    def test_uses_data_center_host(self):
+        data_centers = {
+            'AU': 'restapi-au.switchautomation.com/auth',
+            'US': 'restapi-us.switchautomation.com/auth',
+        }
+
+        for data_center, expected_host in data_centers.items():
+            with self.subTest(data_center=data_center):
+                with patch('switch_api._authentication._authentication.requests.request',
+                           return_value=self._response()) as request:
+                    fetch_login_context('Production', uuid4(), data_center)
+
+                self.assertTrue(request.call_args.args[1].startswith(
+                    f'https://{expected_host}/login-context?'))
+
+    def test_defaults_to_us_with_warning(self):
+        with patch('switch_api._authentication._authentication.requests.request',
+                   return_value=self._response()) as request:
+            with self.assertLogs(level=logging.WARNING) as logs:
+                fetch_login_context('Production', uuid4())
+
+        self.assertIn('No data center was provided. Defaulting to US.', logs.output[0])
+        self.assertIn('restapi-us.switchautomation.com/auth',
+                      request.call_args.args[1])
+
+    def test_rejects_unknown_data_center(self):
+        with self.assertRaisesRegex(ValueError, "data_center must be either 'AU' or 'US'"):
+            fetch_login_context('Production', uuid4(), 'EU')
+
+    def test_user_profile_uses_data_center_host(self):
+        data_centers = {
+            'AU': 'https://restapi-au.switchautomation.com/auth/user-profile?',
+            'US': 'https://restapi-us.switchautomation.com/auth/user-profile?',
+        }
+
+        for data_center, expected_prefix in data_centers.items():
+            with self.subTest(data_center=data_center):
+                with patch('switch_api._authentication._authentication.requests.request',
+                           return_value=self._response()) as request:
+                    fetch_user_profile_details('token', 'Production', uuid4(), data_center)
+
+                self.assertTrue(request.call_args.args[1].startswith(expected_prefix))