stripe-ruby-mock 1.10.1.7 → 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e0b68df0cf8a9bb5fcc7743fe4dd1983cf4bd0a3
+  data.tar.gz: 4a10d0bbbf8b53ebb4dbf86875b4c2cc35191c15
+SHA512:
+  metadata.gz: acce1dfcefe02aab720f6ae0b489bd25fbef197d50bc0b4b57971264ce14fbad3c6b42a4cd379d12bba6ada203f81f037e49e11277a7db5af227b023729268db
+  data.tar.gz: e206a8a69476fd96a82e42a53f16855ce9645a97b0dee81b6dd714dee78b25a2646f30e2b516908c1529b2df8bddca8dc786945d24951b0631305ba54343ad39

data/.gitignore

@@ -3,3 +3,4 @@ pkg/
 .DS_Store
 stripe-mock-server.pid
 Gemfile.lock
+stripe-mock-server.log

data/README.md

@@ -8,13 +8,25 @@
 
 In your gemfile:
 
-    gem 'stripe-ruby-mock', '~> 1.10.1.7'
+    gem 'stripe-ruby-mock', '~> 2.0.0'
 
 ## Features
 
 * No stripe server access required
 * Easily test against stripe errors
 * Mock and customize stripe webhooks
+* Flip a switch to run your tests against Stripe's **live test servers**
+
+### Specifications
+
+**STRIPE API TARGET VERSION:** 2014-06-17
+
+* Strict params: Plan, Token#create
+
+## TODO BEFORE MERGE
+
+* Strictify params: Customer#create
+* Require existing card tokens
 
 ## Description
 
@@ -31,6 +43,7 @@ You can use stripe-ruby-mock with any ruby testing library. Here's a quick dummy
 require 'stripe_mock'
 
 describe MyApp do
+  let(:stripe_helper) { StripeMock.create_test_helper }
   before { StripeMock.start }
   after { StripeMock.stop }
 
@@ -39,13 +52,65 @@ describe MyApp do
     # This doesn't touch stripe's servers nor the internet!
     customer = Stripe::Customer.create({
       email: 'johnny@appleseed.com',
-      card: 'void_card_token'
+      card: stripe_helper.generate_card_token
     })
     expect(customer.email).to eq('johnny@appleseed.com')
   end
 end
 ```
 
+## Test Helpers
+
+Some Stripe API calls require several parameters. StripeMock helps you keep your test brief with some helpers:
+
+```ruby
+describe MyApp do
+  let(:stripe_helper) { StripeMock.create_test_helper }
+
+  it "creates a stripe plan" do
+    plan = stripe_helper.create_plan(:id => 'my_plan', :amount => 1500)
+
+    # The above line replaces the following:
+    # plan = Stripe::Plan.create(
+    #   :id => 'my_plan',
+    #   :name => 'StripeMock Default Plan ID',
+    #   :amount => 1500,
+    #   :currency => 'usd',
+    #   :interval => 'month'
+    # )
+    expect(plan.id).to eq('my_plan')
+    expect(plan.amount).to eq(1500)
+  end
+end
+```
+
+The [available helpers](lib/stripe_mock/test_strategies/) are:
+
+```ruby
+stripe_helper.create_plan(my_plan_params)
+stripe_helper.delete_plan(my_plan_params)
+stripe_helper.generate_card_token(my_card_params)
+```
+
+For everything else, use Stripe as you normally would (i.e. use Stripe as if you were not using StripeMock).
+
+## Live Testing
+
+Every once in a while you want to make sure your tests are actually valid. StripeMock has a switch that allows you to run your test suite (or a subset thereof) against Stripe's live test servers.
+
+Here is an example of setting up your RSpec (2.x) test suite to run live with a command line switch:
+
+```ruby
+RSpec.configure do |c|
+  if c.filter_manager.inclusions.keys.include?(:live)
+    puts "Running **live** tests against Stripe..."
+    StripeMock.toggle_live(true)
+  end
+end
+```
+
+With this you can run live tests by running `rspec -t live`
+
 ## Mocking Card Errors
 
 Tired of manually inputting fake credit card numbers to test against errors? Tire no more!
@@ -97,7 +162,7 @@ customer = Stripe::Customer.create
 customer.cards.create
 ```
 
