rack-stubs 0.0.1

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+group :development do
+  gem 'bundler', '~> 1.0.7'
+end
+
+gemspec

data/README.rdoc

@@ -0,0 +1,7 @@
+= Rack Stubs
+
+Rack middleware for specifying behaviour of HTTP resources by POSTing stub representations.
+
+== Usage
+
+See the features :)

data/features/step_definitions/steps.rb

@@ -0,0 +1,21 @@
+Given /^(GET|POST) ([^\s]+) returns (\d\d\d) with the body "([^"]*)"$/ do |verb, path, status, body|
+  Then %|#{verb} #{path} should return #{status} with the body "#{body}"|
+end
+
+When /^I (GET|POST) "([^"]+)" to (\/[^\s]*) with the body:$/ do |verb, mime, path, body|
+  RestClient.send(verb.downcase, url(path), body, { "Content-Type" => mime })
+end
+
+Then /^(GET|POST) (\/[^\s]*) should return (\d\d\d) with the body "([^"]*)"$/ do |verb, path, status, body|
+  RestClient.send(verb.downcase, url(path), {}) do |response, request, result, &block|
+    response.code.should == status.to_i
+    response.body.should == body
+  end
+end
+
+Then /^(GET|POST) (\/[^\s]*) should return (\d\d\d) with the body:$/ do |verb, path, status, body|
+  RestClient.send(verb.downcase, url(path), {}) do |response, request, result, &block|
+    response.code.should == status.to_i
+    response.body.should == body
+  end
+end

data/features/stub_responses.feature

@@ -0,0 +1,69 @@
+Feature: Stub Responses
+  In order to simulate behaviour of third-party web services
+  As a test for my application
+  I want to simulate http service behaviour
+  
+  Background:
+    Given GET /foo returns 404 with the body "Not Found"
+    And   GET /bar returns 404 with the body "Not Found"
+    And   POST /foo returns 404 with the body "Not Found"
+    And   POST /bar returns 404 with the body "Not Found"
+  
+  Scenario: Stub GET response
+    When  I POST "application/json+rack-stub" to /foo with the body:
+      """
+        {
+          "GET" : [200, { "header": "value" }, ["jazz"]]
+        }
+      """
+    Then  GET /foo should return 200 with the body "jazz"
+    And   POST /foo should return 404 with the body "Not Found"
+
+  Scenario: Stub POST response
+    When  I POST "application/json+rack-stub" to /bar with the body:
+      """
+        {
+          "POST" : [200, { "header": "value" }, ["funk"]]
+        }
+      """
+    Then  POST /bar should return 200 with the body "funk"
+    And   GET /foo should return 404 with the body "Not Found"
+    
+  Scenario: Clear all stub responses
+    When  I POST "application/json+rack-stub" to /foo with the body:
+      """
+        {
+          "GET" : [200, { "header": "value" }, ["soul"]]
+        }
+      """
+    And   I POST "application/json+rack-stub" to /bar with the body:
+      """
+       {
+         "POST" : [200, { "header": "value" }, ["brother"]]
+       }
+      """
+    When  I POST "application/json+rack-stub" to /rack_stubs/clear with the body:
+      """
+      """
+    Then  GET /foo should return 404 with the body "Not Found"
+    And   POST /bar should return 404 with the body "Not Found"
+
+  Scenario: List all stub responses
+    Then  GET /rack_stubs/list should return 200 with the body "{}"
+    When  I POST "application/json+rack-stub" to /foo with the body:
+      """
+        {
+          "GET" : [200, { "header": "value" }, ["salsa"]]
+        }
+      """
+    And   I POST "application/json+rack-stub" to /bar with the body:
+      """
+       {
+         "POST" : [200, { "header": "value" }, ["chicken"]]
+       }
+      """
+    Then  GET /rack_stubs/list should return 200 with the body:
+      """
+      {"/foo":{"GET":[200,{"header":"value"},["salsa"]]},"/bar":{"POST":[200,{"header":"value"},["chicken"]]}}
+      """
+

data/features/support/env.rb

@@ -0,0 +1,47 @@
+require 'mongrel'
+require 'restclient'
+
+$:.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'rack_stubs'
+
+module RackStubs::World
+  def host
+    "localhost"
+  end
+  
+  def port
+    6663
+  end
+  
+  def options
+    { :Host => host, :Port => port }
+  end
+  
+  def start_server
+    @@server ||= begin
+      server = WebServer.new
+      server.start(app, options)
+      server
+    end
+  end
+  
+  def url(path)
+    "http://#{host}:#{port}#{path}"
+  end
+  
+  def app
+    @app ||= Rack::Builder.app do
+      use RackStubs::Middleware
+      run lambda { |e|
+        [404, {"Content-Type" => "text/plain"}, ["Not Found"]]
+      }
+    end
+  end
+end
+
+World(RackStubs::World)
+
+Before do
+  start_server
+  RestClient.post url("/rack_stubs/clear"), {}
+end

data/features/support/web_server.rb

