http_stub 0.14.2 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 462d586bf168313bf0a34ff8549b6120d336503a
-  data.tar.gz: 1ea3c26af008e2a0fe3339c7827e170ecf252648
+  metadata.gz: 77eb1d522a9c4187caae1203528f66741295bffe
+  data.tar.gz: f089d9c6e085126c6be87386a77cc1295b142e9c
 SHA512:
-  metadata.gz: 0c6a2fbd7db3b9e04d4b7ebdd52b7a4fe910001a1d11474962a532a61d5c1a86f7ed193891ff69aa701a724c7362ecbab5a2aed3ee84260208243547fa5a770c
-  data.tar.gz: 0fdb121126205ad0628b2aead6012ae5c6dd7828c1d5bedcfc726739f77cbadd5f1ffeb22c98819e316316f08f0b8343033c570375ca3a3efbe091168d7cbd29
+  metadata.gz: 5c367ce983d21581034478d9accfcffc23d1d150fe49053fd72992fd2a7e8106eae1cb3a7d710111bf9ffad5ec073623785102efca130b0a4b64251e9d5f93f4
+  data.tar.gz: d3f5a65a799a7afebc73feb58f155196fce11acacb827d3706243b836abb5261f75cf04f9cb6156a6deb2462e4d23db80efd90759e638af8f673edab278c6ba2

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

@@ -0,0 +1,21 @@
+module HttpStub
+  module Configurer
+    module Request
+      module Http
+
+        class Basic
+
+          def initialize(http_request)
+            @http_request = http_request
+          end
+
+          def to_http_request
+            @http_request
+          end
+
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+module HttpStub
+  module Configurer
+    module Request
+      module Http
+
+        class Factory
+
+          class << self
+
+            def stub(model)
+              HttpStub::Configurer::Request::Http::Multipart.new("/stubs", model)
+            end
+
+            def stub_activator(model)
+              HttpStub::Configurer::Request::Http::Multipart.new("/stubs/activators", model)
+            end
+
+            def get(path)
+              to_basic_request(Net::HTTP::Get.new(path))
+            end
+
+            def post(path)
+              to_basic_request(Net::HTTP::Post.new(path).tap { |request| request.body = "" })
+            end
+
+            def delete(path)
+              to_basic_request(Net::HTTP::Delete.new(path))
+            end
+
+            private
+
+            def to_basic_request(http_request)
+              HttpStub::Configurer::Request::Http::Basic.new(http_request)
+            end
+
+          end
+
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+module HttpStub
+  module Configurer
+    module Request
+      module Http
+
+        class Multipart
+
+          def initialize(path, model)
+            @path = path
+            @model = model
+          end
+
+          def to_http_request
+            Net::HTTP::Post::Multipart.new(@path, parameters)
+          end
+
+          private
+
+          def parameters
+            { payload: @model.payload.to_json }.tap do |parameters|
+              @model.response_files.each do |response_file|
+                parameters["response_file_#{response_file.id}"] =
+                  UploadIO.new(response_file.path, response_file.type, response_file.name)
+              end
+            end
+          end
+
+        end
+
+      end
+    end
+  end
+end

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

@@ -2,17 +2,33 @@ module HttpStub
   module Configurer
     module Request
 
-      class Stub < Net::HTTP::Post
+      class Stub
 
-        def initialize(payload)
-          super("/stubs")
-          @payload = payload
-          self.content_type = "application/json"
-          self.body = payload.to_json
+        def initialize(args)
+          @id       = SecureRandom.uuid
+          @request  = args[:request]
+          @response = HttpStub::Configurer::Request::StubResponse.new(@id, args[:response])
+          @triggers = args[:triggers].map(&:build)
         end
 
-        def stub_uri
-          @payload[:uri]
+        def payload
+          {
+            id:         @id,
+            uri:        HttpStub::Configurer::Request::ControllableValue.format(@request[:uri]),
+            method:     @request[:method],
+            headers:    HttpStub::Configurer::Request::ControllableValue.format(@request[:headers] || {}),
+            parameters: HttpStub::Configurer::Request::ControllableValue.format(@request[:parameters] || {}),
+            response:   @response.payload,
+            triggers:   @triggers.map(&:payload)
+          }
+        end
+
+        def response_files
+          ([ @response.file ] + @triggers.map(&:response_files)).flatten.compact
+        end
+
+        def to_s
+          @request[:uri]
         end
 
       end

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

@@ -2,17 +2,21 @@ module HttpStub
   module Configurer
     module Request
 
-      class StubActivator < Net::HTTP::Post
+      class StubActivator
 
