http_stub 0.19.1 → 0.20.0

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: db776c7504fe1de45fec47a235aabd80355a1f10
-  data.tar.gz: 9900db1809f2a8404f17bd8c53b1d161d87c00ff
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YzEzZTE3NjYzODQyZTFjMTU1NzdjNDk1YmE3MDBmYWVlYjQzNTRlMQ==
+  data.tar.gz: !binary |-
+    YzI4MjA5ZjI5NzI1NmYyNDEzMGI4OWM0MDhmYjg5NTcyNGJlNTk3NQ==
 SHA512:
-  metadata.gz: b7e98fe17e5a5af10bf737bc77d6766f53f4c3557a8a3130cf851fffe63089632433844a24471ec4c3e60b2976faa03fe963982a6cb5e6f5f623d047b6cf4087
-  data.tar.gz: f0a8e46fa7721be673816eb64e8311b92c1a6b02dd67455769cf2e676d02b7b8c38b94ff7476a4034658777942d8987b26eb91d5ff0a96692366a4e4164dc470
+  metadata.gz: !binary |-
+    ODkwODg5NzU4Yzk0MjdhZjJlMmE1Nzg5ZjFmMmRlZGM2MmI4ZmZlZWJmZTE2
+    MzViMTBmMmY1NWE4MGMxOTBiOWMwYmExMTVmNDQ5ZWM5NzQyMWU1MjA1YzAw
+    MjlkMDBjYTJjNDI0NDRmNTgzMDhkYzU4ODI3OTEwMDYyOGY4MjA=
+  data.tar.gz: !binary |-
+    ODk0MTQ5YmNjN2I0YjZkYmRjZDc0ZDU2NWNlMWUzZTU3NGRhMmRjOTZkMDUy
+    NjEwYzIzZGNiMDg4MTMxMDc0N2RjOTIwNDY4OTcwMjRmMThhMjk0NzNlYmY4
+    ZTUxOWIyMTAyODY5NDIxMWIxNTdhZThhNzM0MWM5NzQyNzFjNGY=

data/lib/http_stub.rb

@@ -20,39 +20,43 @@ require 'active_support/core_ext/hash/indifferent_access'
 require_relative 'http_stub/hash_with_indifferent_and_insensitive_access'
 require_relative 'http_stub/extensions/core/hash'
 require_relative 'http_stub/extensions/rack/handler'
+require_relative 'http_stub/server/formatted_hash'
+require_relative 'http_stub/server/header_parser'
+require_relative 'http_stub/server/request'
 require_relative 'http_stub/server/registry'
-require_relative 'http_stub/server/stub/omitted_value_matcher'
-require_relative 'http_stub/server/stub/regexp_value_matcher'
-require_relative 'http_stub/server/stub/exact_value_matcher'
-require_relative 'http_stub/server/stub/string_value_matcher'
-require_relative 'http_stub/server/stub/hash_with_string_value_matchers'
-require_relative 'http_stub/server/stub/headers'
-require_relative 'http_stub/server/stub/request_header_parser'
-require_relative 'http_stub/server/stub/payload_file_consolidator'
-require_relative 'http_stub/server/stub/request_parser'
-require_relative 'http_stub/server/stub/truthy_request_matcher'
-require_relative 'http_stub/server/stub/uri'
-require_relative 'http_stub/server/stub/method'
-require_relative 'http_stub/server/stub/request_headers'
-require_relative 'http_stub/server/stub/request_parameters'
-require_relative 'http_stub/server/stub/simple_request_body'
-require_relative 'http_stub/server/stub/json_request_body'
-require_relative 'http_stub/server/stub/request_body'
+require_relative 'http_stub/server/stub/match/omitted_value_matcher'
+require_relative 'http_stub/server/stub/match/regexp_value_matcher'
+require_relative 'http_stub/server/stub/match/exact_value_matcher'
+require_relative 'http_stub/server/stub/match/string_value_matcher'
+require_relative 'http_stub/server/stub/match/hash_with_string_value_matchers'
+require_relative 'http_stub/server/stub/match/truthy_matcher'
+require_relative 'http_stub/server/stub/match/rule/uri'
+require_relative 'http_stub/server/stub/match/rule/method'
+require_relative 'http_stub/server/stub/match/rule/headers'
+require_relative 'http_stub/server/stub/match/rule/parameters'
+require_relative 'http_stub/server/stub/match/rule/simple_body'
+require_relative 'http_stub/server/stub/match/rule/json_body'
+require_relative 'http_stub/server/stub/match/rule/body'
 require_relative 'http_stub/server/stub/response/base'
 require_relative 'http_stub/server/stub/response/text'
 require_relative 'http_stub/server/stub/response/file'
 require_relative 'http_stub/server/stub/response'
