python-sdk-remote 0.0.112__tar.gz → 0.0.114__tar.gz

{python_sdk_remote-0.0.112 → python_sdk_remote-0.0.114}/PKG-INFO

@@ -1,15 +1,17 @@
 Metadata-Version: 2.1
 Name: python-sdk-remote
-Version: 0.0.112
+Version: 0.0.114
 Summary: PyPI Package for Circles Python SDK Local Python
 Home-page: https://github.com/circles-zone/python-sdk-remote-python-package
 Author: Circles
-Author-email: info@circles.ai
+Author-email: info@circlez.ai
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: Other/Proprietary License
 Classifier: Operating System :: OS Independent
 Description-Content-Type: text/markdown
+Requires-Dist: requests
 Requires-Dist: python-dotenv
 Requires-Dist: url-remote
+Requires-Dist: pyjwt
 
 This is a package for sharing common functions used in different repositories

{python_sdk_remote-0.0.112 → python_sdk_remote-0.0.114}/python_sdk_remote/src/utilities.py

@@ -1,13 +1,18 @@
 import json
+import jwt
+import requests
+import re
 import os
-from datetime import date, datetime, time, timedelta
+import random
+from datetime import date, datetime, time, timedelta, timezone
 from urllib.parse import urlparse
 
 from dotenv import load_dotenv
 from url_remote.environment_name_enum import EnvironmentName
 
 from .mini_logger import MiniLogger as logger
