tariochbctools 1.2.4__py2.py3-none-any.whl → 1.4.0__py2.py3-none-any.whl

tariochbctools/importers/awardwalletimp/config.py

@@ -0,0 +1,93 @@
+import argparse
+import sys
+import uuid
+from typing import Any
+
+import yaml
+from awardwallet import AwardWalletClient
+from awardwallet.api import AccessLevel
+
+
+def get_link_url(client):
+    connection_url = client.get_connection_link(
+        platform="desktop",
+        access_level=AccessLevel.READ_ALL_EXCEPT_PASSWORDS,
+        state=str(uuid.uuid4()),
+    )
+    print(  # noqa: T201
+        "Redirect your user to this URL to authorize the connection."
+        "\nThis link expires in 10 minutes:"
+    )
+    print(connection_url)  # noqa: T201
+
+
+def generate(client):
+    """
+    Generate a config for a user including user_id and account_id list.
+    Output in yaml format.
+    """
+    config = {}
+    config["api_key"] = client.api_key
+    config["users"] = {}
+
+    connected_users = client.list_connected_users()
+
+    for user in connected_users:
+        user_id = user["userId"]
+        user_details = client.get_connected_user_details(user_id)
+        account_config = {}
+
+        for account in user_details.get("accounts", []):
+            account_config[account["accountId"]] = {
+                "provider": account["displayName"],
+                "account": "Assets:Current:Points",  # Placeholder, user should adjust
+                "currency": "POINTS",
+            }
+
+        config["users"][user_id] = {
+            "name": user["userName"],
+            "all_history": False,
+            "accounts": account_config,
+        }
+
+    yaml.dump(config, sys.stdout, sort_keys=False)
+
+
+def parse_args(args: Any) -> Any:
+    parser = argparse.ArgumentParser(description="awardwallet-config")
+    sub_parsers = parser.add_subparsers(dest="mode", required=True)
+
+    parser.add_argument(
+        "--api-key",
+        required=True,
+        help="API key, can be generated on AwardWallet Business interface",
+    )
+
+    sub_parsers.add_parser(
+        "get_link_url", help="Generate a connection link URL for user authorization"
+    )
+    sub_parsers.add_parser(
+        "generate", help="Generate a configuration template for connected users"
+    )
+
+    return parser.parse_args(args)
+
+
+def main(args: Any) -> None:
+    args = parse_args(args)
+
+    client = AwardWalletClient(args.api_key)
+
+    if args.mode == "get_link_url":
+        get_link_url(client)
+    elif args.mode == "generate":
+        generate(client)
+
+
+def run() -> None:
+    """Entry point for console_scripts"""
+    main(sys.argv[1:])
+
+
+if __name__ == "__main__":
+    main(sys.argv[1:])

tariochbctools/importers/awardwalletimp/importer.py

@@ -0,0 +1,160 @@
+import logging
+from os import path
+from typing import Any
+
+import beangulp
+import dateutil.parser
+import yaml
+from awardwallet import AwardWalletClient
+from beancount.core import amount, data
+from beancount.core.number import D
+
+
+class Importer(beangulp.Importer):
+    """An importer for AwardWallet"""
+
+    def _configure(self, filepath: str, existing: data.Entries) -> None:
+        with open(filepath, "r") as f:
+            self.config = yaml.safe_load(f)
+        self.api_key = self.config["api_key"]
+
+    def identify(self, filepath: str) -> bool:
+        return path.basename(filepath).endswith("awardwallet.yaml")
+
+    def account(self, filepath: str) -> data.Account:
+        return ""
+
+    def extract(self, filepath: str, existing: data.Entries = None) -> data.Entries:
+        self._configure(filepath, existing)
+        client = AwardWalletClient(self.api_key)
+        entries = []
+
+        for user_id, user in self.config["users"].items():
+            user_details = client.get_connected_user_details(user_id)
+
+            if user.get("accounts"):
+                if user.get("all_history", False):
+                    entries.extend(self._extract_account_history(user, client))
+                else:
+                    entries.extend(self._extract_user_history(user, user_details))
+            else:
+                logging.warning(
+                    "Ignoring user ID %s: no accounts configured",
+                    user_id,
+                )
+
+        return entries
+
+    def _extract_user_history(
+        self, user: dict, user_details: dict
+    ) -> 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]
+
+                entries.extend(
+                    self._extract_transactions(
+                        account["history"], account_config, account_id
+                    )
+                )
+            else:
+                logging.warning(
+                    "Ignoring account ID %s: %s", account_id, account["displayName"]
+                )
+        return entries
+
+    def _extract_account_history(
+        self, user: dict, client: AwardWalletClient
+    ) -> list[data.Transaction]:
+        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"]
+
+            entries.extend(
+                self._extract_transactions(
+                    account["history"], account_config, account_id
+                )
+            )
+        return entries
+
+    def _extract_transactions(
+        self,
+        history: list,
+        account_config: dict,
+        account_id: str,
+    ) -> list[data.Transaction]:
+        local_account = account_config["account"]
+        currency = account_config["currency"]
+
+        logging.debug(
+            "Extracting %i transactions for account %s",
+            len(history),
+            account_id,
+        )
+
+        entries = []
+        for trx in history:
+            entries.extend(
+                self._extract_transaction(trx, local_account, currency, account_id)
+            )
+        return entries
+
+    def _extract_transaction(
+        self,
+        trx: dict[str, Any],
+        local_account: data.Account,
+        currency: str,
+        account_id: str,
+    ) -> list[data.Transaction]:
+        entries = []
+        metakv = {"account-id": str(account_id)}
+
+        trx_date = None
+        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", " ")
+
+        assert trx_date
+        assert trx_description
+        assert trx_amount is not None, f"No amount in trx: {trx}"
+
+        meta = data.new_metadata("", 0, metakv)
+        entry = data.Transaction(
+            meta,
+            trx_date,
+            "*",
+            "",
+            trx_description,
+            data.EMPTY_SET,
+            data.EMPTY_SET,
+            [
+                data.Posting(
+                    local_account,
+                    amount.Amount(trx_amount, currency),
+                    None,
+                    None,
+                    None,
+                    None,
+                ),
+            ],
+        )
+        entries.append(entry)
+        return entries