-        def initialize(payload)
-          super("/stubs/activators")
-          @payload = payload
-          self.content_type = "application/json"
-          self.body = payload.to_json
+        delegate :response_files, to: :@stub
+
+        def initialize(args)
+          @activation_uri = args[:activation_uri]
+          @stub           = args[:stub]
+        end
+
+        def payload
+          { activation_uri: @activation_uri }.merge(@stub.payload)
         end
 
-        def activation_uri
-          @payload[:activation_uri]
+        def to_s
+          @activation_uri
         end
 
       end

data/lib/http_stub/configurer/request/{stub_activator_payload_builder.rb → stub_activator_builder.rb}

@@ -2,12 +2,12 @@ module HttpStub
   module Configurer
     module Request
 
-      class StubActivatorPayloadBuilder
+      class StubActivatorBuilder
 
-        delegate :match_requests, :respond_with, :trigger, to: :@stub_payload_builder
+        delegate :match_requests, :respond_with, :trigger, to: :@stub_builder
         
         def initialize(response_defaults)
-          @stub_payload_builder = HttpStub::Configurer::Request::StubPayloadBuilder.new(response_defaults)
+          @stub_builder = HttpStub::Configurer::Request::StubBuilder.new(response_defaults)
         end
 
         def on(uri)
@@ -15,7 +15,7 @@ module HttpStub
         end
 
         def build
-          { activation_uri: @activation_uri }.merge(@stub_payload_builder.build)
+          HttpStub::Configurer::Request::StubActivator.new(activation_uri: @activation_uri, stub: @stub_builder.build)
         end
 
       end

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

@@ -0,0 +1,34 @@
+module HttpStub
+  module Configurer
+    module Request
+
+      class StubBuilder
+        
+        def initialize(response_defaults)
+          @response = response_defaults ? response_defaults.clone : {}
+          @triggers = []
+        end
+
+        def match_requests(uri, args={})
+          @request = { uri: uri }.merge(args)
+        end
+
+        def respond_with(args)
+          @response.deep_merge!(args)
+        end
+
+        def trigger(stub_builder_or_builders)
+          resolved_builders =
+            stub_builder_or_builders.is_a?(Array) ? stub_builder_or_builders : [ stub_builder_or_builders ]
+          @triggers.concat(resolved_builders)
+        end
+
+        def build
+          HttpStub::Configurer::Request::Stub.new(request: @request, response: @response, triggers: @triggers)
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+module HttpStub
+  module Configurer
+    module Request
+
+      class StubResponse
+
+        def initialize(id, args)
+          @id   = id
+          @args = args
+        end
+
+        def payload
+          {
+            status:           @args[:status] || "",
+            headers:          @args[:headers] || {},
+            body:             @args[:body],
+            delay_in_seconds: @args[:delay_in_seconds] || ""
+          }
+        end
+
+        def file
+          if contains_file?
+            args = { id: @id, type: @args[:headers]["content-type"] }.merge(@args[:body][:file])
+            HttpStub::Configurer::Request::StubResponseFile.new(args)
+          else
+            nil
+          end
+        end
+
+        private
+
+        def contains_file?
+          @args[:body].is_a?(Hash) && @args[:body].key?(:file)
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+module HttpStub
+  module Configurer
+    module Request
+
+      class StubResponseFile
+
+        attr_reader :id, :path, :name, :type
+
+        def initialize(args)
+          @id   = args[:id]
+          @path = args[:path]
+          @name = args[:name]
+          @type = args[:type]
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -4,13 +4,17 @@ module HttpStub
 
       class Command
 
-        attr_reader :request, :description
+        attr_reader :description
 
         def initialize(args)
           @request = args[:request]
           @description = args[:description]
         end
 
+        def http_request
+          @request.to_http_request
+        end
+
       end
 
     end

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

@@ -10,7 +10,7 @@ module HttpStub
 
         def process(command)
           begin
-            response = Net::HTTP.start(host, port) { |http| http.request(command.request) }
+            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"
           rescue Exception => exc
             raise "#{error_message_prefix(command)}: #{exc}"

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

@@ -18,14 +18,14 @@ module HttpStub
         end
 
         def build_stub(&block)
-          builder = HttpStub::Configurer::Request::StubPayloadBuilder.new(@response_defaults)
+          builder = HttpStub::Configurer::Request::StubBuilder.new(@response_defaults)
           block.call(builder) if block_given?
           builder
         end
 
         def add_stub!(builder=nil, &block)
           resolved_builder = builder || self.build_stub(&block)
-          @server_facade.stub_response(HttpStub::Configurer::Request::Stub.new(resolved_builder.build))
+          @server_facade.stub_response(resolved_builder.build)
         end
 
         def add_stubs!(builders)
