stripe_invoice 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 20da253e1cd8256f9a83fdff32032f4e296e519c
-  data.tar.gz: 31614a75ebf67a5426967dcb7f092d650172529b
+  metadata.gz: 4885d32ab6190113c39fb30c8ab1ce99904b4603
+  data.tar.gz: 204da69a615798863d6944c0001f14c2d5173feb
 SHA512:
-  metadata.gz: 8c275a01506f4d2586a1b8c1f198c017d4fea5c8a788027a4876be3ac9e850294dc5906a2253437c5f6f2d90201f243ccd27dacd80b578278f141a9963a7f8b8
-  data.tar.gz: 50bbbd8caed4779b00fe77994d2f12274199d5645c7d60a56b834bd9221f1ea5f511b805078aa8857256f7390837075226f77ec00d4baff577b2fa178bcae918
+  metadata.gz: 3623c343b700cc7caf4636198504d1b2dfd5e216874a30efa30aadc1397644565a7476f2a152a8c34b69971681e2f20c62aba134f63b9d44fae540b6350ef055
+  data.tar.gz: e7eef5100bf2191ed6708a750db875ec4304d892bb784888a51ba33d3c03e33231fb1b82093785448a704744ea2795c2b8bbeadce0d055f4f52729f062fb8d41

data/.gitignore

