Updates with various exceptions

Author: jeeftor

simplefin4py/exceptions.py

@@ -1,11 +1,41 @@
 """SimpleFIN Exceptions."""
 
 
-class ClaimError(Exception):
+class SimpleFinInvalidClaimTokenError(Exception):
+    """Invalid claim token error."""
+
+    def __init__(self) -> None:
+        """Initialize the exception."""
+        self.message = "The claim token is invalid and could not be decoded."
+        super().__init__(self.message)
+
+
+class SimpleFinClaimError(Exception):
     """Exception raised for errors in the claim process."""
 
     def __init__(self) -> None:
         """Initialize the exception."""
         self.message = "The claim token either does not exist or has already been used claimed by someone "
         "else. Receiving this could mean that the user’s transaction information has been compromised."
         super().__init__(self.message)
+
+
+class SimpleFinAuthError(Exception):
+    """Authentication Error (403) on Account endpoint."""
+
+    def __init__(self) -> None:
+        """Initialize the exception."""
+        self.message = (
+            "Authentication failed. This could be because access has been revoked or if the credentials "
+            "are incorrect."
+        )
+        super().__init__(self.message)
+
+
+class SimpleFinPaymentError(Exception):
+    """A 402 error will raise a Payment Required."""
+
+    def __init__(self) -> None:
+        """Initialize the exception."""
+        self.message = "Payment Required"
+        super().__init__(self.message)

simplefin4py/simplefin.py

@@ -1,11 +1,14 @@
 """SimpleFin Class."""
 from __future__ import annotations
 
+import binascii
+
 import aiohttp
 import base64
 
 from aiohttp import BasicAuth, ClientConnectorError, ClientConnectorSSLError
 
+from .exceptions import SimpleFinClaimError, SimpleFinInvalidClaimTokenError
 from .model import FinancialData
 from .const import LOGGER
 
@@ -25,7 +28,11 @@ async def claim_setup_token(
         cls, setup_token: str, verify_ssl: bool = True, proxy: str | None = None
     ) -> str:
         """Exchanges a 1-time setup token for an access token."""
-        claim_url = base64.b64decode(setup_token).decode("utf-8")
+        try:
+            claim_url = base64.b64decode(setup_token).decode("utf-8")
+        except binascii.Error as err:
+            raise SimpleFinInvalidClaimTokenError from err
+
         auth = BasicAuth(
             login="", password=""
         )  # Replace with appropriate auth if needed
@@ -39,6 +46,9 @@ async def claim_setup_token(
 
         async with aiohttp.ClientSession(auth=auth, connector=connector) as session:
             response = await session.post(claim_url, **request_params)
+            if response.status == 403:
+                # Claim issue
+                raise SimpleFinClaimError()
             access_url: str = await response.text()
             return access_url
 

tests/conftest.py

@@ -10,7 +10,6 @@
 
 current_dir = os.path.dirname(__file__)
 
-
 MOCK_CLAIM_TOKEN = "https://claim.url"  # noqa: S105
 MOCK_ACCESS_URL = "https://user:passwords@access_url"
 
@@ -57,6 +56,16 @@ def mock_claim_token_success() -> Generator[aioresponses, None, None]:
         yield m
 
 
+@pytest.fixture  # type: ignore
+def mock_claim_token_403() -> Generator[aioresponses, None, None]:
+    """Fixture for mocking a login process with bad credentials."""
+    # Using 'aioresponses' to mock asynchronous HTTP responses.
+    with aioresponses() as m:
+        # Mock a failed login attempt due to bad credentials.
+        m.post(MOCK_CLAIM_TOKEN, status=403, body="")
+        yield m
+
+
 @pytest.fixture  # type: ignore
 def mock_claim_token() -> str:
     """Fixture for the claim URL."""

tests/test_simplefin.py

@@ -5,6 +5,7 @@
 from aioresponses import aioresponses
 
 from simplefin4py import SimpleFin
+from simplefin4py.exceptions import SimpleFinInvalidClaimTokenError, SimpleFinClaimError
 from tests.conftest import MOCK_ACCESS_URL
 
 
@@ -16,6 +17,25 @@ async def test_claim_token_good(mock_claim_token_success, mock_claim_token):
     assert access_url == MOCK_ACCESS_URL
 
 
+@pytest.mark.asyncio  # type: ignore
+async def test_claim_token_bad():
+    """Test a successful claim token."""
+    # Claim the token.
+    with pytest.raises(SimpleFinInvalidClaimTokenError):
+        access_url = await SimpleFin.claim_setup_token(
+            "bad token of crap", proxy="localhost"
+        )
+        assert access_url == MOCK_ACCESS_URL
+
+
+@pytest.mark.asyncio  # type: ignore
+async def test_claim_token_403(mock_claim_token_403, mock_claim_token):
+    """Test a successful claim token."""
+    # Claim the token.
+    with pytest.raises(SimpleFinClaimError):
+        await SimpleFin.claim_setup_token(mock_claim_token, proxy="localhost")
+
+
 @pytest.mark.asyncio  # type: ignore
 async def test_access_402(mock_get_data_402) -> None:
     """Test a failed access token."""