Add configure_additional_bank Functionality and Bump Version to 1.2.17

README.md

@@ -57,3 +57,21 @@ Para generar nuevo válido CLABES
 import clabe
 clabe.generate_new_clabes(10, '002123456')
 ```
+
+## Para agregar un nuevo banco
+
+A partir de la versión 2.0.0, el paquete se actualizará a **Pydantic v2**, lo que significa que las versiones anteriores ya no recibirán soporte.
+
+Sin embargo, hemos añadido una función para agregar bancos adicionales a la lista, en caso de que sea necesario. Esto se puede hacer sin necesidad de crear un PR. Para agregar un banco, simplemente llama a la siguiente función con el código de Banxico y el nombre del banco:
+
+```python
+import clabe
+clabe.add_bank('12345', 'New Bank')
+```
+
+Para eliminar un banco
+
+```python
+import clabe
+clabe.remove_bank('12345')
+```

clabe/__init__.py

@@ -7,14 +7,18 @@
     'generate_new_clabes',
     'get_bank_name',
     'validate_clabe',
+    'add_bank',
+    'remove_bank',
 ]
 
 from .banks import BANK_NAMES, BANKS
 from .types import Clabe
 from .validations import (
+    add_bank,
     compute_control_digit,
     generate_new_clabes,
     get_bank_name,
+    remove_bank,
     validate_clabe,
 )
 from .version import __version__

clabe/validations.py

@@ -1,6 +1,8 @@
 import random
 from typing import List, Union
 
+from pydantic import BaseModel, Field
+
 from .banks import BANK_NAMES, BANKS
 
 CLABE_LENGTH = 18
@@ -61,3 +63,54 @@ def generate_new_clabes(number_of_clabes: int, prefix: str) -> List[str]:
         assert validate_clabe(clabe)
         clabes.append(clabe)
     return clabes
+
+
+class BankConfigRequest(BaseModel):
+    """
+    Validates and processes bank configuration requests.
+
+    The class handles validation of bank names and codes, ensuring:
+    - Bank names are non-empty strings
+    - Banxico codes are exactly 5 digits
+    """
+
+    bank_name: str = Field(
+        min_length=1,
+        strip_whitespace=True,
+        description="Bank name must have at least 1 character.",
+    )
+
+    bank_code_banxico: str = Field(
+        regex=r"^\d{5}$", description="Banxico code must be a 5-digit string."
+    )
+
+    @property
+    def bank_code_abm(self):
+        return self.bank_code_banxico[-3:]
+
+
+def add_bank(bank_code_banxico: str, bank_name: str) -> None:
+    """
+    Add a bank configuration.
+
+    Args:
+        bank_code_banxico: 5-digit Banxico bank code
+        bank_name: Bank name
+    """
+    request = BankConfigRequest(
+        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
+
+
+def remove_bank(bank_code_banxico: str) -> None:
+    """
+    Remove a bank configuration by its Banxico code.
+
+    Args:
+        bank_code_banxico: 5-digit Banxico bank code
+    """
+    BANKS.pop(bank_code_banxico[-3:], None)
+    BANK_NAMES.pop(bank_code_banxico, None)

clabe/version.py

@@ -1 +1 @@
-__version__ = '1.2.16'
+__version__ = '1.2.17'

tests/test_clabe.py

@@ -1,9 +1,13 @@
 import pytest
 
 from clabe import (
+    BANK_NAMES,
+    BANKS,
+    add_bank,
     compute_control_digit,
     generate_new_clabes,
     get_bank_name,
+    remove_bank,
     validate_clabe,
 )
 
@@ -36,3 +40,53 @@ def test_generate_new_clabes():
     for clabe in clabes:
         assert clabe.startswith(prefix)
         assert validate_clabe(clabe)
+
+
+@pytest.mark.parametrize(
+    'abm_code, banxico_code, name',
+    [
+        ('713', '90713', 'Cuenca DMZ'),
+        ('714', '90714', 'Cuenca Gem DMZ'),
+        ('715', '90715', 'Cuenca Gem Beta'),
+    ],
+)
+def test_add_bank_success(abm_code, banxico_code, name):
+    add_bank(banxico_code, name)
+    assert get_bank_name(abm_code) == name
+
+
+@pytest.mark.parametrize(
+    'banxico_code, name',
+    [
+        ('1234', 'Test Bank'),  # invalid Banxico code 4 digits
+        ('123456', 'Test Bank'),  # invalid Banxico code 6 digits
+        ('12345', ''),  # Valid code, empty name
+        ('123AT', 'Test Bank'),  # Non-numeric codes
+    ],
+)
+def test_add_bank_invalid_inputs(banxico_code, name):
+    with pytest.raises(ValueError):
+        add_bank(banxico_code, name)
+
+
+def test_remove_bank():
+    test_code = "90716"
+    test_name = "To Delete Bank"
+    add_bank(test_code, test_name)
+
+    assert test_code[-3:] in BANKS
+    assert test_code in BANK_NAMES
+
+    remove_bank(test_code)
+
+    assert test_code[-3:] not in BANKS
+    assert test_code not in BANK_NAMES
+
+
+def test_remove_nonexistent_bank():
+    nonexistent_code = "99999"
+
+    remove_bank(nonexistent_code)
+
+    assert nonexistent_code[-3:] not in BANKS
+    assert nonexistent_code not in BANK_NAMES