http_stub 0.0.2 → 0.0.3

data/lib/http/stub/registry.rb

@@ -0,0 +1,23 @@
+module Http
+  module Stub
+
+    class Registry
+
+      def initialize
+        @stubs = []
+      end
+
+      def add(stub, request)
+        @stubs.unshift(stub)
+        request.logger.info "Stub registered: #{stub}"
+      end
+
+      def find_for(request)
+        request.logger.info "Finding stub fulfilling: #{request}"
+        @stubs.find { |stub| stub.stubs?(request) }
+      end
+
+    end
+
+  end
+end

data/lib/http/stub/server.rb

@@ -3,17 +3,17 @@ module Http
 
     class Server < ::Sinatra::Base
 
-      SUPPORTED_REQUEST_TYPES = [:get, :post, :put, :delete, :patch, :options].freeze
-
       enable :dump_errors, :logging
 
-      def initialize()
+      def initialize
         super()
-        @response_register = {}
+        @registry = Http::Stub::Registry.new
       end
 
       private
 
+      SUPPORTED_REQUEST_TYPES = [:get, :post, :put, :delete, :patch, :options].freeze
+
       def self.any_request_type(path, opts={}, &block)
         SUPPORTED_REQUEST_TYPES.each { |type| self.send(type, path, opts, &block) }
       end
@@ -24,15 +24,17 @@ module Http
       # {
       #   "uri": "/some/path",
       #   "method": "get",
+      #   "parameters": {
+      #     "key": "value",
+      #     ...
+      #   },
       #   "response": {
       #     "status": "200",
       #     "body": "Hello World"
       #   }
       # }
       post "/stub" do
-        data = JSON.parse(request.body.read)
-        logger.info "Stub registered: #{data}"
-        @response_register[data["uri"]] = data
+        @registry.add(Http::Stub::Stub.new(request), request)
         halt 200
       end
 
@@ -41,14 +43,8 @@ module Http
       private
 
       def handle_stub_request
-        logger.info "Stub response requested: #{request}"
-        stub_data = @response_register[request.path_info]
-        if stub_data && stub_data["method"].downcase == request.request_method.downcase
-          response_data = stub_data["response"]
-          halt response_data["status"].to_i, response_data["body"]
-        else
-          halt 404
-        end
+        stub = @registry.find_for(request)
+        stub ? halt(stub.response.status, stub.response.body) : halt(404)
       end
 
     end

data/lib/http/stub/stub.rb

@@ -0,0 +1,32 @@
+module Http
+  module Stub
+    class Stub
+
+      Response = ImmutableStruct.new(:status, :body)
+
+      attr_reader :response
+
+      def initialize(request)
+        @data = JSON.parse(request.body.read)
+        @response = Response.new(status: @data["response"]["status"], body: @data["response"]["body"])
+      end
+
+      def stubs?(request)
+        @data["uri"] == request.path_info &&
+            @data["method"].downcase == request.request_method.downcase &&
+            parameters == request.params
+      end
+
+      def to_s
+        @data.to_s
+      end
+
+      private
+
+      def parameters
+        @data["parameters"] || {}
+      end
+
+    end
+  end
+end

data/lib/http/stub/version.rb

@@ -1,5 +1,5 @@
 module Http
   module Stub
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/lib/http_stub.rb

@@ -3,8 +3,11 @@ require 'bundler/setup'
 Bundler.require(:default)
 
 require 'sinatra'
+require 'immutable_struct'
 require 'net/http'
 require 'json'
 
+require File.expand_path('../http/stub/stub', __FILE__)
+require File.expand_path('../http/stub/registry', __FILE__)
 require File.expand_path('../http/stub/server', __FILE__)
 require File.expand_path('../http/stub/client', __FILE__)

data/spec/lib/http/client_integration_spec.rb

@@ -12,9 +12,7 @@ describe Http::Stub::Client do
 
   describe "when a response for a request is stubbed" do
 
