Service that parses bank emails with transactions and submits pending transactions to ledger

Building dev docker image:

docker build -f dev/Dockerfile . -t ledger.email-handler

Running misc commands:

docker run -v `pwd`:/project --rm -it ledger.email-handler rspec spec

docker run -v `pwd`:/project --rm -it ledger.email-handler guard

Or just generic bash:

docker run -v `pwd`:/project --rm -it ledger.email-handler bash

• GOAUTH_CLIENT_ID - client if of the offline app that will be used to get id_token of the user. This must be added to JWT_AUD_WHITELIST of ledger
• GOOGLE_CLIENT_SECRET - corresponding secret

For local testing purposes config/settings.local.yml can be created and values above can be placed there. See config structure here: config/settings.yml.

Note: You may need to set RUBY_ENV=staging|production first.

Generate url to get access code

rake get-auth-code-url

Then open the URL in the browser, authorize with your google account (which must be registered ledger user) and copy provided access code.

Then invoke following task with the code from step above. This will get and add access/id tokens for your user so it will be able to call ledger api:

rake add-token[PASTE YOUR TOKEN HERE]

While parsing your email the parser needs to know ledger account that corresponds to your bank account. Follow steps below to configure such mapping for each user.

First see ids of each ledger account for given user:

rake show-ledger-accounts[[email protected]]

Then for each bank account add mapping to ledger account. Bank account is the one that will be in the email

rake add-account-mapping[[email protected],1111,3d2e57ac-0418-41aa-ad63-4ef08063915f]

Email provider config to get emails from needs to be configured. It can be done with a following command:

rake add-email-config[ledger-user,BIC,'{"pop3":{"address":"pop.gmail.com"\,"port"
:995\,"account":"[email protected]"\,"password":"password"}}']

Where:

• ledger-user - user email of ledger user
• BIC - BIC of the bank
• settings: provider specific JSON settings. At this point pop3 only is supported.

{
    "pop3": {
      "address": "pop.gmail.com",
      "port":: 995, #Pop3 port. Default 995
      "requires_ssl": true, # Optional, default true
      "account": "[email protected]",
      "password": "password",
      "autoremove": false # Optional, default false. Note: set to true if your provider will fetch again previously fetched.
    }
}

To invoke worker that will use provider to fetch emails then parse them and submit and submit to ledger as pending transactions:

rake handle-emails

You can schedule this command with cron to have this done on a schedule.

rubocop && rspec spec

Mailtrap can be used as a mail provider. Use rake test:send-to-mailtrap[user,password,path] to send to mailtrap.

Test if provider settings are valid: rake test:pop3-fetch[user-email,BIC]

Invoke particular parser for given raw mail: rake test:invoke-parser[BIC,message_path]