http_stub 0.16.0.pre1 → 0.17.0.pre1

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: e089a8fb77ad42e2691e6c05fe6a2d766ac07626
-  data.tar.gz: 5bb5f0740862f3e106b5fc9015c85fddb3452d49
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YTlmNDUyNWZjZjhjODYwMjcyNDViZWE1MDY4NzljZTc3MDJhYmYxMA==
+  data.tar.gz: !binary |-
+    ZTdhZmExMjY3NTBkNzZmZGMwYTdjMTJhZWM1ODAzMzcyZWZhZThmOQ==
 SHA512:
-  metadata.gz: 51fb2fc9c208dc1af31405a5bc1520c743693cf155a6834d6a555d414c5cf1d722b7eca43edb2c3e7d2e60d8bf7d589776b8f7499097f3d026edf4c3ee416031
-  data.tar.gz: 3403a0f714d40df0e387332213695d672f0f443adff2031b061bd65f46a6b17e989c1bb47677b1842febdf2a5cd3edd71ac7a2fb1a903bc26189226f387a116c
+  metadata.gz: !binary |-
+    ZWI2MDc1ZThkNjQ4OWE2YWQ4YWM3MjM1YThlYzc5ZTg4OWE1MzFmM2EyZGUx
+    N2ZiM2Q5Y2ZhN2I3MGQ2ZGUzNTdmM2ViM2M0MGQwNDI5ODZhMTdjODM5MjBl
+    ZjMyNmMwMTJkMWNmNjk4MTk3NDg5ZGIxNTRlYmFiNDk1MzJjYWI=
+  data.tar.gz: !binary |-
+    OWI1OGY4MzNiOGU3MjdkNGFmZDgxNjRhMjlkNmIxZjA5N2FmYjc0NDE3MmM5
+    NThiZDAyNzQzNTRjMTBjODFlMTA3MDJhZGEwMjUwZmUxMTBjOTcxNWMwZDhm
+    NWVlYzgxMzIwNWYxZmJhZTk5NWUxOWUzZTYzMTQzOTdhNjJiZTQ=

data/lib/http_stub.rb

@@ -1,11 +1,12 @@
 require 'sinatra'
 require 'sinatra/partial'
-require 'haml'
-require 'sass'
 require 'json'
 require 'net/http'
 require 'net/http/post/multipart'
+require 'json-schema'
 require 'http_server_manager'
+require 'haml'
+require 'sass'
 
 require 'active_support/core_ext/module/aliasing'
 require 'active_support/core_ext/module/delegation'
@@ -28,10 +29,14 @@ require_relative 'http_stub/server/stub/headers'
 require_relative 'http_stub/server/stub/request_header_parser'
 require_relative 'http_stub/server/stub/payload_file_consolidator'
 require_relative 'http_stub/server/stub/request_parser'
-require_relative 'http_stub/server/stub/method'
+require_relative 'http_stub/server/stub/truthy_request_matcher'
 require_relative 'http_stub/server/stub/uri'
-require_relative 'http_stub/server/stub/request_parameters'
+require_relative 'http_stub/server/stub/method'
 require_relative 'http_stub/server/stub/request_headers'
+require_relative 'http_stub/server/stub/request_parameters'
+require_relative 'http_stub/server/stub/simple_request_body'
+require_relative 'http_stub/server/stub/json_request_body'
+require_relative 'http_stub/server/stub/request_body'
 require_relative 'http_stub/server/stub/response/base'
 require_relative 'http_stub/server/stub/response/text'
 require_relative 'http_stub/server/stub/response/file'
@@ -70,6 +75,6 @@ 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/stub_activator_builder'
-require_relative 'http_stub/configurer/dsl/sanctioned'
+require_relative 'http_stub/configurer/dsl/server'
 require_relative 'http_stub/configurer/dsl/deprecated'
 require_relative 'http_stub/configurer'

data/lib/http_stub/configurer.rb

@@ -10,28 +10,8 @@ module HttpStub
 
     module ClassMethods
 
-      def get_host
-        @host
-      end
-
-      def host(host)
-        @host = host
-      end
-
-      def get_port
-        @port
-      end
-
-      def port(port)
-        @port = port
-      end
-
-      def get_base_uri
-        "http://#{@host}:#{@port}"
-      end
-
       def stub_server
-        @dsl ||= HttpStub::Configurer::DSL::Sanctioned.new(server_facade)
+        @stub_server ||= HttpStub::Configurer::DSL::Server.new(server_facade)
       end
 
       def initialize!

data/lib/http_stub/configurer/dsl/{sanctioned.rb → server.rb}

@@ -2,15 +2,21 @@ module HttpStub
   module Configurer
     module DSL
 