-    before(:each) do
-      client.stub_response!("/a_path", method: :get, status: 200, body: "Some body")
-    end
+    before(:each) { client.stub_response!("/a_path", method: :get, status: 200, body: "Some body") }
 
     describe "and that request is made" do
 

data/spec/lib/http/rake_task_integration_spec.rb

@@ -5,7 +5,7 @@ describe Http::Stub::RakeTask do
 
     it "should start a stub server that responds to stub requests" do
       request = Net::HTTP::Post.new("/stub")
-      request.body = "{}"
+      request.body = { "response" => { "status" => 302, "body" => "Some Body" } }.to_json
 
       response = Net::HTTP.new("localhost", 8001).start { |http| http.request(request) }
 

data/spec/lib/http/registry_spec.rb

@@ -0,0 +1,79 @@
+describe Http::Stub::Registry do
+
+  let(:registry) { Http::Stub::Registry.new }
+
+  let(:logger) { double("Logger").as_null_object }
+  let(:request) { double("HttpRequest", logger: logger, to_s: "Request as String") }
+
+  describe "#add" do
+
+    it "should log that the stub has been registered" do
+      stub = double(Http::Stub::Stub, to_s: "Stub as String")
+      logger.should_receive(:info).with(/Stub as String/)
+
+      registry.add(stub, request)
+    end
+
+  end
+
+  describe "#find_for" do
+
+    describe "when multiple stubs have been registered" do
+
+      let(:stubs) do
+        (1..3).map { |i| double("#{Http::Stub::Stub}#{i}", :stubs? => false) }
+      end
+
+      before(:each) do
+        stubs.each { |stub| registry.add(stub, request) }
+      end
+
+      describe "and one registered stub matches the request" do
+
+        before(:each) { stubs[1].stub!(:stubs?).and_return(true) }
+
+        it "should return the stub" do
+          registry.find_for(request).should eql(stubs[1])
+        end
+
+      end
+
+      describe "and multiple registered stubs match the request" do
+
+        before(:each) do
+          [0, 2].each { |i| stubs[i].stub!(:stubs?).and_return(true) }
+        end
+
+        it "should support stub overrides by returning the last stub registered" do
+          registry.find_for(request).should eql(stubs[2])
+        end
+
+      end
+
+      describe "and no registered stubs match the request" do
+
+        it "should return nil" do
+          registry.find_for(request).should be_nil
+        end
+
+      end
+
+    end
+
+    describe "when no stub has been registered" do
+
+      it "should return nil" do
+        registry.find_for(request).should be_nil
+      end
+
+    end
+
+    it "it should log that a stub is being found" do
+      logger.should_receive(:info).with(/Request as String/)
+
+      registry.find_for(request)
+    end
+
+  end
+
+end

data/spec/lib/http/server_spec.rb

@@ -1,65 +1,74 @@
 describe Http::Stub::Server do
   include Rack::Test::Methods
 
-  let(:app) { Http::Stub::Server }
+  let(:app) { Http::Stub::Server.new }
+
+  let(:registry) { double(Http::Stub::Registry).as_null_object }
+  before(:each) { Http::Stub::Registry.stub!(:new).and_return(registry) }
+
   let(:response) { last_response }
   let(:response_body) { response.body.to_s }
 
-  shared_examples "a server that stubs a response" do |options|
+  describe "when a stub request is received" do
 
-    let(:request_type) { options[:request_type] }
-    let(:different_request_type) { options[:different_request_type] }
-    let(:test_url) { "/test_#{request_type}" }
+    it "should register a stub encapsulating the request" do
+      stub = double(Http::Stub::Stub)
+      Http::Stub::Stub.should_receive(:new).and_return(stub)
+      registry.should_receive(:add).with(stub, anything)
 