+require_relative 'http_stub/server/response'
 require_relative 'http_stub/server/stub/triggers'
-require_relative 'http_stub/server/stub/instance'
+require_relative 'http_stub/server/stub/payload_file_consolidator'
+require_relative 'http_stub/server/stub/parser'
+require_relative 'http_stub/server/stub/stub'
+require_relative 'http_stub/server/stub/empty'
+require_relative 'http_stub/server/stub/match/match'
 require_relative 'http_stub/server/stub/registry'
 require_relative 'http_stub/server/stub/controller'
 require_relative 'http_stub/server/stub'
-require_relative 'http_stub/server/scenario/request_parser'
-require_relative 'http_stub/server/scenario/instance'
+require_relative 'http_stub/server/scenario/parser'
+require_relative 'http_stub/server/scenario/scenario'
 require_relative 'http_stub/server/scenario/activator'
 require_relative 'http_stub/server/scenario/controller'
 require_relative 'http_stub/server/scenario'
-require_relative 'http_stub/server/response'
+require_relative 'http_stub/server/request_pipeline'
 require_relative 'http_stub/server/response_pipeline'
 require_relative 'http_stub/server/application'
 require_relative 'http_stub/server/daemon'
@@ -79,5 +83,6 @@ require_relative 'http_stub/configurer/dsl/endpoint_template'
 require_relative 'http_stub/configurer/dsl/stub_activator_builder'
 require_relative 'http_stub/configurer/dsl/server'
 require_relative 'http_stub/configurer/dsl/deprecated'
+require_relative 'http_stub/configurer/dsl/deprecated'
 require_relative 'http_stub/configurer/part'
 require_relative 'http_stub/configurer'

data/lib/http_stub/configurer/server/command_processor.rb

@@ -12,6 +12,7 @@ module HttpStub
           begin
             response = Net::HTTP.start(host, port) { |http| http.request(command.http_request) }
             raise "#{error_message_prefix(command)}: #{response.code} #{response.message}" unless response.code == "200"
+            response
           rescue Exception => exc
             raise "#{error_message_prefix(command)}: #{exc}"
           end

data/lib/http_stub/server/application.rb

@@ -9,10 +9,13 @@ module HttpStub
 
       def initialize
         super()
-        @stub_registry       = HttpStub::Server::Stub::Registry.new
+        @match_registry      = HttpStub::Server::Registry.new("match")
+        @stub_registry       = HttpStub::Server::Stub::Registry.new(@match_registry)
         @scenario_registry   = HttpStub::Server::Registry.new("scenario")
         @stub_controller     = HttpStub::Server::Stub::Controller.new(@stub_registry)
         @scenario_controller = HttpStub::Server::Scenario::Controller.new(@scenario_registry, @stub_registry)
+        @request_pipeline    =
+          HttpStub::Server::RequestPipeline.new(@stub_controller, @scenario_controller, @match_registry)
       end
 
       private
@@ -23,29 +26,15 @@ module HttpStub
         SUPPORTED_REQUEST_TYPES.each { |type| self.send(type, path, opts, &block) }
       end
 
-      before { @response_pipeline = HttpStub::Server::ResponsePipeline.new(self) }
+      before do
+        @response_pipeline = HttpStub::Server::ResponsePipeline.new(self)
+        @http_stub_request = HttpStub::Server::Request.new(request)
+      end
 
       public
 
-      # Sample request body:
-      # {
-      #   "uri": "/some/path",
-      #   "method": "get",
-      #   "headers": {
-      #     "key": "value",
-      #     ...
-      #   },
-      #   "parameters": {
-      #     "key": "value",
-      #     ...
-      #   },
-      #   "response": {
-      #     "status": "200",
-      #     "body": "Hello World"
-      #   }
-      # }
       post "/stubs" do
-        response = @stub_controller.register(request)
+        response = @stub_controller.register(@http_stub_request, logger)
         @response_pipeline.process(response)
       end
 
@@ -54,7 +43,7 @@ module HttpStub
       end
 
       delete "/stubs" do
-        @stub_controller.clear(request)
+        @stub_controller.clear(logger)
         halt 200, "OK"
       end
 
@@ -68,21 +57,12 @@ module HttpStub
         halt 200, "OK"
       end
 