@@ -0,0 +1,11 @@
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/log/*.log
+test/dummy/tmp/
+test/dummy/.sass-cache
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/dummy/db/*.sqlite3
+*.gem

data/.project

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>stripe_invoice</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+	</buildSpec>
+	<natures>
+		<nature>com.aptana.projects.webnature</nature>
+		<nature>org.radrails.rails.core.railsnature</nature>
+		<nature>com.aptana.ruby.core.rubynature</nature>
+	</natures>
+</projectDescription>

data/Gemfile

@@ -0,0 +1,31 @@
+source "https://rubygems.org"
+
+# Declare your gem's dependencies in stripe_invoice.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# jquery-rails is used by the dummy application
+gem "jquery-rails"
+
+gem 'stripe'
+gem 'haml-rails'
+
+gem 'prawn-rails'
+ 
+group :development, :test do
+	gem "rspec-rails", "~> 2.12.2"
+	gem "factory_girl_rails", "~> 4.0"
+	gem 'pdf-inspector'
+  gem 'vcr'
+  gem 'webmock'
+end
+
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'debugger'

data/Gemfile.lock

@@ -0,0 +1,219 @@
+PATH
+  remote: .
+  specs:
+    stripe_invoice (0.4.0)
+      delayed_job_active_record
+      haml-rails
+      prawn-rails
+      rails (~> 3.2.18)
+      stripe
+      stripe_event
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    Ascii85 (1.0.2)
+    actionmailer (3.2.18)
+      actionpack (= 3.2.18)
+      mail (~> 2.5.4)
+    actionpack (3.2.18)
+      activemodel (= 3.2.18)
+      activesupport (= 3.2.18)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.5)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.18)
+      activesupport (= 3.2.18)
+      builder (~> 3.0.0)
+    activerecord (3.2.18)
+      activemodel (= 3.2.18)
+      activesupport (= 3.2.18)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.18)
+      activemodel (= 3.2.18)
+      activesupport (= 3.2.18)
+    activesupport (3.2.18)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    addressable (2.3.6)
+    afm (0.2.2)
+    arel (3.0.3)
+    bcrypt (3.1.9)
+    bluecloth (2.2.0)
+    builder (3.0.4)
+    capybara (2.4.4)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      xpath (~> 2.0)
+    coderay (1.1.0)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    delayed_job (4.0.6)
+      activesupport (>= 3.0, < 5.0)
+    delayed_job_active_record (4.0.3)
+      activerecord (>= 3.0, < 5.0)
+      delayed_job (>= 3.0, < 4.1)
+    devise (3.4.1)
+      bcrypt (~> 3.0)
+      orm_adapter (~> 0.1)
+      railties (>= 3.2.6, < 5)
+      responders
+      thread_safe (~> 0.1)
+      warden (~> 1.2.3)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    factory_girl (4.5.0)
+      activesupport (>= 3.0.0)
+    factory_girl_rails (4.5.0)
+      factory_girl (~> 4.5.0)
+      railties (>= 3.0.0)
+    haml (4.0.5)
+      tilt
+    haml-rails (0.4)
+      actionpack (>= 3.1, < 4.1)
+      activesupport (>= 3.1, < 4.1)
+      haml (>= 3.1, < 4.1)
+      railties (>= 3.1, < 4.1)
+    hashery (2.1.1)
+    hike (1.2.3)
+    i18n (0.6.9)
+    journey (1.0.4)
+    jquery-rails (3.1.0)
+      railties (>= 3.0, < 5.0)
+      thor (>= 0.14, < 2.0)
+    json (1.8.1)
+    koudoku (0.0.11)
+      bluecloth
+      rails
+      stripe
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    method_source (0.8.2)
+    mime-types (1.25.1)
+    mini_portile (0.6.1)
+    multi_json (1.10.1)
+    nokogiri (1.6.4)
+      mini_portile (~> 0.6.0)
+    orm_adapter (0.5.0)
+    pdf-core (0.4.0)
+    pdf-inspector (1.2.0)
+      pdf-reader (~> 1.0)
+    pdf-reader (1.3.3)
+      Ascii85 (~> 1.0.0)
+      afm (~> 0.2.0)
+      hashery (~> 2.0)
+      ruby-rc4
+      ttfunk
+    polyglot (0.3.5)
+    prawn (1.3.0)
+      pdf-core (~> 0.4.0)
+      ttfunk (~> 1.4.0)
+    prawn-rails (0.1.0)
+      prawn
+      prawn-table
+      rails (>= 3.1.0)
+    prawn-table (0.2.1)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.4.5)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.4)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (3.2.18)
+      actionmailer (= 3.2.18)
+      actionpack (= 3.2.18)
+      activerecord (= 3.2.18)
+      activeresource (= 3.2.18)
+      activesupport (= 3.2.18)
+      bundler (~> 1.0)
+      railties (= 3.2.18)
+    railties (3.2.18)
+      actionpack (= 3.2.18)
+      activesupport (= 3.2.18)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (10.3.2)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    responders (1.1.1)
+      railties (>= 3.2, < 4.2)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.2)
+    rspec-rails (2.12.2)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    ruby-rc4 (0.1.5)
+    safe_yaml (1.0.4)
+    slop (3.6.0)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.10)
+    stripe (1.11.0)
+      json (~> 1.8.1)
+      mime-types (~> 1.25)
+      rest-client (~> 1.4)
+    stripe_event (1.4.0)
+      activesupport (>= 3.1)
+      stripe (~> 1.6)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    tilt (1.4.1)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    ttfunk (1.4.0)
+    tzinfo (0.3.42)
+    vcr (2.9.3)
+    warden (1.2.3)
+      rack (>= 1.0)
+    webmock (1.20.4)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+    xpath (2.0.0)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  capybara
+  devise
+  factory_girl_rails (~> 4.0)
+  haml-rails
+  jquery-rails
+  koudoku
+  pdf-inspector
+  prawn-rails
+  pry
+  rspec-rails (~> 2.12.2)
+  sqlite3
+  stripe
+  stripe_invoice!
+  vcr
+  webmock

data/Rakefile

@@ -1,33 +1,34 @@
 #!/usr/bin/env rake
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
-begin
-  require 'rdoc/task'
-rescue LoadError
-  require 'rdoc/rdoc'
-  require 'rake/rdoctask'
-  RDoc::Task = Rake::RDocTask
-end
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'StripeInvoice'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
-load 'rails/tasks/engine.rake'
-
-Bundler::GemHelper.install_tasks
-
-require 'rspec/core'
-require 'rspec/core/rake_task'
-desc "Run all specs in spec directory (excluding plugin specs)"
-RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
-
-task :default => :spec
+require "bundler/gem_tasks"
+# begin
+  # require 'bundler/setup'
+# rescue LoadError
+  # puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+# end
+# begin
+  # require 'rdoc/task'
+# rescue LoadError
+  # require 'rdoc/rdoc'
+  # require 'rake/rdoctask'
+  # RDoc::Task = Rake::RDocTask
+# end
+# 
+# RDoc::Task.new(:rdoc) do |rdoc|
+  # rdoc.rdoc_dir = 'rdoc'
+  # rdoc.title    = 'StripeInvoice'
+  # rdoc.options << '--line-numbers'
+  # rdoc.rdoc_files.include('README.rdoc')
+  # rdoc.rdoc_files.include('lib/**/*.rb')
+# end
+# 
+# APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+# load 'rails/tasks/engine.rake'
+# 
+# Bundler::GemHelper.install_tasks
+# 
+# require 'rspec/core'
+# require 'rspec/core/rake_task'
+# desc "Run all specs in spec directory (excluding plugin specs)"
+# RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+# 
+# task :default => :spec

