stripe-ruby-mock 1.8.3.7 → 1.8.3.8

data/README.md

@@ -165,6 +165,53 @@ you'll want to use the executable:
     $ stripe-mock-server -p 4000
     $ stripe-mock-server --help
 
+## Mocking Webhooks
+
+If your application handles stripe webhooks, you are most likely retrieving the event from
+stripe and passing the result to a handler. StripeMock helps you by easily mocking that event:
+
+```ruby
+it "mocks a stripe webhook" do
+  event = StripeMock.mock_webhook_event('customer.created')
+
+  customer_object = event.data.object
+  expect(customer_object.id).to_not be_nil
+  expect(customer_object.active_card).to_not be_nil
+  # etc.
+end
+```
+
+### Customizing Webhooks
+
+By default, StripeMock searches in your `spec/fixtures/stripe_webhooks/` folder for your own, custom webhooks.
+If it finds nothing, it falls back to [test events generated through stripe's webhooktester](lib/stripe_mock/webhook_fixtures/).
+
+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:
+
+    StripeMock.webhook_fixture_path = './spec/other/folder/'
+
+Also, you can override values whenever you create any webhook event:
+
+```ruby
+it "can override default webhook values" do
+  event = StripeMock.mock_webhook_event('customer.created', {
+    :data => {
+      :object => {
+        :id => 'cus_my_custom_value',
+        :email => 'joe@example.com'
+      }
+    }
+  })
+  # Alternatively:
+  # event.data.object.id = 'cus_my_custome_value'
+  # event.data.object.email = 'joe@example.com'
+  expect(event.data.object.id).to eq('cus_my_custome_value')
+  expect(event.data.object.email).to eq('joe@example.com')
+end
+```
+
 ## TODO
 
 * Cover all stripe urls/methods

data/lib/stripe_mock/api/webhooks.rb

@@ -1,14 +1,23 @@
 module StripeMock
 
   def self.mock_webhook_event(type, params={})
-    unless Webhooks.event_list.include?(type)
-      raise UnsupportedRequestError.new "Unsupported webhook event `#{type}`"
+
+    fixture_file = File.join(@webhook_fixture_path, "#{type}.json")
+
+    if File.exists?(fixture_file) == false
+      unless Webhooks.event_list.include?(type)
+        raise UnsupportedRequestError.new "Unsupported webhook event `#{type}` (Searched in #{@webhook_fixture_path})"
+      end
+      fixture_file = File.join(@webhook_fixture_fallback_path, "#{type}.json")
     end
-    json = MultiJson.load  File.read  File.join(@webhook_fixture_path, "#{type}.json")
+
+    json = MultiJson.load  File.read(fixture_file)
 
     json = Stripe::Util.symbolize_names(json)
     params = Stripe::Util.symbolize_names(params)
-    Stripe::Event.construct_from Util.rmerge(json, params)
+    json[:data][:object] = Util.rmerge(json[:data][:object], params)
+
+    Stripe::Event.construct_from(json)
   end
 
   module Webhooks

data/lib/stripe_mock/util.rb

@@ -20,4 +20,3 @@ module StripeMock
 
   end
 end
-

data/lib/stripe_mock/version.rb

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

data/lib/stripe_mock.rb

@@ -31,6 +31,12 @@ require 'stripe_mock/request_handlers/plans.rb'
 require 'stripe_mock/instance'
 
 module StripeMock
+
   lib_dir = File.expand_path(File.dirname(__FILE__), '../..')
-  @webhook_fixture_path = File.join(lib_dir, 'stripe_mock/webhook_fixtures')
+  @webhook_fixture_path = './spec/fixtures/stripe_webhooks/'
+  @webhook_fixture_fallback_path = File.join(lib_dir, 'stripe_mock/webhook_fixtures')
+
+  class << self
+    attr_accessor :webhook_fixture_path
+  end
 end

data/spec/_dummy/webhooks/dummy.event.json

@@ -0,0 +1,6 @@
+{
+  "val": "success",
+  "data": {
+    "object": {}
+  }
+}

data/spec/fixtures/stripe_webhooks/account.updated.json

@@ -0,0 +1,7 @@
+{
+  "id": "evt_123",
+  "type": "account.updated",
+  "data": {
+    "object": {}
+  }
+}

data/spec/fixtures/stripe_webhooks/custom.account.updated.json

@@ -0,0 +1,5 @@
+{
+  "data": {
+    "object": {}
+  }
+}

data/spec/readme_spec.rb

@@ -55,4 +55,25 @@ describe 'README examples' do
     StripeMock.prepare_card_error(:processing_error)
   end
 
+  it "mocks a stripe webhook" do
+    event = StripeMock.mock_webhook_event('customer.created')
+
+    customer_object = event.data.object
+    expect(customer_object.id).to_not be_nil
+    expect(customer_object.active_card).to_not be_nil
+    # etc.
+  end
+
+  it "can override default webhook values" do
+    event = StripeMock.mock_webhook_event('customer.created', {
+      :id => 'cus_my_custom_value',
+      :email => 'joe@example.com'
+    })
+    # Alternatively:
+    # event.data.object.id = 'cus_my_custom_value'
+    # event.data.object.email = 'joe@example.com'
+    expect(event.data.object.id).to eq('cus_my_custom_value')
+    expect(event.data.object.email).to eq('joe@example.com')
+  end
+
 end

data/spec/webhook_spec.rb

@@ -5,38 +5,54 @@ describe 'Webhook Generation' do
   it "matches the list of webhooks with the folder of fixtures" do
     events = StripeMock::Webhooks.event_list.to_set
     file_names = Dir['./lib/stripe_mock/webhook_fixtures/*'].map {|f| File.basename(f, '.json')}.to_set
+    # The reason we take the difference instead of compare equal is so
+    # that a missing event name will show up in the test failure report.
     expect(events - file_names).to eq(Set.new)
     expect(file_names - events).to eq(Set.new)
   end
 
+
+  it "first looks in spec/fixtures/stripe_webhooks/ for fixtures by default" do
+    event = StripeMock.mock_webhook_event('account.updated')
+    expect(event).to be_a(Stripe::Event)
+    expect(event.id).to eq('evt_123')
+    expect(event.type).to eq('account.updated')
+  end
+
+  it "allows non-standard event names in the project fixture folder" do
+    expect {
+      event = StripeMock.mock_webhook_event('custom.account.updated')
+    }.to_not raise_error
+  end
+
+  it "allows configuring the project fixture folder" do
+    StripeMock.webhook_fixture_path = './spec/_dummy/webhooks/'
+    expect(StripeMock.webhook_fixture_path).to eq('./spec/_dummy/webhooks/')
+
+    event = StripeMock.mock_webhook_event('dummy.event')
+    expect(event.val).to eq('success')
+  end
+
   it "generates an event" do
     event = StripeMock.mock_webhook_event('customer.created')
     expect(event).to be_a(Stripe::Event)
   end
 
-  it "takes a hash and deep merges" do
+  it "takes a hash and deep merges into the data object" do
     event = StripeMock.mock_webhook_event('customer.created', {
-      :data => {
-        :object => {
-          :account_balance => 12345
-        }
-      }
+      :account_balance => 12345
     })
     expect(event.data.object.account_balance).to eq(12345)
   end
 
-  it "takes a hash and deep merges arrays" do
+  it "takes a hash and deep merges arrays in the data object" do
     event = StripeMock.mock_webhook_event('invoice.created', {
-      :data => {
-        :object => {
-          :lines => {
-            :data => [
-              { :amount => 555,
-                :plan => { :id => 'wh_test' }
-              }
-            ]
+      :lines => {
+        :data => [
+          { :amount => 555,
+            :plan => { :id => 'wh_test' }
           }
-        }
+        ]
       }
     })
     expect(event.data.object.lines.data.first.amount).to eq(555)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stripe-ruby-mock
 version: !ruby/object:Gem::Version
-  version: 1.8.3.7
+  version: 1.8.3.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-19 00:00:00.000000000 Z
+date: 2013-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: stripe
@@ -162,6 +162,9 @@ files:
 - lib/stripe_mock/webhook_fixtures/transfer.paid.json
 - lib/stripe_mock/webhook_fixtures/transfer.updated.json
 - lib/trollop.rb
+- spec/_dummy/webhooks/dummy.event.json
+- spec/fixtures/stripe_webhooks/account.updated.json
+- spec/fixtures/stripe_webhooks/custom.account.updated.json
 - spec/instance_spec.rb
 - spec/readme_spec.rb
 - spec/server_spec.rb
@@ -202,6 +205,9 @@ signing_key:
 specification_version: 3
 summary: TDD with stripe
 test_files:
+- spec/_dummy/webhooks/dummy.event.json
+- spec/fixtures/stripe_webhooks/account.updated.json
+- spec/fixtures/stripe_webhooks/custom.account.updated.json
 - spec/instance_spec.rb
 - spec/readme_spec.rb
 - spec/server_spec.rb