committee 5.5.3 → 5.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d63a9269323d485600c6f853e59ea9ac678faa6090838560cea1e54cec88f40
-  data.tar.gz: d8168ded9e92aabbf7144e6f98c8b52a90f1b5b956c3c4d9ae1bbba61504fbf2
+  metadata.gz: d5ca2d98a65682acdd759d0fdbb8de493cec34b96889fec3cfd18bf4928b50cc
+  data.tar.gz: f2c50536c4bd4840dae6dc1a3da96c4a85dd2ec25ee69e55c944a90f3a514d00
 SHA512:
-  metadata.gz: 3b951a8e7d81870e3d5947145dfdafb777e980367d41f83f4bc66c4ed902face9b29e6e92f7bb2db55e5a3ed56ff0c95544b35305373061501dcba76cb71ee5e
-  data.tar.gz: ac977e7c4f909abd4707aa0b540cf5efcd885b03212bec6eca6cf69f4199e2bed0ed2711768d7852f93921192d12ea957e7f4f07868cc3259b96374097c89a12
+  metadata.gz: b3f35d67aab36148b9085b0a129ee315ea41e27ed6fde96c2038830c2046a3d1d5e212feeae849cd3d4571d69b01349911826711a699d326d6e799ca725a9391
+  data.tar.gz: 411bb7a8a21de88b9c978cb848480a2a40ebd9aab2e9819648d066d301db47420e9ccf9820c292e441c90b546d9c42ff42b0363c852e7db78e7eb902415adf6c

data/lib/committee/middleware/response_validation.rb

@@ -9,25 +9,38 @@ module Committee
         super
         @strict = options[:strict]
         @validate_success_only = @schema.validator_option.validate_success_only
+        @streaming_content_parsers = options[:streaming_content_parsers] || {}
       end
 
       def handle(request)
         status, headers, response = @app.call(request.env)
 
-        begin
-          v = build_schema_validator(request)
-          v.response_validate(status, headers, response, @strict) if v.link_exist? && self.class.validate?(status, validate_success_only)
+        streaming_content_parser = retrieve_streaming_content_parser(headers)
 
-        rescue Committee::InvalidResponse
-          handle_exception($!, request.env)
+        if streaming_content_parser
+          response = Rack::BodyProxy.new(response) do
+            begin
+              validate(request, status, headers, response, streaming_content_parser)
+            rescue => e
+              handle_exception(e, request.env)
 
-          raise if @raise
-          return @error_class.new(500, :invalid_response, $!.message).render unless @ignore_error
-        rescue JSON::ParserError
-          handle_exception($!, request.env)
+              raise e if @raise
+            end
+          end
+        else
+          begin
+            validate(request, status, headers, response)
+          rescue Committee::InvalidResponse
+            handle_exception($!, request.env)
+
+            raise if @raise
+            return @error_class.new(500, :invalid_response, $!.message).render unless @ignore_error
+          rescue JSON::ParserError
+            handle_exception($!, request.env)
 
-          raise Committee::InvalidResponse if @raise
-          return @error_class.new(500, :invalid_response, "Response wasn't valid JSON.").render unless @ignore_error
+            raise Committee::InvalidResponse if @raise
+            return @error_class.new(500, :invalid_response, "Response wasn't valid JSON.").render unless @ignore_error
+          end
         end
 
         [status, headers, response]
@@ -50,6 +63,19 @@ module Committee
 
       private
 
+      def validate(request, status, headers, response, streaming_content_parser = nil)
+        v = build_schema_validator(request)
+        if v.link_exist? && self.class.validate?(status, validate_success_only)
+          v.response_validate(status, headers, response, @strict, streaming_content_parser)
+        end
+      end
+
+      def retrieve_streaming_content_parser(headers)
+        content_type_key = headers.keys.detect { |k| k.casecmp?('Content-Type') }
+        content_type = headers.fetch(content_type_key, nil)
+        @streaming_content_parsers[content_type]
+      end
+
       def handle_exception(e, env)
         @error_handler.call(e, env) if @error_handler
       end

