stripe-ruby-mock 1.8.3.3 → 1.8.3.4

data/README.md

@@ -14,7 +14,7 @@
 
 ## Description
 
-** *WARNING: THIS LIBRARY IS INCOMPLETE* **
+** *WARNING: THIS LIBRARY IS INCOMPLETE AND IN ACTIVE DEVELOPMENT* **
 
 At its core, this library overrides [stripe-ruby's](https://github.com/stripe/stripe-ruby)
 request method to skip all http calls and
@@ -24,7 +24,6 @@ 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'
 require 'stripe_mock'
 
 describe MyApp do
@@ -45,7 +44,7 @@ end
 
 ## Mocking Errors
 
-Tired of manually inputting fake credit card numbers to test against errors? Tire no longer!
+Tired of manually inputting fake credit card numbers to test against errors? Tire no more!
 
 ```ruby
 it "mocks a declined card error" do
@@ -96,11 +95,56 @@ 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)
 
+## 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:
+
+    $ stripe-mock-server # Default port is 4999
+    $ stripe-mock-server 4000
+
+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!
+    # 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.set_server_debug(true)
+@client.get_server_data(:customers) # Also works for :charges, :plans, etc.
+@client.clear_server_data
+
+@client.close!
+@client.state #=> 'closed'
+```
+
 ## TODO
 
 * Cover all stripe urls/methods
 * Create hash for storing/retrieving all stripe objects in-memory
   * Currently implemented for: **Customers**, **Charges**, and **Plans**
+* Throw useful errors that emulate Stripe's
+  * For example: "You must supply either a card or a customer id" for `Stripe::Charge`
 
 ## Copyright
 

data/bin/stripe-mock-server

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+
+args = ARGV.dup
+ARGV.clear
+port = (args.shift || 4999).to_i
+
+require 'stripe_mock'
+require 'stripe_mock/server'
+
+StripeMock.start_server(port)

data/lib/stripe_mock/api/client.rb

@@ -0,0 +1,29 @@
+module StripeMock
+
+  def self.client; @client; end
+
+  def self.start_client(port=4999)
+    alias_stripe_method :request, StripeMock.method(:redirect_to_mock_server)
+    @client = 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_data if opts[:clear_server_data] == true
+    @client.close!
+    @client = nil
+    true
+  end
+
+  private
+
+  def self.redirect_to_mock_server(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

@@ -14,7 +14,7 @@ module StripeMock
   private
 
   def self.card_error_args
-    @__map = {
+    @__map ||= {
       incorrect_number: ["The card number is incorrect", 'number', 'incorrect_number', 402],
       invalid_number: ["The card number is not a valid credit card number", 'number', 'invalid_number', 402],
       invalid_expiry_month: ["The card's expiration month is invalid", 'exp_month', 'invalid_expiry_month', 402],

data/lib/stripe_mock/api/instance.rb

@@ -1,27 +1,27 @@
 module StripeMock
 
-  @@first_start = true
-  @@instance = nil
+  @state = 'ready'
+  @instance = nil
+  @original_request_method = Stripe.method(:request)
 
   def self.start
-    if @@first_start == true
-      @@original_request_method = Stripe.method(:request)
-      @@first_start = false
-    end
-    @@instance = Instance.new
-    alias_stripe_method :request, @@instance.method(:mock_request)
+    @instance = Instance.new
+    alias_stripe_method :request, @instance.method(:mock_request)
+    @state = 'local'
   end
 
   def self.stop
-    return if @@instance.nil?
-    alias_stripe_method :request, @@original_request_method
-    @@instance = nil
+    return unless @state == 'local'
+    alias_stripe_method :request, @original_request_method
+    @instance = nil
+    @state = 'ready'
   end
 
   def self.alias_stripe_method(new_name, method_object)
     Stripe.define_singleton_method(new_name) {|*args| method_object.call(*args) }
   end
 
-  def self.instance; @@instance; end
+  def self.instance; @instance; end
+  def self.state; @state; end
 
 end

data/lib/stripe_mock/client.rb

@@ -0,0 +1,48 @@
+module StripeMock
+
+  class Client
+    attr_reader :port, :state
+
+    def initialize(port)
+      @port = port
+      @pipe = Jimson::Client.new("http://0.0.0.0:#{port}")
+      # Ensure client can connect to server
+      timeout_wrap { @pipe.ping }
+      @state = 'ready'
+    end
+
+    def mock_request(method, url, api_key, params={}, headers={})
+      timeout_wrap { @pipe.mock_request(method, url, api_key, params, headers) }
+    end
+
+    def get_server_data(key)
+      timeout_wrap { @pipe.get_data(key) }
+    end
+
+    def set_server_debug(toggle)
+      timeout_wrap { @pipe.set_debug(toggle) }
+    end
+
+    def clear_server_data
+      timeout_wrap { @pipe.clear }
+    end
+
+    def close!
+      @state = 'closed'
+      StripeMock.stop_client(:clear_server_data => false)
+    end
+
+    def timeout_wrap
+      raise ClosedClientConnectionError if @state == 'closed'
+      yield
+    rescue ClosedClientConnectionError
+      raise
+    rescue Errno::ECONNREFUSED => e
+      raise StripeMock::ServerTimeoutError.new(e)
+    rescue StandardError => e
+      puts "Unexpected StripeMock Client Error: #{e.inspect}"
+      {}
+    end
+  end
+
+end

data/lib/stripe_mock/errors/closed_client_connection_error.rb

@@ -0,0 +1,9 @@
+module StripeMock
+  class ClosedClientConnectionError < StripeMockError
+
+    def initialize
+      super("This StripeMock client has already been closed.")
+    end
+
+  end
+end

data/lib/stripe_mock/errors/server_timeout_error.rb

@@ -0,0 +1,12 @@
+module StripeMock
+  class ServerTimeoutError < StripeMockError
+
+    attr_reader :associated_error
+
+    def initialize(associated_error)
+      @associated_error = associated_error
+      super("Unable to connect to stripe mock server (did you forget to run `$ stripe-mock-server`?)")
+    end
+
+  end
+end

data/lib/stripe_mock/instance.rb

@@ -18,7 +18,7 @@ module StripeMock
 
 
     attr_reader :charges, :customers, :plans
-    attr_accessor :pending_error
+    attr_accessor :pending_error, :debug
 
     def initialize
       @customers = {}
@@ -27,11 +27,20 @@ module StripeMock
 
       @id_counter = 0
       @pending_error = nil
+      @debug = false
     end
 
     def mock_request(method, url, api_key, params={}, headers={})
       return {} if method == :xtest
 
+      # Ensure params hash has symbols as keys
+      params = Stripe::Util.symbolize_names(params)
+
+      if @debug == true
+        puts "[StripeMock req] #{method} #{url}"
+        puts "                 #{params}"
+      end
+
       if @pending_error
         raise @pending_error
         @pending_error = nil
@@ -41,7 +50,9 @@ module StripeMock
       handler = @@handlers.find {|h| method_url =~ h[:route] }
 
       if handler
-        self.send  handler[:name],  handler[:route], method_url, params, headers
+        self.send(handler[:name], handler[:route], method_url, params, headers).tap {|json|
+          puts "[StripeMock res] #{json}" if @debug == true
+        }
       else
         puts "WARNING: Unrecognized method + url: [#{method} #{url}]"
         puts " params: #{params}"
@@ -51,9 +62,9 @@ module StripeMock
 
     private
 
-    def new_id
+    def new_id(prefix)
       # Stripe ids must be strings
-      (@id_counter += 1).to_s
+      "test_#{prefix}_#{@id_counter += 1}"
     end
 
   end

data/lib/stripe_mock/request_handlers/charges.rb

@@ -8,7 +8,7 @@ module StripeMock
       end
 
       def new_charge(route, method_url, params, headers)
-        id = new_id
+        id = new_id('ch')
         charges[id] = Data.test_charge(params.merge :id => id)
       end
 

data/lib/stripe_mock/request_handlers/customers.rb

@@ -11,7 +11,7 @@ module StripeMock
       end
 
       def new_customer(route, method_url, params, headers)
-        id = new_id
+        id = new_id('cus')
         customers[id] = Data.test_customer(params.merge :id => id)
       end
 

data/lib/stripe_mock/request_handlers/plans.rb

@@ -8,7 +8,7 @@ module StripeMock
       end
 
       def new_plan(route, method_url, params, headers)
-        params[:id] ||= new_id
+        params[:id] ||= new_id('plan')
         plans[ params[:id] ] = Data.test_plan(params)
       end
 

data/lib/stripe_mock/server.rb

@@ -0,0 +1,42 @@
+require 'thin'
+require 'jimson-temp'
+
+module StripeMock
+
+  def self.start_server(port=4999)
+    server = Jimson::Server.new(Server.new,
+      :host => '0.0.0.0',
+      :port => port,
+      :server => :thin,
+      :show_errors => true
+    )
+    server.start
+  end
+
+  class Server
+    extend Jimson::Handler
+
+    def initialize
+      self.clear_data
+    end
+
+    def mock_request(*args)
+      @instance.mock_request(*args)
+    end
+
+    def get_data(key)
+      @instance.send(key)
+    end
+
+    def clear_data
+      @instance = Instance.new
+    end
+
+    def set_debug(toggle)
+      @instance.debug = toggle
+    end
+
+    def ping; true; end
+  end
+
+end

data/lib/stripe_mock/version.rb

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

data/lib/stripe_mock.rb

@@ -1,12 +1,19 @@
 require 'ostruct'
+require 'jimson-temp'
+require 'stripe'
 
 require 'stripe_mock/version'
 require 'stripe_mock/data'
 
 require 'stripe_mock/errors/stripe_mock_error'
 require 'stripe_mock/errors/uninitialized_instance_error'
+require 'stripe_mock/errors/server_timeout_error'
+require 'stripe_mock/errors/closed_client_connection_error'
+
+require 'stripe_mock/client'
 
 require 'stripe_mock/api/instance'
+require 'stripe_mock/api/client'
 require 'stripe_mock/api/errors'
 
 require 'stripe_mock/request_handlers/charges.rb'

data/spec/instance_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe StripeMock::Instance do
+
+  before { StripeMock.start }
+  after { StripeMock.stop }
+
+  it "handles both string and symbol hash keys" do
+    string_params = {
+      "id" => "str_abcde",
+      :name => "String Plan"
+    }
+    res = StripeMock.instance.mock_request('post', '/v1/plans', 'api_key', string_params)
+    expect(res[:id]).to eq('str_abcde')
+    expect(res[:name]).to eq('String Plan')
+  end
+
+end

data/spec/server_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+
+describe 'StripeMock Server' do
+
+  before(:all) do
+    Dante::Runner.new('stripe-mock-server').execute(
+      :daemonize => true, :pid_path => './stripe-mock-server.pid'
+    ){
+      StripeMock.start_server(4999)
+    }
+  end
+
+  after(:all) do
+    Dante::Runner.new('stripe-mock-server').execute(
+      :kill => true, :pid_path => './stripe-mock-server.pid'
+    )
+  end
+
+
+  before do
+    @client = StripeMock.start_client
+  end
+
+  after { StripeMock.stop_client }
+
+
+  it "uses an RPC client for mock requests" do
+    charge = Stripe::Charge.create(
+      amount: 987,
+      currency: 'USD',
+      card: 'card_token_abcde',
+      description: 'card charge'
+    )
+    expect(charge.amount).to eq(987)
+    expect(charge.currency).to eq('USD')
+    expect(charge.description).to eq('card charge')
+  end
+
+
+  it "should not clear server data in between client sessions by default" do
+    customer = Stripe::Customer.create(email: 'johnny@appleseed.com')
+    expect(customer.email).to eq('johnny@appleseed.com')
+
+    server_customer_data = StripeMock.client.get_server_data(:customers)[customer.id]
+    expect(server_customer_data).to_not be_nil
+    expect(server_customer_data['email']).to eq('johnny@appleseed.com')
+
+    StripeMock.stop_client
+    StripeMock.start_client
+
+    server_customer_data = StripeMock.client.get_server_data(:customers)[customer.id]
+    expect(server_customer_data).to_not be_nil
+    expect(server_customer_data['email']).to eq('johnny@appleseed.com')
+  end
+
+
+  it "returns a response with symbolized hash keys" do
+    response = StripeMock.redirect_to_mock_server('get', '/v1/plans/x', 'xxx')
+    response.keys.each {|k| expect(k).to be_a(Symbol) }
+  end
+
+
+  it "can toggle debug" do
+    StripeMock.client.set_server_debug(true)
+    StripeMock.client.set_server_debug(false)
+    StripeMock.client.set_server_debug(true)
+  end
+
+
+  it "raises an error when client is stopped" do
+    expect(@client).to be_a StripeMock::Client
+    expect(@client.state).to eq('ready')
+
+    StripeMock.stop_client
+    expect(@client.state).to eq('closed')
+    expect { @client.clear_server_data }.to raise_error StripeMock::ClosedClientConnectionError
+  end
+
+
+  it "raises an error when client connection is closed" do
+    expect(@client).to be_a StripeMock::Client
+    expect(@client.state).to eq('ready')
+
+    @client.close!
+    expect(@client.state).to eq('closed')
+    expect(StripeMock.stop_client).to eq(false)
+  end
+
+
+  it "throws an error when server is not running" do
+    StripeMock.stop_client
+    begin
+      StripeMock.start_client(1515)
+      # We should never get here
+      expect(false).to eq(true)
+    rescue StripeMock::ServerTimeoutError => e
+      expect(e.associated_error).to be_a(Errno::ECONNREFUSED)
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -2,3 +2,5 @@ gem 'rspec', '~> 2.4'
 require 'rspec'
 require 'stripe'
 require 'stripe_mock'
+require 'stripe_mock/server'
+require 'dante'

data/spec/stripe/charge_spec.rb

@@ -13,6 +13,7 @@ describe 'Charge API' do
       description: 'card charge'
     )
 
+    expect(charge.id).to match(/^test_ch/)
     expect(charge.amount).to eq(999)
     expect(charge.description).to eq('card charge')
   end

data/spec/stripe/customer_spec.rb

@@ -11,6 +11,7 @@ describe 'Customer API' do
       card: 'some_card_token',
       description: "a description"
     })
+    expect(customer.id).to match(/^test_cus/)
     expect(customer.email).to eq('johnny@appleseed.com')
     expect(customer.description).to eq('a description')
   end

data/stripe-ruby-mock.gemspec

@@ -18,7 +18,9 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
 
   gem.add_dependency 'stripe', '~> 1.8.3'
+  gem.add_dependency 'jimson-temp'
 
   gem.add_development_dependency 'rspec', '~> 2.4'
   gem.add_development_dependency 'rubygems-tasks', '~> 0.2'
+  gem.add_development_dependency 'dante', '~> 0.1.5'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stripe-ruby-mock
 version: !ruby/object:Gem::Version
-  version: 1.8.3.3
+  version: 1.8.3.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-31 00:00:00.000000000 Z
+date: 2013-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: stripe
@@ -27,6 +27,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.8.3
+- !ruby/object:Gem::Dependency
+  name: jimson-temp
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -59,9 +75,26 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: dante
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.5
 description: A drop-in library to test stripe without hitting their servers
 email: gilbertbgarza@gmail.com
-executables: []
+executables:
+- stripe-mock-server
 extensions: []
 extra_rdoc_files: []
 files:
@@ -71,10 +104,15 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/stripe-mock-server
 - lib/stripe_mock.rb
+- lib/stripe_mock/api/client.rb
 - lib/stripe_mock/api/errors.rb
 - lib/stripe_mock/api/instance.rb
+- lib/stripe_mock/client.rb
 - lib/stripe_mock/data.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
 - lib/stripe_mock/errors/uninitialized_instance_error.rb
 - lib/stripe_mock/instance.rb
@@ -82,8 +120,11 @@ files:
 - lib/stripe_mock/request_handlers/customers.rb
 - lib/stripe_mock/request_handlers/invoice_items.rb
 - lib/stripe_mock/request_handlers/plans.rb
+- lib/stripe_mock/server.rb
 - lib/stripe_mock/version.rb
+- spec/instance_spec.rb
 - spec/readme_spec.rb
+- spec/server_spec.rb
 - spec/spec_helper.rb
 - spec/stripe/charge_spec.rb
 - spec/stripe/customer_spec.rb
@@ -91,6 +132,7 @@ files:
 - spec/stripe/invoice_item_spec.rb
 - spec/stripe/plan_spec.rb
 - spec/stripe_mock_spec.rb
+- spec/support/server_daemon.rb
 - stripe-ruby-mock.gemspec
 homepage: https://github.com/mindeavor/stripe-ruby-mock
 licenses:
@@ -118,7 +160,9 @@ signing_key:
 specification_version: 3
 summary: TDD with stripe
 test_files:
+- spec/instance_spec.rb
 - spec/readme_spec.rb
+- spec/server_spec.rb
 - spec/spec_helper.rb
 - spec/stripe/charge_spec.rb
 - spec/stripe/customer_spec.rb
@@ -126,3 +170,4 @@ test_files:
 - spec/stripe/invoice_item_spec.rb
 - spec/stripe/plan_spec.rb
 - spec/stripe_mock_spec.rb
+- spec/support/server_daemon.rb