@@ -0,0 +1,15 @@
+class WebServer
+  def start(app, options)
+    rack_server = nil
+    rack_thread = Thread.new do
+      ::Rack::Handler::Mongrel.run(app, options) do |server|
+        rack_server = server
+      end
+    end
+    at_exit do
+      rack_server.stop
+      rack_thread.kill
+    end
+    sleep 0.05 while rack_server.nil?
+  end  
+end

data/lib/rack-stubs.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + '/rack_stubs'

data/lib/rack_stubs/client.rb

@@ -0,0 +1,38 @@
+require 'json'
+require 'restclient'
+
+module RackStubs
+  class Client
+    def initialize(service, rest_client = RestClient)
+      @service = service 
+      @rest_client = rest_client
+    end
+    
+    def service_url(path)
+      @service.gsub(/\/+$/, '') + '/' + path.gsub(/^\/+/, '')
+    end
+  
+    def get(path)
+      PathSpecification.new(service_url(path), 'GET', @rest_client)
+    end
+  
+    def post(path)
+      PathSpecification.new(service_url(path), 'POST', @rest_client)
+    end
+  end
+
+  class PathSpecification
+    def initialize(path, http_verb, rest_client)
+      @path = path
+      @http_verb = http_verb
+      @rest_client = rest_client
+    end
+  
+    def returns(status_code, response_headers, response_body)
+      @rest_client.post(@path,
+        { @http_verb => [status_code, response_headers, response_body] }.to_json,
+        {"Content-Type" => "application/json+rack-stub"}
+      )
+    end
+  end
+end

data/lib/rack_stubs/middleware.rb

@@ -0,0 +1,57 @@
+require 'json'
+require 'rack'
+
+module RackStubs
+  class Middleware
+    def initialize(app)
+      @app = app
+      @stubs = {}
+    end
+  
+    def call(env)
+      request = Rack::Request.new(env)
+      if request.path =~ /\/rack_stubs\/clear$/
+        @stubs = {}
+        ok
+      elsif request.path =~ /\/rack_stubs\/list$/
+        [200, {"Content-Type" => "text/plain"}, [@stubs.to_json]]
+      elsif request.content_type == "application/json+rack-stub"
+        setup_stub(request.path, JSON.parse(request.body.read.to_s))
+        ok
+      elsif @stubs.include?(request.path) &&
+            @stubs[request.path].include?(request.request_method)
+        @stubs[request.path][request.request_method]
+      else
+        @app.call(env)
+      end
+    end
+
+    def setup_stub(path, http_verb_behaviours_hash)
+      @stubs[path] = http_verb_behaviours_hash
+    end
+    
+    def get(path)
+      PathSpecification.new(path, "GET", self)
+    end
+    
+    def post(path)
+      PathSpecification.new(path, "POST", self)
+    end
+
+    private
+    
+    class PathSpecification
+      def initialize(path, http_verb, middleware)
+        @path, @http_verb, @middleware = path, http_verb, middleware
+      end
+      
+      def returns(status, headers, body)
+        @middleware.setup_stub(@path, { @http_verb => [status, headers, body] })
+      end
+    end
+  
+    def ok
+      [200, {"Content-Type" => "text/plain"}, ["OK"]]
+    end
+  end
+end

data/lib/rack_stubs.rb

@@ -0,0 +1,9 @@
+lib = File.dirname(__FILE__)
+$:.unshift(lib) unless $:.include?(lib) || $:.include?(File.expand_path(lib))
+
+module RackStubs
+  VERSION = '0.0.1'
+end
+
+require 'rack_stubs/middleware'
+require 'rack_stubs/client'

data/rack-stubs.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+require "rack_stubs"
+
+Gem::Specification.new do |s|
+  s.name        = 'rack-stubs'
+  s.version     = RackStubs::VERSION
+  s.authors     = ['Josh Chisholm']
+  s.description = 'Makes rack apps deliver stub responses'
+  s.summary     = "rack-stubs-#{s.version}"
+  s.email       = 'joshuachisholm@gmail.com'
+  s.homepage    = 'http://github.com/joshski/rack-stubs'
+
+  s.add_dependency 'json', '~> 1.4.6'
+  s.add_dependency 'rack', '~> 1.2.1'
+  s.add_dependency 'rest-client', '~> 1.4.2'
+  
+  s.rubygems_version  = "1.3.7"
+  s.files             = `git ls-files`.split("\n")
+  s.test_files        = `git ls-files -- {features,spec}/*`.split("\n")
+  s.extra_rdoc_files  = ["README.rdoc"]
+  s.require_path      = "lib"
+end

