ledger_tiller_export 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 307135e8c2caf98e4b2958efc90c4acfa8944ecd
+  data.tar.gz: 0ad4cbab8a0bc01f6174887393b897c830be8276
+SHA512:
+  metadata.gz: 5694e282fa1fa7a298d34fbfb2ef8a7bd635c5a2ac2b22121fefd758ab2ec16ae81a5246be8a4032673eaae9ed599a2ba0d554d3ff6ecc0a9b722260ad1100e5
+  data.tar.gz: 52e45c2a10d3f04de595f2533d414b9373d57643aa23d5dd31beae75d6323dfc0b3699e2f28a8a50e5bc04d2d8e6e060a8f096d133eaaac44df8938abdf3ee1f

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at pete@petekeen.net. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in ledger_tiller_export.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,91 @@
+PATH
+  remote: .
+  specs:
+    ledger_tiller_export (0.1.0)
+      google_drive
+      ledger_gen
+      sorbet-runtime
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    declarative (0.0.10)
+    declarative-option (0.1.0)
+    diff-lcs (1.3)
+    faraday (1.0.1)
+      multipart-post (>= 1.2, < 3)
+    google-api-client (0.36.4)
+      addressable (~> 2.5, >= 2.5.1)
+      googleauth (~> 0.9)
+      httpclient (>= 2.8.1, < 3.0)
+      mini_mime (~> 1.0)
+      representable (~> 3.0)
+      retriable (>= 2.0, < 4.0)
+      signet (~> 0.12)
+    google_drive (3.0.4)
+      google-api-client (>= 0.11.0, < 0.37.0)
+      googleauth (>= 0.5.0, < 1.0.0)
+      nokogiri (>= 1.5.3, < 2.0.0)
+    googleauth (0.12.0)
+      faraday (>= 0.17.3, < 2.0)
+      jwt (>= 1.4, < 3.0)
+      memoist (~> 0.16)
+      multi_json (~> 1.11)
+      os (>= 0.9, < 2.0)
+      signet (~> 0.14)
+    httpclient (2.8.3)
+    jwt (2.2.1)
+    ledger_gen (0.2.0)
+    memoist (0.16.2)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    multi_json (1.14.1)
+    multipart-post (2.1.1)
+    nokogiri (1.10.9)
+      mini_portile2 (~> 2.4.0)
+    os (1.1.0)
+    public_suffix (4.0.5)
+    rake (13.0.1)
+    representable (3.0.4)
+      declarative (< 0.1.0)
+      declarative-option (< 0.2.0)
+      uber (< 0.2.0)
+    retriable (3.1.2)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    signet (0.14.0)
+      addressable (~> 2.3)
+      faraday (>= 0.17.3, < 2.0)
+      jwt (>= 1.5, < 3.0)
+      multi_json (~> 1.10)
+    sorbet (0.5.5648)
+      sorbet-static (= 0.5.5648)
+    sorbet-runtime (0.5.5648)
+    sorbet-static (0.5.5648-universal-darwin-14)
+    uber (0.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  ledger_tiller_export!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  sorbet
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Pete Keen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,162 @@
+# LedgerTillerExport
+
+`LedgerTillerExport` is a tool to help export transactions from [Tiller](https://www.tillerhq/) into [Ledger](https://www.ledger-cli.org).
+It reads the Google spreadsheet that Tiller maintains and follows rules that you define to create Ledger transactions.
+It will read your Ledger file to dedupe transactions using Tiller's guids.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ledger_tiller_export'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ledger_tiller_export
+
+## Usage
+
+Here's a simple example script:
+
+```ruby
+require 'ledger_tiller_export'
+
+RULES = [
+  LedgerTillerExport::RegexpRule.new(match: 'McDonalds', account: 'Expenses:Food'),
+  LedgerTillerExport::RegexpRule.new(match: 'DTE', account: 'Expenses:Utils:Energy'),
+]
+
+if __FILE__ == $PROGRAM_NAME
+  LedgerTillerExport::Exporter.new(
+    rules: RULES,
+    spreadsheet: 'YourGoogleSheetId',
+  ).run
+end
+```
+
+If you already have existing Ledger transactions you may want to pick a start date and only export transactions that happen after that date.
+You can subclass `LedgerTillerExport::Exporter` and override the `skip_row?` method:
+
+```ruby
+class MyTillerExporter < LedgerTillerExport::Exporter
+  def skip_row?(row)
+    return true if row.txn_date < Date.new(2020, 5, 1)
+
+    super
+  end
+end
+```
+
+`LedgerTillerExport` comes with one rule type, `RegexpRule`, which simply matches on the payee of each transaction and returns the given account.
+You can define your own rule types if you want to implement more interesting behavior. For example, I track checks that I've written using transactions like this:
+
+```
+2020/05/05 * Lawn Guy
+    Expenses:Lawn                      $35.00
+    Liabilities:Checks:SomeBank:1025
+```
+
+When the check gets cashed I write another transaction like this:
+
+```
+2020/05/10 * Check paid
+    Liabilities:Checks:SomeBank:1025   $35.00
+    Assets:SomeBank::Checking
+```
+
+To automatically reconcile these I have a rule in my exporter script that looks like this:
+
+```ruby
+require 'sorbet-runtime'
+
+class CheckingAccountRule
+  extend T::Sig
+
+  include LedgerTillerExport::RuleInterface
+
+  class CheckingAccount < T::Struct
+    const :account, String
+    const :check_account_prefix, String
+  end
+
+  class Check < T::Struct
+    const :amount, Float
+    const :check, String
+  end
+  
+  CHECKING_ACCOUNTS = T.let([
+    CheckingAccount.new(account: 'Assets:SomeBank:Checking', check_account_prefix: 'Liabilities:Checks:SomeBank),
+    CheckingAccount.new(account: 'Assets:OtherBank:Checking', check_account_prefix: 'Liabilities:Checks:OtherBank'),
+  ], T::Array[CheckingAccount])
+
+  sig {void}
+  def initialize
+    @outstanding_checks = fetch_outstanding_checks
+  end
+
+  sig {override.params(row: LedgerTillerExport::Row).returns(T.nilable(String))}
+  def account_for_row(row)
+    if row.description =~ /Check|Bill pay/i
+      @outstanding_checks.each do |check|
+        if row.amount.to_f.round(2) == check.amount.round(2)
+          CHECKING_ACCOUNTS.each do |acct|
+            if acct.account == row.account && check.check.start_with?(acct.check_account_prefix)
+              return check.check
+            end
+          end
+        end
+      end
+    end
+  end
+
+  # fetch all of the outstanding checks using a Ledger balance query with a custom format
+  sig {returns(T::Array[Check])}
+  def fetch_outstanding_checks
+    cmd = [
+      'ledger',
+      %q{--balance-format=%(quantity(scrub(display_total))),%(account)\n},
+      'bal',
+      'checks',
+    ]
+
+    raw_checks, _, _ = Open3.capture3(*cmd)
+
+    raw_checks.strip.split(/\n/).map do |raw|
+      row = raw.split(/,/, 2)
+      Check.new(amount: T.must(row.first).to_f, check: T.must(row.last))
+    end
+  end
+end
+```
+
+The only required method is `account_for_row`, which either returns a `String` account name or `nil` if the rule didn't match.
+
+This example rule will read all of the outstanding checks from Ledger using a custom balance query.
+It then will match against a specific payee (`/Check|Bill pay/`) and scan across all of the outstanding checks.
+If it finds one, it outputs the check account.
+
+(Note that this uses [Sorbet](https://sorbet.org) but you don't have to do that if you don't want to.)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ledger_tiller_export. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the LedgerTillerExport project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/ledger_tiller_export/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ledger_tiller_export"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ledger_tiller_export.gemspec

@@ -0,0 +1,32 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ledger_tiller_export/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ledger_tiller_export"
+  spec.version       = LedgerTillerExport::VERSION
+  spec.authors       = ["Pete Keen"]
+  spec.email         = ["pete@petekeen.net"]
+
+  spec.summary       = %q{Generate ledger transactions from Tiller}
+  spec.description   = %q{Generate ledger transactions from Tiller}
+  spec.homepage      = "https://github.com/peterkeen/ledger_tiller_export"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "sorbet-runtime"
+  spec.add_dependency "ledger_gen"
+  spec.add_dependency "google_drive"
+
+  spec.add_development_dependency "sorbet"
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end