cuenca-validations 2.0.5.dev3__tar.gz → 2.0.5.dev5__tar.gz

{cuenca_validations-2.0.5.dev3 → cuenca_validations-2.0.5.dev5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: cuenca_validations
-Version: 2.0.5.dev3
+Version: 2.0.5.dev5
 Summary: Cuenca common validations
 Home-page: https://github.com/cuenca-mx/cuenca-validations
 Author: Cuenca

{cuenca_validations-2.0.5.dev3 → cuenca_validations-2.0.5.dev5}/cuenca_validations/types/__init__.py

@@ -104,7 +104,7 @@ __all__ = [
     'digits',
     'get_state_name',
     'uuid_field',
-    'Metadata',
+    'LogConfig',
 ]
 
 from .card import StrictPaymentCardNumber
@@ -153,7 +153,7 @@ from .enums import (
 from .files import BatchFileMetadata
 from .general import (
     JSONEncoder,
-    Metadata,
+    LogConfig,
     SantizedDict,
     StrictPositiveInt,
     digits,

{cuenca_validations-2.0.5.dev3 → cuenca_validations-2.0.5.dev5}/cuenca_validations/types/general.py

@@ -86,6 +86,6 @@ def get_state_name(state: State):
 
 
 @dataclass
-class Metadata:
-    sensitive: bool
-    log_chars: int = 0
+class LogConfig:
+    masked: bool = False
+    unmasked_chars_length: int = 0

cuenca_validations-2.0.5.dev5/cuenca_validations/types/helpers.py

@@ -0,0 +1,22 @@
+import uuid
+from base64 import urlsafe_b64encode
+from typing import Callable, Optional
+
+from pydantic.fields import FieldInfo
+
+from .general import LogConfig
+
+
+def uuid_field(prefix: str = '') -> Callable[[], str]:
+    def base64_uuid_func() -> str:
+        return prefix + urlsafe_b64encode(uuid.uuid4().bytes).decode()[:-2]
+
+    return base64_uuid_func
+
+
+def get_log_config(field: FieldInfo) -> Optional[LogConfig]:
+    """Helper function to find LogConfig in field metadata"""
+    try:
+        return next(m for m in field.metadata if isinstance(m, LogConfig))
+    except StopIteration:
+        return None

{cuenca_validations-2.0.5.dev3 → cuenca_validations-2.0.5.dev5}/cuenca_validations/types/requests.py

@@ -55,7 +55,7 @@ from .card import (
     StrictPaymentCardNumber,
 )
 from .general import (
-    Metadata,
+    LogConfig,
     SerializableAnyUrl,
     SerializableHttpUrl,
     StrictPositiveInt,
@@ -496,7 +496,7 @@ class UserUpdateRequest(BaseModel):
 
 class UserLoginRequest(BaseRequest):
     password: Annotated[
-        str, Metadata(sensitive=True)
+        str, LogConfig(masked=True)
     ]  # Set password field to str for backward compatibility.
     user_id: Optional[str] = Field(None, description='Deprecated field')
     model_config = ConfigDict(

cuenca_validations-2.0.5.dev5/cuenca_validations/version.py

@@ -0,0 +1 @@
+__version__ = '2.0.5.dev5'

{cuenca_validations-2.0.5.dev3 → cuenca_validations-2.0.5.dev5}/cuenca_validations.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: cuenca_validations
-Version: 2.0.5.dev3
+Version: 2.0.5.dev5
 Summary: Cuenca common validations
 Home-page: https://github.com/cuenca-mx/cuenca-validations
 Author: Cuenca

{cuenca_validations-2.0.5.dev3 → cuenca_validations-2.0.5.dev5}/tests/test_types.py

@@ -6,7 +6,8 @@ from typing import Annotated
 
 import pytest
 from freezegun import freeze_time
-from pydantic import BaseModel, SecretStr, ValidationError
+from pydantic import AfterValidator, BaseModel, SecretStr, ValidationError
+from pydantic.fields import FieldInfo
 
 from cuenca_validations.types import (
     Address,
@@ -25,7 +26,9 @@ from cuenca_validations.types.enums import (
     SessionType,
     State,
 )
-from cuenca_validations.types.general import Metadata, StrictPositiveInt
+from cuenca_validations.types.general import LogConfig, StrictPositiveInt
+from cuenca_validations.types.helpers import get_log_config
+from cuenca_validations.types.identities import Password
 from cuenca_validations.types.requests import (
     ApiKeyUpdateRequest,
     BankAccountValidationRequest,
@@ -589,22 +592,60 @@ def test_strict_positive_int_invalid(value, expected_error, expected_message):
         IntModel(value=value)
 
 
-class MetadataModel(BaseModel):
-    secret: Annotated[str, Metadata(sensitive=True)]
-    partial_secret: Annotated[str, Metadata(sensitive=True, log_chars=4)]
+def validate_repeated_digits(password: str) -> str:
+    """
+    Example of a custom validator
+    Check if the str contains repeated numbers
+    """
+    import re
+
+    if re.search(r'(\d).*\1', password):
+        raise ValueError("str cannot contain repeated digits")
+    return password
+
+
+class LogConfigModel(BaseModel):
+    password: Annotated[Password, LogConfig(masked=True)]
+    validated: Annotated[
+        str, AfterValidator(validate_repeated_digits), LogConfig(masked=True)
+    ]
+    secret: Annotated[str, LogConfig(masked=True)]
+    partial_secret: Annotated[
+        str, LogConfig(masked=True, unmasked_chars_length=4)
+    ]
+
+
+def test_log_config():
+    model = LogConfigModel(
+        password="Mypass123.",
+        validated="str123",
+        secret="super-secret",
+        partial_secret="1234567890",
+    )
 
+    password_field = LogConfigModel.model_fields["password"]
+    validated_field = LogConfigModel.model_fields["validated"]
+    secret_field = LogConfigModel.model_fields["secret"]
+    partial_field = LogConfigModel.model_fields["partial_secret"]
 
-def test_metadata():
-    model = MetadataModel(secret="super-secret", partial_secret="1234567890")
+    assert get_log_config(password_field).masked is True
+    assert get_log_config(password_field).unmasked_chars_length == 0
 
-    secret_field = MetadataModel.model_fields["secret"]
-    partial_field = MetadataModel.model_fields["partial_secret"]
+    assert get_log_config(validated_field).masked is True
+    assert get_log_config(validated_field).unmasked_chars_length == 0
 
-    assert secret_field.metadata[0].sensitive is True
-    assert secret_field.metadata[0].log_chars == 0
+    assert get_log_config(secret_field).masked is True
+    assert get_log_config(secret_field).unmasked_chars_length == 0
 
-    assert partial_field.metadata[0].sensitive is True
-    assert partial_field.metadata[0].log_chars == 4
+    assert get_log_config(partial_field).masked is True
+    assert get_log_config(partial_field).unmasked_chars_length == 4
 
+    assert model.password.get_secret_value() == "Mypass123."
+    assert model.validated == "str123"
     assert model.secret == "super-secret"
     assert model.partial_secret == "1234567890"
+
+
+def test_get_log_config_no_log_config():
+    field = FieldInfo(default=None)
+    assert get_log_config(field) is None

cuenca_validations-2.0.5.dev3/cuenca_validations/types/helpers.py

@@ -1,10 +0,0 @@
-import uuid
-from base64 import urlsafe_b64encode
-from typing import Callable
-
-
-def uuid_field(prefix: str = '') -> Callable[[], str]:
-    def base64_uuid_func() -> str:
-        return prefix + urlsafe_b64encode(uuid.uuid4().bytes).decode()[:-2]
-
-    return base64_uuid_func

cuenca_validations-2.0.5.dev3/cuenca_validations/version.py

@@ -1 +0,0 @@
-__version__ = '2.0.5.dev3'