sync upstream repo

shayki5 · May 15, 2024 · 7821c96 · 7821c96
1 parent 3d9142b
commit 7821c96
Show file tree

Hide file tree

Showing 20 changed files with 4,959 additions and 111 deletions.
diff --git a/.github/workflows/scrape.yml b/.github/workflows/scrape.yml
@@ -83,6 +83,10 @@ jobs:
           -e YNAB_TOKEN
           -e YNAB_BUDGET_ID
           -e YNAB_ACCOUNTS
+          -e BUXFER_USER_NAME
+          -e BUXFER_PASSWORD
+          -e BUXFER_ACCOUNTS
+          -e TRANSACTION_HASH_TYPE
           ${{ env.REGISTRY }}/${{ steps.normalize-repository-name.outputs.repository }}:latest
         env:
           DEBUG: ""
@@ -107,6 +111,10 @@ jobs:
           YNAB_TOKEN: ${{ secrets.YNAB_TOKEN }}
           YNAB_BUDGET_ID: ${{ secrets.YNAB_BUDGET_ID }}
           YNAB_ACCOUNTS: ${{ secrets.YNAB_ACCOUNTS }}
+          BUXFER_USER_NAME: ${{ secrets.BUXFER_USER_NAME }}
+          BUXFER_PASSWORD: ${{ secrets.BUXFER_PASSWORD }}
+          BUXFER_ACCOUNTS: ${{ secrets.BUXFER_ACCOUNTS }}
+          TRANSACTION_HASH_TYPE: ${{ secrets.TRANSACTION_HASH_TYPE }}
 
       - name: Update categories
         run: |
@@ -125,4 +133,4 @@ jobs:
         uses: fjogeleit/http-request-action@v1
         with:
           url: "${{ secrets.UPDATE_WEB_HOOK }}"
-          method: "GET"
+          method: "GET"
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,5 +1,13 @@
 {
-  "cSpell.words": ["Kusto", "moneyman", "MULTIJSON", "nektos", "txns", "ynab"],
+  "cSpell.words": [
+    "Buxfer",
+    "Kusto",
+    "moneyman",
+    "MULTIJSON",
+    "nektos",
+    "txns",
+    "ynab"
+  ],
   "yaml.schemas": {
     "https://json.schemastore.org/github-workflow.json": "file:///workspaces/money/.github/workflows/build.yml"
   }

diff --git a/Dockerfile b/Dockerfile
@@ -1,7 +1,6 @@
 # ---- Base Node ----
 FROM node:18-alpine AS base
-
-RUN apk add --no-cache \
+RUN apk add --no-cache --no-check-certificate \
       chromium \
       nodejs yarn \
       nss ca-certificates \
@@ -42,4 +41,4 @@ COPY --from=builder /app/package.json .
 COPY --from=builder /app/dst ./dst
 COPY --from=builder /app/node_modules ./node_modules
 
-CMD ["npm", "run", "start"]
+CMD ["npm", "run", "start"]
diff --git a/README.md b/README.md
@@ -88,12 +88,14 @@ Example:
 
 #### Other configurations
 
-| env variable name    | default            | description                                                                                                  |
-| -------------------- | ------------------ | ------------------------------------------------------------------------------------------------------------ |
-| `ACCOUNTS_TO_SCRAPE` | `""`               | A comma separated list of providers to take from `ACCOUNTS_JSON`. if empty, all accounts will be used        |
-| `DAYS_BACK`          | `10`               | The amount of days back to scrape                                                                            |
-| `TZ`                 | `'Asia/Jerusalem'` | A timezone for the process - used for the formatting of the timestamp                                        |
-| `FUTURE_MONTHS`      | `1`                | The amount of months that will be scrapped in the future, starting from the day calculated using `DAYS_BACK` |
+| env variable name       | default            | description                                                                                                                                   |
+| ----------------------- | ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------- |
+| `ACCOUNTS_TO_SCRAPE`    | `""`               | A comma separated list of providers to take from `ACCOUNTS_JSON`. if empty, all accounts will be used                                         |
+| `DAYS_BACK`             | `10`               | The amount of days back to scrape                                                                                                             |
+| `TZ`                    | `'Asia/Jerusalem'` | A timezone for the process - used for the formatting of the timestamp                                                                         |
+| `FUTURE_MONTHS`         | `1`                | The amount of months that will be scrapped in the future, starting from the day calculated using `DAYS_BACK`                                  |
+| `TRANSACTION_HASH_TYPE` | ``                 | The hash type to use for the transaction hash. Can be `moneyman` or empty. The default will be changed to `moneyman` in the upcoming versions |
+| `HIDDEN_DEPRECATIONS`   | ''                 | A comma separated list of deprecations to hide                                                                                                |
 
 ### Get notified in telegram
 
@@ -206,3 +208,27 @@ Example:
   "5897": "ba2dd3a9-b7d4-46d6-8413-8327203e2b82"
 }
 ```
+
+### Export to [Buxfer](https://www.buxfer.com/features)
+
+To export your transactions directly to `Buxfer` you need to use the following environment variables to setup:
+| env variable name | description |
+| ------------------------------------ | ------------------------------------------------------------- |
+| `BUXFER_USER_NAME` | The `Buxfer` user name. Check [Buxfer settings](https://www.buxfer.com/settings?type=login) about how to obtain it |
+| `BUXFER_PASSWORD` | The `Buxfer` user password. Check [Buxfer settings](https://www.buxfer.com/settings?type=login) about how to obtain it |
+| `BUXFER_ACCOUNTS` | A key-value list to correlate each account with the `Buxfer` account `UUID` |
+
+#### BUXFER_ACCOUNTS
+
+A `JSON` key-value pair structure representing a mapping between two identifiers. The `key` represent the account ID as is understood by moneyman (as obtained from web scrapping the financial institutions) and the `value` it's the `UUID` visible in the Buxfer URL when an account is selected.
+
+For example, in the URL:
+`https://www.buxfer.com/account?id=123456` the account UUID is the account id query parameter.
+
+Example:
+
+```json
+{
+  "5897": "123456"
+}
+```