http_stub 0.0.4 → 0.1.1

data/lib/http_stub.rb

@@ -7,7 +7,7 @@ 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__)
+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/lib/http_stub/client.rb

@@ -0,0 +1,60 @@
+module HttpStub
+
+  module Client
+
+    def self.included(mod)
+      mod.extend(HttpStub::Client::ClassMethods)
+      mod.send(:include, HttpStub::Client::InstanceMethods)
+    end
+
+    module ClassMethods
+
+      attr_reader :host_value, :port_value
+
+      def host(host)
+        @host_value = host
+      end
+
+      def port(port)
+        @port_value = port
+      end
+
+    end
+
+    module InstanceMethods
+
+      def stub!(uri, options)
+        response_options = options[:response]
+        request = Net::HTTP::Post.new("/stub")
+        request.content_type = "application/json"
+        request.body = {
+            "uri" => uri,
+            "method" => options[:method],
+            "response" => {
+                "status" => response_options[:status] || "200",
+                "body" => response_options[:body]
+            }
+        }.to_json
+        response = submit(request)
+        raise "Unable to stub request: #{response.message}" unless response.code == "200"
+      end
+
+      alias_method :stub_response!, :stub!
+
+      def clear!
+        request = Net::HTTP::Delete.new("/stubs")
+        response = submit(request)
+        raise "Unable to clear stubs: #{response.message}" unless response.code == "200"
+      end
+
+      private
+
+      def submit(request)
+        Net::HTTP.new(self.class.host_value, self.class.port_value).start { |http| http.request(request) }
+      end
+
+    end
+
+  end
+
+end

data/lib/http_stub/registry.rb

@@ -0,0 +1,26 @@
+module HttpStub
+
+  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.inspect}"
+      @stubs.find { |stub| stub.stubs?(request) }
+    end
+
+    def clear(request)
+      request.logger.info "Clearing stubs"
+      @stubs.clear
+    end
+
+  end
+
+end

data/lib/http_stub/server.rb

