http_stub 0.25.1 → 0.26.0

data/lib/http_stub/configurer/dsl/stub_builder_template.rb

@@ -0,0 +1,26 @@
+module HttpStub
+  module Configurer
+    module DSL
+
+      class StubBuilderTemplate
+
+        attr_reader :template
+
+        delegate :match_requests, :schema, :respond_with, :trigger, :invoke, to: :@template
+
+        def initialize(parent_template=nil, &block)
+          @template = HttpStub::Configurer::DSL::StubBuilder.new(parent_template.try(:template), &block)
+        end
+
+        def build_stub(response_overrides={}, &block)
+          HttpStub::Configurer::DSL::StubBuilder.new(@template) do |stub|
+            stub.respond_with(response_overrides)
+            stub.invoke(&block) if block_given?
+          end
+        end
+
+      end
+
+    end
+  end
+end

data/lib/http_stub/configurer/request/http/basic.rb

@@ -5,12 +5,18 @@ module HttpStub
 
         class Basic
 
-          def initialize(http_request)
-            @http_request = http_request
+          def initialize(args)
+            @request_method = args[:method]
+            @path           = args[:path]
+            @headers        = args[:headers] || {}
+            @parameters     = args[:parameters]
           end
 
           def to_http_request
-            @http_request
+            http_request_class = Net::HTTP.const_get(@request_method.to_s.capitalize)
+            http_request_class.new("/http_stub/#{@path}", @headers.stringify_keys).tap do |http_request|
+              http_request.set_form_data(@parameters) if @parameters
+            end
           end
 
         end

data/lib/http_stub/configurer/request/http/factory.rb

@@ -7,29 +7,20 @@ module HttpStub
 
           class << self
 
-            def multipart(model)
-              HttpStub::Configurer::Request::Http::Multipart.new(model)
+            def multipart(path, model, headers={})
+              HttpStub::Configurer::Request::Http::Multipart.new(path: path, headers: headers, model: model)
             end
 
-            def get(path)
-              create_basic_request(:get, path.start_with?("/") ? path : "/#{path}")
+            def get(path, headers={})
+              HttpStub::Configurer::Request::Http::Basic.new(method: :get, path: path, headers: headers)
             end
 
             def post(path, parameters={})
-              create_basic_request(:post, path) { |http_request| http_request.set_form_data(parameters) }
+              HttpStub::Configurer::Request::Http::Basic.new(method: :post, path: path, parameters: parameters)
             end
 
-            def delete(path)
-              create_basic_request(:delete, path)
-            end
-
-            private
-
-            def create_basic_request(request_method, path, &_block)
-              http_request_class = Net::HTTP.const_get(request_method.to_s.capitalize)
-              http_request = http_request_class.new(path)
-              yield http_request if block_given?
-              HttpStub::Configurer::Request::Http::Basic.new(http_request)
+            def delete(path, headers={})
+              HttpStub::Configurer::Request::Http::Basic.new(method: :delete, path: path, headers: headers)
             end
 
           end

data/lib/http_stub/configurer/request/http/multipart.rb

@@ -5,20 +5,18 @@ module HttpStub
 
         class Multipart
 
-          def initialize(model)
-            @model = model
+          def initialize(args)
+            @model   = args[:model]
+            @path    = args[:path]
+            @headers = args[:headers] || {}
           end
 
           def to_http_request
-            Net::HTTP::Post::Multipart.new(path, parameters)
+            Net::HTTP::Post::Multipart.new("/http_stub/#{@path}", parameters, @headers.stringify_keys)
           end
 
           private
 
-          def path
-            "/http_stub/#{@model.class.name.demodulize.pluralize.underscore}"
-          end
-
           def parameters
             { payload: @model.payload.to_json }.tap do |parameters|
               @model.response_files.each do |response_file|

data/lib/http_stub/configurer/request/stub.rb

@@ -8,7 +8,7 @@ module HttpStub
           @id       = SecureRandom.uuid
           @request  = args[:request]
           @response = HttpStub::Configurer::Request::StubResponse.new(@id, args[:response])
-          @triggers = args[:triggers].map(&:build)
+          @triggers = HttpStub::Configurer::Request::Triggers.new(args[:triggers])
         end
 
         def payload
@@ -20,12 +20,12 @@ module HttpStub
             parameters: HttpStub::Configurer::Request::ControllableValue.format(@request[:parameters] || {}),
             body:       HttpStub::Configurer::Request::ControllableValue.format(@request[:body] || {}),
             response:   @response.payload,
-            triggers:   @triggers.map(&:payload)
+            triggers:   @triggers.payload
           }
         end
 
         def response_files
