webspicy 0.18.0 → 0.19.0

data/lib/webspicy/openapi/generator.rb

@@ -1,127 +0,0 @@
-require "finitio/generation"
-require "finitio/json_schema"
-module Webspicy
-  module Openapi
-    class Generator
-
-      def initialize(config)
-        @config = Configuration.dress(config)
-        @generator = config.generator || Finitio::Generation.new
-      end
-      attr_reader :config, :generator
-
-      def call
-        {
-          openapi: "3.0.2",
-          info: {
-            version: "1.0.0",
-            title: "Hello API"
-          },
-          paths: paths
-        }
-      end
-
-    private
-
-      def paths
-        config.each_scope.inject({}) do |paths,scope|
-          scope.each_specification.inject(paths) do |paths,specification|
-            paths.merge(path_for(specification)){|k,ps,qs|
-              ps.merge(qs)
-            }
-          end
-        end
-      end
-
-      def path_for(specification)
-        {
-          specification.url => {
-            summary: specification.name
-          }.merge(verbs_for(specification))
-        }
-      end
-
-      def verbs_for(specification)
-        specification.services.inject({}) do |verbs,service|
-          verb = service.method.downcase
-          verb_defn = {
-            description: service.description,
-            responses: responses_for(service)
-          }
-          unless ["get", "options", "delete", "head"].include?(verb)
-            verb_defn[:requestBody] = request_body_for(service)
-          end
-          verbs.merge({ verb => verb_defn })
-        end
-      end
-
-      def request_body_for(service)
-        schema = actual_input_schema(service)
-        {
-          required: true,
-          content: {
-            "application/json" => {
-              schema: schema.to_json_schema,
-              example: generator.call(schema, {})
-            }
-          }
-        }
-      end
-
-      def responses_for(service)
-        result = {}
-        service.examples.each_with_object(result) do |test_case, rs|
-          rs.merge!(response_for(test_case, false)){|k,r1,r2| r1 }
-        end
-        service.counterexamples.each_with_object(result) do |test_case, rs|
-          rs.merge!(response_for(test_case, true)){|k,r1,r2| r1 }
-        end
-        result
-      end
-
-      def response_for(test_case, counterexample)
-        res = {
-          description: test_case.description,
-        }
-        status = (test_case.expected_status && test_case.expected_status.to_int) || 200
-        if test_case.expected_content_type && status != 204
-          content = {
-            schema: schema_for(test_case, counterexample)
-          }
-          unless counterexample
-            content[:example] = example_for(test_case, counterexample)
-          end
-          res[:content] = {
-            test_case.expected_content_type => content
-          }
-        end
-        {
-          status => res
-        }
-      end
-
-      def schema_for(test_case, counterexample)
-        schema = actual_output_schema(test_case, counterexample)
-        schema.to_json_schema
-      end
-
-      def example_for(test_case, counterexample)
-        schema = actual_output_schema(test_case, counterexample)
-        generator.call(schema, {})
-      end
-
-      def actual_output_schema(test_case, counterexample)
-        if counterexample
-          test_case.service.error_schema['Main']
-        else
-          test_case.service.output_schema['Main']
-        end
-      end
-
-      def actual_input_schema(service)
-        service.input_schema['Main']
-      end
-
-    end # class Generator
-  end # module Openapi
-end # module Webspicy

data/lib/webspicy/rspec/checker.rb

@@ -1,2 +0,0 @@
-require_relative 'support/rspec_runnable'
-require_relative 'checker/rspec_checker'

data/lib/webspicy/rspec/checker/rspec_checker.rb

@@ -1,24 +0,0 @@
-module Webspicy
-  class Checker
-    class RSpecChecker
-      include Webspicy::Support::RSpecRunnable
-
-    protected
-
-      def load_rspec_examples
-        config.each_scope do |scope|
-          scope.each_specification_file do |file, folder|
-            RSpec.describe file.relative_to(folder).to_s do
-
-              it 'meets the formal doc data schema' do
-                Webspicy.specification(file.load, file, scope)
-              end
-
-            end
-          end
-        end
-      end
-
-    end # class RSpecChecker
-  end # class Checker
-end # module Webspicy

data/lib/webspicy/rspec/support/rspec_runnable.rb

