http_stub 0.24.3 → 0.25.0

data/spec/lib/http_stub/server/stub/payload/base_uri_modifier_spec.rb

@@ -0,0 +1,23 @@
+describe HttpStub::Server::Stub::Payload::BaseUriModifier do
+
+  let(:modifier) { described_class }
+
+  describe "::modify!" do
+
+    let(:payload)         { HttpStub::StubFixture.new.server_payload }
+    let(:base_uri)        { "http://base.uri:8888" }
+    let(:request)         { instance_double(HttpStub::Server::Request::Request, base_uri: base_uri) }
+
+    subject { modifier.modify!(payload, request) }
+
+    it "alters the payload to include the servers base uri" do
+      expected_payload = payload.clone.merge("base_uri" => base_uri)
+
+      subject
+
+      expect(payload).to eql(expected_payload)
+    end
+
+  end
+
+end

data/spec/lib/http_stub/server/{payload_file_consolidator_spec.rb → stub/payload/response_body_modifier_spec.rb}

@@ -1,13 +1,15 @@
-describe HttpStub::Server::Stub::PayloadFileConsolidator do
+describe HttpStub::Server::Stub::Payload::ResponseBodyModifier do
 
-  let(:consolidator) { described_class }
+  let(:modifier) { described_class }
 
-  describe "::consolidate!" do
+  describe "::modify!" do
 
     let(:parameters) { {} }
     let(:request)    { instance_double(HttpStub::Server::Request::Request, parameters: parameters) }
 
-    subject { consolidator.consolidate!(payload, request) }
+    let!(:original_payload) { payload.clone }
+
+    subject { modifier.modify!(payload, request) }
 
     context "when the payload contains a response file and has a corresponding file parameter" do
 
@@ -15,10 +17,12 @@ describe HttpStub::Server::Stub::PayloadFileConsolidator do
       let(:payload)         { payload_fixture.server_payload }
       let(:parameters)      { { "response_file_#{payload_fixture.id}" => payload_fixture.file_parameter } }
 
-      it "returns the payload with a response body that contains the file parameter value" do
+      it "modifies the payload to have a response body that contains the file parameter value" do
         expected_payload = payload.clone.tap { |hash| hash["response"]["body"] = payload_fixture.file_parameter }
 
-        expect(subject).to eql(expected_payload)
+        subject
+
+        expect(payload).to eql(expected_payload)
       end
 
     end
@@ -32,8 +36,10 @@ describe HttpStub::Server::Stub::PayloadFileConsolidator do
 
         let(:trigger_fixtures) { (1..3).map { HttpStub::StubFixture.new.with_text_response! } }
 
-        it "returns the payload unchanged" do
-          expect(subject).to eql(payload)
+        it "leaves the payload unchanged" do
+          subject
+
+          expect(payload).to eql(original_payload)
         end
 
       end
@@ -47,13 +53,15 @@ describe HttpStub::Server::Stub::PayloadFileConsolidator do
           end
         end
 
-        it "returns the payload with the trigger response bodies replaced by the files" do
-          expected_payload = payload_fixture.server_payload
+        it "modifies the payload to have trigger response bodies replaced by the files" do
+          expected_payload = payload.clone
           expected_payload["triggers"].zip(trigger_fixtures.map(&:file_parameter)).each do |trigger, file_param|
             trigger["response"]["body"] = file_param
           end
 
-          expect(subject).to eql(expected_payload)
+          subject
+
+          expect(payload).to eql(expected_payload)
         end
 
       end
@@ -64,10 +72,10 @@ describe HttpStub::Server::Stub::PayloadFileConsolidator do
 
       let(:payload) { HttpStub::StubFixture.new.server_payload }
 
-      it "returns an unchanged payload" do
-        original_payload = payload.clone
+      it "leaves the payload unchanged" do
+        subject
 
-        expect(subject).to eql(original_payload)
+        expect(payload).to eql(original_payload)
       end
 
     end

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