-          ([ @response.file ] + @triggers.map(&:response_files)).flatten.compact
+          ([ @response.file ] + @triggers.response_files).compact
         end
 
         def to_s

data/lib/http_stub/configurer/request/triggers.rb

@@ -0,0 +1,25 @@
+module HttpStub
+  module Configurer
+    module Request
+
+      class Triggers
+
+        def initialize(args)
+          @scenario_names = args[:scenario_names]
+          @stubs          = args[:stubs]
+        end
+
+        def response_files
+          @stubs.map(&:response_files).flatten
+        end
+
+        def payload
+          { scenario_names: @scenario_names, stubs: @stubs.map(&:payload) }
+        end
+
+      end
+
+    end
+  end
+
+end

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

@@ -4,12 +4,12 @@ module HttpStub
 
       class CommandProcessor
 
-        def initialize(configurer)
-          @configurer = configurer
+        def initialize(configuration)
+          @configuration = configuration
         end
 
         def process(command, http_options={})
-          response = Net::HTTP.start(host, port, http_options) { |http| http.request(command.http_request) }
+          response = send_command(command, http_options)
           raise "#{error_message_prefix(command)}: #{response.code} #{response.message}" unless response.code == "200"
           response
         rescue StandardError => err
@@ -18,16 +18,14 @@ module HttpStub
 
         private
 
-        def host
-          @configurer.stub_server.host
-        end
-
-        def port
-          @configurer.stub_server.port
+        def send_command(command, http_options)
+          Net::HTTP.start(@configuration.host, @configuration.port, http_options) do |http|
+            http.request(command.http_request)
+          end
         end
 
         def error_message_prefix(command)
-          "Error occurred #{command.description} whilst configuring #{@configurer.stub_server.base_uri}: "
+          "Error occurred #{command.description} whilst configuring #{@configuration.base_uri}: "
         end
 
       end

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

@@ -0,0 +1,33 @@
+module HttpStub
+  module Configurer
+    module Server
+
+      class Configuration
+
+        attr_accessor :host, :port, :session_identifier
+
+        def initialize
+          @enabled_features = []
+        end
+
+        def base_uri
+          "http://#{host}:#{port}"
+        end
+
+        def external_base_uri
+          ENV["STUB_EXTERNAL_BASE_URI"] || base_uri
+        end
+
+        def enable(*features)
+          @enabled_features = features
+        end
+
+        def enabled?(feature)
+          @enabled_features.include?(feature)
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -4,72 +4,50 @@ module HttpStub
 
       class Facade
 
-        STUBS_BASE_URI          = "/http_stub/stubs".freeze
-        STUB_MEMORY_URI         = "#{STUBS_BASE_URI}/memory".freeze
-        SCENARIOS_BASE_URI      = "/http_stub/scenarios".freeze
-        SCENARIO_ACTIVATION_URI = "#{SCENARIOS_BASE_URI}/activate".freeze
+        attr_reader :default_session
 
-        private_constant :STUBS_BASE_URI, :STUB_MEMORY_URI, :SCENARIOS_BASE_URI, :SCENARIO_ACTIVATION_URI
-
-        def initialize(configurer)
-          @request_processor = HttpStub::Configurer::Server::RequestProcessor.new(configurer)
-        end
-
-        def stub_response(model)
-          @request_processor.submit(
-            request:     HttpStub::Configurer::Request::Http::Factory.multipart(model),
-            description: "stubbing '#{model}'"
-          )
+        def initialize(configuration)
+          @request_processor = HttpStub::Configurer::Server::RequestProcessor.new(configuration)
         end
 
-        def define_scenario(model)
-          @request_processor.submit(
-            request:     HttpStub::Configurer::Request::Http::Factory.multipart(model),
-            description: "registering scenario '#{model}'"
-          )
+        def server_has_started
+          @request_processor.disable_buffering!
         end
 
-        def activate(scenario_name)
-          request = HttpStub::Configurer::Request::Http::Factory.post(SCENARIO_ACTIVATION_URI, name: scenario_name)
-          @request_processor.submit(
-            request:     request,
-            description: "activating '#{scenario_name}'"
-          )
+        def flush_requests
+          @request_processor.flush!
         end
 
-        def remember_stubs
+        def reset
           @request_processor.submit(
-            request:      HttpStub::Configurer::Request::Http::Factory.post(STUB_MEMORY_URI),
-            description: "committing stubs to memory"
+            request:     HttpStub::Configurer::Request::Http::Factory.delete("memory"),
+            description: "resetting server"
           )
         end
 