@@ -0,0 +1,56 @@
+module HttpStub
+
+  class Server < ::Sinatra::Base
+
+    enable :dump_errors, :logging
+
+    def initialize
+      super()
+      @registry = HttpStub::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
+
+    public
+
+    # Sample request body:
+    # {
+    #   "uri": "/some/path",
+    #   "method": "get",
+    #   "parameters": {
+    #     "key": "value",
+    #     ...
+    #   },
+    #   "response": {
+    #     "status": "200",
+    #     "body": "Hello World"
+    #   }
+    # }
+    post "/stub" do
+      @registry.add(HttpStub::Stub.new(request), request)
+      halt 200
+    end
+
+    delete "/stubs" do
+      @registry.clear(request)
+      halt 200
+    end
+
+    any_request_type(//) { handle_stub_request }
+
+    private
+
+    def handle_stub_request
+      stub = @registry.find_for(request)
+      stub ? halt(stub.response.status, stub.response.body) : halt(404)
+    end
+
+  end
+
+end

data/lib/http_stub/start_server_rake_task.rb

@@ -0,0 +1,20 @@
+require File.expand_path('../../http_stub', __FILE__)
+require 'rake/tasklib' unless defined?(::Rake::TaskLib)
+
+module HttpStub
+
+  class StartServerRakeTask < ::Rake::TaskLib
+
+    def initialize(options)
+      desc "Starts stub #{options[:name]}"
+      task "start_#{options[:name]}" do
+        HttpStub::Server.instance_eval do
+          set :port, options[:port]
+          run!
+        end
+      end
+    end
+
+  end
+
+end

data/lib/http_stub/stub.rb

@@ -0,0 +1,32 @@
+module HttpStub
+
+  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

data/lib/http_stub/version.rb

@@ -0,0 +1,3 @@
+module HttpStub
+  VERSION = "0.1.1"
+end

data/spec/curl_samples.txt

@@ -0,0 +1,3 @@
+curl -v -H "Accept: application/json" -H "Content-type: application/json" -X POST -d '{"uri": "/test", "method": "post", "response": {"status":"200", "body":"Foo"}}' http://localhost:8001/stub
+
+curl -v -H "Accept: application/json" -H "Content-type: application/json" -X POST -d '' http://localhost:8001/test

data/spec/lib/{http → http_stub}/client_integration_spec.rb

@@ -1,8 +1,8 @@
-describe Http::Stub::Client do
+describe HttpStub::Client do
   include_context "server integration"
 
   class TestClient
-    include Http::Stub::Client
+    include HttpStub::Client
 
     host "localhost"
     port 8001

data/spec/lib/{http → http_stub}/registry_spec.rb

@@ -1,14 +1,14 @@
-describe Http::Stub::Registry do
+describe HttpStub::Registry do
 
-  let(:registry) { Http::Stub::Registry.new }
+  let(:registry) { HttpStub::Registry.new }
 
   let(:logger) { double("Logger").as_null_object }
-  let(:request) { double("HttpRequest", logger: logger, to_s: "Request as String") }
+  let(:request) { double("HttpRequest", logger: logger, inspect: "Request inspect result") }
 
   describe "#add" do
 
     it "should log that the stub has been registered" do
-      stub = double(Http::Stub::Stub, to_s: "Stub as String")
+      stub = double(HttpStub::Stub, to_s: "Stub as String")
       logger.should_receive(:info).with(/Stub as String/)
 
       registry.add(stub, request)
@@ -21,7 +21,7 @@ describe Http::Stub::Registry do
     describe "when multiple stubs have been registered" do
 
       let(:stubs) do
-        (1..3).map { |i| double("#{Http::Stub::Stub}#{i}", :stubs? => false) }
+        (1..3).map { |i| double("#{HttpStub::Stub}#{i}", :stubs? => false) }
       end
 
       before(:each) do
@@ -78,8 +78,8 @@ describe Http::Stub::Registry do
 
     end
 
-    it "it should log that a stub is being found" do
-      logger.should_receive(:info).with(/Request as String/)
+    it "it should log stub discovery diagnostics that includes the complete details of the request" do
+      logger.should_receive(:info).with(/Request inspect result/)
 
       registry.find_for(request)
     end

data/spec/lib/{http → http_stub}/server_spec.rb

@@ -1,10 +1,10 @@
-describe Http::Stub::Server do
+describe HttpStub::Server do
   include Rack::Test::Methods
 
-  let(:app) { Http::Stub::Server.new }
+  let(:app) { HttpStub::Server.new }
 
-  let(:registry) { double(Http::Stub::Registry).as_null_object }
-  before(:each) { Http::Stub::Registry.stub!(:new).and_return(registry) }
+  let(:registry) { double(HttpStub::Registry).as_null_object }
+  before(:each) { HttpStub::Registry.stub!(:new).and_return(registry) }
 
   let(:response) { last_response }
   let(:response_body) { response.body.to_s }
@@ -12,8 +12,8 @@ describe Http::Stub::Server do
   describe "when a stub request is received" do
 
     it "should register a stub encapsulating the request" do
-      stub = double(Http::Stub::Stub)
-      Http::Stub::Stub.should_receive(:new).and_return(stub)
+      stub = double(HttpStub::Stub)
+      HttpStub::Stub.should_receive(:new).and_return(stub)
       registry.should_receive(:add).with(stub, anything)
 
       issue_stub_request
@@ -27,7 +27,7 @@ describe Http::Stub::Server do
 
       before(:each) do
         registry.stub!(:find_for).and_return(
-            double(Http::Stub::Stub, response: double("StubResponse", status: 500, body: "Some text")))
+            double(HttpStub::Stub, response: double("StubResponse", status: 500, body: "Some text")))
       end
 
       it "should respond with the configured status" do

data/spec/lib/{http → http_stub}/start_server_rake_task_integration_spec.rb

