api-foundry-query-engine 0.0.1__tar.gz

api_foundry_query_engine-0.0.1/.gitignore

@@ -0,0 +1,11 @@
+.DS_STORE
+*.pyc
+dist/
+__pycache__/
+venv
+build/
+coverage.xml
+htmlcov/
+.coverage.*
+.coverage
+.vscode/

api_foundry_query_engine-0.0.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

api_foundry_query_engine-0.0.1/PKG-INFO

@@ -0,0 +1,14 @@
+Metadata-Version: 2.3
+Name: api-foundry-query-engine
+Version: 0.0.1
+Summary: The AWS lambda service handler use by the `api_foundry` project is a powerful tool designed to automate the deployment of REST APIs on AWS using Lambda services to access and interact with relational databases (RDBMS). This project leverages the OpenAPI specification to define and manage the APIs
+Project-URL: Documentation, https://github.com/DanRepik/api-foundry
+Project-URL: Source, https://github.com/DanRepik/api-foundry
+Author-email: Daniel Repik <danrepik@icloud.com>
+License-File: LICENSE
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.9
+Requires-Python: >=3.9
+Requires-Dist: boto3
+Requires-Dist: pyhumps
+Requires-Dist: pyyaml

api_foundry_query_engine-0.0.1/api_foundry_query_engine/adapters/adapter.py

@@ -0,0 +1,67 @@
+import abc
+from typing import Optional
+
+from api_foundry_query_engine.operation import Operation
+from api_foundry_query_engine.services.transactional_service import TransactionalService
+from api_foundry_query_engine.utils.logger import logger
+from api_foundry_query_engine.services.service import Service
+
+log = logger(__name__)
+
+
+class Adapter(metaclass=abc.ABCMeta):
+    service: Service
+
+    @classmethod
+    def __subclasshook__(cls, __subclass: type) -> bool:
+        return (
+            hasattr(__subclass, "marshal")
+            and callable(__subclass.marshal)
+            and hasattr(__subclass, "umarshal")
+            and callable(__subclass.unmarshal)
+        )
+
+    def __init__(self, service: Optional[Service] = None) -> None:
+        self.service = service if service is not None else TransactionalService()
+
+    def unmarshal(self, event) -> Operation:
+        """
+        Unmarshal the event in a tuple for processing
+
+        Parameters:
+        - event (dict): Lambda event object.
+
+        Returns:
+        - Operation containing the entity, action, and parameters
+        """
+        raise NotImplementedError
+
+    def marshal(self, result: list[dict]):
+        """
+        Marshal the result into a event response
+
+        Parameters:
+        - result (list): the data set to return in the response
+
+        Returns:
+        - the event response
+        """
+        return result
+
+    def process_event(self, event):
+        """
+        Process Lambda event using a domain function.
+
+        Parameters:
+        - service_function (callable): The service function to be executed.
+        - event (dict): Lambda event object.
+
+        Returns:
+        - any: Result of the domain function.
+        """
+        operation = self.unmarshal(event)
+
+        result = self.service.execute(operation)
+        log.debug(f"adapter result: {result}")
+
+        return self.marshal(result)

api_foundry_query_engine-0.0.1/api_foundry_query_engine/adapters/case_change_adapter.py

@@ -0,0 +1,79 @@
+from humps import camelize, decamelize
+
+from api_foundry_query_engine.adapters.adapter import Adapter
+from api_foundry_query_engine.utils.logger import logger
+from api_foundry_query_engine.operation import Operation
+
+log = logger(__name__)
+
+
+class CaseChangeAdapter(Adapter):
+    """
+    Handles changing case from snake to camel and back
+    """
+
+    def unmarshal(self, event) -> Operation:
+        """
+        Unmarshal the event in a tuple for processing
+
+        Parameters:
+        - event (dict): Lambda event object.
+
+        Returns:
+        - tuple: Tuple containing entity operation, store_params, query_params and metadata params.
+        """
+        operation = super().unmarshal(event)
+
+        # determine case
+        self.camel_case = (
+            operation.metadata_params.get("_case", "snake") == "camel"
+            or self.__check_camel_case(operation.store_params)
+            or self.__check_camel_case(operation.query_params)
+        )
+        log.info(f"camel_case: {self.camel_case}")
+
+        if self.camel_case:
+            return Operation(
+                path=operation.entity,
+                action=operation.action,
+                store_params=decamelize(operation.store_params),
+                query_params=decamelize(operation.query_params),
+                metadata_params=operation.metadata_params,
+            )
+
+        return operation
+
+    def marshal(self, result: list[dict]):
+        """
+        Marshal the result into a event response
+
+        Parameters:
+        - result (list): the data set to return in the response
+
+        Returns:
+        - the event response
+        """
+        super().marshal(result)
+
+        if not self.camel_case:
+            return result
+
+        converted_result = []
+        for item in result:
+            converted_result.append(camelize(item))
+
+        # convert back to camel case if needed
+        return converted_result
+
+    def __check_camel_case(self, params: dict) -> bool:
+        if params is not None:
+            # check the keys for an upper case character
+            for param in params:
+                if (
+                    param != param.lower()
+                    and param != param.upper()
+                    and "_" not in param
+                ):
+                    return True
+
+        return False