-`:new_charge` and `:create_card` are names of methods in the [StripeMock request handlers](lib/stripe_mock/request_handlers). You can also set `StripeMock.debug(true)` to see the event name for each Stripe request made in your tests.
+`:new_charge` and `:create_card` are names of methods in the [StripeMock request handlers](lib/stripe_mock/request_handlers). You can also set `StripeMock.toggle_debug(true)` to see the event name for each Stripe request made in your tests.
 
 ### Custom Errors
 
@@ -289,6 +354,7 @@ StripeMock.global_id_prefix = 'my_app_'
 * Cover all stripe urls/methods
 * Throw useful errors that emulate Stripe's requirements
   * For example: "You must supply either a card or a customer id" for `Stripe::Charge`
+* Fingerprinting for other resources besides Cards
 
 ## Developing stripe-ruby-mock
 
@@ -296,6 +362,7 @@ To run the tests:
 
     $ bundle install
     $ bundle exec rspec
+    $ bundle exec rspec -t live # Runs certain tests against Stripe's servers
 
 Patches are welcome and greatly appreciated! If you're contributing to fix a problem,
 be sure to write tests that illustrate the problem being fixed.

data/Rakefile

@@ -14,7 +14,7 @@ rescue LoadError => e
 end
 
 begin
-  gem 'rspec', '~> 2.4'
+  gem 'rspec', '~> 3.1'
   require 'rspec/core/rake_task'
 
   RSpec::Core::RakeTask.new

data/lib/stripe_mock/api/client.rb

@@ -3,6 +3,7 @@ module StripeMock
   def self.client; @client; end
 
   def self.start_client(port=4999)
+    return false if @state == 'live'
     return @client unless @client.nil?
 
     alias_stripe_method :request, StripeMock.method(:redirect_to_mock_server)

data/lib/stripe_mock/api/instance.rb

@@ -5,6 +5,7 @@ module StripeMock
   @original_request_method = Stripe.method(:request)
 
   def self.start
+    return false if @state == 'live'
     @instance = Instance.new
     alias_stripe_method :request, @instance.method(:mock_request)
     @state = 'local'

data/lib/stripe_mock/api/live.rb

@@ -0,0 +1,15 @@
+module StripeMock
+
+  def self.toggle_live(toggle)
+    if @state != 'ready' && @state != 'live'
+      raise "You cannot toggle StripeMock live when it has already started."
+    end
+    if toggle
+      @state = 'live'
+      StripeMock.set_default_test_helper_strategy(:live)
+    else
+      @state = 'ready'
+      StripeMock.set_default_test_helper_strategy(:mock)
+    end
+  end
+end

data/lib/stripe_mock/api/server.rb

@@ -1,30 +1,33 @@
 module StripeMock
 
-  @default_pid_path = './stripe-mock-server.pid'
-  @default_log_path = './stripe-mock-server.log'
+  @default_server_pid_path = './stripe-mock-server.pid'
+  @default_server_log_path = './stripe-mock-server.log'
 
-  def self.default_server_pid_path; @default_pid_path; end
-  def self.default_server_pid_path=(new_path)
-    @default_pid_path = new_path
-  end
+  class << self
+    attr_writer :default_server_pid_path, :default_server_log_path
 
+    ["pid", "log"].each do |config_type|
+      define_method("default_server_#{config_type}_path") do
+        instance_variable_get("@default_server_#{config_type}_path") || "./stripe-mock-server.#{config_type}"
+      end
+    end
 
-  def self.spawn_server(opts={})
-    pid_path = opts[:pid_path] || @default_pid_path
-    log_path = opts[:log_path] || @default_log_path
+    def spawn_server(opts={})
+      pid_path = opts[:pid_path] || default_server_pid_path
+      log_path = opts[:log_path] || default_server_log_path
 
