tariochbctools 1.4.1__tar.gz → 1.5.0__tar.gz

{tariochbctools-1.4.1 → tariochbctools-1.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tariochbctools
-Version: 1.4.1
+Version: 1.5.0
 Summary: Importers, plugins and price fetchers for Beancount
 Home-page: https://github.com/tarioch/beancounttools/
 Author: Patrick Ruckstuhl
@@ -19,7 +19,7 @@ Classifier: Topic :: Office/Business :: Financial :: Investment
 Description-Content-Type: text/x-rst; charset=UTF-8
 License-File: LICENSE.txt
 Requires-Dist: importlib-metadata; python_version < "3.8"
-Requires-Dist: awardwallet
+Requires-Dist: awardwallet>=0.2
 Requires-Dist: beancount>=3
 Requires-Dist: beangulp
 Requires-Dist: beanprice

{tariochbctools-1.4.1 → tariochbctools-1.5.0}/docs/importers.rst

@@ -447,48 +447,65 @@ Import PDF from `radicant <https://radicant.com/>`__
 AwardWallet
 ------------------------------
 
-Import from `AwardWallet <https://awardwallet.com/>`__ using their `Account Access API <https://awardwallet.com/api/account>`__.
+Import from `AwardWallet <https://awardwallet.com/>`__ using their `Account
+Access API <https://awardwallet.com/api/account>`__.
 
-As of 2025 AwardWallet integrates over 460 airline, hotel, shopping and other loyalty programmes.
+As of 2025 AwardWallet integrates over 460 airline, hotel, shopping and other
+loyalty programmes. Many programmes do not support retrieval of transactions,
+only balances.
 
-Follow the instructions in the `API documentation <https://awardwallet.com/api/account#introduction>`__ to register for a free Business account and create an API key.
+1.  Update your personal AwardWallet account.
+    The importer can only retrieve data that has already been synced to your AwardWallet account.
 
-The API key is restricted to the **allowed IP addresses** you specify in the Business interface API Settings.
+2.  Follow the instructions in the `API documentation
+    <https://awardwallet.com/api/account#introduction>`__ to register for a
+    free Business account and create an API key.
 
-Link and authorize personal accounts using the included ``awardwallet-conf`` CLI tool:
+    The API key is restricted to the **allowed IP addresses** you specify in
+    the Business interface API Settings.
 
-.. code-block:: console
+3.  Link and authorize personal accounts using the included ``awardwallet-conf``
+    CLI tool:
 
-  awardwallet-conf --api-key YOUR_API_KEY get_link_url
+    .. code-block:: console
 
+      awardwallet-conf --api-key YOUR_API_KEY get_link_url
 
-Generate a config file for all linked users called (or ending with) ``awardwallet.yaml`` in your import location (e.g. download folder) and edit it to your needs.
-Note that not all providers support retrieval of transaction history.
+    Manage access to your personal account under `Manage Users
+    <https://awardwallet.com/user/connections>`__ in the personal web
+    interface.
 
-.. code-block:: console
+4.  Generate a config file for all linked users ending with
+    ``awardwallet.yaml`` in your import location (e.g. download folder) and
+    edit it to your needs.
 
-  awardwallet-conf --api-key YOUR_API_KEY generate > awardwallet.yaml
+    .. code-block:: console
 
-Example configuration file:
+      awardwallet-conf --api-key YOUR_API_KEY generate > awardwallet.yaml
 
-.. code-block:: yaml
+    If you have multiple accounts using the same points currency (e.g. ``AVIOS``
+    used by BA, Iberia, ...) create sub-accounts for each so that ``balance``
+    directives will work.
 
-  api_key: YOUR_API_KEY
-  users:
-    12345:
-      name: John Smith
-      all_history: false
-      accounts:
-        7654321:
-          provider: "British Airways Club"
-          account: Assets:Current:Points
-          currency: AVIOS
+    Example configuration file:
 
+    .. code-block:: yaml
 
-Finally, initialize the importer:
+      api_key: YOUR_API_KEY
+      users:
+        12345:
+          name: John Smith
+          all_history: false     # only the last 10 txns per account
+          accounts:
+            7654321:
+              provider: "British Airways Club"
+              account: Assets:Current:Points
+              currency: AVIOS
 
-.. code-block:: python
+5.  Finally, initialize the importer:
+
+    .. code-block:: python
 
-  from tariochbctools.importers.awardwalletimp import importer as awimp
+      from tariochbctools.importers.awardwalletimp import importer as awimp
 
-  CONFIG = [awimp.Importer()]
+      CONFIG = [awimp.Importer()]

{tariochbctools-1.4.1 → tariochbctools-1.5.0}/setup.cfg

@@ -28,7 +28,7 @@ package_dir =
 	=src
 install_requires = 
 	importlib-metadata; python_version<"3.8"
-	awardwallet
+	awardwallet>=0.2
 	beancount>=3
 	beangulp
 	beanprice

{tariochbctools-1.4.1 → tariochbctools-1.5.0}/src/tariochbctools/importers/awardwalletimp/config.py

@@ -5,7 +5,7 @@ from typing import Any
 
 import yaml
 from awardwallet import AwardWalletClient
-from awardwallet.api import AccessLevel
+from awardwallet.client import AccessLevel
 
 
 def get_link_url(client):
@@ -33,19 +33,18 @@ def generate(client):
     connected_users = client.list_connected_users()
 
     for user in connected_users:
-        user_id = user["userId"]
-        user_details = client.get_connected_user_details(user_id)
+        user_details = client.get_connected_user_details(user.user_id)
         account_config = {}
 
-        for account in user_details.get("accounts", []):
-            account_config[account["accountId"]] = {
-                "provider": account["displayName"],
+        for account in user_details.accounts:
+            account_config[account.account_id] = {
+                "provider": account.display_name,
                 "account": "Assets:Current:Points",  # Placeholder, user should adjust
                 "currency": "POINTS",
             }
 
-        config["users"][user_id] = {
-            "name": user["userName"],
+        config["users"][user.user_id] = {
+            "name": user.user_name,
             "all_history": False,
             "accounts": account_config,
         }

{tariochbctools-1.4.1 → tariochbctools-1.5.0}/src/tariochbctools/importers/awardwalletimp/importer.py

@@ -1,11 +1,13 @@
+import datetime
 import logging
+import re
+from operator import attrgetter
 from os import path
-from typing import Any
 
 import beangulp
 import dateutil.parser
 import yaml
-from awardwallet import AwardWalletClient
+from awardwallet import AwardWalletClient, model
 from beancount.core import amount, data
 from beancount.core.number import D
 
@@ -46,27 +48,33 @@ class Importer(beangulp.Importer):
         return entries
 
     def _extract_user_history(
-        self, user: dict, user_details: dict
+        self, user: dict, user_details: model.GetConnectedUserDetailsResponse
     ) -> list[data.Transaction]:
         """
         User history is limited to the last 10 history elements per account
         """
         entries = []
-        for account in user_details["accounts"]:
-            account_id = account["accountId"]
-
-            if account_id in user["accounts"]:
-                logging.info("Extracting account ID %s", account_id)
-                account_config = user["accounts"][account_id]
+        for account in user_details.accounts:
+            if account.account_id in user["accounts"]:
+                logging.info("Extracting account ID %s", account.account_id)
+                account_config = user["accounts"][account.account_id]
 
                 entries.extend(
                     self._extract_transactions(
-                        account["history"], account_config, account_id
+                        account.history, account_config, account.account_id
                     )
                 )
+
+                # we fudge the date by using the latest txn (across *all* accounts)
+                latest_txn = max(entries, key=attrgetter("date"), default=None)
+                entries.extend(
+                    self._extract_balance(account, account_config, latest_txn)
+                )
             else:
                 logging.warning(
-                    "Ignoring account ID %s: %s", account_id, account["displayName"]
+                    "Ignoring account ID %s: %s",
+                    account.account_id,
+                    account.display_name,
                 )
         return entries
 
@@ -76,13 +84,15 @@ class Importer(beangulp.Importer):
         entries = []
         for account_id, account_config in user["accounts"].items():
             logging.info("Extracting account ID %s", account_id)
-            account = client.get_account_details(account_id)["account"]
+            account = client.get_account_details(account_id).account
 
             entries.extend(
-                self._extract_transactions(
-                    account["history"], account_config, account_id
-                )
+                self._extract_transactions(account.history, account_config, account_id)
             )
+
+            # we fudge the date by using the latest txn (across *all* accounts)
+            latest_txn = max(entries, key=attrgetter("date"), default=None)
+            entries.extend(self._extract_balance(account, account_config, latest_txn))
         return entries
 
     def _extract_transactions(
@@ -109,7 +119,7 @@ class Importer(beangulp.Importer):
 
     def _extract_transaction(
         self,
-        trx: dict[str, Any],
+        trx: model.HistoryItem,
         local_account: data.Account,
         currency: str,
         account_id: str,
@@ -121,20 +131,23 @@ class Importer(beangulp.Importer):
         trx_description = None
         trx_amount = None
 
-        for f in trx.get("fields", []):
-            if f["code"] == "PostingDate":
-                trx_date = dateutil.parser.parse(f["value"]["value"]).date()
-            if f["code"] == "Description":
-                trx_description = f["value"]["value"].replace("\n", " ")
-            if f["code"] == "Miles":
-                trx_amount = D(f["value"]["value"])
-            if f["code"] == "Info":
-                name = f["name"].lower().replace(" ", "-")
-                metakv[name] = f["value"]["value"].replace("\n", " ")
+        for f in trx.fields:
+            if f.code == "PostingDate":
+                trx_date = dateutil.parser.parse(f.value.value).date()
+            if f.code == "Description":
+                trx_description = f.value.value.replace("\n", " ")
+            if f.code == "Miles":
+                trx_amount = D(f.value.value)
+            if f.code == "Info":
+                name = re.sub(r"\W", "-", f.name).lower()
+                metakv[name] = f.value.value.replace("\n", " ")
 
         assert trx_date
         assert trx_description
-        assert trx_amount is not None, f"No amount in trx: {trx}"
+
+        if trx_amount is None:
+            logging.warning("Skipping transaction with no amount: %s", trx)
+            return []
 
         meta = data.new_metadata("", 0, metakv)
         entry = data.Transaction(
@@ -158,3 +171,36 @@ class Importer(beangulp.Importer):
         )
         entries.append(entry)
         return entries
+
+    def _extract_balance(
+        self,
+        account: model.Account,
+        account_config: dict,
+        latest_txn: data.Transaction | None,
+    ) -> list[data.Transaction]:
+        local_account = account_config["account"]
+        currency = account_config["currency"]
+        balance = amount.Amount(D(account.balance_raw), currency)
+        metakv = {"account-id": str(account.account_id)}
+
+        optional_date = account.last_change_date or account.last_retrieve_date
+        if optional_date:
+            date = optional_date.date()
+        elif latest_txn:
+            date = latest_txn.date
+        else:
+            logging.warning(
+                "No date information available for balance of account %s, using today",
+                account.account_id,
+            )
+            date = datetime.date.today()
+
+        entry = data.Balance(
+            data.new_metadata("", 0, metakv),
+            date + datetime.timedelta(days=1),
+            local_account,
+            balance,
+            None,
+            None,
+        )
+        return [entry]

{tariochbctools-1.4.1 → tariochbctools-1.5.0}/src/tariochbctools/importers/radicant/importer.py

@@ -1,5 +1,5 @@
 import re
-from datetime import datetime
+from datetime import datetime, timedelta
 
 import beangulp
 import camelot
@@ -46,6 +46,11 @@ class Importer(beangulp.Importer):
         if conversionOriginal and conversionRate:
             kv = {"original": conversionOriginal, "rate": conversionRate}
             text = text.replace("Amount: " + conversionOriginal, "")
+            # handle decimal seperated original amounts
+            [originalCcy, originalAmt] = conversionOriginal.split(" ")
+            text = text.replace(
+                "Amount: " + f"{originalCcy} {float(originalAmt):,}", ""
+            )
         else:
             kv = None
 
@@ -63,17 +68,34 @@ class Importer(beangulp.Importer):
             ],
         )
 
+    def createBalance(
+        self,
+        filepath: str,
+        date: str,
+        amt: amount.Amount,
+    ) -> data.Balance:
+        meta = data.new_metadata(filepath, 0, None)
+        return data.Balance(
+            meta,
+            datetime.strptime(date, "%d.%m.%Y").date() + timedelta(days=1),
+            self._account,
+            amt,
+            None,
+            None,
+        )
+
     def extract(self, filepath: str, existing: data.Entries) -> data.Entries:
         entries = []
 
         conversionPattern = re.compile(r"(?P<original>.+) at the rate of (?P<rate>.+)")
+        balancePattern = re.compile(r"Balance as of (?P<date>\d\d\.\d\d\.\d\d\d\d)")
 
         tables = camelot.read_pdf(
             filepath,
             flavor="stream",
             pages="all",
-            table_regions=["40,470,580,32"],
-            columns=["110,300,370,440,500"],
+            table_regions=["40,600,580,32"],
+            columns=["110,305,370,440,500"],
             strip_text="\n",
             layout_kwargs={"word_margin": 0.50},
             split_text=True,
@@ -89,7 +111,7 @@ class Importer(beangulp.Importer):
             conversionOriginal = None
             conversionRate = None
             for _, row in df.iterrows():
-                date, text, _, debit, credit, _ = tuple(row)
+                date, text, _, debit, credit, bal = tuple(row)
 
                 # skip stuff before
                 if beforeStart and "Date" != date:
@@ -98,8 +120,16 @@ class Importer(beangulp.Importer):
                     beforeStart = False
                     continue
 
-                # skip stuff after
-                if "Balance as of" in text:
+                # create balance and skip stuff after
+                balanceMatch = balancePattern.match(text)
+                if balanceMatch:
+                    entries.append(
+                        self.createBalance(
+                            filepath,
+                            balanceMatch.group("date"),
+                            amount.Amount(D(bal.replace("'", "")), self.currency),
+                        )
+                    )
                     break
 
                 trxDate = date

{tariochbctools-1.4.1 → tariochbctools-1.5.0}/src/tariochbctools.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tariochbctools
-Version: 1.4.1
+Version: 1.5.0
 Summary: Importers, plugins and price fetchers for Beancount
 Home-page: https://github.com/tarioch/beancounttools/
 Author: Patrick Ruckstuhl
@@ -19,7 +19,7 @@ Classifier: Topic :: Office/Business :: Financial :: Investment
 Description-Content-Type: text/x-rst; charset=UTF-8
 License-File: LICENSE.txt
 Requires-Dist: importlib-metadata; python_version < "3.8"
-Requires-Dist: awardwallet
+Requires-Dist: awardwallet>=0.2
 Requires-Dist: beancount>=3
 Requires-Dist: beangulp
 Requires-Dist: beanprice

{tariochbctools-1.4.1 → tariochbctools-1.5.0}/src/tariochbctools.egg-info/requires.txt

@@ -1,4 +1,4 @@
-awardwallet
+awardwallet>=0.2
 beancount>=3
 beangulp
 beanprice

{tariochbctools-1.4.1 → tariochbctools-1.5.0}/tests/tariochbctools/importers/test_awardwallet.py

@@ -2,6 +2,8 @@ import json
 from unittest.mock import MagicMock, patch
 
 import pytest
+from awardwallet import model
+from beancount.core.data import Balance
 from beancount.core.number import D
 
 from tariochbctools.importers.awardwalletimp import importer as awimp
@@ -25,6 +27,7 @@ TEST_CONFIG = b"""
             currency: VIRGINPTS
       34:
         name: User with dummy account
+        all_history: true
         accounts:
           0:
 """
@@ -56,6 +59,7 @@ TEST_TRX = b"""
     }
 """
 
+# second account has no optional fields
 TEST_USER_DETAILS = b"""
     {
       "userId": 12,
@@ -82,8 +86,8 @@ TEST_USER_DETAILS = b"""
           "autologinUrl": "https://business.awardwallet.com/account/redirect?ID=7654321",
           "updateUrl": "https://business.awardwallet.com/account/edit/7654321?autosubmit=1",
           "editUrl": "https://business.awardwallet.com/account/edit/7654321",
-          "balance": "146,780",
-          "balanceRaw": 146780,
+          "balance": "123,456",
+          "balanceRaw": 123456,
           "owner": "John Smith",
           "errorCode": 1,
           "lastDetectedChange": "+750",
@@ -93,49 +97,49 @@ TEST_USER_DETAILS = b"""
           "properties": [
             {
               "name": "Next Elite Level",
-              "value": {"value": "Bronze", "type": "string"},
+              "value": "Bronze",
               "kind": 9
             },
             {
               "name": "Date of joining the club",
-              "value": {"value": "20 Jun 2013", "type": "string"},
+              "value": "20 Jun 2013",
               "kind": 5
             },
             {
               "name": "Lifetime Tier Points",
-              "value": {"value": "35,000", "type": "string"}
+              "value": "35,000"
             },
             {
               "name": "Executive Club Tier Points",
-              "value": {"value": "35,000", "type": "string"}
+              "value": "35,000"
             },
             {
               "name": "Card expiry date",
-              "value": {"value": "31 Mar 2017", "type": "string"}
+              "value": "31 Mar 2017"
             },
             {
               "name": "Membership year ends",
-              "value": {"value": "08 Feb 2016", "type": "string"}
+              "value": "08 Feb 2016"
             },
             {
               "name": "Last Activity",
-              "value": {"value": "10-Dec-15", "type": "string"},
+              "value": "10-Dec-15",
               "kind": 13
             },
             {
               "name": "Name",
-              "value": {"value": "Mr Smith", "type": "string"},
+              "value": "Mr Smith",
               "kind": 12
             },
             {
               "name": "Level",
-              "value": {"value": "Blue", "type": "string"},
+              "value": "Blue",
               "rank": 0,
               "kind": 3
             },
             {
               "name": "Membership no",
-              "value": {"value": "1122334455", "type": "string"},
+              "value": "1122334455",
               "kind": 1
             }
           ],
@@ -219,18 +223,14 @@ TEST_USER_DETAILS = b"""
           "code": "virgin",
           "displayName": "Virgin Atlantic (Flying Club)",
           "kind": "Airlines",
-          "balance": "146,780",
-          "balanceRaw": 146780,
+          "login": "johnsmith",
+          "autologinUrl": "https://business.awardwallet.com/account/redirect?ID=7654321",
+          "updateUrl": "https://business.awardwallet.com/account/edit/7654321?autosubmit=1",
+          "editUrl": "https://business.awardwallet.com/account/edit/7654321",
+          "balance": "24,680",
+          "balanceRaw": 24680,
           "owner": "John Smith",
           "errorCode": 1,
-          "lastDetectedChange": "+750",
-          "properties": [
-            {
-              "name": "Next Elite Level",
-              "value": {"value": "Bronze", "type": "string"},
-              "kind": 9
-            }
-          ],
           "history": [
           ]
         }
@@ -271,12 +271,14 @@ def awardwallet_importer_factory(tmp_path):
 
 @pytest.fixture(name="tmp_trx")
 def tmp_trx_fixture():
-    yield json.loads(TEST_TRX)
+    j = json.loads(TEST_TRX, strict=False)
+    yield model.HistoryItem(**j)
 
 
 @pytest.fixture(name="tmp_user_details")
 def tmp_user_details_fixture():
-    yield json.loads(TEST_USER_DETAILS, strict=False)
+    j = json.loads(TEST_USER_DETAILS, strict=False)
+    yield model.GetConnectedUserDetailsResponse(**j)
 
 
 def test_identify(importer, tmp_config):
@@ -285,9 +287,7 @@ def test_identify(importer, tmp_config):
 
 def test_extract_transaction_simple(importer, tmp_trx):
     entries = importer._extract_transaction(tmp_trx, "Assets:Other", "POINTS", 7654321)
-    assert entries[0].postings[0].units.number == D(
-        tmp_trx["fields"][3]["value"]["value"]
-    )
+    assert entries[0].postings[0].units.number == D(tmp_trx.fields[3].value.value)
 
 
 def test_extract_user_history(importer, tmp_user_details):
@@ -295,21 +295,34 @@ def test_extract_user_history(importer, tmp_user_details):
         importer.config["users"][12],
         tmp_user_details,
     )
-    assert len(entries) == 3
+
+    assert len(entries) == 5  # three txns, two balances
+
+    balances = [e for e in entries if isinstance(e, Balance)]
+    assert len(balances) == 2
+    assert balances[0].amount.number == D("123456")
+    assert balances[0].amount.currency == "AVIOS"
+    assert balances[1].amount.number == D("24680")
+    assert balances[1].amount.currency == "VIRGINPTS"
 
 
 @patch("tariochbctools.importers.awardwalletimp.importer.AwardWalletClient")
 def test_extract_all_users(mock_api, importer, tmp_config, tmp_user_details):
     importer._extract_user_history = MagicMock()
+    importer._extract_account_history = MagicMock()
 
     importer.extract(tmp_config)
-    assert importer._extract_user_history.call_count == 2
+    assert importer._extract_user_history.call_count == 1
+    assert importer._extract_account_history.call_count == 1
 
 
 @patch("tariochbctools.importers.awardwalletimp.importer.AwardWalletClient")
 def test_extract_all_accounts(mock_api, importer, tmp_config, tmp_user_details):
     importer._extract_transactions = MagicMock()
+    importer._extract_balance = MagicMock()
     mock_api.return_value.get_connected_user_details.return_value = tmp_user_details
+    # get_account_details mock (for user 34) returns zero txns
 
     importer.extract(tmp_config)
-    assert importer._extract_transactions.call_count == 2
+    assert importer._extract_transactions.call_count == 3
+    assert importer._extract_balance.call_count == 3