url-remote 0.0.51__tar.gz

url-remote-0.0.51/PKG-INFO

@@ -0,0 +1,16 @@
+Metadata-Version: 2.1
+Name: url-remote
+Version: 0.0.51
+Home-page: https://github.com/circles-zone/url-remote-python-package
+Author: Circles
+Author-email: info@circles.life
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: Other/Proprietary License
+Classifier: Operating System :: OS Independent
+Description-Content-Type: text/markdown
+Requires-Dist: python-dotenv>=1.0.0
+Requires-Dist: pytest>=7.4.1
+Requires-Dist: database-without-orm-local>=0.0.79
+Requires-Dist: logger-local>=0.0.59
+
+URL Remote

url-remote-0.0.51/README.md

@@ -0,0 +1,14 @@
+# Usage:
+
+`pip install url-remote`
+
+```python
+from url_local.url_circlez import UrlCirclez
+
+UrlCirclez.endpoint_url(brand_name = BrandName, environment_name = EnvironmentName,
+                        ComponentName.GENDER_DETECTION.value, EntityName.GENDER_DETECTION.value, ANALYZE_FACIAL_IMAGE_API_VERSION[EnvironmentName],
+                        ActionName.ANALYZE_FACIAL_IMAGE.value)
+# >>> "https://353sstqmj5.execute-api.us-east-1.amazonaws.com/play1/api/v1/gender-detection/analyzeFacialImage"
+```
+
+Includes also domain related functions<br>

url-remote-0.0.51/pyproject.toml

@@ -0,0 +1,12 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[tool.poetry]
+name = "url-remote"
+version = "0.0.32"
+description = "url-local Python Package"
+readme = "README.md"
+authors = [
+    "Circlez.ai <info@circlez.ai>",
+]

url-remote-0.0.51/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

url-remote-0.0.51/setup.py

@@ -0,0 +1,31 @@
+import setuptools
+
+PACKAGE_NAME = "url-remote"
+package_dir = PACKAGE_NAME.replace("-", "_")
+
+setuptools.setup(
+    name=PACKAGE_NAME,  
+    version='0.0.51', # https://pypi.org/project/url-remote
+
+    author="Circles",
+    author_email="info@circles.life",
+    url=f"https://github.com/circles-zone/{PACKAGE_NAME}-python-package",
+    packages=[package_dir],
+    package_dir={package_dir: f'{package_dir}/src'},
+    package_data={package_dir: ['*.py']},
+    long_description="URL Remote",
+    long_description_content_type='text/markdown',
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: Other/Proprietary License",
+        "Operating System :: OS Independent",
+    ],
+    install_requires=[
+        "python-dotenv>=1.0.0",
+        "pytest>=7.4.1",
+        "database-without-orm-local>=0.0.79",
+        # TODO Can we swtich to logger-remote?
+        "logger-local>=0.0.59" ,
+        # "queue-local>=0.0.13"
+    ]
+)

url-remote-0.0.51/url_remote/src/action_name_enum.py

@@ -0,0 +1,51 @@
+from enum import Enum
+
+# TODO Based on https://restfulapi.net/resource-naming/ we should change all APIs to xxx-yy gradually
+
+# Rename to HttpUrlActionName
+class ActionName(Enum):
+    # Authentication
+    LOGIN = "login" # No need to authenticate before, we should add API KEY and impersonate
+    VALIDATE_USER_JWT = 'validate-user-jwt' # No need to authenticate before, we should add API KEY and impersonate
+
+    # Event
+    GET_EVENT_BY_ID = "getEventById"
+    CREATE_EVENT = "createEvent"
+    UPDATE_EVENT_BY_ID = "updateEventById"
+    DELETE_EVENT_BY_ID = "deleteEventById"
+
+    # Gender-detection
+    ANALYZE_FACIAL_IMAGE = "analyzeFacialImage"
+    # TODO Repace it with GENDER_DETECTION_API_VERSION_DICT[environment_name][ANALYZE_FACIAL_IMAGE]
+    GENDER_DETECTION_API_VERSION = 1
+
+    # Group
+    GET_ALL_GROUPS = "getAllGroups"
+    GET_GROUP_BY_NAME = "getGroupByName"
+    GET_GROUP_BY_ID = "getGroupById"
+    CREATE_GROUP = "createGroup"
+    UPDATE_GROUP = "updateGroup"
+    DELETE_GROUP = "deleteGroup"
+
+    # Logger
+    ADD_LOG = "add"
+
+    # Storage
+    PUT = "put"
+    DOWNLOAD = "download"
+
+    # Timeline
+    TIMELINE = "timeline"
+
+    # User
+    CREATE_USER = "createUser" # No need to authenticate before, we should add API KEY and impersonate
+    UPDATE_USER = "updateUser"
+
+    # Group-profile
+    CREATE_GROUP_PROFILE = "createGroupProfile"
+    DELETE_GROUP_PROFILE = "deleteGroupProfile"
+    GET_GROUP_PROFILE = "getGroupProfileByGroupIdProfileId"
+
+    # SmartLink
+    EXECUTE_SMARTLINK_BY_IDENTIFIER = "executeSmartLinkByIdentifier" # Used when not logged in user press on a SmartLink
+    GET_SMARTLINK_DATA_BY_IDENTIFIER = "getSmartLinkDataByIdentifier" # Who is using it?

