vhi-python 0.1.3__tar.gz → 0.1.5__tar.gz

{vhi_python-0.1.3 → vhi_python-0.1.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vhi-python
-Version: 0.1.3
+Version: 0.1.5
 Summary: A Python client library for the Vhi API, handling authentication, MFA callbacks, claims retrieval, and document downloads.
 Author-email: Agent <agent@example.com>
 License: MIT

{vhi_python-0.1.3 → vhi_python-0.1.5}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "vhi-python"
-version = "0.1.3"
+version = "0.1.5"
 description = "A Python client library for the Vhi API, handling authentication, MFA callbacks, claims retrieval, and document downloads."
 readme = "README.md"
 authors = [

{vhi_python-0.1.3 → vhi_python-0.1.5}/src/vhi/__init__.py

@@ -7,5 +7,5 @@ __all__ = [
     "VhiAuthenticationError",
     "VhiMfaRequiredError",
     "VhiApiError",
-    "ClaimStatement"
+    "ClaimStatement",
 ]

{vhi_python-0.1.3 → vhi_python-0.1.5}/src/vhi/client.py

@@ -1,45 +1,104 @@
 import requests
-import os
 import uuid
 import json
+import pickle
+import hashlib
+from pathlib import Path
 from typing import Callable, Optional, List
 from .exceptions import VhiAuthenticationError, VhiMfaRequiredError, VhiApiError
 from .models import ClaimStatement
 
+
 class VhiClient:
     """
     A client library for interacting with the Vhi API.
     Handles authentication, MFA callbacks, claims retrieval, and document downloads.
     """
-    DEFAULT_CONFIG_URL = "https://www.vhi.ie/myvhi/myclaimstatements" # Usually embedded here
-    
-    def __init__(self, username: str, password: str, mfa_callback: Optional[Callable[[], str]] = None):
+
+    DEFAULT_CONFIG_URL = (
+        "https://www.vhi.ie/myvhi/myclaimstatements"  # Usually embedded here
+    )
+
+    def __init__(
+        self,
+        username: str,
+        password: str,
+        mfa_callback: Optional[Callable[[], str]] = None,
+        cache_session: bool = True,
+    ):
         """
         Initialize the VhiClient.
-        
+
         Args:
             username: User's email address.
             password: User's password.
             mfa_callback: A callable that returns the 2FA OTP string when invoked.
+            cache_session: Whether to cache session cookies locally to prevent re-authentication.
         """
         self.username = username
         self.password = password
         self.mfa_callback = mfa_callback
-        
+        self.cache_session = cache_session
+
         # State management
         self.session = requests.Session()
-        
+
         # Default Browser Headers to mimic browser and avoid WAF
-        self.session.headers.update({
-            "user-agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/146.0.0.0 Safari/537.36",
-            "sec-ch-ua": '"Chromium";v="146", "Not-A.Brand";v="24", "Google Chrome";v="146"',
-            "sec-ch-ua-mobile": "?0",
-            "sec-ch-ua-platform": '"Windows"',
-        })
-        
+        self.session.headers.update(
+            {
+                "user-agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/146.0.0.0 Safari/537.36",
+                "sec-ch-ua": '"Chromium";v="146", "Not-A.Brand";v="24", "Google Chrome";v="146"',
+                "sec-ch-ua-mobile": "?0",
+                "sec-ch-ua-platform": '"Windows"',
+            }
+        )
+
         self.is_authenticated = False
-        self.apis_base_url = "https://apis.vhi.ie" # Will be updated during discovery if necessary
-        
+        self.apis_base_url = (
+            "https://apis.vhi.ie"  # Will be updated during discovery if necessary
+        )
+
+    def _get_cache_path(self) -> Path:
+        user_hash = hashlib.md5(self.username.encode("utf-8")).hexdigest()
+        cache_dir = Path.home() / ".vhi"
+        cache_dir.mkdir(exist_ok=True)
+        return cache_dir / f"session_{user_hash}.pkl"
+
+    def _save_session(self):
+        if not self.cache_session:
+            return
+        with open(self._get_cache_path(), "wb") as f:
+            pickle.dump(self.session.cookies, f)
+
+    def _load_session(self) -> bool:
+        if not self.cache_session:
+            return False
+        cache_path = self._get_cache_path()
+        if cache_path.exists():
+            try:
+                with open(cache_path, "rb") as f:
+                    self.session.cookies = pickle.load(f)
+                return True
+            except Exception:
+                pass
+        return False
+
+    def _is_session_valid(self) -> bool:
+        try:
+            url = f"{self.apis_base_url}/claims/v1/statements"
+            headers = {
+                "Accept": "application/json",
+                "Origin": "https://app.vhi.ie",
+                "Referer": "https://app.vhi.ie/",
+                "Sec-Fetch-Mode": "cors",
+                "Sec-Fetch-Site": "same-site",
+            }
+            # Only test to see if 401 is returned
+            response = self.session.get(url, headers=headers, timeout=5)
+            return response.status_code == 200
+        except Exception:
+            return False
+
     def _fetch_environment_config(self):
         """
         Optional: Dynamically discovers the API base URL.
@@ -56,6 +115,13 @@ class VhiClient:
         """
         Performs the login flow. Handles the MFA challenge if required.
         """
+        if self._load_session():
+            if self._is_session_valid():
+                self.is_authenticated = True
+                return
+            else:
+                self.session.cookies.clear()
+
         # Set proper fetch headers mimicking trace exactly
         headers = {
             "accept": "application/json, text/plain, */*",
@@ -70,96 +136,129 @@ class VhiClient:
             "sec-fetch-dest": "empty",
             "sec-fetch-mode": "cors",
             "sec-fetch-site": "same-site",
-            "user-session-id": str(uuid.uuid4())
-        }
-        
-        payload = {
-            "username": self.username,
-            "usercred": self.password
+            "user-session-id": str(uuid.uuid4()),
         }
-        
+
+        payload = {"username": self.username, "usercred": self.password}
+
         # Format strictly without spaces to bypass strict WAF parsers
-        raw_payload = json.dumps(payload, separators=(',', ':'))
-        
+        raw_payload = json.dumps(payload, separators=(",", ":"))
+
         # 1. Primary Authentication
         login_url = f"{self.apis_base_url}/api/myvhilogin/login"
-        
+
         response = self.session.post(login_url, data=raw_payload, headers=headers)
-        
+
         if response.status_code == 200:
             try:
                 data = response.json()
             except ValueError:
-                raise VhiApiError("Login response was not valid JSON", status_code=response.status_code)
-                
+                raise VhiApiError(
+                    "Login response was not valid JSON",
+                    status_code=response.status_code,
+                )
+
             # The HAR trace uses a deeply nested response structure or a flattened one depending on Gateway
             status_val = data.get("status") or data.get("data", {}).get("status")
-            
+
             if status_val == "MFA_REQUIRED":
-                state_token = data.get("stateToken") or data.get("data", {}).get("stateToken")
-                
+                state_token = data.get("stateToken") or data.get("data", {}).get(
+                    "stateToken"
+                )
+
                 # Attempt to extract the verify url from the first factor
                 try:
-                    factors = data.get("factors") or data.get("data", {}).get("_embedded", {}).get("factors", [])
+                    factors = data.get("factors") or data.get("data", {}).get(
+                        "_embedded", {}
+                    ).get("factors", [])
                     verify_url = factors[0]["_links"]["verify"]["href"]
                 except (IndexError, KeyError):
                     # Fallback URL if extraction fails
-                    verify_url = f"https://admin-digital.vhi.ie/api/v1/authn/factors/verify"
-                    
+                    verify_url = (
+                        "https://admin-digital.vhi.ie/api/v1/authn/factors/verify"
+                    )
+
                 if not state_token:
-                    raise VhiApiError("MFA required but no state_token provided in response")
-                    
+                    raise VhiApiError(
+                        "MFA required but no state_token provided in response"
+                    )
+
                 self._handle_mfa_challenge(state_token, verify_url, headers)
             else:
                 self.is_authenticated = True
+                self._save_session()
                 return
-                
+
         elif response.status_code == 401:
             raise VhiAuthenticationError("Invalid credentials provided.")
         else:
-            raise VhiApiError(f"Login failed with status {response.status_code}: {response.text}", status_code=response.status_code, response=response)
-            
-    def _handle_mfa_challenge(self, state_token: str, verify_url: str, base_headers: dict):
+            raise VhiApiError(
+                f"Login failed with status {response.status_code}: {response.text}",
+                status_code=response.status_code,
+                response=response,
+            )
+
+    def _handle_mfa_challenge(
+        self, state_token: str, verify_url: str, base_headers: dict
+    ):
         """
         Internal method to submit the MFA code.
         """
         if not self.mfa_callback:
-            raise VhiMfaRequiredError("MFA is required but no mfa_callback was provided to VhiClient.")
-            
+            raise VhiMfaRequiredError(
+                "MFA is required but no mfa_callback was provided to VhiClient."
+            )
+
+        # 1. Trigger the SMS / challenge
+        trigger_payload = {"stateToken": state_token}
+        trigger_raw_payload = json.dumps(trigger_payload, separators=(",", ":"))
+        trigger_response = self.session.post(
+            verify_url, data=trigger_raw_payload, headers=base_headers
+        )
+
+        if trigger_response.status_code != 200:
+            raise VhiApiError(
+                f"Failed to trigger MFA challenge. Status: {trigger_response.status_code} - {trigger_response.text}"
+            )
+
         # Pause execution and invoke the user-defined callback to get the OTP
         otp_code = self.mfa_callback()
-        
+
         if not otp_code:
-            raise VhiAuthenticationError("MFA callback did not return a valid OTP code.")
-            
-        payload = {
-            "passCode": otp_code,
-            "stateToken": state_token
-        }
-        
-        response = self.session.post(verify_url, json=payload, headers=base_headers)
-        
+            raise VhiAuthenticationError(
+                "MFA callback did not return a valid OTP code."
+            )
+
+        payload = {"passCode": otp_code, "stateToken": state_token}
+
+        raw_payload = json.dumps(payload, separators=(",", ":"))
+        response = self.session.post(verify_url, data=raw_payload, headers=base_headers)
+
         if response.status_code == 200:
             self.is_authenticated = True
-            
+            self._save_session()
             # The session cookie jar has now been populated with the authorized session
             # Or we might need to extract a Bearer token. This implementation relies
             # on cookies being correctly set via Set-Cookie headers by the API.
         else:
-            raise VhiAuthenticationError(f"MFA verification failed. Status: {response.status_code}")
+            raise VhiAuthenticationError(
+                f"MFA verification failed. Status: {response.status_code} - {response.text}"
+            )
 
     def get_claims(self) -> List[ClaimStatement]:
         """
         Retrieves the list of claim statements.
-        
+
         Returns:
             List of ClaimStatement objects.
         """
         if not self.is_authenticated:
-            raise VhiAuthenticationError("Client is not authenticated. Call login() first.")
-            
+            raise VhiAuthenticationError(
+                "Client is not authenticated. Call login() first."
+            )
+
         url = f"{self.apis_base_url}/claims/v1/statements"
-        
+
         headers = {
             "Accept": "application/json",
             "Origin": "https://www.vhi.ie",
@@ -167,36 +266,45 @@ class VhiClient:
             "Sec-Fetch-Mode": "cors",
             "Sec-Fetch-Site": "same-site",
         }
-        
+
         response = self.session.get(url, headers=headers)
-        
+
         if response.status_code == 200:
             try:
                 data = response.json()
             except ValueError:
-                raise VhiApiError("Invalid JSON received for claims statements.", status_code=response.status_code)
-                
+                raise VhiApiError(
+                    "Invalid JSON received for claims statements.",
+                    status_code=response.status_code,
+                )
+
             claims_data = data.get("claims", [])
             return [ClaimStatement.from_dict(claim) for claim in claims_data]
         elif response.status_code == 401:
             self.is_authenticated = False
             raise VhiAuthenticationError("Session expired or unauthorized.")
         else:
-            raise VhiApiError(f"Failed to fetch claims: {response.status_code}", status_code=response.status_code, response=response)
-            
+            raise VhiApiError(
+                f"Failed to fetch claims: {response.status_code}",
+                status_code=response.status_code,
+                response=response,
+            )
+
     def download_document(self, document_id: str, dest_path: str):
         """
         Streams a claim PDF document to the local disk.
-        
+
         Args:
             document_id: The ID of the document to download.
             dest_path: The file path where the PDF should be saved.
         """
         if not self.is_authenticated:
-            raise VhiAuthenticationError("Client is not authenticated. Call login() first.")
-            
+            raise VhiAuthenticationError(
+                "Client is not authenticated. Call login() first."
+            )
+
         url = f"{self.apis_base_url}/documents/v1/{document_id}/download"
-        
+
         headers = {
             "Accept": "application/pdf",
             "Origin": "https://www.vhi.ie",
@@ -204,16 +312,22 @@ class VhiClient:
             "Sec-Fetch-Mode": "cors",
             "Sec-Fetch-Site": "same-site",
         }
-        
+
         # Use stream=True to prevent loading large PDFs into memory
         with self.session.get(url, headers=headers, stream=True) as response:
             if response.status_code == 200:
-                with open(dest_path, 'wb') as f:
+                with open(dest_path, "wb") as f:
                     for chunk in response.iter_content(chunk_size=8192):
                         if chunk:
                             f.write(chunk)
             elif response.status_code == 401:
                 self.is_authenticated = False
-                raise VhiAuthenticationError("Session expired or unauthorized while downloading document.")
+                raise VhiAuthenticationError(
+                    "Session expired or unauthorized while downloading document."
+                )
             else:
-                raise VhiApiError(f"Failed to download document {document_id}: {response.status_code}", status_code=response.status_code, response=response)
+                raise VhiApiError(
+                    f"Failed to download document {document_id}: {response.status_code}",
+                    status_code=response.status_code,
+                    response=response,
+                )

{vhi_python-0.1.3 → vhi_python-0.1.5}/src/vhi/exceptions.py

@@ -1,17 +1,24 @@
 class VhiError(Exception):
     """Base exception for Vhi Python Client"""
+
     pass
 
+
 class VhiAuthenticationError(VhiError):
     """Raised when authentication fails (invalid credentials)"""
+
     pass
 
+
 class VhiMfaRequiredError(VhiError):
     """Raised when MFA is required but no callback is provided or callback fails"""
+
     pass
 
+
 class VhiApiError(VhiError):
     """Raised when the Vhi API returns an error response"""
+
     def __init__(self, message, status_code=None, response=None):
         super().__init__(message)
         self.status_code = status_code

{vhi_python-0.1.3 → vhi_python-0.1.5}/src/vhi/models.py

@@ -1,5 +1,5 @@
 from dataclasses import dataclass
-from typing import Optional
+
 
 @dataclass
 class ClaimStatement:
@@ -8,7 +8,7 @@ class ClaimStatement:
     practitioner: str
     document_id: str
     status: str
-    
+
     @classmethod
     def from_dict(cls, data: dict) -> "ClaimStatement":
         return cls(
@@ -16,5 +16,5 @@ class ClaimStatement:
             date_of_service=data.get("dateOfService", ""),
             practitioner=data.get("practitioner", ""),
             document_id=data.get("documentId", ""),
-            status=data.get("status", "")
+            status=data.get("status", ""),
         )

{vhi_python-0.1.3 → vhi_python-0.1.5}/src/vhi_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vhi-python
-Version: 0.1.3
+Version: 0.1.5
 Summary: A Python client library for the Vhi API, handling authentication, MFA callbacks, claims retrieval, and document downloads.
 Author-email: Agent <agent@example.com>
 License: MIT

{vhi_python-0.1.3 → vhi_python-0.1.5}/tests/test_client.py

@@ -3,70 +3,90 @@ import responses
 import os
 import tempfile
 from vhi.client import VhiClient
-from vhi.exceptions import VhiAuthenticationError, VhiMfaRequiredError, VhiApiError
+from vhi.exceptions import VhiAuthenticationError
+
 
 @responses.activate
 def test_login_success_no_mfa():
-    client = VhiClient("test@example.com", "password")
-    
+    client = VhiClient("test@example.com", "password", cache_session=False)
+
     responses.add(
         responses.POST,
         "https://apis.vhi.ie/api/myvhilogin/login",
         json={"status": "SUCCESS", "sessionToken": "test-token"},
-        status=200
+        status=200,
     )
-    
+
     client.login()
     assert client.is_authenticated is True
 
+
 @responses.activate
 def test_login_requires_mfa_success():
     def mfa_callback():
         return "123456"
-        
-    client = VhiClient("test@example.com", "password", mfa_callback=mfa_callback)
-    
+
+    client = VhiClient(
+        "test@example.com", "password", mfa_callback=mfa_callback, cache_session=False
+    )
+
     # Mock primary login returning 200 with MFA_REQUIRED
     responses.add(
         responses.POST,
         "https://apis.vhi.ie/api/myvhilogin/login",
         json={
-            "status": "MFA_REQUIRED", 
+            "status": "MFA_REQUIRED",
             "stateToken": "state-123",
-            "factors": [{"_links": {"verify": {"href": "https://admin-digital.vhi.ie/api/v1/authn/factors/verify"}}}]
+            "factors": [
+                {
+                    "_links": {
+                        "verify": {
+                            "href": "https://admin-digital.vhi.ie/api/v1/authn/factors/verify"
+                        }
+                    }
+                }
+            ],
         },
-        status=200
+        status=200,
+    )
+
+    # Mock MFA trigger returning 200 CHALLENGE
+    responses.add(
+        responses.POST,
+        "https://admin-digital.vhi.ie/api/v1/authn/factors/verify",
+        json={"status": "MFA_CHALLENGE"},
+        status=200,
     )
-    
+
     # Mock MFA verify returning 200 SUCCESS
     responses.add(
         responses.POST,
         "https://admin-digital.vhi.ie/api/v1/authn/factors/verify",
         json={"status": "SUCCESS", "sessionToken": "final-token"},
-        status=200
+        status=200,
     )
-    
+
     client.login()
     assert client.is_authenticated is True
 
+
 @responses.activate
 def test_login_invalid_credentials():
-    client = VhiClient("test@example.com", "wrong")
-    
+    client = VhiClient("test@example.com", "wrong", cache_session=False)
+
     responses.add(
-        responses.POST,
-        "https://apis.vhi.ie/api/myvhilogin/login",
-        status=401
+        responses.POST, "https://apis.vhi.ie/api/myvhilogin/login", status=401
     )
-    
+
     with pytest.raises(VhiAuthenticationError):
         client.login()
 
+
 @responses.activate
 def test_get_claims_success():
-    client = VhiClient("test@example.com", "password")
-    client.is_authenticated = True # Mock existing session
-    
+    client = VhiClient("test@example.com", "password", cache_session=False)
+    client.is_authenticated = True  # Mock existing session
+
     responses.add(
         responses.GET,
         "https://apis.vhi.ie/claims/v1/statements",
@@ -77,36 +97,37 @@ def test_get_claims_success():
                     "dateOfService": "2026-03-15",
                     "practitioner": "Dr. Smith",
                     "documentId": "DOC-123",
-                    "status": "Processed"
+                    "status": "Processed",
                 }
             ]
         },
-        status=200
+        status=200,
     )
-    
+
     claims = client.get_claims()
     assert len(claims) == 1
     assert claims[0].claim_id == "CLM-123"
     assert claims[0].practitioner == "Dr. Smith"
 
+
 @responses.activate
 def test_download_document_success():
-    client = VhiClient("test@example.com", "password")
+    client = VhiClient("test@example.com", "password", cache_session=False)
     client.is_authenticated = True
-    
+
     pdf_content = b"%PDF-1.4 mock pdf content"
-    
+
     responses.add(
         responses.GET,
         "https://apis.vhi.ie/documents/v1/DOC-123/download",
         body=pdf_content,
         status=200,
-        content_type="application/pdf"
+        content_type="application/pdf",
     )
-    
+
     with tempfile.NamedTemporaryFile(delete=False) as tmp:
         dest_path = tmp.name
-        
+
     try:
         client.download_document("DOC-123", dest_path)
         with open(dest_path, "rb") as f:

{vhi_python-0.1.3 → vhi_python-0.1.5}/tests/test_integration.py

@@ -3,9 +3,10 @@ import pytest
 from vhi.client import VhiClient
 from vhi.exceptions import VhiMfaRequiredError, VhiAuthenticationError
 
+
 @pytest.mark.skipif(
     not os.getenv("VHI_USERNAME") or not os.getenv("VHI_PASSWORD"),
-    reason="Integration tests require VHI_USERNAME and VHI_PASSWORD environment variables"
+    reason="Integration tests require VHI_USERNAME and VHI_PASSWORD environment variables",
 )
 def test_live_login():
     """
@@ -14,11 +15,11 @@ def test_live_login():
     """
     username = os.environ["VHI_USERNAME"]
     password = os.environ["VHI_PASSWORD"]
-    
+
     # We initialize without an mfa_callback to ensure it raises VhiMfaRequiredError
     # if MFA is prompted, which validates the primary credentials were correct.
     client = VhiClient(username, password)
-    
+
     try:
         client.login()
         # If it succeeds without MFA, we are authenticated.
@@ -28,4 +29,4 @@ def test_live_login():
         # This confirms our primary login endpoint and payload reverse-engineering is correct.
         pass
     except VhiAuthenticationError as e:
-         pytest.fail(f"Integration login failed - incorrect credentials: {e}")
+        pytest.fail(f"Integration login failed - incorrect credentials: {e}")