committee 5.0.0.beta1 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4257522fd7e79dceca7f4ee846f35d8eea30f70a4a2a9ab1f9e99a946eb992f6
-  data.tar.gz: c71c15566465b608e72380c47ad3beceb9195d47949c234c1fbb0f99b0ebc22a
+  metadata.gz: d38440a7b31b31d429a47b744f397333489d09dbae1dbf16bcd74dd01124d68d
+  data.tar.gz: a7d1b5a22c1f415c6eb2bae32b6666df4558c3361f7685c50926499e2e74575e
 SHA512:
-  metadata.gz: ca98156c131a991a05fc12f4bb149e2d740c6083befb91b96874ac27b2fdc923109e452f64d35f3e8bb0e92bd3c19575171013f8529ef95437bbd3b51335d1a4
-  data.tar.gz: a623459fca01819e67403a3ba73b4e7cf3997d01c48b6c21f71f87ca51b9f6eddf3e3e413be25678d684042cb94b991a75c5432ea85cec07af7f07696accaa94
+  metadata.gz: 5314750901b395a42cdb9efe6c3a2992bb67a4d7561a0937422d48574f7705944a0b7317ccc5b10eda510734a8dac2375eaf27c1932be26ea1000662b14cf31d
+  data.tar.gz: 2ec012b81b43e319df14fbaefeb72b38bc2f065358084d479e927d68c58734e44c6b3d252436dc3fcc296dbfeb0c7798105fb52f3aca7325904673f7cf9647e4

data/lib/committee/drivers.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'digest'
+
 module Committee
   module Drivers
     # Gets a driver instance from the specified name. Raises ArgumentError for
@@ -36,13 +38,16 @@ module Committee
     # @param [String] schema_path
     # @return [Committee::Driver]
     def self.load_from_file(schema_path, parser_options: {})
-      case File.extname(schema_path)
-      when '.json'
-        load_from_json(schema_path, parser_options: parser_options)
-      when '.yaml', '.yml'
-        load_from_yaml(schema_path, parser_options: parser_options)
-      else
-        raise "Committee only supports the following file extensions: '.json', '.yaml', '.yml'"
+      @__load_from_file_cache ||= {}
+      @__load_from_file_cache[cache_key(schema_path, parser_options)] ||= begin
+        case File.extname(schema_path)
+        when '.json'
+          load_from_json(schema_path, parser_options: parser_options)
+        when '.yaml', '.yml'
+          load_from_yaml(schema_path, parser_options: parser_options)
+        else
+          raise "Committee only supports the following file extensions: '.json', '.yaml', '.yml'"
+        end
       end
     end
 
@@ -74,6 +79,17 @@ module Committee
       # TODO: in the future, pass `opts` here and allow optionality in other drivers?
       driver.parse(hash)
     end
+
+    class << self
+      private
+
+      def cache_key(schema_path, parser_options)
+        [
+          File.exist?(schema_path) ? Digest::MD5.hexdigest(File.read(schema_path)) : nil,
+          parser_options.hash,
+        ].join('_')
+      end
+    end
   end
 end
 

data/lib/committee/schema_validator/hyper_schema/response_validator.rb

@@ -48,9 +48,15 @@ module Committee
         private
 
         def response_media_type(response)
-          response.content_type.to_s.split(";").first.to_s
+          if response.respond_to?(:media_type)
+            response.media_type.to_s
+          else
+            # for rack compatibility. In rack v 1.5.0, Rack::Response doesn't have media_type
+            response.content_type.to_s.split(";").first.to_s
+          end
         end
 
+
         def check_content_type!(response)
           if @link.media_type
             unless Rack::Mime.match?(response_media_type(response), @link.media_type)

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

@@ -52,6 +52,10 @@ module Committee
           ret
         end
 
+        def optional_body?
+          !request_operation.operation_object&.request_body&.required
+        end
+
         def valid_request_content_type?(content_type)
           if (request_body = request_operation.operation_object&.request_body)
             !request_body.select_media_type(content_type).nil?

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

@@ -24,6 +24,7 @@ module Committee
           # support post, put, patch only
           return true unless request.post? || request.put? || request.patch?
           return true if @operation_object.valid_request_content_type?(content_type)
+          return true if @operation_object.optional_body? && empty_request?(request)
 
           message = if valid_content_types.size > 1
                       types = valid_content_types.map {|x| %{"#{x}"} }.join(', ')
@@ -37,6 +38,14 @@ module Committee
         def valid_content_types
           @operation_object&.request_content_types
         end
+
+        def empty_request?(request)
+          return true if !request.body
+
+          data = request.body.read
+          request.body.rewind
+          data.empty?
+        end
       end
     end
   end

data/lib/committee/schema_validator.rb

