beancount-gocardless 0.1.6__py3-none-any.whl → 0.1.8__py3-none-any.whl

beancount_gocardless/client.py

@@ -2,11 +2,29 @@ from datetime import timedelta, datetime
 import requests_cache
 import requests
 from typing import TypedDict, Optional
-
-
-def remove_vary_header(response):
-    if "Vary" in response.headers:
-        del response.headers["Vary"]  # Fuck it, it’s gone
+import logging
+
+logger = logging.getLogger(__name__)
+
+
+def strip_headers_hook(response, *args, **kwargs):
+    to_preserve = [
+        "Content-Type",
+        "Date",
+        "Content-Encoding",
+        "Content-Language",
+        "Last-Modified",
+    ]
+    deleted = set()
+    to_preserve_lower = [h.lower() for h in to_preserve]
+    header_keys_to_check = response.headers.copy().keys()
+    for header in header_keys_to_check:
+        if header.lower() in to_preserve_lower:
+            continue
+        else:
+            response.headers.pop(header, None)
+            deleted.add(header)
+    logger.debug("Deleted headers: %s", ", ".join(deleted))
     return response
 
 
@@ -23,7 +41,7 @@ class CacheOptions(TypedDict, total=False):
 
     cache_name: requests_cache.StrOrPath
     backend: Optional[requests_cache.BackendSpecifier]
-    expire_after: requests_cache.ExpirationTime
+    expire_after: int
     old_data_on_error: bool
 
 
@@ -63,7 +81,7 @@ class BaseService:
         "expire_after": 0,
         "old_data_on_error": True,
         "match_headers": False,
-        "response_hook": remove_vary_header,
+        "cache_control": False,
     }
 
     def __init__(
@@ -82,21 +100,78 @@ class BaseService:
         """
         self.secret_id = secret_id
         self.secret_key = secret_key
-        self.token = None
+        self._token = None
         merged_options = {**self.DEFAULT_CACHE_OPTIONS, **(cache_options or {})}
         self.session = requests_cache.CachedSession(**merged_options)
+        self.session.hooks["response"].append(strip_headers_hook)
+
+    def check_cache_status(self, method: str, url: str, params=None, data=None) -> dict:
+        """
+        Attempts to predict the cache status for a given request.
+
+        NOTE: This is an approximation and relies on internal mechanisms
+              that might change. It also performs I/O to check the cache.
+
+        Args:
+            method (str): HTTP method ("GET", "POST", etc.).
+            endpoint (str): API endpoint.
+            params (dict, optional): URL parameters.
+            data (dict, optional): Request body data.
+
+        Returns:
+            dict: Information about the potential cache state:
+                  {'key_exists': bool, 'is_expired': Optional[bool], 'cache_key': str}
+                  'is_expired' is None if the key doesn't exist or expiration
+                  cannot be reliably determined without full retrieval.
+        """
+        headers = {"Authorization": f"Bearer {self.token}"}
+
+        req = requests.Request(method, url, params=params, data=data, headers=headers)
+        prepared_request: requests.PreparedRequest = self.session.prepare_request(req)
+        cache = self.session.cache
+        cache_key = cache.create_key(prepared_request)
+        key_exists = cache.contains(cache_key)
+        is_expired = None
+
+        if key_exists:
+            try:
+                # Try to get the response object without triggering expiration side effects
+                # Note: This still reads from the cache backend (I/O)
+                cached_response = cache.get_response(cache_key)
+                if cached_response:
+                    # is_expired is a property calculated on the CachedResponse
+                    is_expired = cached_response.is_expired
+                else:
+                    # get_response might return None if item expired and configured to delete
+                    # Or if backend consistency issue. Treat as expired/absent.
+                    key_exists = False  # Correct the state if get_response fails
+                    is_expired = True  # Assume expired if get_response returns None for existing key
+            except Exception as e:
+                logger.error(
+                    f"Error checking expiration for cache key {cache_key}: {e}"
+                )
+                # Cannot determine expiration reliably
+                is_expired = None  # Mark as unknown
+
+        return {
+            "key_exists": key_exists,
+            "is_expired": is_expired,
+            "cache_key": cache_key,
+        }
 
-    def _ensure_token_valid(self):
+    @property
+    def token(self):
         """
-        Ensure a valid token exists.  Gets a new token if one doesn't exist.
+        Ensure a token exists.  Gets a new token if one doesn't exist.
         Nordigen tokens don't currently have a refresh mechanism, so this just gets a new one if needed.
         """
-        if not self.token:
+        if not self._token:
             self.get_token()
+        return self._token
 
     def get_token(self):
         """
-        Fetch a new API access token using credentials. Sets the `self.token` attribute.
+        Fetch a new API access token using credentials. Sets the `self._token` attribute.
 
         Raises:
             HttpServiceException: If the API request fails.
@@ -106,7 +181,7 @@ class BaseService:
             data={"secret_id": self.secret_id, "secret_key": self.secret_key},
         )
         self._handle_response(response)
