boto3-assist 0.16.0__tar.gz → 0.18.0__tar.gz

{boto3_assist-0.16.0 → boto3_assist-0.18.0}/.vscode/settings.json

@@ -26,5 +26,8 @@
         "editor.formatOnSave": true,        
         "editor.defaultFormatter": "ms-python.black-formatter",
     },
+    "cSpell.words": [
+        "addopts"
+    ],
     
 }

{boto3_assist-0.16.0 → boto3_assist-0.18.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: boto3_assist
-Version: 0.16.0
+Version: 0.18.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

{boto3_assist-0.16.0 → boto3_assist-0.18.0}/examples/dynamodb/models/order_item_model.py

@@ -36,15 +36,15 @@ class OrderItem(DynamoDBModelBase):
         # the primary key will be made off of the
         # order.id and this item.id
         # this will allow for a 1 to many search on the items related to an order
-        primay: DynamoDBIndex = DynamoDBIndex()
-        primay.name = "primary"
+        primary: DynamoDBIndex = DynamoDBIndex()
+        primary.name = "primary"
         # create a partition key off of the order key
-        primay.partition_key.attribute_name = "pk"
-        primay.partition_key.value = lambda: DynamoDBKey.build_key(
+        primary.partition_key.attribute_name = "pk"
+        primary.partition_key.value = lambda: DynamoDBKey.build_key(
             ("order", self.order_id)
         )
 
         # create the sort key off of this items id
-        primay.sort_key.attribute_name = "sk"
-        primay.sort_key.value = lambda: DynamoDBKey.build_key(("item", self.id))
-        self.indexes.add_primary(primay)
+        primary.sort_key.attribute_name = "sk"
+        primary.sort_key.value = lambda: DynamoDBKey.build_key(("item", self.id))
+        self.indexes.add_primary(primary)

{boto3_assist-0.16.0 → boto3_assist-0.18.0}/examples/dynamodb/models/order_model.py

@@ -43,13 +43,13 @@ class Order(DynamoDBModelBase):
 
     def __setup_indexes(self):
         # user id
-        primay: DynamoDBIndex = DynamoDBIndex()
-        primay.name = "primary"
-        primay.partition_key.attribute_name = "pk"
-        primay.partition_key.value = lambda: DynamoDBKey.build_key(("order", self.id))
-        primay.sort_key.attribute_name = "sk"
-        primay.sort_key.value = lambda: DynamoDBKey.build_key(("order", self.id))
-        self.indexes.add_primary(primay)
+        primary: DynamoDBIndex = DynamoDBIndex()
+        primary.name = "primary"
+        primary.partition_key.attribute_name = "pk"
+        primary.partition_key.value = lambda: DynamoDBKey.build_key(("order", self.id))
+        primary.sort_key.attribute_name = "sk"
+        primary.sort_key.value = lambda: DynamoDBKey.build_key(("order", self.id))
+        self.indexes.add_primary(primary)
 
         # all orders on a given day, sort by created date
         self.indexes.add_secondary(

{boto3_assist-0.16.0 → boto3_assist-0.18.0}/examples/dynamodb/models/product_model.py

@@ -33,13 +33,15 @@ class Product(DynamoDBModelBase):
         return f"{self.name} - ${self.price}"
 
     def __setup_indexes(self):
-        primay: DynamoDBIndex = DynamoDBIndex()
-        primay.name = "primary"
-        primay.partition_key.attribute_name = "pk"
-        primay.partition_key.value = lambda: DynamoDBKey.build_key(("product", self.id))
-        primay.sort_key.attribute_name = "sk"
-        primay.sort_key.value = lambda: DynamoDBKey.build_key(("product", self.id))
-        self.indexes.add_primary(primay)
+        primary: DynamoDBIndex = DynamoDBIndex()
+        primary.name = "primary"
+        primary.partition_key.attribute_name = "pk"
+        primary.partition_key.value = lambda: DynamoDBKey.build_key(
+            ("product", self.id)
+        )
+        primary.sort_key.attribute_name = "sk"
+        primary.sort_key.value = lambda: DynamoDBKey.build_key(("product", self.id))
+        self.indexes.add_primary(primary)
 
         self.indexes.add_secondary(
             DynamoDBIndex(

{boto3_assist-0.16.0 → boto3_assist-0.18.0}/examples/dynamodb/models/user_model.py

@@ -31,13 +31,13 @@ class User(DynamoDBModelBase):
 
     def __setup_indexes(self):
         # user id
-        primay: DynamoDBIndex = DynamoDBIndex()
-        primay.name = "primary"
-        primay.partition_key.attribute_name = "pk"
-        primay.partition_key.value = lambda: DynamoDBKey.build_key(("user", self.id))
-        primay.sort_key.attribute_name = "sk"
-        primay.sort_key.value = lambda: DynamoDBKey.build_key(("user", self.id))
-        self.indexes.add_primary(primay)
+        primary: DynamoDBIndex = DynamoDBIndex()
+        primary.name = "primary"
+        primary.partition_key.attribute_name = "pk"
+        primary.partition_key.value = lambda: DynamoDBKey.build_key(("user", self.id))
+        primary.sort_key.attribute_name = "sk"
+        primary.sort_key.value = lambda: DynamoDBKey.build_key(("user", self.id))
+        self.indexes.add_primary(primary)
 
         # find all users by email address
         gsi0: DynamoDBIndex = DynamoDBIndex(

{boto3_assist-0.16.0 → boto3_assist-0.18.0}/examples/dynamodb/models/user_post_model.py

@@ -33,7 +33,7 @@ class UserPost(DynamoDBModelBase):
         self.__setup_indexes()
 
     def __setup_indexes(self):
-        primay: DynamoDBIndex = DynamoDBIndex(
+        primary: DynamoDBIndex = DynamoDBIndex(
             index_name="primary",
             partition_key=DynamoDBKey(
                 attribute_name="pk",
@@ -44,7 +44,7 @@ class UserPost(DynamoDBModelBase):
                 value=lambda: f"post#{self.slug if self.slug else ''}",
             ),
         )
-        self.indexes.add_primary(primay)
+        self.indexes.add_primary(primary)
 
         gsi0: DynamoDBIndex = DynamoDBIndex(
             index_name="gsi0",

{boto3_assist-0.16.0 → boto3_assist-0.18.0}/pyproject.toml

@@ -15,7 +15,7 @@ addopts = "-m 'not integration'"
 
 [project]
 name = "boto3_assist"
-version = "0.16.0"
+version = "0.18.0"
 
 authors = [
   { name="Eric Wilson", email="boto3-assist@geekcafe.com" }

{boto3_assist-0.16.0 → boto3_assist-0.18.0}/src/boto3_assist/utilities/serialization_utility.py

@@ -12,8 +12,8 @@ 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
+from boto3_assist.utilities.string_utility import StringUtility
 
 T = TypeVar("T")
 
@@ -119,16 +119,12 @@ class JsonConversions:
     @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()
+        return StringUtility.camel_to_snake(value)
 
     @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:])
+        return StringUtility.snake_to_camel(value)
 
     @staticmethod
     def _convert_keys(data, convert_func, deep: bool = True):

{boto3_assist-0.16.0 → boto3_assist-0.18.0}/src/boto3_assist/utilities/string_utility.py

@@ -12,6 +12,7 @@ from datetime import datetime
 from decimal import Decimal
 import uuid
 import json
+import re
 from aws_lambda_powertools import Logger
 from boto3_assist.utilities.datetime_utility import DatetimeUtility
 
@@ -200,7 +201,7 @@ class StringUtility:
         namespace: uuid.UUID | str, unique_string: str, case_sensitive: bool = False
     ) -> str:
         """
-        Generates an idempotnent UUID, which is useful for creates
+        Generates an idempotent UUID, which is useful for creates
 
         Args:
             namespace (GUID | str): A namespace for your id, it must be a UUID or a string in a UUID format
@@ -320,3 +321,17 @@ class StringUtility:
             return False
         else:
             raise ValueError(f"Invalid boolean value: {value}")
+
+    @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:])

boto3_assist-0.18.0/src/boto3_assist/version.py

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

{boto3_assist-0.16.0/tests/unit/dynamodb_tests/dbmodels → boto3_assist-0.18.0/tests/unit/dynamodb_tests/db_models}/cms/base.py

@@ -15,7 +15,7 @@ from boto3_assist.dynamodb.dynamodb_model_base import (
 class BaseCMSDBModel(DynamoDBModelBase):
     """
     The Base DB Model
-    Sets a common set of proporrties for all models
+    Sets a common set of properties for all models
     """
 
     def __init__(self) -> None:

{boto3_assist-0.16.0/tests/unit/dynamodb_tests/dbmodels → boto3_assist-0.18.0/tests/unit/dynamodb_tests/db_models}/cms/content_block.py

@@ -7,7 +7,7 @@ MIT License.  See Project Root for the license information.
 import datetime as dt
 from boto3_assist.dynamodb.dynamodb_index import DynamoDBIndex, DynamoDBKey
 from boto3_assist.utilities.string_utility import StringUtility
-from tests.unit.dynamodb_tests.models.cms.base import BaseCMSDBModel
+from tests.unit.dynamodb_tests.db_models.cms.base import BaseCMSDBModel
 
 
 class ContentBlock(BaseCMSDBModel):
@@ -41,13 +41,13 @@ class ContentBlock(BaseCMSDBModel):
         self.__setup_indexes()
 
     def __setup_indexes(self):
-        primay: DynamoDBIndex = DynamoDBIndex()
-        primay.name = "primary"
-        primay.partition_key.attribute_name = "pk"
-        primay.partition_key.value = lambda: DynamoDBKey.build_key(
+        primary: DynamoDBIndex = DynamoDBIndex()
+        primary.name = "primary"
+        primary.partition_key.attribute_name = "pk"
+        primary.partition_key.value = lambda: DynamoDBKey.build_key(
             ("site", self.site_id), ("block-type", self.block_type)
         )
 
-        primay.sort_key.attribute_name = "sk"
-        primay.sort_key.value = lambda: DynamoDBKey.build_key(("content", self.id))
-        self.indexes.add_primary(primay)
+        primary.sort_key.attribute_name = "sk"
+        primary.sort_key.value = lambda: DynamoDBKey.build_key(("content", self.id))
+        self.indexes.add_primary(primary)

{boto3_assist-0.16.0/tests/unit/dynamodb_tests/dbmodels → boto3_assist-0.18.0/tests/unit/dynamodb_tests/db_models}/cms/page.py

@@ -7,7 +7,7 @@ MIT License.  See Project Root for the license information.
 from typing import List, Dict, Any
 import datetime as dt
 from boto3_assist.dynamodb.dynamodb_index import DynamoDBIndex, DynamoDBKey
-from tests.unit.dynamodb_tests.dbmodels.cms.base import BaseCMSDBModel
+from tests.unit.dynamodb_tests.db_models.cms.base import BaseCMSDBModel
 
 
 class Page(BaseCMSDBModel):
@@ -45,16 +45,16 @@ class Page(BaseCMSDBModel):
         self.__setup_indexes()
 
     def __setup_indexes(self):
-        primay: DynamoDBIndex = DynamoDBIndex()
-        primay.name = "primary"
-        primay.partition_key.attribute_name = "pk"
-        primay.partition_key.value = lambda: DynamoDBKey.build_key(
+        primary: DynamoDBIndex = DynamoDBIndex()
+        primary.name = "primary"
+        primary.partition_key.attribute_name = "pk"
+        primary.partition_key.value = lambda: DynamoDBKey.build_key(
             ("site", self.site_id), ("pages", None)
         )
 
-        primay.sort_key.attribute_name = "sk"
-        primay.sort_key.value = lambda: DynamoDBKey.build_key(("page", self.slug))
-        self.indexes.add_primary(primay)
+        primary.sort_key.attribute_name = "sk"
+        primary.sort_key.value = lambda: DynamoDBKey.build_key(("page", self.slug))
+        self.indexes.add_primary(primary)
 
         gsi1: DynamoDBIndex = DynamoDBIndex()
         gsi1.name = "gsi1"
@@ -69,7 +69,7 @@ class Page(BaseCMSDBModel):
     @property
     def id(self) -> str:
         """The id for the page"""
-        return f"{self.site_id}/{self.slug}"
+        return f"{self.site_id}/{self.type}/{self.slug}"
 
     @id.setter
     def id(self, id: str):

{boto3_assist-0.16.0/tests/unit/dynamodb_tests/dbmodels → boto3_assist-0.18.0/tests/unit/dynamodb_tests/db_models}/cms/template.py

@@ -6,7 +6,7 @@ MIT License.  See Project Root for the license information.
 
 from typing import List
 from boto3_assist.dynamodb.dynamodb_index import DynamoDBIndex, DynamoDBKey
-from tests.unit.dynamodb_tests.dbmodels.cms.base import BaseCMSDBModel
+from tests.unit.dynamodb_tests.db_models.cms.base import BaseCMSDBModel
 
 
 class Template(BaseCMSDBModel):
@@ -28,16 +28,16 @@ class Template(BaseCMSDBModel):
         self.__setup_indexes()
 
     def __setup_indexes(self):
-        primay: DynamoDBIndex = DynamoDBIndex()
-        primay.name = "primary"
-        primay.partition_key.attribute_name = "pk"
-        primay.partition_key.value = lambda: DynamoDBKey.build_key(
+        primary: DynamoDBIndex = DynamoDBIndex()
+        primary.name = "primary"
+        primary.partition_key.attribute_name = "pk"
+        primary.partition_key.value = lambda: DynamoDBKey.build_key(
             ("site", self.site_id), ("templates", None)
         )
 
-        primay.sort_key.attribute_name = "sk"
-        primay.sort_key.value = lambda: DynamoDBKey.build_key(("template", self.title))
-        self.indexes.add_primary(primay)
+        primary.sort_key.attribute_name = "sk"
+        primary.sort_key.value = lambda: DynamoDBKey.build_key(("template", self.title))
+        self.indexes.add_primary(primary)
 
         gsi1: DynamoDBIndex = DynamoDBIndex()
         gsi1.name = "gsi1"
@@ -52,8 +52,10 @@ class Template(BaseCMSDBModel):
     @property
     def s3_object_key(self) -> str:
         """The s3 object key for the template"""
-        return f"{self.site_id}/{self.title}"
+        return f"{self.site_id}/template/{self.type}/{self.title}"
 
     @s3_object_key.setter
     def s3_object_key(self, value: str):
+        # we don't set this field, but we also don't
+        # want an error during the serialization process
         pass

{boto3_assist-0.16.0/tests/unit/dynamodb_tests/dbmodels → boto3_assist-0.18.0/tests/unit/dynamodb_tests/db_models}/user_model.py

@@ -30,13 +30,13 @@ class User(DynamoDBModelBase):
         self.__setup_indexes()
 
     def __setup_indexes(self):
-        primay: DynamoDBIndex = DynamoDBIndex()
-        primay.partition_key.attribute_name = "pk"
+        primary: DynamoDBIndex = DynamoDBIndex()
+        primary.partition_key.attribute_name = "pk"
         # allows for a wild card search on all "sites"
-        primay.partition_key.value = lambda: DynamoDBKey.build_key(("user", self.id))
-        primay.sort_key.attribute_name = "sk"
-        primay.sort_key.value = lambda: DynamoDBKey.build_key(("user", self.id))
-        self.indexes.add_primary(primay)
+        primary.partition_key.value = lambda: DynamoDBKey.build_key(("user", self.id))
+        primary.sort_key.attribute_name = "sk"
+        primary.sort_key.value = lambda: DynamoDBKey.build_key(("user", self.id))
+        self.indexes.add_primary(primary)
 
         gsi0: DynamoDBIndex = DynamoDBIndex(index_name="gsi0")
         gsi0.partition_key.attribute_name = "gsi0_pk"

{boto3_assist-0.16.0/tests/unit/dynamodb_tests/dbmodels → boto3_assist-0.18.0/tests/unit/dynamodb_tests/db_models}/user_required_fields_model.py

@@ -30,13 +30,13 @@ class User(DynamoDBModelBase):
         self.__setup_indexes()
 
     def __setup_indexes(self):
-        primay: DynamoDBIndex = DynamoDBIndex()
-        primay.partition_key.attribute_name = "pk"
+        primary: DynamoDBIndex = DynamoDBIndex()
+        primary.partition_key.attribute_name = "pk"
         # allows for a wild card search on all "sites"
-        primay.partition_key.value = lambda: DynamoDBKey.build_key(("user", self.id))
-        primay.sort_key.attribute_name = "sk"
-        primay.sort_key.value = lambda: DynamoDBKey.build_key(("user", self.id))
-        self.indexes.add_primary(primay)
+        primary.partition_key.value = lambda: DynamoDBKey.build_key(("user", self.id))
+        primary.sort_key.attribute_name = "sk"
+        primary.sort_key.value = lambda: DynamoDBKey.build_key(("user", self.id))
+        self.indexes.add_primary(primary)
 
         gsi0: DynamoDBIndex = DynamoDBIndex(index_name="gsi0")
         gsi0.partition_key.attribute_name = "gsi0_pk"

{boto3_assist-0.16.0 → boto3_assist-0.18.0}/tests/unit/dynamodb_tests/dynamodb_model_base_test.py

@@ -9,14 +9,14 @@ from typing import Dict, List
 
 from boto3_assist.dynamodb.dynamodb_index import DynamoDBIndex
 from boto3_assist.dynamodb.dynamodb_key import DynamoDBKey
-from tests.unit.dynamodb_tests.dbmodels.user_model import User
+from tests.unit.dynamodb_tests.db_models.user_model import User
 
 
 class DynamoDBModelUnitTest(unittest.TestCase):
     "Serialization Tests"
 
     def test_basic_serialization(self):
-        """Test Basic Serlization"""
+        """Test Basic Serialization"""
         # Arrange
         data = {
             "id": "123456",
@@ -39,7 +39,7 @@ class DynamoDBModelUnitTest(unittest.TestCase):
         self.assertIsInstance(key, dict)
 
     def test_object_serialization_map(self):
-        """Test Basic Serlization"""
+        """Test Basic Serialization"""
         # Arrange
         data = {
             "id": "123456",
@@ -60,7 +60,7 @@ class DynamoDBModelUnitTest(unittest.TestCase):
         self.assertIsInstance(serialized_data, User)
 
     def test_new_key_design_serialization_map(self):
-        """Test Basic Serlization"""
+        """Test Basic Serialization"""
         # Arrange
         data = {
             "id": "123456",

{boto3_assist-0.16.0 → boto3_assist-0.18.0}/tests/unit/dynamodb_tests/dynamodb_model_projections_test.py

@@ -7,15 +7,15 @@ MIT License.  See Project Root for the license information.
 import unittest
 
 
-from tests.unit.dynamodb_tests.dbmodels.user_model import User
-from tests.unit.dynamodb_tests.dbmodels.simple_model import Simple
+from tests.unit.dynamodb_tests.db_models.user_model import User
+from tests.unit.dynamodb_tests.db_models.simple_model import Simple
 
 
-class DynamoDBModeProjectionlUnitTest(unittest.TestCase):
+class DynamoDBModeProjectionUnitTest(unittest.TestCase):
     "Serialization Tests"
 
     def test_projection_expressions_transformation(self):
-        """Test Basic Serlization"""
+        """Test Basic Serialization"""
         # Arrange
         data = {
             "id": "123456",
@@ -53,7 +53,7 @@ class DynamoDBModeProjectionlUnitTest(unittest.TestCase):
         self.assertIn("status", attribute_names["#status"])
 
     def test_simple_model(self):
-        """Test Basic Serlization"""
+        """Test Basic Serialization"""
         # Arrange
         data = {
             "id": "123456",

{boto3_assist-0.16.0 → boto3_assist-0.18.0}/tests/unit/dynamodb_tests/dynamodb_model_serializtion_test.py

@@ -7,15 +7,15 @@ MIT License.  See Project Root for the license information.
 import unittest
 
 
-from tests.unit.dynamodb_tests.dbmodels.user_model import User
-from tests.unit.dynamodb_tests.dbmodels.user_required_fields_model import User as User2
+from tests.unit.dynamodb_tests.db_models.user_model import User
+from tests.unit.dynamodb_tests.db_models.user_required_fields_model import User as User2
 
 
-class DynamoDBModelSerializationUnitTest(unittest.TestCase):
+class Dynamodb_Model_SerializationUnitTest(unittest.TestCase):
     "Serialization Tests"
 
     def test_basic_serialization(self):
-        """Test Basic Serlization"""
+        """Test Basic Serialization"""
         # Arrange
         data = {
             "id": "123456",

{boto3_assist-0.16.0 → boto3_assist-0.18.0}/tests/unit/dynamodb_tests/dynamodb_moto_sorting_test.py

@@ -12,11 +12,11 @@ from mypy_boto3_dynamodb import DynamoDBClient
 
 from boto3_assist.dynamodb.dynamodb import DynamoDB
 from boto3_assist.environment_services.environment_loader import EnvironmentLoader
-from tests.unit.dynamodb_tests.dbmodels.cms.page import Page
+from tests.unit.dynamodb_tests.db_models.cms.page import Page
 
 
 @moto.mock_aws
-class DynamoDBSortinglUnitTest(unittest.TestCase):
+class DynamoDB_SortingUnitTest(unittest.TestCase):
     "Sorting Tests"
 
     def __init__(self, methodName="runTest"):

{boto3_assist-0.16.0 → boto3_assist-0.18.0}/tests/unit/utilities/serialization_utility_test.py

@@ -191,7 +191,7 @@ class SerializationUnitTest(unittest.TestCase):
     "Serialization Tests"
 
     def test_basic_serialization(self):
-        """Test Basic Serlization"""
+        """Test Basic Serialization"""
         # Arrange
         data = {
             "name": "John Doe",
@@ -219,7 +219,7 @@ class SerializationUnitTest(unittest.TestCase):
         self.assertEqual(user.authorization.groups[0], "Admin")
 
     def test_object_serialization_map(self):
-        """Test Basic Serlization"""
+        """Test Basic Serialization"""
         # Arrange
         data = {"name": "John Doe", "age": 30, "email": "john@example.com"}
 
@@ -233,7 +233,7 @@ class SerializationUnitTest(unittest.TestCase):
         self.assertEqual(serialized_data.email, "john@example.com")
 
     def test_object_serialization_map_resource(self):
-        """Ensure the db properties aren't carried over to sub objects during Serlization"""
+        """Ensure the db properties aren't carried over to sub objects during Serialization"""
         # Arrange
         subscription: Subscription = Subscription()
 

boto3_assist-0.16.0/src/boto3_assist/version.py

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