http_stub 0.22.4 → 0.23.0

data/lib/http_stub/server/stub/response/attribute/headers.rb

@@ -0,0 +1,26 @@
+module HttpStub
+  module Server
+    module Stub
+      module Response
+        module Attribute
+
+          class Headers < ::Hash
+            include HttpStub::Extensions::Core::Hash::Formatted
+
+            def initialize(stub_headers)
+              super(stub_headers, ":")
+            end
+
+            def with_values_from(request)
+              self.each_with_object({}) do |(name, value), result|
+                result[name] = HttpStub::Server::Stub::Response::Attribute::Interpolator.interpolate(value, request)
+              end
+            end
+
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/http_stub/server/stub/response/attribute/interpolator.rb

@@ -0,0 +1,26 @@
+module HttpStub
+  module Server
+    module Stub
+      module Response
+        module Attribute
+
+          module Interpolator
+
+            CHAIN = [
+              HttpStub::Server::Stub::Response::Attribute::Interpolator::Headers,
+              HttpStub::Server::Stub::Response::Attribute::Interpolator::Parameters
+            ].freeze
+
+            private_constant :CHAIN
+
+            def self.interpolate(value, request)
+              CHAIN.reduce(value) { |result, interpolator| interpolator.interpolate(result, request) }
+            end
+
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/http_stub/server/stub/response/attribute/interpolator/headers.rb

@@ -0,0 +1,27 @@
+module HttpStub
+  module Server
+    module Stub
+      module Response
+        module Attribute
+          module Interpolator
+
+            class Headers
+
+              CONTROL_VALUE_REGEXP = /control:request\.headers\[([^\]]+)\]/
+
+              private_constant :CONTROL_VALUE_REGEXP
+
+              def self.interpolate(stub_headers, request)
+                stub_headers.scan(CONTROL_VALUE_REGEXP).flatten.reduce(stub_headers) do |result, header_name|
+                  result.gsub("control:request.headers[#{header_name}]", request.headers[header_name] || "")
+                end
+              end
+
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/http_stub/server/stub/response/attribute/interpolator/parameters.rb

@@ -0,0 +1,27 @@
+module HttpStub
+  module Server
+    module Stub
+      module Response
+        module Attribute
+          module Interpolator
+
+            class Parameters
+
+              CONTROL_VALUE_REGEXP = /control:request\.parameters\[([^\]]+)\]/
+
+              private_constant :CONTROL_VALUE_REGEXP
+
+              def self.interpolate(stub_parameters, request)
+                stub_parameters.scan(CONTROL_VALUE_REGEXP).flatten.reduce(stub_parameters) do |result, parameter_name|
+                  result.gsub("control:request.parameters[#{parameter_name}]", request.parameters[parameter_name] || "")
+                end
+              end
+
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/http_stub/server/stub/response/base.rb

@@ -5,11 +5,9 @@ module HttpStub
 
         class Base
 
-          private
-
           DEFAULT_ARGS = { "status" => 200, "delay_in_seconds" => 0 }.freeze
 
-          public
+          private_constant :DEFAULT_ARGS
 
           class << self
 
@@ -20,7 +18,7 @@ module HttpStub
             def merge_defaults(args)
               args.clone.tap do |result|
                 headers = result["headers"] ||= {}
-                DEFAULT_ARGS.each    { |key, value| result[key] = value if !result[key] || result[key] == "" }
+                DEFAULT_ARGS.each    { |key, value| result[key]  = value if !result[key]  || result[key]  == "" }
                 default_headers.each { |key, value| headers[key] = value if !headers[key] || headers[key] == "" }
               end
             end
@@ -33,29 +31,20 @@ module HttpStub
 
           end
 
-          attr_reader :status, :headers, :body, :delay_in_seconds
+          attr_reader :status, :headers, :delay_in_seconds
 
           def initialize(args={})
-            @original_args    = args
+            @original_args = args
             resolved_args     = self.class.merge_defaults(args)
             @status           = resolved_args["status"]
-            @headers          = HttpStub::Server::FormattedHash.new(resolved_args["headers"], ":")
-            @body             = resolved_args["body"]
+            @headers          = HttpStub::Server::Stub::Response::Attribute::Headers.new(resolved_args["headers"])
             @delay_in_seconds = resolved_args["delay_in_seconds"]
           end
 
-          def empty?
-            @original_args.empty?
-          end
-
           def type
             self.class.name.demodulize.underscore
           end
 
-          def to_s
-            @original_args.to_s
-          end
-
         end
 
       end

data/lib/http_stub/server/stub/response/file.rb

@@ -11,8 +11,12 @@ module HttpStub
 
           def initialize(args)
             @file = args["body"][:tempfile]
-            @uri = "file://#{@file.path}"
-            super(args.merge("body" => ""))
+            @uri  = "file://#{@file.path}"
+            super
+          end
+
+          def with_values_from(request)
+            self.class.new(@original_args.merge("headers" => @headers.with_values_from(request)))
           end
 
           def serve_on(server)

data/lib/http_stub/server/stub/response/text.rb