@@ -1,4 +1,4 @@
-describe Http::Stub::StartServerRakeTask do
+describe HttpStub::StartServerRakeTask do
   include_context "server integration"
 
   describe("when the generated task is invoked") do

data/spec/lib/{http → http_stub}/stub_spec.rb

@@ -1,4 +1,4 @@
-describe Http::Stub::Stub do
+describe HttpStub::Stub do
 
   let(:stub_uri) { "/a_path" }
   let(:stub_method) { "get" }
@@ -15,7 +15,7 @@ describe Http::Stub::Stub do
     }.to_json
   end
   let(:stub_request) { double("HttpRequest", :body => double("HttpRequestBody", :read => stub_body)) }
-  let(:stub_instance) { Http::Stub::Stub.new(stub_request) }
+  let(:stub_instance) { HttpStub::Stub.new(stub_request) }
 
   describe "#stubs?" do
 

data/spec/spec_helper.rb

@@ -1,7 +1,7 @@
 require 'cover_me'
 require 'rack/test'
 
-require File.expand_path('../../lib/http/stub/start_server_rake_task', __FILE__)
+require File.expand_path('../../lib/http_stub/start_server_rake_task', __FILE__)
 require File.expand_path('../../lib/http_stub', __FILE__)
 
 Dir[File.expand_path('../support/**/*.rb', __FILE__)].each { |file| require file }

data/spec/support/server_integration.rb

@@ -1,4 +1,4 @@
-share_examples_for "server integration" do
+shared_context "server integration" do
 
   FIVE_SECONDS = 5
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: http_stub
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-12 00:00:00.000000000 Z
+date: 2013-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -44,6 +44,102 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: cover_me
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: flog
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.2
+- !ruby/object:Gem::Dependency
+  name: travis-lint
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.0
 description: Configure server responses via requests to /stub.  Intended as an acceptance
   / integration testing tool.
 email: matthew.ueckerman@myob.com
@@ -51,19 +147,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ./lib/http/stub/client.rb
-- ./lib/http/stub/registry.rb
-- ./lib/http/stub/server.rb
-- ./lib/http/stub/start_server_rake_task.rb
-- ./lib/http/stub/stub.rb
-- ./lib/http/stub/version.rb
+- ./lib/http_stub/client.rb
+- ./lib/http_stub/registry.rb
+- ./lib/http_stub/server.rb
+- ./lib/http_stub/start_server_rake_task.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/registry_spec.rb
-- ./spec/lib/http/server_spec.rb
-- ./spec/lib/http/start_server_rake_task_integration_spec.rb
-- ./spec/lib/http/stub_spec.rb
+- ./spec/curl_samples.txt
+- ./spec/lib/http_stub/client_integration_spec.rb
+- ./spec/lib/http_stub/registry_spec.rb
+- ./spec/lib/http_stub/server_spec.rb
+- ./spec/lib/http_stub/start_server_rake_task_integration_spec.rb
+- ./spec/lib/http_stub/stub_spec.rb
 - ./spec/spec_helper.rb
 - ./spec/support/server_integration.rb
 homepage: http://github.com/MYOB-Technology/http_stub
@@ -87,19 +183,19 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 698355929090701443
+      hash: -2002962712402429402
 requirements: []
 rubyforge_project: http_stub
 rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
-summary: A Http Server replaying configured stub responses
+summary: A HTTP Server replaying configured stub responses
 test_files:
-- ./spec/curl_sample.txt
-- ./spec/lib/http/client_integration_spec.rb
-- ./spec/lib/http/registry_spec.rb
-- ./spec/lib/http/server_spec.rb
-- ./spec/lib/http/start_server_rake_task_integration_spec.rb
-- ./spec/lib/http/stub_spec.rb
+- ./spec/curl_samples.txt
+- ./spec/lib/http_stub/client_integration_spec.rb
+- ./spec/lib/http_stub/registry_spec.rb
+- ./spec/lib/http_stub/server_spec.rb
+- ./spec/lib/http_stub/start_server_rake_task_integration_spec.rb
+- ./spec/lib/http_stub/stub_spec.rb
 - ./spec/spec_helper.rb
 - ./spec/support/server_integration.rb

