app_earnings 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 487fedffadd25385824a6975622541ccfc1ed345
+  data.tar.gz: 90512a69c5fba64f7b9076335e5014b292d43e2c
+SHA512:
+  metadata.gz: 7bbd1156a220de74b2131579141f193dcb405f4de9c293768f32b822cc75bf1d6ce934af67459297ace932de3cd949537eec5d9d5526d2e85a14d08126af7dcc
+  data.tar.gz: 9cdc32f3ba8a84db4573e3e5fd3253061a7ce6c8d83c5bddcd0ef9b56e1ecbcab389ffb6a1f9bf1d1d6a4f1590285dc9306ad91a4fd75419fd36680711ad3902

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in app_earnings.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Egghead Games LLC
+
+MIT License
+
+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,71 @@
+app_earnings
+============
+
+Process App Store monthly "raw" CSV files into a report by Application and IAP. 
+Currently supports Google Play and Amazon Android marketplace data.
+
+## Background
+
+Egghead Games is an independent app developer who has to provide monthly royalties to various licensors based on sales. 
+None of the existing tools like Distimo or App Annie provided data that was sufficiently accurate to make payments. 
+The stores provide data files (usually CSV) with the raw data, but processing these by hand or spreadsheet is painful.
+This command utility takes the CSV files and outputs sales by app and in-app purchase within the app. 
+It takes into account refunds and currency conversions, so that the amounts given should exactly correspond to the payments
+made by the app store.
+
+## Description
+
+The Google Play and Amazon Android Marketplaces provide monthly earning reports in the form of CSV files.
+
+This command line utility processes the transactions, groups them by app and in-app purchase (IAP), and produces the net dollar amount for each app. It includes the following features:
+
+ * handles returns 
+ * provides sub-totals for IAPs, so you can see how much individual IAPs are earning.
+ * uses Amazon exchange rates to ensure that all amounts are in your final currency
+ * should handle non-USD Google Wallet accounts (though this is untested)
+ * JSON output is available, to make further processing simpler
+
+By default, it provides simple text output.
+
+## Installation
+
+Install it yourself as:
+
+    $ gem install app_earnings
+
+## Usage
+
+This will show the full set of current commands and options:
+
+	app_earnings help
+
+### Google Play Marketplace
+
+To process a Google Play monthly earnings report csv file into a text sales report:
+
+	app_earnings play PlayApps_201401.csv
+
+Alternatively, you can get a JSON version of the data with:
+
+	app_earnings play PlayApps_201401.csv --format json
+
+### Amazon Android Marketplace
+
+To process Amazon monthly earnings report files into a text sales report:
+
+	app_earnings amazon EarningsReport-Jan-1-2014-Jan-31-2014.csv PaymentReport-Feb-1-2014-Mar-1-2014.csv
+
+Note that the payment report must be for the month after, as Amazon payments happen a month in arrears.
+
+Alternatively, you can get a JSON version of the data with:
+
+	app_earnings amazon EarningsReport-Jan-1-2014-Jan-31-2014.csv PaymentReport-Feb-1-2014-Mar-1-2014.csv --format json
+
+
+## Contributing
+
+1. Fork it ( http://github.com/eggheadgames/app_earnings/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,24 @@
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+require 'ruby-lint/rake_task'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec
+
+desc 'Run RuboCop on the lib directory'
+Rubocop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ['lib/**/*.rb']
+  # don't abort rake on failure
+  task.fail_on_error = false
+end
+
+RubyLint::RakeTask.new do |task|
+  task.name  = 'lint'
+  task.files = ['lib']
+end
+
+desc 'Runs specs/Lint/Style checks'
+task :all => [ :lint, :rubocop, :spec ]

data/app_earnings.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "app_earnings"
+  spec.version       = "1.0.0"
+  spec.authors       = ["Egghead Games", "André Luis Leal Cardoso Junior", "Michael Mee"]
+  spec.email         = ["support@eggheadgames.com"]
+  spec.summary       = %q{Process app store csv report files into a text/json summary by application and iap}
+  spec.description   = <<-EOF
+Allows easy calculation of revenue sharing by app and in-app purchases. 
+Munges the monthly CSV reports from Google Play or Amazon Android app stores. 
+Does Amazon currency conversions and verifies against payment amounts.
+EOF
+  spec.homepage      = "http://github.com/eggheadgames/app_earnings"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   << 'app_earnings'
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "thor", "~> 0.18.0"
+  spec.add_dependency "currencies", "~> 0.4.2"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rubocop", "~> 0.18.1"
+  spec.add_development_dependency "ruby-lint", "~> 1.1.0"
+  spec.add_development_dependency "rspec", "~> 2.14"
+end

data/bin/app_earnings

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+
+begin
+  require 'app_earnings'
+rescue LoadError
+  lib = File.expand_path('../../lib', __FILE__)
+  $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+  require 'app_earnings'
+end
+
+AppEarnings::Cli.start(ARGV)

data/lib/app_earnings.rb

@@ -0,0 +1,21 @@
+require 'app_earnings/cli'
+require 'app_earnings/report'
+require 'app_earnings/amazon'
+require 'app_earnings/google_play'
+
+# Process Monthly Earnings report
+# From GoogleApps or Amazon
+# transaction CSV file into a report by Application and IAP
+module AppEarnings
+  def self.play_report(name, format = 'text')
+    parsed = GooglePlay::Parser.new(name).extract
+    GooglePlay::Reporter.new(parsed).report_as(format)
+  end
+
+  def self.amazon_report(payments, earnings, format = 'text')
+    parsed = []
+    parsed << Amazon::Parser.new(payments).extract
+    parsed << Amazon::Parser.new(earnings).extract
+    Amazon::Reporter.new(parsed).report_as(format)
+  end
+end

data/lib/app_earnings/amazon.rb

@@ -0,0 +1,3 @@
+require 'app_earnings/amazon/parser'
+require 'app_earnings/amazon/amazon_report'
+require 'app_earnings/amazon/reporter'

data/lib/app_earnings/amazon/amazon_report.rb

@@ -0,0 +1,37 @@
+require 'yaml'
+require 'iso4217'
+
+module AppEarnings::Amazon
+  # Converts a csv file to a hash.
+  class AmazonReport
+    include AppEarnings::Report
+
+    attr_accessor :exchange_info
+
+    def initialize(name, transactions, exchange_info)
+      @exchange_info = exchange_info
+      extract_amount(name, transactions)
+    end
+
+    def convert_amounts(amounts)
+      amounts.reduce(0.0) do |sum, (marketplace, amount)|
+        amount = amount * @exchange_info[marketplace].to_f
+        sum + amount
+      end
+    end
+
+    def amount_from_transactions(transactions)
+      amounts = transactions.reduce({}) do |sum, transaction|
+        marketplace = transaction[:marketplace]
+        sum[marketplace] ||= 0.0
+        sum[marketplace] += transaction[:gross_earnings_or_refunds].to_f
+        sum
+      end
+
+      {
+        currency: 'USD',
+        amount: convert_amounts(amounts).round(2)
+      }
+    end
+  end
+end

data/lib/app_earnings/amazon/parser.rb

@@ -0,0 +1,42 @@
+require 'csv'
+
+module AppEarnings::Amazon
+  # Converts a csv file to a hash.
+  class Parser
+    attr_accessor :file_name
+
+    def initialize(file_name)
+      @file_name = file_name
+      @contents = File.read(@file_name)
+      @header, @summary, @details = @contents.split(/Summary|Detail/)
+
+      if @header =~ /Payment Report/
+        @report_type = :payments
+      else
+        @report_type = :earnings
+      end
+    end
+
+    def extract
+      {
+        report_type: @report_type,
+        header: @header,
+        summary: parse(@summary.strip),
+        details: parse((@details || '').strip)
+      }
+    end
+
+    private
+
+    def parse(content)
+      return nil if content.nil?
+      extracted_data = []
+      options = { headers: true, header_converters: :symbol }
+
+      CSV.parse(content, options) do |row|
+        extracted_data << row.to_hash
+      end
+      extracted_data
+    end
+  end
+end

data/lib/app_earnings/amazon/reporter.rb

@@ -0,0 +1,89 @@
+module AppEarnings::Amazon
+  # Generates a report based on the data provided
+  class Reporter
+    AVAILABLE_FORMATS = %w(json text)
+    attr_accessor :data
+
+    def initialize(data)
+      @data = data
+      @payments_data = @data.find { |r| r[:report_type] == :payments }
+      @earnings_data = (@data - [@payments_data]).first
+      @exchange_info = fetch_exchange_info
+    end
+
+    def fetch_exchange_info
+      @payments_full_amount = 0.0
+      @payments_data[:summary].reduce({}) do |all_info, data|
+        all_info[data[:marketplace]] = data[:fx_rate]
+        @payments_full_amount += data[:total_payment].gsub(/,/, '').to_f
+        all_info
+      end
+    end
+
+    def full_amount
+      total = @reports.reduce(0.0) { |a, e| a + e.amount.to_f }
+      total - refunds
+    end
+
+    def refunds
+      @earnings_data[:summary].reduce(0.0) do |sum, marketplace|
+        currency = marketplace[:refunds_currency_code]
+        amount = marketplace[:refunds].gsub(/\(|\)/, '').to_f
+        amount = amount * @exchange_info[currency].to_f if currency != 'USD'
+        sum + amount
+      end
+    end
+
+    def generate
+      @reports = []
+      @data.each do |raw_data|
+        if raw_data[:report_type] == :earnings
+          by_apps = raw_data[:details].group_by { |element| element[:app] }
+                                      .sort_by { |app| app }
+
+          by_apps.each do |key, application|
+            @reports << AmazonReport.new(key, application, @exchange_info)
+          end
+        end
+      end
+    end
+
+    def report_as(format = 'text')
+      unless AVAILABLE_FORMATS.include?(format)
+        fail "#{format} Not supported. Available formats are: " +
+             " #{AVAILABLE_FORMATS.join(", ")}"
+      end
+
+      generate
+      render_as(format)
+    end
+
+    def render_as(format = 'text')
+      case format
+      when 'text'
+        as_text
+      when 'json'
+        as_json
+      end
+    end
+
+    def as_text
+      amount = AppEarnings::Report.formatted_amount('USD', full_amount)
+      refund = AppEarnings::Report.formatted_amount('USD', refunds)
+      puts @reports
+      puts "Total of refunds: #{refund}"
+      puts "Total of all transactions: #{amount}"
+
+      if @payments_full_amount.round(2) != full_amount
+        puts "Total from Payment Report: #{@payments_full_amount.round(2)}"
+      end
+      @reports
+    end
+
+    def as_json
+      puts JSON.generate(apps: @reports.map(&:to_json),
+                         currency: 'USD',
+                         total: full_amount)
+    end
+  end
+end

data/lib/app_earnings/cli.rb

@@ -0,0 +1,31 @@
+require 'thor'
+
+module AppEarnings
+  # Command-line utility: Retrieves CSV file
+  # and generates a report based into it.
+  class Cli < Thor
+    desc 'play PlayApps.csv', 'Generates a detailed report'\
+                              ' for the provided Google Play transaction file'
+    method_option :format, type: :string, default: 'text',
+                           aliases: '-f', enum: %w(text json)
+    def play(name)
+      if File.exists?(name)
+        AppEarnings.play_report(name, options[:format])
+      else
+        puts "File '#{name}' not found!"
+      end
+    end
+
+    desc 'amazon PaymentReport.csv EarningsReport.csv', 'Generates a '\
+                          'detailed report for the Amazon report files'
+    method_option :format, type: :string, default: 'text',
+                           aliases: '-f', enum: %w(text json)
+    def amazon(payments, earnings)
+      if File.exists?(payments) && File.exists?(earnings)
+        AppEarnings.amazon_report(payments, earnings, options[:format])
+      else
+        puts "Files '#{payments}' and '#{earnings}' were not found!"
+      end
+    end
+  end
+end

data/lib/app_earnings/google_play.rb

@@ -0,0 +1,3 @@
+require 'app_earnings/google_play/parser'
+require 'app_earnings/google_play/play_report'
+require 'app_earnings/google_play/reporter'

data/lib/app_earnings/google_play/parser.rb

@@ -0,0 +1,22 @@
+require 'csv'
+
+module AppEarnings::GooglePlay
+  # Converts a csv file to a hash.
+  class Parser
+    attr_accessor :file_name
+
+    def initialize(file_name)
+      @file_name = file_name
+    end
+
+    def extract
+      @extracted_data = []
+      options = { headers: true, header_converters: :symbol }
+
+      CSV.foreach(@file_name, options) do |row|
+        @extracted_data << row.to_hash
+      end
+      @extracted_data
+    end
+  end
+end

data/lib/app_earnings/google_play/play_report.rb

@@ -0,0 +1,29 @@
+module AppEarnings::GooglePlay
+  # Represents the report.
+  class PlayReport
+    include AppEarnings::Report
+
+    def initialize(name, transactions)
+      extract_amount(name, transactions)
+      unless transactions_from_product.first.nil?
+        @description = transactions_from_product.first[:product_title]
+      end
+    end
+
+    # It sums up to all available amounts, but it takes just the first one.
+    # As it's usually just one.
+    def amount_from_transactions(transactions)
+      all_currencies = transactions.reduce({}) do |sum, transaction|
+        currency = transaction[:merchant_currency]
+        sum[currency] ||= 0.0
+        sum[currency] += transaction[:amount_merchant_currency].to_f
+        sum
+      end.first
+
+      {
+        currency: all_currencies.first,
+        amount: all_currencies.last.round(2)
+      }
+    end
+  end
+end

data/lib/app_earnings/google_play/reporter.rb

@@ -0,0 +1,65 @@
+require 'yaml'
+require 'json'
+require 'iso4217'
+
+module AppEarnings::GooglePlay
+  # Generates a report based on the data provided
+  class Reporter
+    AVAILABLE_FORMATS = %w(json text)
+    attr_accessor :raw_data
+
+    def initialize(raw_data)
+      @raw_data = raw_data
+    end
+
+    def generate
+      by_apps = @raw_data.group_by { |element| element[:product_id] }
+                         .sort_by { |app| app }
+
+      @reports = []
+      by_apps.each do |key, application|
+        @reports << PlayReport.new(key, application)
+      end
+    end
+
+    def full_amount
+      total = @reports.reduce(0.0) { |a, e| a + e.amount.to_f }
+      currency = @reports.first.currency
+      [currency, total]
+    end
+
+    def report_as(format = 'text')
+      unless AVAILABLE_FORMATS.include?(format)
+        fail "#{format} Not supported. Available formats are: " +
+             " #{AVAILABLE_FORMATS.join(", ")}"
+      end
+
+      generate
+      render_as(format)
+    end
+
+    def render_as(format = 'text')
+      case format
+      when 'text'
+        as_text
+      when 'json'
+        as_json
+      end
+    end
+
+    def as_text
+      currency, total = full_amount
+      formatted_amount = AppEarnings::Report.formatted_amount(currency, total)
+      puts @reports
+      puts "Total of all transactions: #{formatted_amount}"
+      @reports
+    end
+
+    def as_json
+      currency, total = full_amount
+      puts JSON.generate(apps: @reports.map(&:to_json),
+                         currency: currency,
+                         total: total)
+    end
+  end
+end

data/lib/app_earnings/report.rb

@@ -0,0 +1,94 @@
+module AppEarnings
+  # Base class for reports
+  module Report
+    attr_accessor :name, :transactions, :amount, :currency
+
+    def extract_amount(name, transactions)
+      @name = name
+      @transactions = transactions
+      @total_amount = amount_from_transactions(@transactions)
+      @currency = @total_amount[:currency]
+      @amount = @total_amount[:amount]
+    end
+
+    def transactions_by_type
+      transactions.group_by { |transaction| transaction[:transaction_type] }
+    end
+
+    def transactions_from_in_app_purchases
+      transactions.reject do |tr|
+        tr[:sku_id].nil? && tr[:vendor_sku].nil?
+      end
+    end
+
+    def transactions_from_in_app_purchases_by_id_and_name
+      transactions_from_in_app_purchases.group_by do |tr|
+        [tr[:sku_id] || tr[:vendor_sku],
+         tr[:item_name] || tr[:product_title]]
+      end
+    end
+
+    def transactions_count_by_type
+      transaction_count = {}
+      transactions_by_type.each do |type, transactions|
+        transaction_count[type] = transactions.length
+      end
+      transaction_count
+    end
+
+    def transactions_from_product
+      transactions - transactions_from_in_app_purchases
+    end
+
+    def total_from_in_app_purchases
+      transactions_from_in_app_purchases_by_id_and_name.map do |iap, tr|
+        {
+          id: iap.first,
+          name: iap.last
+        }.merge(amount_from_transactions(tr))
+      end
+    end
+
+    def formatted_transactions_count_by_type
+      transactions_count_by_type.sort_by { |name, _| name }.map do |tr|
+        tr.join(': ')
+      end
+    end
+
+    def formatted_total_by_products
+      total_from_in_app_purchases.sort_by { |product| product[:id] }
+        .map do |app|
+          total_amount = Report.formatted_amount(app[:currency], app[:amount])
+          "#{app[:id]} - #{app[:name]}: #{total_amount}"
+        end
+    end
+
+    def self.formatted_amount(currency, amount)
+      symbol = ISO4217::Currency.from_code(currency).symbol
+      "#{currency} #{symbol}#{sprintf('%.2f', amount)}"
+    end
+
+    def to_json
+      {
+        id: @name,
+        name: @description,
+        transactions_types: transactions_count_by_type,
+        total: @amount.round(2),
+        currency: @currency,
+        subtotals: total_from_in_app_purchases
+      }
+    end
+
+    def to_s
+      %Q(#{@name} #{@description}
+Transactions: #{formatted_transactions_count_by_type.join(", ")}
+Total:
+#{Report.formatted_amount(@currency, @amount)}
+
+Sub totals by IAP:
+#{formatted_total_by_products.join("\n")}
+
+)
+    end
+  end
+end

data/spec/app_earnings/amazon/amazon_reporter_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe AppEarnings::Amazon::Reporter do
+  let(:payments_data) { AppEarnings::Amazon::Parser.new(file("amazon_payments.csv")).extract }
+  let(:earnings_data) { AppEarnings::Amazon::Parser.new(file("amazon_earnings.csv")).extract }
+  let(:dummy_data) { [ { merchant_currency: "USD", amount_merchant_currency: 10.0 },
+                       { merchant_currency: "USD", amount_merchant_currency: 5.0 } ] }
+  let(:reporter) { AppEarnings::Amazon::Reporter.new([payments_data, earnings_data]) }
+
+  it "should return an array of report objects" do
+    data = reporter.report_as('text')
+    expect(data).to be_a(Array)
+    expect(data.first).to be_a(AppEarnings::Amazon::AmazonReport)
+  end
+
+  it "should fail when trying to use an unsupported format" do
+    expect { reporter.report_as('unknown') }.to raise_error
+  end
+
+  it "should sum refunds" do
+    reporter.refunds.should eql(4.18)
+  end
+
+  it "should return total amount" do
+    reporter.generate
+    reporter.full_amount.should eql(10.3)
+  end
+end

data/spec/app_earnings/amazon/parser_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe AppEarnings::Amazon::Parser do
+  context "Validation" do
+    it "should fail when an invalid csv is provided" do
+      expect { AppEarnings::Amazon::Parser.new("non_existant.csv").extract }.to raise_error(Errno::ENOENT)
+    end
+  end
+
+  context "Extracted data" do
+    let(:extracted_data_earnings) { AppEarnings::Amazon::Parser.new(file("amazon_earnings.csv")).extract }
+    let(:extracted_data_payments) { AppEarnings::Amazon::Parser.new(file("amazon_payments.csv")).extract }
+
+    it "should retrieve data from the provided csv and find out the type" do
+      expect(extracted_data_earnings[:report_type]).to eql(:earnings)
+      expect(extracted_data_earnings).to_not be_empty
+    end
+
+    it "should retrieve data from the provided csv and find out the type" do
+      expect(extracted_data_payments[:report_type]).to eql(:payments)
+      expect(extracted_data_payments).to_not be_empty
+    end
+  end
+end

data/spec/app_earnings/app_earnings_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe AppEarnings do
+  it "should generate a report by application based on a provided csv file for googple play" do
+    expect_any_instance_of(AppEarnings::GooglePlay::Parser).to receive(:extract)
+    expect_any_instance_of(AppEarnings::GooglePlay::Reporter).to receive(:report_as).with('text')
+
+    AppEarnings.play_report(file("play_transactions.csv"))
+  end
+
+  it "should generate a report by application based on a provided csv file for amazon" do
+    expect_any_instance_of(AppEarnings::Amazon::Reporter).to receive(:report_as).with('text')
+    AppEarnings.amazon_report(file("amazon_earnings.csv"), file("amazon_payments.csv"))
+  end
+end

data/spec/app_earnings/google_play/parser_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe AppEarnings::GooglePlay::Parser do
+  context "Validation" do
+    it "should fail when an invalid csv is provided" do
+      expect { AppEarnings::GooglePlay::Parser.new("non_existant.csv").extract }.to raise_error(Errno::ENOENT)
+    end
+  end
+
+  context "Extracted data" do
+    let(:extracted_data) { AppEarnings::GooglePlay::Parser.new(file("play_transactions.csv")).extract }
+
+    it "should retrieve data from the provided csv" do
+      expect(extracted_data).to_not be_empty
+    end
+  end
+end

data/spec/app_earnings/google_play/reporter_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe AppEarnings::GooglePlay::Reporter do
+  let(:extracted_data) { AppEarnings::GooglePlay::Parser.new(file("play_transactions.csv")).extract }
+  let(:dummy_data) { [ { merchant_currency: "USD", amount_merchant_currency: 10.0 },
+                       { merchant_currency: "USD", amount_merchant_currency: 5.0 } ] }
+  let(:reporter) { AppEarnings::GooglePlay::Reporter.new(extracted_data) }
+
+  it "should return an array of report objects" do
+    data = reporter.report_as('text')
+    expect(data).to be_a(Array)
+    expect(data.first).to be_a(AppEarnings::GooglePlay::PlayReport)
+  end
+
+  it "should fail when trying to use an unsupported format" do
+    expect { reporter.report_as('unknown') }.to raise_error
+  end
+end

data/spec/app_earnings/report_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe AppEarnings::Report do
+  let(:google_fee) { { product_title: "one", transaction_type: "Google Fee", merchant_currency: "USD", amount_merchant_currency: 10.0, sku_id: '1' } }
+  let(:charge) { { product_title: "two", transaction_type: "Charge", merchant_currency: "USD", amount_merchant_currency: 20.0 } }
+  let(:charge_eur) { { product_title: "two", transaction_type: "Charge", merchant_currency: "EUR", amount_merchant_currency: 20.0 } }
+  let(:transactions) { [ google_fee, charge, google_fee, charge_eur ] }
+
+  before(:each) do
+    @report = AppEarnings::GooglePlay::PlayReport.new("Product one", transactions)
+  end
+
+  it "should return count of transactions by type" do
+    expect(@report.transactions_count_by_type).to include( { "Google Fee" => 2 }, { "Charge" => 2 })
+  end
+
+  it "should group transactions by type" do
+    expect(@report.transactions_by_type.keys).to include("Google Fee", "Charge")
+  end
+
+  it "should not include transactions made for IAP" do
+    expect(@report.transactions_from_product.all? { |tr| tr[:sku_id].nil? }).to be_true
+  end
+
+  it "should not include transactions made from product" do
+    expect(@report.transactions_from_in_app_purchases.all? { |tr| !tr[:sku_id].nil? }).to be_true
+  end
+
+  it "should group transactions by product title (IAP)" do
+    transactions_by_product = @report.transactions_from_in_app_purchases_by_id_and_name
+    counter = transactions_by_product.map { |product, transactions| [ product, transactions.length] }
+    expect(counter).to include([["1", "one"], 2])
+  end
+
+  it "should retrieve amount from a list of transactions" do
+    amount = @report.amount_from_transactions(transactions)
+    expect(amount).to include({ currency: "USD", amount: 40.00 })
+  end
+
+  it "should retrieve totals by product title" do
+    amounts = @report.total_from_in_app_purchases
+    expect(amounts).to include({ id: "1", name: "one", currency: "USD", amount: 20.00})
+  end
+end

data/spec/fixtures/amazon_earnings.csv

@@ -0,0 +1,32 @@
+Amazon Mobile App Distribution
+Earnings Report
+1/1/2014 - 1/31/2014
+Mobile Apps
+
+Notes
+Gross Earnings  -  Gross royalties and/or commissions earned by the developer during the period.
+Refunds  -  The royalty and/or commission portion of the total amount refunded to customers who returned their purchase.
+"Adjustments  -  Sum of all adjustments that occurred on your account during the specified month, such as pricing adjustments for marketing promotions. Please contact us with questions about a specific adjustment."
+Earnings Before Tax  -   May not reflect the actual disbursement values when royalties are subject to a withholding or payment thresholds have not been met. Please see the FAQ on the developer portal or your developer agreement for more detail.
+
+Summary
+Marketplace,From Date,To Date,Charge Units,Refund Units,Gross Earnings,Gross Earnings Currency Code,Refunds,Refunds Currency Code,Adjustments,Adjustments Currency Code,Earnings Before Tax,Earnings Before Tax Currency Code
+Amazon.ca,1/1/2014,1/31/2014,7,0,2.09,CAD,0.00,CAD,0.00,CAD,1.00,CAD
+Amazon.cn,1/1/2014,1/31/2014,0,0,0.00,CNY,0.00,CNY,0.00,CNY,0.00,CNY
+Amazon.co.jp,1/1/2014,1/31/2014,0,0,0,JPY,0,JPY,0,JPY,0,JPY
+Amazon.co.uk,1/1/2014,1/31/2014,244,0,73.61,GBP,0.00,GBP,0.00,GBP,20.00,GBP
+Amazon.com,1/1/2014,1/31/2014,"3,121",-2,"2,146.67",USD,(4.18),USD,0.00,USD,"2,000.12",USD
+Amazon.com.au,1/1/2014,1/31/2014,0,0,0.00,AUD,0.00,AUD,0.00,AUD,0.00,AUD
+Amazon.com.br,1/1/2014,1/31/2014,0,0,0.00,BRL,0.00,BRL,0.00,BRL,0.00,BRL
+Amazon.de,1/1/2014,1/31/2014,0,0,0.00,EUR,0.00,EUR,0.00,EUR,0.00,EUR
+Amazon.es,1/1/2014,1/31/2014,0,0,0.00,EUR,0.00,EUR,0.00,EUR,0.00,EUR
+Amazon.fr,1/1/2014,1/31/2014,0,0,0.00,EUR,0.00,EUR,0.00,EUR,0.00,EUR
+Amazon.it,1/1/2014,1/31/2014,0,0,0.00,EUR,0.00,EUR,0.00,EUR,0.00,EUR
+
+Detail
+Marketplace,Date,App,Item Name,Period,Vendor SKU,Item Type,Transaction Type,List Price,List Price Currency Code,Sales Price,Sales Price Currency Code,units,Gross Earnings or Refunds,Gross Earnings or Refunds Currency Code
+Amazon.com,1/1/2014,App,,,,Apps,CHARGE,2.99,USD,2.99,USD,4,8.36,USD
+Amazon.co.uk,1/1/2014,Metal Gear,,,,Apps,CHARGE,1.09,GBP,0.51,GBP,1,0.36,GBP
+Amazon.com,1/1/2014,Metal Gear,,,,Apps,CHARGE,1.99,USD,0.99,USD,8,5.52,USD
+Amazon.co.uk,1/1/2014,Metal Gear FREE Trial,,,,Apps,CHARGE,0.00,GBP,0.00,GBP,1,0.00,GBP
+Amazon.com,1/1/2014,Metal Gear FREE Trial,,,,Apps,CHARGE,0.00,USD,0.00,USD,14,0.00,USD

data/spec/fixtures/amazon_payments.csv

@@ -0,0 +1,18 @@
+Amazon Mobile App Distribution
+Payment Report
+1/23/2014 - 2/10/2014
+Mobile Apps
+
+Notes
+Payment Cost is the cost of disbursing your earnings in your home currency
+Tax Witheld is the taxes Amazon withholds from your earnings due to US tax withholding requirements
+A more detailed calculation of earnings can be found in the Earnings Report.
+
+Summary
+Payment Date,Marketplace,Earnings Period,Earnings Before Tax,Earnings Before Tax Currency Code,Tax Withheld,Tax Withheld Currency Code,Payment Cost,Payment Cost Currency Code,Payment Method,FX Rate,Total Payment,Total Payment Currency Code,Payment Comment
+1/30/2014,Amazon.ca,12/1/2013 - 12/31/2013,2.09,CAD,0.00,CAD,0.00,CAD,EFT,0.894737,1.0,USD,
+1/30/2014,Amazon.co.uk,12/1/2013 - 12/31/2013,115.24,GBP,0.00,GBP,0.00,GBP,EFT,1.655675,100.10,USD,
+1/30/2014,Amazon.com,12/1/2013 - 12/31/2013,"2,221.57",USD,0.00,USD,0.00,USD,EFT,1.000000,"2,200.12",USD,
+1/30/2014,Amazon.com.au,12/1/2013 - 12/31/2013,4.54,AUD,0.00,AUD,0.00,AUD,EFT,0.876652,2.00,USD,
+1/30/2014,Amazon.de,12/1/2013 - 12/31/2013,1.52,EUR,0.00,EUR,0.00,EUR,EFT,1.361842,2.07,USD,
+

data/spec/fixtures/play_transactions.csv

@@ -0,0 +1,4 @@
+Description,Transaction Date,Transaction Time,Tax Type,Transaction Type,Refund Type,Product Title,Product id,Product Type,Sku Id,Hardware,Buyer Country,Buyer State,Buyer Postal Code,Buyer Currency,Amount (Buyer Currency),Currency Conversion Rate,Merchant Currency,Amount (Merchant Currency)
+1376321714625257,"Jan 29, 2014",7:33:12 AM PST,,Charge,,Flappy Bird,com.example.flappy,0,,m0,AU,QLD,4520,AUD,2.99,0.874200,USD,2.61
+1376321714625257,"Jan 29, 2014",7:33:12 AM PST,,Google fee,,Flappy Bird,com.example.flappy,0,,m0,AU,QLD,4520,AUD,-0.90,0.874200,USD,-0.79
+1346161764058234,"Jan 29, 2014",8:03:14 AM PST,,Charge,,Flappy Clone,example.clone,0,,espresso10rf,AU,,3165,AUD,2.99,0.875700,USD,2.62

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require './lib/app_earnings'
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.color_enabled = true
+  config.tty = true
+
+  config.formatter = :documentation # :progress, :html, :textmate
+  config.before do
+    AppEarnings::Amazon::Reporter.any_instance.stub(:puts)
+    AppEarnings::GooglePlay::Reporter.any_instance.stub(:puts)
+  end
+end
+
+def file(name)
+  File.expand_path(File.dirname(__FILE__) + '/fixtures/' + name)
+end

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: app_earnings
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Egghead Games
+- André Luis Leal Cardoso Junior
+- Michael Mee
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+- !ruby/object:Gem::Dependency
+  name: currencies
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+- !ruby/object:Gem::Dependency
+  name: ruby-lint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+description: "Allows easy calculation of revenue sharing by app and in-app purchases.
+  \nMunges the monthly CSV reports from Google Play or Amazon Android app stores.
+  \nDoes Amazon currency conversions and verifies against payment amounts.\n"
+email:
+- support@eggheadgames.com
+executables:
+- app_earnings
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app_earnings.gemspec
+- lib/app_earnings.rb
+- lib/app_earnings/amazon.rb
+- lib/app_earnings/amazon/amazon_report.rb
+- lib/app_earnings/amazon/parser.rb
+- lib/app_earnings/amazon/reporter.rb
+- lib/app_earnings/cli.rb
+- lib/app_earnings/google_play.rb
+- lib/app_earnings/google_play/parser.rb
+- lib/app_earnings/google_play/play_report.rb
+- lib/app_earnings/google_play/reporter.rb
+- lib/app_earnings/report.rb
+- spec/app_earnings/amazon/amazon_reporter_spec.rb
+- spec/app_earnings/amazon/parser_spec.rb
+- spec/app_earnings/app_earnings_spec.rb
+- spec/app_earnings/google_play/parser_spec.rb
+- spec/app_earnings/google_play/reporter_spec.rb
+- spec/app_earnings/report_spec.rb
+- spec/fixtures/amazon_earnings.csv
+- spec/fixtures/amazon_payments.csv
+- spec/fixtures/play_transactions.csv
+- spec/spec_helper.rb
+- bin/app_earnings
+homepage: http://github.com/eggheadgames/app_earnings
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- 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.0.3
+signing_key: 
+specification_version: 4
+summary: Process app store csv report files into a text/json summary by application
+  and iap
+test_files:
+- spec/app_earnings/amazon/amazon_reporter_spec.rb
+- spec/app_earnings/amazon/parser_spec.rb
+- spec/app_earnings/app_earnings_spec.rb
+- spec/app_earnings/google_play/parser_spec.rb
+- spec/app_earnings/google_play/reporter_spec.rb
+- spec/app_earnings/report_spec.rb
+- spec/fixtures/amazon_earnings.csv
+- spec/fixtures/amazon_payments.csv
+- spec/fixtures/play_transactions.csv
+- spec/spec_helper.rb
+has_rdoc: