ynap 1.0.0

data/lib/ynap/extensions/float.rb

@@ -0,0 +1,5 @@
+class Float
+  def to_ynab
+    (BigDecimal(self.to_s) * 1000).to_i
+  end
+end

data/lib/ynap/extensions/integer.rb

@@ -0,0 +1,5 @@
+class Integer
+  def to_plaid
+    self.to_f / 1000
+  end
+end

data/lib/ynap/extensions/plaid/models/transaction.rb

@@ -0,0 +1,8 @@
+require "plaid"
+
+class Plaid::Models::Transaction
+  # Includes a negative amount for easier comparison with YNAB transactions
+  def description
+    [date, "#{(-amount).to_s.rjust(12)} #{iso_currency_code}", name].join(" - ")
+  end
+end

data/lib/ynap/extensions/ynab/save_transaction.rb

@@ -0,0 +1,8 @@
+require "ynab"
+
+class YNAB::SaveTransaction
+  # Includes a decimal amount for easier comparison with Plaid transactions
+  def description
+    [date, amount.to_plaid.to_s.rjust(12), payee_name, memo].join(" - ")
+  end
+end

data/lib/ynap/extensions/ynab/transaction_detail.rb

@@ -0,0 +1,8 @@
+require "ynab"
+
+class YNAB::TransactionDetail
+  # Includes a decimal amount for easier comparison with Plaid transactions
+  def description
+    [date, amount.to_plaid.to_s.rjust(12), payee_name, memo].join(" - ")
+  end
+end

data/lib/ynap/models/account.rb

@@ -0,0 +1,62 @@
+require 'date'
+require 'ynap/models/bridge_record.rb'
+
+class Account < BridgeRecord
+  TRANSACTIONS_HORIZON = 30
+
+  attr_reader :plaid_id, :start_date, :ynab_id
+
+  def initialize(plaid_id:, plaid_access_token:, ynab_id:, start_date: nil)
+    super(plaid_access_token)
+    @plaid_id     = plaid_id
+    @ynab_id      = ynab_id
+    @start_date   = Date.parse(start_date) unless start_date.nil?
+    @to_date = Date.today
+    @from_date = @start_date || (@to_date - TRANSACTIONS_HORIZON)
+  end
+
+  def description
+    reconciled = reconciled? ? "✅" : "❌"
+    "#{ynab_account.name}: #{plaid_balance} P#{reconciled}Y #{ynab_balance.to_plaid} #{plaid_account.balances.iso_currency_code}"
+  end
+
+  def balances
+    { plaid: plaid_balance, ynab: ynab_balance.to_plaid }
+  end
+
+  def reconciled?
+    plaid_balance.to_ynab == ynab_balance
+  end
+
+  # Plaid
+
+  def plaid_accounts
+    @plaid_accounts ||= plaid_client.accounts.balance.get(plaid_access_token).accounts
+  end
+
+  def plaid_account
+    @plaid_account ||= plaid_accounts.find { |account| account.account_id == plaid_id }
+  end
+
+  def plaid_balance
+    @plaid_balance ||= plaid_account.balances.available
+  end
+
+  def plaid_transactions
+    @plaid_transactions ||= plaid_client.transactions.get(plaid_access_token, @from_date, @to_date, account_ids: [plaid_id]).transactions
+  end
+
+  # YNAB
+
+  def ynab_account
+    @ynab_account ||= ynab_client.accounts.get_account_by_id(Ynap.config.dig(:ynab, :budget_id), ynab_id).data.account
+  end
+
+  def ynab_balance
+    @ynab_balance ||= ynab_account.balance
+  end
+
+  def ynab_transactions
+    @ynab_transactions ||= ynab_client.transactions.get_transactions_by_account(Ynap.config.dig(:ynab, :budget_id), ynab_id, since_date: @from_date).data.transactions.reverse
+  end
+end

data/lib/ynap/models/bank.rb