@@ -1,27 +0,0 @@
-module Webspicy
-  module Support
-    module RSpecRunnable
-
-      def initialize(config)
-        @config = Configuration.dress(config)
-      end
-      attr_reader :config
-
-      def reset_rspec!
-        RSpec.reset
-        RSpec.configure do |c|
-          c.filter_gems_from_backtrace "rake"
-        end
-        load_rspec_examples
-      end
-
-      def call(err=$stderr, out=$stdout)
-        reset_rspec!
-        options = RSpec::Core::ConfigurationOptions.new(config.rspec_options)
-        conf = RSpec::Core::Configuration.new
-        RSpec::Core::Runner.new(options, conf).run(err, out)
-      end
-
-    end # module RSpecRunnable
-  end # module Support
-end # module Webspicy

data/lib/webspicy/rspec/tester.rb

@@ -1,4 +0,0 @@
-require_relative 'support/rspec_runnable'
-require_relative 'tester/rspec_matchers'
-require_relative 'tester/rspec_asserter'
-require_relative 'tester/rspec_tester'

data/lib/webspicy/rspec/tester/rspec_asserter.rb

@@ -1,121 +0,0 @@
-module Webspicy
-  class Tester
-    class RSpecAsserter
-
-      def initialize(rspec, invocation)
-        @rspec = rspec
-        @invocation = invocation  
-      end
-      attr_reader :rspec,  :invocation
-
-      def self.call(rspec, invocation)
-        new(rspec, invocation).send(:assert!)
-      end
-
-      def response
-        invocation.response
-      end
-
-      def test_case
-        invocation.test_case
-      end
-
-      def service
-        test_case.service
-      end
-
-    protected
-
-      def assert!
-        rspec.aggregate_failures do
-          assert_status_met
-          assert_content_type_met
-          assert_expected_headers
-        end
-        assert_output_schema_met
-        rspec.aggregate_failures do
-          assert_assertions_met
-          assert_postconditions_met
-          assert_errconditions_met
-        end
-      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_errconditions_met
-        return unless service.has_errconditions?
-        return unless test_case.counterexample?
-        service.errconditions.each do |post|
-          msg = post.check(invocation)
-          rspec.expect(msg).to rspec.meet_errcondition(post)
-        end
-      end
-
-    end # class RSpecAsserter
-  end # class Tester
-end # module Webspicy

data/lib/webspicy/rspec/tester/rspec_matchers.rb

@@ -1,114 +0,0 @@
-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 :meet_errcondition do |post|
-  match do |actual|
-    actual.nil?
-  end
-  failure_message_for_should do |actual|
-    "expected errcondition `#{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/rspec/tester/rspec_tester.rb

@@ -1,63 +0,0 @@
-module Webspicy
-  class Tester
-    class RSpecTester
-      include Webspicy::Support::RSpecRunnable
-
-    protected
-
-      def load_rspec_examples
-        tester = self
-        RSpec.describe "Webspicy test suite" do
-          before(:all) do
-            tester.config.listeners(:before_all).each do |l|
-              l.call(tester.config)
-            end
-          end
-          after(:all) do
-            tester.config.listeners(:after_all).each do |l|
-              l.call(tester.config)
-            end
-          end
-          tester.config.each_scope do |scope|
-            client = scope.get_client
-            scope.each_specification do |specification|
-              scope.each_service(specification) do |service|
-                scope.each_testcase(service) do |test_case|
-                  str = "#{service} #{test_case}"
-                  str = Webspicy::Support::Colorize.colorize_highlight(str, tester.config)
-                  describe(str) do
-
-                    around(:each) do |example|
-                      client.around(test_case) do
-                        client.before(test_case)
-                        test_case.instrument(client)
-                        client.instrument(test_case)
-                        @response = client.call(test_case)
-                        @invocation = Tester::Invocation.new(test_case, @response, client)
-                        example.run
-                        client.after(test_case, @invocation)
-                        @invocation
-                      end
-                    end
-        
-                    let(:invocation) do
-                      @invocation
-                    end
-        
-                    it "meets its specification" do
-                      raise "Test not ran" unless invocation.done?
-                      RSpecAsserter.call(self, invocation)
-                    end
-
-                  end
-                end
-              end
-            end
-          end
-        end
-        self
-      end
-
-    end # class RSpecTester
-  end # class Tester
-end # module Webspicy