committee 3.3.0 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c35304cf9026ae20062ea312cdca6b43af486c4c2e5e7c952b35bbad811ce4e
-  data.tar.gz: d9a96cd2c6c15b9de26fb95ef0b4d59216c999f8589329d6ee6b21b41e2511d9
+  metadata.gz: 19c70ee2e436755ddf7b0b59b213ab7c00b60e67ce52520b956b889121b24e4c
+  data.tar.gz: 06066adc6056231938d36d93a98c5d7318d9c1ff367784265d66c0eb271fb7b6
 SHA512:
-  metadata.gz: 42ffc889dcc301c9de500417390454f4723bf049f0336b9de92b94fcaa2d67f53a7f5c4c9ad5a3a56bd2e9fff70d06ebe7c7279729c616b45ab33625c2a33572
-  data.tar.gz: d3c7ca273497b2eb4444fcdb6eb43f49fed866335d1a627f806586f6755557b8a956b43eb5c9448b7cf19176b9e2a4705c78bf6045dde2e98b19fd55211e0070
+  metadata.gz: bfbcc7aa85c676291125ed16b20badadda3eb8d895b6834cdc884602345c6ed3a052ecbdd381615b8bbca49815d884407cf8cc2f8cbbe05702593b5cc171f568
+  data.tar.gz: cc454350c3d04969ad3f24c1922b887a6e319cea4f0a869b647ef439dbc9f5f83f3922bde82abdeb0994a540e53d5e68345e76d7291b408e42cd2f5a4df9eec1

data/lib/committee.rb

@@ -16,9 +16,7 @@ module Committee
   end
 
   def self.warn_deprecated(message)
-    if !$VERBOSE.nil?
-      $stderr.puts(message)
-    end
+    warn("[DEPRECATION] #{message}")
   end
 end
 
@@ -31,3 +29,4 @@ require_relative "committee/validation_error"
 
 require_relative "committee/bin/committee_stub"
 require_relative "committee/test/methods"
+require_relative "committee/test/schema_coverage"

data/lib/committee/drivers.rb

@@ -21,14 +21,14 @@ module Committee
     # @param [String] schema_path
     # @return [Committee::Driver]
     def self.load_from_json(schema_path)
-      load_from_data(JSON.parse(File.read(schema_path)))
+      load_from_data(JSON.parse(File.read(schema_path)), schema_path)
     end
 
     # load and build drive from YAML file
     # @param [String] schema_path
     # @return [Committee::Driver]
     def self.load_from_yaml(schema_path)
-      load_from_data(YAML.load_file(schema_path))
+      load_from_data(YAML.load_file(schema_path), schema_path)
     end
 
     # load and build drive from file
@@ -48,10 +48,10 @@ module Committee
     # load and build drive from Hash object
     # @param [Hash] hash
     # @return [Committee::Driver]
-    def self.load_from_data(hash)
+    def self.load_from_data(hash, schema_path = nil)
       if hash['openapi']&.start_with?('3.0.')
-        parser = OpenAPIParser.parse(hash)
-        return Committee::Drivers::OpenAPI3::Driver.new.parse(parser)
+        openapi = OpenAPIParser.parse_with_filepath(hash, schema_path)
+        return Committee::Drivers::OpenAPI3::Driver.new.parse(openapi)
       end
 
       driver = if hash['swagger'] == '2.0'

data/lib/committee/errors.rb

@@ -8,9 +8,21 @@ module Committee
   end
 
   class InvalidRequest < Error
+    attr_reader :original_error
+
+    def initialize(error_message=nil, original_error: nil)
+      @original_error = original_error
+      super(error_message)
+    end
   end
 
   class InvalidResponse < Error
+    attr_reader :original_error
+
+    def initialize(error_message=nil, original_error: nil)
+      @original_error = original_error
+      super(error_message)
+    end
   end
 
   class NotFound < Error

data/lib/committee/middleware/request_validation.rb

@@ -21,14 +21,14 @@ module Committee
         rescue Committee::BadRequest, Committee::InvalidRequest
           handle_exception($!, request.env)
           raise if @raise
-          return @error_class.new(400, :bad_request, $!.message).render unless @ignore_error
+          return @error_class.new(400, :bad_request, $!.message, request).render unless @ignore_error
         rescue Committee::NotFound => e
           raise if @raise