-    before(:each) do
-      post "/stub", '{"uri": "' + test_url + '", "method": "' + request_type.to_s + '", "response": {"status":"200", "body":"Foo"}}'
+      issue_stub_request
     end
 
-    describe "when a #{options[:request_type]} request is made" do
+  end
 
-      before(:each) { self.send(request_type, test_url) }
+  describe "when a playback request is received" do
 
-      it "should respond with the stubbed response code" do
-        response.status.should eql(200)
-      end
+    describe "and the request has been stubbed" do
 
-      it "should respond with the stubbed body" do
-        response_body.should eql("Foo")
+      before(:each) do
+        registry.stub!(:find_for).and_return(
+            double(Http::Stub::Stub, response: double("StubResponse", status: 500, body: "Some text")))
       end
 
-    end
+      it "should respond with the configured status" do
+        get "/a_path"
 
-    describe "and a request of type '#{options[:different_request_type]}' is made" do
+        response.status.should eql(500)
+      end
 
-      before(:each) { self.send(different_request_type, test_url) }
+      it "should respond with the configured body" do
+        get "/a_path"
 
-      it "should respond with a 404 response code" do
-        response.status.should eql(404)
+        response_body.should eql("Some text")
       end
 
     end
 
-  end
+    describe "and the request has not been stubbed" do
 
-  all_request_types = [:get, :post, :put, :delete, :patch, :options]
-  all_request_types.each_with_index do |request_type, i|
+      before(:each) do
+        registry.stub!(:find_for).and_return(nil)
+      end
 
-    describe "when a #{request_type} request is stubbed" do
+      it "should respond with a 404" do
+        get "/a_path"
 
-      it_should_behave_like "a server that stubs a response", request_type: request_type, different_request_type: all_request_types[i - 1]
+        response.status.should eql(404)
+      end
 
     end
 
   end
 
-  describe "when a request is made that is not stubbed" do
-
-    before(:each) { get "/not_stubbed" }
-
-    it "should respond with 404 response code" do
-      response.status.should eql(404)
-    end
-
+  def issue_stub_request
+    post "/stub", {
+        "uri" => "/a_path",
+        "method" => "a method",
+        "response" => {
+            "status" => 200,
+            "body" => "Foo"
+        }
+    }.to_json
   end
 
 end

data/spec/lib/http/stub_spec.rb

