td_statement_extractor 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ae91581fa2bd86441e5fd80c0f78682e56c175f0e559d8fe929877900286b2ab
+  data.tar.gz: 663efa58cf0702bcdb29f8e67352057e771b12c5c2cdb64aa27293254a550e00
+SHA512:
+  metadata.gz: 5ce5c27bbbeee4d217b1b543352f5cf71fb145e31cb74301a4e226469cccfab88f964819b4219ce90fb2da63b560c7ea0ef998a5984e4679fdba2e61f2c3b121
+  data.tar.gz: 693a6261ecfa83aa755f345a4c251c49b904c6ceca9dcccd38ac9f23b5240be4a6e1d0769d4d8b511d53f665ae1f8006c44ddfaf7763ae94532d53803d796ff5

data/.github/workflows/ruby.yml

@@ -0,0 +1,46 @@
+name: build
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Install Ruby (3.1.x)
+      uses: ruby/setup-ruby@v1
+
+    - name: Install Ghostscript
+      run: sudo apt-get install ghostscript gsfonts
+
+    - name: Setup Code Climate test-reporter
+      run: |
+        curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+        chmod +x ./cc-test-reporter
+        ./cc-test-reporter before-build
+    - name: Build and test with RSpec
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec rspec
+    - name: Publish code coverage
+      run: |
+        export GIT_BRANCH="${GITHUB_REF/refs\/heads\//}"
+        ./cc-test-reporter after-build -r ${{secrets.CC_TEST_REPORTER_ID}}
+
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Install Ruby (3.1.x)
+      uses: ruby/setup-ruby@v1
+
+    - name: Lint with StandardRB
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec standardrb --no-fix