-from .http_response import (create_authorization_http_headers, get_user_jwt_from_event,  # noqa - used for backwards compatibility
+from .http_response import (create_authorization_http_headers,  # noqa - used for backwards compatibility
+                            get_user_jwt_from_event,
                             create_return_http_headers, create_error_http_response, create_ok_http_response,
                             create_http_body)
 
@@ -19,6 +24,7 @@ load_dotenv()
 
 # TODO Use the const/enum from language package
 DEFAULT_LANG_CODE_STR = "en"
+DEFAULT_DATETIME_FORMAT = "%Y-%m-%d %H:%M:%S"
 
 
 def append_if_not_exist(lst: list, item: object) -> None:
@@ -287,7 +293,6 @@ def our_get_env(key: str, default: str = None, raise_if_not_found: bool = True,
     return env_var
 
 
-
 def get_sql_hostname() -> str:
     return our_get_env("RDS_HOSTNAME")
 
@@ -300,5 +305,103 @@ def get_sql_password() -> str:
     return our_get_env("RDS_PASSWORD")
 
 
+def get_dialog_jwt_secret_key() -> str:
+    return our_get_env("DIALOG_JWT_SECRET_KEY", raise_if_empty=True)
+
+
+def encode_jwt(payload: dict, key: str) -> str:
+    """Example:
+    payload = {
+        "user_id": 123,
+        "username": "john_doe",
+        "exp": datetime.datetime.utcnow() + datetime.timedelta(hours=1)
+    }
+    """
+    return jwt.encode(payload, key, algorithm='HS256')
+
+
+def decode_jwt(token: str, key: str) -> dict:
+    """key can be private / public"""
+    return jwt.decode(token, key, algorithms=['HS256'])
+
+
+def obfuscate_log_dict(log_dict: dict) -> dict:
+    """
+    Obfuscate keys:
+    - %password%
+    - %secret%
+    - %token%
+    - %jwt%
+    - %e%mail%
+    - %phone%
+    - %name% (first / last / nick / user etc.)
+    - %address%
+    - %ssn%
+    """
+    environment_name = get_environment_name()
+    if environment_name == EnvironmentName.PLAY1.value:
+        return log_dict
+    obfuscated_log_dict = {}
+    for key, value in log_dict.items():
+        if isinstance(value, dict):
+            obfuscated_log_dict[key] = obfuscate_log_dict(value)
+        elif re.search(r'password|secret|token|jwt|e[\-_]?mail|phone|name|address|ssn', key, re.IGNORECASE):
+            obfuscated_log_dict[key] = "***"
+        else:
+            obfuscated_log_dict[key] = value
+    return obfuscated_log_dict
+
+# TODO: add tests to the following functions
+
 def remove_digits(text: str) -> str:
-    return ''.join([i for i in text if not i.isdigit()])
+    return ''.join(i for i in text if not i.isdigit())
+
+
+def generate_otp():
+    """Generates a 6-digit OTP"""
+    otp = random.randint(100000, 999999)
+    return otp
+
+
+def get_current_datetime_string(datetime_format: str = DEFAULT_DATETIME_FORMAT, tz: timezone = None) -> str:
+    current_datetime_string = datetime.now(tz).strftime(datetime_format)
+    return current_datetime_string
+
+
+def datetime_from_str(date_str: str, datetime_format: str = DEFAULT_DATETIME_FORMAT) -> datetime:
+    return datetime.strptime(date_str, datetime_format)
+
+
+def datetime_to_str(input_datetime: datetime, datetime_format: str = DEFAULT_DATETIME_FORMAT) -> str:
+    return input_datetime.strftime(datetime_format)
+
+
+def validate_arguments(args: dict) -> None:
+    """
+    Validate method arguments to ensure they are not None or ''
+    :param args: arguments to be validated (usually locals())
+    :return: True if all arguments are not None or '', False otherwise
+    """
+    for arg, value in args.items():
+        if not arg:
+            raise ValueError(f"Argument {arg} is cannot be empty (got {value})")
+
+
+def reformat_time_string(input_str: str) -> str:
+    """Example:
+    "1234" -> "12:34:00:00"
+    """
+    hours = input_str[:2]
+    minutes = "00" if len(input_str) < 4 else input_str[2:4]
+    seconds = "00" if len(input_str) < 6 else input_str[4:6]
+    milliseconds = "00" if len(input_str) < 8 else input_str[6:8]
+    time_format = f"{hours}:{minutes}:{seconds}:{milliseconds}"
+    return time_format
+
+
+def get_ip_v4():
+    return requests.get('https://ipv4.seeip.org/jsonip').json()['ip']
+
+
+def get_ip_v6():
+    return requests.get('https://api.seeip.org/jsonip').json()['ip']

{python_sdk_remote-0.0.112 → python_sdk_remote-0.0.114}/python_sdk_remote.egg-info/PKG-INFO

@@ -1,15 +1,17 @@
 Metadata-Version: 2.1
 Name: python-sdk-remote
-Version: 0.0.112
+Version: 0.0.114
 Summary: PyPI Package for Circles Python SDK Local Python
 Home-page: https://github.com/circles-zone/python-sdk-remote-python-package
 Author: Circles
-Author-email: info@circles.ai
+Author-email: info@circlez.ai
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: Other/Proprietary License
 Classifier: Operating System :: OS Independent
 Description-Content-Type: text/markdown
+Requires-Dist: requests
 Requires-Dist: python-dotenv
 Requires-Dist: url-remote
+Requires-Dist: pyjwt
 
 This is a package for sharing common functions used in different repositories

{python_sdk_remote-0.0.112 → python_sdk_remote-0.0.114}/python_sdk_remote.egg-info/requires.txt

@@ -1,2 +1,4 @@
+requests
 python-dotenv
 url-remote
+pyjwt

{python_sdk_remote-0.0.112 → python_sdk_remote-0.0.114}/setup.py

@@ -7,9 +7,9 @@ package_dir = PACKAGE_NAME.replace("-", "_")
 # python -m build needs pyproject.toml or setup.py
 setuptools.setup(
     name=PACKAGE_NAME,
-    version='0.0.112',  # https://pypi.org/project/python-sdk-remote/
+    version='0.0.114',  # https://pypi.org/project/python-sdk-remote/
     author="Circles",
-    author_email="info@circles.ai",
+    author_email="info@circlez.ai",
     description="PyPI Package for Circles Python SDK Local Python",
     long_description="This is a package for sharing common functions used in different repositories",
     long_description_content_type="text/markdown",
@@ -23,7 +23,9 @@ setuptools.setup(
         "Operating System :: OS Independent",
     ],
     install_requires=[
+        "requests",
         "python-dotenv",
-        "url-remote"
+        "url-remote",
+        "pyjwt",
     ]
 )