@@ -4,7 +4,7 @@ module Committee
   module SchemaValidator
     class << self
       def request_media_type(request)
-        request.content_type.to_s.split(";").first.to_s
+        request.media_type.to_s
       end
 
       # @param [String] prefix

data/lib/committee/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Committee
-    VERSION = '5.0.0.beta1'.freeze
+    VERSION = '5.1.0'.freeze
 end

data/test/drivers_test.rb

@@ -67,6 +67,35 @@ describe Committee::Drivers do
       end
       assert_equal "Committee only supports the following file extensions: '.json', '.yaml', '.yml'", e.message
     end
+
+    describe 'cache behavior' do
+      describe 'when loading the same file' do
+        it 'returns the same object when the options are identical' do
+          assert_equal(
+            Committee::Drivers.load_from_file(open_api_3_schema_path, parser_options:{strict_reference_validation: true}).object_id,
+            Committee::Drivers.load_from_file(open_api_3_schema_path, parser_options:{strict_reference_validation: true}).object_id,
+          )
+        end
+
+        it 'returns different objects if the options are different' do
+          refute_equal(
+            Committee::Drivers.load_from_file(open_api_3_schema_path, parser_options:{strict_reference_validation: true}).object_id,
+            Committee::Drivers.load_from_file(open_api_3_schema_path, parser_options:{strict_reference_validation: false}).object_id,
+          )
+        end
+
+        it 'returns different objects if the file contents have changed' do
+          object_id = Committee::Drivers.load_from_file(open_api_3_schema_path, parser_options:{strict_reference_validation: true}).object_id
+          original_file_contents = File.read(open_api_3_schema_path)
+          File.write(open_api_3_schema_path, original_file_contents + "\n")
+          refute_equal(
+            Committee::Drivers.load_from_file(open_api_3_schema_path, parser_options:{strict_reference_validation: true}).object_id,
+            object_id,
+          )
+          File.write(open_api_3_schema_path, original_file_contents)
+        end
+      end
+    end
   end
 
   describe 'load_from_json(schema_path)' do

data/test/schema_validator/open_api_3/request_validator_test.rb

@@ -71,6 +71,13 @@ describe Committee::SchemaValidator::OpenAPI3::RequestValidator do
       assert_equal 200, last_response.status
     end
 
+    it "skips content_type check with an empty body" do
+      @app = new_rack_app(check_content_type: true, schema: open_api_3_schema)
+      header "Content-Type", "application/x-www-form-urlencoded"
+      patch "/validate_empty_optional_body"
+      assert_equal 200, last_response.status
+    end
+    
     it "does not mix up parameters and requestBody" do
       @app = new_rack_app(check_content_type: true, schema: open_api_3_schema)
       params = {
@@ -81,10 +88,17 @@ describe Committee::SchemaValidator::OpenAPI3::RequestValidator do
       assert_equal 200, last_response.status
     end
 
+    it "error because content_type check with body" do
+      @app = new_rack_app(check_content_type: true, schema: open_api_3_schema)
+      header "Content-Type", "application/x-www-form-urlencoded"
+      patch "/validate_empty_optional_body", "{}"
+      assert_equal 400, last_response.status
+    end    
+
     def new_rack_app(options = {})
       # TODO: delete when 5.0.0 released because default value changed
       options[:parse_response_by_content_type] = true if options[:parse_response_by_content_type] == nil
-    
+
       Rack::Builder.new {
         use Committee::Middleware::RequestValidation, options
         run lambda { |_|

data/test/test_helper.rb

@@ -11,8 +11,10 @@ SimpleCov.start do
   add_filter "/test/"
 
   # This library has a pretty modest number of lines, so let's try to stick
-  # to a 100% coverage target for a while and see what happens.
-  minimum_coverage 100
+  # to a 99% coverage target for a while and see what happens.
+  # We can't use 100% because old rack version doesn't support media_type and it's not testable :(
+  # https://github.com/interagent/committee/pull/360/files#diff-ce1125b6594690a88a70dbe2869f7fcfa2962c2bca80751f3720888920e2dfabR54
+  minimum_coverage 99
 end
 
 require "minitest"

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: committee
 version: !ruby/object:Gem::Version
-  version: 5.0.0.beta1
+  version: 5.1.0
 platform: ruby
 authors:
 - Brandur
 - geemus (Wesley Beary)
 - ota42y
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-25 00:00:00.000000000 Z
+date: 2024-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_schema
@@ -52,14 +52,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -214,7 +214,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - brandur@mutelight.org
 - geemus+github@gmail.com
@@ -306,7 +306,7 @@ homepage: https://github.com/interagent/committee
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -317,12 +317,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key: 
+rubygems_version: 3.4.20
+signing_key:
 specification_version: 4
 summary: A collection of Rack middleware to support JSON Schema.
 test_files: []