http_stub 0.15.5 → 0.16.0.pre1

data/spec/acceptance/stub_trigger_spec.rb

@@ -0,0 +1,144 @@
+describe "Stub trigger acceptance" do
+  include_context "configurer integration"
+
+  let(:configurer) { HttpStub::Examples::ConfigurerWithStubTriggers.new }
+
+  before(:example) { configurer.class.initialize! }
+
+  context "when a stub is submitted that contains triggers" do
+
+    context "with simple response bodies" do
+
+      let(:triggered_stubs) do
+        (1..3).map do |trigger_number|
+          stub_server.build_stub do |stub|
+            stub.match_requests("/triggered_stub_#{trigger_number}", method: :get)
+            stub.respond_with(status: 200 + trigger_number, body: "Triggered stub body #{trigger_number}")
+          end
+        end
+      end
+
+      before(:example) do
+        stub_server.add_stub! do |stub|
+          stub.match_requests("/stub_with_triggers", method: :get)
+          stub.respond_with(body: "Trigger stub body")
+          stub.trigger(triggered_stubs)
+        end
+      end
+
+      context "and a request is made matching the stub" do
+
+        before(:example) { @stub_with_triggers_response = HTTParty.get("#{server_uri}/stub_with_triggers") }
+
+        it "replays the stubbed response" do
+          expect(@stub_with_triggers_response.code).to eql(200)
+          expect(@stub_with_triggers_response.body).to eql("Trigger stub body")
+        end
+
+        (1..3).each do |trigger_number|
+
+          context "and then a request matching triggered stub ##{trigger_number} is made" do
+
+            let(:response) { HTTParty.get("#{server_uri}/triggered_stub_#{trigger_number}") }
+
+            it "replays the triggered response" do
+              expect(response.code).to eql("20#{trigger_number}".to_i)
+              expect(response.body).to eql("Triggered stub body #{trigger_number}")
+            end
+
+          end
+
+        end
+
+      end
+
+    end
+
+    context "with a mix of text and file responses" do
+
+      let(:pdf_file_path) { "#{HttpStub::Spec::RESOURCES_DIR}/sample.pdf" }
+      let(:pdf_file_trigger) do
+        stub_server.build_stub do |stub|
+          stub.match_requests("/triggered_stub_pdf_file", method: :get)
+          stub.respond_with(
+            status: 201,
+            headers: { "content-type" => "application/pdf" },
+            body: { file: { path: pdf_file_path, name: ::File.basename(pdf_file_path) } }
+          )
+        end
+      end
+
+      let(:text_body) { "Sample trigger stub body" }
+      let(:text_trigger) do
+        stub_server.build_stub do |stub|
+          stub.match_requests("/triggered_stub_text", method: :get)
+          stub.respond_with(status: 202, body: "Sample trigger stub body")
+        end
+      end
+
+      let(:txt_file_path) { "#{HttpStub::Spec::RESOURCES_DIR}/sample.txt" }
+      let(:txt_file_trigger) do
+        stub_server.build_stub do |stub|
+          stub.match_requests("/triggered_stub_txt_file", method: :get)
+          stub.respond_with(
+            status: 203,
+            headers: { "content-type" => "text/plain" },
+            body: { file: { path: txt_file_path, name: ::File.basename(txt_file_path) } }
+          )
+        end
+      end
+
+      let(:triggered_stubs) { [ pdf_file_trigger, text_trigger, txt_file_trigger ] }
+
+      before(:example) do
+        stub_server.add_stub! do |stub|
+          stub.match_requests("/stub_with_triggers", method: :get)
+          stub.respond_with(body: "Trigger stub body")
+          stub.trigger(triggered_stubs)
+        end
+      end
+
+      context "and a request is made matching the stub" do
+
+        before(:example) { HTTParty.get("#{server_uri}/stub_with_triggers") }
+
+        context "and then a request matching a triggered stub returning a PDF file is made" do
+
+          let(:response) { HTTParty.get("#{server_uri}/triggered_stub_pdf_file") }
+
+          it "replays the triggered response" do
+            expect(response.code).to eql(201)
+            expect_response_to_contain_file(pdf_file_path)
+          end
+
+        end
+
+        context "and then a request matching a triggered stub returning texrt is made" do
+
+          let(:response) { HTTParty.get("#{server_uri}/triggered_stub_text") }
+
+          it "replays the triggered response" do
+            expect(response.code).to eql(202)
+            expect(response.body).to eql(text_body)
+          end
+
+        end
+
+        context "and then a request matching a triggered stub returning a text file is made" do
+
+          let(:response) { HTTParty.get("#{server_uri}/triggered_stub_txt_file") }
+
+          it "replays the triggered response" do
+            expect(response.code).to eql(203)
+            expect(response.parsed_response).to eql(::File.read(txt_file_path))
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/spec/lib/http_stub/configurer/{deprecated_dsl_spec.rb → dsl/deprecated_spec.rb}

