amazon_purchases_ledger 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d6f6be1f97de2fbd0aa0628bd485bb0212b3e1b5
+  data.tar.gz: 2a232cab20c11bbc73451cc70db4ccf96d2175c9
+SHA512:
+  metadata.gz: 3ea309277784ad1037eee6671202e22e3a79a54616080a4605a2259d8b3ae15d10aec7848f435e405858b8e64b1cf761f166f78a38b6dc284d34f73499fc2ced
+  data.tar.gz: 84becc66b0829aae3424d21f00f780396c75ce552e5f5fa508d44f859f248e2e2389d1bc613cb6a54c8bba90d1c7c6539e996ea25e7758c692baa07d3f28492f

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.idea/**
+
+output.csv
+*transactions*.csv

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/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 amazon_purchases_ledger.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    amazon_purchases_ledger (0.0.1)
+      thor (~> 0.20)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    flog (4.6.2)
+      path_expander (~> 1.0)
+      ruby_parser (~> 3.1, > 3.1.0)
+      sexp_processor (~> 4.8)
+    method_source (0.9.0)
+    parser (2.5.0.4)
+      ast (~> 2.4.0)
+    path_expander (1.0.2)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    ruby_parser (3.11.0)
+      sexp_processor (~> 4.9)
+    sexp_processor (4.10.1)
+    thor (0.20.0)
+    zombie_scout (0.0.6)
+      flog (~> 4.2)
+      parser (~> 2.1)
+      thor (~> 0.18)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  amazon_purchases_ledger!
+  bundler (~> 1.16)
+  pry (~> 0.11)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  zombie_scout (~> 0.0.5)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 John Randall
+
+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,64 @@
+# Amazon Purchases Ledger
+
+This gem takes order and item CSVs downloaded from your Amazon account as input, and parses those into a transactions CSV which is created in your home folder. 
+
+This output file is suitable for importing into a financial ledger system, such as Bankivity or Quicken. It contains fields for for transaction date, transaction amount, source account, and a memo. 
+
+The memo field in the output file contains details for each order, including the items and shipment details. Having these details included in each transaction row can helps with categorizing transactions for tax or budgeting purposes.
+
+To create the orders and items CSVs needed as input, see https://www.amazon.com/gp/help/customer/display.html
+
+
+## TODO: 
+
+[ ] Create a scraper that automatically downloads the source CSVs. See https://github.com/kyamaguchi/amazon_auth 
+
+
+## Similar projects
+
+* Amazon Order - Does similar things scraping he Amazon DOM rather than using CSVs. See https://github.com/kyamaguchi/amazon_order
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'amazon_purchases_ledger'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install amazon_purchases_ledger
+
+
+## Usage
+
+After installing, bundle should be available at the command line via
+
+    $ amazon_purchases_ledger
+
+Pass in the filepaths to an Amazon orders csv and an Amazon items csv, and the gem will create a ```transactions.csv``` in the user's home folder:
+
+    $ amazon_purchases_ledger [orders csv filepath] [items csv filepath]
+
+
+## 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/johntrandall/amazon_purchases_ledger.
+
+
+## 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/amazon_purchases_ledger.gemspec

@@ -0,0 +1,39 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "amazon_purchases_ledger/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = 'amazon_purchases_ledger'
+  spec.version       = AmazonPurchasesLedger::VERSION
+  spec.authors       = ['John Randall']
+  spec.email         = ['john@johnrandall.com']
+
+  spec.summary       = %q{Combine and Amazon orders csv and items csv into a csv suitable for importing into a financial ledger.}
+  spec.description   = %q{Takes and Amazon orders csv and items csv as input. Generates and output csv suitable for importing into a financial program.}
+  spec.homepage      = 'https://github.com/johntrandall/amazon_purchases_ledger'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  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", 'lib/**']
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.11"
+  spec.add_development_dependency 'zombie_scout', '~> 0.0.5'
+  spec.add_dependency 'thor', '~> 0.20'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "amazon_purchases_ledger"
+
+# 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/exe/amazon_purchases_ledger

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "amazon_purchases_ledger"
+
+AmazonPurchasesLedger::CLI.start(ARGV)

data/lib/amazon_purchases_ledger.rb

@@ -0,0 +1,24 @@
+require "amazon_purchases_ledger/version"
+require "amazon_purchases_ledger/merge_service"
+require "amazon_purchases_ledger/order"
+require "amazon_purchases_ledger/order/factory"
+require "amazon_purchases_ledger/shipment"
+require "amazon_purchases_ledger/shipment/factory"
+require "amazon_purchases_ledger/item"
+require "amazon_purchases_ledger/item/factory"
+
+require 'thor'
+
+module AmazonPurchasesLedger
+  # Your code goes here...
+  class CLI < Thor
+
+    desc 'merge [orders.csv] [items.csv]', 'render transactions CSV at user\'s home_dir'
+
+    def merge(csv_path_1, csv_path_2)
+      AmazonPurchasesLedger::MergeService.new(csv_path_1, csv_path_2).perform
+    end
+
+  end
+end
+

data/lib/amazon_purchases_ledger/item.rb

@@ -0,0 +1,51 @@
+module AmazonPurchasesLedger
+  class Item
+    def initialize(items_csv_row:)
+      @items_csv_row = items_csv_row
+    end
+
+    def output_text
+      [
+        '* ',
+        item_cost, ' for ',
+        item_quantity_string, item_title, ', ',
+        'Seller: ', item_seller
+      ].join
+    end
+
+    def item_quantity_string
+      "#{@items_csv_row[:quantity]}x " if @items_csv_row[:quantity]
+    end
+
+    private
+    def item_seller
+      @items_csv_row[:seller]
+    end
+
+    def item_title
+      truncate(@items_csv_row[:title], 40)
+    end
+
+    def item_cost
+      @items_csv_row[:item_total]
+    end
+
+    def truncate(content, max)
+      if content.length > max
+        truncated = ""
+        collector = ""
+        content = content.split(" ")
+        content.each do |word|
+          word = word + " "
+          collector << word
+          truncated << word if collector.length < max
+        end
+        truncated = truncated.strip.chomp(",").concat("...")
+      else
+        truncated = content
+      end
+      return truncated
+    end
+
+  end
+end

data/lib/amazon_purchases_ledger/item/factory.rb

@@ -0,0 +1,15 @@
+module AmazonPurchasesLedger
+  class Item
+    class Factory
+      def initialize(items_csv:, carrier_tracking:)
+        @items_csv = items_csv
+        @carrier_tracking = carrier_tracking
+      end
+
+      def items
+        items_csv_rows = @items_csv.select { |row| row[:carrier_name__tracking_number] == @carrier_tracking }
+        items_csv_rows.map { |items_csv_row| Item.new(items_csv_row: items_csv_row) }
+      end
+    end
+  end
+end

data/lib/amazon_purchases_ledger/merge_service.rb

@@ -0,0 +1,55 @@
+require 'csv'
+
+module AmazonPurchasesLedger
+  class MergeService
+
+    def initialize(csv_path_1, csv_path_2)
+      @csv_path_1 = csv_path_1
+      @csv_path_2 = csv_path_2
+      @csvs = [CSV.table(@csv_path_1, headers: true), CSV.table(@csv_path_2, headers: true)]
+    end
+
+    # TODO: Fix filepath (strings are not paths). Also, make this cross platform.
+    def perform
+      CSV.open("#{Dir.home}/Desktop/amazon_transactions_#{timestamp}.csv", "wb") do |csv|
+        csv << output_header_row
+        orders.each do |order|
+          csv << order.output_row
+        end
+      end
+    end
+
+    def orders
+      AmazonPurchasesLedger::Order::Factory.new(orders_csv: orders_csv,
+                                                items_csv: items_csv)
+        .orders
+    end
+
+    def orders_csv
+      csvs_with_header(:total_charged)
+    end
+
+    def items_csv
+      csvs_with_header(:title)
+    end
+
+    def output_header_row
+      AmazonPurchasesLedger::Order::OUTPUT_HEADER_ROW
+    end
+
+    private
+    def timestamp
+      Time.now.strftime('%Y-%m-%d_%H-%M-%S')
+    end
+
+    class InvalidInputCsvs < StandardError;
+    end
+
+    def csvs_with_header(header)
+      csvs = @csvs.select { |csv| csv.headers.include?(header) }
+      raise InvalidInputCsvs unless csvs.count == 1
+      csvs.first
+    end
+
+  end
+end

data/lib/amazon_purchases_ledger/order.rb

@@ -0,0 +1,68 @@
+module AmazonPurchasesLedger
+  class Order
+    attr_reader :order_id
+
+    def initialize(order_id:, orders_csv:, items_csv:)
+      @order_id = order_id
+      @orders_csv = orders_csv
+      @items_csv = items_csv
+    end
+
+    def complete?
+      amount != nil
+    end
+
+    OUTPUT_HEADER_ROW = [
+      :order_date,
+      :payment_account,
+      :amount,
+      :memo
+    ]
+
+    def output_row
+      return nil if shipments.any? { |shipment| shipment.total_charged.nil? }
+      [
+        order_date,
+        payment_account,
+        amount,
+        memo
+      ]
+    end
+
+    def memo
+      shipments.map(&:output_text).join("\n")
+    end
+
+    def shipments
+      AmazonPurchasesLedger::Shipment::Factory.new(order_id: @order_id,
+                                                   orders_csv: @orders_csv,
+                                                   items_csv: @items_csv)
+        .shipments
+    end
+
+    def items
+      shipments.flat_map(&:items)
+    end
+
+    private
+    def shipment_rows
+      @orders_csv.select { |row| row[:order_id] == @order_id }
+    end
+
+    def order_date
+      shipment_rows.first[:order_date]
+    end
+
+    def payment_account
+      shipment_rows.first[:payment_instrument_type]
+    end
+
+    def amount
+      return nil if shipments.any? { |shipment| shipment.total_charged.nil? }
+      shipments.map { |shipment| shipment.total_charged }
+        .sum.to_f.to_s.prepend('$')
+    end
+
+  end
+
+end

data/lib/amazon_purchases_ledger/order/factory.rb

@@ -0,0 +1,21 @@
+module AmazonPurchasesLedger
+  class Order
+    class Factory
+      def initialize(orders_csv:, items_csv:)
+        @orders_csv = orders_csv
+        @items_csv = items_csv
+      end
+
+      def orders
+        order_ids.map do |order_id|
+          Order.new(order_id: order_id, orders_csv: @orders_csv, items_csv: @items_csv)
+        end.select(&:complete?)
+      end
+
+      private
+      def order_ids
+        @orders_csv[:order_id]
+      end
+    end
+  end
+end

data/lib/amazon_purchases_ledger/shipment.rb

@@ -0,0 +1,30 @@
+require 'bigdecimal'
+require 'bigdecimal/util'
+
+module AmazonPurchasesLedger
+  class Shipment
+    def initialize(items_csv:, order_csv_row:)
+      @items_csv = items_csv
+      @order_csv_row = order_csv_row
+    end
+
+    def output_text
+      [
+        "Shipment: #{@order_csv_row[:carrier_name__tracking_number]}",
+        items.map { |item| item.output_text },
+        '----------------------'
+      ].join("\n")
+    end
+
+    def total_charged
+      return nil unless @order_csv_row[:total_charged]
+      @order_csv_row[:total_charged].gsub('$', '').to_d
+    end
+
+    def items
+      AmazonPurchasesLedger::Item::Factory.new(carrier_tracking: @order_csv_row[:carrier_name__tracking_number],
+                                               items_csv: @items_csv)
+        .items
+    end
+  end
+end

data/lib/amazon_purchases_ledger/shipment/factory.rb

@@ -0,0 +1,16 @@
+module AmazonPurchasesLedger
+  class Shipment
+    class Factory
+      def initialize(orders_csv:, items_csv:, order_id:)
+        @orders_csv = orders_csv
+        @items_csv = items_csv
+        @order_id = order_id
+      end
+
+      def shipments
+        order_csv_rows = @orders_csv.select { |row| row[:order_id] == @order_id }
+        order_csv_rows.map { |order_csv_row| Shipment.new(items_csv: @items_csv, order_csv_row: order_csv_row) }
+      end
+    end
+  end
+end

data/lib/amazon_purchases_ledger/version.rb

@@ -0,0 +1,3 @@
+module AmazonPurchasesLedger
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: amazon_purchases_ledger
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- John Randall
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: zombie_scout
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+description: Takes and Amazon orders csv and items csv as input. Generates and output
+  csv suitable for importing into a financial program.
+email:
+- john@johnrandall.com
+executables:
+- amazon_purchases_ledger
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- amazon_purchases_ledger-0.1.0.gem
+- amazon_purchases_ledger.gemspec
+- bin/console
+- bin/setup
+- exe/amazon_purchases_ledger
+- lib/amazon_purchases_ledger.rb
+- lib/amazon_purchases_ledger/item.rb
+- lib/amazon_purchases_ledger/item/factory.rb
+- lib/amazon_purchases_ledger/merge_service.rb
+- lib/amazon_purchases_ledger/order.rb
+- lib/amazon_purchases_ledger/order/factory.rb
+- lib/amazon_purchases_ledger/shipment.rb
+- lib/amazon_purchases_ledger/shipment/factory.rb
+- lib/amazon_purchases_ledger/version.rb
+homepage: https://github.com/johntrandall/amazon_purchases_ledger
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- lib/**
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Combine and Amazon orders csv and items csv into a csv suitable for importing
+  into a financial ledger.
+test_files: []