cuenca-validations 2.0.4.dev2__tar.gz → 2.0.5.dev2__tar.gz

{cuenca_validations-2.0.4.dev2 → cuenca_validations-2.0.5.dev2}/PKG-INFO

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

{cuenca_validations-2.0.4.dev2 → cuenca_validations-2.0.5.dev2}/cuenca_validations/types/__init__.py

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

{cuenca_validations-2.0.4.dev2 → cuenca_validations-2.0.5.dev2}/cuenca_validations/types/files.py

@@ -3,11 +3,11 @@ from typing import Optional
 from pydantic import BaseModel
 
 from .enums import KYCFileType
-from .general import HttpUrlString
+from .general import SerializableHttpUrl
 
 
 class BatchFileMetadata(BaseModel):
     id: Optional[str] = None
     is_back: bool
     type: KYCFileType
-    url: HttpUrlString
+    url: SerializableHttpUrl

{cuenca_validations-2.0.4.dev2 → cuenca_validations-2.0.5.dev2}/cuenca_validations/types/general.py

@@ -1,4 +1,5 @@
 import json
+from dataclasses import dataclass
 from typing import Annotated, Any, Optional
 
 from pydantic import AnyUrl, Field, HttpUrl, PlainSerializer, StringConstraints
@@ -6,13 +7,9 @@ from pydantic import AnyUrl, Field, HttpUrl, PlainSerializer, StringConstraints
 from ..validators import sanitize_dict, sanitize_item
 from .enums import State
 
-HttpUrlString = Annotated[
-    HttpUrl, PlainSerializer(lambda x: x.unicode_string(), return_type=str)
-]
+SerializableHttpUrl = Annotated[HttpUrl, PlainSerializer(str, return_type=str)]
 
-AnyUrlString = Annotated[
-    AnyUrl, PlainSerializer(lambda x: x.unicode_string(), return_type=str)
-]
+SerializableAnyUrl = Annotated[AnyUrl, PlainSerializer(str, return_type=str)]
 
 
 class SantizedDict(dict):
@@ -86,3 +83,9 @@ names_state = {
 
 def get_state_name(state: State):
     return names_state[state]
+
+
+@dataclass
+class Metadata:
+    sensitive: bool
+    log_chars: int = 0

{cuenca_validations-2.0.4.dev2 → cuenca_validations-2.0.5.dev2}/cuenca_validations/types/requests.py

@@ -54,7 +54,7 @@ from .card import (
     PaymentCardNumber,
     StrictPaymentCardNumber,
 )
-from .general import AnyUrlString, HttpUrlString, StrictPositiveInt
+from .general import SerializableAnyUrl, SerializableHttpUrl, StrictPositiveInt
 from .identities import (
     Address,
     Beneficiary,
@@ -477,7 +477,7 @@ class UserUpdateRequest(BaseModel):
     status: Optional[UserStatus] = None
     terms_of_service: Optional[TOSRequest] = None
     platform_terms_of_service: Optional[TOSAgreement] = None
-    curp_document_uri: Optional[HttpUrlString] = None
+    curp_document_uri: Optional[SerializableHttpUrl] = None
 
     @field_validator('beneficiaries')
     @classmethod
@@ -500,8 +500,8 @@ class UserLoginRequest(BaseRequest):
 class SessionRequest(BaseRequest):
     user_id: str
     type: SessionType
-    success_url: Optional[AnyUrlString] = None
-    failure_url: Optional[AnyUrlString] = None
+    success_url: Optional[SerializableAnyUrl] = None
+    failure_url: Optional[SerializableAnyUrl] = None
     model_config = ConfigDict(
         json_schema_extra={
             'example': {
@@ -515,13 +515,13 @@ class SessionRequest(BaseRequest):
 
 
 class EndpointRequest(BaseRequest):
-    url: HttpUrlString
+    url: SerializableHttpUrl
     events: Optional[list[WebhookEvent]] = None
     user_id: Optional[str] = None
 
 
 class EndpointUpdateRequest(BaseRequest):
-    url: Optional[HttpUrlString] = None
+    url: Optional[SerializableHttpUrl] = None
     is_enable: Optional[bool] = None
     events: Optional[list[WebhookEvent]] = None
 
@@ -536,7 +536,7 @@ class FileUploadRequest(BaseRequest):
 
 class FileRequest(BaseModel):
     is_back: Optional[bool] = False
-    url: HttpUrlString
+    url: SerializableHttpUrl
     type: KYCFileType
 
 

cuenca_validations-2.0.5.dev2/cuenca_validations/version.py

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

{cuenca_validations-2.0.4.dev2 → cuenca_validations-2.0.5.dev2}/cuenca_validations.egg-info/PKG-INFO

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

{cuenca_validations-2.0.4.dev2 → cuenca_validations-2.0.5.dev2}/tests/test_types.py

@@ -2,6 +2,7 @@ import datetime as dt
 import json
 from dataclasses import dataclass
 from enum import Enum
+from typing import Annotated
 
 import pytest
 from freezegun import freeze_time
@@ -24,7 +25,7 @@ from cuenca_validations.types.enums import (
     SessionType,
     State,
 )
-from cuenca_validations.types.general import StrictPositiveInt
+from cuenca_validations.types.general import Metadata, StrictPositiveInt
 from cuenca_validations.types.requests import (
     ApiKeyUpdateRequest,
     BankAccountValidationRequest,
@@ -586,3 +587,24 @@ class IntModel(BaseModel):
 def test_strict_positive_int_invalid(value, expected_error, expected_message):
     with pytest.raises(expected_error, match=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 test_metadata():
+    model = MetadataModel(secret="super-secret", partial_secret="1234567890")
+
+    secret_field = MetadataModel.model_fields["secret"]
+    partial_field = MetadataModel.model_fields["partial_secret"]
+
+    assert secret_field.metadata[0].sensitive is True
+    assert secret_field.metadata[0].log_chars == 0
+
+    assert partial_field.metadata[0].sensitive is True
+    assert partial_field.metadata[0].log_chars == 4
+
+    assert model.secret == "super-secret"
+    assert model.partial_secret == "1234567890"

cuenca_validations-2.0.4.dev2/cuenca_validations/version.py

@@ -1 +0,0 @@
-__version__ = '2.0.4.dev02'