value-object-pattern 1.31.1__tar.gz → 1.32.0__tar.gz

{value_object_pattern-1.31.1 → value_object_pattern-1.32.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: value-object-pattern
-Version: 1.31.1
+Version: 1.32.0
 Summary: The Value Object Pattern is a Python package that streamlines the creation and management of value objects in your projects.
 Project-URL: Homepage, https://github.com/adriamontoto/value-object-pattern
 Project-URL: Repository, https://github.com/adriamontoto/value-object-pattern

{value_object_pattern-1.31.1 → value_object_pattern-1.32.0}/value_object_pattern/__init__.py

@@ -1,4 +1,4 @@
-__version__ = '1.31.1'
+__version__ = '1.32.0'
 
 from .decorators import process, validation
 from .models import BaseModel, EnumerationValueObject, UnionValueObject, ValueObject

{value_object_pattern-1.31.1 → value_object_pattern-1.32.0}/value_object_pattern/usables/__init__.py

@@ -1,6 +1,7 @@
 from .primitives import (
     AlphaStringValueObject,
     AlphanumericStringValueObject,
+    Base64StringValueObject,
     BooleanValueObject,
     BytesValueObject,
     CamelCaseStringValueObject,
@@ -37,6 +38,7 @@ from .primitives import (
 __all__ = (
     'AlphaStringValueObject',
     'AlphanumericStringValueObject',
+    'Base64StringValueObject',
     'BooleanValueObject',
     'BytesValueObject',
     'CamelCaseStringValueObject',

{value_object_pattern-1.31.1 → value_object_pattern-1.32.0}/value_object_pattern/usables/primitives/__init__.py

@@ -20,6 +20,7 @@ from .none import NoneValueObject, NotNoneValueObject
 from .string import (
     AlphaStringValueObject,
     AlphanumericStringValueObject,
+    Base64StringValueObject,
     CamelCaseStringValueObject,
     DigitStringValueObject,
     KebabCaseStringValueObject,
@@ -38,6 +39,7 @@ from .string import (
 __all__ = (
     'AlphaStringValueObject',
     'AlphanumericStringValueObject',
+    'Base64StringValueObject',
     'BooleanValueObject',
     'BytesValueObject',
     'CamelCaseStringValueObject',

{value_object_pattern-1.31.1 → value_object_pattern-1.32.0}/value_object_pattern/usables/primitives/string/__init__.py

@@ -1,5 +1,6 @@
 from .alpha_value_object import AlphaStringValueObject
 from .alphanumeric_value_object import AlphanumericStringValueObject
+from .base64_value_object import Base64StringValueObject
 from .camel_case_string_value_object import CamelCaseStringValueObject
 from .digit_value_object import DigitStringValueObject
 from .kebab_case_string_value_object import KebabCaseStringValueObject
@@ -17,6 +18,7 @@ from .uppercase_string_value_object import UppercaseStringValueObject
 __all__ = (
     'AlphaStringValueObject',
     'AlphanumericStringValueObject',
+    'Base64StringValueObject',
     'CamelCaseStringValueObject',
     'DigitStringValueObject',
     'KebabCaseStringValueObject',

value_object_pattern-1.32.0/value_object_pattern/usables/primitives/string/base64_value_object.py

@@ -0,0 +1,60 @@
+"""
+Base64StringValueObject value object.
+"""
+
+from base64 import b64decode, b64encode
+from binascii import Error
+from typing import NoReturn
+
+from value_object_pattern.decorators import validation
+
+from .trimmed_string_value_object import TrimmedStringValueObject
+
+
+class Base64StringValueObject(TrimmedStringValueObject):
+    """
+    Ensure the provided value is canonical standard Base64. The empty string is accepted as the Base64 encoding of
+    empty bytes.
+
+    Example:
+    ```python
+    from value_object_pattern.usables import Base64StringValueObject
+
+    string = Base64StringValueObject(value='aGVsbG8gd29ybGQ=')
+
+    print(repr(string))
+    # >>> Base64StringValueObject(value='aGVsbG8gd29ybGQ=')
+    ```
+    """
+
+    @validation(order=0)
+    def _ensure_value_is_base64(self, value: str) -> None:
+        """
+        Ensure the value is canonical standard Base64.
+
+        Args:
+            value (str): The provided value.
+
+        Raises:
+            ValueError: If the value is not canonical standard Base64.
+        """
+        try:
+            decoded_value = b64decode(s=value, validate=True)
+
+        except (Error, ValueError):
+            self._raise_value_is_not_base64(value=value)
+
+        if b64encode(s=decoded_value).decode() != value:
+            self._raise_value_is_not_base64(value=value)
+
+    def _raise_value_is_not_base64(self, value: str) -> NoReturn:
+        """
+        Raise a ValueError when the value is not canonical standard Base64.
+
+        Args:
+            value (str): The provided value.
+
+        Raises:
+            ValueError: Always raised because the value is not canonical standard Base64.
+        """
+        raise ValueError(f'Base64StringValueObject value <<<{value}>>> must be canonical standard Base64.')