@@ -7,6 +7,18 @@ module HttpStub
 
           add_default_headers "content-type" => "application/json"
 
+          attr_reader :body
+
+          def initialize(args={})
+            super
+            @body = HttpStub::Server::Stub::Response::Attribute::Body.new(args["body"])
+          end
+
+          def with_values_from(request)
+            self.class.new(@original_args.merge("headers" => @headers.with_values_from(request),
+                                                "body"    => @body.with_values_from(request)))
+          end
+
           def serve_on(server)
             server.halt(@status, @headers.to_hash, @body)
           end

data/lib/http_stub/server/stub/stub.rb

@@ -23,6 +23,10 @@ module HttpStub
           criteria.is_a?(String) ? matches_by_id?(criteria) : matches_by_rules?(criteria, logger)
         end
 
+        def response_for(request)
+          @response.with_values_from(request)
+        end
+
         def to_s
           @description
         end

data/lib/http_stub/version.rb

@@ -1,3 +1,3 @@
 module HttpStub
-  VERSION = "0.22.4".freeze
+  VERSION = "0.23.0".freeze
 end

data/spec/acceptance/request_reference_spec.rb

@@ -0,0 +1,44 @@
+describe "Request references in response acceptance" do
+  include_context "configurer integration"
+
+  let(:configurer) { HttpStub::Examples::ConfigurerWithRequestReferences.new }
+
+  before(:example) { configurer.class.initialize! }
+
+  context "when a request is made matching a stub that references request attributes" do
+
+    let(:header_value)    { "some header value" }
+    let(:parameter_value) { "some parameter value" }
+
+    let(:response) do
+      HTTParty.get("#{server_uri}/some_path", headers: { "header_name"    => header_value },
+                                              query:   { "parameter_name" => parameter_value })
+    end
+
+    context "the response headers" do
+
+      it "include request headers" do
+        expect(response.headers["header_referencing_header"]).to eql(header_value)
+      end
+
+      it "include request parameters" do
+        expect(response.headers["header_referencing_parameter"]).to eql(parameter_value)
+      end
+
+    end
+
+    context "the response body" do
+
+      it "include request headers" do
+        expect(response.body).to include(header_value)
+      end
+
+      it "include request parameters" do
+        expect(response.body).to include(parameter_value)
+      end
+
+    end
+
+  end
+
+end

data/spec/lib/http_stub/configurer/dsl/request_attribute_referencer_spec.rb

@@ -0,0 +1,37 @@
+describe HttpStub::Configurer::DSL::RequestAttributeReferencer do
+
+  let(:attribute_type) { :some_attribute_type }
+
+  let(:request_attribute_referencer) { described_class.new(attribute_type) }
+
+  describe "#[]" do
+
+    let(:name) { "some_name" }
+
+    subject { request_attribute_referencer[name] }
+
+    it "returns a control value" do
+      expect(subject).to start_with("control:")
+    end
+
+    it "returns a string referring to the referencer request attribute type" do
+      expect(subject).to include("request.some_attribute_type")
+    end
+
+    it "returns a string that will resolve the value for the provided name" do
+      expect(subject).to end_with("[#{name}]")
+    end
+
+    context "when the name provided is a symbol" do
+
+      let(:name) { :some_name }
+
+      it "returns a string that resolves the value with the provided name" do
+        expect(subject).to end_with("[#{name}]")
+      end
+
+    end
+
+  end
+
+end

data/spec/lib/http_stub/configurer/dsl/request_referencer_spec.rb

@@ -0,0 +1,37 @@
+describe HttpStub::Configurer::DSL::RequestReferencer do
+
+  let(:request_referencer) { described_class.new }
+
+  before(:example) { allow(HttpStub::Configurer::DSL::RequestAttributeReferencer).to receive(:new) }
+
+  describe "#parameters" do
+
+    subject { request_referencer.parameters }
+
+    it "returns an attribute request referencer for parameters" do
+      parameter_referencer = instance_double(HttpStub::Configurer::DSL::RequestAttributeReferencer)
+      allow(HttpStub::Configurer::DSL::RequestAttributeReferencer).to(
+        receive(:new).with(:parameters).and_return(parameter_referencer)
+      )
+
+      expect(subject).to eql(parameter_referencer)
+    end
+
+  end
+
+  describe "#headers" do
+
+    subject { request_referencer.headers }
+
+    it "returns an attribute request referencer for headers" do
+      header_referencer = instance_double(HttpStub::Configurer::DSL::RequestAttributeReferencer)
+      allow(HttpStub::Configurer::DSL::RequestAttributeReferencer).to(
+        receive(:new).with(:headers).and_return(header_referencer)
+      )
+
+      expect(subject).to eql(header_referencer)
+    end
+
+  end
+
+end

data/spec/lib/http_stub/configurer/dsl/scenario_activator_spec.rb

@@ -3,7 +3,7 @@ describe HttpStub::Configurer::DSL::ScenarioActivator do
   class HttpStub::Configurer::DSL::TestableScenarioActivator
     include HttpStub::Configurer::DSL::ScenarioActivator
 
-    def activate_all!(uris)
+    def activate_all!(_names)
       # Intentionally blank
     end
 