@@ -33,9 +33,9 @@ module HttpStub
         end
 
         def add_activator!(&block)
-          builder = HttpStub::Configurer::Request::StubActivatorPayloadBuilder.new(@response_defaults)
+          builder = HttpStub::Configurer::Request::StubActivatorBuilder.new(@response_defaults)
           block.call(builder)
-          @server_facade.stub_activator(HttpStub::Configurer::Request::StubActivator.new(builder.build))
+          @server_facade.stub_activator(builder.build)
         end
 
         def activate!(uri)

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

@@ -8,37 +8,51 @@ module HttpStub
           @request_processor = HttpStub::Configurer::Server::RequestProcessor.new(configurer)
         end
 
-        def stub_response(request)
-          @request_processor.submit(request: request, description: "stubbing '#{request.stub_uri}'")
+        def stub_response(model)
+          @request_processor.submit(
+            request: HttpStub::Configurer::Request::Http::Factory.stub(model),
+            description: "stubbing '#{model}'"
+          )
         end
 
-        def stub_activator(request)
-          @request_processor.submit(request: request, description: "registering activator '#{request.activation_uri}'")
+        def stub_activator(model)
+          @request_processor.submit(
+            request: HttpStub::Configurer::Request::Http::Factory.stub_activator(model),
+            description: "registering activator '#{model}'"
+          )
         end
 
         def activate(uri)
-          @request_processor.submit(request: Net::HTTP::Get.new(uri), description: "activating '#{uri}'")
+          @request_processor.submit(
+            request: HttpStub::Configurer::Request::Http::Factory.get(uri),
+            description: "activating '#{uri}'"
+          )
         end
 
         def remember_stubs
-          request = Net::HTTP::Post.new("/stubs/memory")
-          request.body = ""
-          @request_processor.submit(request: request, description: "committing stubs to memory")
+          @request_processor.submit(
+            request: HttpStub::Configurer::Request::Http::Factory.post("/stubs/memory"),
+            description: "committing stubs to memory"
+          )
         end
 
         def recall_stubs
           @request_processor.submit(
-            request: Net::HTTP::Get.new("/stubs/memory"), description: "recalling stubs in memory"
+            request: HttpStub::Configurer::Request::Http::Factory.get("/stubs/memory"),
+            description: "recalling stubs in memory"
           )
         end
 
         def clear_stubs
-          @request_processor.submit(request: Net::HTTP::Delete.new("/stubs"), description: "clearing stubs")
+          @request_processor.submit(
+            request: HttpStub::Configurer::Request::Http::Factory.delete("/stubs"),
+            description: "clearing stubs")
         end
 
         def clear_activators
           @request_processor.submit(
-            request: Net::HTTP::Delete.new("/stubs/activators"), description: "clearing activators"
+            request: HttpStub::Configurer::Request::Http::Factory.delete("/stubs/activators"),
+            description: "clearing activators"
           )
         end
 

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

@@ -0,0 +1,26 @@
+module HttpStub
+  module Extensions
+    module Core
+
+      module Hash
+
+        def downcase_and_underscore_keys
+          self.reduce({}) do |result, element|
+            result[element[0].is_a?(::String) ? element[0].downcase.gsub(/-/, '_') : element[0]] = element[1]
+            result
+          end
+        end
+
+        def has_hash?(other_hash)
+          other_hash.nil? || other_hash.reduce(true) do |result, element|
+            result && (self[element[0]] == element[1])
+          end
+        end
+
+      end
+
+    end
+  end
+end
+
+::Hash.send(:include, HttpStub::Extensions::Core::Hash)

data/lib/http_stub/rake/server_daemon_tasks.rb

@@ -5,7 +5,7 @@ module HttpStub
 
       def initialize(args)
         HttpStub::Rake::ServerTasks.new(args)
-        namespace(args[:name]) { HttpServerManager::Rake::ServerTasks.new(HttpStub::ServerDaemon.new(args)) }
+        namespace(args[:name]) { HttpServerManager::Rake::ServerTasks.new(HttpStub::Server::Daemon.new(args)) }
       end
 
     end

data/lib/http_stub/rake/server_tasks.rb

@@ -16,7 +16,7 @@ module HttpStub
         namespace :start do
           desc "Starts stub #{args[:name]} in the foreground"
           task(:foreground) do
-            HttpStub::Server.instance_eval do
+            HttpStub::Server::Application.instance_eval do
               set :environment, :test
               set :port, args[:port]
               run!

data/lib/http_stub/rake/task_generators.rb