@@ -1,4 +1,4 @@
-describe HttpStub::Configurer::DeprecatedDSL do
+describe HttpStub::Configurer::DSL::Deprecated do
 
   let(:stub_server) { double("StubServer") }
 
@@ -98,7 +98,7 @@ describe HttpStub::Configurer::DeprecatedDSL do
 
   shared_examples_for "a deprecated DSL object" do
 
-    [ :recall_stubs!, :clear_stubs!, :clear_activators! ].each do |stub_server_delegate_method|
+    [ :recall_stubs!, :clear_stubs! ].each do |stub_server_delegate_method|
 
       describe "##{stub_server_delegate_method}" do
 
@@ -114,8 +114,6 @@ describe HttpStub::Configurer::DeprecatedDSL do
 
     describe "#server_has_started!" do
 
-      let(:activation_uri) { "http://some/activation/uri" }
-
       it "informs the stub server that it has started" do
         expect(stub_server).to receive(:has_started!)
 
@@ -126,7 +124,7 @@ describe HttpStub::Configurer::DeprecatedDSL do
 
     describe "#activate!" do
 
-      let(:activation_uri) { "http://some/activation/uri" }
+      let(:activation_uri) { "/some/activation/uri" }
 
       it "delegates to the stub server available to the dsl" do
         expect(stub_server).to receive(:activate!).with(activation_uri)
@@ -142,7 +140,7 @@ describe HttpStub::Configurer::DeprecatedDSL do
 
         include_context "a method stubbing a response"
 
-        let(:builder) { instance_double(HttpStub::Configurer::Request::StubBuilder) }
+        let(:builder) { instance_double(HttpStub::Configurer::DSL::StubBuilder) }
 
         subject { dsl_object.send(method, stub_uri, options) }
 
@@ -160,11 +158,11 @@ describe HttpStub::Configurer::DeprecatedDSL do
 
     describe "#stub_activator" do
 
-      let(:activation_uri) { "http://some/activator/uri" }
+      let(:activation_uri) { "/some/activation/uri" }
 
       include_context "a method stubbing a response"
 
-      let(:builder) { instance_double(HttpStub::Configurer::Request::StubActivatorBuilder) }
+      let(:builder) { instance_double(HttpStub::Configurer::DSL::StubActivatorBuilder) }
 
       subject { dsl_object.stub_activator(activation_uri, stub_uri, options) }
 
@@ -187,12 +185,22 @@ describe HttpStub::Configurer::DeprecatedDSL do
 
     end
 
+    describe "#clear_activators!" do
+
+      it "informs the stub server to clear scenarios" do
+        expect(stub_server).to receive(:clear_scenarios!)
+
+        dsl_object.clear_activators!
+      end
+
+    end
+
   end
 
   context "when included in a class" do
 
-    class HttpStub::Configurer::DeprecatedDSLTest
-      include HttpStub::Configurer::DeprecatedDSL
+    class HttpStub::Configurer::DSL::DeprecatedTest
+      include HttpStub::Configurer::DSL::Deprecated
 
       class << self
 
@@ -207,8 +215,8 @@ describe HttpStub::Configurer::DeprecatedDSL do
     describe "the class in which the module was included" do
 
       let(:dsl_object) do
-        HttpStub::Configurer::DeprecatedDSLTest.stub_server = stub_server
-        HttpStub::Configurer::DeprecatedDSLTest
+        HttpStub::Configurer::DSL::DeprecatedTest.stub_server = stub_server
+        HttpStub::Configurer::DSL::DeprecatedTest
       end
 
       it_behaves_like "a deprecated DSL object"
@@ -218,7 +226,7 @@ describe HttpStub::Configurer::DeprecatedDSL do
     describe "an instance of the class in which the module was included" do
 
       let(:dsl_object) do
-        dsl_object = HttpStub::Configurer::DeprecatedDSLTest.new
+        dsl_object = HttpStub::Configurer::DSL::DeprecatedTest.new
         dsl_object.stub_server = stub_server
         dsl_object
       end

data/spec/lib/http_stub/configurer/{server/dsl_spec.rb → dsl/sanctioned_spec.rb}

@@ -1,8 +1,12 @@
-describe HttpStub::Configurer::Server::DSL do
+describe HttpStub::Configurer::DSL::Sanctioned do
 
   let(:server_facade) { instance_double(HttpStub::Configurer::Server::Facade) }
 