data/app/controllers/stripe_invoice/invoices_controller.rb

@@ -4,59 +4,34 @@ require "prawn-rails"
 module StripeInvoice
   class InvoicesController < ApplicationController
     
+    before_filter :authorize_owner
+    
     def index
-      @owner = send("current_#{::Koudoku.subscriptions_owned_by}")
-      redirect_to '/' unless @owner
-
       @subscription = @owner.subscription
-      if @subscription
-        # I know this looks silly, but Koudoku actually stores the customer's stripe_id 
-        # in the subscription model
-        @stripe_charges = Stripe::Charge.all(
-          :customer => @subscription.stripe_id,
-          :limit => 100)
-
-        @stripe_charges.each do |scharge|
-          scharge_invoice = Stripe::Invoice.retrieve(scharge.invoice) rescue {}
-
-          next if scharge_invoice.blank?
-          # We can use below to get parent_invoice id instead of fetching agin to get exect parent, because parent should come first always.
-          # available_invoices = Invoice.find_all_by_stripe_id(scharge_invoice.id)
-          # available_invoices.first.id
-          invoice_count = Invoice.find_all_by_stripe_id(scharge_invoice.id).count
-          scharge_count = scharge.refunds.count + 1
-          next if scharge_count == invoice_count #Execute next if count is equal. But here we can miss the case if refund get updated.
-          #Do we need to make one flag 'refund_deleted' to manage refund deleted or not ?
-
-          generate_invoice(scharge, @owner, scharge_invoice) if invoice_count==0
-
-          #Check for refund and create invoice
-          if scharge.refunds.present?
-            parent_invoice = Invoice.where({stripe_id: scharge_invoice.id, parent_invoice_id: nil}).first
-            scharge.refunds.each do |scharge_refund|
-              next if Invoice.find_by_stripe_refund_id(scharge_refund.id).present?
-              generate_invoice(scharge, @owner, scharge_invoice, scharge_refund, parent_invoice)
-            end
-          end # if scharge.refunds
-        end
-      end # if subscription
       
-      @invoices = Invoice.where({owner_id: @owner.id, parent_invoice_id: nil}).order('stripe_id, date DESC')
+      @invoices = Charge.where(owner_id: @owner.id).order('date DESC')
     end
     
     def show
-      @owner = send("current_#{::Koudoku.subscriptions_owned_by}")
-      redirect_to '/' unless @owner
-      
-      @invoice = Invoice.find(params[:id])
-      
+      @invoice = Charge.find(params[:id])
+
       respond_to do |format|
         format.html {render layout: false}
         format.pdf
       end
     end
-
+    
+    def tax_report(data)
+      @_response = ActionDispatch::Response.new
+      @data = data
+      render template: 'stripe_invoice/invoices/tax_report', :formats => [:pdf], :locals => {sicharges: data}
+    end
+    
     private
+    def authorize_owner
+      @owner = send("current_#{::Koudoku.subscriptions_owned_by}")
+      redirect_to '/' unless @owner
+    end
 
     def generate_invoice(scharge, owner, scharge_invoice, scharge_refund=nil, parent_invoice=nil)
       amount, stripe_refund_id, parent_invoice_id = scharge_invoice[:total], nil, nil
@@ -66,7 +41,7 @@ module StripeInvoice
         parent_invoice_id = parent_invoice.id if parent_invoice.present?
       end
 