-        self.token = response.json()["access"]
+        self._token = response.json()["access"]
 
     def _handle_response(self, response):
         """
@@ -140,12 +215,14 @@ class BaseService:
             HttpServiceException: If the API request fails.
         """
         url = f"{self.BASE_URL}{endpoint}"
-        self._ensure_token_valid()
         headers = {"Authorization": f"Bearer {self.token}"}
 
+        status = self.check_cache_status(method, url, params, data)
+        logger.debug(f"{endpoint}: {'expired' if status["is_expired"] else 'cache ok'}")
         response = self.session.request(
             method, url, headers=headers, params=params, data=data
         )
+        logger.info("Response headers", response.headers)
 
         # Retry once if token expired (401 Unauthorized)
         if response.status_code == 401:

beancount_gocardless/importer.py

@@ -34,7 +34,7 @@ class NordigenImporter(beangulp.Importer):
             self._client = NordigenClient(
                 self.config["secret_id"],
                 self.config["secret_key"],
-                cache_options=self.config.get('cache_options', None),
+                cache_options=self.config.get("cache_options", None),
             )
 
         return self._client
@@ -116,7 +116,7 @@ class NordigenImporter(beangulp.Importer):
             key=lambda x: x[0].get("valueDate") or x[0].get("bookingDate"),
         )
 
-    def add_metadata(self, transaction, filing_account: str):
+    def add_metadata(self, transaction, custom_metadata):
         """
         Extracts metadata from a transaction and returns it as a dictionary.
 
@@ -124,7 +124,7 @@ class NordigenImporter(beangulp.Importer):
 
         Args:
             transaction (dict): The transaction data from the API.
-            filing_account (str):  The optional filing account from the configuration.
+            custom_metadata (dict): Custom metadata from the config file.
 
         Returns:
             dict: A dictionary of metadata key-value pairs.
@@ -151,8 +151,7 @@ class NordigenImporter(beangulp.Importer):
         if transaction.get("bookingDate"):
             metakv["bookingDate"] = transaction["bookingDate"]
 
-        if filing_account:
-            metakv["filing_account"] = filing_account
+        metakv.update(custom_metadata)
 
         return metakv
 
@@ -223,11 +222,10 @@ class NordigenImporter(beangulp.Importer):
         Returns:
             str: The Beancount transaction flag.
         """
-        # Could be configured to use "!" for pending transactions status == 'pending'
-        return flags.FLAG_OKAY
+        return flags.FLAG_OKAY if status == "booked" else flags.FLAG_WARNING
 
     def create_transaction_entry(
-        self, transaction, status, asset_account, filing_account
+        self, transaction, status, asset_account, custom_metadata
     ):
         """
         Creates a Beancount transaction entry from a Nordigen transaction.
@@ -238,12 +236,12 @@ class NordigenImporter(beangulp.Importer):
             transaction (dict): The transaction data from the API.
             status (str): The transaction status ('booked' or 'pending').
             asset_account (str): The Beancount asset account.
-            filing_account (str): The optional filing account.
+            custom_metadata (dict): Custom metadata from config
 
         Returns:
             data.Transaction: The created Beancount transaction entry.
         """
