webspicy 0.15.5 → 0.16.1

data/lib/webspicy/tester/rspec_asserter.rb

@@ -0,0 +1,108 @@
+module Webspicy
+  class Tester
+    class RSpecAsserter
+
+      def initialize(rspec, invocation)
+        @rspec = rspec
+        @invocation = invocation  
+      end
+      attr_reader :rspec,  :invocation
+
+      def response
+        invocation.response
+      end
+
+      def test_case
+        invocation.test_case
+      end
+
+      def service
+        test_case.service
+      end
+
+      def assert!
+        assert_status_met
+        assert_content_type_met
+        assert_expected_headers
+        assert_output_schema_met
+        assert_assertions_met
+        assert_postconditions_met
+
+        assert_no_other_errors
+      end
+
+      def assert_status_met
+        got = response.status
+        expected = test_case.expected_status
+        rspec.expect(got).to rspec.match_response_status(expected)
+      end
+
+      def assert_content_type_met
+        return if test_case.is_expected_status?(204)
+        return unless ect = test_case.expected_content_type
+        got = response.content_type
+        got = got.mime_type if got.respond_to?(:mime_type)
+        if ect.nil?
+          rspec.expect(ect).to rspec.have_no_response_type
+        else
+          rspec.expect(got).to rspec.match_content_type(ect)
+        end
+      end
+
+      def assert_expected_headers
+        return unless test_case.has_expected_headers?
+        test_case.expected_headers.each_pair do |k,v|
+          got = response.headers[k]
+          if got.nil?
+            rspec.expect(got).to rspec.be_in_response_headers(k)
+          else
+            rspec.expect(got).to rspec.match_response_header(k, v)
+          end
+        end
+      end
+
+      def assert_output_schema_met
+        return if test_case.is_expected_status?(204)
+        return if invocation.is_redirect?
+        if invocation.is_empty_response?
+          body = response.body.to_s.strip
+          rspec.expect(body).to rspec.be_an_empty_response_body
+        else
+          b = invocation.dressed_body
+          if invocation.is_expected_success?
+            rspec.expect(b).to rspec.meet_output_schema
+          else
+            rspec.expect(b).to rspec.meet_error_schema
+          end
+        end
+      end
+
+      def assert_assertions_met
+        return unless test_case.has_assertions?
+        asserter = Tester::Asserter.new(invocation.dressed_body)
+        test_case.assert.each do |assert|
+          begin
+            asserter.instance_eval(assert)
+          rescue => ex
+            rspec.expect(ex).to rspec.meet_assertion(assert)
+          end
+        end
+      end
+
+      def assert_postconditions_met
+        return unless service.has_postconditions?
+        return if test_case.counterexample?
+        service.postconditions.each do |post|
+          msg = post.check(invocation)
+          rspec.expect(msg).to rspec.meet_postcondition(post)
+        end
+      end
+
+      def assert_no_other_errors
+        errors = invocation.errors
+        rspec.expect(errors).to rspec.be_an_empty_errors_array
+      end
+
+    end # class RSpecAsserter
+  end # class Tester
+end # module Webspicy

data/lib/webspicy/tester/rspec_matchers.rb