@@ -1,7 +1,7 @@
-require File.expand_path('../../../http_stub', __FILE__)
+require ::File.expand_path('../../../http_stub', __FILE__)
 require 'rake/tasklib' unless defined? (::Rake::TaskLib)
 
 require 'http_server_manager/rake/task_generators'
 
-require File.expand_path('../server_tasks', __FILE__)
-require File.expand_path('../server_daemon_tasks', __FILE__)
+require ::File.expand_path('../server_tasks', __FILE__)
+require ::File.expand_path('../server_daemon_tasks', __FILE__)

data/lib/http_stub/server/application.rb

@@ -0,0 +1,117 @@
+module HttpStub
+  module Server
+
+    class Application < Sinatra::Base
+
+      register Sinatra::Partial
+
+      enable :dump_errors, :logging, :partial_underscores
+
+      def initialize
+        super()
+        @stub_registry = HttpStub::Server::StubRegistry.new
+        @stub_activator_registry = HttpStub::Server::Registry.new("stub_activator")
+        @stub_controller = HttpStub::Server::StubController.new(@stub_registry)
+        @stub_activator_controller =
+          HttpStub::Server::StubActivatorController.new(@stub_activator_registry, @stub_registry)
+      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
+
+      before { @response_pipeline = HttpStub::Server::ResponsePipeline.new(self) }
+
+      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_pipeline.process(response)
+      end
+
+      get "/stubs" do
+        haml :stubs, {}, stubs: @stub_registry.all
+      end
+
+      delete "/stubs" do
+        @stub_controller.clear(request)
+        halt 200, "OK"
+      end
+
+      post "/stubs/memory" do
+        @stub_registry.remember
+        halt 200, "OK"
+      end
+
+      get "/stubs/memory" do
+        @stub_registry.recall
+        halt 200, "OK"
+      end
+
+      # Sample request body:
+      # {
+      #   "activation_uri": "/some/path",
+      #   ... see /stub ...
+      # }
+      post "/stubs/activators" do
+        response = @stub_activator_controller.register(request)
+        @response_pipeline.process(response)
+      end
+
+      get "/stubs/activators" do
+        haml :stub_activators, {}, stub_activators: @stub_activator_registry.all.sort_by(&:activation_uri)
+      end
+
+      delete "/stubs/activators" do
+        @stub_activator_controller.clear(request)
+        halt 200, "OK"
+      end
+
+      get "/application.css" do
+        sass :application
+      end
+
+      any_request_type(//) { handle_request }
+
+      helpers do
+
+        def h(text)
+          Rack::Utils.escape_html(text)
+        end
+
+      end
+
+      private
+
+      def handle_request
+        response = @stub_controller.replay(request)
+        response = @stub_activator_controller.activate(request) if response.empty?
+        response = HttpStub::Server::Response::ERROR if response.empty?
+        @response_pipeline.process(response)
+      end
+
+    end
+
+  end
+end

data/lib/http_stub/server/daemon.rb

@@ -0,0 +1,39 @@
+module HttpStub
+  module Server
+
+    class Daemon < HttpServerManager::Server
+
+      class << self
+
+        def pid_dir=(dir)
+          HttpServerManager.pid_dir = dir
+        end
+
+        def log_dir=(dir)
+          HttpServerManager.log_dir = dir
+        end
+
+      end
+
+      def initialize(args)
+        super({ host: "localhost" }.merge(args))
+        @configurer = args[:configurer]
+      end
+
+      def start!
+        super
+        if @configurer
+          @configurer.initialize!
+          logger.info "#{@name} initialized"
+        end
+      end
+
+      def start_command
+        "rake #{@name}:start:foreground"
+      end
+
+    end
+
+  end
+
+end

data/lib/http_stub/{models → server}/exact_value_matcher.rb

@@ -1,5 +1,5 @@
 module HttpStub
-  module Models
+  module Server
 
     class ExactValueMatcher
 

data/lib/http_stub/{models → server}/hash_with_string_value_matchers.rb

@@ -1,10 +1,10 @@
 module HttpStub
-  module Models
+  module Server
 
     class HashWithStringValueMatchers < Hash
 
       def initialize(stub_hash)
-        stub_hash.each_pair { |key, value| self[key] = HttpStub::Models::StringValueMatcher.new(value) }
+        stub_hash.each_pair { |key, value| self[key] = HttpStub::Server::StringValueMatcher.new(value) }
       end
 
       def match?(actual_hash)

data/lib/http_stub/{models → server}/headers.rb

@@ -1,5 +1,5 @@
 module HttpStub
-  module Models
+  module Server
 
     class Headers < Hash