url-remote-0.0.51/url_remote/src/brand_name_enum.py

@@ -0,0 +1,5 @@
+from enum import Enum
+
+
+class BrandName(Enum):
+    CIRCLEZ = 'Circlez'

url-remote-0.0.51/url_remote/src/component_name_enum.py

@@ -0,0 +1,17 @@
+from enum import Enum
+
+# Order by a..z of component name
+# Should in in sync with https://github.com/circles-zone/url-remote-typescript-package/blob/dev/src/component-name.enum.ts
+class ComponentName(Enum):
+    AUTHENTICATION = "auth"  # Used by User Context both for login and validateJwt
+    EVENT = "event"
+    GENDER_DETECTION = "gender-detection"
+    GROUP = "group"
+    GROUP_PROFILE = "group-profile"
+    LOGGER = "logger"
+    MARKETPLACE_GOODS = "marketplace-goods"
+    STORAGE = "storage"
+    TIMELINE = "timeline"
+    USER_REGISTRATION = "user-registration"
+    SMARTLINK = "smartlink"
+    

url-remote-0.0.51/url_remote/src/entity_name_enum.py

@@ -0,0 +1,15 @@
+from enum import Enum
+
+# Sorted by A..Z of Entity Type
+class EntityName(Enum):
+    AUTH_LOGIN = "auth"
+    EVENT = "event"
+    GENDER_DETECTION = "gender-detection"
+    GROUP = "group"
+    GROUP_PROFILE = "group-profile"
+    LOGGER = "logger"
+    MARKETPLACE_GOODS = "marketplace-goods"
+    STORAGE = "storage"
+    TIMELINE = "timeline"
+    USER_REGISTRATION = "user-registration"
+    SMARTLINK = "smartlink"

url-remote-0.0.51/url_remote/src/environment_name_enum.py

@@ -0,0 +1,7 @@
+from enum import Enum
+
+
+class EnvironmentName(Enum):
+    LOCAL = 'local'
+    PLAY1 = 'play1'
+    DVLP1 = 'dvlp1'

url-remote-0.0.51/url_remote/src/url_circlez.py