@@ -0,0 +1,33 @@
+describe HttpStub::Server::Stub::Payload do
+
+  describe "::modify!" do
+
+    let(:payload) { HttpStub::StubFixture.new.server_payload }
+    let(:request) { instance_double(HttpStub::Server::Request::Request) }
+
+    subject { described_class.modify!(payload, request) }
+
+    before(:example) do
+      allow(HttpStub::Server::Stub::Payload::BaseUriModifier).to receive(:modify!)
+      allow(HttpStub::Server::Stub::Payload::ResponseBodyModifier).to receive(:modify!)
+    end
+
+    it "modifies the payloads base uri" do
+      expect(HttpStub::Server::Stub::Payload::BaseUriModifier).to receive(:modify!).with(payload, request)
+
+      subject
+    end
+
+    it "modifies the payloads request body" do
+      expect(HttpStub::Server::Stub::Payload::ResponseBodyModifier).to receive(:modify!).with(payload, request)
+
+      subject
+    end
+
+    it "returns the potentially modified payload" do
+      expect(subject).to be(payload)
+    end
+
+  end
+
+end

data/spec/lib/http_stub/server/stub/response/base_spec.rb

@@ -186,4 +186,26 @@ describe HttpStub::Server::Stub::Response::Base do
 
   end
 
+  describe "#to_hash" do
+
+    subject { response.to_hash }
+
+    describe "supporting creating a JSON representation of the response" do
+
+      it "contains the responses status" do
+        expect(subject).to include(status: response.status)
+      end
+
+      it "contains the responses headers" do
+        expect(subject).to include(headers: response.headers)
+      end
+
+      it "contains the responses delay in seconds" do
+        expect(subject).to include(delay_in_seconds: response.delay_in_seconds)
+      end
+
+    end
+
+  end
+
 end

data/spec/lib/http_stub/server/stub/response/file_spec.rb

@@ -77,7 +77,8 @@ describe HttpStub::Server::Stub::Response::File do
 
     let(:status)          { 321 }
     let(:additional_args) { { "status" => status } }
-    let(:server)          { instance_double(Sinatra::Base) }
+    let(:server_response) { instance_double(Sinatra::Response, status: 200) }
+    let(:server)          { instance_double(Sinatra::Base, response: server_response) }
 
     subject { response_file.serve_on(server) }
 
@@ -93,6 +94,15 @@ describe HttpStub::Server::Stub::Response::File do
       subject
     end
 
+    it "updates the responses status to reflect the status evaluated by Sinatra" do
+      expect(server).to receive(:send_file).ordered
+      expect(server_response).to receive(:status).and_return(304).ordered
+
+      subject
+
+      expect(response_file.status).to eql(304)
+    end
+
     context "when a content type header is specified" do
 
       let(:content_type) { "plain/text" }
@@ -170,4 +180,22 @@ describe HttpStub::Server::Stub::Response::File do
 
   end
 
+  describe "#to_hash" do
+
+    subject { response_file.to_hash }
+
+    describe "supporting creating a JSON representation of the response" do
+
+      it "contains the files uri" do
+        expect(subject).to include(file_uri: response_file.uri)
+      end
+
+      it "contains the standard response attributes" do
+        expect(subject).to include(headers: response_file.headers)
+      end
+
+    end
+
+  end
+
 end

data/spec/lib/http_stub/server/stub/response/text_spec.rb

@@ -165,4 +165,22 @@ describe HttpStub::Server::Stub::Response::Text do
 
   end
 
+  describe "#to_hash" do
+
+    subject { response_text.to_hash }
+
+    describe "supporting creating a JSON representation of the response" do
+
+      it "contains the responses body" do
+        expect(subject).to include(body: response_text.body)
+      end
+
+      it "contains the standard response attributes" do
+        expect(subject).to include(headers: response_text.headers)
+      end
+
+    end
+
+  end
+
 end

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

@@ -1,22 +1,10 @@
 describe HttpStub::Server::Stub::Stub do
 
-  let(:request_header_payload) do
-    {
-        "header1" => "header_value1",
-        "header2" => "header_value2",
-        "header3" => "header_value3"
-    }
-  end
-  let(:request_parameter_payload) do
-    {
-        "param1" => "param_value1",
-        "param2" => "param_value2",
-        "param3" => "param_value3"
-    }
-  end
-  let(:request_method_payload) { "get" }
+  let(:base_uri)        { "http://base.uri:8888" }
+  let(:stub_id)         { SecureRandom.uuid }
   let(:trigger_payload) do
     {
+      "base_uri" =>   base_uri,
       "uri" =>        "/a_triggered_path",
       "method" =>     "post",
       "headers" =>    { "triggered_header" => "triggered_header_value" },
@@ -28,14 +16,14 @@ describe HttpStub::Server::Stub::Stub do
       }
     }
   end