data/lib/committee/schema_validator/hyper_schema.rb

@@ -18,7 +18,7 @@ module Committee
         parameter_coerce!(request, link, "rack.request.query_hash") if link_exist? && !request.GET.nil? && !link.schema.nil?
       end
 
-      def response_validate(status, headers, response, _test_method = false)
+      def response_validate(status, headers, response, _test_method = false, custom_body_parser = nil)
         return unless link_exist?
 
         full_body = +""
@@ -26,8 +26,9 @@ module Committee
           full_body << chunk
         end
 
-        data = {}
-        unless full_body.empty?
+        data = if custom_body_parser
+                 custom_body_parser.call(full_body)
+        elsif !full_body.empty?
           parse_to_json = if validator_option.parse_response_by_content_type
                             content_type_key = headers.keys.detect { |k| k.casecmp?('Content-Type') }
             headers.fetch(content_type_key, nil)&.start_with?('application/json')
@@ -35,7 +36,9 @@ module Committee
             true
           end
 
-          data = JSON.parse(full_body) if parse_to_json
+          JSON.parse(full_body) if parse_to_json
+        else
+          {}
         end
 
         Committee::SchemaValidator::HyperSchema::ResponseValidator.new(link, validate_success_only: validator_option.validate_success_only, allow_blank_structures: validator_option.allow_blank_structures).call(status, headers, data)

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

@@ -110,7 +110,8 @@ module Committee
         end
 
         def validate_post_request_params(path_params, query_params, body_params, headers, validator_option)
-          content_type = headers['Content-Type'].to_s.split(";").first.to_s
+          content_type_key = headers.keys.detect { |k| k.casecmp?('Content-Type') }
+          content_type = headers[content_type_key].to_s.split(';').first.to_s
 
           # bad performance because when we coerce value, same check
           validate_path_and_query_params(path_params, query_params, headers, validator_option)

data/lib/committee/schema_validator/open_api_3.rb

@@ -20,7 +20,7 @@ module Committee
         copy_coerced_data_to_params(request)
       end
 
-      def response_validate(status, headers, response, test_method = false)
+      def response_validate(status, headers, response, test_method = false, custom_body_parser = nil)
         full_body = +""
         response.each do |chunk|
           full_body << chunk
@@ -28,16 +28,18 @@ module Committee
 
         parse_to_json = if validator_option.parse_response_by_content_type
                           content_type_key = headers.keys.detect { |k| k.casecmp?('Content-Type') }
-          headers.fetch(content_type_key, nil)&.start_with?('application/json')
-        else
-          true
-        end
-
-        data = if parse_to_json
+                          headers.fetch(content_type_key, nil)&.start_with?('application/json')
+                        else
+                          true
+                        end
+
+        data = if custom_body_parser
+                 custom_body_parser.call(full_body)
+               elsif parse_to_json
                  full_body.empty? ? {} : JSON.parse(full_body)
-        else
-          full_body
-        end
+               else
+                 full_body
+               end
 
         # TODO: refactoring name
         strict = test_method

data/lib/committee/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Committee
-  VERSION = '5.5.3'.freeze
+  VERSION = '5.5.5'.freeze
 end

data/test/middleware/response_validation_test.rb

@@ -196,6 +196,74 @@ describe Committee::Middleware::ResponseValidation do
     end
   end
 