-          return @error_class.new(404, :not_found, e.message).render unless @ignore_error
+          return @error_class.new(404, :not_found, e.message, request).render unless @ignore_error
         rescue JSON::ParserError
           handle_exception($!, request.env)
           raise Committee::InvalidRequest if @raise
-          return @error_class.new(400, :bad_request, "Request body wasn't valid JSON.").render unless @ignore_error
+          return @error_class.new(400, :bad_request, "Request body wasn't valid JSON.", request).render unless @ignore_error
         end
 
         @app.call(request.env)
@@ -42,11 +42,7 @@ module Committee
         if @error_handler.arity > 1
           @error_handler.call(e, env)
         else
-          warn <<-MESSAGE
-          [DEPRECATION] Using `error_handler.call(exception)` is deprecated and will be change to
-            `error_handler.call(exception, request.env)` in next major version.
-          MESSAGE
-
+          Committee.warn_deprecated('Using `error_handler.call(exception)` is deprecated and will be change to `error_handler.call(exception, request.env)` in next major version.')
           @error_handler.call(e)
         end
       end

data/lib/committee/middleware/response_validation.rb

@@ -11,9 +11,9 @@ module Committee
       end
 
       def handle(request)
-        begin
-          status, headers, response = @app.call(request.env)
+        status, headers, response = @app.call(request.env)
 
+        begin
           v = build_schema_validator(request)
           v.response_validate(status, headers, response) if v.link_exist? && self.class.validate?(status, validate_success_only)
 
@@ -46,11 +46,7 @@ module Committee
         if @error_handler.arity > 1
           @error_handler.call(e, env)
         else
-          warn <<-MESSAGE
-          [DEPRECATION] Using `error_handler.call(exception)` is deprecated and will be change to
-            `error_handler.call(exception, request.env)` in next major version.
-          MESSAGE
-
+          Committee.warn_deprecated('Using `error_handler.call(exception)` is deprecated and will be change to `error_handler.call(exception, request.env)` in next major version.')
           @error_handler.call(e)
         end
       end

data/lib/committee/request_unpacker.rb

@@ -16,7 +16,7 @@ module Committee
     def call
       # if Content-Type is empty or JSON, and there was a request body, try to
       # interpret it as JSON
-      params = if !@request.media_type || @request.media_type =~ %r{application/.*json}
+      params = if !@request.media_type || @request.media_type =~ %r{application/(?:.*\+)?json}
         parse_json
       elsif @optimistic_json
         begin

data/lib/committee/schema_validator/hyper_schema.rb

@@ -35,7 +35,14 @@ module Committee
         response.each do |chunk|
           full_body << chunk
         end
-        data = full_body.empty? ? {} : JSON.parse(full_body)
+
+        data = {}
+        unless full_body.empty?
+          parse_to_json = !validator_option.parse_response_by_content_type ||
+                          headers.fetch('Content-Type', nil)&.start_with?('application/json')
+          data = JSON.parse(full_body) if parse_to_json
+        end
+
         Committee::SchemaValidator::HyperSchema::ResponseValidator.new(link, validate_success_only: validator_option.validate_success_only).call(status, headers, data)
       end
 

data/lib/committee/schema_validator/open_api_3.rb

@@ -30,7 +30,14 @@ module Committee
         response.each do |chunk|
           full_body << chunk
         end
-        data = full_body.empty? ? {} : JSON.parse(full_body)
+
+        parse_to_json = !validator_option.parse_response_by_content_type || 
+                        headers.fetch('Content-Type', nil)&.start_with?('application/json')
+        data = if parse_to_json
+          full_body.empty? ? {} : JSON.parse(full_body)
+        else
+          full_body
+        end
 
         strict = test_method
         Committee::SchemaValidator::OpenAPI3::ResponseValidator.

data/lib/committee/schema_validator/open_api_3/operation_wrapper.rb

@@ -17,13 +17,17 @@ module Committee
           request_operation.original_path
         end
 
+        def http_method
+          request_operation.http_method
+        end
+
         def coerce_path_parameter(validator_option)
           options = build_openapi_parser_path_option(validator_option)
           return {} unless options.coerce_value
 
           request_operation.validate_path_params(options)
         rescue OpenAPIParser::OpenAPIError => e