@@ -0,0 +1,145 @@
+require 'plaid'
+require 'yaml'
+require 'ynap/extensions/float.rb'
+require 'ynap/models/account.rb'
+require 'ynap/models/bridge_record.rb'
+
+class Bank < BridgeRecord
+  attr_reader :id, :name, :plaid_access_token, :accounts, :result
+  attr_accessor :transactions_horizon
+
+  def initialize(id:, name:, plaid_access_token:, accounts: [])
+    super(plaid_access_token)
+    @id                   = id
+    @name                 = name
+    @plaid_access_token   = plaid_access_token
+    @accounts             = accounts.map { |params| Account.new params.merge(plaid_access_token: plaid_access_token) }
+    @transactions_horizon = Account::TRANSACTIONS_HORIZON
+  end
+
+  def self.find(id)
+    new Ynap.bank_config(id)
+  end
+
+  def self.all
+    Ynap.config[:banks].map do |params|
+      new params
+    end
+  end
+
+  def self.accounts_descriptions
+    all.map(&:accounts_descriptions).flatten.join("\n")
+  end
+
+  def self.payees(with_memos: false)
+    with_memos ? payees_memos : all.map(&:payees).flatten.uniq
+  end
+
+  def self.payees_memos
+    all.map(&:payees_memos).flatten.uniq
+  end
+
+  #
+  # Plaidist
+  #
+
+  # Accounts
+
+  def all_plaid_accounts
+    @all_plaid_accounts ||= plaid_client.accounts.get(plaid_access_token).accounts
+  end
+
+  def all_plaid_ids
+    all_plaid_accounts.map { |account| { name: account.name, official_name: account.official_name, plaid_id: account.account_id } }
+  end
+
+  def accounts_descriptions
+    accounts.map(&:description)
+  end
+
+  def account(plaid_id:)
+    accounts.find { |account| account.plaid_id == plaid_id }
+  end
+
+  # Transactions
+
+  def fetch_plaid_transactions(from_date: nil, to_date: Date.today)
+    start_date = from_date || (to_date - @transactions_horizon)
+    plaid_client.transactions.get(plaid_access_token, start_date, to_date).transactions
+  end
+
+  def plaid_transactions
+    @plaid_transactions ||= fetch_plaid_transactions(from_date: nil, to_date: Date.today)
+  end
+
+  # Since we fetch all plaid transactions at once and accounts have various
+  # started_date, we need to filter line by line
+  def importable_plaid_transactions
+    @importable_plaid_transactions ||= plaid_transactions.filter do |transaction|
+      account = account(plaid_id: transaction.account_id)
+      account.start_date.nil? || Date.parse(transaction.date) >= account.start_date
+    end
+  end
+
+  def refresh_plaid_transactions!
+    plaid_client.transactions.refresh(plaid_access_token)
+  end
+
+  #
+  # YNABist
+  #
+
+  def ynab_transactions
+    @ynab_transactions ||= importable_plaid_transactions.map do |plaid_transaction|
+      account = account(plaid_id: plaid_transaction.account_id)
+      converter = ParamsConverter.new account, plaid_transaction
+      YNAB::SaveTransaction.new(converter.to_params)
+    end
+  end
+
+  def wrapped_ynab_transactions
+    YNAB::SaveTransactionsWrapper.new(transactions: ynab_transactions)
+  end
+
+  #
+  # Transactions Queries
+  #
+
+  def transactions_for(ynab_id)
+    ynab_transactions.select { |transaction| transaction.account_id == ynab_id }
+  end
+
+  def transactions_total(account)
+    transactions_for(account.ynab_id).sum(&:amount)
+  end
+
+  def payees
+    ynab_transactions.map(&:payee_name).uniq.sort
+  end
+
+  def payees_memos
+    ynab_transactions.map { |t| [t.payee_name, t.memo].join(" <~> ") }.uniq.sort
+  end
+
+  #
+  # Balances
+  #
+
+  def reconciliate_account(account)
+    account.ynab_balance + transactions_total(account) == account.plaid_balance.to_ynab
+  end
+
+  def reconciled?
+    @bank.accounts.inject(true) { |reconciled, account| reconciled && reconciliate_account(account) }
+  end
+
+  #
+  # Import
+  #
+
+  def import
+    @result = ynab_client.transactions.create_transactions(Ynap.config.dig(:ynab, :budget_id), wrapped_ynab_transactions).tap do |result|
+      puts "#{name} - New: #{result.data.transaction_ids.size}, Known: #{result.data.duplicate_import_ids.size}\n"
+    end
+  end
+end

data/lib/ynap/models/bridge_record.rb

@@ -0,0 +1,9 @@
+class BridgeRecord
+  attr_accessor :plaid_client, :plaid_access_token, :ynab_client
+
+  def initialize(plaid_access_token)
+    @plaid_access_token = plaid_access_token
+    @plaid_client = Plaid::Client.new Ynap.config[:plaid].slice(:env, :client_id, :secret)
+    @ynab_client  = YNAB::API.new Ynap.config.dig(:ynab, :token)
+  end
+end

data/lib/ynap/payee_parser.rb

@@ -0,0 +1,12 @@
+class PayeeParser
+  attr_reader :regex
+
+  def initialize(regex = nil)
+    @regex = regex || Ynap.regexp
+  end
+
+  def cleaned_name(label)
+    matched = label.match(@regex)
+    matched.nil? ? label : matched[:name].strip
+  end
+end

data/lib/ynap/values/params_converter.rb

@@ -0,0 +1,52 @@
+class ParamsConverter
+  IMPORT_ID_PREFIX = "GW"
+  IMPORT_ID_FIXED_SIZE = IMPORT_ID_PREFIX.length + 10 + 3
+  MAX_IMPORT_ID_SIZE = 36
+
+  attr_reader :account, :plaid_transaction
+
+  def initialize(account, plaid_transaction)
+    @account           = account
+    @plaid_transaction = plaid_transaction
+  end
+
+  def amount
+    @amount ||= -(BigDecimal(plaid_transaction.amount.to_s) * 100).to_i
+  end
+
+  def date
+    @date ||= Date.parse(plaid_transaction.date)
+  end
+
+  def transaction_id
+    @transaction_id ||= plaid_transaction.pending_transaction_id || plaid_transaction.transaction_id
+  end
+
+  def transaction_id_length
+    @transaction_id_length ||= MAX_IMPORT_ID_SIZE - IMPORT_ID_FIXED_SIZE - amount.to_s.size
+  end
+
+  def sliced_transaction_id
+    @sliced_transaction_id ||= transaction_id[0, transaction_id_length]
+  end
+
+  def import_id
+    [IMPORT_ID_PREFIX, amount, date, sliced_transaction_id].join(":")
+  end
+
+  def payee_name
+    @payee_name ||= plaid_transaction.merchant_name || PayeeParser.new.cleaned_name(plaid_transaction.name)[0, 50]
+  end
+
+  def to_params
+    {
+      account_id: account.ynab_id,
+      amount: amount * 10,
+      cleared: 'cleared',
+      date: date,
+      import_id: import_id,
+      memo: plaid_transaction.name,
+      payee_name: payee_name
+    }
+  end
+end

data/lib/ynap/version.rb

@@ -0,0 +1,3 @@
+module Ynap
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,197 @@
+--- !ruby/object:Gem::Specification
+name: ynap
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Arnaud Joubay
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-11-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: plaid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: ynab
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: YNAP allows you to automatically import into YNAB the transactions of
+  any bank supported by Plaid.
+email: 
+executables:
+- ynap
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- bin/console
+- bin/plaid
+- bin/setup
+- bin/ynap
+- config/ynap.yml.example
+- exe/ynap
+- html/index.html
+- html/oauth-response.html
+- lib/ynap.rb
+- lib/ynap/cli.rb
+- lib/ynap/extensions/float.rb
+- lib/ynap/extensions/integer.rb
+- lib/ynap/extensions/plaid/models/transaction.rb
+- lib/ynap/extensions/ynab/save_transaction.rb
+- lib/ynap/extensions/ynab/transaction_detail.rb
+- lib/ynap/models/account.rb
+- lib/ynap/models/bank.rb
+- lib/ynap/models/bridge_record.rb
+- lib/ynap/payee_parser.rb
+- lib/ynap/values/params_converter.rb
+- lib/ynap/version.rb
+homepage: https://github.com/sowenjub/ynap
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/sowenjub/ynap
+  source_code_uri: https://github.com/sowenjub/ynap
+  changelog_uri: https://github.com/sowenjub/ynap/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: You Need A Plaid
+test_files: []