Name: stripe-ruby-mock
Owner: Particle
Description: A mocking library for testing stripe ruby
Created: 2016-01-13 22:36:59.0
Updated: 2016-01-13 22:37:00.0
Pushed: 2018-01-03 18:48:00.0
Size: 735
Language: Ruby
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
This gem has unexpectedly grown in popularity and I've gotten pretty busy, so I'm currently looking for more core contributors to help me out. If you're interested, there is only one requirement: submit a significant enough pull request and have it merged into master (many of you have already done this). Afterwards, ping me in chat and I will add you as a collaborator.
In your gemfile:
gem 'stripe-ruby-mock', '~> 2.2.1', :require => 'stripe_mock'
STRIPE API TARGET VERSION: 2015-09-08 (master)
Older API version branches:
Since StripeMock tries to keep up with Stripe's API version, its version system is a little different:
WARNING: This library does not cover all Stripe API endpoints. If you need one that's missing, please create an issue for it, or see this wiki page if you're interested in contributing
At its core, this library overrides stripe-ruby's 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:
ire 'stripe_mock'
ribe MyApp do
t(:stripe_helper) { StripeMock.create_test_helper }
fore { StripeMock.start }
ter { StripeMock.stop }
"creates a stripe customer" do
# This doesn't touch stripe's servers nor the internet!
# Specify :source in place of :card (with same value) to return customer with source data
customer = Stripe::Customer.create({
email: 'johnny@appleseed.com',
card: stripe_helper.generate_card_token
})
expect(customer.email).to eq('johnny@appleseed.com')
d
Some Stripe API calls require several parameters. StripeMock helps you keep your test brief with some helpers:
ribe MyApp do
t(:stripe_helper) { StripeMock.create_test_helper }
"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)
d
The available helpers are:
pe_helper.create_plan(my_plan_params)
pe_helper.delete_plan(my_plan_params)
pe_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).
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:
pec 2.x
c.configure do |c|
c.filter_manager.inclusions.keys.include?(:live)
StripeMock.toggle_live(true)
puts "Running **live** tests against Stripe..."
d
With this you can run live tests by running rspec -t live
Here is an example of setting up your RSpec (3.x) test suite to run live with the same command line switch:
pec 3.x
c.configure do |c|
c.filter_manager.inclusions.rules.include?(:live)
StripeMock.toggle_live(true)
puts "Running **live** tests against Stripe..."
d
Tired of manually inputting fake credit card numbers to test against errors? Tire no more!
mocks a declined card error" do
Prepares an error for the next create charge request
ripeMock.prepare_card_error(:card_declined)
pect { Stripe::Charge.create(amount: 1, currency: 'usd') }.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')
peMock.prepare_card_error(:incorrect_number)
peMock.prepare_card_error(:invalid_number)
peMock.prepare_card_error(:invalid_expiry_month)
peMock.prepare_card_error(:invalid_expiry_year)
peMock.prepare_card_error(:invalid_cvc)
peMock.prepare_card_error(:expired_card)
peMock.prepare_card_error(:incorrect_cvc)
peMock.prepare_card_error(:card_declined)
peMock.prepare_card_error(:missing)
peMock.prepare_card_error(:processing_error)
You can see the details of each error in lib/stripe_mock/api/errors.rb
By default, prepare_card_error only triggers for :new_charge, the event that happens when you run Charge.create. More explicitly, this is what happens by default:
peMock.prepare_card_error(:card_declined, :new_charge)
If you want the error to trigger on a different event, you need to replace :new_charge with a different event. For example:
peMock.prepare_card_error(:card_declined, :create_card)
omer = Stripe::Customer.create
is line throws the card error
omer.cards.create
:new_charge and :create_card are names of methods in the StripeMock request handlers. You can also set StripeMock.toggle_debug(true) to see the event name for each Stripe request made in your tests.
To raise an error on a specific type of request, take a look at the request handlers folder 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:
raises a custom error for specific actions" do
stom_error = StandardError.new("Please knock first.")
ripeMock.prepare_error(custom_error, :new_customer)
pect { Stripe::Charge.create(amount: 1, currency: 'usd') }.to_not raise_error
pect { Stripe::Customer.create }.to raise_error {|e|
expect(e).to be_a StandardError
expect(e.message).to eq("Please knock first.")
In the above example, :new_customer is the name of a method from customers.rb.
Sometimes you want your test stripe data to persist for a bit, such as during integration tests running on different processes. In such cases you'll want to start the stripe mock server:
# spec_helper.rb
#
# The mock server will automatically be killed when your tests are done running.
#
require 'thin'
StripeMock.spawn_server
Then, instead of StripeMock.start, you'll want to use StripeMock.start_client:
ribe MyApp do
fore do
@client = StripeMock.start_client
d
ter do
StripeMock.stop_client
# Alternatively:
# @client.close!
# -- Or --
# StripeMock.stop_client(:clear_server_data => true)
d
This is all essentially the same as using StripeMock.start, except that the stripe test
data is held in its own server process.
Here are some other neat things you can do with the client:
ent.state #=> 'ready'
ent.get_server_data(:customers) # Also works for :charges, :plans, etc.
ent.clear_server_data
ent.close!
ent.state #=> 'closed'
TE: Shown below are the default options
peMock.default_server_pid_path = './stripe-mock-server.pid'
peMock.spawn_server(
id_path => StripeMock.default_server_pid_path,
ost => '0.0.0.0',
ort => 4999,
erver => :thin
peMock.kill_server(StripeMock.default_server_pid_path)
If you need the mock server to continue running even after your tests are done, you'll want to use the executable:
$ stripe-mock-server -p 4000
$ stripe-mock-server --help
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:
mocks a stripe webhook" do
ent = StripeMock.mock_webhook_event('customer.created')
stomer_object = event.data.object
pect(customer_object.id).to_not be_nil
pect(customer_object.default_card).to_not be_nil
etc.
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.
For example, you could create a file in spec/fixtures/stripe_webhooks/invoice.created.with-sub.json, copy/paste the default from the default invoice.created.json, and customize it to your needs.
Then you can use that webook directly in your specs:
can use a custom webhook fixture" do
ent = StripeMock.mock_webhook_event('invoice.created.with-sub')
etc.
You can alse override values on the fly:
can override webhook values" do
NOTE: given hash values get merged directly into event.data.object
ent = 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'
pect(event.data.object.id).to eq('cus_my_custom_value')
pect(event.data.object.email).to eq('joe@example.com')
You can name events whatever you like in your spec/fixtures/stripe_webhooks/ folder. However, if you try to call a non-standard event that's doesn't exist in that folder, StripeMock will throw an error.
If you wish to use a different fixture path, you can set it yourself:
StripeMock.webhook_fixture_path = './spec/other/folder/'
Sometimes you need to check if your code reads a stripe card correctly. If so, you can specifically assign card data to a generated card token:
generates a stripe card token" do
rd_token = StripeMock.generate_card_token(last4: "9191", exp_year: 1984)
s = Stripe::Customer.create(source: card_token)
rd = cus.sources.data.first
pect(card.last4).to eq("9191")
pect(card.exp_year).to eq(1984)
To enable debug messages:
StripeMock.toggle_debug(true)
This will only last for the session; Once you call StripeMock.stop or StripeMock.stop_client,
debug will be toggled off.
If you always want debug to be on (it's quite verbose), you should put this in a before block.
You may have noticed that all generated Stripe ids start with test_. If you want to remove this:
rns off test_ prefix
peMock.global_id_prefix = false
you can set your own
peMock.global_id_prefix = 'my_app_'
Stripe::ChargePatches are welcome and greatly appreciated! If you're contributing to fix a problem, be sure to write tests that illustrate the problem being fixed. This will help ensure that the problem remains fixed in future updates.
Copyright (c) 2013 Gilbert
See LICENSE.txt for details.