@@ -0,0 +1,104 @@
+require 'rspec/expectations'
+
+RSpec::Matchers.define :match_response_status do |expected|
+  match do |actual|
+    expected === actual
+  end
+  failure_message_for_should do |actual|
+    "expected response status #{actual} to be #{expected}"
+  end
+end
+
+RSpec::Matchers.define :have_no_response_type do
+  match do |actual|
+    actual.nil?
+  end
+  failure_message_for_should do |actual|
+    "expected Content-Type not to be present"
+  end
+end
+
+RSpec::Matchers.define :match_content_type do |expected|
+  match do |actual|
+    actual.to_s.start_with?(expected.to_s)
+  end
+  failure_message_for_should do |actual|
+    "expected Content-Type to be `#{expected}`, got `#{actual}`"
+  end
+end
+
+RSpec::Matchers.define :be_in_response_headers do |header_name|
+  match do |actual|
+    !actual.nil?
+  end
+  failure_message_for_should do |actual|
+    "expected response header `#{header_name}` to be set"
+  end
+end
+
+RSpec::Matchers.define :match_response_header do |header_name, expected|
+  match do |actual|
+    expected == actual
+  end
+  failure_message_for_should do |actual|
+    "expected response header `#{header_name}` to be `#{expected}`, got `#{actual}`"
+  end
+end
+
+RSpec::Matchers.define :be_an_empty_response_body do
+  match do |actual|
+    actual.empty?
+  end
+  failure_message_for_should do |actual|
+    "expected response body to be empty, started with `#{actual[0..20]}`"
+  end
+end
+
+RSpec::Matchers.define :meet_output_schema do
+  match do |actual|
+    !actual.is_a?(Exception)
+  end
+  failure_message_for_should do |actual|
+    "expected response body to meet output schema, got following error:\n" + \
+    "    #{actual.message}"
+  end
+end
+
+RSpec::Matchers.define :meet_error_schema do
+  match do |actual|
+    !actual.is_a?(Exception)
+  end
+  failure_message_for_should do |actual|
+    "expected response body to meet error schema, got following error:\n" + \
+    "    #{actual.message}"
+  end
+end
+
+RSpec::Matchers.define :meet_assertion do |assert|
+  match do |actual|
+    actual.nil?
+  end
+  failure_message_for_should do |actual|
+    "expected assertion `#{assert}` to be met, got following error:\n" + \
+    "    #{actual.message}"
+  end
+end
+
+RSpec::Matchers.define :meet_postcondition do |post|
+  match do |actual|
+    actual.nil?
+  end
+  failure_message_for_should do |actual|
+    "expected postcondition `#{post.class.name}` to be met, got following error:\n" + \
+    "    #{actual}"
+  end
+end
+
+RSpec::Matchers.define :be_an_empty_errors_array do
+  match do |actual|
+    actual.empty?
+  end
+  failure_message_for_should do |actual|
+    "expected no webspicy error, got the following ones:\n" + actual.map{|a| "    #{a}" }.join("\n")
+  end
+end

data/lib/webspicy/version.rb

@@ -1,8 +1,8 @@
 module Webspicy
   module Version
     MAJOR = 0
-    MINOR = 15
-    TINY  = 5
+    MINOR = 16
+    TINY  = 1
   end
   VERSION = "#{Version::MAJOR}.#{Version::MINOR}.#{Version::TINY}"
 end

data/spec/unit/configuration/scope/test_each_service.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+module Webspicy
+  class Configuration
+    describe Scope, 'each_service' do
+
+      let(:scope) {
+        Scope.new(configuration)
+      }
+
+      let(:specification) {
+        scope.each_specification.first
+      }
+
+      subject {
+        scope.each_service(specification).to_a
+      }
+
+      context 'without any filter' do
+
+        let(:configuration) {
+          Configuration.new(restful_folder){|c|
+            c.file_filter = /getTodo.yml/
+          }
+        }
+
+        it 'returns all services' do
+          expect(subject.size).to eql(1)
+        end
+      end
+
+      context 'with a service filter as a proc' do
+
+        let(:configuration) {
+          Configuration.new(restful_folder){|c|
+            c.file_filter = /getTodo.yml/
+            c.service_filter = ->(s) {
+              s.method == "POST"
+            }
+          }
+        }
+
+        it 'returns nothing' do
+          expect(subject.size).to eql(0)
+        end
+      end
+
+    end
+  end
+end

data/spec/unit/configuration/scope/test_each_specification.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+module Webspicy
+  class Configuration
+    describe Scope, 'each_specification' do
+
+      let(:scope) {
+        Scope.new(configuration)
+      }
+
+      subject {
+        scope.each_specification.to_a
+      }
+
+      context 'without any filter' do
+
+        let(:configuration) {
+          Configuration.new(restful_folder)
+        }
+
+        it 'returns all files' do
+          expect(subject.size).to eql(restful_folder.glob('**/*.yml').size)
+        end
+      end
+
+      context 'with a file filter as a proc' do
+
+        let(:configuration) {
+          Configuration.new(restful_folder){|c|
+            c.file_filter = ->(f) {
+              f.basename.to_s == "getTodo.yml"
+            }
+          }
+        }
+
+        it 'returns only that file' do
+          expect(subject.size).to eql(1)
+        end
+      end
+
+      context 'with a file filter as a Regex' do
+
+        let(:configuration) {
+          Configuration.new(restful_folder){|c|
+            c.file_filter = /getTodo.yml/
+          }
+        }
+
+        it 'returns only that file' do
+          expect(subject.size).to eql(1)
+        end
+      end
+
+      context 'when having children folders' do
+
+        let(:configuration) {
+          Configuration.new(restful_folder) do |c|
+            c.folder 'todo'
+          end
+        }
+
+        it 'returns all files' do
+          expect(subject.size).to eql(restful_folder.glob('**/*.yml').size)
+        end
+      end
+
+    end
+  end
+end