-    Dante::Runner.new('stripe-mock-server').execute(
-      :daemonize => true, :pid_path => pid_path, :log_path => log_path
-    ){
-      StripeMock::Server.start_new(opts)
-    }
-    at_exit { kill_server(pid_path) }
-  end
+      Dante::Runner.new('stripe-mock-server').execute(
+        :daemonize => true, :pid_path => pid_path, :log_path => log_path
+      ){
+        StripeMock::Server.start_new(opts)
+      }
+      at_exit { kill_server(pid_path) }
+    end
 
-  def self.kill_server(pid_path=nil)
-    puts "Killing server at #{pid_path}"
-    path = pid_path || @default_pid_path
-    Dante::Runner.new('stripe-mock-server').execute(:kill => true, :pid_path => path)
+    def kill_server(pid_path=nil)
+      puts "Killing server at #{pid_path}"
+      path = pid_path || default_server_pid_path
+      Dante::Runner.new('stripe-mock-server').execute(:kill => true, :pid_path => path)
+    end
   end
-
 end

data/lib/stripe_mock/api/test_helpers.rb

@@ -0,0 +1,24 @@
+module StripeMock
+
+  def self.create_test_helper(strategy=nil)
+    if strategy
+      get_test_helper_strategy(strategy).new
+    elsif @__test_strat
+      @__test_strat.new
+    else
+      TestStrategies::Mock.new
+    end
+  end
+
+  def self.set_default_test_helper_strategy(strategy)
+    @__test_strat = get_test_helper_strategy(strategy)
+  end
+
+  def self.get_test_helper_strategy(strategy)
+    case strategy.to_sym
+    when :mock then TestStrategies::Mock
+    when :live then TestStrategies::Live
+    else raise "Invalid test helper strategy: #{strategy.inspect}"
+    end
+  end
+end

data/lib/stripe_mock/client.rb

@@ -40,14 +40,6 @@ module StripeMock
       timeout_wrap { @pipe.debug? }
     end
 
-    def set_server_strict(toggle)
-      timeout_wrap { @pipe.set_strict(toggle) }
-    end
-
-    def server_strict?
-      timeout_wrap { @pipe.strict? }
-    end
-
     def set_server_global_id_prefix(value)
       timeout_wrap { @pipe.set_global_id_prefix(value) }
     end
@@ -68,6 +60,10 @@ module StripeMock
       timeout_wrap { Stripe::Util.symbolize_names @pipe.generate_webhook_event(event_data) }
     end
 
+    def destroy_resource(type, id)
+      timeout_wrap { @pipe.destroy_resource(type, id) }
+    end
+
     def clear_server_data
       timeout_wrap { @pipe.clear_data }
     end

data/lib/stripe_mock/data.rb

@@ -31,8 +31,9 @@ module StripeMock
     end
 
     def self.mock_charge(params={})
+      charge_id = params[:id] || "ch_1fD6uiR9FAA2zc"
       {
-        id: "ch_1fD6uiR9FAA2zc",
+        id: charge_id,
         object: "charge",
         created: 1366194027,
         livemode: false,
@@ -47,6 +48,7 @@ module StripeMock
           object: "card",
           last4: "4242",
           type: "Visa",
+          brand: "Visa",
           exp_month: 12,
           exp_year: 2013,
           fingerprint: "3TQGpK9JoY1GgXPw",
@@ -63,29 +65,37 @@ module StripeMock
           address_zip_check: nil
         },
         captured: params.has_key?(:capture) ? params.delete(:capture) : true,
+        refunds: {
+          object: "list",
+          total_count: 0,
+          has_more: false,
+          url: "/v1/charges/#{charge_id}/refunds",
+          data: []
+        },
+        balance_transaction: "txn_2dyYXXP90MN26R",
         failure_message: nil,
