mustwin-stripe-ruby-mock 1.8.4.10

data/.gitignore

@@ -0,0 +1,5 @@
+html/
+pkg/
+.DS_Store
+stripe-mock-server.pid
+Gemfile.lock

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+script: "bundle exec rake"

data/ChangeLog.rdoc

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

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+group :test do
+  gem 'rake'
+end
+
+gemspec

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,264 @@
+# stripe-ruby-mock [![Build Status](https://travis-ci.org/rebelidealist/stripe-ruby-mock.png?branch=master)](https://travis-ci.org/rebelidealist/stripe-ruby-mock)
+
+* Homepage: https://github.com/rebelidealist/stripe-ruby-mock
+* Issues: https://github.com/rebelidealist/stripe-ruby-mock/issues
+
+## Install
+
+In your gemfile:
+
+    gem 'stripe-ruby-mock', '>= 1.8.4.9'
+
+## Features
+
+* No stripe server access required
+* Easily test against stripe errors
+* Mock and customize stripe webhooks
+
+## Description
+
+** *WARNING: This library does not cover all Stripe API endpoints. If you need one that's missing, please create an issue for it.* **
+
+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:
+
+```ruby
+require 'stripe_mock'
+
+describe MyApp do
+  before { StripeMock.start }
+  after { StripeMock.stop }
+
+  it "creates 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
+```
+
+## 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 create charge request
+  StripeMock.prepare_card_error(:card_declined)
+
+  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
+```
+
+### Built-In Card Errors
+
+```ruby
+StripeMock.prepare_card_error(:incorrect_number)
+StripeMock.prepare_card_error(:invalid_number)
+StripeMock.prepare_card_error(:invalid_expiry_month)
+StripeMock.prepare_card_error(:invalid_expiry_year)
+StripeMock.prepare_card_error(:invalid_cvc)
+StripeMock.prepare_card_error(:expired_card)
+StripeMock.prepare_card_error(:incorrect_cvc)
+StripeMock.prepare_card_error(:card_declined)
+StripeMock.prepare_card_error(:missing)
+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
+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`:
+
+```ruby
+describe MyApp do
+  before do
+    @client = StripeMock.start_client
+  end
+
+  after do
+    StripeMock.stop_client
+    # Alternatively:
+    #   @client.close!
+    # -- Or --
+    #   StripeMock.stop_client(:clear_server_data => true)
+  end
+end
+```
+
+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:
+
+```ruby
+@client.state #=> 'ready'
+
+@client.get_server_data(:customers) # Also works for :charges, :plans, etc.
+@client.clear_server_data
+
+@client.close!
+@client.state #=> 'closed'
+```
+
+### Mock Server Options
+
+```ruby
+# NOTE: Shown below are the default options
+StripeMock.default_server_pid_path = './stripe-mock-server.pid'
+
+StripeMock.spawn_server(
+  :pid_path => StripeMock.default_server_pid_path,
+  :host => '0.0.0.0',
+  :port => 4999,
+  :server => :thin
+)
+
+StripeMock.kill_server(StripeMock.default_server_pid_path)
+```
+
+### Mock Server Command
+
+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
+
+## 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 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
+  # NOTE: given hash values get merged directly into event.data.object
+  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
+```
+
+## Generating Card Tokens
+
+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:
+
+```ruby
+it "generates a stripe card token" do
+  card_token = StripeMock.generate_card_token(last4: "9191", exp_year: 1984)
+
+  cus = Stripe::Customer.create(card: card_token)
+  card = cus.cards.data.first
+  expect(card.last4).to eq("9191")
+  expect(card.exp_year).to eq(1984)
+end
+```
+
+## Debugging
+
+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.
+
+## TODO
+
+* 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`
+
+## Developing stripe-ruby-mock
+
+To run the tests:
+
+    $ rspec
+
+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.
+This will help ensure that the problem remains fixed in future updates.
+
+## 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/bin/stripe-mock-server

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+
+require 'trollop'
+
+opts = Trollop::options do
+  opt :port, "Listening port", :type => :int, :default => 4999
+  opt :host, "Host to listen on", :type => :string, :default => '0.0.0.0'
+  opt :server, "Server to use", :type => :string, :default => 'thin'
+  opt :debug, "Request and response output", :default => true
+  opt :pid_path, "Location to put server pid file", :type => :string, :default => './stripe-mock-server.pid'
+end
+
+require 'stripe_mock'
+require 'stripe_mock/server'
+
+StripeMock::Server.start_new(opts)

data/lib/stripe_mock.rb

@@ -0,0 +1,46 @@
+require 'ostruct'
+require 'jimson-temp'
+require 'dante'
+
+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'
+require 'stripe_mock/errors/uninitialized_instance_error'
+require 'stripe_mock/errors/unstarted_state_error'
+require 'stripe_mock/errors/server_timeout_error'
+require 'stripe_mock/errors/closed_client_connection_error'
+
+require 'stripe_mock/client'
+require 'stripe_mock/server'
+
+require 'stripe_mock/api/instance'
+require 'stripe_mock/api/client'
+require 'stripe_mock/api/server'
+require 'stripe_mock/api/card_tokens'
+require 'stripe_mock/api/errors'
+require 'stripe_mock/api/webhooks'
+require 'stripe_mock/api/strict'
+require 'stripe_mock/api/debug'
+
+require 'stripe_mock/request_handlers/charges.rb'
+require 'stripe_mock/request_handlers/customers.rb'
+require 'stripe_mock/request_handlers/invoice_items.rb'
+require 'stripe_mock/request_handlers/plans.rb'
+require 'stripe_mock/instance'
+
+module StripeMock
+
+  lib_dir = File.expand_path(File.dirname(__FILE__), '../..')
+  @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/lib/stripe_mock/api/card_tokens.rb

@@ -0,0 +1,22 @@
+module StripeMock
+
+  def self.generate_card_token(card_params)
+    if @state == 'local'
+      instance.generate_card_token(card_params)
+    elsif @state == 'remote'
+      client.generate_card_token(card_params)
+    else
+      raise UnstartedStateError
+    end
+  end
+
+  def self.generate_recipient_token(recipient_params)
+    if @state == 'local'
+      instance.generate_recipient_token(recipient_params)
+    elsif @state == 'remote'
+      client.generate_recipient_token(recipient_params)
+    else
+      raise UnstartedStateError
+    end
+  end
+end

data/lib/stripe_mock/api/client.rb

@@ -0,0 +1,37 @@
+module StripeMock
+
+  def self.client; @client; end
+
+  def self.start_client(port=4999)
+    return @client unless @client.nil?
+
+    alias_stripe_method :request, StripeMock.method(:redirect_to_mock_server)
+    @client = StripeMock::Client.new(port)
+    @state = 'remote'
+    @client
+  end
+
+  def self.stop_client(opts={})
+    return false unless @state == 'remote'
+    @state = 'ready'
+
+    alias_stripe_method :request, @original_request_method
+    @client.clear_server_data if opts[:clear_server_data] == true
+    @client.cleanup
+    @client = nil
+    true
+  end
+
+  private
+
+  def self.redirect_to_mock_server(method, url, api_key, params={}, headers={})
+    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)
+  end
+
+end