http_stub 0.17.0 → 0.18.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MjE5ZmY4YmJhNjA3OGI2NWU1MWMxNmIzODk3OTQwMDI3NWZjOTY4Ng==
-  data.tar.gz: !binary |-
-    NTA4YjMxNzYyNGI4YTM3MzI1M2Y4YTRjYTUzOTIzZjgwMTBkODAxYQ==
+SHA1:
+  metadata.gz: 7e6b513e163138fb09f45fcd3ad25690c0e49720
+  data.tar.gz: d01a275fbc644b47ca4c13f38082112ad99d9810
 SHA512:
-  metadata.gz: !binary |-
-    Mjk1NGI5YjE3Y2EwNjIxZmQwYzIyOGM5ZDU0ZDRhNzUzODAwNmMwYTA5NmY5
-    YWI3YmQ1YTkxZDA0ODE1MDgzYmM1OGEyYWY5OTIyMDI4MmNmMjQ2MmI3MmQ4
-    NGVkNjljOThkMTkyMTYzNjRkOWNiZTljNTQ0ZDIyZGJkZGUwYjM=
-  data.tar.gz: !binary |-
-    OGZkOTY0YWRlZDAwZjYwZGE0ODA0ZmE3YTEyNDA0ZWRmYmQzZTIwYzQwNjcw
-    OTE0NmNhZmUwNWYxMjliZDBiZTdiYWRkNjc5YjExMDc0YjJmOThjNzQyMGRj
-    YzAwZjU2N2NmMzk2ZGZjYThlNjZlOGU1YWQ2ZGYyMDE1NGI3OGQ=
+  metadata.gz: c73d28013f716113eeda47db419e4e4b7bd6c2c25152369ec9d9570c388e4fa7f3a8585b64314be7cca267aba2bdb11b73be2a29d492e9ab816a69544740cbd3
+  data.tar.gz: 4ee8e85dd25bd6c87ae6b501e6d4f9012d49d036c43c84897779e33725db7dc7eee9b71b1bd650cc01935d1665fd6029595f1784f1169baed93a292cdc27a66a

data/lib/http_stub.rb

@@ -74,7 +74,9 @@ require_relative 'http_stub/configurer/dsl/stub_builder'
 require_relative 'http_stub/configurer/dsl/stub_builder_producer'
 require_relative 'http_stub/configurer/dsl/scenario_activator'
 require_relative 'http_stub/configurer/dsl/scenario_builder'
+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/part'
 require_relative 'http_stub/configurer'

data/lib/http_stub/configurer.rb

@@ -21,6 +21,14 @@ module HttpStub
         @initialized = true
       end
 
+      def parts=(parts)
+        parts.each do |name, part|
+          part.configure(self)
+          self.define_singleton_method(name) { part }
+          self.send(:define_method, name) { part }
+        end
+      end
+
       private
 
       def server_facade

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

@@ -0,0 +1,26 @@
+module HttpStub
+  module Configurer
+    module DSL
+
+      class EndpointTemplate
+
+        delegate :match_requests, :schema, :respond_with, :trigger, :invoke, to: :@default_stub_builder
+
+        def initialize(server, response_defaults)
+          @server = server
+          @default_stub_builder = HttpStub::Configurer::DSL::StubBuilder.new(response_defaults)
+        end
+
+        def add_scenario!(name, response_overrides={}, &block)
+          @server.add_one_stub_scenario!(name) do |stub_builder|
+            stub_builder.merge!(@default_stub_builder)
+            stub_builder.respond_with(response_overrides)
+            stub_builder.invoke(&block)
+          end
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -36,6 +36,18 @@ module HttpStub
           @server_facade.define_scenario(builder.build)
         end
 
+        def add_one_stub_scenario!(name, &block)
+          add_scenario!(name) do |scenario|
+            scenario.add_stub! { |stub| stub.invoke(&block) }
+          end
+        end
+
+        def endpoint_template(&block)
+          HttpStub::Configurer::DSL::EndpointTemplate.new(self, @response_defaults).tap do |template|
+            template.invoke(&block)
+          end
+        end
+
         def add_activator!(&block)
           builder = HttpStub::Configurer::DSL::StubActivatorBuilder.new(@response_defaults)
           block.call(builder)

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

@@ -3,6 +3,10 @@ module HttpStub
     module DSL
 
       class StubBuilder
+
+        attr_reader :request, :response, :triggers
+
+        public
         
         def initialize(response_defaults)
           @response = response_defaults ? response_defaults.clone : {}
@@ -28,6 +32,16 @@ module HttpStub
           self
         end
 