-          raise Committee::InvalidRequest.new(e.message)
+          raise Committee::InvalidRequest.new(e.message, original_error: e)
         end
 
         # @param [Boolean] strict when not content_type or status code definition, raise error
@@ -32,7 +36,7 @@ module Committee
 
           return request_operation.validate_response_body(response_body, response_validate_options(strict, check_header))
         rescue OpenAPIParser::OpenAPIError => e
-          raise Committee::InvalidResponse.new(e.message)
+          raise Committee::InvalidResponse.new(e.message, original_error: e)
         end
 
         def validate_request_params(params, headers, validator_option)
@@ -109,7 +113,7 @@ module Committee
           # bad performance because when we coerce value, same check
           request_operation.validate_request_parameter(params, headers, build_openapi_parser_get_option(validator_option))
         rescue OpenAPIParser::OpenAPIError => e
-          raise Committee::InvalidRequest.new(e.message)
+          raise Committee::InvalidRequest.new(e.message, original_error: e)
         end
 
         def validate_post_request_params(params, headers, validator_option)
@@ -120,7 +124,7 @@ module Committee
           request_operation.validate_request_parameter(params, headers, schema_validator_options)
           request_operation.validate_request_body(content_type, params, schema_validator_options)
         rescue => e
-          raise Committee::InvalidRequest.new(e.message)
+          raise Committee::InvalidRequest.new(e.message, original_error: e)
         end
 
         def response_validate_options(strict, check_header)

data/lib/committee/schema_validator/open_api_3/router.rb

@@ -22,8 +22,10 @@ module Committee
         end
 
         def operation_object(request)
+          return nil unless includes_request?(request)
+
           path = request.path
-          path = path.gsub(@prefix_regexp, '') if prefix_request?(request)
+          path = path.gsub(@prefix_regexp, '') if @prefix_regexp
 
           request_method = request.request_method.downcase
 

data/lib/committee/schema_validator/option.rb

@@ -15,7 +15,8 @@ module Committee
                   :coerce_query_params,
                   :coerce_recursive,
                   :optimistic_json,
-                  :validate_success_only
+                  :validate_success_only,
+                  :parse_response_by_content_type
 
       # Non-boolean options:
       attr_reader :headers_key,
@@ -35,6 +36,12 @@ module Committee
         @check_header        = options.fetch(:check_header, true)
         @coerce_recursive    = options.fetch(:coerce_recursive, true)
         @optimistic_json     = options.fetch(:optimistic_json, false)
+        @parse_response_by_content_type = if options[:parse_response_by_content_type].nil?
+          Committee.warn_deprecated('Committee: please set parse_response_by_content_type = false because we\'ll change default value in next major version.') 
+          false
+        else
+          options.fetch(:parse_response_by_content_type)
+        end
 
         # Boolean options and have a different value by default
         @allow_get_body      = options.fetch(:allow_get_body, schema.driver.default_allow_get_body)

data/lib/committee/test/methods.rb

@@ -10,7 +10,7 @@ module Committee
 
       def assert_request_schema_confirm
         unless schema_validator.link_exist?
-          request = "`#{request_object.request_method} #{request_object.path_info}` undefined in schema."
+          request = "`#{request_object.request_method} #{request_object.path_info}` undefined in schema (prefix: #{committee_options[:prefix].inspect})."
           raise Committee::InvalidRequest.new(request)
         end
 
@@ -19,11 +19,17 @@ module Committee
 
       def assert_response_schema_confirm
         unless schema_validator.link_exist?
-          response = "`#{request_object.request_method} #{request_object.path_info}` undefined in schema."
+          response = "`#{request_object.request_method} #{request_object.path_info}` undefined in schema (prefix: #{committee_options[:prefix].inspect})."
           raise Committee::InvalidResponse.new(response)
         end
 
         status, headers, body = response_data
+
+        if schema_coverage
+          operation_object = router.operation_object(request_object)
+          schema_coverage&.update_response_coverage!(operation_object.original_path, operation_object.http_method, status)
+        end
+
         schema_validator.response_validate(status, headers, [body], true) if validate_response?(status)
       end
 
@@ -55,15 +61,18 @@ module Committee
         @schema_validator ||= router.build_schema_validator(request_object)
       end
 
