stripe-ruby-mock 1.8.3.10 → 1.8.3.11

data/README.md

@@ -42,39 +42,20 @@ describe MyApp do
 end
 ```
 
-## Mocking Errors
+## Mocking Card Errors
 
 Tired of manually inputting fake credit card numbers to test against errors? Tire no more!
 
 ```ruby
 it "mocks a declined card error" do
-  # Prepares an error for the next stripe request
+  # Prepares an error for the next create charge request
   StripeMock.prepare_card_error(:card_declined)
 
-  begin
-    # Note: The next request of ANY type will raise your prepared error
-    Stripe::Charge.create()
-  rescue Stripe::CardError => error
-    expect(error.http_status).to eq(402)
-    expect(error.code).to eq('card_declined')
-  end
-end
-```
-
-You can also set your own custom Stripe error using `prepare_error`:
-
-```ruby
-it "raises a custom error" do
-  custom_error = Stripe::AuthenticationError.new('Did not provide favourite colour', 400)
-  StripeMock.prepare_error(custom_error)
-
-  begin
-    # Note: The next request of ANY type will raise your prepared error
-    Stripe::Invoice.create()
-  rescue Stripe::AuthenticationError => error
-    expect(error.http_status).to eq(400)
-    expect(error.message).to eq('Did not provide favourite colour')
-  end
+  expect { Stripe::Charge.create }.to raise_error {|e|
+    expect(e).to be_a Stripe::CardError
+    expect(e.http_status).to eq(402)
+    expect(e.code).to eq('card_declined')
+  }
 end
 ```
 
@@ -95,6 +76,28 @@ StripeMock.prepare_card_error(:processing_error)
 
 You can see the details of each error in [lib/stripe_mock/api/errors.rb](lib/stripe_mock/api/errors.rb)
 
+### Custom Errors
+
+To raise an error on a specific type of request, take a look at the [request handlers folder](lib/stripe_mock/request_handlers/) and pass a method name to `StripeMock.prepare_error`.
+
+If you wanted to raise an error for creating a new customer, for instance, you would do the following:
+
+```ruby
+it "raises a custom error for specific actions" do
+  custom_error = StandardError.new("Please knock first.")
+
+  StripeMock.prepare_error(custom_error, :new_customer)
+
+  expect { Stripe::Charge.create }.to_not raise_error
+  expect { Stripe::Customer.create }.to raise_error {|e|
+    expect(e).to be_a StandardError
+    expect(e.message).to eq("Please knock first.")
+  }
+end
+```
+
+In the above example, `:new_customer` is the name of a method from [customers.rb](lib/stripe_mock/request_handlers/customers.rb).
+
 ## Running the Mock Server
 
 Sometimes you want your test stripe data to persist for a bit, such as during integration tests
@@ -186,7 +189,7 @@ If it finds nothing, it falls back to [test events generated through stripe's we
 
 You can name events whatever you like in your `spec/fixtures/stripe_webhooks/` folder. However, if you try to call a non-existant event that's not in that folder, StripeMock will throw an error.
 
-If you wish to use a different fixture path, you can call set it yourself:
+If you wish to use a different fixture path, you can set it yourself:
 
     StripeMock.webhook_fixture_path = './spec/other/folder/'
 

data/lib/stripe_mock.rb

@@ -7,6 +7,7 @@ require 'stripe'
 require 'stripe_mock/version'
 require 'stripe_mock/data'
 require 'stripe_mock/util'
+require 'stripe_mock/error_queue'
 
 require 'stripe_mock/errors/stripe_mock_error'
 require 'stripe_mock/errors/unsupported_request_error'

data/lib/stripe_mock/api/client.rb

@@ -25,11 +25,13 @@ module StripeMock
   private
 
   def self.redirect_to_mock_server(method, url, api_key, params={}, headers={})
-    if @remote_state_pending_error
-      raise @remote_state_pending_error
-      @remote_state_pending_error = nil
+    handler = Instance.handler_for_method_url("#{method} #{url}")
+    mock_error = client.error_queue.error_for_handler_name(handler[:name])
+    if mock_error
+      client.error_queue.dequeue
+      raise mock_error
     end
-    Stripe::Util.symbolize_names @client.mock_request(method, url, api_key, params, headers)
+    Stripe::Util.symbolize_names client.mock_request(method, url, api_key, params, headers)
   end
 
 end

data/lib/stripe_mock/api/errors.rb

@@ -1,10 +1,12 @@
 module StripeMock
 
-  def self.prepare_error(stripe_error)
+  def self.prepare_error(stripe_error, *handler_names)
+    handler_names.push(:all) if handler_names.count == 0
+
     if @state == 'local'
-      instance.pending_error = stripe_error
+      instance.error_queue.queue(stripe_error, handler_names)
     elsif @state == 'remote'
-      @remote_state_pending_error = stripe_error
+      client.error_queue.queue(stripe_error, handler_names)
     else
       raise UnstartedStateError
     end
@@ -13,10 +15,11 @@ module StripeMock
   def self.prepare_card_error(code)
     args = CardErrors.argument_map[code]
     raise StripeMockError.new("Unrecognized stripe card error code: #{code}") if args.nil?
-    self.prepare_error  Stripe::CardError.new(*args)
+    self.prepare_error  Stripe::CardError.new(*args), :new_charge
   end
 
   module CardErrors
+
     def self.argument_map
       @__map ||= {
         incorrect_number: ["The card number is incorrect", 'number', 'incorrect_number', 402],

data/lib/stripe_mock/client.rb

@@ -1,7 +1,7 @@
 module StripeMock
 
   class Client
-    attr_reader :port, :state
+    attr_reader :port, :state, :error_queue
 
     def initialize(port)
       @port = port
@@ -9,6 +9,7 @@ module StripeMock
       # Ensure client can connect to server
       timeout_wrap { @pipe.ping }
       @state = 'ready'
+      @error_queue = ErrorQueue.new
     end
 
     def mock_request(method, url, api_key, params={}, headers={})

data/lib/stripe_mock/error_queue.rb

@@ -0,0 +1,23 @@
+module StripeMock
+  class ErrorQueue
+
+    def initialize
+      @queue = []
+    end
+
+    def queue(error, handler_names)
+      @queue << handler_names.map {|n| [n, error]}
+    end
+
+    def error_for_handler_name(handler_name)
+      return nil if @queue.count == 0
+      triggers = @queue.first
+      (triggers.assoc(:all) || triggers.assoc(handler_name) || [])[1]
+    end
+
+    def dequeue
+      @queue.shift
+    end
+
+  end
+end

data/lib/stripe_mock/instance.rb

@@ -11,14 +11,18 @@ module StripeMock
       }
     end
 
+    def self.handler_for_method_url(method_url)
+      @@handlers.find {|h| method_url =~ h[:route] }
+    end
+
     include StripeMock::RequestHandlers::Charges
     include StripeMock::RequestHandlers::Customers
     include StripeMock::RequestHandlers::InvoiceItems
     include StripeMock::RequestHandlers::Plans
 
 
-    attr_reader :charges, :customers, :plans
-    attr_accessor :pending_error, :debug, :strict
+    attr_reader :charges, :customers, :plans, :error_queue
+    attr_accessor :debug, :strict
 
     def initialize
       @customers = {}
@@ -26,7 +30,7 @@ module StripeMock
       @plans = {}
 
       @id_counter = 0
-      @pending_error = nil
+      @error_queue = ErrorQueue.new
       @debug = false
       @strict = true
     end
@@ -42,15 +46,14 @@ module StripeMock
         puts "                 #{params}"
       end
 
-      if @pending_error
-        raise @pending_error
-        @pending_error = nil
-      end
-
       method_url = "#{method} #{url}"
-      handler = @@handlers.find {|h| method_url =~ h[:route] }
+      handler = Instance.handler_for_method_url(method_url)
+      mock_error = @error_queue.error_for_handler_name(handler[:name])
 
-      if handler
+      if handler && mock_error
+        @error_queue.dequeue
+        raise mock_error
+      elsif handler
         res = self.send(handler[:name], handler[:route], method_url, params, headers)
         puts "[StripeMock res] #{res}" if @debug == true
         [res, api_key]

data/lib/stripe_mock/version.rb

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

data/spec/readme_spec.rb

@@ -16,30 +16,14 @@ describe 'README examples' do
 
 
   it "mocks a declined card error" do
-    # Prepares an error for the next stripe request
+    # Prepares an error for the next create charge request
     StripeMock.prepare_card_error(:card_declined)
 
-    begin
-      # Note: The next request of ANY type will raise your prepared error
-      Stripe::Charge.create()
-    rescue Stripe::CardError => error
-      expect(error.http_status).to eq(402)
-      expect(error.code).to eq('card_declined')
-    end
-  end
-
-
-  it "raises a custom error" do
-    custom_error = Stripe::AuthenticationError.new('Did not provide favourite colour', 400)
-    StripeMock.prepare_error(custom_error)
-
-    begin
-      # Note: The next request of ANY type will raise your prepared error
-      Stripe::Invoice.create()
-    rescue Stripe::AuthenticationError => error
-      expect(error.http_status).to eq(400)
-      expect(error.message).to eq('Did not provide favourite colour')
-    end
+    expect { Stripe::Charge.create }.to raise_error {|e|
+      expect(e).to be_a Stripe::CardError
+      expect(e.http_status).to eq(402)
+      expect(e.code).to eq('card_declined')
+    }
   end
 
   it "has built-in card errors" do

data/spec/shared_stripe_examples/error_mocks.rb

@@ -11,8 +11,7 @@ end
 
 shared_examples 'Stripe Error Mocking' do
 
-  it "mocks a manually gives stripe card error" do
-
+  it "mocks a manually given stripe card error" do
     error = Stripe::CardError.new('Test Msg', 'param_name', 'bad_code', 444, 'body', 'json body')
     StripeMock.prepare_error(error)
 
@@ -47,11 +46,10 @@ shared_examples 'Stripe Error Mocking' do
 
 
   it "mocks a manually gives stripe invalid auth error" do
-
     error = Stripe::AuthenticationError.new('Bad Auth', 499, 'abody', 'json abody')
     StripeMock.prepare_error(error)
 
-    expect { Stripe::Invoice.create() }.to raise_error {|e|
+    expect { Stripe::Plan.create() }.to raise_error {|e|
       expect(e).to be_a(Stripe::AuthenticationError)
       expect(e.message).to eq('Bad Auth')
 
@@ -62,6 +60,17 @@ shared_examples 'Stripe Error Mocking' do
   end
 
 
+  it "raises a custom error for specific actions" do
+    custom_error = StandardError.new("Please knock first.")
+    StripeMock.prepare_error(custom_error, :new_customer)
+
+    expect { Stripe::Charge.create }.to_not raise_error
+    expect { Stripe::Customer.create }.to raise_error {|e|
+      expect(e).to be_a StandardError
+      expect(e.message).to eq("Please knock first.")
+    }
+  end
+
   # # # # # # # # # # # # # #
   # Card Error Helper Methods
   # # # # # # # # # # # # # #
@@ -72,6 +81,12 @@ shared_examples 'Stripe Error Mocking' do
     }
   end
 
+  it "only raises a card error when a card charge is attempted" do
+    StripeMock.prepare_card_error(:card_declined)
+    expect { Stripe::Customer.create(id: 'x') }.to_not raise_error
+    expect { Stripe::Charge.create() }.to raise_error Stripe::CardError
+  end
+
   it "mocks an incorrect number card error" do
     StripeMock.prepare_card_error(:incorrect_number)
     expect_card_error 'incorrect_number', 'number'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stripe-ruby-mock
 version: !ruby/object:Gem::Version
-  version: 1.8.3.10
+  version: 1.8.3.11
   prerelease: 
 platform: ruby
 authors:
@@ -115,6 +115,7 @@ files:
 - lib/stripe_mock/api/webhooks.rb
 - lib/stripe_mock/client.rb
 - lib/stripe_mock/data.rb
+- lib/stripe_mock/error_queue.rb
 - lib/stripe_mock/errors/closed_client_connection_error.rb
 - lib/stripe_mock/errors/server_timeout_error.rb
 - lib/stripe_mock/errors/stripe_mock_error.rb