-      class Sanctioned
+      class Server
         include HttpStub::Configurer::DSL::StubBuilderProducer
         include HttpStub::Configurer::DSL::ScenarioActivator
 
+        attr_accessor :host, :port
+
         def initialize(server_facade)
           @server_facade     = server_facade
           @response_defaults = {}
         end
 
+        def base_uri
+          "http://#{host}:#{port}"
+        end
+
         def response_defaults=(args)
           @response_defaults = args
         end

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

@@ -13,6 +13,10 @@ module HttpStub
           self.tap { @request = { uri: uri }.merge(args) }
         end
 
+        def schema(type, definition)
+          { schema: { type: type, definition: definition } }
+        end
+
         def respond_with(args)
           self.tap { @response.deep_merge!(args) }
         end

data/lib/http_stub/configurer/request/stub.rb

@@ -18,6 +18,7 @@ module HttpStub
             method:     @request[:method],
             headers:    HttpStub::Configurer::Request::ControllableValue.format(@request[:headers] || {}),
             parameters: HttpStub::Configurer::Request::ControllableValue.format(@request[:parameters] || {}),
+            body:       HttpStub::Configurer::Request::ControllableValue.format(@request[:body] || {}),
             response:   @response.payload,
             triggers:   @triggers.map(&:payload)
           }

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

@@ -20,15 +20,15 @@ module HttpStub
         private
 
         def host
-          @configurer.get_host
+          @configurer.stub_server.host
         end
 
         def port
-          @configurer.get_port
+          @configurer.stub_server.port
         end
 
         def error_message_prefix(command)
-          "Error occurred #{command.description} whilst configuring #{@configurer.get_base_uri}: "
+          "Error occurred #{command.description} whilst configuring #{@configurer.stub_server.base_uri}: "
         end
 
       end

data/lib/http_stub/rake/server_tasks.rb

@@ -18,7 +18,7 @@ module HttpStub
           task(:foreground) do
             HttpStub::Server::Application.instance_eval do
               set :environment, :test
-              set :port, args[:port]
+              set :port, args[:configurer] ? args[:configurer].stub_server.port : args[:port]
               run!
             end
           end

data/lib/http_stub/server/daemon.rb

@@ -16,8 +16,10 @@ module HttpStub
       end
 
       def initialize(args)
-        super({ host: "localhost" }.merge(args))
         @configurer = args[:configurer]
+        default_args = @configurer ?
+          { host: @configurer.stub_server.host, port: @configurer.stub_server.port } : { host: "localhost" }
+        super(default_args.merge(args))
       end
 
       def start!

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

@@ -4,20 +4,21 @@ module HttpStub
 
       class Instance
 
-        attr_reader :method, :uri, :headers, :parameters, :response, :triggers
+        attr_reader :method, :uri, :headers, :parameters, :body, :response, :triggers
 
         def initialize(args)
           @method      = HttpStub::Server::Stub::Method.new(args["method"])
           @uri         = HttpStub::Server::Stub::Uri.new(args["uri"])
           @headers     = HttpStub::Server::Stub::RequestHeaders.new(args["headers"])
           @parameters  = HttpStub::Server::Stub::RequestParameters.new(args["parameters"])
+          @body        = HttpStub::Server::Stub::RequestBody.create(args["body"])
           @response    = HttpStub::Server::Stub::Response.create(args["response"])
           @triggers    = HttpStub::Server::Stub::Triggers.new(args["triggers"])
           @description = args.to_s
         end
 
         def satisfies?(request)
-          [ @uri, @method, @headers, @parameters ].all? { |matcher| matcher.match?(request) }
+          [ @uri, @method, @headers, @parameters, @body ].all? { |matcher| matcher.match?(request) }
         end
 
         def to_s

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