-  let(:dsl) { HttpStub::Configurer::Server::DSL.new(server_facade) }
+  let(:dsl) { HttpStub::Configurer::DSL::Sanctioned.new(server_facade) }
+
+  it "produces stub builders" do
+    expect(dsl).to be_a(HttpStub::Configurer::DSL::StubBuilderProducer)
+  end
 
   describe "#has_started!" do
 
@@ -14,74 +18,10 @@ describe HttpStub::Configurer::Server::DSL do
 
   end
 
-  describe "#build_stub" do
-
-    let(:stub_builder) { instance_double(HttpStub::Configurer::Request::StubBuilder) }
-
-    before(:example) do
-      allow(HttpStub::Configurer::Request::StubBuilder).to receive(:new).and_return(stub_builder)
-    end
-
-    subject { dsl.build_stub }
-
-    context "when response defaults have been established" do
-
-      let(:response_defaults) { { key: "value" } }
-
-      before(:example) { dsl.response_defaults = { key: "value" } }
-
-      it "creates a stub builder containing the response defaults" do
-        expect(HttpStub::Configurer::Request::StubBuilder).to receive(:new).with(response_defaults)
-
-        subject
-      end
-
-    end
-
-    context "when no response defaults have been established" do
-
-      it "creates a stub builder with empty response defaults" do
-        expect(HttpStub::Configurer::Request::StubBuilder).to receive(:new).with({})
-
-        subject
-      end
-
-    end
-
-    context "when a block is provided" do
-
-      let(:block) { lambda { |_stub| "some block" } }
-
-      subject { dsl.build_stub(&block) }
-
-      it "yields the created builder to the provided block" do
-        expect(block).to receive(:call).with(stub_builder)
-
-        subject
-      end
-
-      it "returns the created builder" do
-        expect(subject).to eql(stub_builder)
-      end
-
-    end
-
-    context "when a block is not provided" do
-
-      subject { dsl.build_stub }
-
-      it "returns the built stub" do
-        expect(subject).to eql(stub_builder)
-      end
-
-    end
-
-  end
-
   describe "#add_stub!" do
 
     let(:stub)         { instance_double(HttpStub::Configurer::Request::Stub) }
-    let(:stub_builder) { instance_double(HttpStub::Configurer::Request::StubBuilder, build: stub) }
+    let(:stub_builder) { instance_double(HttpStub::Configurer::DSL::StubBuilder, build: stub) }
 
     before(:example) { allow(server_facade).to receive(:stub_response) }
 
@@ -113,12 +53,12 @@ describe HttpStub::Configurer::Server::DSL do
 
       let(:block) { lambda { |_stub| "some block" } }
 
-      before(:example) { allow(HttpStub::Configurer::Request::StubBuilder).to receive(:new).and_return(stub_builder) }
+      before(:example) { allow(HttpStub::Configurer::DSL::StubBuilder).to receive(:new).and_return(stub_builder) }
 
       subject { dsl.add_stub!(&block) }
 
       it "creates a stub builder" do
-        expect(HttpStub::Configurer::Request::StubBuilder).to receive(:new)
+        expect(HttpStub::Configurer::DSL::StubBuilder).to receive(:new)
 
         subject
       end
@@ -135,48 +75,85 @@ describe HttpStub::Configurer::Server::DSL do
 
   end
 
-  describe "#add_stubs!" do
+  describe "#add_scenario!" do
 
-    context "when multiple stub builders are provided" do
+    let(:scenario_name)    { "some/scenario/name" }
+    let(:scenario)         { instance_double(HttpStub::Configurer::Request::Scenario) }
+    let(:scenario_builder) { instance_double(HttpStub::Configurer::DSL::ScenarioBuilder, build: scenario) }
 
-      let(:stubs) { (1..3).map { instance_double(HttpStub::Configurer::Request::Stub) } }
-      let(:stub_builders) do
-        stubs.map { |stub| instance_double(HttpStub::Configurer::Request::StubBuilder, build: stub) }
-      end
+    before(:example) { allow(server_facade).to receive(:define_scenario) }
+
+    let(:block) { lambda { |_scenario| "some block" } }
+
+    before(:example) do
+      allow(HttpStub::Configurer::DSL::ScenarioBuilder).to receive(:new).and_return(scenario_builder)
+    end
+
+    subject { dsl.add_scenario!(scenario_name, &block) }
+
+    context "when response defaults have been established" do
+
+      let(:response_defaults) { { key: "value" } }
+
+      before(:example) { dsl.response_defaults = { key: "value" } }
 
-      subject { dsl.add_stubs!(stub_builders) }
+      it "creates a scenario builder containing the response defaults" do
+        expect(HttpStub::Configurer::DSL::ScenarioBuilder).to receive(:new).with(response_defaults, anything)
 
-      before(:example) { allow(server_facade).to receive(:stub_response) }
+        subject
+      end
 