@@ -0,0 +1,157 @@
+describe Http::Stub::Stub do
+
+  let(:stub_uri) { "/a_path" }
+  let(:stub_method) { "get" }
+  let(:stub_parameters) { {} }
+  let(:stub_body) do
+    {
+        "uri" => stub_uri,
+        "method" => stub_method,
+        "parameters" => stub_parameters,
+        "response" => {
+            "status" => 201,
+            "body" => "Foo"
+        }
+    }.to_json
+  end
+  let(:stub_request) { double("HttpRequest", :body => double("HttpRequestBody", :read => stub_body)) }
+  let(:stub_instance) { Http::Stub::Stub.new(stub_request) }
+
+  describe "#stubs?" do
+
+    let(:request_uri) { stub_uri }
+    let(:request_method) { stub_method }
+    let(:request_parameters) { stub_parameters }
+    let(:request) do
+      double("HttpRequest", :path_info => request_uri, :request_method => request_method, :params => request_parameters)
+    end
+
+    describe "when the request uri matches" do
+
+      describe "and the request method matches" do
+
+        describe "and a parameter match is configured" do
+
+          let(:stub_parameters) do
+            {
+                "param1" => "value1",
+                "param2" => "value2",
+                "param3" => "value3"
+            }
+          end
+
+          describe "and the parameters match" do
+
+            it "should return true" do
+              stub_instance.stubs?(request).should be_true
+            end
+
+          end
+
+          describe "and the parameter values do not match" do
+
+            let(:request_parameters) do
+              {
+                  "param1" => "value1",
+                  "param2" => "aDifferentValue",
+                  "param3" => "value3"
+              }
+            end
+
+            it "should return false" do
+              stub_instance.stubs?(request).should be_false
+            end
+
+          end
+
+          describe "and not all parameters are provided" do
+
+            let(:request_parameters) do
+              {
+                  "param1" => "value1",
+                  "param3" => "value3"
+              }
+            end
+
+            it "should be false" do
+              stub_instance.stubs?(request).should be_false
+            end
+
+          end
+
+        end
+
+      end
+
+    end
+
+    describe "when the request uri does not match" do
+
+      let(:request_uri) { "/a_different_path" }
+
+      it "should return false" do
+        stub_instance.stubs?(request).should be_false
+      end
+
+    end
+
+    describe "when the request method does not match" do
+
+      let(:request_method) { "post" }
+
+      it "should return false" do
+        stub_instance.stubs?(request).should be_false
+      end
+
+    end
+
+  end
+
+  describe "#response" do
+
+    it "should expose the provided response status" do
+      stub_instance.response.status.should eql(201)
+    end
+
+    it "should expose the provided response body" do
+      stub_instance.response.body.should eql("Foo")
+    end
+
+  end
+
+  describe "#to_s" do
+
+    let(:stub_parameters) do
+      {
+          "param1" => "value1",
+          "param2" => "value2",
+          "param3" => "value3"
+      }
+    end
+
+    it "should return a string containing the stubbed uri" do
+      stub_instance.to_s.should match(/\/a_path/)
+    end
+
+    it "should return a string containing the stubbed request method" do
+      stub_instance.to_s.should match(/get/)
+    end
+
+    it "should return a string containing the stubbed parameters" do
+      stub_parameters.each_pair do |key, value|
+        stub_instance.to_s.should match(/#{Regexp.escape(key)}/)
+        stub_instance.to_s.should match(/#{Regexp.escape(value)}/)
+      end
+    end
+
+    it "should return a string containing the intended response code" do
+      stub_instance.to_s.should match(/201/)
+    end
+
+    it "should return a string containing the intended response body" do
+      stub_instance.to_s.should match(/Foo/)
+    end
+
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: http_stub
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-10 00:00:00.000000000 Z
+date: 2013-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -28,6 +28,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.3.4
+- !ruby/object:Gem::Dependency
+  name: immutable_struct
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
 description: Configure server responses via requests to /stub.  Intended as an acceptance
   / integration testing tool.
 email: matthew.ueckerman@myob.com
@@ -37,13 +53,17 @@ extra_rdoc_files: []
 files:
 - ./lib/http/stub/client.rb
 - ./lib/http/stub/rake_task.rb
+- ./lib/http/stub/registry.rb
 - ./lib/http/stub/server.rb
+- ./lib/http/stub/stub.rb
 - ./lib/http/stub/version.rb
 - ./lib/http_stub.rb
 - ./spec/curl_sample.txt
 - ./spec/lib/http/client_integration_spec.rb
 - ./spec/lib/http/rake_task_integration_spec.rb
+- ./spec/lib/http/registry_spec.rb
 - ./spec/lib/http/server_spec.rb
+- ./spec/lib/http/stub_spec.rb
 - ./spec/spec_helper.rb
 - ./spec/support/server_integration.rb
 homepage: http://github.com/MYOB-Technology/http_stub
@@ -67,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1339898744489492428
+      hash: 2752646787075504105
 requirements: []
 rubyforge_project: http_stub
 rubygems_version: 1.8.25
@@ -78,6 +98,8 @@ test_files:
 - ./spec/curl_sample.txt
 - ./spec/lib/http/client_integration_spec.rb
 - ./spec/lib/http/rake_task_integration_spec.rb
+- ./spec/lib/http/registry_spec.rb
 - ./spec/lib/http/server_spec.rb
+- ./spec/lib/http/stub_spec.rb
 - ./spec/spec_helper.rb
 - ./spec/support/server_integration.rb