http_stub 0.27.0 → 0.28.0.beta1

data/spec/acceptance/stub_trigger_spec.rb

@@ -1,37 +1,17 @@
 describe "Stub trigger acceptance" do
-  include_context "configurer integration"
+  include_context "server integration"
 
-  let(:configurer_specification) { { class: HttpStub::Examples::ConfigurerWithStubTriggers } }
+  let(:configurator) { HttpStub::Examples::ConfiguratorWithStubTriggers }
 
-  context "when a stub is submitted that contains triggers" do
+  context "when a stub has triggers" do
 
     context "that trigger scenarios" do
 
-      let(:triggered_scenario_names) do
-        (1..3).map do |scenario_number|
-          "Triggered Scenario #{scenario_number}".tap do |scenario_name|
-            stub_server.add_scenario_with_one_stub!(scenario_name) do |stub|
-              stub.match_requests(uri: "/triggered_scenario_#{scenario_number}", method: :get)
-              stub.respond_with(status: 200 + scenario_number, body: "Triggered scenario body #{scenario_number}")
-            end
-          end
-        end
-      end
-
-      before(:example) do
-        stub_server.add_stub! do |stub|
-          stub.match_requests(uri: "/triggers_scenarios", method: :get)
-          stub.respond_with(body: "Stub triggering scenarios body")
-          stub.trigger(scenarios: triggered_scenario_names)
-        end
-      end
-
       context "and a request is made matching the stub" do
 
         before(:example) { @stub_with_triggers_response = HTTParty.get("#{server_uri}/triggers_scenarios") }
 
         it "replays the stubbed response" do
-          expect(@stub_with_triggers_response.code).to eql(200)
           expect(@stub_with_triggers_response.body).to eql("Stub triggering scenarios body")
         end
 
@@ -55,30 +35,12 @@ describe "Stub trigger acceptance" do
     end
 
     context "that trigger stubs" do