api_foundry_query_engine-0.0.1/api_foundry_query_engine/adapters/gateway_adapter.py

@@ -0,0 +1,112 @@
+import json
+
+from api_foundry_query_engine.adapters.adapter import Adapter
+from api_foundry_query_engine.operation import Operation
+
+actions_map = {
+    "GET": "read",
+    "POST": "create",
+    "PUT": "update",
+    "DELETE": "delete",
+}
+
+
+class GatewayAdapter(Adapter):
+    def marshal(self, result: list[dict]):
+        """
+        Marshal the result into a event response
+
+        Parameters:
+        - result (list): the data set to return in the response
+
+        Returns:
+        - the event response
+        """
+        return super().marshal(result)
+
+    def unmarshal(self, event):
+        """
+        Get parameters from the Lambda event.
+
+        Parameters:
+        - event (dict): Lambda event object.
+
+        Returns:
+        - tuple: Tuple containing data, query and metadata parameters.
+        """
+        entity = event.get("resource").split("/")[1]
+        action = actions_map.get(event.get("httpMethod").upper(), "read")
+
+        event_params = {}
+
+        path_parameters = self._convert_parameters(event.get("pathParameters"))
+        if path_parameters is not None:
+            event_params.update(path_parameters)
+
+        queryStringParameters = self._convert_parameters(
+            event.get("queryStringParameters")
+        )
+        if queryStringParameters is not None:
+            event_params.update(queryStringParameters)
+
+        query_params, metadata_params = self.split_params(event_params)
+
+        store_params = {}
+        body = event.get("body")
+        if body is not None and len(body) > 0:
+            store_params = json.loads(body)
+
+        return Operation(
+            entity=entity,
+            action=action,
+            store_params=store_params,
+            query_params=query_params,
+            metadata_params=metadata_params,
+        )
+
+    def _convert_parameters(self, parameters):
+        """
+        Convert parameters to appropriate types.
+
+        Parameters:
+        - parameters (dict): Dictionary of parameters.
+
+        Returns:
+        - dict: Dictionary with parameters converted to appropriate types.
+        """
+        if parameters is None:
+            return None
+
+        result = {}
+        for parameter, value in parameters.items():
+            try:
+                result[parameter] = int(value)
+            except ValueError:
+                try:
+                    result[parameter] = float(value)
+                except ValueError:
+                    result[parameter] = value
+        return result
+
+    def split_params(self, parameters: dict):
+        """
+        Split a dictionary into two dictionaries based on keys.
+
+        Parameters:
+        - dictionary (dict): Input dictionary.
+
+        Returns:
+        - tuple: A tuple containing two dictionaries.
+                The first dictionary contains metadata_params,
+                and the second dictionary query_params.
+        """
+        query_params = {}
+        metadata_params = {}
+
+        for key, value in parameters.items():
+            if key.startswith("__"):
+                metadata_params[key] = value
+            else:
+                query_params[key] = value
+
+        return query_params, metadata_params

api_foundry_query_engine-0.0.1/api_foundry_query_engine/connectors/connection.py

@@ -0,0 +1,32 @@
+from api_foundry_query_engine.utils.logger import logger
+
+# Initialize the logger
+log = logger(__name__)
+
+db_config_map = dict()
+
+
+class Cursor:
+    def execute(self, sql: str, params: dict, selection_results: dict) -> list[dict]:
+        raise NotImplementedError
+
+    def close(self):
+        raise NotImplementedError
+
+
+class Connection:
+    def __init__(self, db_config: dict) -> None:
+        super().__init__()
+        self.db_config = db_config
+
+    def engine(self) -> str:
+        return self.db_config["engine"]
+
+    def cursor(self) -> Cursor:
+        raise NotImplementedError
+
+    def commit(self):
+        raise NotImplementedError
+
+    def close(self):
+        raise NotImplementedError

api_foundry_query_engine-0.0.1/api_foundry_query_engine/connectors/connection_factory.py

