faraday_simulation 0.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify dependencies in faraday_simulation.gemspec.
+gemspec

data/Gemfile.lock

@@ -0,0 +1,20 @@
+PATH
+  remote: .
+  specs:
+    faraday_simulation (0.0.1)
+      faraday
+      rake
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    faraday (0.8.1)
+      multipart-post (~> 1.1)
+    multipart-post (1.1.5)
+    rake (0.9.2.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  faraday_simulation!

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Joseph Pearson
+
+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,49 @@
+# FaradaySimulation
+
+A [Faraday]() extension to provide dynamic stubbing. This makes it possible 
+to simulate more of the behavior of the target service in your tests and when
+your app is running in development mode.
+
+
+## Usage
+
+The `FaradaySimulation::Adapter` class is the equivalent of Faraday's own
+test adapter, but you can do a bit more with the stubs:
+
+    conn = Faraday::Connection.new { |builder|
+      builder.use(FaradaySimulation::Adapter) { |stub|
+        stub.get('/drink/:name.json') { |env|
+          [200, {}, "Drinking #{env[:params]['name']}"]
+        }
+      }
+    }
+
+    resp = conn.get('/drink/sake.json')
+    # resp.body => 'Drinking sake'
+
+    resp = conn.get('/drink/ale.json')
+    # resp.body => 'Drinking ale'
+
+Put simply, any stub path you define that includes `:foo` will match to
+any string, and that string will be the value of `env[:params]['foo']` in
+your stub block.
+
+For more complex routes, you can define the stub with a regular expression.
+Any regex group (you know, parenthesized pattern) in the matching regex will
+be placed in env[:segments]. For example:
+
+    stub.get(/\/foo\/([A-Z]+)\//) { |env|
+      [200, {}, "Segment is #{env[:segments][0]}"]
+    }
+
+    resp = conn.get('/foo/BAR')
+    # resp.body => 'Segment is BAR'
+
+    resp = conn.get('/foo/bar')
+    # => Stubs::NotFound error
+
+
+## Copyright
+
+Copyright (c) 2012 Joseph Pearson, released under the MIT License. 
+See MIT-LICENSE for details.

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new { |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/unit/test*.rb']
+  t.verbose = true
+}
+
+desc("Run tests")
+task(:default => :test)

data/faraday_simulation.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/faraday_simulation/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors = ['Joseph Pearson']
+  gem.email = ['joseph@booki.sh']
+  gem.description = 'A Faraday extension to provide dynamic stubbing.'
+  gem.summary = 'Dynamic stubbing in Faraday'
+  gem.homepage = ''
+
+  gem.files = `git ls-files`.split($\)
+  gem.executables = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name = 'faraday_simulation'
+  gem.require_paths = ['lib']
+  gem.version = FaradaySimulation::VERSION
+  gem.add_dependency('rake')
+  gem.add_dependency('faraday')
+end

data/lib/faraday_simulation/adapter.rb

@@ -0,0 +1,8 @@
+class FaradaySimulation::Adapter < Faraday::Adapter::Test
+
+  def initialize(app, stubs=nil, &block)
+    stubs = stubs || FaradaySimulation::Stubs.new
+    super(app, stubs, &block)
+  end
+
+end

data/lib/faraday_simulation/stub.rb

@@ -0,0 +1,68 @@
+class FaradaySimulation::Stub < Faraday::Adapter::Test::Stub
+
+  attr_accessor(:segments, :segment_names)
+
+
+  def initialize(full, body, block)
+    self.segment_names = []
+    query = nil
+    if full.kind_of?(String)
+      self.path, query = full.split('?')
+      process_path
+    else
+      self.path = full
+    end
+    self.params = query ? Faraday::Utils.parse_nested_query(query) : {}
+    self.body = body
+    self.block = Proc.new { |env|
+      env[:params].update(body_params(env))
+      segment_names.each { |name|
+        env[:params][name] = self.segments.shift
+      }
+      env[:segments] = self.segments
+      block.call(env)
+    }
+  end
+
+
+  def matches?(request_uri, request_body)
+    request_path, request_query = request_uri.split('?')
+    request_params = request_query ?
+      Faraday::Utils.parse_nested_query(request_query) :
+      {}
+    md = request_path.match(self.path)
+    if (
+      (md && md[0] == request_path) &&
+      params_match?(request_params) &&
+      (body.to_s.size.zero? || request_body == body)
+    )
+      self.segments = md.to_a.slice(1, md.size)
+      true
+    else
+      false
+    end
+  end
+
+
+  def process_path
+    self.path += '/'  unless path.match(/\/$/)
+    self.path.gsub!(/:([^\/\.]+)/) {
+      self.segment_names << $1
+      '([^\/\.]+)'
+    }
+    self.path = Regexp.new(self.path)  if segment_names.any?
+  end
+
+
+  protected
+
+    def body_params(env)
+      case env[:request_headers]["Content-Type"]
+      when /\bjson$/
+        JSON.load(env[:body])
+      else
+        Faraday::Utils.send(:parse_nested_query, env[:body])
+      end
+    end
+
+end

data/lib/faraday_simulation/stubs.rb

@@ -0,0 +1,8 @@
+class FaradaySimulation::Stubs < Faraday::Adapter::Test::Stubs
+
+  def new_stub(request_method, path, body=nil, &block)
+    stub = FaradaySimulation::Stub.new(path, body, block)
+    (@stack[request_method] ||= []) << stub
+  end
+
+end

data/lib/faraday_simulation/version.rb

@@ -0,0 +1,5 @@
+module FaradaySimulation
+
+  VERSION = '0.0.1'
+
+end

data/lib/faraday_simulation.rb

@@ -0,0 +1,8 @@
+require 'faraday'
+
+module FaradaySimulation
+end
+
+require 'faraday_simulation/stub'
+require 'faraday_simulation/stubs'
+require 'faraday_simulation/adapter'

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'faraday_simulation'
+require 'test/unit'

data/test/unit/test_adapter.rb

@@ -0,0 +1,96 @@
+require 'test_helper'
+
+class FaradaySimulation::TestAdapter < Test::Unit::TestCase
+
+  def setup
+    @stubs = FaradaySimulation::Stubs.new
+    @conn = Faraday::Connection.new { |builder|
+      builder.use(FaradaySimulation::Adapter, @stubs)
+    }
+  end
+
+
+  def test_simplest_case_of_stubbed_routing
+    conn = Faraday::Connection.new { |builder|
+      builder.use(FaradaySimulation::Adapter) { |stub|
+        stub.get('/nigiri/sake.json') {
+          [200, {}, 'hi world']
+        }
+      }
+    }
+
+    resp = conn.get('/nigiri/sake.json')
+    assert_equal('hi world', resp.body)
+  end
+
+
+  def test_body_params
+    @stubs.post('/endpoint') { |env|
+      assert_equal('bar', env[:params]['foo'])
+    }
+    @conn.post('/endpoint', 'foo=bar')
+  end
+
+
+  def test_query_params
+    @stubs.get('/endpoint') { |env|
+      assert_equal('garply', env[:params]['foo'])
+    }
+    @conn.get('/endpoint?foo=garply')
+  end
+
+
+  def test_query_params_when_defined_do_not_match
+    @stubs.get('/endpoint?foo=baz') { |env| }
+    assert_raises(Faraday::Adapter::Test::Stubs::NotFound) {
+      @conn.get('/endpoint?foo=woz')
+    }
+  end
+
+
+  def test_segment_params
+    @stubs.get(/\/endpoint\/([^\/]+)\//) { |env|
+      assert_equal('slug', env[:segments][0])
+    }
+    @conn.get('/endpoint/slug')
+  end
+
+
+  def test_multiple_segment_params
+    @stubs.get(/\/endpoint\/([^\/]+)\/junk\/(.*)/) { |env|
+      assert_equal('slug', env[:segments][0])
+      assert_equal('wildcard/string/', env[:segments][1])
+    }
+    @conn.get('/endpoint/slug/junk/wildcard/string/')
+  end
+
+
+  def test_segment_params_with_query_params
+    @stubs.get(/\/endpoint\/([^\/]+)\//) { |env|
+      assert_equal('bar', env[:params]['foo'])
+    }
+    @conn.get('/endpoint/slug?foo=bar')
+  end
+
+
+  def test_routed_params
+    @stubs.get('/endpoint/:slug') { |env|
+      assert_equal('faraday_simulation', env[:params]['slug'])
+    }
+    assert_nothing_raised {
+      @conn.get('/endpoint/faraday_simulation')
+    }
+  end
+
+
+  def test_routed_params_with_extension
+    @stubs.get('/endpoint/:slug.:format') { |env|
+      assert_equal('faraday_simulation', env[:params]['slug'])
+      assert_equal('json', env[:params]['format'])
+    }
+    assert_nothing_raised {
+      @conn.get('/endpoint/faraday_simulation.json')
+    }
+  end
+
+end

data/test/unit/test_readme.rb

@@ -0,0 +1,39 @@
+require 'test_helper'
+
+class FaradaySimulation::TestReadme < Test::Unit::TestCase
+
+  def test_routed_example
+    conn = Faraday::Connection.new { |builder|
+      builder.use(FaradaySimulation::Adapter) { |stub|
+        stub.get('/drink/:name.json') { |env|
+          [200, {}, "Drinking #{env[:params]['name']}"]
+        }
+      }
+    }
+
+    resp = conn.get('/drink/sake.json')
+    assert_equal('Drinking sake', resp.body)
+
+    resp = conn.get('/drink/ale.json')
+    assert_equal('Drinking ale', resp.body)
+  end
+
+
+  def test_segmented_example
+    conn = Faraday::Connection.new { |builder|
+      builder.use(FaradaySimulation::Adapter) { |stub|
+        stub.get(/\/foo\/([A-Z]+)\//) { |env|
+          [200, {}, "Segment is #{env[:segments][0]}"]
+        }
+      }
+    }
+
+    resp = conn.get('/foo/BAR')
+    assert_equal('Segment is BAR', resp.body)
+
+    assert_raises(Faraday::Adapter::Test::Stubs::NotFound) {
+      resp = conn.get('/foo/bar')
+    }
+  end
+
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification 
+name: faraday_simulation
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Joseph Pearson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-07-09 00:00:00 +10:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: faraday
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: A Faraday extension to provide dynamic stubbing.
+email: 
+- joseph@booki.sh
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README.md
+- Rakefile
+- faraday_simulation.gemspec
+- lib/faraday_simulation.rb
+- lib/faraday_simulation/adapter.rb
+- lib/faraday_simulation/stub.rb
+- lib/faraday_simulation/stubs.rb
+- lib/faraday_simulation/version.rb
+- test/test_helper.rb
+- test/unit/test_adapter.rb
+- test/unit/test_readme.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Dynamic stubbing in Faraday
+test_files: 
+- test/test_helper.rb
+- test/unit/test_adapter.rb
+- test/unit/test_readme.rb