-      Invoice.create({
+      Charge.create({
         stripe_id: scharge_invoice.id,
         owner_id: owner.id, 
         date: scharge.created, 

data/app/delayed_jobs/stripe_invoice/dj_tax_report.rb

@@ -0,0 +1,73 @@
+module StripeInvoice
+  class DJTaxReport
+    def initialize(year = 1.year.ago.year)
+      @year = year
+    end
+    
+    
+    def perform
+      puts "[DJTaxReport] computing tax report for #{@year}"
+      
+      sicharges = StripeInvoice::Charge.where(
+            "date >= ? and date <= ?", 
+            date_to_epoch("#{@year}-01-01"), 
+            date_to_epoch("#{@year}-12-31"))
+            
+      puts "[DJTaxReport] number of charges in year: #{sicharges.size}"
+      arr_data = []
+      sicharges.each do |charge|
+        owner = Koudoku.owner_class.find(charge.owner_id)
+        
+        next unless owner # skip if we don't have an owner
+        
+        data = {
+          charge: charge,
+          bt: Stripe::BalanceTransaction.retrieve(charge.indifferent_json[:balance_transaction]),
+          owner: owner
+        }
+        puts "[DJTaxReport] aggregating data #{charge.stripe_id}"
+        if charge.indifferent_json[:refunds].count > 0
+          arr_refunds = []
+          charge.indifferent_json[:refunds].each do |refund|
+            refd = {
+              refund: refund,
+              bt: Stripe::BalanceTransaction.retrieve(refund[:balance_transaction])
+            }
+            arr_refunds << refd
+          end
+          
+          data[:refunds] = arr_refunds
+          #puts "[DJTaxReport] charge had refunds: #{arr_refunds}"
+        end # has refunds
+        
+        arr_data << data
+      end
+      
+      puts "[DJTaxReport] data collected; rendering view"
+      #res = InvoicesController.new.tax_report arr_data
+      res = Renderer.render template: "stripe_invoice/invoices/tax_report", 
+            locals: {sicharges: arr_data, year: @year, totals: totals(arr_data)}, 
+            formats: [:pdf]
+      
+      #InvoiceMailer.tax_report.deliver!
+    end
+    
+    
+    private 
+    def date_to_epoch(date)
+      Date.strptime(date,"%Y-%m-%d").to_datetime.utc.to_i
+    end
+    
+    def totals(sicharges)
+      result = {
+        transaction_volume: total_transaction_volume(sicharges),
+      }
+    end
+    
+    include ActionView::Helpers::NumberHelper
+    def total_transaction_volume(sicharges)
+      number_to_currency(sicharges.inject(0) {|sum, hash_ch| sum + hash_ch[:bt][:amount]} / 100.0, 
+        unit: "#{sicharges.first[:bt][:currency].upcase} ")
+    end
+  end
+end

data/app/helpers/stripe_invoice/application_helper.rb

@@ -2,7 +2,13 @@ module StripeInvoice
   module ApplicationHelper
     
     def format_timestamp(timestamp)
-      l(Time.at(timestamp).to_datetime, :format => :short_date)
+      dt = timestamp
+      
+      unless timestamp.is_a? DateTime
+        dt = Time.at(timestamp).to_datetime
+      end
+      
+      l(dt, :format => :short_date)
     end
     
     alias_method :ft, :format_timestamp

data/app/helpers/stripe_invoice/invoices_helper.rb

@@ -8,7 +8,7 @@ module StripeInvoice
       # assuming that all currencies are split into 100 parts is probably wrong
       # on an i18n scale but it works for USD, EUR and LBP
       # TODO fix this maybe?
-      amount = amount / 100
+      amount = amount / 100.0
       options = {
         # use comma for euro 
         separator: currency == 'EUR' ? ',' : '.', 

data/app/helpers/stripe_invoice/tax_report_helper.rb

@@ -0,0 +1,16 @@
+module StripeInvoice
+  module TaxReportHelper
+    
+    # takes a Stripe JSON hash and an attribute name and returns a 
+    # nicely formatted string for that currency 
+    def format_stripe_currency(obj, attr_sym = :amount)
+      number_to_currency(obj[attr_sym].to_f / 100, unit: "#{obj[:currency].upcase} ")
+    end
+    
+    
+    def format_billing_address(owner)
+      raise "You need to implement #billing_address on your subscription owner class" unless owner.respond_to? :billing_address
+      owner.billing_address
+    end
+  end
+end

data/app/mailers/stripe_invoice/invoice_mailer.rb

@@ -0,0 +1,35 @@
+module StripeInvoice
+  class InvoiceMailer < ActionMailer::Base
+  
+    # Subject can be set in your I18n file at config/locales/en.yml
+    # with the following lookup:
+    #
+    #   en.invoice_mailer.new_invoice.subject
+    #
+    def new_invoice(charge)
+      @charge = charge
+      
+  
+      mail subject: "new #{I18n.t("config.stripe_invoice.app_name")} invoice available", to: @charge.owner.email
+    end
+    
+    def refund_invoice(charge)
+      @charge = charge
+      
+      mail subject: "We refunded your #{I18n.t("config.stripe_invoice.app_name")} charge", to: @charge.owner.email
+    end
+    
+    
+    def tax_report
+      attachments['tax-report.pdf'] = {
+        content: File.read(::Rails.root.join('tmp', 'tax_report.pdf')),
+        mime_type: "application/pdf"
+      }
+      
+      # sends the email to the default from address
+      addr_to = ActionMailer::Base.default[:from]
+      mail subject: "Tax report", to: addr_to 
+      puts "[InvoiceMailer] tax report sent to #{addr_to}"
+    end
+  end
+end

data/app/models/stripe_invoice/charge.rb

@@ -0,0 +1,79 @@
+module StripeInvoice
+  class Charge < ActiveRecord::Base
+    attr_accessible :id, :invoice_number, :stripe_id, :json, 
+      :owner_id, :date, :amount, :discount, :total, :subtotal, :period_start, 
+      :period_end, :currency 
+    
+    alias_attribute :number, :invoice_number
+
+    serialize :json, JSON
+    
+    def indifferent_json
+     @json ||= json.with_indifferent_access 
+    end
+    
+    def datetime
+      Time.at(date).to_datetime
+    end
+    
+    def owner
+      @owner ||= Koudoku.owner_class.find(owner_id)
+    end
+    
+    def refunds
+      indifferent_json[:refunds]
+    end
+
+    def total_refund
+      refunds.inject(0){ |total,refund| total + refund[:amount]}
+    end
+    
+    # builds the invoice from the stripe CHARGE object
+    # OR updates the existing invoice if an invoice for that id exists
+    def self.create_from_stripe(stripe_charge)
+      charge = Charge.find_by_stripe_id(stripe_charge[:id])
+      
+      raise "won't build for unpaid charges" unless stripe_charge.paid
+      # for existing invoices just update and be done
+      if charge.present?
+        charge.update_attribute(:json, stripe_charge)
+        return charge 
+      end
+      
+      owner = get_subscription_owner stripe_charge
+      
+      return unless owner
+      
+      stripe_invoice = Stripe::Invoice.retrieve stripe_charge[:invoice]
+      last_charge = Charge.last
+      new_charge_number = (last_charge ? (last_charge.id * 7) : 1).to_s.rjust(5, '0')
+      
+      charge_date = Time.at(stripe_charge[:created]).utc.to_datetime
+      
+      charge = Charge.create({
+        stripe_id: stripe_charge[:id], 
+        owner_id: owner.id,
+        date: stripe_charge[:created],
+        amount: stripe_charge[:amount],
+        subtotal: stripe_invoice[:subtotal],
+        discount: stripe_invoice[:discount],
+        total: stripe_invoice[:total],
+        currency: stripe_invoice[:currency],
+        period_start: stripe_invoice[:period_start],
+        period_end: stripe_invoice[:period_end],
+        invoice_number: "#{charge_date.year}-#{new_charge_number}",
+        json: stripe_charge
+      })
+      
+      puts "Charge saved: #{charge.id}"
+    end
+    
+    private 
+    def self.get_subscription_owner(stripe_charge)
+      # ::Subscription is generated by Koudoku, but lives in main_app
+      subscription = ::Subscription.find_by_stripe_id(stripe_charge.customer)
+      return nil if subscription.nil?
+      owner = subscription.subscription_owner 
+    end
+  end
+end

data/app/views/stripe_invoice/invoice_mailer/new_invoice.text.erb

@@ -0,0 +1,7 @@
+Hi there,
+
+There is a new invoice available for you here: <%= invoice_url(@charge, :format => :pdf)%>.
+
+If you find anything wrong with the invoice, please reply to this email. 
+
+Cheers