data/lib/http/stub/client.rb

@@ -1,60 +0,0 @@
-module Http
-  module Stub
-    module Client
-
-      def self.included(mod)
-        mod.extend(Http::Stub::Client::ClassMethods)
-        mod.send(:include, Http::Stub::Client::InstanceMethods)
-      end
-
-      module ClassMethods
-
-        attr_reader :host_value, :port_value
-
-        def host(host)
-          @host_value = host
-        end
-
-        def port(port)
-          @port_value = port
-        end
-
-      end
-
-      module InstanceMethods
-
-        def stub!(uri, options)
-          response_options = options[:response]
-          request = Net::HTTP::Post.new("/stub")
-          request.content_type = "application/json"
-          request.body = {
-              "uri" => uri,
-              "method" => options[:method],
-              "response" => {
-                  "status" => response_options[:status] || "200",
-                  "body" => response_options[:body]
-              }
-          }.to_json
-          response = submit(request)
-          raise "Unable to stub request: #{response.message}" unless response.code == "200"
-        end
-
-        alias_method :stub_response!, :stub!
-
-        def clear!
-          request = Net::HTTP::Delete.new("/stubs")
-          response = submit(request)
-          raise "Unable to clear stubs: #{response.message}" unless response.code == "200"
-        end
-
-        private
-
-        def submit(request)
-          Net::HTTP.new(self.class.host_value, self.class.port_value).start { |http| http.request(request) }
-        end
-
-      end
-
-    end
-  end
-end

data/lib/http/stub/registry.rb

@@ -1,28 +0,0 @@
-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
-
-      def clear(request)
-        request.logger.info "Clearing stubs"
-        @stubs.clear
-      end
-
-    end
-
-  end
-end

data/lib/http/stub/server.rb

@@ -1,58 +0,0 @@
-module Http
-  module Stub
-
-    class Server < ::Sinatra::Base
-
-      enable :dump_errors, :logging
-
-      def initialize
-        super()
-        @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
-
-      public
-
-      # Sample request body:
-      # {
-      #   "uri": "/some/path",
-      #   "method": "get",
-      #   "parameters": {
-      #     "key": "value",
-      #     ...
-      #   },
-      #   "response": {
-      #     "status": "200",
-      #     "body": "Hello World"
-      #   }
-      # }
-      post "/stub" do
-        @registry.add(Http::Stub::Stub.new(request), request)
-        halt 200
-      end
-
-      delete "/stubs" do
-        @registry.clear(request)
-        halt 200
-      end
-
-      any_request_type(//) { handle_stub_request }
-
-      private
-
-      def handle_stub_request
-        stub = @registry.find_for(request)
-        stub ? halt(stub.response.status, stub.response.body) : halt(404)
-      end
-
-    end
-
-  end
-end

data/lib/http/stub/start_server_rake_task.rb

@@ -1,22 +0,0 @@
-require File.expand_path('../../../http_stub', __FILE__)
-require 'rake/tasklib' unless defined?(::Rake::TaskLib)
-
-module Http
-  module Stub
-
-    class StartServerRakeTask < ::Rake::TaskLib
-
-      def initialize(options)
-        desc "Starts stub #{options[:name]}"
-        task "start_#{options[:name]}" do
-          Http::Stub::Server.instance_eval do
-            set :port, options[:port]
-            run!
-          end
-        end
-      end
-
-    end
-
-  end
-end

data/lib/http/stub/stub.rb

@@ -1,32 +0,0 @@
-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 +0,0 @@
-module Http
-  module Stub
-    VERSION = "0.0.4"
-  end
-end

data/spec/curl_sample.txt

@@ -1 +0,0 @@
-curl -v -H "Accept: application/json" -H "Content-type: application/json" -X POST -d '{"uri": "/test", "method": "get", "response": {"status":"200", "body":"Foo"}}' http://localhost:8001/stub