@@ -0,0 +1,110 @@
+import boto3
+import json
+import os
+
+from api_foundry_query_engine.connectors.connection import Connection
+from api_foundry_query_engine.utils.app_exception import ApplicationException
+from api_foundry_query_engine.utils.logger import logger
+
+log = logger(__name__)
+
+
+class ConnectionFactory:
+    db_config_map: dict[str, dict]
+
+    def __init__(self):
+        self.db_config_map = dict()
+
+    def get_connection(self, database: str) -> Connection:
+        """
+        Factory function to create a database connector based on the
+        specified engine and schema.
+
+        Args:
+        - engine (str): The database engine type
+                ('postgres', 'oracle', or 'mysql').
+        - schema (str): The schema for the database.
+
+        Returns:
+        - Connector: An instance of the appropriate Connector subclass.
+        """
+
+        # Get the secret name based on the engine and database from the secrets map
+        log.info(f"database: {database}")
+        db_config = self.db_config_map.get(database)
+        if not db_config:
+            secret_name = json.loads(os.environ.get("SECRETS", "{}")).get(database)
+            log.info(f"secret_name: {secret_name}")
+
+            if secret_name:
+                db_config = self.__get_secret(secret_name)
+            else:
+                raise ValueError(f"Secret not found for database: {database}")
+
+        engine = db_config.get("engine")
+        if not engine:
+            raise ApplicationException(
+                500, "Database 'engine' is not defined in the secret."
+            )
+
+        if engine == "postgres":
+            from .postgres_connection import PostgresConnection
+
+            return PostgresConnection(db_config)
+
+        # Add support for other engines here if needed in the future
+
+        raise ValueError(f"Unsupported database engine: {engine}")
+
+    def __get_secret(self, db_secret_name: str):
+        """
+        Get the secret from AWS Secrets Manager.
+
+        Parameters:
+        - db_secret_name (str): The name of the AWS Secrets Manager secret.
+
+        Returns:
+        - dict: The database configuration obtained from the secret.
+        """
+        endpoint_url = os.environ.get("AWS_ENDPOINT_URL")  # LocalStack endpoint
+        sts_client = boto3.client("sts", endpoint_url=endpoint_url)
+
+        secret_account_id = os.environ.get("SECRET_ACCOUNT_ID", None)
+        log.info(f"secret_account_id: {secret_account_id}")
+
+        if secret_account_id:
+            # If a secret account ID is provided, assume a role in that account
+            secret_role = os.environ.get("ROLE_NAME", None)
+            assume_role_response = sts_client.assume_role(
+                RoleArn=f"arn:aws:iam::{secret_account_id}:role/{secret_role}",
+                RoleSessionName="AssumeRoleSession",
+            )
+
+            credentials = assume_role_response["Credentials"]
+
+            secretsmanager = boto3.client(
+                "secretsmanager",
+                aws_access_key_id=credentials["AccessKeyId"],
+                aws_secret_access_key=credentials["SecretAccessKey"],
+                aws_session_token=credentials["SessionToken"],
+                endpoint_url=endpoint_url,
+            )
+        else:
+            # If no secret account ID is provided, use the default account
+            log.info(f"endpoint_url: {endpoint_url}")
+            secretsmanager = boto3.client(
+                "secretsmanager",
+                #                endpoint_url=endpoint_url,
+            )
+
+        # Get the secret value from AWS Secrets Manager
+        log.info(f"db_secret_name: {db_secret_name}")
+        db_secret = secretsmanager.describe_secret(SecretId=db_secret_name)
+        db_secret = secretsmanager.get_secret_value(SecretId=db_secret_name)
+        log.debug(f"loading secret name: {db_secret}")
+
+        # Return the parsed JSON secret string
+        return json.loads(db_secret.get("SecretString"))
+
+
+connection_factory = ConnectionFactory()

api_foundry_query_engine-0.0.1/api_foundry_query_engine/connectors/oracle_connector.py

@@ -0,0 +1,29 @@
+from api_foundry_query_engine.utils.logger import logger
+from api_foundry_query_engine.utils.app_exception import ApplicationException
+from api_foundry_query_engine.connectors.connection import Connector
+
+log = logger(__name__)
+
+
+class OracleConnnector(Connector):
+    def __init__(self, db_secret_name: str) -> None:
+        super().__init__(db_secret_name)
+
+    def close(self):
+        pass
+
+    def execute(self, cursor, sql: str, parameters: dict):
+        from oracledb import Error, IntegrityError, ProgrammingError
+
+        log.debug(f"sql: {sql}, parameters: {parameters}")
+        try:
+            cursor.execute(sql, parameters)
+        except IntegrityError as err:
+            (error,) = err.args
+            raise ApplicationException(409, error.message)
+        except ProgrammingError as err:
+            (error,) = err.args
+            raise ApplicationException(400, error.message)
+        except Error as err:
+            (error,) = err.args
+            raise ApplicationException(500, error.message)