+  describe 'streaming response' do
+    describe "text/event-stream; e.g. server-sent events" do
+      it 'validates the response stream as a string' do
+        options = {
+          schema: open_api_3_streaming_response_schema,
+          streaming_content_parsers: { 'text/event-stream' => ->(body) { body } },
+        }
+        status = 200
+        headers = { 'content-type' => 'text/event-stream' }
+        @app = Rack::Builder.new {
+          use Committee::Middleware::ResponseValidation, options
+          run lambda { |_|
+            [status, headers, ["hello"]]
+          }
+        }
+
+        get "/events/stream"
+        assert_equal 200, last_response.status
+      end
+    end
+
+    describe 'application/x-json-stream; customized streaming event' do
+      it "successfully validates the response as a special stream using a customized parser" do
+        error_handler_called = false
+        error_handler = ->(_e, _env) { error_handler_called = true }
+        options = {
+          schema: open_api_3_streaming_response_schema,
+          streaming_content_parsers: { 'application/x-json-stream' => ->(body) { JSON.parse!(body) } },
+          error_handler: error_handler,
+        }
+        status = 200
+        headers = { 'content-type' => 'application/x-json-stream' }
+        @app = Rack::Builder.new {
+          use Committee::Middleware::ResponseValidation, options
+          run lambda { |_|
+            [status, headers, [JSON.dump({ "id" => 12345, "message" => "hello" })]]
+          }
+        }
+
+        get "/events/stream/json"
+        assert_equal 200, last_response.status
+        assert_equal false, error_handler_called
+      end
+
+      it "fails to validate the response as a special stream using a customized parser due to a schema mismatch" do
+        error_handler_called = false
+        error_handler = ->(_e, _env) { error_handler_called = true }
+        options = {
+          schema: open_api_3_streaming_response_schema,
+          streaming_content_parsers: { 'application/x-json-stream' => ->(body) { JSON.parse!(body) } },
+          error_handler: error_handler,
+        }
+        status = 200
+        headers = { 'content-type' => 'application/x-json-stream' }
+        @app = Rack::Builder.new {
+          use Committee::Middleware::ResponseValidation, options
+          run lambda { |_|
+            [status, headers, [JSON.dump({ "message" => "hello" })]] # Missing 'id' field
+          }
+        }
+
+        get "/events/stream/json"
+        assert_equal 200, last_response.status
+        assert_equal true, error_handler_called
+      end
+    end
+  end
+
   private
 
   def new_rack_app(response, headers = {}, options = {})

data/test/test_helper.rb

@@ -61,6 +61,10 @@ def open_api_3_coverage_schema
   @open_api_3_coverage_schema ||= Committee::Drivers.load_from_file(open_api_3_coverage_schema_path, parser_options: { strict_reference_validation: true })
 end
 
+def open_api_3_streaming_response_schema
+  @open_api_3_streaming_response_schema ||= Committee::Drivers.load_from_file(open_api_3_streaming_response_schema_path, parser_options: { strict_reference_validation: true })
+end
+
 # Don't cache this because we'll often manipulate the created hash in tests.
 def hyper_schema_data
   JSON.parse(File.read(hyper_schema_schema_path))
@@ -122,3 +126,7 @@ end
 def open_api_3_invalid_reference_path
   "./test/data/openapi3/invalid_reference.yaml"
 end
+
+def open_api_3_streaming_response_schema_path
+  "./test/data/openapi3/streaming_response.yaml"
+end

metadata

@@ -1,16 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: committee
 version: !ruby/object:Gem::Version
-  version: 5.5.3
+  version: 5.5.5
 platform: ruby
 authors:
 - Brandur
 - geemus (Wesley Beary)
 - ota42y
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-04-07 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_schema
@@ -39,9 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.5'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -49,9 +45,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.5'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: openapi_parser
   requirement: !ruby/object:Gem::Requirement
@@ -164,7 +157,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
 email:
 - brandur@mutelight.org
 - geemus+github@gmail.com
@@ -260,7 +252,6 @@ metadata:
   changelog_uri: https://github.com/interagent/committee/blob/master/CHANGELOG.md
   rubygems_mfa_required: 'true'
   source_code_uri: https://github.com/interagent/committee
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -275,8 +266,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.18
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A collection of Rack middleware to support JSON Schema.
 test_files: []