pygrestqlambda 0.0.0__py3-none-any.whl

pygrestqlambda/aws/lambda_function/json_transform.py

@@ -0,0 +1,18 @@
+from uuid import UUID
+from datetime import datetime
+
+
+def json_output(value: object) -> str:
+    """
+    Calculates the serialised version of an object to return in a JSON response
+    """
+
+    # Handle UUIDs
+    if isinstance(value, UUID):
+        value = str(value)
+
+    # Handle timestamps
+    if isinstance(value, datetime):
+        value = value.isoformat()
+
+    return value

pygrestqlambda/aws/lambda_function/proxy_integration_respose.py

@@ -0,0 +1,54 @@
+"""
+Receives payload in format sent by AWS REST API Gateway
+https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-lambda-proxy-integrations.html#api-gateway-simple-proxy-for-lambda-input-format
+
+Returns payload structure expected by REST API Gateway
+https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-lambda-proxy-integrations.html#api-gateway-simple-proxy-for-lambda-output-format
+"""
+
+import logging
+import json
+from dataclasses import dataclass
+from pygrestqlambda.aws.lambda_function.json_transform import json_output
+from base64 import b64encode
+
+
+@dataclass
+class LambdaFunctionProxyIntegrationResponse:
+    """
+    Lambda function response
+    """
+    is_base64_encoded: bool | None = False
+    status_code: int | None = 401
+    headers: dict | None = None
+    multi_value_headers: dict | None = None
+    body: str | None = None
+
+    def get_payload(self) -> dict:
+        """
+        Gets payload to send to REST API Gateway
+        """
+
+        # Set headers
+        if self.headers is None:
+            self.headers = {}
+
+        if "Content-Type" not in self.headers:
+            self.headers["Content-Type"] = "application/json"
+
+        # Calculate body
+        if self.is_base64_encoded:
+            body = b64encode(self.body).decode("utf-8")
+        else:
+            body = json.dumps(self.body, default=json_output)
+
+        logging.debug("Transforming dataclass dictionary to JSON")
+        data = {
+            "isBase64Encoded": self.is_base64_encoded,
+            "statusCode": self.status_code,
+            "headers": self.headers,
+            "multiValueHeaders": self.multi_value_headers,
+            "body": body,
+        }
+
+        return data

pygrestqlambda/db/record.py

@@ -0,0 +1,66 @@
+from abc import ABCMeta
+
+
+class Record(metaclass=ABCMeta):
+    """
+    Generic record that maps to a row in a database table
+    """
+
+    def __init__(self, conn: bool = False) -> None:
+        self.conn = conn
+
+    def before_create(self):
+        """
+        Runs before a new record is created. Useful for mutating a new record
+        before being committed.
+        """
+        pass
+
+    def before_read(self):
+        """
+        Before a record is retrieved from the database. Useful for injecting
+        filters or sorting.
+        """
+        pass
+
+    def before_update(self):
+        """
+        Before a new record is created. Useful for mutating a record before it
+        is committed.
+        """
+        pass
+
+    def before_delete(self):
+        """
+        Before an existing record is deleted. Useful for e.g. updating counters
+        or other aggregate fields in other tables.
+        """
+        pass
+
+    def after_create(self):
+        """
+        Runs after a new record is created. Useful for updating e.g. counters
+        tables.
+        """
+        pass
+
+    def after_read(self):
+        """
+        After a record is retrieved from the database. Useful for transforming
+        retrieved data.
+        """
+        pass
+
+    def after_update(self):
+        """
+        Runs after a new record is updated. Useful for updating e.g. counters
+        tables.
+        """
+        pass
+
+    def after_delete(self):
+        """
+        Runs after an existing record is deleted. Useful for updating e.g.
+        counters tables.
+        """
+        pass

pygrestqlambda-0.0.0.dist-info/METADATA

@@ -0,0 +1,34 @@
+Metadata-Version: 2.4
+Name: pygrestqlambda
+Version: 0.0.0
+Summary: PostgreSQL REST API framework for AWS Lambda functions
+Project-URL: Homepage, https://github.com/mesogate/pygrestqlambda
+Project-URL: Issues, https://github.com/mesogate/pygrestqlambda/issues
+Author-email: Voquis Limited <opensource@voquis.com>
+License-File: LICENSE
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.11
+Requires-Dist: aws-xray-sdk
+Requires-Dist: boto3
+Provides-Extra: dev
+Requires-Dist: build; extra == 'dev'
+Requires-Dist: pylint; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Requires-Dist: twine; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Python PostgreSQL REST API framework for AWS Lambda functions
+> [!NOTE]
+> Project status: `Alpha`
+
+A REST API web framework for persisting records in a PostgreSQL database.
+
+## Supported features
+- Automatic creation of `uid` fields
+- Automatic setting of `created_at` and `last_updated_at` timestamps
+- Automatic setting of `creator_uid` and `last_updater_uid`
+- RDS with IAM credentials

pygrestqlambda-0.0.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+pygrestqlambda/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pygrestqlambda/aws/lambda_function/json_transform.py,sha256=Jye6MxYb1vyU4Bz4aLIcYauMwAHrMCZPdUlF3AqdJTM,381
+pygrestqlambda/aws/lambda_function/proxy_integration_respose.py,sha256=TMnOk0RMFaDhbFk5ZAfCVQmN_mMKX5KpgKKxwisKV8I,1702
+pygrestqlambda/db/record.py,sha256=EoPJTWNfF2ieEV7if2neieF0VZsf2Fs44SW13h3fZcA,1577
+pygrestqlambda-0.0.0.dist-info/METADATA,sha256=t1_x_ZXzWSBxXfobwAZCxQ2C7Y_sB1fEtTTHiteqBUk,1233
+pygrestqlambda-0.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+pygrestqlambda-0.0.0.dist-info/licenses/LICENSE,sha256=8QeS1c5uv4AYoEG3M80OSCBuC_Pk-6vjU1VBUnlX2m0,1071
+pygrestqlambda-0.0.0.dist-info/RECORD,,

pygrestqlambda-0.0.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

pygrestqlambda-0.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Voquis Limited
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.