boto3-assist 0.9.4__tar.gz → 0.10.0__tar.gz

{boto3_assist-0.9.4 → boto3_assist-0.10.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: boto3_assist
-Version: 0.9.4
+Version: 0.10.0
 Summary: Additional boto3 wrappers to make your life a little easier
 Author-email: Eric Wilson <boto3-assist@geekcafe.com>
 License-File: LICENSE-EXPLAINED.txt
@@ -51,3 +51,19 @@ pip install boto3-assist
 
 ```
 
+## Running Unit Tests
+Several of our tests use a mocking library to simulate connections to S3, DynamoDB, etc.  In order to use those tests, you will need to have a `.env.unittest` file at the root of this project (which our tests will attempt to locate and load).  
+
+For your convenince the `.evn.unittest` file has been added to this project.  The values should not point to live AWS profiles, instead it should use the values added.
+
+Since we also point to a profile, you should create the profile in the `~/.aws/config` file.  The entry should look like the following:
+
+```toml
+[profile moto-mock-tests]
+region = us-east-1
+output = json
+aws_access_key_id = test
+aws_secret_access_key = test
+
+```
+

{boto3_assist-0.9.4 → boto3_assist-0.10.0}/README.md

@@ -28,3 +28,19 @@ pip install boto3-assist
 
 ```
 
+## Running Unit Tests
+Several of our tests use a mocking library to simulate connections to S3, DynamoDB, etc.  In order to use those tests, you will need to have a `.env.unittest` file at the root of this project (which our tests will attempt to locate and load).  
+
+For your convenince the `.evn.unittest` file has been added to this project.  The values should not point to live AWS profiles, instead it should use the values added.
+
+Since we also point to a profile, you should create the profile in the `~/.aws/config` file.  The entry should look like the following:
+
+```toml
+[profile moto-mock-tests]
+region = us-east-1
+output = json
+aws_access_key_id = test
+aws_secret_access_key = test
+
+```
+

{boto3_assist-0.9.4 → boto3_assist-0.10.0}/pyproject.toml

@@ -5,9 +5,13 @@ build-backend = "hatchling.build"
 [tool.hatch.build.targets.wheel]
 packages = ["src/boto3_assist"]
 
+[tool.pytest.ini_options]
+pythonpath = ["src"]
+testpaths = ["tests"]
+
 [project]
 name = "boto3_assist"
-version = "0.9.4"
+version = "0.10.0"
 
 authors = [
   { name="Eric Wilson", email="boto3-assist@geekcafe.com" }

{boto3_assist-0.9.4 → boto3_assist-0.10.0}/requirements-dev.txt

@@ -8,7 +8,7 @@ mypy_boto3_cloudwatch
 mypy_boto3_s3
 mypy_boto3_cognito_idp
 mypy_boto3_securityhub
-
+mypy_boto3_ssm
 moto [dynamodb2] # mocks for unit tests
 # setuptools
 types-python-dateutil

{boto3_assist-0.9.4 → boto3_assist-0.10.0}/src/boto3_assist/aws_lambda/mock_context.py

@@ -1,4 +1,5 @@
 from aws_lambda_powertools.utilities.typing import LambdaContext
 
 
-class MockLambdaContext(LambdaContext)
+class MockLambdaContext(LambdaContext):
+    pass

{boto3_assist-0.9.4 → boto3_assist-0.10.0}/src/boto3_assist/boto3session.py

@@ -63,6 +63,9 @@ class Boto3SessionManager:
             logger.debug("Connecting without assuming a role.")
             self.__session = self.__get_aws_session(profile, region)
 
+        if profile:
+            print(f"Connecting with a profile: {profile}")
+
     def __assume_role(self):
         """Assume an AWS IAM role."""
         try:

{boto3_assist-0.9.4 → boto3_assist-0.10.0}/src/boto3_assist/cognito/cognito_utility.py

@@ -12,7 +12,7 @@ from aws_lambda_powertools import Logger
 
 from boto3_assist.cognito.user import CognitoUser
 from boto3_assist.utilities.string_utility import StringUtility
-from boto3_assist.utilities.dictionaroy_utility import DictionaryUtilitiy
+from boto3_assist.utilities.dictionary_utility import DictionaryUtilitiy
 from boto3_assist.cognito.cognito_connection import CognitoConnection
 
 logger = Logger()

{boto3_assist-0.9.4 → boto3_assist-0.10.0}/src/boto3_assist/dynamodb/dynamodb.py

@@ -7,7 +7,7 @@ MIT License.  See Project Root for the license information.
 import os
 from typing import List, Optional, overload, Dict, Any
 
-from aws_lambda_powertools import Tracer, Logger
+from aws_lambda_powertools import Logger
 from boto3.dynamodb.conditions import (
     Key,
     # And,
@@ -22,7 +22,7 @@ from boto3_assist.utilities.string_utility import StringUtility
 
 
 logger = Logger()
-tracer = Tracer()
+
 
 
 class DynamoDB(DynamoDBConnection):
@@ -55,7 +55,7 @@ class DynamoDB(DynamoDBConnection):
         )
         logger.setLevel(os.getenv("LOG_LEVEL", "INFO"))
 
-    @tracer.capture_method
+    
     def save(
         self,
         item: dict | DynamoDBModelBase,
@@ -169,7 +169,7 @@ class DynamoDB(DynamoDBConnection):
         call_type: str = "resource",
     ) -> Dict[str, Any]: ...
 
-    @tracer.capture_method
+    
     def get(
         self,
         key: Optional[dict] = None,
@@ -344,7 +344,7 @@ class DynamoDB(DynamoDBConnection):
     ) -> dict:
         pass
 
-    @tracer.capture_method
+    
     def delete(
         self,
         *,

{boto3_assist-0.9.4 → boto3_assist-0.10.0}/src/boto3_assist/dynamodb/dynamodb_helpers.py

@@ -7,11 +7,11 @@ MIT License.  See Project Root for the license information.
 from typing import List, Any, Dict
 
 from boto3.dynamodb.conditions import ConditionBase, Key, And, Equals
-from aws_lambda_powertools import Tracer, Logger
+from aws_lambda_powertools import Logger
 from boto3_assist.dynamodb.dynamodb_index import DynamoDBIndex
 
 logger = Logger()
-tracer = Tracer()
+
 
 
 class DynamoDBHelpers:
@@ -118,7 +118,7 @@ class DynamoDBHelpers:
             logger.error({"exception": str(e)})
             return "unknown"
 
-    @tracer.capture_method(capture_response=False)
+    
     def wrap_response(self, items, dynamodb_response: dict, diagnostics) -> dict:
         """A wrapper for response data"""
         last_key = dynamodb_response.get("LastEvaluatedKey", None)
@@ -135,8 +135,7 @@ class DynamoDBHelpers:
         }
 
         return response
-
-    @tracer.capture_method(capture_response=False)
+    
     def wrap_collection_response(self, collection: List[dict]) -> dict[str, List]:
         """
         Wraps Up Some usefull information when dealing with

{boto3_assist-0.9.4 → boto3_assist-0.10.0}/src/boto3_assist/s3/s3_object.py

@@ -593,12 +593,7 @@ class S3Object:
         If running in AWS Lambda, returns '/tmp'.
         Otherwise, returns the system's standard temp directory.
         """
-        if "AWS_LAMBDA_FUNCTION_NAME" in os.environ:
-            # In AWS Lambda environment
-            return "/tmp"
-        else:
-            # Not in AWS Lambda, use the system's default temp directory
-            return tempfile.gettempdir()
+        return FileOperations.get_tmp_directory()
 
     def encode(
         self, text: str, encoding: str = "utf-8", errors: str = "strict"

boto3_assist-0.10.0/src/boto3_assist/ssm/connection.py

@@ -0,0 +1,57 @@
+"""
+Geek Cafe, LLC
+Maintainers: Eric Wilson
+MIT License.  See Project Root for the license information.
+"""
+
+from typing import Optional
+from typing import TYPE_CHECKING
+
+from aws_lambda_powertools import Logger
+
+from boto3_assist.connection import Connection
+
+if TYPE_CHECKING:
+    from mypy_boto3_ssm import Client
+else:
+    Client = object
+
+
+logger = Logger()
+
+
+class SSMConnection(Connection):
+    """Connection"""
+
+    def __init__(
+        self,
+        *,
+        aws_profile: Optional[str] = None,
+        aws_region: Optional[str] = None,
+        aws_end_point_url: Optional[str] = None,
+        aws_access_key_id: Optional[str] = None,
+        aws_secret_access_key: Optional[str] = None,
+    ) -> None:
+        super().__init__(
+            service_name="ssm",
+            aws_profile=aws_profile,
+            aws_region=aws_region,
+            aws_access_key_id=aws_access_key_id,
+            aws_secret_access_key=aws_secret_access_key,
+            aws_end_point_url=aws_end_point_url,
+        )
+
+        self.__client: Client | None = None
+
+    @property
+    def client(self) -> Client:
+        """Client Connection"""
+        if self.__client is None:
+            self.__client = self.session.client
+
+        return self.__client
+
+    @client.setter
+    def client(self, value: Client):
+        logger.info("Setting Client")
+        self.__client = value

boto3_assist-0.10.0/src/boto3_assist/ssm/parameter_store/parameter_store.py

@@ -0,0 +1,116 @@
+"""
+Geek Cafe, LLC
+Maintainers: Eric Wilson
+MIT License.  See Project Root for the license information.
+"""
+
+from typing import Optional, Literal
+
+from botocore.exceptions import ClientError
+from boto3_assist.ssm.connection import SSMConnection
+
+
+class ParameterStore(SSMConnection):
+    """Parameter Store"""
+
+    def get_parameter(self, name: str, with_decryption=True):
+        """
+        Retrieve a parameter from Parameter Store.
+
+        :param name: The full name of the parameter.
+        :param with_decryption: If True, decrypt secure strings.
+        :return: The parameter value or None if an error occurs.
+        """
+        try:
+            response = self.client.get_parameter(
+                Name=name, WithDecryption=with_decryption
+            )
+            return response["Parameter"]["Value"]
+        except ClientError as e:
+            print(f"Error getting parameter {name}: {e}")
+            raise
+
+    def put_parameter(
+        self,
+        name: str,
+        value: str,
+        type: Literal["String", "StringList", "SecureString"] = "String",  # pylint: disable=redefined-builtin
+        overwrite=True,
+    ):
+        """
+        Create or update a parameter in Parameter Store.
+
+        :param name: The full name of the parameter.
+        :param value: The value to store.
+        :param type: Parameter type ('String', 'StringList', or 'SecureString').
+        :param overwrite: If True, overwrite an existing parameter.
+        :return: The response from the put_parameter call or None on error.
+        """
+        try:
+            response = self.client.put_parameter(
+                Name=name, Value=value, Type=type, Overwrite=overwrite
+            )
+            return response
+        except ClientError as e:
+            print(f"Error putting parameter {name}: {e}")
+            raise
+
+    def delete_parameter(self, name: str):
+        """
+        Delete a parameter from Parameter Store.
+
+        :param name: The full name of the parameter.
+        :return: The response from the delete_parameter call or None on error.
+        """
+        try:
+            response = self.client.delete_parameter(Name=name)
+            return response
+        except ClientError as e:
+            print(f"Error deleting parameter {name}: {e}")
+            raise
+
+    def list_parameters(self, path: str = "/", recursive=True):
+        """
+        List parameters in a given path.
+
+        :param path: The hierarchical path for the parameters.
+        :param recursive: If True, retrieve parameters recursively.
+        :return: A list of parameter metadata dictionaries.
+        """
+        try:
+            paginator = self.client.get_paginator("describe_parameters")
+            parameters = []
+            filters = [
+                {
+                    "Key": "Path",
+                    "Option": "Recursive" if recursive else "OneLevel",
+                    "Values": [path],
+                }
+            ]
+            for page in paginator.paginate(ParameterFilters=filters):
+                parameters.extend(page.get("Parameters", []))
+            return parameters
+        except ClientError as e:
+            print(f"Error listing parameters for path {path}: {e}")
+            raise
+
+
+# Example usage:
+if __name__ == "__main__":
+    # Initialize the ParameterStore class.
+    ssm = ParameterStore()
+    # Example: Put a parameter.
+    put_response = ssm.put_parameter("/myapp/AccountNumber", "123456789012")
+    print("Put parameter response:", put_response)
+
+    # Example: Get a parameter.
+    account_number = ssm.get_parameter("/myapp/AccountNumber")
+    print("Account Number:", account_number)
+
+    # Example: List parameters under /myapp.
+    params = ssm.list_parameters(path="/myapp")
+    print("Parameters under /myapp:", params)
+
+    # Example: Delete a parameter.
+    delete_response = ssm.delete_parameter("/myapp/AccountNumber")
+    print("Delete parameter response:", delete_response)

{boto3_assist-0.9.4 → boto3_assist-0.10.0}/src/boto3_assist/utilities/datetime_utility.py

@@ -1,12 +1,18 @@
+"""
+Geek Cafe, LLC
+Maintainers: Eric Wilson
+MIT License.  See Project Root for the license information.
+"""
+
 import uuid
 from datetime import UTC, datetime, timedelta, timezone
 from typing import Any
 import pytz  # type: ignore
-from aws_lambda_powertools import Tracer, Logger
+from aws_lambda_powertools import Logger
 from dateutil.relativedelta import relativedelta
 
 
-tracer = Tracer()
+
 logger = Logger()
 
 _last_timestamp = None
@@ -41,7 +47,7 @@ class DatetimeUtility:
         return datetime.now(timezone.utc)
 
     @staticmethod
-    @tracer.capture_method(capture_response=False)
+    
     def string_to_date(string_date: str | datetime) -> datetime | None:
         """
         Description: takes a string value and returns it as a datetime.

boto3_assist-0.9.4/src/boto3_assist/utilities/dictionaroy_utility.py → boto3_assist-0.10.0/src/boto3_assist/utilities/dictionary_utility.py

@@ -1,3 +1,9 @@
+"""
+Geek Cafe, LLC
+Maintainers: Eric Wilson
+MIT License.  See Project Root for the license information.
+"""
+
 from typing import List
 
 

{boto3_assist-0.9.4 → boto3_assist-0.10.0}/src/boto3_assist/utilities/file_operations.py

@@ -1,13 +1,16 @@
+"""
+Geek Cafe, LLC
+Maintainers: Eric Wilson
+MIT License.  See Project Root for the license information.
+"""
+
 import os
+
 import shutil
-import json
-import zipfile
-from typing import List, Any, Dict
-from pathlib import Path
-import re
+import tempfile
 
-from aws_lambda_powertools import Logger
 
+from aws_lambda_powertools import Logger
 
 logger = Logger()
 
@@ -113,3 +116,20 @@ class FileOperations:
                 logger.debug(f"extension after prefix removal: {extention}")
 
         return extention
+
+    @staticmethod
+    def get_tmp_directory() -> str:
+        """
+        Get the temp directory
+        """
+        # are we in an aws lambda function?
+        if os.environ.get("AWS_LAMBDA_FUNCTION_NAME"):
+            # we are in a lambda function /tmp is the only place
+            # we can write to
+            if not os.path.exists("/tmp"):
+                raise ValueError("Temp directory does not exist.")
+
+            tmp_dir = "/tmp"
+            return tmp_dir
+
+        return tempfile.gettempdir()

{boto3_assist-0.9.4 → boto3_assist-0.10.0}/src/boto3_assist/utilities/http_utility.py

@@ -1,3 +1,9 @@
+"""
+Geek Cafe, LLC
+Maintainers: Eric Wilson
+MIT License.  See Project Root for the license information.
+"""
+
 from urllib.parse import unquote
 from typing import Dict, Any
 

{boto3_assist-0.9.4 → boto3_assist-0.10.0}/src/boto3_assist/utilities/numbers_utility.py

@@ -1,3 +1,9 @@
+"""
+Geek Cafe, LLC
+Maintainers: Eric Wilson
+MIT License.  See Project Root for the license information.
+"""
+
 import math
 from typing import List, Optional
 from aws_lambda_powertools import Logger

{boto3_assist-0.9.4 → boto3_assist-0.10.0}/src/boto3_assist/utilities/serialization_utility.py

@@ -1,4 +1,8 @@
-"""Serialization Utility"""
+"""
+Geek Cafe, LLC
+Maintainers: Eric Wilson
+MIT License.  See Project Root for the license information.
+"""
 
 import datetime as dt
 import decimal
@@ -8,7 +12,7 @@ import uuid
 from datetime import datetime
 from decimal import Decimal
 from typing import Any, Dict, List, TypeVar
-
+import re
 from aws_lambda_powertools import Logger
 
 T = TypeVar("T")
@@ -99,6 +103,114 @@ class JsonEncoder(json.JSONEncoder):
             )  # Or any other way you wish to serialize objects without __dict__
 
 
+class JsonConversions:
+    """
+    Json Conversion Utility
+    Used for snake_case to camelCase and vice versa
+    """
+
+    @staticmethod
+    def _camel_to_snake(value: str) -> str:
+        """Converts a camelCase to a snake_case"""
+        # Insert underscores before uppercase letters, then convert to lowercase.
+        s1 = re.sub(r"(.)([A-Z][a-z]+)", r"\1_\2", value)
+        return re.sub(r"([a-z0-9])([A-Z])", r"\1_\2", s1).lower()
+
+    @staticmethod
+    def _snake_to_camel(value: str) -> str:
+        """Converts a value from snake_case to camelCase"""
+        # Split the value by underscores and capitalize each component except the first.
+        components = value.split("_")
+        return components[0] + "".join(x.title() for x in components[1:])
+
+    @staticmethod
+    def _convert_keys(data, convert_func, deep: bool = True):
+        """
+        Recursively converts dictionary keys using the provided convert_func.
+
+        Parameters:
+        data: The input data (dict, list, or other) to process.
+        convert_func: Function to convert the keys (e.g. camel_to_snake or snake_to_camel).
+        deep (bool): If True (default), convert keys in all nested dictionaries.
+                    If False, only convert the keys at the current level.
+        """
+        if isinstance(data, dict):
+            new_dict = {}
+            for key, value in data.items():
+                new_key = convert_func(key)
+                # Only process nested structures if deep is True.
+                new_dict[new_key] = (
+                    JsonConversions._convert_keys(value, convert_func, deep)
+                    if deep
+                    else value
+                )
+            return new_dict
+        elif isinstance(data, list):
+            # For lists, if deep conversion is enabled, process each element.
+            return [
+                JsonConversions._convert_keys(item, convert_func, deep)
+                if deep
+                else item
+                for item in data
+            ]
+        else:
+            return data
+
+    @staticmethod
+    def json_camel_to_snake(data, deep: bool = True):
+        """Converts all keys in the JSON structure from camelCase to snake_case.
+
+        Parameters:
+        data: The JSON-like structure (dict or list) to process.
+        deep (bool): If True, process keys in all nested dictionaries; if False, only at the first level.
+        """
+        return JsonConversions._convert_keys(
+            data, JsonConversions._camel_to_snake, deep
+        )
+
+    @staticmethod
+    def json_snake_to_camel(data, deep: bool = True):
+        """Converts all keys in the JSON structure from snake_case to camelCase.
+
+        Parameters:
+        data: The JSON-like structure (dict or list) to process.
+        deep (bool): If True, process keys in all nested dictionaries; if False, only at the first level.
+        """
+        return JsonConversions._convert_keys(
+            data, JsonConversions._snake_to_camel, deep
+        )
+
+    # # Example usage:
+    # if __name__ == "__main__":
+    #     sample_json = {
+    #         "firstName": "John",
+    #         "lastName": "Doe",
+    #         "address": {"streetAddress": "21 2nd Street", "city": "New York"},
+    #         "phoneNumbers": [
+    #             {"phoneType": "home", "phoneNumber": "2125551234"},
+    #             {"phoneType": "fax", "phoneNumber": "6465554567"},
+    #         ],
+    #     }
+
+    #     print("Original JSON:")
+    #     print(sample_json)
+
+    #     # Convert from camelCase to snake_case on all levels.
+    #     snake_json_deep = json_camel_to_snake(sample_json, deep=True)
+    #     print("\nConverted to snake_case (deep conversion):")
+    #     print(snake_json_deep)
+
+    #     # Convert from camelCase to snake_case only at the first level.
+    #     snake_json_shallow = json_camel_to_snake(sample_json, deep=False)
+    #     print("\nConverted to snake_case (first-level only):")
+    #     print(snake_json_shallow)
+
+    #     # Convert back from snake_case to camelCase on all levels.
+    #     camel_json_deep = json_snake_to_camel(snake_json_deep, deep=True)
+    #     print("\nConverted back to camelCase (deep conversion):")
+    #     print(camel_json_deep)
+
+
 class Serialization:
     """
     Serialization Class

boto3_assist-0.10.0/src/boto3_assist/version.py

@@ -0,0 +1 @@
+__version__ = '0.10.0'

boto3_assist-0.10.0/tests/parameter_store/parameter_store_test.py

@@ -0,0 +1,35 @@
+"""
+Geek Cafe, LLC
+Maintainers: Eric Wilson
+MIT License.  See Project Root for the license information.
+"""
+
+import unittest
+
+import moto
+
+from boto3_assist.environment_services.environment_loader import EnvironmentLoader
+from boto3_assist.ssm.parameter_store.parameter_store import ParameterStore
+
+
+@moto.mock_aws
+class ParameterStoreTest(unittest.TestCase):
+    """Parameter store tests - with mocking"""
+
+    def setUp(self):
+        """Setup"""
+        ev: EnvironmentLoader = EnvironmentLoader()
+        # NOTE: you need to make sure the the env file below exists or you will get an error
+        # this also requires the @moto.mock_aws decorator
+        ev.load_environment_file(file_name=".env.unittest")
+        # ev.load_environment_file(file_name=".env")
+
+    def test_get_parameter(self):
+        parameter_store = ParameterStore()
+        parameter_name = "/dev/test"
+        parameter_value = "test_1"
+
+        parameter_store.put_parameter(parameter_name, parameter_value)
+        response = parameter_store.get_parameter(parameter_name)
+
+        self.assertEqual(response, parameter_value)

boto3_assist-0.9.4/src/boto3_assist/version.py

@@ -1 +0,0 @@
-__version__ = '0.9.4'