data/.gitignore

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

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+3.1

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 td_statement_extractor.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,85 @@
+PATH
+  remote: .
+  specs:
+    td_statement_extractor (0.1.1)
+      pdf-reader (~> 2.4.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    Ascii85 (1.1.0)
+    afm (0.2.2)
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    hashery (2.1.2)
+    json (2.6.3)
+    language_server-protocol (3.17.0.2)
+    parallel (1.22.1)
+    parser (3.2.0.0)
+      ast (~> 2.4.1)
+    pdf-reader (2.4.2)
+      Ascii85 (~> 1.0)
+      afm (~> 0.2.1)
+      hashery (~> 2.0)
+      ruby-rc4
+      ttfunk
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.2)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.42.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.24.1)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.15.2)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    ruby-rc4 (0.1.5)
+    simplecov (0.17.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    standard (1.22.1)
+      language_server-protocol (~> 3.17.0.2)
+      rubocop (= 1.42.0)
+      rubocop-performance (= 1.15.2)
+    ttfunk (1.7.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  bundler
+  rake (>= 12.3.3)
+  rspec (~> 3.0)
+  simplecov (~> 0.17.1)
+  standard
+  td_statement_extractor!
+
+BUNDLED WITH
+   2.4.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Aaron Gough
+
+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,32 @@
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
+[![build](https://github.com/aarongough/td_statement_extractor/actions/workflows/ruby.yml/badge.svg)](https://github.com/aarongough/td_statement_extractor/actions/workflows/ruby.yml)
+[![Maintainability](https://api.codeclimate.com/v1/badges/8a22ae11816d0eebfd85/maintainability)](https://codeclimate.com/github/aarongough/td_statement_extractor/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/8a22ae11816d0eebfd85/test_coverage)](https://codeclimate.com/github/aarongough/td_statement_extractor/test_coverage)
+
+# TD Statement Extractor
+
+Extract machine readable transaction data from TD credit card statements. Useful for importing data quickly into a bookkeeping or accounting system!
+
+## Installation
+
+Install from the command line:
+
+    $ gem install td_statement_extractor
+
+## Usage
+
+    td_statement_extractor INPUT_FILE OUTPUT_FILE
+
+## 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/aarongough/td_statement_extractor.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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 "td_statement_extractor"
+
+# 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/bin/td_statement_extractor

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+require "rubygems"
+require "bundler/setup"
+require "td_statement_extractor"
+
+raise "Input file path cannot be blank" if ARGV[0].nil?
+raise "Output file path cannot be blank" if ARGV[1].nil?
+
+input_file_path = File.expand_path(ARGV[0])
+output_file_path = File.expand_path(ARGV[1])
+
+raise "Input file does not exist" unless File.exist?(input_file_path)
+
+statement = TdStatementExtractor::Statement.new(input_file_path)
+statement.output_csv(output_file_path)
+
+puts
+puts "Processed file: #{input_file_path}"
+puts "CSV written to: #{output_file_path}"
+puts "Details:"
+puts "  Transactions: #{statement.transactions.count}"
+puts "  Total activity: #{("$" + statement.total_activity.to_s).gsub("$-", "-$")}"
+puts

data/lib/td_statement_extractor/statement.rb

@@ -0,0 +1,123 @@
+require "pdf-reader"
+require "date"
+require "csv"
+
+module TdStatementExtractor
+  class Statement
+    STATEMENT_DATE = /(?<statement_date>(?<month>[A-Z][a-z]+)\s(?<day>[0-9]+),\s(?<year>[0-9]{4}))/
+    MONTH = /(?<month>JAN|FEB|MAR|APR|MAY|JUN|JUL|AUG|SEP|OCT|NOV|DEC)/
+    DAY = /(?<day>[0-9]+)/
+    DATE = /(?<date>#{MONTH}\s#{DAY})/
+    AMOUNT = /(?<amount>-?\$[,\d]+\.\d+)/
+    DESCRIPTION = /#{DATE}\s+#{DATE}?\s+(?<description>.+)\s+#{AMOUNT}/
+
+    attr_accessor :input_file_path, :temp_file_path, :debug_mode, :transactions, :statement_date, :pdf, :text
+
+    def initialize(input_file_path, debug_mode = false)
+      @input_file_path = input_file_path
+      @debug_mode = debug_mode
+
+      self.class.check_for_ghostscript
+
+      pre_process_pdf
+      import_pdf
+      extract_statement_date
+
+      @transactions = text.each_line.map do |line|
+        puts "#{transaction_line?(line) ? "T" : "F"} - #{line.lstrip.strip}" if @debug_mode && line.match?(/\w+/)
+        next unless transaction_line?(line)
+        data = transaction_from_line(line)
+        data[:date] = transform_date(data[:date], statement_date)
+
+        data
+      end.compact
+    ensure
+      File.delete(temp_file_path) unless temp_file_path.nil?
+    end
+
+    def pre_process_pdf
+      @temp_file_path = File.join(File.dirname(@input_file_path), "td_statement_temp_#{Time.now.to_i}.pdf")
+
+      # Use Ghostscript to decrypt and decompress the PDF. Also remove
+      # all images and crop the margins to remove watermarking that interferes
+      # with the scraping process
+      `gs -o #{@temp_file_path} -sDEVICE=pdfwrite -dFILTERVECTOR -dFILTERIMAGE -g5400x7200 -c "<</PageOffset [-36 -36]>> setpagedevice" -f #{@input_file_path} 2>&1`
+    end
+
+    def import_pdf
+      @pdf = PDF::Reader.new(temp_file_path)
+      @text = pdf.pages.map { |page| page.text }.join
+    end
+
+    def extract_statement_date
+      @statement_date = text.match(STATEMENT_DATE)&.[](:statement_date)
+      raise InvalidStatementDateError, "Unable to extract statement date" if statement_date.nil? || statement_date.empty?
+    end
+
+    def transaction_line?(line)
+      line.match?(DATE) && line.match?(AMOUNT)
+    end
+
+    def transaction_from_line(line)
+      date = line.match(DATE)&.[](:date)
+      amount = -(line.match(AMOUNT)&.[](:amount)&.gsub("$", "")&.gsub(",", "")&.to_f || 0)
+      description = line.match(DESCRIPTION)&.[](:description)&.strip
+
+      raise MissingDateError, "Error extracting DATE from line: #{line}" if date.nil? || date.empty?
+      raise MissingAmountError, "Error extracting AMOUNT from line: #{line}" if amount.nil? || amount.zero?
+      raise MissingDescriptionError, "Error extracting DESCRIPTION from line: #{line}" if description.nil? || description.empty?
+
+      {date: date, description: description, amount: amount}
+    end
+
+    def transform_date(date, statement_date)
+      month = date.match(MONTH)&.[](:month)
+      day = date.match(DAY)&.[](:day)&.to_i
+      statement_month = statement_date.match(STATEMENT_DATE)&.[](:month)
+      statement_year = statement_date.match(STATEMENT_DATE)&.[](:year)&.to_i
+
+      raise InvalidMonthError, "Error extracting MONTH from date: #{date}" if month.nil? || month.empty?
+      raise InvalidDayError, "Error extracting DAY from date: #{date}" if day.zero? || day > 31
+      raise InvalidStatementDateError, "Error extracting MONTH from statement date: #{statement_date}" if statement_month.nil? || statement_month.empty?
+      raise InvalidStatementDateError, "Error extracting YEAR from statement date: #{statement_date}" if statement_year.nil? || statement_year.zero? || statement_year < 1980 || statement_year > 3000
+
+      year = if statement_month == "January" && month == "DEC"
+        statement_year - 1
+      else
+        statement_year
+      end
+
+      Date.parse("#{month} #{day} #{year}")
+    end
+
+    def total_activity
+      -transactions.reduce(0) { |total, x| total + x[:amount] }.round(2)
+    end
+
+    def output_csv(output_path)
+      CSV.open(output_path, "a") do |csv|
+        transactions.each do |transaction|
+          csv << [transaction[:date].strftime("%d/%m/%Y"), transaction[:description], transaction[:amount]]
+        end
+      end
+    end
+
+    def self.check_for_ghostscript
+      raise GhostscriptNotInstalledError, "Please install Ghostscript. See docs for more info." if `which gs`.empty?
+    end
+
+    class MissingDateError < StandardError; end
+
+    class MissingAmountError < StandardError; end
+
+    class MissingDescriptionError < StandardError; end
+
+    class InvalidMonthError < StandardError; end
+
+    class InvalidDayError < StandardError; end
+
+    class InvalidStatementDateError < StandardError; end
+
+    class GhostscriptNotInstalledError < StandardError; end
+  end
+end

data/lib/td_statement_extractor/version.rb

@@ -0,0 +1,3 @@
+module TdStatementExtractor
+  VERSION = "0.1.1"
+end

data/lib/td_statement_extractor.rb

@@ -0,0 +1,5 @@
+require "td_statement_extractor/version"
+require "td_statement_extractor/statement"
+
+module TdStatementExtractor
+end

data/td_statement_extractor.gemspec

@@ -0,0 +1,35 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "td_statement_extractor/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "td_statement_extractor"
+  spec.version = TdStatementExtractor::VERSION
+  spec.authors = ["Aaron Gough"]
+  spec.email = ["aaron.gough@gmail.com"]
+
+  spec.summary = "Extract machine readable transaction data from TD credit card statements."
+  spec.description = "Extract machine readable transaction data from TD credit card statements."
+  spec.homepage = "https://github.com/aarongough/td_statement_extractor"
+  spec.license = "MIT"
+
+  spec.required_ruby_version = ">= #{File.read(".ruby-version").strip}"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.bindir = "bin"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "pdf-reader", "~> 2.4.0"
+
+  spec.add_development_dependency "standard"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", ">= 12.3.3"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "simplecov", "~> 0.17.1"
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: td_statement_extractor
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Aaron Gough
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-01-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pdf-reader
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+description: Extract machine readable transaction data from TD credit card statements.
+email:
+- aaron.gough@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/td_statement_extractor
+- lib/td_statement_extractor.rb
+- lib/td_statement_extractor/statement.rb
+- lib/td_statement_extractor/version.rb
+- td_statement_extractor.gemspec
+homepage: https://github.com/aarongough/td_statement_extractor
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Extract machine readable transaction data from TD credit card statements.
+test_files: []