+        failure_code: nil,
         amount_refunded: 0,
         customer: nil,
         invoice: nil,
         description: nil,
-        dispute: nil
+        dispute: nil,
+        metadata: {
+        }
       }.merge(params)
     end
 
     def self.mock_refund(params={})
-      mock_charge.merge({
-        refunded: true,
-        refunds: [
-          {
-            amount: params[:amount],
-            currency: "usd",
-            created: 1380208998,
-            object: "refund",
-            balance_transaction: "txn_2dyYXXP90MN26R"
-          }
-        ],
-        amount_refunded: params[:amount]
-      })
+      {
+        id: "re_4fWhgUh5si7InF",
+        amount: 1,
+        currency: "usd",
+        created: 1409165988,
+        object: "refund",
+        balance_transaction: "txn_4fWh2RKvgxcXqV",
+        metadata: {},
+        charge: "ch_4fWhYjzQ23UFWT"
+      }.merge(params)
     end
 
     def self.mock_charge_array
@@ -102,6 +112,7 @@ module StripeMock
         object: "card",
         last4: "4242",
         type: "Visa",
+        brand: "Visa",
         exp_month: 4,
         exp_year: 2016,
         fingerprint: "wXWJT135mEK107G8",
@@ -170,7 +181,8 @@ module StripeMock
         :trial_start => 1308595038,
         :trial_end => 1308681468,
         :customer => "c_test_customer",
-        :quantity => 1
+        :quantity => 1,
+        :metadata => {}
       }, params)
     end
 
@@ -230,7 +242,7 @@ module StripeMock
 
     def self.mock_invoice_item(params = {})
       {
-        id: "ii_test",
+        id: "test_ii",
         object: "invoiceitem",
         date: 1349738920,
         amount: 1099,
@@ -279,21 +291,32 @@ module StripeMock
       }.merge(params)
     end
 
-    def self.mock_recipient(params={})
+    def self.mock_recipient(cards, params={})
+      rp_id = params[:id] || "test_rp_default"
+      cards.each {|card| card[:recipient] = rp_id}
       {
-        :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"
+        name: "Stripe User",
+        type: "individual",
+        livemode: false,
+        object: "recipient",
+        id: rp_id,
+        active_account: {
+          last4: "6789",
+          bank_name: "STRIPE TEST BANK",
+          country: "US",
+          object: "bank_account"
+        },
+        created: 1304114758,
+        verified: true,
+        metadata: {
+        },
+        cards: {
+          object: "list",
+          count: cards.count,
+          url: "/v1/recipients/#{rp_id}/cards",
+          data: cards
         },
-        :created => 1304114758,
-        :verified => true
+        default_card: nil
       }.merge(params)
     end
 
@@ -317,6 +340,7 @@ module StripeMock
           :object => 'card',
           :last4 => '2222',
           :type => 'Visa',
+          :brand => 'Visa',
           :exp_month => 9,
           :exp_year => 2017,
           :fingerprint => 'JRRLXGh38NiYygM7',

data/lib/stripe_mock/instance.rb

@@ -2,6 +2,7 @@ module StripeMock
   class Instance
 
     include StripeMock::RequestHandlers::Helpers
+    include StripeMock::RequestHandlers::ParamValidators
 
     # Handlers are ordered by priority
     @@handlers = []
@@ -31,9 +32,9 @@ module StripeMock
 
 
     attr_reader :bank_tokens, :charges, :coupons, :customers, :events,
-                :invoices, :plans, :recipients, :subscriptions
+                :invoices, :invoice_items, :plans, :recipients, :subscriptions
 
-    attr_accessor :error_queue, :debug, :strict
+    attr_accessor :error_queue, :debug
 
     def initialize
       @bank_tokens = {}
@@ -43,6 +44,7 @@ module StripeMock
       @coupons = {}
       @events = {}
       @invoices = {}
+      @invoice_items = {}
       @plans = {}
       @recipients = {}
       @subscriptions = {}
