Add IBAN validation service (#12)

Author: ebram96

src/abstract_api/__init__.py

@@ -2,13 +2,15 @@
 
 from .avatars import Avatars
 from .email_validation import EmailValidation
+from .iban_validation import IBANValidation
 from .ip_geolocation import IPGeolocation
 from .phone_validation import PhoneValidation
 from .vat import VAT
 
 __all__: Final[list[str]] = [
     "Avatars",
     "EmailValidation",
+    "IBANValidation",
     "IPGeolocation",
     "PhoneValidation",
     "VAT"

src/abstract_api/iban_validation/__init__.py

@@ -0,0 +1,9 @@
+from typing import Final
+
+from .iban_validation import IBANValidation
+from .iban_validation_response import IBANValidationResponse
+
+__all__: Final[list[str]] = [
+    "IBANValidation",
+    "IBANValidationResponse"
+]

src/abstract_api/iban_validation/iban_validation.py

@@ -0,0 +1,40 @@
+from abstract_api.bases import BaseService
+from abstract_api.exceptions import ResponseParseError
+
+from .iban_validation_response import IBANValidationResponse
+
+
+class IBANValidation(BaseService):
+    """AbstractAPI IBAN validation and verification service.
+
+    Used to validate and verify a IBAN number.
+
+    Attributes:
+        _subdomain: IBAN validation service subdomain.
+    """
+    _subdomain: str = "ibanvalidation"
+
+    def check(self, iban: str) -> IBANValidationResponse:
+        """Validates an IBAN.
+
+        Args:
+            iban: The IBAN to validate. Note that the API will accept white
+                spaces, so BE71 0961 2345 6769 is considered as valid
+                as BE71096123456769.
+
+        Returns:
+            IBANValidationResponse representing API call response.
+        """
+        response = self._service_request(iban=iban)
+
+        # TODO: Move to parent
+        try:
+            iban_validation_response = IBANValidationResponse(
+                response=response
+            )
+        except Exception as e:
+            raise ResponseParseError(
+                "Failed to parse response as IBANValidationResponse"
+            ) from e
+
+        return iban_validation_response

src/abstract_api/iban_validation/iban_validation_response.py

@@ -0,0 +1,32 @@
+from typing import TYPE_CHECKING
+
+import requests
+
+from abstract_api.bases import JSONResponse
+
+from .response_fields import RESPONSE_FIELDS
+
+
+class IBANValidationResponse(JSONResponse):
+    """IBAN validation service response."""
+
+    def __init__(self, response: requests.models.Response) -> None:
+        """Initializes a new IBANValidationResponse."""
+        super().__init__(response)
+        self._response_fields = RESPONSE_FIELDS
+        for field in RESPONSE_FIELDS:
+            if TYPE_CHECKING:
+                assert isinstance(self.meta.body_json, dict)
+            value = self.meta.body_json.get(field)
+            # TODO: Move to parent class
+            setattr(self, f"_{field}", value)
+
+    @property
+    def iban(self) -> str:
+        """The IBAN submitted for validation."""
+        return self._get_response_field("iban")
+
+    @property
+    def is_valid(self) -> bool:
+        """Whether the IBAN submitted is valid."""
+        return self._get_response_field("is_valid")

src/abstract_api/iban_validation/response_fields.py

@@ -0,0 +1,7 @@
+"""Response fields of IBAN validation service endpoint."""
+
+
+RESPONSE_FIELDS: frozenset[str] = frozenset({
+    "iban",
+    "is_valid"
+})