aplos-nca-saas-sdk 0.0.12__py3-none-any.whl → 0.0.13__py3-none-any.whl

aplos_nca_saas_sdk/integration_testing/tests/nca_analysis_test.py

@@ -1,5 +1,5 @@
 """
-Copyright 2024 Aplos Analytics
+Copyright 2024-2025 Aplos Analytics
 All Rights Reserved.   www.aplosanalytics.com   LICENSED MATERIALS
 Property of Aplos Analytics, Utah, USA
 """
@@ -48,7 +48,7 @@ class NCAAnalysisTest(IntegrationTestBase):
             try:
                 # Create new NCA Execution
                 nca_execution: NCAAnalysis = NCAAnalysis(
-                    nca_execution_config.login.domain
+                    nca_execution_config.login.host
                 )
 
                 # Initialize Configuration Data

aplos_nca_saas_sdk/integration_testing/tests/validation_test.py

@@ -1,5 +1,5 @@
 """
-Copyright 2024 Aplos Analytics
+Copyright 2024-2025 Aplos Analytics
 All Rights Reserved.   www.aplosanalytics.com   LICENSED MATERIALS
 Property of Aplos Analytics, Utah, USA
 """

aplos_nca_saas_sdk/nca_resources/_api_base.py

@@ -0,0 +1,44 @@
+"""
+Copyright 2024-2025 Aplos Analytics
+All Rights Reserved.   www.aplosanalytics.com   LICENSED MATERIALS
+Property of Aplos Analytics, Utah, USA
+"""
+
+from typing import Any
+
+
+from aplos_nca_saas_sdk.nca_resources.nca_authenticator import NCAAuthenticator
+from aplos_nca_saas_sdk.nca_resources.nca_endpoints import NCAEndpoints
+
+
+class NCAApiBaseClass:
+    """NCA Api Base Class"""
+
+    def __init__(self, host: str) -> None:
+        self.host = host
+        self.__authenticator: NCAAuthenticator = NCAAuthenticator(host=host)
+        self.__endpoints: NCAEndpoints = NCAEndpoints(host=host)
+        if not host:
+            raise ValueError("Missing Aplos Api Domain")
+
+    @property
+    def authenticator(self) -> NCAAuthenticator:
+        """Gets the authenticator"""
+
+        return self.__authenticator
+
+    @authenticator.setter
+    def authenticator(self, value: Any) -> None:
+        """Sets the authenticator"""
+
+        self.__authenticator = value
+
+    @property
+    def endpoints(self) -> NCAEndpoints:
+        """Gets the endpoints"""
+
+        if self.authenticator.cognito.jwt:
+            self.__endpoints.tenant_id = self.authenticator.cognito.tenant_id
+            self.__endpoints.user_id = self.authenticator.cognito.user_id
+
+        return self.__endpoints

aplos_nca_saas_sdk/{aws_resources → nca_resources}/aws_cognito.py

@@ -1,5 +1,5 @@
 """
-Copyright 2024 Aplos Analytics
+Copyright 2024-2025 Aplos Analytics
 All Rights Reserved.   www.aplosanalytics.com   LICENSED MATERIALS
 Property of Aplos Analytics, Utah, USA
 """
@@ -79,7 +79,7 @@ class CognitoAuthentication:
           - or the Aplos Domain (which can get the clientId and region)
         """
         if self.__client_id is None and self.__aplos_domain is not None:
-            self.__config = NCAAppConfiguration(aplos_saas_domain=self.__aplos_domain)
+            self.__config = NCAAppConfiguration(host=self.__aplos_domain)
             self.__client_id = self.__config.cognito_client_id
             self.__region = self.__config.cognito_region
 

aplos_nca_saas_sdk/{aws_resources → nca_resources}/aws_s3_presigned_payload.py

@@ -1,12 +1,12 @@
 """
-Copyright 2024 Aplos Analytics
+Copyright 2024-2025 Aplos Analytics
 All Rights Reserved.   www.aplosanalytics.com   LICENSED MATERIALS
 Property of Aplos Analytics, Utah, USA
 """
 
 
-class S3PresignedPayload:
-    """S3PresignedPayload"""
+class S3PresignedUrlPayload:
+    """S3 Presigned Url Payload"""
 
     def __init__(self, payload: dict | None = None) -> None:
         self.url: str | None = None

aplos_nca_saas_sdk/{aws_resources → nca_resources}/aws_s3_presigned_upload.py

@@ -1,5 +1,5 @@
 """