@@ -0,0 +1,180 @@
+import urllib.parse
+
+from dotenv.main import load_dotenv
+
+from .brand_name_enum import BrandName
+from .environment_name_enum import EnvironmentName
+
+load_dotenv()
+
+
+class OurUrl:
+    # static dict for domain mapping
+    domain_mapping = {
+        'auth.dvlp1.circ.zone': 'i4wp5o2381.execute-api.us-east-1.amazonaws.com',
+        'auth.play1.circ.zone': 'nmxjjpyrv9.execute-api.us-east-1.amazonaws.com',
+        'user-registration.dvlp1.circ.zone': 'lczo7l194b.execute-api.us-east-1.amazonaws.com',
+        'user-registration.play1.circ.zone': 't3tnkh0r64.execute-api.us-east-1.amazonaws.com',
+        'gender-detection.dvlp1.circ.zone': '353sstqmj5.execute-api.us-east-1.amazonaws.com',
+        'gender-detection.play1.circ.zone': '353sstqmj5.execute-api.us-east-1.amazonaws.com',
+        'group.dvlp1.circ.zone': '2mvpuqbhh1.execute-api.us-east-1.amazonaws.com',
+        'group.play1.circ.zone': 'ly0jegwkib.execute-api.us-east-1.amazonaws.com',
+        'group-profile.dvlp1.circ.zone': 'dot2ynvxwl.execute-api.us-east-1.amazonaws.com',
+        'group-profile.play1.circ.zone': 'y4abphdp9l.execute-api.us-east-1.amazonaws.com', 
+        'marketplace-goods.play1.circ.zone': 'vcev0rrt01.execute-api.us-east-1.amazonaws.com',
+        'logger.dvlp1.circ.zone': 't91y4nxsye.execute-api.us-east-1.amazonaws.com',
+        'logger.play1.circ.zone': 'fsujmjyfal.execute-api.us-east-1.amazonaws.com',
+        #'event.play1.circ.zone': 'p89mpsr5m1.execute-api.us-east-1.amazonaws.com',
+        #'event.play1.circ.zone': 'x8ql0j9cwf.execute-api.us-east-1.amazonaws.com',
+        'event.play1.circ.zone': 'gskq98jtkf.execute-api.us-east-1.amazonaws.com',
+        'event.dvlp1.circ.zone': 'wbq5liyk63.execute-api.us-east-1.amazonaws.com',
+        'storage.play1.circ.zone': 'wbq5liyk63.execute-api.us-east-1.amazonaws.com',  # TODO update
+        'storage.dvlp1.circ.zone': 'wbq5liyk63.execute-api.us-east-1.amazonaws.com',  # TODO update
+        'smartlink.play1.circ.zone': 'wagdetw4hk.execute-api.us-east-1.amazonaws.com/dev'
+        # 'websocket.dvlp1.circ.zone': 'ws://23.22.217.199:8080',
+        # 'websocket.play1.circ.zone': 'ws://23.22.217.199:8080',
+    }
+
+    @staticmethod
+    def _base_domain(brand_name: str, environment_name: str) -> str:
+        """
+        Return the base domain based on the input environment.
+
+        Parameters:
+            brand_name (string): Actual brand name.
+            environment_name (string): Desired environment name
+
+        Return:
+            A string that represents the base domain of a given environment name.
+        """
+        if brand_name == BrandName.CIRCLEZ.value:
+            if environment_name == EnvironmentName.DVLP1.value:
+                return 'dvlp1.circ.zone'
+
+            elif environment_name == EnvironmentName.PLAY1.value:
+                return 'play1.circ.zone'
+            elif environment_name == EnvironmentName.LOCAL:
+                return 'localhost'
+            else:
+                message = 'Invalid ENVIRONMENT_NAME="' + \
+                    environment_name + '" in BRAND_NAME=Circlez'
+                print(message)
+                raise ValueError(message)
+        else:
+            raise ValueError('Invalid BRAND_NAME "' + brand_name + '"')
+
+    @staticmethod
+    def app_url(brand_name: str, environment_name: str) -> str:
+        if brand_name == BrandName.CIRCLEZ.value:
+            if environment_name == EnvironmentName.LOCAL.value:
+                # TODO: Align it with TypeScript default and environment variable.
+                return "localhost:5173"
+            elif environment_name == EnvironmentName.PLAY1.value:
+                return "http://circles-user-reactjs-frontend.play1.circ.zone.s3-website-us-east-1.amazonaws.com/"
+            elif environment_name == EnvironmentName.DVLP1.value:
+                return "https://d2f9rjvjaf75eo.cloudfront.net/"
+            else:
+                raise ValueError('Invalid environment name')
+        return 'unknown'
+
+    @staticmethod
+    def endpoint_url(brand_name: str, environment_name: str, component_name: str, entity_name: str, version: int, action_name: str,
+                     path_parameters=None, query_parameters=None) -> str:
+        """
+        Function that generate a URL with the format:
+            "https://{direct_domain}/{environment_name}/api/v{version}/{entity}/{action}/{parameters}"
+
+        Parameters:
+            brand_name (string): Actual brand name.
+            environment_name (string): Desired environment name.
+            component (string): Desired component.
+            entity (string): Desired entity.
+            version (integer): Version.
+            action (string): Desired action.
+            path_parameters (dictionary): A dictionary representing the path parameters with their values.
+            query_parameters (dictionary): A dictionary representing the query parameters with their values.
+
+        Return:
+            A string that represent the desired endpoint url based on input.
+
+        """
+        base_url = OurUrl._base_url_builder(
+            component_name, brand_name, environment_name, version, entity_name, action_name)
+
+        if path_parameters:
+            path_params_string = '/'.join([urllib.parse.quote_plus(str(val))
+                                          for val in path_parameters.values()])
+            url_with_path_params = f"{base_url}/{path_params_string}"
+        else:
+            url_with_path_params = base_url
+
+        if query_parameters:
+            query_params_string = '&'.join(
+                [f"{urllib.parse.quote_plus(key)}={urllib.parse.quote_plus(str(value))}" for key, value in
+                 query_parameters.items()])
+            url_with_query_params = f"{url_with_path_params}?{query_params_string}"
+        else:
+            url_with_query_params = url_with_path_params
+
+        new_url = OurUrl._convert_to_direct_url(url_with_query_params)
+        return new_url
+
+    @staticmethod
+    def _base_url_builder(component_name: str, brand_name: str, environment_name: str, version: int, entity_name: str,
+                          action_name: str) -> str:
+        """
+        Function that generate the basic direct url with the format:
+            "https://{direct_domain}/{environment_name}/api/v{version}/{entity}/{action}"
+
+        Parameters:
+            brand_name (string): Actual brand name.
+            environment_name (string): Desired environment name.
+            component (string): Desired component.
+            version (integer): Version.
+            action (string): Desired action.
+
+        Return:
+            A string representing direct url after mapping out the domain.
+        """
+        base_domain = f"{component_name}.{OurUrl._base_domain(brand_name, environment_name)}"
+
+        try:
+            direct_domain = OurUrl.domain_mapping[base_domain]
+        except KeyError:
+            # Handle the case when the base_domain is not found in the domain_mapping
+            raise ValueError(
+                f"Domain mapping not found for '{base_domain}' in brand '{brand_name}' and environment '{environment_name}'")
+
+        direct_url = f"https://{direct_domain}/{environment_name}/api/v{version}/{entity_name}/{action_name}"
+        return direct_url
+
+    @staticmethod
+    def _convert_to_direct_url(direct_url: str, path_parameters=None, query_parameters=None) -> str:
+        """
+        Function that conver the base url to direct url.
+
+        Parameters:
+            direct_url (string): The direct url after mapping the domain from the base domain.
+            path_parameters (dictionary): A dictionary representing desired path parameters.
+            query_parameters (dictionary): A dictionary representing desired query parameters.
+
+        Return:
+            A string representing the final url after adding all the parameters to the direct url.
+        """
+        if path_parameters:
+            for key, value in path_parameters.items():
+                direct_url = direct_url.replace(f"{{{key}}}", value)
+
+        path_params_string = '/'.join(
+            urllib.parse.quote_plus(str(value)) for value in path_parameters.values()) if path_parameters else ''
+        url_with_path_params = f"{direct_url}/{path_params_string}" if path_params_string else direct_url
+
+        if query_parameters:
+            query_params_string = '&'.join(
+                f"{urllib.parse.quote_plus(str(key))}={urllib.parse.quote_plus(str(value))}" for key, value in
+                query_parameters.items())
+            url_with_query_params = f"{url_with_path_params}?{query_params_string}"
+        else:
+            url_with_query_params = url_with_path_params
+
+        return url_with_query_params