+        def invoke(&block)
+          block.arity == 0 ? self.instance_eval(&block) : block.call(self)
+        end
+
+        def merge!(stub_builder)
+          @request = (@request || {}).deep_merge(stub_builder.request || {})
+          self.respond_with(stub_builder.response)
+          self.trigger(stub_builder.triggers)
+        end
+
         def build
           HttpStub::Configurer::Request::Stub.new(request: @request, response: @response, triggers: @triggers)
         end

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

@@ -6,7 +6,7 @@ module HttpStub
 
         def build_stub(&block)
           builder = HttpStub::Configurer::DSL::StubBuilder.new(@response_defaults)
-          block.arity == 0 ? builder.instance_eval(&block) : block.call(builder) if block_given?
+          builder.invoke(&block) if block_given?
           builder
         end
 

data/lib/http_stub/configurer/part.rb

@@ -0,0 +1,19 @@
+module HttpStub
+  module Configurer
+
+    module Part
+
+      def configure(configurer)
+        @configurer = configurer
+        configure_methods = self.methods.find_all { |method| method.to_s =~ /^configure_.+_(stub|scenario)s?$/ }
+        configure_methods.each { |configure_method| self.send(configure_method) }
+      end
+
+      def method_missing(name, *args, &block)
+        @configurer.send(name, *args, &block)
+      end
+
+    end
+
+  end
+end

data/lib/http_stub/version.rb

@@ -1,3 +1,3 @@
 module HttpStub
-  VERSION = "0.17.0".freeze
+  VERSION = "0.18.0".freeze
 end

data/spec/acceptance/configurer_part_spec.rb

@@ -0,0 +1,66 @@
+describe "Configurer Part acceptance" do
+  include_context "configurer integration"
+
+  context "when a configurer contains a part" do
+
+    let(:configurer) { HttpStub::Examples::ConfigurerWithParts.new }
+
+    before(:example) { configurer.class.initialize! }
+
+    context "that contains a configure stub method" do
+
+      let(:response) { issue_request("registered_in_configure_stub_method") }
+
+      it "invokes the method" do
+        expect(response.body).to eql("configure stub response")
+      end
+
+    end
+
+    context "that contains a configure stubs methods" do
+
+      let(:response) { issue_request("registered_in_configure_stubs_method") }
+
+      it "invokes the method" do
+        expect(response.body).to eql("configure stubs response")
+      end
+
+    end
+
+    context "that contains a configure scenario methods" do
+
+      let(:response) { issue_request("registered_in_configure_scenario_method") }
+
+      it "invokes the method" do
+        expect(response.body).to eql("configure scenario response")
+      end
+
+    end
+
+    context "that contains a configure scenarios methods" do
+
+      let(:response) { issue_request("registered_in_configure_scenarios_method") }
+
+      it "invokes the method" do
+        expect(response.body).to eql("configure scenarios response")
+      end
+
+    end
+
+    context "that contains a part referencing another part" do
+
+      let(:response) { issue_request("registered_in_another_part") }
+
+      it "resolves the other part successfully" do
+        expect(response.body).to eql("response from another part")
+      end
+
+    end
+
+    def issue_request(uri)
+      HTTParty.get("#{server_uri}/#{uri}")
+    end
+
+  end
+
+end

data/spec/acceptance/endpoint_template_spec.rb

@@ -0,0 +1,54 @@
+describe "Endpoint Template acceptance" do
+  include_context "configurer integration"
+
+  context "when a configurer contains an endpoint template" do
+
+    let(:configurer) { HttpStub::Examples::ConfigurerWithEndpointTemplate.new }
+
+    before(:example) { configurer.class.initialize! }
+
+    it "does not register a stub when the template is defined" do
+      response = issue_request("template_uri")
+
+      expect(response.code).to eql(404)
+    end
+
+    context "and a templated scenario is activated" do
+
+      before(:example) { stub_server.activate!(scenario_name) }
+
+      context "that customises the request matching rules" do
+
+        let(:scenario_name) { "custom_request" }
+
+        let(:response) { issue_request("custom_uri") }
+
+        it "registers a templated stub for the scenario" do
+          expect(response.code).to eql(200)
+          expect(response.body).to eql("template body")
+        end
+
+      end
+
+      context "that customises the response" do
+
+        let(:scenario_name) { "custom_response" }
+
+        let(:response) { issue_request("template_uri") }
+
+        it "registers a templated stub for the scenario" do
+          expect(response.code).to eql(202)
+          expect(response.body).to eql("custom body")
+        end
+
+      end
+
+    end
+
+  end
+
+  def issue_request(uri)
+    HTTParty.get("#{server_uri}/#{uri}")
+  end
+
+end

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