-  let(:stub_id)      { SecureRandom.uuid }
   let(:stub_payload) do
     {
       "id" =>         stub_id,
+      "base_uri" =>   base_uri,
       "uri" =>        "/a_path",
-      "method" =>     stub_method,
-      "headers" =>    request_header_payload,
-      "parameters" => request_parameter_payload,
+      "method" =>     "get",
+      "headers" =>    { "header" => "header value" },
+      "parameters" => { "parameter" => "parameter value" },
       "body" =>       { "schema" => { "json" => "stub schema definition" } },
       "response" => {
         "status" => 201,
@@ -44,11 +32,7 @@ describe HttpStub::Server::Stub::Stub do
       "triggers" => [ trigger_payload ]
     }
   end
-  let(:stub_method)        { instance_double(HttpStub::Server::Stub::Match::Rule::Method, matches?: true) }
-  let(:uri)                { instance_double(HttpStub::Server::Stub::Match::Rule::Uri, matches?: true) }
-  let(:request_headers)    { instance_double(HttpStub::Server::Stub::Match::Rule::Headers, matches?: true) }
-  let(:request_parameters) { instance_double(HttpStub::Server::Stub::Match::Rule::Parameters, matches?: true) }
-  let(:request_body)       { double("HttpStub::Server::Stub::SomeRequestBody", matches?: true) }
+  let(:match_rules)        { instance_double(HttpStub::Server::Stub::Match::Rules, matches?: true) }
   let(:response_types)     { [ HttpStub::Server::Stub::Response::Text, HttpStub::Server::Stub::Response::File ] }
   let(:response)           { instance_double(response_types.sample) }
   let(:triggers)           { instance_double(HttpStub::Server::Stub::Triggers) }
@@ -56,11 +40,7 @@ describe HttpStub::Server::Stub::Stub do
   let(:the_stub) { HttpStub::Server::Stub::Stub.new(stub_payload) }
 
   before(:example) do
-    allow(HttpStub::Server::Stub::Match::Rule::Method).to receive(:new).and_return(stub_method)
-    allow(HttpStub::Server::Stub::Match::Rule::Uri).to receive(:new).and_return(uri)
-    allow(HttpStub::Server::Stub::Match::Rule::Headers).to receive(:new).and_return(request_headers)
-    allow(HttpStub::Server::Stub::Match::Rule::Parameters).to receive(:new).and_return(request_parameters)
-    allow(HttpStub::Server::Stub::Match::Rule::Body).to receive(:create).and_return(request_body)
+    allow(HttpStub::Server::Stub::Match::Rules).to receive(:new).and_return(match_rules)
     allow(HttpStub::Server::Stub::Response).to receive(:create).and_return(response)
     allow(HttpStub::Server::Stub::Triggers).to receive(:new).and_return(triggers)
   end
@@ -72,102 +52,25 @@ describe HttpStub::Server::Stub::Stub do
     context "when a request is provided" do
 
       let(:request_method) { request_method_payload }
-      let(:request)        { instance_double(HttpStub::Server::Request::Request, method: request_method_payload) }
+      let(:request)        { instance_double(HttpStub::Server::Request::Request) }
 
       subject { the_stub.matches?(request, logger) }
 
-      describe "when the request uri matches" do
-
-        before(:example) { allow(uri).to receive(:matches?).with(request, logger).and_return(true) }
-
-        describe "and the request method matches" do
-
-          describe "and a header match is configured" do
-
-            describe "that matches" do
-
-              before(:example) { allow(request_headers).to receive(:matches?).with(request, logger).and_return(true) }
-
-              describe "and a parameter match is configured" do
-
-                describe "that matches" do
-
-                  before(:example) do
-                    allow(request_parameters).to receive(:matches?).with(request, logger).and_return(true)
-                  end
-
-                  describe "and a body match is configured" do
-
-                    describe "that matches" do
-
-                      before(:example) do
-                        allow(request_body).to receive(:matches?).with(request, logger).and_return(true)
-                      end
-
-                      it "returns true" do
-                        expect(subject).to be(true)
-                      end
-
-                    end
-
-                  end
+      before(:example) { allow(match_rules).to receive(:matches?).with(request, logger).and_return(match_rules_result) }
 
-                end
+      describe "and the match rules match the request" do
 
-              end
+        let(:match_rules_result) { true }
 
-            end
-
-          end
-
-        end
-
-      end
-
-
-      describe "when the request uri does not match" do
-
-        before(:example) { allow(uri).to receive(:matches?).with(request, logger).and_return(false) }
-
-        it "returns false" do
-          expect(subject).to be(false)
-        end
-
-      end
-
-      describe "when the request method does not match" do
-
-        before(:example) { allow(stub_method).to receive(:matches?).with(request, logger).and_return(false) }
-
-        it "returns false" do
-          expect(subject).to be(false)
-        end
-
-      end
-
-      describe "when the headers do not match" do
-
-        before(:example) { allow(request_headers).to receive(:matches?).with(request, logger).and_return(false) }
-
-        it "returns false" do
-          expect(subject).to be(false)
-        end
-
-      end
-
-      describe "when the parameters do not match" do
-
-        before(:example) { allow(request_parameters).to receive(:matches?).with(request, logger).and_return(false) }
-
-        it "returns false" do
-          expect(subject).to be(false)
+        it "returns true" do
+          expect(subject).to be(true)
         end
 
       end
 
-      describe "when the bodies do not match" do
+      describe "and the match rule do not match the request" do
 
-        before(:example) { allow(request_body).to receive(:matches?).with(request, logger).and_return(false) }
+        let(:match_rules_result) { false }
 
         it "returns false" do
           expect(subject).to be(false)
@@ -205,7 +108,7 @@ describe HttpStub::Server::Stub::Stub do
 
   end
 
-  describe "#repsonse_for" do
+  describe "#response_for" do
 
     let(:request) { instance_double(HttpStub::Server::Request::Request) }
 
@@ -228,40 +131,30 @@ describe HttpStub::Server::Stub::Stub do
 
   describe "#uri" do
 
-    it "returns the uri model encapsulating the uri provided in the request body" do
-      expect(the_stub.uri).to eql(uri)
-    end
-
-  end
-
-  describe "#method" do
-
-    it "returns the method model encapsulating the method provided in the request body" do
-      expect(the_stub.method).to eql(stub_method)
-    end
+    subject { the_stub.uri }
 
-  end
+    context "when an id is provided in the payload" do
 
-  describe "#headers" do
+      it "returns a absolute uri on the server  that includes the id" do
+        expect(subject).to eql("#{base_uri}/http_stub/stubs/#{stub_id}")
+      end
 
-    it "returns the headers model encapsulating the headers provided in the request body" do
-      expect(the_stub.headers).to eql(request_headers)
     end
 
-  end
+    context "when an id is not provided in the payload" do
 
-  describe "#parameters" do
+      it "returns an absolute uri on the server that includes a generated id" do
+        expect(subject).to match(%r{#{base_uri}/http_stub/stubs/[a-zA-Z0-9-]+$})
+      end
 
-    it "returns the parameters model encapsulating the parameters provided in the request body" do
-      expect(the_stub.parameters).to eql(request_parameters)
     end
 
   end
 
-  describe "#body" do
+  describe "#match_rules" do
 
-    it "returns the body model encapsulating the body provided in the request body" do
-      expect(the_stub.body).to eql(request_body)
+    it "returns the match rules encapsulating the rules provided in the request body" do
+      expect(the_stub.match_rules).to eql(match_rules)
     end
 
   end
@@ -282,20 +175,30 @@ describe HttpStub::Server::Stub::Stub do
 
   end
 
-  describe "#stub_uri" do
+  describe "#to_hash" do
 
-    context "when an id is provided in the payload" do
+    subject { the_stub.to_hash }
+
+    describe "supporting creating a JSON representation of the stub" do
 
-      it "returns a relative uri to the stub that includes the id" do
-        expect(the_stub.stub_uri).to eql("/http_stub/stubs/#{stub_id}")
+      it "contains the stubs id" do
+        expect(subject).to include(id: stub_id)
       end
 
-    end
+      it "contains the stubs uri" do
+        expect(subject).to include(uri: the_stub.uri)
+      end
 
-    context "when an id is not provided in the payload" do
+      it "contains the stubs match rules" do
+        expect(subject).to include(match_rules: the_stub.match_rules)
+      end
+
+      it "contains the stubs response" do
+        expect(subject).to include(response: the_stub.response)
+      end
 
-      it "returns a relative uri to the stub that includes a generated id" do
-        expect(the_stub.stub_uri).to match(/\/http_stub\/stubs\/[a-zA-Z0-9-]+$/)
+      it "contains the stubs triggers" do
+        expect(subject).to include(triggers: the_stub.triggers)
       end
 
     end