@@ -13,30 +13,30 @@ describe HttpStub::Configurer::DSL::ScenarioActivator do
 
   describe "#activate!" do
 
-    subject { activator.activate!(uri) }
+    subject { activator.activate!(name) }
 
-    context "when a uri is provided" do
+    context "when a name is provided" do
 
-      let(:uri) { "some/uri" }
+      let(:name) { "some name" }
 
-      it "delegates to activate all with the provided uri" do
-        expect(activator).to receive(:activate_all!).with([ uri ])
+      it "delegates to activate all with the provided name" do
+        expect(activator).to receive(:activate_all!).with([ name ])
 
         subject
       end
 
     end
 
-    context "when multiple uri's are provided" do
+    context "when multiple names are provided" do
 
-      let(:uris) { (1..3).map { |i| "uri/#{i}" } }
+      let(:names) { (1..3).map { |i| "name #{i}" } }
 
       context "as multiple arguments" do
 
-        subject { activator.activate!(*uris) }
+        subject { activator.activate!(*names) }
 
-        it "delegates to activate all the provided uris" do
-          expect(activator).to receive(:activate_all!).with(uris)
+        it "delegates to activate all the provided names" do
+          expect(activator).to receive(:activate_all!).with(names)
 
           subject
         end
@@ -45,10 +45,10 @@ describe HttpStub::Configurer::DSL::ScenarioActivator do
 
       context "as an array" do
 
-        subject { activator.activate!(uris) }
+        subject { activator.activate!(names) }
 
-        it "delegates to activate all the provided uris" do
-          expect(activator).to receive(:activate_all!).with(uris)
+        it "delegates to activate all the provided names" do
+          expect(activator).to receive(:activate_all!).with(names)
 
           subject
         end

data/spec/lib/http_stub/configurer/dsl/server_spec.rb

@@ -204,9 +204,7 @@ describe HttpStub::Configurer::DSL::Server do
     end
 
     it "yields the created builder to the provided block" do
-      expect(block).to receive(:call).with(scenario_builder)
-
-      subject
+      expect { |block| server.add_scenario!(scenario_name, &block) }.to yield_with_args(scenario_builder)
     end
 
     it "builds the scenario request" do
@@ -335,9 +333,7 @@ describe HttpStub::Configurer::DSL::Server do
     end
 
     it "yields the created builder to the provided block" do
-      expect(block).to receive(:call).with(stub_activator_builder)
-
-      subject
+      expect { |block| server.add_activator!(&block) }.to yield_with_args(stub_activator_builder)
     end
 
     it "builds a scenario request" do

data/spec/lib/http_stub/configurer/dsl/stub_builder_spec.rb

@@ -6,10 +6,8 @@ describe HttpStub::Configurer::DSL::StubBuilder do
 
   shared_context "triggers one stub" do
 
-    let(:trigger_stub) { instance_double(HttpStub::Configurer::Request::Stub) }
-    let(:trigger_builder) do
-      instance_double(HttpStub::Configurer::DSL::StubBuilder, build: trigger_stub)
-    end
+    let(:trigger_stub)    { instance_double(HttpStub::Configurer::Request::Stub) }
+    let(:trigger_builder) { instance_double(HttpStub::Configurer::DSL::StubBuilder, build: trigger_stub) }
 
     before(:example) { builder.trigger(trigger_builder) }
 
@@ -17,7 +15,7 @@ describe HttpStub::Configurer::DSL::StubBuilder do
 
   shared_context "triggers many stubs" do
 
-    let(:trigger_stubs) { (1..3).map { instance_double(HttpStub::Configurer::Request::Stub) } }
+    let(:trigger_stubs)    { (1..3).map { instance_double(HttpStub::Configurer::Request::Stub) } }
     let(:trigger_builders) do
       trigger_stubs.map { |stub| instance_double(HttpStub::Configurer::DSL::StubBuilder, build: stub) }
     end
@@ -103,10 +101,38 @@ describe HttpStub::Configurer::DSL::StubBuilder do
 
   describe "#respond_with" do
 
-    subject { builder.respond_with(status: 201) }
+    context "when a block is provided referencing the matching request" do
+
+      let(:request_referencer) { instance_double(HttpStub::Configurer::DSL::RequestReferencer) }
+
+      subject { builder.respond_with { |request| { headers: request.headers[:some_header] } } }
+
+      it "includes the hash returned from the evaluated block in the response hash" do
+        subject
+
+        expect(builder.response).to include(headers: a_string_matching(/^control/))
+      end
+
+      it "returns the builder to support method chaining" do
+        expect(subject).to eql(builder)
+      end
+
+    end
+
+    context "when a block is not provided" do
+
+      subject { builder.respond_with(status: 201) }
+
+      it "includes the proivded hash in the response hash" do
+        subject
+
+        expect(builder.response).to include(status: 201)
+      end
+
+      it "returns the builder to support method chaining" do
+        expect(subject).to eql(builder)
+      end
 
-    it "returns the builder to support method chaining" do
-      expect(subject).to eql(builder)
     end
 
   end