-      it "builds each stub" do
-        stubs.zip(stub_builders).each { |stub, stub_builder| expect(stub_builder).to receive(:build).and_return(stub) }
+      it "creates a scenario builder containing the provided scenario name" do
+        expect(HttpStub::Configurer::DSL::ScenarioBuilder).to receive(:new).with(anything, scenario_name)
 
         subject
       end
 
-      it "informs the server facade of each built stub" do
-        stubs.each { |stub| expect(server_facade).to receive(:stub_response).with(stub) }
+    end
+
+    context "when no response defaults have been established" do
+
+      it "creates a scenario builder with empty response defaults" do
+        expect(HttpStub::Configurer::DSL::ScenarioBuilder).to receive(:new).with({}, anything)
 
         subject
       end
 
     end
 
+    it "yields the created builder to the provided block" do
+      expect(block).to receive(:call).with(scenario_builder)
+
+      subject
+    end
+
+    it "builds the scenario request" do
+      expect(scenario_builder).to receive(:build).and_return(scenario)
+
+      subject
+    end
+
+    it "informs the server facade to submit the scenario request" do
+      expect(server_facade).to receive(:define_scenario).with(scenario)
+
+      subject
+    end
+
   end
 
   describe "#add_activator!" do
 
-    let(:stub_activator) { instance_double(HttpStub::Configurer::Request::StubActivator) }
+    let(:scenario) { instance_double(HttpStub::Configurer::Request::Scenario) }
     let(:stub_activator_builder) do
-      instance_double(HttpStub::Configurer::Request::StubActivatorBuilder, build: stub_activator)
+      instance_double(HttpStub::Configurer::DSL::StubActivatorBuilder, build: scenario)
     end
 
-    before(:example) { allow(server_facade).to receive(:stub_activator) }
+    before(:example) { allow(server_facade).to receive(:define_scenario) }
 
     let(:block) { lambda { |_activator| "some block" } }
 
     before(:example) do
-      allow(HttpStub::Configurer::Request::StubActivatorBuilder).to receive(:new).and_return(stub_activator_builder)
+      allow(HttpStub::Configurer::DSL::StubActivatorBuilder).to receive(:new).and_return(stub_activator_builder)
     end
 
     subject { dsl.add_activator!(&block) }
@@ -188,7 +165,7 @@ describe HttpStub::Configurer::Server::DSL do
       before(:example) { dsl.response_defaults = { key: "value" } }
 
       it "creates a stub activator builder containing the response defaults" do
-        expect(HttpStub::Configurer::Request::StubActivatorBuilder).to receive(:new).with(response_defaults)
+        expect(HttpStub::Configurer::DSL::StubActivatorBuilder).to receive(:new).with(response_defaults)
 
         subject
       end
@@ -198,7 +175,7 @@ describe HttpStub::Configurer::Server::DSL do
     context "when no response defaults have been established" do
 
       it "creates a stub activator builder with empty response defaults" do
-        expect(HttpStub::Configurer::Request::StubActivatorBuilder).to receive(:new).with({})
+        expect(HttpStub::Configurer::DSL::StubActivatorBuilder).to receive(:new).with({})
 
         subject
       end
@@ -211,14 +188,14 @@ describe HttpStub::Configurer::Server::DSL do
       subject
     end
 
-    it "builds the stub activator request" do
-      expect(stub_activator_builder).to receive(:build).and_return(stub_activator)
+    it "builds a scenario request" do
+      expect(stub_activator_builder).to receive(:build).and_return(scenario)
 
       subject
     end
 
-    it "informs the server facade to submit the stub activator request" do
-      expect(server_facade).to receive(:stub_activator).with(stub_activator)
+    it "informs the server facade to submit the scenario request" do
+      expect(server_facade).to receive(:define_scenario).with(scenario)
 
       subject
     end
@@ -227,12 +204,12 @@ describe HttpStub::Configurer::Server::DSL do
 
   describe "#activate!" do
 
-    let(:uri) { "/some/activation/uri" }
+    let(:scenario_name) { "/some/scenario/name" }
 
     it "delegates to the server facade" do
-      expect(server_facade).to receive(:activate).with(uri)
+      expect(server_facade).to receive(:activate).with(scenario_name)
 
-      dsl.activate!(uri)
+      dsl.activate!(scenario_name)
     end
 
   end
@@ -267,12 +244,12 @@ describe HttpStub::Configurer::Server::DSL do
 
   end
 
-  describe "#clear_activators!" do
+  describe "#clear_scenarios!" do
 
     it "delegates to the server facade" do
-      expect(server_facade).to receive(:clear_activators)
+      expect(server_facade).to receive(:clear_scenarios)
 
-      dsl.clear_activators!
+      dsl.clear_scenarios!
     end
 
   end