+      def schema_coverage
+        return nil unless schema.is_a?(Committee::Drivers::OpenAPI3::Schema)
+
+        coverage = committee_options.fetch(:schema_coverage, nil)
+
+        coverage.is_a?(SchemaCoverage) ? coverage : nil
+      end
+
       def old_behavior
         old_assert_behavior = committee_options.fetch(:old_assert_behavior, nil)
         if old_assert_behavior.nil?
-          warn <<-MSG
-          [DEPRECATION] now assert_schema_conform check response schema only.
-            but we will change check request and response in future major version.
-            so if you want to conform response only, please use assert_response_schema_confirm,
-            or you can suppress this message and keep old behavior by setting old_assert_behavior=true.
-          MSG
+          Committee.warn_deprecated('Now assert_schema_conform check response schema only. but we will change check request and response in future major version. so if you want to conform response only, please use assert_response_schema_confirm, or you can suppress this message and keep old behavior by setting old_assert_behavior=true.')
           old_assert_behavior = true
         end
         old_assert_behavior

data/lib/committee/test/schema_coverage.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+module Committee
+  module Test
+    class SchemaCoverage
+      attr_reader :schema
+
+      class << self
+        def merge_report(first, second)
+          report = first.dup
+          second.each do |k, v|
+            if v.is_a?(Hash)
+              if report[k].nil?
+                report[k] = v
+              else
+                report[k] = merge_report(report[k], v)
+              end
+            else
+              report[k] ||= v
+            end
+          end
+          report
+        end
+
+        def flatten_report(report)
+          responses = []
+          report.each do |path_name, path_coverage|
+            path_coverage.each do |method, method_coverage|
+              responses_coverage = method_coverage['responses']
+              responses_coverage.each do |response_status, is_covered|
+                responses << {
+                  path: path_name,
+                  method: method,
+                  status: response_status,
+                  is_covered: is_covered,
+                }
+              end
+            end
+          end
+          {
+            responses: responses,
+          }
+        end
+      end
+
+      def initialize(schema)
+        raise 'Unsupported schema' unless schema.is_a?(Committee::Drivers::OpenAPI3::Schema)
+
+        @schema = schema
+        @covered = {}
+      end
+
+      def update_response_coverage!(path, method, response_status)
+        method = method.to_s.downcase
+        response_status = response_status.to_s
+
+        @covered[path] ||= {}
+        @covered[path][method] ||= {}
+        @covered[path][method]['responses'] ||= {}
+        @covered[path][method]['responses'][response_status] = true
+      end
+
+      def report
+        report = {}
+
+        schema.open_api.paths.path.each do |path_name, path_item|
+          report[path_name] = {}
+          path_item._openapi_all_child_objects.each do |object_name, object|
+            next unless object.is_a?(OpenAPIParser::Schemas::Operation)
+
+            method = object_name.split('/').last&.downcase
+            next unless method
+
+            report[path_name][method] ||= {}
+
+            # TODO: check coverage on request params/body as well?
+
+            report[path_name][method]['responses'] ||= {}
+            object.responses.response.each do |response_status, _|
+              is_covered = @covered.dig(path_name, method, 'responses', response_status) || false
+              report[path_name][method]['responses'][response_status] = is_covered
+            end
+            if object.responses.default
+              is_default_covered = (@covered.dig(path_name, method, 'responses') || {}).any? do |status, is_covered|
+                is_covered && !object.responses.response.key?(status)
+              end
+              report[path_name][method]['responses']['default'] = is_default_covered
+            end
+          end
+        end
+
+        report
+      end
+
+      def report_flatten
+        self.class.flatten_report(report)
+      end
+    end
+  end
+end
+

data/lib/committee/validation_error.rb

@@ -2,12 +2,13 @@
 
 module Committee
   class ValidationError
-    attr_reader :id, :message, :status
+    attr_reader :id, :message, :status, :request
 
-    def initialize(status, id, message)
+    def initialize(status, id, message, request = nil)
       @status = status
       @id = id
       @message = message
+      @request = request
     end
 
     def error_body

data/test/bin/committee_stub_test.rb

@@ -43,7 +43,11 @@ describe Committee::Bin::CommitteeStub, "app" do
   end
 
   def app
-    @bin.get_app(hyper_schema, {})
+    options = {}
+    # TODO: delete when 5.0.0 released because default value changed
+    options[:parse_response_by_content_type] = false
+
+    @bin.get_app(hyper_schema, options)
   end
 
   it "defaults to a 404" do