-        metakv = self.add_metadata(transaction, filing_account)
+        metakv = self.add_metadata(transaction, custom_metadata)
         meta = data.new_metadata("", 0, metakv)
 
         trx_date = self.get_transaction_date(transaction)
@@ -294,14 +292,15 @@ class NordigenImporter(beangulp.Importer):
         for account in self.config["accounts"]:
             account_id = account["id"]
             asset_account = account["asset_account"]
-            filing_account = account.get("filing_account", None)
+            # Use get() with a default empty dict for custom_metadata
+            custom_metadata = account.get("metadata", {})
 
             transactions_data = self.get_transactions_data(account_id)
             all_transactions = self.get_all_transactions(transactions_data)
 
             for transaction, status in all_transactions:
                 entry = self.create_transaction_entry(
-                    transaction, status, asset_account, filing_account
+                    transaction, status, asset_account, custom_metadata
                 )
                 entries.append(entry)
 

{beancount_gocardless-0.1.6.dist-info → beancount_gocardless-0.1.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: beancount-gocardless
-Version: 0.1.6
+Version: 0.1.8
 Summary: 
 License: MIT
 Requires-Python: >=3.12

beancount_gocardless-0.1.8.dist-info/RECORD

@@ -0,0 +1,9 @@
+beancount_gocardless/__init__.py,sha256=Rf2-pfuaXaXPwBu3yEn2uXyOQ6uLyGxljJ5hoTCss5Y,100
+beancount_gocardless/cli.py,sha256=ZdsdknScEOlUq_7rI0ixzN1UDh1dgUokzTzO_3WySqY,2407
+beancount_gocardless/client.py,sha256=g2Px7mcM34ibEAVzbxUtCTVrGWO1sm_CmCL-PXySHro,15764
+beancount_gocardless/importer.py,sha256=tjNKPCYFddR62YDAXm6rfLqcVNeiGKWbVAEyoPWPekg,11151
+beancount_gocardless-0.1.8.dist-info/LICENSE,sha256=7EI8xVBu6h_7_JlVw-yPhhOZlpY9hP8wal7kHtqKT_E,1074
+beancount_gocardless-0.1.8.dist-info/METADATA,sha256=-WXcAySDk-rankLsjnn9keWLVrrscByJdwl2n1h1bkw,2634
+beancount_gocardless-0.1.8.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
+beancount_gocardless-0.1.8.dist-info/entry_points.txt,sha256=fmhiRcNVrum0p30f5YNqvIYVEPXYsS5cP1xNkVmdn8k,70
+beancount_gocardless-0.1.8.dist-info/RECORD,,

beancount_gocardless-0.1.6.dist-info/RECORD

@@ -1,9 +0,0 @@
-beancount_gocardless/__init__.py,sha256=Rf2-pfuaXaXPwBu3yEn2uXyOQ6uLyGxljJ5hoTCss5Y,100
-beancount_gocardless/cli.py,sha256=ZdsdknScEOlUq_7rI0ixzN1UDh1dgUokzTzO_3WySqY,2407
-beancount_gocardless/client.py,sha256=PHZQH3O122cqYsYZDdb1NEoYuS5NBJc0ZteostnMUbM,12511
-beancount_gocardless/importer.py,sha256=TcwHnXFLBER6RGhd0siaK4kD6ToSdmvWODwh_ZfT6e4,11183
-beancount_gocardless-0.1.6.dist-info/LICENSE,sha256=7EI8xVBu6h_7_JlVw-yPhhOZlpY9hP8wal7kHtqKT_E,1074
-beancount_gocardless-0.1.6.dist-info/METADATA,sha256=WZ5uXpof3dWLDVQFwM_7UX5i_I6y78tJ6A1oMHlE2s8,2634
-beancount_gocardless-0.1.6.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
-beancount_gocardless-0.1.6.dist-info/entry_points.txt,sha256=fmhiRcNVrum0p30f5YNqvIYVEPXYsS5cP1xNkVmdn8k,70
-beancount_gocardless-0.1.6.dist-info/RECORD,,