data/spec/rack_stubs/client_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+module RackStubs
+  describe Client do
+  
+    def rest_client_should_stub(path, responses)
+      @rest_client.should_receive(:post).with(path, responses.to_json, {"Content-Type" => "application/json+rack-stub"})
+    end
+  
+    before do
+      @rest_client = mock("rest_client")
+      @client = Client.new("http://path/to/service", @rest_client)
+    end
+  
+    it "stubs GETs to return 404" do
+      rest_client_should_stub("http://path/to/service/resource", { 'GET' => [404, {}, ""] })
+      @client.get("/resource").returns(404, {}, "")
+    end
+
+    it "stubs POSTs to return 404" do
+      rest_client_should_stub("http://path/to/service/resource", { 'POST' => [404, {}, ""] })
+      @client.post("/resource").returns(404, {}, "")
+    end
+  
+    it "stubs GETs to return 200" do
+      rest_client_should_stub("http://path/to/service/resource", { 'GET' => [200, {}, ""] })
+      @client.get("/resource").returns(200, {}, "")
+    end
+  
+    it "stubs POSTs to return 200" do
+      rest_client_should_stub("http://path/to/service/resource", { 'POST' => [200, {}, ""] })
+      @client.post("/resource").returns(200, {}, "")
+    end
+  
+    it "stubs GETs to return the correct body" do
+      rest_client_should_stub("http://path/to/service/resource", { 'GET' => [200, {}, "Success"] })
+      @client.get("/resource").returns(200, {}, "Success")
+    end
+  
+    it "stubs POSTs to return the correct body" do
+      rest_client_should_stub("http://path/to/service/resource", { 'POST' => [200, {}, "Success"] })
+      @client.post("/resource").returns(200, {}, "Success")
+    end
+  
+    it "stubs GETs to return the correct http headers" do
+      rest_client_should_stub("http://path/to/service/resource", { 'GET' => [200, { "header" => "information" }, ""] })
+      @client.get("/resource").returns(200, { "header" => "information" }, "")
+    end
+  
+    it "stubs POSTs to return the correct http headers" do
+      rest_client_should_stub("http://path/to/service/resource", { 'POST' => [200, { "header" => "information" }, ""] })
+      @client.post("/resource").returns(200, { "header" => "information" }, "")
+    end
+  
+    it "stubs GETs with the correct path" do
+      rest_client_should_stub("http://path/to/service/nothing", { 'GET' => [200, {}, ""] })
+      @client.get("/nothing").returns(200, { }, "")
+    end
+    
+    it "isn't fussy about leading slashes in paths" do
+      rest_client_should_stub("http://path/to/service/something", { 'GET' => [200, {}, ""] })
+      @client.get("something").returns(200, { }, "")
+    end
+  
+    it "isn't fussy about trailing slashes in paths" do
+      rest_client_should_stub("http://path/with/a/trailing/slash/anything", { 'GET' => [200, {}, ""] })
+      Client.new("http://path/with/a/trailing/slash/", @rest_client).get("anything").returns(200, { }, "")
+    end
+    
+  end
+end

data/spec/rack_stubs/middleware_spec.rb

@@ -0,0 +1,21 @@
+module RackStubs  
+  describe Middleware do
+    it "allows GET behaviour to be specified directly, using the client interface" do
+      app = mock("app")
+      env = Rack::MockRequest.env_for("/foo")
+      env["REQUEST_METHOD"] = "GET"
+      middleware = Middleware.new(app)
+      middleware.get("/foo").returns(200, {}, "found!")
+      middleware.call(env).should == [200, {}, "found!"]
+    end
+    
+    it "allows POST behaviour to be specified directly, using the client interface" do
+      app = mock("app")
+      env = Rack::MockRequest.env_for("/bar")
+      env["REQUEST_METHOD"] = "POST"
+      middleware = Middleware.new(app)
+      middleware.post("/bar").returns(200, {}, "OK!")
+      middleware.call(env).should == [200, {}, "OK!"]
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+$:.unshift(File.dirname(__FILE__))
+
+require 'rubygems'
+require 'rspec'
+
+require File.dirname(__FILE__) + '/../lib/rack_stubs'

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification 
+name: rack-stubs
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Josh Chisholm
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-10 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 4
+        - 6
+        version: 1.4.6
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rack
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 1
+        - 2
+        - 1
+        version: 1.2.1
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 1
+        - 4
+        - 2
+        version: 1.4.2
+  type: :runtime
+  version_requirements: *id003
+description: Makes rack apps deliver stub responses
+email: joshuachisholm@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- Gemfile
+- README.rdoc
+- features/step_definitions/steps.rb
+- features/stub_responses.feature
+- features/support/env.rb
+- features/support/web_server.rb
+- lib/rack-stubs.rb
+- lib/rack_stubs.rb
+- lib/rack_stubs/client.rb
+- lib/rack_stubs/middleware.rb
+- rack-stubs.gemspec
+- spec/rack_stubs/client_spec.rb
+- spec/rack_stubs/middleware_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/joshski/rack-stubs
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.4.1
+signing_key: 
+specification_version: 3
+summary: rack-stubs-0.0.1
+test_files: 
+- features/step_definitions/steps.rb
+- features/stub_responses.feature
+- features/support/env.rb
+- features/support/web_server.rb
+- spec/rack_stubs/client_spec.rb
+- spec/rack_stubs/middleware_spec.rb
+- spec/spec_helper.rb