-      # Sample request body:
-      # {
-      #   "name": "some_scenario_name",
-      #   "stubs": [
-      #     {
-      #       ... see /stub ...
-      #     },
-      #   ],
-      #   "triggered_scenario_names": [
-      #     "some_other_scenario_name",
-      #    ...
-      #   ]
-      # }
+      get "/stubs/matches" do
+        haml :matches, {}, matches: @match_registry.all
+      end
+
       post "/stubs/scenarios" do
-        response = @scenario_controller.register(request)
+        response = @scenario_controller.register(@http_stub_request, logger)
         @response_pipeline.process(response)
       end
 
@@ -91,15 +71,22 @@ module HttpStub
       end
 
       delete "/stubs/scenarios" do
-        @scenario_controller.clear(request)
+        @scenario_controller.clear(logger)
         halt 200, "OK"
       end
 
+      get "/stubs/:id" do
+        haml :stub, {}, the_stub: @stub_registry.find(params[:id], logger)
+      end
+
       get "/application.css" do
         sass :application
       end
 
-      any_request_type(//) { handle_request }
+      any_request_type(//) do
+        response = @request_pipeline.process(@http_stub_request, logger)
+        @response_pipeline.process(response)
+      end
 
       helpers do
 
@@ -109,15 +96,6 @@ module HttpStub
 
       end
 
-      private
-
-      def handle_request
-        response = @stub_controller.replay(request)
-        response = @scenario_controller.activate(request) if response.empty?
-        response = HttpStub::Server::Response::ERROR if response.empty?
-        @response_pipeline.process(response)
-      end
-
     end
 
   end

data/lib/http_stub/server/formatted_hash.rb

@@ -0,0 +1,18 @@
+module HttpStub
+  module Server
+
+    class FormattedHash < Hash
+
+      def initialize(hash, key_value_delimiter)
+        self.merge!(hash || {})
+        @key_value_delimiter = key_value_delimiter
+      end
+
+      def to_s
+        self.map { |key_and_value| key_and_value.map(&:to_s).join(@key_value_delimiter) }.join(", ")
+      end
+
+    end
+
+  end
+end

data/lib/http_stub/server/header_parser.rb

@@ -0,0 +1,17 @@
+module HttpStub
+  module Server
+
+    class HeaderParser
+
+      def self.parse(request)
+        request.env.reduce(HttpStub::Server::FormattedHash.new({}, ":")) do |result, element|
+          match = element[0].match(/^(?:HTTP_)?([A-Z0-9_]+)$/)
+          result[match[1]] = element[1] if match
+          result
+        end
+      end
+
+    end
+
+  end
+end

data/lib/http_stub/server/registry.rb

@@ -8,18 +8,18 @@ module HttpStub
         @models = []
       end
 
-      def add(model, request)
+      def add(model, logger)
         @models.unshift(model)
-        request.logger.info "Registered #{@model_name}: #{model}"
+        logger.info "Registered #{@model_name}: #{model}"
       end
 
-      def concat(models, request)
-        models.each { |model| self.add(model, request) }
+      def concat(models, logger)
+        models.each { |model| self.add(model, logger) }
       end
 
-      def find(args)
-        args[:request].logger.info "Finding #{@model_name} satisfying: #{args[:criteria]}"
-        @models.find { |model| model.satisfies?(args[:criteria]) }
+      def find(criteria, logger)
+        logger.info "Finding #{@model_name} matching: #{criteria}"
+        @models.find { |model| model.matches?(criteria, logger) }
       end
 
       def last
@@ -35,8 +35,8 @@ module HttpStub
         @models = @models.slice(starting_index..-1) if starting_index
       end
 
-      def clear(request)
-        request.logger.info "Clearing #{@model_name} registry"
+      def clear(logger)
+        logger.info "Clearing #{@model_name} registry"
         @models.clear
       end
 

data/lib/http_stub/server/request.rb

@@ -0,0 +1,19 @@
+module HttpStub
+  module Server
+
+    class Request
+
+      attr_reader :uri, :method, :headers, :parameters, :body
+
+      def initialize(request)
+        @uri        = request.path_info
+        @method     = request.request_method.downcase
+        @headers    = HttpStub::Server::FormattedHash.new(HttpStub::Server::HeaderParser.parse(request), ":")
+        @parameters = HttpStub::Server::FormattedHash.new(request.params, "=")
+        @body       = request.body.read
+      end
+
+    end
+
+  end
+end

data/lib/http_stub/server/request_pipeline.rb

@@ -0,0 +1,27 @@
+module HttpStub
+  module Server
+
+    class RequestPipeline
+
+      def initialize(stub_controller, scenario_controller, match_registry)
+        @stub_controller     = stub_controller
+        @scenario_controller = scenario_controller
+        @match_registry      = match_registry
+      end
+
+      def process(request, logger)
+        response = @stub_controller.replay(request, logger)
+        response = @scenario_controller.activate(request, logger) if response.empty?
+        response.empty? ? process_unmatched(request, logger) : response
+      end
+
+      private
+
+      def process_unmatched(request, logger)
+        @match_registry.add(HttpStub::Server::Stub::Match::Match.new(nil, request), logger)
+        HttpStub::Server::Response::NOT_FOUND
+      end
+    end
+
+  end
+end

data/lib/http_stub/server/response.rb

@@ -3,9 +3,13 @@ module HttpStub
 
     class Response
 
-      SUCCESS = HttpStub::Server::Stub::Response::Text.new("status" => 200, "body" => "OK").freeze
-      ERROR   = HttpStub::Server::Stub::Response::Text.new("status" => 404, "body" => "ERROR").freeze
-      EMPTY   = HttpStub::Server::Stub::Response::Text.new.freeze
+      def self.success(headers={})
+        HttpStub::Server::Stub::Response::Text.new("status" => 200, "headers" => headers, "body" => "OK")
+      end
+
+      SUCCESS   = success.freeze
+      NOT_FOUND = HttpStub::Server::Stub::Response::Text.new("status" => 404, "body" => "NOT FOUND").freeze
+      EMPTY     = HttpStub::Server::Stub::Response::Text.new.freeze
 
     end
 

data/lib/http_stub/server/scenario.rb

@@ -4,7 +4,7 @@ module HttpStub
     module Scenario
 
       def self.create(args)
-        HttpStub::Server::Scenario::Instance.new(args)
+        HttpStub::Server::Scenario::Scenario.new(args)
       end
 
     end

data/lib/http_stub/server/scenario/activator.rb

@@ -9,12 +9,12 @@ module HttpStub
           @stub_registry     = stub_registry
         end
 
-        def activate(scenario, request)
-          @stub_registry.concat(scenario.stubs, request)
+        def activate(scenario, logger)
+          @stub_registry.concat(scenario.stubs, logger)
           scenario.triggered_scenario_names.each do |triggered_scenario_name|
-            scenario_to_activate = @scenario_registry.find(criteria: triggered_scenario_name, request: request)
+            scenario_to_activate = @scenario_registry.find(triggered_scenario_name, logger)
             raise "Scenario not found with name '#{triggered_scenario_name}'" unless scenario_to_activate
-            activate(scenario_to_activate, request)
+            activate(scenario_to_activate, logger)
           end
         end
 

data/lib/http_stub/server/scenario/controller.rb

@@ -9,24 +9,24 @@ module HttpStub
           @scenario_activator = HttpStub::Server::Scenario::Activator.new(scenario_registry, stub_registry)
         end
 
-        def register(request)
-          scenario = HttpStub::Server::Scenario.create(HttpStub::Server::Scenario::RequestParser.parse(request))
-          @scenario_registry.add(scenario, request)
+        def register(request, logger)
+          scenario = HttpStub::Server::Scenario.create(HttpStub::Server::Scenario::Parser.parse(request))
+          @scenario_registry.add(scenario, logger)
           HttpStub::Server::Response::SUCCESS
         end
 
-        def activate(request)
-          scenario = @scenario_registry.find(criteria: request.path_info.gsub(/^\//, ""), request: request)
+        def activate(request, logger)
+          scenario = @scenario_registry.find(request.uri.gsub(/^\//, ""), logger)
           if scenario
-            @scenario_activator.activate(scenario, request)
+            @scenario_activator.activate(scenario, logger)
             HttpStub::Server::Response::SUCCESS
           else
             HttpStub::Server::Response::EMPTY
           end
         end
 
-        def clear(request)
-          @scenario_registry.clear(request)
+        def clear(logger)
+          @scenario_registry.clear(logger)
         end
 
       end

data/lib/http_stub/server/scenario/{request_parser.rb → parser.rb}

@@ -2,10 +2,10 @@ module HttpStub
   module Server
     module Scenario
 
-      class RequestParser
+      class Parser
 
         def self.parse(request)
-          JSON.parse(request.params["payload"]).tap do |payload|
+          JSON.parse(request.parameters["payload"]).tap do |payload|
             payload["stubs"].each do |stub_payload|
               HttpStub::Server::Stub::PayloadFileConsolidator.consolidate!(stub_payload, request)
             end