-        def recall_stubs
+        def define_scenario(scenario)
           @request_processor.submit(
-            request:     HttpStub::Configurer::Request::Http::Factory.get(STUB_MEMORY_URI),
-            description: "recalling stubs in memory"
+            request:     HttpStub::Configurer::Request::Http::Factory.multipart("scenarios", scenario),
+            description: "registering scenario '#{scenario}'"
           )
         end
 
-        def clear_stubs
-          @request_processor.submit(
-            request:     HttpStub::Configurer::Request::Http::Factory.delete(STUBS_BASE_URI),
-            description: "clearing stubs")
-        end
-
         def clear_scenarios
           @request_processor.submit(
-            request:     HttpStub::Configurer::Request::Http::Factory.delete(SCENARIOS_BASE_URI),
+            request:     HttpStub::Configurer::Request::Http::Factory.delete("scenarios"),
             description: "clearing scenarios"
           )
         end
 
-        def server_has_started
-          @request_processor.disable_buffering!
+        def create_session_facade(id)
+          HttpStub::Configurer::Server::SessionFacade.new(id, @request_processor)
         end
 
-        def flush_requests
-          @request_processor.flush!
+        def clear_sessions
+          @request_processor.submit(
+            request:     HttpStub::Configurer::Request::Http::Factory.delete("sessions"),
+            description: "clearing sessions"
+          )
         end
 
       end

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

@@ -4,8 +4,8 @@ module HttpStub
 
       class RequestProcessor
 
-        def initialize(configurer)
-          @command_processor = HttpStub::Configurer::Server::CommandProcessor.new(configurer)
+        def initialize(configuration)
+          @command_processor = HttpStub::Configurer::Server::CommandProcessor.new(configuration)
           @buffered_command_processor = @active_processor =
             HttpStub::Configurer::Server::BufferedCommandProcessor.new(@command_processor)
         end

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

@@ -0,0 +1,64 @@
+module HttpStub
+  module Configurer
+    module Server
+
+      class SessionFacade
+
+        REQUEST_FACTORY = HttpStub::Configurer::Request::Http::Factory
+
+        private_constant :REQUEST_FACTORY
+
+        def initialize(session_id, request_processor)
+          @session_id          = session_id
+          @request_processor   = request_processor
+          @session_description = "session '#{session_id}'"
+        end
+
+        def mark_as_default
+          @request_processor.submit(
+            request:     REQUEST_FACTORY.post("sessions/default", http_stub_session_id: @session_id),
+            description: "marking #{@session_description} as the default"
+          )
+        end
+
+        def stub_response(stub)
+          @request_processor.submit(
+            request:     REQUEST_FACTORY.multipart("stubs", stub, http_stub_session_id: @session_id),
+            description: "stubbing '#{stub}' in #{@session_description}"
+          )
+        end
+
+        def activate(scenario_names)
+          parameters = { http_stub_session_id: @session_id, "names[]" => scenario_names }
+          @request_processor.submit(
+            request:     REQUEST_FACTORY.post("scenarios/activate", parameters),
+            description: "activating #{scenario_names.map { |name| "'#{name}'" }.join(", ")} in #{@session_description}"
+          )
+        end
+
+        def reset_stubs
+          @request_processor.submit(
+            request:     REQUEST_FACTORY.post("stubs/reset", http_stub_session_id: @session_id),
+            description: "resetting stubs in #{@session_description}"
+          )
+        end
+
+        def clear_stubs
+          @request_processor.submit(
+            request:     REQUEST_FACTORY.delete("stubs", http_stub_session_id: @session_id),
+            description: "clearing stubs in #{@session_description}"
+          )
+        end
+
+        def delete
+          @request_processor.submit(
+            request:     REQUEST_FACTORY.delete("sessions", http_stub_session_id: @session_id),
+            description: "deleting #{@session_description}"
+          )
+        end
+
+      end
+
+    end
+  end
+end

data/lib/http_stub/extensions/core/uri.rb

@@ -0,0 +1,28 @@
+module HttpStub
+  module Extensions
+    module Core
+
+      module URI
+
+        def self.included(mod)
+          mod.extend(ClassMethods)
+        end
+
+        module ClassMethods
+
+          def add_parameters(uri, parameters)
+            parsed_uri = ::URI.parse(uri)
+            existing_parameters = ::URI.decode_www_form(parsed_uri.query || "").to_h
+            parsed_uri.query = ::URI.encode_www_form(existing_parameters.merge(parameters))
+            parsed_uri.to_s
+          end
+
+        end
+
+      end
+
+    end
+  end
+end
+
+::URI.send(:include, HttpStub::Extensions::Core::URI)

data/lib/http_stub/extensions/rack/handler.rb

@@ -1,6 +1,7 @@
 module HttpStub
   module Extensions
     module Rack
+
       module Handler
 
         def self.included(mod)