-Copyright 2024 Aplos Analytics
+Copyright 2024-2025 Aplos Analytics
 All Rights Reserved.   www.aplosanalytics.com   LICENSED MATERIALS
 Property of Aplos Analytics, Utah, USA
 """
@@ -9,20 +9,23 @@ import os
 from typing import Any, Dict
 
 import requests
-from aplos_nca_saas_sdk.aws_resources.aws_s3_presigned_payload import (
-    S3PresignedPayload,
+from aplos_nca_saas_sdk.nca_resources.aws_s3_presigned_payload import (
+    S3PresignedUrlPayload,
 )
-from aplos_nca_saas_sdk.utilities.http_utility import HttpUtilities, Routes
+from aplos_nca_saas_sdk.utilities.http_utility import HttpUtilities
+from aplos_nca_saas_sdk.nca_resources._api_base import NCAApiBaseClass
 
 
-class S3PresignedUpload:
-    """S3PresignedUpload"""
+class S3PresignedUrlUpload(NCAApiBaseClass):
+    """S3PresignedUrlUpload"""
 
-    def __init__(self, jwt: str, api_url: str) -> None:
-        self.api_url = api_url
-        self.jwt = jwt
+    def __init__(self, host: str) -> None:
+        super().__init__(host)
 
-    def upload_file(self, input_file: str) -> Dict[str, Any]:
+    def upload_file(
+        self,
+        input_file: str,
+    ) -> Dict[str, Any]:
         """
         Uploads a file to your Aplos Cloud Account in AWS
 
@@ -34,15 +37,17 @@ class S3PresignedUpload:
         """
 
         # get the presigned url for uploading
-        paylod: S3PresignedPayload = self.__get_presigned_upload_info(
-            input_file=input_file
+        paylod: S3PresignedUrlPayload = self.__get_presigned_upload_info(
+            input_file=input_file, jwt=self.authenticator.cognito.jwt
         )
         # upload the files
         upload_response = self.__upload_file_to_s3(paylod, input_file=input_file)
 
         return upload_response
 
-    def __get_presigned_upload_info(self, input_file: str) -> S3PresignedPayload:
+    def __get_presigned_upload_info(
+        self, input_file: str, jwt: str
+    ) -> S3PresignedUrlPayload:
         """
         Performs all the necessary steps for creating a presigned url to upload a file to S3.
         We're using AWS S3 presigned urls for security as well as allowing for very large files if required.
@@ -50,11 +55,11 @@ class S3PresignedUpload:
             input_file (str): the path to the input (analysis) file
 
         Returns:
-            S3PresignedPayload: instance of S3PresignedPayload
+            S3PresignedUrlPayload: instance of S3PresignedUrlPayload
         """
 
-        url = f"{self.api_url}/{Routes.NCA_GENERATE_UPLOAD}"
-        headers = HttpUtilities.get_headers(self.jwt)
+        url = self.endpoints.files
+        headers = HttpUtilities.get_headers(jwt)
 
         body = {"file_name": input_file, "method_type": "post"}
         response = requests.post(
@@ -64,29 +69,29 @@ class S3PresignedUpload:
         if response.status_code == 403:
             raise PermissionError(
                 "Failed to get a presigned url. "
-                f"Status Code: {response.status_code }"
+                f"Status Code: {response.status_code}"
                 f"Reason: {response.reason} "
                 f"403 Errors can also occur if you have an invalid path."
             )
         elif response.status_code != 200:
             raise RuntimeError(
                 "Failed to get a presigned url. "
-                f"Status Code: {response.status_code }"
+                f"Status Code: {response.status_code}"
                 f"Reason: {response.reason}"
             )
         result = response.json()
 
-        payload: S3PresignedPayload = S3PresignedPayload(result)
+        payload: S3PresignedUrlPayload = S3PresignedUrlPayload(result)
 
         return payload
 
     def __upload_file_to_s3(
-        self, payload: S3PresignedPayload, input_file: str
+        self, payload: S3PresignedUrlPayload, input_file: str
     ) -> Dict[str, Any]:
         """
         Peforms the actual uploading via a presigned url for S3 bucket storage
         Args:
-            payload (S3PresignedPayload): instance of S3PresignedPayload with all the data needed
+            payload (S3PresignedUrlPayload): instance of S3PresignedUrlPayload with all the data needed
             input_file (str): the path to a file being uploaded
 
         Raises:
@@ -104,8 +109,9 @@ class S3PresignedUpload:
         with open(input_file, "rb") as file:
             files = {"file": (input_file, file)}
             # upload to s3 with the presigned url