-
-      let(:triggered_stubs) do
-        (1..3).map do |trigger_number|
-          stub_server.build_stub do |stub|
-            stub.match_requests(uri: "/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(uri: "/triggers_stubs", method: :get)
-          stub.respond_with(body: "Stub triggering stubs body")
-          stub.trigger(stubs: triggered_stubs)
-        end
-      end
-
+      
       context "and a request is made matching the stub" do
 
         before(:example) { @stub_with_triggers_response = HTTParty.get("#{server_uri}/triggers_stubs") }
 
         it "replays the stubbed response" do
-          expect(@stub_with_triggers_response.code).to eql(200)
           expect(@stub_with_triggers_response.body).to eql("Stub triggering stubs body")
         end
 
@@ -101,80 +63,41 @@ describe "Stub trigger acceptance" do
 
     end
 
-    context "that contain 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(uri: "/triggered_stub_pdf_file", method: :get)
-          stub.respond_with(
-            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(uri: "/triggered_stub_text", method: :get)
-          stub.respond_with(status: 201, 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(uri: "/triggered_stub_txt_file", method: :get)
-          stub.respond_with(
-            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(uri: "/stub_with_triggers", method: :get)
-          stub.respond_with(body: "Trigger stub body")
-          stub.trigger(stubs: triggered_stubs)
-        end
-      end
+    context "that contains a mix of text and file responses" do
 
       context "and a request is made matching the stub" do
 
-        before(:example) { HTTParty.get("#{server_uri}/stub_with_triggers") }
+        before(:example) { HTTParty.get("#{server_uri}/stub_with_mixed_response_triggers") }
 
         context "and then a request matching a triggered stub returning a PDF file is made" do
 
+          let(:pdf_file_path) { HttpStub::Examples::ConfiguratorWithStubTriggers::PDF_FILE_PATH }
+
           let(:response) { HTTParty.get("#{server_uri}/triggered_stub_pdf_file") }
 
           it "replays the triggered response" do
-            expect(response.code).to eql(200)
             expect(response).to contain_file(pdf_file_path)
           end
 
         end
 
-        context "and then a request matching a triggered stub returning texrt is made" do
+        context "and then a request matching a triggered stub returning text is made" do
 
           let(:response) { HTTParty.get("#{server_uri}/triggered_stub_text") }
 
           it "replays the triggered response" do
-            expect(response.code).to eql(201)
-            expect(response.body).to eql(text_body)
+            expect(response.body).to eql("Sample trigger stub body")
           end
 
         end
 
         context "and then a request matching a triggered stub returning a text file is made" do
 
+          let(:txt_file_path) { HttpStub::Examples::ConfiguratorWithStubTriggers::TXT_FILE_PATH }
+
           let(:response) { HTTParty.get("#{server_uri}/triggered_stub_txt_file") }
 
           it "replays the triggered response" do
-            expect(response.code).to eql(200)
             expect(response.parsed_response).to eql(::File.read(txt_file_path))
           end
 

data/spec/helper.rb

@@ -2,18 +2,24 @@ require 'bundler'
 Bundler.require(:development)
 
 SimpleCov.start do
+  coverage_dir "tmp/coverage"
+
   add_filter "/spec/"
   add_filter "/vendor/"
 
+  add_filter "/examples/configurator_with_response_blocks"
+
   minimum_coverage 100
   refuse_coverage_drop
 end if ENV["coverage"]
 
 require 'http_server_manager/test_support'
 
+require_relative '../lib/http_stub/configurator'
+require_relative '../lib/http_stub/client'
 require_relative '../lib/http_stub/rake/task_generators'
-require_relative '../lib/http_stub'
 
+require_relative '../examples/stub_builder'
 Dir[File.expand_path('../../examples/**/*.rb', __FILE__)].each { |file| require file }
 
 HttpStub::Server::Daemon.log_dir = ::File.expand_path('../../tmp/log', __FILE__)
@@ -23,8 +29,8 @@ HttpServerManager.logger = HttpServerManager::Test::SilentLogger
 
 module HttpStub
 
-  module Spec
-    RESOURCES_DIR = ::File.expand_path('../resources', __FILE__)
+  module Examples
+    RESOURCES_DIR = ::File.expand_path('../../examples/resources', __FILE__)
   end
 
 end
@@ -32,27 +38,43 @@ end
 require_relative 'support/include_in_json'
 require_relative 'support/contain_file'
 require_relative 'support/surpressed_output'
+require_relative 'support/object_convertable_to_json'
+require_relative 'support/extensions/core/random'
 require_relative 'support/rack/request_fixture'
 require_relative 'support/rack/rack_application_test'
 require_relative 'support/cross_origin_server/integration'
 require_relative 'support/cross_origin_server/index_page'
+require_relative 'support/http_stub/port'
+require_relative 'support/http_stub/headers_fixture'
+require_relative 'support/http_stub/configurator/stub_builder'
+require_relative 'support/http_stub/configurator/stub_fixture'
+require_relative 'support/http_stub/configurator/scenario_builder'
+require_relative 'support/http_stub/configurator/scenario_fixture'
+require_relative 'support/http_stub/configurator_fixture'
+require_relative 'support/http_stub/server/silent_logger'
+require_relative 'support/http_stub/server/simple_request'
+require_relative 'support/http_stub/server/request/sinatra_request_fixture'
 require_relative 'support/http_stub/server/request_fixture'
 require_relative 'support/http_stub/server/session_fixture'
 require_relative 'support/http_stub/server/scenario_fixture'
 require_relative 'support/http_stub/server/memory_fixture'
 require_relative 'support/http_stub/server/stub/match/match_fixture'
 require_relative 'support/http_stub/server/stub/match/miss_fixture'
-require_relative 'support/http_stub/stub_fixture'
-require_relative 'support/http_stub/scenario_fixture'
+require_relative 'support/http_stub/server/stub/response/file_body_fixture'
+require_relative 'support/http_stub/server/stub/response/text_body_fixture'
+require_relative 'support/http_stub/server/stub/response/blocks_fixture'
+require_relative 'support/http_stub/server/stub/response_builder'
+require_relative 'support/http_stub/server/stub/response_fixture'
+require_relative 'support/http_stub/server/stub_fixture'
 require_relative 'support/http_stub/server/application/http_stub_rack_application_test'
-require_relative 'support/http_stub/empty_configurer'
 require_relative 'support/http_stub/server/driver'
 require_relative 'support/http_stub/server_integration'
-require_relative 'support/http_stub/configurer_integration'
-require_relative 'support/http_stub/stub_registrator'
+require_relative 'support/http_stub/configurator_with_stub_builder_and_requester'
+require_relative 'support/http_stub/stub_requester'
+
 require_relative 'support/html_helpers'
-require_relative 'support/http_stub/html_view_including_request_details'
-require_relative 'support/http_stub/html_view_excluding_request_details'
+require_relative 'support/http_stub/html_view_including_a_stub_request'
+require_relative 'support/http_stub/html_view_excluding_a_stub_request'
 require_relative 'support/http_stub/selenium/browser'
 require_relative 'support/browser_integration'
 

data/spec/lib/http_stub/client/client_spec.rb

@@ -0,0 +1,109 @@
+describe HttpStub::Client::Client do
+
+  let(:server_uri) { "/some/server/uri" }
+
+  let(:server)          { instance_double(HttpStub::Client::Server) }
+  let(:default_session) { instance_double(HttpStub::Client::Session) }
+
+  let(:client) { described_class.new(server_uri) }
+
+  before(:example) do
+    allow(HttpStub::Client::Server).to receive(:new).and_return(server)
+    allow(HttpStub::Client::Session).to receive(:new).and_return(default_session)
+  end
+
+  it "creates a server for the requests issued by the client supplying the server URI" do
+    expect(HttpStub::Client::Server).to receive(:new).with(server_uri)
+
+    client
+  end
+
+  it "creates a default session which the client uses when sessions are not used" do
+    expect(HttpStub::Client::Session).to receive(:new)
+
+    client
+  end
+
+  it "creates a default session identified as the transactional session" do
+    expect(HttpStub::Client::Session).to receive(:new).with("http_stub_transactional", anything)
+
+    client
+  end
+
+  it "creates a default session that uses the server to issue requests" do
+    expect(HttpStub::Client::Session).to receive(:new).with(anything, server)
+
+    client
+  end
+
+  describe "#session" do
+
+    let(:session_id) { "some session id" }
+
+    let(:session) { instance_double(HttpStub::Client::Session) }
+
+    subject { client.session(session_id) }
+
+    before(:example) { allow(HttpStub::Client::Session).to receive(:new).and_return(session) }
+
+    it "creates a session for the provided ID" do
+      expect(HttpStub::Client::Session).to receive(:new).with(session_id, anything)
+
+      subject
+    end
+
+    it "creates a session that uses the server to issue requests" do
+      expect(HttpStub::Client::Session).to receive(:new).with(anything, server)
+
+      subject
+    end
+
+    it "returns the created session" do
+      expect(subject).to eql(session)
+    end
+
+  end
+
+  describe "#activate!" do
+
+    let(:scenario_name) { "Some scenario name" }
+
+    subject { client.activate!(scenario_name) }
+
+    it "delegates to the default session" do
+      expect(default_session).to receive(:activate!).with(scenario_name)
+
+      subject
+    end
+
+  end
+
+  describe "#reset!" do
+
+    let(:request) { instance_double(HttpStub::Client::Request::Basic) }
+
+    subject { client.reset! }
+
+    before(:example) { allow(server).to receive(:submit!) }
+
+    it "submits a delete request" do
+      expect(server).to receive(:submit!).with(hash_including(method: :delete))
+
+      subject
+    end
+
+    it "submits a request to the sessions endpoint" do
+      expect(server).to receive(:submit!).with(hash_including(path: "sessions"))
+
+      subject
+    end
+
+    it "describes the intent of the request as to reset the server" do
+      expect(server).to receive(:submit!).with(hash_including(intent: "reset server"))
+
+      subject
+    end
+
+  end
+
+end

data/spec/lib/http_stub/client/request_integration_spec.rb

@@ -0,0 +1,74 @@
+describe HttpStub::Client::Request, "integrating with a server" do
+
+  let(:request_intent)         { "some request intent" }
+  let(:request_args_overrides) { {} }
+  let(:request_args)            do
+    {
+      method:       :post,
+      base_uri:     server_uri,
+      path:         "stubs/reset",
+      intent:       request_intent,
+      http_options: { open_timeout: 1 }
+    }.merge(request_args_overrides)
+  end
+
+  let(:request) { described_class.new(request_args) }
+
+  describe "#submit" do
+
+    subject { request.submit }
+
+    context "when a server is running" do
+      include_context "server integration"
+
+      context "and a valid request is submitted" do
+
+        it "executes without error" do
+          expect { subject }.not_to raise_error
+        end
+
+        it "returns a response that indicates the request was issued" do
+          expect(subject.code).to eql("200")
+        end
+
+        context "that contains parameters" do
+
+          let(:request_args_overrides) do
+            {
+              path:       "scenarios/activate",
+              parameters: { "names[]" => [ "invalid_scenario" ] }
+            }
+          end
+
+          it "executes without error" do
+            expect { subject }.not_to raise_error
+          end
+
+          it "returns a response that indicates the request honoured the parameters" do
+            expect(subject.body).to include("invalid_scenario")
+          end
+
+        end
+
+      end
+
+    end
+
+    context "when a request is submitted to an unavailable server" do
+
+      let(:request_args_overrides) do
+        {
+          base_uri: "http://localhost:#{HttpStub::Port.free_port}",
+          path:     "does/not/exist"
+        }
+      end
+
+      it "raises an exception" do
+        expect { subject }.to raise_error(StandardError)
+      end
+
+    end
+
+  end
+
+end

data/spec/lib/http_stub/client/request_spec.rb

@@ -0,0 +1,32 @@
+describe HttpStub::Client::Request do
+
+  let(:request_method) { :post }
+  let(:request_intent) { "some intent" }
+  let(:request_args)            do
+    {
+      method:       request_method,
+      base_uri:     "http://some/base/uri",
+      path:         "some/path",
+      intent:       request_intent
+    }
+  end
+
+  let(:request) { described_class.new(request_args) }
+
+  describe "#submit" do
+
+    subject { request.submit }
+
+    context "when an invalid method is provided" do
+
+      let(:request_method) { :invalid }
+
+      it "raises an error describing the intent of the request"  do
+        expect { subject }.to raise_error(/#{request_intent}/)
+      end
+
+    end
+
+  end
+
+end