@@ -0,0 +1,163 @@
+describe HttpStub::Configurer::DSL::EndpointTemplate do
+
+  let(:stub_fixture) { HttpStub::StubFixture.new }
+
+  let(:server)               { instance_double(HttpStub::Configurer::DSL::Server) }
+  let(:response_defaults)    { {} }
+  let(:default_stub_builder) { instance_double(HttpStub::Configurer::DSL::StubBuilder) }
+
+  let(:endpoint_template) { HttpStub::Configurer::DSL::EndpointTemplate.new(server, response_defaults) }
+
+  before(:example) do
+    allow(HttpStub::Configurer::DSL::StubBuilder).to(
+      receive(:new).with(response_defaults).and_return(default_stub_builder)
+    )
+  end
+
+  describe "#match_requests" do
+
+    let(:uri)  { "/some/uri" }
+    let(:args) { { key: :value } }
+
+    subject { endpoint_template.match_requests(uri, args) }
+
+    it "delegates to the default stub builder" do
+      expect(default_stub_builder).to receive(:match_requests).with(uri, args)
+
+      subject
+    end
+
+  end
+
+  describe "#schema" do
+
+    let(:type)       { :some_type }
+    let(:definition) { { key: :value } }
+
+    subject { endpoint_template.schema(type, definition) }
+
+    it "delegates to the default stub builder" do
+      expect(default_stub_builder).to receive(:schema).with(type, definition)
+
+      subject
+    end
+
+  end
+
+  describe "#respond_with" do
+
+    let(:args) { { status: 204 } }
+
+    subject { endpoint_template.respond_with(args) }
+
+    it "delegates to the default stub builder" do
+      expect(default_stub_builder).to receive(:respond_with).with(args)
+
+      subject
+    end
+
+  end
+
+  describe "#trigger" do
+
+    let(:trigger) { instance_double(HttpStub::Configurer::DSL::StubBuilder) }
+
+    subject { endpoint_template.trigger(trigger) }
+
+    it "delegates to the default stub builder" do
+      expect(default_stub_builder).to receive(:trigger).with(trigger)
+
+      subject
+    end
+
+  end
+
+  describe "#invoke" do
+
+    let(:block_verifier) { double("BlockVerifier") }
+    let(:block)          { lambda { block_verifier.verify } }
+
+    subject { endpoint_template.invoke(&block) }
+
+    it "delegates to the default stub builder" do
+      expect(default_stub_builder).to receive(:invoke).and_yield
+      expect(block_verifier).to receive(:verify)
+
+      subject
+    end
+
+  end
+
+  describe "#add_scenario!" do
+
+    let(:name)               { "some_scenario_name" }
+    let(:response_overrides) { {} }
+    let(:block_verifier)     { double("BlockVerifier") }
+    let(:block)              { lambda { block_verifier.verify } }
+
+    let(:stub_builder)     { instance_double(HttpStub::Configurer::DSL::StubBuilder).as_null_object }
+
+    before(:example) { allow(server).to receive(:add_one_stub_scenario!).and_yield(stub_builder) }
+
+    subject { endpoint_template.add_scenario!(name, response_overrides, &block) }
+
+    it "add a one stub scenario to the server" do
+      expect(server).to receive(:add_one_stub_scenario!).with(name)
+
+      subject
+    end
+
+    it "merges the added stub with the default stub builder" do
+      expect(stub_builder).to receive(:merge!).with(default_stub_builder)
+
+      subject
+    end
+
+    context "when response overrides are provided" do
+
+      let(:response_overrides) { { status: 302 } }
+
+      it "informs the stub builder to respond with the response overrides" do
+        expect(stub_builder).to receive(:respond_with).with(response_overrides)
+
+        subject
+      end
+
+    end
+
+    context "when response overrides are not provided" do
+
+      subject { endpoint_template.add_scenario!(name, &block) }
+
+      it "does not change the stub builder by requesting it respond with an empty hash" do
+        expect(stub_builder).to receive(:respond_with).with({})
+
+        subject
+      end
+
+    end
+
+    it "merges the response defaults before applying the response overrides" do
+      expect(stub_builder).to receive(:merge!).ordered
+      expect(stub_builder).to receive(:respond_with).ordered
+
+      subject
+    end
+
+    it "requests the added stub builder invoke the provided block" do
+      expect(stub_builder).to receive(:invoke).and_yield
+      expect(block_verifier).to receive(:verify)
+
+      subject
+    end
+
+    it "applies the response overrides before invoking the provided block" do
+      expect(stub_builder).to receive(:respond_with).ordered
+      expect(stub_builder).to receive(:invoke).ordered
+
+      subject
+    end
+
+  end
+
+end