Add configure_additional_bank Functionality and Bump Version to 1.2.17

README.md

@@ -57,3 +57,10 @@ Para generar nuevo válido CLABES
 import clabe
 clabe.generate_new_clabes(10, '002123456')
 ```
+
+Para generar un nuevo banco
+
+```python
+import clabe
+clabe.configure_additional_bank('777', '713', 'New Bank')
+```

clabe/__init__.py

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

clabe/validations.py

@@ -1,6 +1,9 @@
 import random
+import re
 from typing import List, Union
 
+from pydantic import BaseModel, Field, validator
+
 from .banks import BANK_NAMES, BANKS
 
 CLABE_LENGTH = 18
@@ -61,3 +64,52 @@ def generate_new_clabes(number_of_clabes: int, prefix: str) -> List[str]:
         assert validate_clabe(clabe)
         clabes.append(clabe)
     return clabes
+
+
+class BankConfigRequest(BaseModel):
+    bank_name: str = Field(
+        min_length=1,
+        strip_whitespace=True,
+        description="The name of the bank - cannot be empty",
+    )
+
+    bank_code_banxico: str = Field(
+        min_length=5, max_length=5, description="The Banxico code for the bank"
+    )
+
+    @validator("bank_code_banxico")
+    def validate_bank_code(cls, value):
+        if not re.fullmatch(r"\d{5}", value):
+            raise ValueError(
+                "bank_code_banxico must be a string of exactly 5 digits"
+            )
+        return value
+
+    @property
+    def bank_code_abm(self):
+        return self.bank_code_banxico[-3:]
+
+
+def configure_additional_bank(bank_code_banxico: str, bank_name: str) -> None:
+
+    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:
+    bank_code_abm = next(
+        (
+            abm
+            for abm, banxico in BANKS.items()
+            if banxico == bank_code_banxico
+        ),
+        None,
+    )
+
+    if bank_code_abm:
+        BANKS.pop(bank_code_abm)
+        BANK_NAMES.pop(bank_code_banxico)

clabe/version.py

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

tests/test_clabe.py

@@ -2,8 +2,10 @@
 
 from clabe import (
     compute_control_digit,
+    configure_additional_bank,
     generate_new_clabes,
     get_bank_name,
+    remove_bank,
     validate_clabe,
 )
 
@@ -36,3 +38,36 @@ 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_configure_additional_bank_success(abm_code, banxico_code, name):
+    configure_additional_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_configure_additional_bank_invalid_inputs(banxico_code, name):
+    with pytest.raises(ValueError):
+        configure_additional_bank(banxico_code, name)
+
+
+def test_remove_bank():
+    remove_bank('40138')
+    with pytest.raises(ValueError):
+        get_bank_name('138')