url-remote-0.0.51/url_remote.egg-info/PKG-INFO

@@ -0,0 +1,16 @@
+Metadata-Version: 2.1
+Name: url-remote
+Version: 0.0.51
+Home-page: https://github.com/circles-zone/url-remote-python-package
+Author: Circles
+Author-email: info@circles.life
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: Other/Proprietary License
+Classifier: Operating System :: OS Independent
+Description-Content-Type: text/markdown
+Requires-Dist: python-dotenv>=1.0.0
+Requires-Dist: pytest>=7.4.1
+Requires-Dist: database-without-orm-local>=0.0.79
+Requires-Dist: logger-local>=0.0.59
+
+URL Remote

url-remote-0.0.51/url_remote.egg-info/SOURCES.txt

@@ -0,0 +1,15 @@
+README.md
+pyproject.toml
+setup.py
+url_remote.egg-info/PKG-INFO
+url_remote.egg-info/SOURCES.txt
+url_remote.egg-info/dependency_links.txt
+url_remote.egg-info/requires.txt
+url_remote.egg-info/top_level.txt
+url_remote/src/__init__.py
+url_remote/src/action_name_enum.py
+url_remote/src/brand_name_enum.py
+url_remote/src/component_name_enum.py
+url_remote/src/entity_name_enum.py
+url_remote/src/environment_name_enum.py
+url_remote/src/url_circlez.py

url-remote-0.0.51/url_remote.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

url-remote-0.0.51/url_remote.egg-info/requires.txt

@@ -0,0 +1,4 @@
+python-dotenv>=1.0.0
+pytest>=7.4.1
+database-without-orm-local>=0.0.79
+logger-local>=0.0.59

url-remote-0.0.51/url_remote.egg-info/top_level.txt

@@ -0,0 +1 @@
+url_remote