stripe-ruby-mock 1.8.1.1

data/.gitignore

@@ -0,0 +1,3 @@
+html/
+pkg/
+.DS_Store

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/ChangeLog.rdoc

@@ -0,0 +1,4 @@
+=== 0.1.0 / 2013-04-28
+
+* Initial release:
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2013 Gilbert
+
+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,54 @@
+# stripe-ruby-mock
+
+* Homepage: https://github.com/mindeavor/stripe-ruby-mock#readme
+* Issues: https://github.com/mindeavor/stripe-ruby-mock/issues
+
+## Install
+
+    $ gem install stripe-ruby-mock
+
+## Features
+
+* Easily test against stripe errors
+* No stripe server access required
+
+## Description
+
+** *WARNING: THIS LIBRARY IS INCOMPLETE* **
+
+At its core, this library overrides [stripe-ruby's](https://github.com/stripe/stripe-ruby)
+request method to skip all http calls and
+instead directly return test data. This allows you to write and run tests
+without the need to actually hit stripe's servers.
+
+You can use stripe-ruby-mock with any ruby testing library. Here's a quick dummy example with RSpec:
+
+    require 'stripe'
+    require 'stripe_mock'
+
+    describe MyApp do
+      before { StripeMock.start }
+      after { StripeMock.stop }
+
+      it "should create a stripe customer" do
+
+        # This doesn't touch stripe's servers nor the internet!
+        customer = Stripe::Customer.create({
+          email: 'johnny@appleseed.com',
+          card: 'void_card_token'
+        })
+        expect(customer.email).to eq('johnny@appleseed.com')
+      end
+    end
+
+## TODO
+
+* Cover all stripe urls/methods
+* Mock stripe error responses
+* Create hash for storing/retrieving stripe objects in-memory
+
+## Copyright
+
+Copyright (c) 2013 Gilbert
+
+See LICENSE.txt for details.

data/Rakefile

@@ -0,0 +1,28 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'rake'
+
+begin
+  gem 'rubygems-tasks', '~> 0.2'
+  require 'rubygems/tasks'
+
+  Gem::Tasks.new
+rescue LoadError => e
+  warn e.message
+  warn "Run `gem install rubygems-tasks` to install Gem::Tasks."
+end
+
+begin
+  gem 'rspec', '~> 2.4'
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new
+rescue LoadError => e
+  task :spec do
+    abort "Please run `gem install rspec` to install RSpec."
+  end
+end
+
+task :test    => :spec
+task :default => :spec

data/lib/stripe_mock.rb

@@ -0,0 +1,29 @@
+require 'stripe_mock/version'
+require 'stripe_mock/data'
+require 'stripe_mock/methods'
+
+module StripeMock
+
+  @@init = false
+  @@enabled = false
+
+  def self.start
+    if @@init == false
+      @@request_method = Stripe.method(:request)
+      @@init = true
+    end
+    alias_stripe_method :request, Methods.method(:mock_request)
+    @@enabled = true
+  end
+
+  def self.stop
+    return unless @@enabled == true
+    alias_stripe_method :request, @@request_method
+    @@enabled = false
+  end
+
+  def self.alias_stripe_method(new_name, method_object)
+    Stripe.define_singleton_method(new_name) {|*args| method_object.call(*args) }
+  end
+
+end

data/lib/stripe_mock/data.rb

@@ -0,0 +1,281 @@
+module StripeMock
+  module Data
+
+    def self.test_customer(params)
+      {
+        :subscription_history => [],
+        :bills => [],
+        :charges => [],
+        :livemode => false,
+        :object => "customer",
+        :id => "c_test_customer",
+        :active_card => {
+          :object => "card",
+          :last4 => "4242",
+          :type => "Visa",
+          :exp_month => 12,
+          :exp_year => 2013,
+          :fingerprint => "3TQGpK9JoY1GgXPw",
+          :country => "US",
+          :name => "From Here",
+          :address_line1 => nil,
+          :address_line2 => nil,
+          :address_city => nil,
+          :address_state => nil,
+          :address_zip => nil,
+          :address_country => nil,
+          :cvc_check => "pass",
+          :address_line1_check => nil,
+          :address_zip_check => nil
+        },
+        :created => 1304114758
+      }.merge(params)
+    end
+
+    def self.test_customer_array
+      {
+        :data => [test_customer, test_customer, test_customer],
+        :object => 'list',
+        :url => '/v1/customers'
+      }
+    end
+
+    def self.test_charge(params={})
+      {
+        :refunded => false,
+        :paid => true,
+        :amount => 100,
+        :card => {
+          :type => "Visa",
+          :last4 => "4242",
+          :exp_month => 11,
+          :country => "US",
+          :exp_year => 2012,
+          :id => "cc_test_card",
+          :object => "card"
+        },
+        :id => "ch_test_charge",
+        :reason => "execute_charge",
+        :livemode => false,
+        :currency => "usd",
+        :object => "charge",
+        :created => 1304114826
+      }.merge(params)
+    end
+
+    def self.test_charge_array
+      {
+        :data => [test_charge, test_charge, test_charge],
+        :object => 'list',
+        :url => '/v1/charges'
+      }
+    end
+
+    def self.test_card(params={})
+      {
+        :type => "Visa",
+        :last4 => "4242",
+        :exp_month => 11,
+        :country => "US",
+        :exp_year => 2012,
+        :id => "cc_test_card",
+        :object => "card"
+      }.merge(params)
+    end
+
+    def self.test_coupon(params={})
+      {
+        :duration => 'repeating',
+        :duration_in_months => 3,
+        :percent_off => 25,
+        :id => "co_test_coupon",
+        :object => "coupon"
+      }.merge(params)
+    end
+
+    #FIXME nested overrides would be better than hardcoding plan_id
+    def self.test_subscription(plan_id="gold")
+      {
+        :current_period_end => 1308681468,
+        :status => "trialing",
+        :plan => {
+          :interval => "month",
+          :amount => 7500,
+          :trial_period_days => 30,
+          :object => "plan",
+          :id => plan_id
+        },
+        :current_period_start => 1308595038,
+        :cancel_at_period_end => false,
+        :canceled_at => nil,
+        :start => 1308595038,
+        :object => "subscription",
+        :trial_start => 1308595038,
+        :trial_end => 1308681468,
+        :customer => "c_test_customer",
+        :quantity => 1
+      }
+    end
+
+    def self.test_invoice(params={})
+      {
+        :id => 'in_test_invoice',
+        :object => 'invoice',
+        :livemode => false,
+        :amount_due => 1000,
+        :attempt_count => 0,
+        :attempted => false,
+        :closed => false,
+        :currency => 'usd',
+        :customer => 'c_test_customer',
+        :date => 1349738950,
+        :lines => {
+          "invoiceitems" => [
+            {
+              :id => 'ii_test_invoice_item',
+              :object => '',
+              :livemode => false,
+              :amount => 1000,
+              :currency => 'usd',
+              :customer => 'c_test_customer',
+              :date => 1349738950,
+              :description => "A Test Invoice Item",
+              :invoice => 'in_test_invoice'
+            },
+          ],
+        },
+        :paid => false,
+        :period_end => 1349738950,
+        :period_start => 1349738950,
+        :starting_balance => 0,
+        :subtotal => 1000,
+        :total => 1000,
+        :charge => nil,
+        :discount => nil,
+        :ending_balance => nil,
+        :next_payemnt_attempt => 1349825350,
+      }.merge(params)
+    end
+
+    def self.test_paid_invoice
+      test_invoice.merge({
+          :attempt_count => 1,
+          :attempted => true,
+          :closed => true,
+          :paid => true,
+          :charge => 'ch_test_charge',
+          :ending_balance => 0,
+          :next_payment_attempt => nil,
+        })
+    end
+
+    def self.test_invoice_customer_array
+      {
+        :data => [test_invoice],
+        :object => 'list',
+        :url => '/v1/invoices?customer=test_customer'
+      }
+    end
+
+    def self.test_recipient(params={})
+      {
+        :name => "Stripe User",
+        :type => "individual",
+        :livemode => false,
+        :object => "recipient",
+        :id => "rp_test_recipient",
+        :active_account => {
+          :last4 => "6789",
+          :bank_name => "STRIPE TEST BANK",
+          :country => "US",
+          :object => "bank_account"
+        },
+        :created => 1304114758,
+        :verified => true
+      }.merge(params)
+    end
+
+    def self.test_recipient_array
+      {
+        :data => [test_recipient, test_recipient, test_recipient],
+        :object => 'list',
+        :url => '/v1/recipients'
+      }
+    end
+
+    def self.test_transfer(params={})
+      {
+        :status => 'pending',
+        :amount => 100,
+        :account => {
+          :object => 'bank_account',
+          :country => 'US',
+          :bank_name => 'STRIPE TEST BANK',
+          :last4 => '6789'
+        },
+        :recipient => 'test_recipient',
+        :fee => 0,
+        :fee_details => [],
+        :id => "tr_test_transfer",
+        :livemode => false,
+        :currency => "usd",
+        :object => "transfer",
+        :date => 1304114826
+      }.merge(params)
+    end
+
+    def self.test_transfer_array
+      {
+        :data => [test_transfer, test_transfer, test_transfer],
+        :object => 'list',
+        :url => '/v1/transfers'
+      }
+    end
+
+    def self.test_invalid_api_key_error
+      {
+        "error" => {
+          "type" => "invalid_request_error",
+          "message" => "Invalid API Key provided: invalid"
+        }
+      }
+    end
+
+    def self.test_invalid_exp_year_error
+      {
+        "error" => {
+          "code" => "invalid_expiry_year",
+          "param" => "exp_year",
+          "type" => "card_error",
+          "message" => "Your card's expiration year is invalid"
+        }
+      }
+    end
+
+    def self.test_missing_id_error
+      {
+        :error => {
+          :param => "id",
+          :type => "invalid_request_error",
+          :message => "Missing id"
+        }
+      }
+    end
+
+    def self.test_api_error
+      {
+        :error => {
+          :type => "api_error"
+        }
+      }
+    end
+
+    def self.test_delete_discount_response
+      {
+        :deleted => true,
+        :id => "di_test_coupon"
+      }
+    end
+
+  end
+end

data/lib/stripe_mock/methods.rb

@@ -0,0 +1,25 @@
+module StripeMock
+  module Methods
+
+    def self.mock_request(method, url, api_key, params={}, headers={})
+      return {} if method == :xtest
+
+      # Ordered from most specific to least specific
+      case "#{method} #{url}"
+      when 'post /v1/customers'
+        Data.test_customer(params)
+      when 'post /v1/invoiceitems'
+        Data.test_invoice(params)
+      when %r{post /v1/customers/(.*)/subscription}
+        Data.test_subscription(params[:plan])
+      when %r{get /v1/customers/(.*)}
+        Data.test_customer :id => $1
+      else
+        puts "WARNING: Unrecognized method + url: [#{method} #{url}]"
+        puts " params: #{params}"
+        {}
+      end
+    end
+
+  end
+end

data/lib/stripe_mock/version.rb

@@ -0,0 +1,4 @@
+module StripeMock
+  # stripe-ruby-mock version
+  VERSION = "1.8.1.1"
+end

data/spec/mock_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+require 'stripe_mock'
+
+describe StripeMock do
+
+  before { StripeMock.start }
+  after  { StripeMock.stop }
+
+  it "should override stripe's request method" do
+    Stripe.request(:xtest, '/', 'abcde') # no error
+  end
+
+  it "should revert overriding stripe's request method" do
+    Stripe.request(:xtest, '/', 'abcde') # no error
+    StripeMock.stop
+    expect { Stripe.request(:x, '/', 'abcde') }.to raise_error
+  end
+
+  it "should create a stripe customer" do
+    customer = Stripe::Customer.create({
+      email: 'johnny@appleseed.com',
+      card: 'some_card_token',
+      description: "a description"
+    })
+    expect(customer.email).to eq('johnny@appleseed.com')
+    expect(customer.description).to eq('a description')
+  end
+
+  it "should retrieve a stripe customer" do
+    customer = Stripe::Customer.retrieve("test_customer")
+    expect(customer.id).to eq('test_customer')
+  end
+
+  it "should update a stripe customer's subscription" do
+    customer = Stripe::Customer.retrieve("test_customer")
+    sub = customer.update_subscription({ :plan => 'silver' })
+
+    expect(sub.object).to eq('subscription')
+    expect(sub.plan.identifier).to eq('silver')
+  end
+
+  it "should create a stripe invoice item" do
+    invoice = Stripe::InvoiceItem.create({
+      amount: 1099,
+      customer: 1234,
+      currency: 'USD',
+      description: "invoice desc"
+    }, 'abcde')
+
+    expect(invoice.amount).to eq(1099)
+    expect(invoice.description).to eq('invoice desc')
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+gem 'rspec', '~> 2.4'
+require 'rspec'
+require 'stripe'
+require 'stripe_mock/version'

data/stripe-ruby-mock.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path('../lib/stripe_mock/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "stripe-ruby-mock"
+  gem.version       = StripeMock::VERSION
+  gem.summary       = %q{TDD with stripe}
+  gem.description   = %q{A drop-in library to test stripe without hitting their servers}
+  gem.license       = "MIT"
+  gem.authors       = ["Gilbert"]
+  gem.email         = "gilbertbgarza@gmail.com"
+  gem.homepage      = "https://github.com/mindeavor/stripe-ruby-mock#readme"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'stripe', '~> 1.8.1'
+
+  gem.add_development_dependency 'rspec', '~> 2.4'
+  gem.add_development_dependency 'rubygems-tasks', '~> 0.2'
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: stripe-ruby-mock
+version: !ruby/object:Gem::Version
+  version: 1.8.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Gilbert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: stripe
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: A drop-in library to test stripe without hitting their servers
+email: gilbertbgarza@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- ChangeLog.rdoc
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/stripe_mock.rb
+- lib/stripe_mock/data.rb
+- lib/stripe_mock/methods.rb
+- lib/stripe_mock/version.rb
+- spec/mock_spec.rb
+- spec/spec_helper.rb
+- stripe-ruby-mock.gemspec
+homepage: https://github.com/mindeavor/stripe-ruby-mock#readme
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: TDD with stripe
+test_files:
+- spec/mock_spec.rb
+- spec/spec_helper.rb