tariochbctools/importers/nordigen/nordigen_config.py

@@ -1,5 +1,6 @@
 import argparse
 import sys
+from json import JSONDecoder
 from typing import Any
 
 import requests
@@ -41,24 +42,45 @@ def list_bank(token: str, country: str) -> None:
         print(asp["name"] + ": " + asp["id"])  # noqa: T201
 
 
-def create_link(token: str, reference: str, bank: str) -> None:
+def create_link(
+    token: str,
+    reference: str,
+    bank: str,
+    max_historical_days: str,
+    access_valid_for_days: str,
+    access_scope: str,
+) -> None:
     if not bank:
         raise Exception("Please specify --bank it is required for create_link")
     requisitionId = _find_requisition_id(token, reference)
     if requisitionId:
         print(f"Link for for reference {reference} already exists.")  # noqa: T201
     else:
-        r = requests.post(
+        decoder = JSONDecoder()
+        r1 = requests.post(
+            "https://bankaccountdata.gocardless.com/api/v2/agreements/enduser/",
+            data={
+                "institution_id": bank,
+                "max_historical_days": max_historical_days,
+                "access_valid_for_days": access_valid_for_days,
+                "access_scope": decoder.decode(access_scope),
+            },
+            headers=build_header(token),
+        )
+        check_result(r1)
+        agreement_id = r1.json()["id"]
+        r2 = requests.post(
             "https://bankaccountdata.gocardless.com/api/v2/requisitions/",
             data={
                 "redirect": "http://localhost",
+                "agreement": agreement_id,
                 "institution_id": bank,
                 "reference": reference,
             },
             headers=build_header(token),
         )
-        check_result(r)
-        link = r.json()["link"]
+        check_result(r2)
+        link = r2.json()["link"]
         print(f"Go to {link} for connecting to your bank.")  # noqa: T201
 
 
@@ -137,12 +159,27 @@ def parse_args(args: Any) -> Any:
     parser.add_argument(
         "--reference",
         default="beancount",
-        help="reference for add_bank and delete_bank, needs to be unique",
+        help="reference for create_link and delete_link, needs to be unique",
     )
     parser.add_argument(
         "--bank",
         help="Bank to connect to, see list_banks",
     )
+    parser.add_argument(
+        "--max_historical_days",
+        default="90",
+        help="the length of the transaction history to be retrieved",
+    )
+    parser.add_argument(
+        "--access_valid_for_days",
+        default="90",
+        help="the length of days while the access to account is valid, must be > 0 and <= 90",
+    )
+    parser.add_argument(
+        "--access_scope",
+        default='["balances", "details", "transactions"]',
+        help="the scope of information",
+    )
     parser.add_argument(
         "mode",
         choices=[
@@ -163,7 +200,14 @@ def main(args: Any) -> None:
     if args.mode == "list_banks":
         list_bank(token, args.country)
     elif args.mode == "create_link":
-        create_link(token, args.reference, args.bank)
+        create_link(
+            token,
+            args.reference,
+            args.bank,
+            args.max_historical_days,
+            args.access_valid_for_days,
+            args.access_scope,
+        )
     elif args.mode == "list_accounts":
         list_accounts(token)
     elif args.mode == "delete_link":

{tariochbctools-1.2.4.dist-info → tariochbctools-1.4.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tariochbctools
-Version: 1.2.4
+Version: 1.4.0
 Summary: Importers, plugins and price fetchers for Beancount
 Home-page: https://github.com/tarioch/beancounttools/
 Author: Patrick Ruckstuhl
@@ -20,6 +20,7 @@ Classifier: License :: OSI Approved :: MIT License
 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: beancount>=3
 Requires-Dist: beangulp
 Requires-Dist: beanprice

{tariochbctools-1.2.4.dist-info → tariochbctools-1.4.0.dist-info}/RECORD

@@ -1,5 +1,8 @@
 tariochbctools/__init__.py,sha256=pH5i4Fj1tbXLqLtTVIdoojiplZssQn0nnud8-HXodRE,577
 tariochbctools/importers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tariochbctools/importers/awardwalletimp/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tariochbctools/importers/awardwalletimp/config.py,sha256=EPwvUE9WBdCk9xxleJ8qDLfPy8GwcgAtG1uGSShyt4w,2460
+tariochbctools/importers/awardwalletimp/importer.py,sha256=0G3DcxYP_chy1zUYMCijDOwNZBBBdX8hR2sPKiVHZS8,5071
 tariochbctools/importers/bcge/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tariochbctools/importers/bcge/importer.py,sha256=bAQpkBLURatdsfSoMQdiha-8QfExAXXvpzAgnFFMwoE,1176
 tariochbctools/importers/bitst/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -21,7 +24,7 @@ tariochbctools/importers/netbenefits/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeu
 tariochbctools/importers/netbenefits/importer.py,sha256=nzjz12uzi8ozYaOFW5S8U1LPToxk8C0jESL8X6Ex6CY,5904
 tariochbctools/importers/nordigen/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tariochbctools/importers/nordigen/importer.py,sha256=lNAcuv-iDQfb82xVRi7--ApvCLCBLDGJLXX7awhDdvw,3953
-tariochbctools/importers/nordigen/nordigen_config.py,sha256=cbv7DkGrQ6SzX0L1m25nHi3UH9Oi9tgQGkRmjoZ1QXk,5122
+tariochbctools/importers/nordigen/nordigen_config.py,sha256=GHSdyBpjbAscn-Kob0n4Xrp2L0yjc7vExshwt7O60hM,6468
 tariochbctools/importers/postfinance/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tariochbctools/importers/postfinance/importer.py,sha256=PLBbnswb_tHt8wzd7yCC4UAWHoPn3WcJIXaOMewz6fc,2524
 tariochbctools/importers/quickfile/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -50,9 +53,9 @@ tariochbctools/plugins/check_portfolio_sum.py,sha256=naJ2j6BFpQhJhT2c-gfjyIdcYe0
 tariochbctools/plugins/generate_base_ccy_prices.py,sha256=4CDzUosjMWCZfsBJMLrf-i5WNCHexI2rdm5vIDYW-AI,1314
 tariochbctools/plugins/prices/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tariochbctools/plugins/prices/ibkr.py,sha256=GYCjnlF-MK-ZFPEr0M6T4iO3Etq0tMmrMlsHGInXUO8,1405
-tariochbctools-1.2.4.dist-info/licenses/LICENSE.txt,sha256=VR2hkz3p9Sw4hSXc7S5iZTOXGeV4h-i8AO_q0zEmtkE,1074
-tariochbctools-1.2.4.dist-info/METADATA,sha256=87Qb4bqnikac4es0cW1cl91eLfRt-8_4pSMKW-bKnOU,2190
-tariochbctools-1.2.4.dist-info/WHEEL,sha256=JNWh1Fm1UdwIQV075glCn4MVuCRs0sotJIq-J6rbxCU,109
-tariochbctools-1.2.4.dist-info/entry_points.txt,sha256=9xrCCY1wx2zCIsQUOWZelLHDmHw9Oc-ZBAKUIY9lKTA,88
-tariochbctools-1.2.4.dist-info/top_level.txt,sha256=CiA_NepCI6zDNsaORA55zmpuJFSnTvLESraIL13xiOQ,15
-tariochbctools-1.2.4.dist-info/RECORD,,
+tariochbctools-1.4.0.dist-info/licenses/LICENSE.txt,sha256=VR2hkz3p9Sw4hSXc7S5iZTOXGeV4h-i8AO_q0zEmtkE,1074
+tariochbctools-1.4.0.dist-info/METADATA,sha256=Jh3Yufmm8ZjEP4mVNVJR8MIIjNTf09VVKfqSaiAvw6s,2217
+tariochbctools-1.4.0.dist-info/WHEEL,sha256=JNWh1Fm1UdwIQV075glCn4MVuCRs0sotJIq-J6rbxCU,109
+tariochbctools-1.4.0.dist-info/entry_points.txt,sha256=bo7wO1u-PIDHNuqsTEekC56VCAmn2i2vTRcKXxqc770,158
+tariochbctools-1.4.0.dist-info/top_level.txt,sha256=CiA_NepCI6zDNsaORA55zmpuJFSnTvLESraIL13xiOQ,15
+tariochbctools-1.4.0.dist-info/RECORD,,

{tariochbctools-1.2.4.dist-info → tariochbctools-1.4.0.dist-info}/entry_points.txt

@@ -1,2 +1,3 @@
 [console_scripts]
+awardwallet-conf = tariochbctools.importers.awardwalletimp.config:run
 nordigen-conf = tariochbctools.importers.nordigen.nordigen_config:run