@@ -50,7 +52,10 @@ module StripeMock
       @debug = false
       @error_queue = ErrorQueue.new
       @id_counter = 0
-      @strict = true
+      @balance_transaction_counter = 0
+
+      # This is basically a cache for ParamValidators
+      @base_strategy = TestStrategies::Base.new
     end
 
     def mock_request(method, url, api_key, params={}, headers={})
@@ -63,6 +68,7 @@ module StripeMock
 
       if handler = Instance.handler_for_method_url(method_url)
         if @debug == true
+          puts "- - - - " * 8
           puts "[StripeMock req]::#{handler[:name]} #{method} #{url}"
           puts "                  #{params}"
         end
@@ -90,12 +96,11 @@ module StripeMock
     private
 
     def assert_existance(type, id, obj, message=nil)
-      return unless @strict == true
-
       if obj.nil?
         msg = message || "No such #{type}: #{id}"
         raise Stripe::InvalidRequestError.new(msg, type.to_s, 404)
       end
+      obj
     end
 
     def new_id(prefix)
@@ -103,6 +108,11 @@ module StripeMock
       "#{StripeMock.global_id_prefix}#{prefix}_#{@id_counter += 1}"
     end
 
+    def new_balance_transaction(prefix)
+      # balance transaction ids must be strings
+      "#{StripeMock.global_id_prefix}#{prefix}_#{@balance_transaction_counter += 1}"
+    end
+
     def symbolize_names(hash)
       Stripe::Util.symbolize_names(hash)
     end

data/lib/stripe_mock/request_handlers/cards.rb

@@ -3,53 +3,64 @@ module StripeMock
     module Cards
 
       def Cards.included(klass)
+        klass.add_handler 'get /v1/customers/(.*)/cards', :retrieve_cards
         klass.add_handler 'post /v1/customers/(.*)/cards', :create_card
         klass.add_handler 'get /v1/customers/(.*)/cards/(.*)', :retrieve_card
         klass.add_handler 'delete /v1/customers/(.*)/cards/(.*)', :delete_card
         klass.add_handler 'post /v1/customers/(.*)/cards/(.*)', :update_card
+        klass.add_handler 'get /v1/recipients/(.*)/cards/(.*)', :retrieve_recipient_card
       end
 
       def create_card(route, method_url, params, headers)
         route =~ method_url
-
-        customer = customers[$1]
-        assert_existance :customer, $1, customer
+        customer = assert_existance :customer, $1, customers[$1]
 
         card = card_from_params(params[:card])
-        add_card_to_customer(card, customer)
+        add_card_to_object(:customer, card, customer)
+      end
+
+      def retrieve_cards(route, method_url, params, headers)
+        route =~ method_url
+        customer = assert_existance :customer, $1, customers[$1]
+
+        cards = customer[:cards]
+        cards[:count] = cards[:data].length
+        cards
       end
 
       def retrieve_card(route, method_url, params, headers)
         route =~ method_url
+        customer = assert_existance :customer, $1, customers[$1]
 
-        customer = customers[$1]
-        assert_existance :customer, $1, customer
-        card = get_customer_card(customer, $2)
-        assert_existance :card, $2, card
-        card
+        assert_existance :card, $2, get_card(customer, $2)
+      end
+
+      def retrieve_recipient_card(route, method_url, params, headers)
+        route =~ method_url
+        recipient = assert_existance :recipient, $1, recipients[$1]
+
+        assert_existance :card, $2, get_card(recipient, $2, "Recipient")
       end
 
       def delete_card(route, method_url, params, headers)
         route =~ method_url
+        customer = assert_existance :customer, $1, customers[$1]
+
+        assert_existance :card, $2, get_card(customer, $2)
 
-        customer = customers[$1]
-        assert_existance :customer, $1, customer
-        card = get_customer_card(customer, $2)
-        assert_existance :card, $2, card
         card = { id: $2, deleted: true }
