refactor: streamline bank configuration by replacing error classes with Pydantic model validation

Author: gabino

clabe/errors.py

@@ -9,13 +9,3 @@ class BankCodeValidationError(PydanticValueError):
 class ClabeControlDigitValidationError(PydanticValueError):
     code = 'clabe.control_digit'
     msg_template = 'clabe dígito de control no es válido'
-
-
-class BankCodeABMAlreadyExistsError(PydanticValueError):
-    code = 'clabe.bank_code_abm_already_exists'
-    msg_template = 'código de banco ABM ya existe'
-
-
-class BankCodeBanxicoAlreadyExistsError(PydanticValueError):
-    code = 'clabe.bank_code_banxico_already_exists'
-    msg_template = 'código de banco banxico ya existe'

clabe/validations.py

@@ -1,13 +1,10 @@
 import random
 from typing import List, Union
 
+from pydantic import BaseModel, Field, validator
 from pydantic.errors import NotDigitError
 
 from .banks import BANK_NAMES, BANKS
-from .errors import (
-    BankCodeABMAlreadyExistsError,
-    BankCodeBanxicoAlreadyExistsError,
-)
 
 CLABE_LENGTH = 18
 CLABE_WEIGHTS = [3, 7, 1, 3, 7, 1, 3, 7, 1, 3, 7, 1, 3, 7, 1, 3, 7]
@@ -69,42 +66,33 @@ def generate_new_clabes(number_of_clabes: int, prefix: str) -> List[str]:
     return clabes
 
 
-def configure_additional_bank(
-    bank_code_abm: str, bank_code_banxico: str, bank_name: str
-) -> None:
-    """
-    Configures an additional bank.
-
-    Args:
-        bank_code_abm (str): The ABM code for the bank.
-        bank_code_banxico (str): The Banxico code for the bank.
-        bank_name (str): The name of the bank.
-
-    Raises:
-        ValueError: If the bank_code_abm or bank_code_banxico
-        already exists in the provided dictionaries.
-    """
-
-    if not all(
-        isinstance(x, str)
-        for x in [bank_code_abm, bank_code_banxico, bank_name]
-    ):
-        raise TypeError("All parameters must be strings")
-
-    if not bank_code_abm.isdigit():
-        raise NotDigitError
-
-    if not bank_code_banxico.isdigit():
-        raise NotDigitError
+class BankConfigRequest(BaseModel):
+    bank_code_abm: str = Field(..., description="The ABM code for the bank")
+    bank_code_banxico: str = Field(
+        ..., description="The Banxico code for the bank"
+    )
+    bank_name: str = Field(..., description="The name of the bank")
 
-    if not bank_name.strip():
-        raise ValueError("bank_name cannot be empty")
+    @validator('bank_code_abm', 'bank_code_banxico')
+    def validate_numeric_codes(cls, v: str) -> str:
+        if not v.isdigit():
+            raise NotDigitError
+        return v
 
-    if bank_code_abm in BANKS:
-        raise BankCodeABMAlreadyExistsError
+    @validator('bank_name')
+    def validate_bank_name(cls, v: str) -> str:
+        if not v.strip():
+            raise ValueError("bank_name cannot be empty")
+        return v.strip()
 
-    if bank_code_banxico in BANK_NAMES:
-        raise BankCodeBanxicoAlreadyExistsError
 
-    BANKS[bank_code_abm] = bank_code_banxico
-    BANK_NAMES[bank_code_banxico] = bank_name.strip()
+def configure_additional_bank(
+    bank_code_abm: str, bank_code_banxico: str, bank_name: str
+) -> None:
+    request = BankConfigRequest(
+        bank_code_abm=bank_code_abm,
+        bank_code_banxico=bank_code_banxico,
+        bank_name=bank_name,
+    )
+    BANKS[request.bank_code_abm] = request.bank_code_banxico
+    BANK_NAMES[request.bank_code_banxico] = request.bank_name

tests/test_clabe.py

@@ -7,10 +7,6 @@
     get_bank_name,
     validate_clabe,
 )
-from clabe.errors import (
-    BankCodeABMAlreadyExistsError,
-    BankCodeBanxicoAlreadyExistsError,
-)
 
 VALID_CLABE = '002000000000000008'
 INVALID_CLABE_CONTROL_DIGIT = '002000000000000007'
@@ -43,29 +39,30 @@ def test_generate_new_clabes():
         assert validate_clabe(clabe)
 
 
-def test_configure_additional_bank_success():
-    configure_additional_bank("777", "713", "New Bank")
-    assert get_bank_name('777') == 'New Bank'
-
-
-def test_configure_additional_bank_existing_abm_code():
-    with pytest.raises(BankCodeABMAlreadyExistsError):
-        configure_additional_bank("002", "40002", "Banamex")
-
-
-def test_configure_additional_bank_existing_banxico_code():
-    with pytest.raises(BankCodeBanxicoAlreadyExistsError):
-        configure_additional_bank("666", "40137", "New Bank")
-
-
-def test_configure_additional_bank_invalid_inputs():
-    with pytest.raises(TypeError):
-        configure_additional_bank(3, 3, 3)
-    with pytest.raises(ValueError):
-        configure_additional_bank("A", "B", "C")
-    with pytest.raises(ValueError):
-        configure_additional_bank("666", "B", "C")
-    with pytest.raises(ValueError):
-        configure_additional_bank("777", "713", "")
+@pytest.mark.parametrize(
+    'abm_code, banxico_code, name',
+    [
+        ('713', '90713', 'Cuenca DMZ'),
+        ('777', '713', 'Cuenca Gem DMZ'),
+        ('666', '723', 'Cuenca Gem Beta'),
+    ],
+)
+def test_configure_additional_bank_success(abm_code, banxico_code, name):
+    configure_additional_bank(abm_code, banxico_code, name)
+    assert get_bank_name(abm_code) == name
+
+
+@pytest.mark.parametrize(
+    'abm_code, banxico_code, name',
+    [
+        ('A', 'B', 'C'),  # Invalid format for both codes
+        ('666', 'B', 'Test Bank'),  # Valid ABM code, invalid Banxico code
+        ('777', '713', ''),  # Valid codes, empty name
+        ('abc', 'def', 'Test Bank'),  # Non-numeric codes
+    ],
+)
+def test_configure_additional_bank_invalid_inputs(
+    abm_code, banxico_code, name
+):
     with pytest.raises(ValueError):
-        configure_additional_bank("abc", "def", "Test Bank")
+        configure_additional_bank(abm_code, banxico_code, name)