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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: switch_api
-Version: 0.6.26
+Version: 0.6.28
 Summary: A complete package for data ingestion into the Switch Automation Platform.
 Author: Switch Automation Pty Ltd.
 License: MIT License

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

@@ -16,7 +16,7 @@ setup(
     long_description_content_type='text/markdown',
     license='MIT License',
     name="switch_api",
-    version="0.6.26",
+    version="0.6.28",
     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.26 → switch_api-0.6.28}/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.26"
+__version__ = "0.6.28"

{switch_api-0.6.26 → switch_api-0.6.28}/switch_api/_utils/_mqtt.py

@@ -17,7 +17,7 @@ global _control_ws_port
 global _control_ws_username
 global _control_ws_password
 global _control_ws_max_timeout
-global _control_ws_ssl_pwd
+global _control_ws_ca_certs
 
 _control_api_endpoint = ''
 _control_ws_host = ''
@@ -25,7 +25,7 @@ _control_ws_port = WS_DEFAULT_PORT
 _control_ws_username = ''
 _control_ws_password = ''
 _control_ws_max_timeout = WS_MQTT_DEFAULT_MAX_TIMEOUT
-_control_ws_ssl_pwd = ''
+_control_ws_ca_certs = ''
 
 def get_control_config():
     """
@@ -53,10 +53,10 @@ def get_control_config():
             Username for MQTT authentication.
         - password : str
             Password for MQTT authentication.
-        - ssl_pwd : str
-            Password for SSL authentication.
         - max_timeout : int
             Maximum timeout (in seconds) for control operations.
+        - ca_certs : str (optional)
+            A string path to the Certificate Authority certificate files in Server
     """
     return {
         "api_endpoint": _control_api_endpoint,
@@ -64,13 +64,19 @@ def get_control_config():
         "ws_port": _control_ws_port,
         "username": _control_ws_username,
         "password": _control_ws_password,
-        "ssl_pwd": _control_ws_ssl_pwd,
         "max_timeout": _control_ws_max_timeout,
+        "ca_certs": _control_ws_ca_certs
     }
 
 
-def set_mqtt_broker_config(api_endpoint: str, ws_host: str, user_name: str, password: str, ws_ssl_pwd: str,
-                          ws_port: int = WS_DEFAULT_PORT, max_timeout: int = WS_MQTT_DEFAULT_MAX_TIMEOUT, bypass_username_password: bool = False):
+def set_mqtt_broker_config(api_endpoint: str, 
+                           ws_host: str, 
+                           user_name: str, 
+                           password: str,
+                           ws_port: int = WS_DEFAULT_PORT, 
+                           max_timeout: int = WS_MQTT_DEFAULT_MAX_TIMEOUT, 
+                           ca_certs: str = None, 
+                           bypass_username_password: bool = False):
     """Set Control Variables
 
     Set Control Variables needed to enable control request to MQTT Broker when running locally.
@@ -98,17 +104,17 @@ def set_mqtt_broker_config(api_endpoint: str, ws_host: str, user_name: str, pass
     global _control_ws_username
     global _control_ws_password
     global _control_ws_max_timeout
-    global _control_ws_ssl_pwd
+    global _control_ws_ca_certs
 
     # Check if endpoint is a valid URL
     if not api_endpoint.startswith('https://'):
         raise ValueError(
             "Invalid IoT API Endpoint. The IoT host should start with 'https://'.")
 
-    # # Check if host is a valid URL
-    # if not ws_host.startswith('wss://'):
-    #     raise ValueError(
-    #         "Invalid IoT Websocket MQTT Host. The IoT host should start with 'wss://'.")
+    # Check if host is a valid URL
+    if not ws_host.startswith('wss://'):
+        raise ValueError(
+            "Invalid IoT Websocket MQTT Host. The IoT host should start with 'wss://'.")
 
     # Check if user_name and password are not empty
     if not bypass_username_password:
@@ -127,5 +133,5 @@ def set_mqtt_broker_config(api_endpoint: str, ws_host: str, user_name: str, pass
     _control_ws_port = ws_port
     _control_ws_username = user_name
     _control_ws_password = password
-    _control_ws_ssl_pwd = ws_ssl_pwd
-    _control_ws_max_timeout = max_timeout
+    _control_ws_max_timeout = max_timeout
+    _control_ws_ca_certs = ca_certs

{switch_api-0.6.26 → switch_api-0.6.28}/switch_api/integration/_utils.py

@@ -201,7 +201,7 @@ def _timezone_dst_offsets(api_inputs: ApiInputs, date_from: datetime.date, date_
         else:
             return timezone_offsets
     except Exception as ex:
-        logger.error("API Call was not successful.", ex)
+        logger.error("API Call was not successful. %s", ex)
         return pandas.DataFrame()
 
 def _upsert_entities_affected_count(api_inputs: ApiInputs, entities_affected_count: int):

{switch_api-0.6.26 → switch_api-0.6.28}/switch_api/realtime/_mqtt.py

@@ -44,10 +44,10 @@ class SwitchRealtime:
         port: int,
         username: str,
         password: str,
-        ssl_pwd: str,
         client_id: str,
         email: str, 
-        project_id: str
+        project_id: str,
+        ca_certs: str = None
     ):
         self.host = host
         self.port = port
@@ -57,23 +57,18 @@ class SwitchRealtime:
 
         self.client_id = client_id
         self.client = mqtt.Client(client_id=client_id, transport='websockets', clean_session=True)
-        # self.client.tls_set()
-
-        # -- adhoc for cds engine server --
-        self.client.ws_set_options(path="/mqtt")
-        # self.client.tls_set(
-        #     ca_certs=certifi.where(),
-        #     cert_reqs=ssl.CERT_REQUIRED,
-        #     tls_version=ssl.PROTOCOL_TLS_CLIENT,
-        # )
-        self.client.tls_set(
-            ca_certs='/usr/share/ca-certificates/mozilla/Go_Daddy_Root_Certificate_Authority_-_G2.crt',
-            cert_reqs=ssl.CERT_REQUIRED,
-            tls_version=ssl.PROTOCOL_TLS_CLIENT,
-        )
-        self.client.tls_insecure_set(False)
-        logger.info("certifi CA bundle: %s", certifi.where())
-        # -- adhoc for cds engine server --
+
+        if ca_certs:
+            # -- adhoc for cds engine server --
+            self.client.ws_set_options(path="/mqtt")
+            self.client.tls_set(
+                ca_certs=ca_certs,
+                cert_reqs=ssl.CERT_REQUIRED,
+                tls_version=ssl.PROTOCOL_TLS_CLIENT,
+            )
+            self.client.tls_insecure_set(False)
+        else:
+            self.client.tls_set()
 
         if username and password:
             self.client.username_pw_set(username, password)

{switch_api-0.6.26 → switch_api-0.6.28}/switch_api/realtime/_redis.py

@@ -102,6 +102,7 @@ def set_realtime_redis_config(
     retry_max_delay: float = 0.05,
     socket_timeout: int = None,
     socket_connect_timeout: int = None,
+    ca_cert: str = None
 ):
     """
     Configure Redis state storage for realtime MQTT dataset updates.