+            # authentication is built into the url
             upload_response = requests.post(
-                str(payload.url), data=payload.form_data, files=files, timeout=30
+                str(payload.url), data=payload.form_data, files=files, timeout=60
             )
 
         # Check the response: 204 is a success in this case

aplos_nca_saas_sdk/nca_resources/nca_analysis.py

@@ -1,5 +1,5 @@
 """
-Copyright 2024 Aplos Analytics
+Copyright 2024-2025 Aplos Analytics
 All Rights Reserved.   www.aplosanalytics.com   LICENSED MATERIALS
 Property of Aplos Analytics, Utah, USA
 """
@@ -11,61 +11,27 @@ import zipfile
 from datetime import datetime, timedelta
 from pathlib import Path
 from typing import Any, Dict
-from aws_lambda_powertools import Logger
+
 import requests
+from aws_lambda_powertools import Logger
 
-from aplos_nca_saas_sdk.aws_resources.aws_cognito import CognitoAuthentication
-from aplos_nca_saas_sdk.aws_resources.aws_s3_presigned_upload import (
-    S3PresignedUpload,
+from aplos_nca_saas_sdk.nca_resources._api_base import NCAApiBaseClass
+from aplos_nca_saas_sdk.nca_resources.aws_s3_presigned_upload import (
+    S3PresignedUrlUpload,
 )
-from aplos_nca_saas_sdk.utilities.commandline_args import CommandlineArgs
-from aplos_nca_saas_sdk.utilities.http_utility import HttpUtilities, Routes
 from aplos_nca_saas_sdk.utilities.environment_vars import EnvironmentVars
+from aplos_nca_saas_sdk.utilities.http_utility import HttpUtilities
 
 logger = Logger()
 
 
-class NCAAnalysis:
-    """NCA Analysis API Access"""
+class NCAAnalysis(NCAApiBaseClass):
+    """NCA Analysis API"""
 
-    def __init__(self, api_domain: str) -> None:
-        self.__jwt: str
+    def __init__(self, host: str) -> None:
+        super().__init__(host)
 
-        if not api_domain:
-            raise ValueError("Missing Aplos Api Domain")
-
-        self.__api_domain: str = api_domain
         self.verbose: bool = False
-        self.__cognito: CognitoAuthentication | None = None
-
-    @property
-    def cognito(self) -> CognitoAuthentication:
-        """Gets the cognito authentication object"""
-
-        if not self.__api_domain:
-            raise RuntimeError(
-                "Missing Aplos Api Domain. Set the internal property of __api_domain first."
-                "This is required to make an authentication connection"
-            )
-
-        if self.__cognito is None:
-            self.__cognito = CognitoAuthentication(
-                client_id=None, region=None, aplos_domain=self.__api_domain
-            )
-
-        return self.__cognito
-
-    @property
-    def api_root(self) -> str:
-        """Gets the base url"""
-        if self.__api_domain is None:
-            raise RuntimeError("Missing Aplos Api Domain")
-
-        url = HttpUtilities.build_url(
-            self.__api_domain, self.cognito.tenant_id, self.cognito.user_id
-        )
-
-        return url
 
     def execute(
         self,
@@ -100,17 +66,13 @@ class NCAAnalysis:
             Dict[str, Any]: The execution response.  If you wait for the completion
         """
 
-        self.log(f"\tLogging into {self.__api_domain}.")
+        self.log(f"\tLogging into {self.host}.")
 
-        if not username:
-            raise ValueError("Missing username.  Please provide a valid username.")
-        if not password:
-            raise ValueError("Missing password.  Please provide a valid password.")
-
-        self.__jwt = self.cognito.login(username=username, password=password)
+        self.authenticator.authenticate(username=username, password=password)
 
         self.log("\tUploading the analysis file.")
-        uploader: S3PresignedUpload = S3PresignedUpload(self.__jwt, str(self.api_root))
+        uploader: S3PresignedUrlUpload = S3PresignedUrlUpload(str(self.host))
+        uploader.authenticator = self.authenticator
         upload_response: Dict[str, Any] = uploader.upload_file(input_file_path)
 
         file_id: str = upload_response.get("file_id", "")
@@ -188,7 +150,7 @@ class NCAAnalysis:
             raise ValueError(
                 "Missing config_data.  Please provide a valid config_data."
             )
-        headers = HttpUtilities.get_headers(self.__jwt)
+        headers = HttpUtilities.get_headers(self.authenticator.cognito.jwt)
         # to start a new execution we need the location of the file (s3 bucket and object key)
         # you basic configuration
         # optional meta data
@@ -198,9 +160,12 @@ class NCAAnalysis:
             "configuration": config_data,
             "meta_data": meta_data,
         }
-        url = f"{str(self.api_root)}/{Routes.NCA_EXECUTIONS}"
+
         response: requests.Response = requests.post(
-            url, headers=headers, data=json.dumps(submission), timeout=30
+            self.endpoints.executions,
+            headers=headers,
+            data=json.dumps(submission),
+            timeout=30,
         )
         json_response: dict = response.json()
 
@@ -234,9 +199,9 @@ class NCAAnalysis:
             str | None: on success: a url for download, on failure: None
         """
 
-        url = f"{self.api_root}/{Routes.NCA_EXECUTIONS}/{execution_id}"
+        url = f"{self.endpoints.execution(execution_id)}"
 
-        headers = HttpUtilities.get_headers(self.__jwt)
+        headers = HttpUtilities.get_headers(self.authenticator.cognito.jwt)
         current_time = datetime.now()
         # Create a timedelta object representing 15 minutes
         time_delta = timedelta(seconds=max_wait_in_seconds)
@@ -337,112 +302,3 @@ class NCAAnalysis:
 
         if self.verbose:
             print(message)
-
-
-def main():
-    try:
-        print("Welcome to the NCA Engine Upload & Execution Demo")
-        args = CommandlineArgs()
-        files_path = os.path.join(Path(__file__).parent, "files")
-
-        args.analysis_file_default = os.path.join(files_path, "single_ev.csv")
-        args.config_file_default = os.path.join(
-            files_path, "configuration_single_ev.json"
-        )
-        args.metadata_file_default = os.path.join(files_path, "meta_data.json")
-        if not args.is_valid():
-            print("\n\n")
-            print("Missing some arguments.")
-            exit()
-
-        engine = NCAAnalysis(
-            api_domain=str(args.api_domain),
-        )
-
-        print("\tLoading analysis configurations")
-        print(f"\t\t{args.config_file}")
-        config_data: dict = read_json_file(str(args.config_file))
-
-        print("\tLoading analysis meta data")
-        print(f"\t\t{args.metadata_file}")
-        meta_data = optional_json_loads(read_text_file(str(args.metadata_file)))
-
-        engine.execute(
-            username=str(args.username),
-            password=str(args.password),
-            input_file_path=str(args.analysis_file),
-            config_data=config_data,
-            meta_data=meta_data,
-            output_directory=str(args.output_directory),
-        )
-        print("Thank you for using the NCA Engine Upload and Execution Demo")
-    except Exception as e:  # pylint: disable=w0718
-        print("An error occured ... exiting with an error")
-        print(str(e))
-
-
-def optional_json_loads(data: str | dict) -> str | dict:
-    """
-    Attempts to load the data as json, fails gracefull and retuns the data is if it fails
-    Args:
-        data (str): data as string
-
-    Returns:
-        str | dict: either the data as is or a converted dictionary/json object
-    """
-    if isinstance(data, dict):
-        return data
-
-    try:
-        data = json.loads(str(data))
-    finally:
-        pass
-    return data
-
-
-def read_json_file(file_path: str) -> dict:
-    """
-    Reads a file and returns the json
-    Args:
-        file_path (str): _description_
-
-    Raises:
-        FileNotFoundError: _description_
-
-    Returns:
-        dict: _description_
-    """
-    if not os.path.exists(file_path):
-        raise FileNotFoundError(f"File Not Found: {file_path}")
-
-    data = None
-    with open(file_path, mode="r", encoding="utf8") as file:
-        data = json.load(file)
-
-    return data
-
-
-def read_text_file(file_path: str) -> str:
-    """
-    Read files contents
-    Args:
-        file_path (str): path to the file
-
-    Raises:
-        FileNotFoundError: if the file is not found
-
-    Returns:
-        str: the files data
-    """
-    if not os.path.exists(file_path):
-        raise FileNotFoundError(f"File Not Found: {file_path}")
-
-    data = None
-    with open(file_path, mode="r", encoding="utf8") as file:
-        data = file.read()
-
-    return data
-
-
-if __name__ == "__main__":
-    main()

aplos_nca_saas_sdk/nca_resources/nca_app_configuration.py

@@ -1,5 +1,5 @@
 """
-Copyright 2024 Aplos Analytics
+Copyright 2024-2025 Aplos Analytics
 All Rights Reserved.   www.aplosanalytics.com   LICENSED MATERIALS
 Property of Aplos Analytics, Utah, USA
 """
@@ -30,8 +30,8 @@ class NCAAppConfiguration:
 
     """
 
-    def __init__(self, aplos_saas_domain: str):
-        self.endpoints: NCAEndpoints = NCAEndpoints(aplos_saas_domain=aplos_saas_domain)
+    def __init__(self, host: str):
+        self.__endpoints: NCAEndpoints = NCAEndpoints(host=host)
         self.__response: requests.Response | None = None
 
     def get(self) -> requests.Response:
@@ -40,7 +40,7 @@ class NCAAppConfiguration:
         if self.__response is not None:
             return self.__response
 
-        url = self.endpoints.app_configuration()
+        url = self.__endpoints.app_configuration
         self.__response = requests.get(url, timeout=30)
         if self.__response.status_code != 200:
             raise RuntimeError("App configuration url is not working.")

aplos_nca_saas_sdk/nca_resources/{nca_login.py → nca_authenticator.py}

@@ -1,25 +1,25 @@
 """
-Copyright 2024 Aplos Analytics
+Copyright 2024-2025 Aplos Analytics
 All Rights Reserved.   www.aplosanalytics.com   LICENSED MATERIALS
 Property of Aplos Analytics, Utah, USA
 """
 
 from typing import Optional
-from aplos_nca_saas_sdk.aws_resources.aws_cognito import CognitoAuthentication
+from aplos_nca_saas_sdk.nca_resources.aws_cognito import CognitoAuthentication
 from aplos_nca_saas_sdk.nca_resources.nca_app_configuration import (
     NCAAppConfiguration,
 )
 
 
-class NCALogin:
-    """NCA Login"""
+class NCAAuthenticator:
+    """NCA Authenticator"""
 
     def __init__(
         self,
         *,
         cognito_client_id: Optional[str] = None,
         cognito_region: Optional[str] = None,
-        aplos_saas_domain: Optional[str] = None,
+        host: Optional[str] = None,
     ) -> None:
         """
         NCA SaaS Login
@@ -27,18 +27,16 @@ class NCALogin:
         Args:
             cognito_client_id (Optional[str], optional): Cognito Client Id. Defaults to None.
             cognito_region (Optional[str], optional): Cognito Region. Defaults to None.
-            aplos_saas_domain (Optional[str], optional): Aplos NCA SaaS domain. Defaults to None.
+            host (Optional[str], optional): Aplos NCA SaaS host. Defaults to None.
 
         Requirements:
             Either pass in the cognito_client_id and cognito_region.
-            or set the aplos_saas_domain to automatically get the client_id and region.
+            or set the host to automatically get the client_id and region.
         """
-        self.jwt: str
-        self.access_token: Optional[str] = None
-        self.refresh_token: Optional[str] = None
+
         self.__cognito_client_id = cognito_client_id
         self.__region = cognito_region
-        self.__domain: Optional[str] = aplos_saas_domain
+        self.__host: Optional[str] = host
         self.__cognito: Optional[CognitoAuthentication] = None
         self.__config: Optional[NCAAppConfiguration] = None
 
@@ -53,19 +51,19 @@ class NCALogin:
             self.__cognito = CognitoAuthentication(
                 client_id=self.__cognito_client_id,
                 region=self.__region,
-                aplos_domain=self.__domain,
+                aplos_domain=self.__host,
             )
 
         return self.__cognito
 
     @property
-    def domain(self) -> str | None:
+    def host(self) -> str | None:
         """
         Domain
         Returns:
-            str: the domain
+            str: the host
         """
-        return self.__domain
+        return self.__host
 
     @property
     def config(self) -> NCAAppConfiguration:
@@ -75,13 +73,13 @@ class NCALogin:
             NCAAppConfiguration: object to handle the NCA App Configuration
         """
         if self.__config is None:
-            if self.__domain is None:
+            if self.__host is None:
                 raise RuntimeError(
                     "Failed to get Aplos Configuration.  The Domain is not set."
                 )
 
             self.__config = NCAAppConfiguration(
-                aplos_saas_domain=self.__domain,
+                host=self.__host,
             )
 
         return self.__config
@@ -96,9 +94,14 @@ class NCALogin:
         Args:
             username (str): the username
             password (str): the users password
-
+        Returns:
+            str: JWT (JSON Web Token)
         """
+        if not username:
+            raise ValueError("Missing username.  Please provide a valid username.")
+        if not password:
+            raise ValueError("Missing password.  Please provide a valid password.")
 
-        self.jwt = self.cognito.login(username=username, password=password)
+        self.cognito.login(username=username, password=password)
 
-        return self.jwt
+        return self.cognito.jwt