data/spec/unit/configuration/scope/test_expand_example.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+module Webspicy
+  class Configuration
+    describe Scope, "expand_example" do
+
+      subject{ Scope.new({}).send(:expand_example, service, example) }
+
+      context 'when the service has no default example' do
+        let(:service) {
+          Webspicy.service({
+            method: "GET",
+            description: "Test service",
+            preconditions: "Foo",
+            input_schema: "{ id: Integer }",
+            output_schema: "{}",
+            error_schema: "{}"
+          })
+        }
+
+        let(:example) {
+          Webspicy.test_case({
+            description: "Hello world"
+          })
+        }
+
+        it 'returns the example itself' do
+          expect(subject).to be(example)
+        end
+      end
+
+      context 'when the service has a default example' do
+        let(:service) {
+          Webspicy.service({
+            method: "GET",
+            description: "Test service",
+            preconditions: "Foo",
+            input_schema: "{ id: Integer }",
+            output_schema: "{}",
+            error_schema: "{}",
+            default_example: {
+              expected: { status: 200 }
+            }
+          })
+        }
+
+        let(:example) {
+          Webspicy.test_case({
+            description: "Hello world",
+            expected: { content_type: "application/json" }
+          })
+        }
+
+        it 'deep merges the default example and the example as expected' do
+          expect(subject).to be_a(Specification::TestCase)
+          expect(subject.description).to eql("Hello world")
+          expect(subject.expected).to eql({
+            status: Support::StatusRange.int(200),
+            content_type: "application/json"
+          })
+        end
+      end
+
+    end
+  end
+end

data/spec/unit/configuration/scope/test_to_real_url.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+module Webspicy
+  class Configuration
+    describe Scope, 'to_real_url' do
+
+      let(:scope) {
+        Scope.new(configuration)
+      }
+
+      context 'when no host at all' do
+
+        let(:configuration) {
+          Configuration.new
+        }
+
+        it 'does nothing on absolute URLs already' do
+          url = 'http://127.0.0.1:4567/todo'
+          got = scope.to_real_url(url)
+          expect(got).to eql(url)
+        end
+
+        it 'yields the block relative URLs' do
+          got = scope.to_real_url("/todo"){ "hello" }
+          expect(got).to eql("hello")
+        end
+
+        it 'fails on relative URLs and no block is given' do
+          expect(->(){
+            scope.to_real_url("/todo")
+          }).to raise_error(/Unable to resolve `\/todo`/)
+        end
+      end
+
+      context 'with a static host' do
+
+        let(:configuration) {
+          Configuration.new do |c|
+            c.host = "http://127.0.0.1:4568"
+          end
+        }
+
+        it 'does nothing on absolute URLs already' do
+          url = 'http://127.0.0.1:4567/todo'
+          got = scope.to_real_url(url)
+          expect(got).to eql(url)
+        end
+
+        it 'resolves relative URLs as expected' do
+          url = '/todo'
+          got = scope.to_real_url(url)
+          expect(got).to eql("http://127.0.0.1:4568/todo")
+        end
+
+      end
+
+      context 'with a dynamic host resolver' do
+
+        let(:configuration) {
+          Configuration.new do |c|
+            c.host = ->(url, tc) {
+              "http://127.0.0.1:4568#{url}"
+            }
+          end
+        }
+
+        it 'resolves absolute URLs' do
+          url = 'http://127.0.0.1:4567/todo'
+          got = scope.to_real_url(url)
+          expect(got).to eql("http://127.0.0.1:4568#{url}")
+        end
+
+        it 'resolves relative URLs as expected' do
+          url = '/todo'
+          got = scope.to_real_url(url)
+          expect(got).to eql("http://127.0.0.1:4568/todo")
+        end
+
+      end
+
+    end
+  end
+end