@@ -199,6 +200,8 @@ def set_realtime_redis_config(
     socket_connect_timeout : int, optional
         Redis socket connection timeout in seconds.
         Defaults to None.
+    ca_cert: str, optional
+        A string path to the Certificate Authority certificate files in Server
 
     Returns
     -------
@@ -255,14 +258,23 @@ def set_realtime_redis_config(
         "retry_max_delay": retry_max_delay,
         "socket_timeout": socket_timeout,
         "socket_connect_timeout": socket_connect_timeout,
+        "ca_cert": ca_cert
     }
     _redis_client = None
-    logger.info(
-        f"Configured Redis realtime state. host={host}, port={port}, "
-        f"ssl={ssl}, db={db}, key_prefix={key_prefix}, "
-        f"max_retries={max_retries}, timeout_max_retries={timeout_max_retries}, "
-        f"retry_min_delay={retry_min_delay}, retry_max_delay={retry_max_delay}"
-    )
+    if ca_cert:
+        logger.info(
+            f"Configured Redis realtime state. host={host}, port={port}, "
+            f"ssl={ssl}, db={db}, key_prefix={key_prefix}, "
+            f"max_retries={max_retries}, timeout_max_retries={timeout_max_retries}, "
+            f"retry_min_delay={retry_min_delay}, retry_max_delay={retry_max_delay}, ca_cert={ca_cert}"
+        )
+    else:
+        logger.info(
+            f"Configured Redis realtime state. host={host}, port={port}, "
+            f"ssl={ssl}, db={db}, key_prefix={key_prefix}, "
+            f"max_retries={max_retries}, timeout_max_retries={timeout_max_retries}, "
+            f"retry_min_delay={retry_min_delay}, retry_max_delay={retry_max_delay}"
+        )
 
 
 def get_realtime_redis_config():
@@ -296,17 +308,33 @@ def get_realtime_redis_client():
             f"port={_redis_config['port']}, ssl={_redis_config['ssl']}, "
             f"db={_redis_config['db']}"
         )
-        _redis_client = redis.Redis(
-            host=_redis_config["host"],
-            port=_redis_config["port"],
-            username=_redis_config["username"],
-            password=_redis_config["password"],
-            ssl=_redis_config["ssl"],
-            db=_redis_config["db"],
-            decode_responses=True,
-            socket_timeout=_redis_config["socket_timeout"],
-            socket_connect_timeout=_redis_config["socket_connect_timeout"],
-        )
+
+        if _redis_config["ca_cert"]:
+            _redis_client = redis.Redis(
+                host=_redis_config["host"],
+                port=_redis_config["port"],
+                username=_redis_config["username"],
+                password=_redis_config["password"],
+                ssl=_redis_config["ssl"],
+                db=_redis_config["db"],
+                decode_responses=True,
+                socket_timeout=_redis_config["socket_timeout"],
+                socket_connect_timeout=_redis_config["socket_connect_timeout"],
+                ssl_ca_certs=_redis_config["ca_cert"]
+            )
+        else:
+            _redis_client = redis.Redis(
+                host=_redis_config["host"],
+                port=_redis_config["port"],
+                username=_redis_config["username"],
+                password=_redis_config["password"],
+                ssl=_redis_config["ssl"],
+                db=_redis_config["db"],
+                decode_responses=True,
+                socket_timeout=_redis_config["socket_timeout"],
+                socket_connect_timeout=_redis_config["socket_connect_timeout"]
+            )
+
 
     return _redis_client
 

{switch_api-0.6.26 → switch_api-0.6.28}/switch_api/realtime/realtime.py

@@ -300,10 +300,10 @@ def submit_realtime_updates(
             port=mqtt_config["ws_port"],
             username=mqtt_config["username"],
             password=mqtt_config["password"],
-            ssl_pwd=mqtt_config["ssl_pwd"],
             client_id=api_inputs.data_feed_id,
             email=api_inputs.email_address,
             project_id=api_inputs.api_project_id,
+            ca_certs=mqtt_config["ca_certs"]
         )
 
     # ----------------------------

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: switch_api
-Version: 0.6.26
+Version: 0.6.28
 Summary: A complete package for data ingestion into the Switch Automation Platform.
 Author: Switch Automation Pty Ltd.
 License: MIT License