-        customer[:cards][:data].reject!{|cc| 
+        customer[:cards][:data].reject!{|cc|
           cc[:id] == card[:id]
         }
+        customer[:default_card] = customer[:cards][:data].count > 0 ? customer[:cards][:data].first[:id] : nil
         card
       end
 
       def update_card(route, method_url, params, headers)
         route =~ method_url
+        customer = assert_existance :customer, $1, customers[$1]
 
-        customer = customers[$1]
-        assert_existance :customer, $1, customer
-        card = get_customer_card(customer, $2)
-        assert_existance :card, $2, card
+        card = assert_existance :card, $2, get_card(customer, $2)
         card.merge!(params)
         card
       end

data/lib/stripe_mock/request_handlers/charges.rb

@@ -8,6 +8,7 @@ module StripeMock
         klass.add_handler 'get /v1/charges/(.*)',           :get_charge
         klass.add_handler 'post /v1/charges/(.*)/capture',  :capture_charge
         klass.add_handler 'post /v1/charges/(.*)/refund',   :refund_charge
+        klass.add_handler 'post /v1/charges/(.*)/refunds',  :create_refund
       end
 
       def new_charge(route, method_url, params, headers)
@@ -15,9 +16,11 @@ module StripeMock
 
         if params[:card] && params[:card].is_a?(String)
           params[:card] = get_card_by_token(params[:card])
+        elsif params[:card] && params[:card][:id]
+          raise Stripe::InvalidRequestError.new("Invalid token id: #{params[:card]}", 'card', 400)
         end
 
-        charges[id] = Data.mock_charge(params.merge :id => id)
+        charges[id] = Data.mock_charge(params.merge :id => id, :balance_transaction => new_balance_transaction('txn'))
       end
 
       def get_charges(route, method_url, params, headers)
@@ -36,21 +39,46 @@ module StripeMock
       def get_charge(route, method_url, params, headers)
         route =~ method_url
         assert_existance :charge, $1, charges[$1]
-        charges[$1] ||= Data.mock_charge(:id => $1)
       end
 
       def capture_charge(route, method_url, params, headers)
         route =~ method_url
-        charge = charges[$1]
-        assert_existance :charge, $1, charge
+        charge = assert_existance :charge, $1, charges[$1]
+
+        if params[:amount]
+          refund = Data.mock_refund(
+            :balance_transaction => new_balance_transaction('txn'),
+            :id => new_id('re'),
+            :amount => charge[:amount] - params[:amount]
+          )
+          add_refund_to_charge(refund, charge)
+        end
 
         charge[:captured] = true
         charge
       end
 
       def refund_charge(route, method_url, params, headers)
-        route =~ method_url
-        charge = Data.mock_refund(params)
+        charge = get_charge(route, method_url, params, headers)
+
+        refund = Data.mock_refund params.merge(
+          :balance_transaction => new_balance_transaction('txn'),
+          :id => new_id('re')
+        )
+        add_refund_to_charge(refund, charge)
+        charge
+      end
+
+      def create_refund(route, method_url, params, headers)
+        charge = get_charge(route, method_url, params, headers)
+
+        refund = Data.mock_refund params.merge(
+          :balance_transaction => new_balance_transaction('txn'),
+          :id => new_id('re'),
+          :charge => charge[:id]
+        )
+        add_refund_to_charge(refund, charge)
+        refund
       end
 
     end

data/lib/stripe_mock/request_handlers/coupons.rb

@@ -17,13 +17,11 @@ module StripeMock
       def get_coupon(route, method_url, params, headers)
         route =~ method_url
         assert_existance :coupon, $1, coupons[$1]
-        coupons[$1] ||= Data.mock_coupon(:id => $1)
       end
 
       def delete_coupon(route, method_url, params, headers)
         route =~ method_url
-        assert_existance :coupon, $1, coupons[$1]
-        coupons.delete($1)
+        assert_existance :coupon, $1, coupons.delete($1)
       end
 
       def list_coupons(route, method_url, params, headers)