@@ -0,0 +1,35 @@
+module HttpStub
+  module Server
+    module Stub
+
+      class JsonRequestBody
+
+        def initialize(schema_definition)
+          @schema_definition = schema_definition
+        end
+
+        def match?(request)
+          validate_against_schema(request).tap do |errors|
+            errors.each { |error| request.logger.info(error) }
+          end.empty?
+        end
+
+        def to_s
+          @schema_definition.to_json
+        end
+
+        private
+
+        def validate_against_schema(request)
+          begin
+            JSON::Validator.fully_validate(@schema_definition, request.body.read, validate_schema: true, json: true)
+          rescue Exception => exc
+            [ exc.message ]
+          end
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+module HttpStub
+  module Server
+    module Stub
+
+      class RequestBody
+
+        private
+
+        SCHEMA_PROPERTIES = %w{ type definition }.freeze
+
+        public
+
+        class << self
+
+          def create(body)
+            matcher = create_schema_request_body(body["schema"]) if body.is_a?(Hash) && body["schema"]
+            matcher ||= HttpStub::Server::Stub::SimpleRequestBody.new(body) if !body.blank?
+            matcher || HttpStub::Server::Stub::TruthyRequestMatcher
+          end
+
+          private
+
+          def create_schema_request_body(schema)
+            validate_schema_properties(schema)
+            begin
+              HttpStub::Server::Stub.const_get("#{schema["type"].capitalize}RequestBody").new(schema["definition"])
+            rescue NameError
+              raise "Stub request body schema #{schema} is invalid: #{schema["type"]} schema is not supported"
+            end
+          end
+
+          def validate_schema_properties(schema)
+            SCHEMA_PROPERTIES.each do |property|
+              raise "Stub request body schema #{schema} is invalid: #{property} expected" unless schema[property]
+            end
+          end
+
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module HttpStub
+  module Server
+    module Stub
+
+      class SimpleRequestBody
+
+        def initialize(body)
+          @body = HttpStub::Server::Stub::StringValueMatcher.new(body)
+        end
+
+        def match?(request)
+          @body.match?(request.body.read)
+        end
+
+        def to_s
+          @body.to_s
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module HttpStub
+  module Server
+    module Stub
+
+      class TruthyRequestMatcher
+
+        class << self
+
+          def match?(_request)
+            true
+          end
+
+          def to_s
+            ""
+          end
+
+        end
+
+      end
+
+    end
+  end
+end

data/lib/http_stub/server/views/_stub.haml

@@ -11,6 +11,9 @@
   %tr
     %td Parameters:
     %td=h(the_stub.parameters)
+  %tr
+    %td Body:
+    %td=h(the_stub.body)
   %tr
     %td Response Status:
     %td=the_stub.response.status

data/lib/http_stub/version.rb

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

data/spec/acceptance/configurer_initialization_spec.rb

@@ -9,7 +9,7 @@ describe "Configurer initialization acceptance" do
 
     context "that contains a class stub" do
 
-      let(:configurer) { HttpStub::Examples::ConfigurerWithStub.new }
+      let(:configurer) { HttpStub::Examples::ConfigurerWithTrivialStub.new }
 
       it "registers the stub" do
         response = HTTParty.get("#{server_uri}/a_class_stub")

data/spec/acceptance/stub_body_schema_validation_spec.rb

@@ -0,0 +1,67 @@
+describe "Scenario acceptance" do
+  include_context "configurer integration"
+
+  context "when a configurer that contains a stub matching a request body schema" do
+
+    let(:configurer)  { HttpStub::Examples::ConfigurerWithSchemaValidatingStub.new }
+
+    before(:example) { configurer.class.initialize! }
+
+    context "and a request is made with a request body" do
+
+      context "that completely matches" do
+
+        let(:response) do
+          issue_request(body: { string_property:  "some string",
+                                integer_property: 88,
+                                float_property:   77.7 }.to_json)
+        end
+
+        it "responds with the configured response" do
+          expect(response.code).to eql(204)
+        end
+
+      end
+
+      context "that partially matches" do
+
+        let(:response) do
+          issue_request(body: { string_property: "some string",
+                                integer_property: 88 }.to_json)
+        end
+
+        it "responds with a 404 status code" do
+          expect(response.code).to eql(404)
+        end
+
+      end
+
+      context "that is completely different" do
+
+        let(:response) { issue_request(body: { some_other_key: "some string" }.to_json) }
+
+        it "responds with a 404 status code" do
+          expect(response.code).to eql(404)
+        end
+
+      end
+
+      context "that is empty" do
+
+        let(:response) { issue_request(body: {}) }
+
+        it "responds with a 404 status code" do
+          expect(response.code).to eql(404)
+        end
+
+      end
+
+    end
+
+    def issue_request(args)
+      HTTParty.post("#{server_uri}/matches_on_body_schema", args)
+    end
+
+  end
+
+end

data/spec/acceptance/stub_control_values_spec.rb

@@ -1,7 +1,7 @@
 describe "Stub control value acceptance" do
   include_context "configurer integration"
 
-  let(:configurer)  { HttpStub::Examples::ConfigurerWithStub.new }
+  let(:configurer)  { HttpStub::Examples::ConfigurerWithTrivialStub.new }
 
   before(:example) { configurer.class.initialize! }
 
@@ -145,7 +145,7 @@ describe "Stub control value acceptance" do
         configurer.stub_response!("/some_stub_path", method: :get, response: { delay_in_seconds: 2 })
       end
 
-      it "delays to response by the time provided" do
+      it "delays the response by the time provided" do
         start_time = Time.now
 
         response = HTTParty.get("#{server_uri}/some_stub_path")