committee 4.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fba0d88ad4356b605437b7bdee80b8af67f4c1604aa01ed67f8e23f03097e93d
-  data.tar.gz: 3a26946ba09a1543a045d2e5755e18da81302964c8b7452e093457745960ad01
+  metadata.gz: 9bef22bebc103d1bee78ba294078cd56e34e37da3e92b5cb89aba683a2361c74
+  data.tar.gz: 76f012e3f28bd5275af941a372563f00b3bf68e1c0332d0e78affc18cbac9f2e
 SHA512:
-  metadata.gz: 245f5960617c3bba3da10e6c64441493eb4d8d657f3deb98d18e46e3db4564ebeeae63fc372eb6153f4d2e0c00124fee4fcec1b7d8b3b342a712d9da63d28257
-  data.tar.gz: 5bb6f878296cac731f5c081e6fe531305c79599e427dad1d72b128def97627c56e2c62901de3aff8b15e8cfa0e07798c608b23e778aedb485a17c92d7aeb0c73
+  metadata.gz: da601220eca1ea05bb829a61a65bf6928262be27c73647de756f44b07329752efe6818be1a79b95bb51ad2e00025d08ff5fbb5410acfdc670d43f6816c6614f1
+  data.tar.gz: c0fad32bef922020708c194065d0de90fccc9d33d00354b4c8a4f3208e18b4720030e01810e798107894e6f503e8145fef11fd12afa1ba1f0b5b017f3b58eeda

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/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/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

data/test/middleware/base_test.rb

@@ -103,17 +103,20 @@ describe Committee::Middleware::Base do
 
   describe 'initialize option' do
     it "schema_path option with hyper-schema" do
-      b = Committee::Middleware::Base.new(nil, schema_path: hyper_schema_schema_path)
+      # TODO: delete when 5.0.0 released because default value changed
+      b = Committee::Middleware::Base.new(nil, schema_path: hyper_schema_schema_path, parse_response_by_content_type: false)
       assert_kind_of Committee::Drivers::HyperSchema::Schema, b.instance_variable_get(:@schema)
     end
 
     it "schema_path option with OpenAPI2" do
-      b = Committee::Middleware::Base.new(nil, schema_path: open_api_2_schema_path)
+      # TODO: delete when 5.0.0 released because default value changed
+      b = Committee::Middleware::Base.new(nil, schema_path: open_api_2_schema_path, parse_response_by_content_type: false)
       assert_kind_of Committee::Drivers::OpenAPI2::Schema, b.instance_variable_get(:@schema)
     end
 
     it "schema_path option with OpenAPI3" do
-      b = Committee::Middleware::Base.new(nil, schema_path: open_api_3_schema_path)
+      # TODO: delete when 5.0.0 released because default value changed
+      b = Committee::Middleware::Base.new(nil, schema_path: open_api_3_schema_path, parse_response_by_content_type: false)
       assert_kind_of Committee::Drivers::OpenAPI3::Schema, b.instance_variable_get(:@schema)
     end
   end
@@ -121,6 +124,9 @@ describe Committee::Middleware::Base do
   private
 
   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/middleware/request_validation_open_api_3_test.rb

@@ -466,6 +466,9 @@ describe Committee::Middleware::RequestValidation do
   end
 
   def new_rack_app_with_lambda(check_lambda, 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 check_lambda

data/test/middleware/request_validation_test.rb

@@ -519,6 +519,9 @@ describe Committee::Middleware::RequestValidation do
 
 
   def new_rack_app_with_lambda(check_lambda, 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 check_lambda

data/test/middleware/response_validation_open_api_3_test.rb

@@ -34,6 +34,14 @@ describe Committee::Middleware::ResponseValidation do
     assert_equal 200, last_response.status
   end
 
+  it "passes through a invalid json with parse_response_by_content_type option" do
+    @app = new_response_rack("csv response", { "Content-Type" => "test/csv"}, schema: open_api_3_schema, parse_response_by_content_type: true)
+
+    get "/csv"
+
+    assert_equal 200, last_response.status
+  end
+
   it "passes through not definition" do
     @app = new_response_rack(JSON.generate(CHARACTERS_RESPONSE), {}, schema: open_api_3_schema)
     get "/no_data"
@@ -210,6 +218,9 @@ describe Committee::Middleware::ResponseValidation do
   private
 
   def new_response_rack(response, headers = {}, options = {}, rack_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
+
     status = rack_options[:status] || 200
     headers = {
       "Content-Type" => "application/json"

data/test/middleware/response_validation_test.rb

@@ -184,6 +184,9 @@ describe Committee::Middleware::ResponseValidation do
   private
 
   def new_rack_app(response, headers = {}, 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
+
     headers = {
       "Content-Type" => "application/json"
     }.merge(headers)

data/test/middleware/stub_test.rb

@@ -112,6 +112,10 @@ describe Committee::Middleware::Stub do
   def new_rack_app(options = {})
     response = options.delete(:response)
     suppress = options.delete(:suppress)
+
+    # 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::Stub, options
       run lambda { |env|

data/test/request_unpacker_test.rb

@@ -100,7 +100,10 @@ describe Committee::RequestUnpacker do
       }
       request = Rack::Request.new(env)
 
-      router = hyper_schema.build_router({})
+      options = {}
+      # TODO: delete when 5.0.0 released because default value changed
+      options[:parse_response_by_content_type] = false
+      router = hyper_schema.build_router(options)
       validator = router.build_schema_validator(request)
 
       schema = JsonSchema::Schema.new
@@ -133,7 +136,10 @@ describe Committee::RequestUnpacker do
       }
       request = Rack::Request.new(env)
 
-      router = open_api_3_schema.build_router({})
+      options = {}
+      # TODO: delete when 5.0.0 released because default value changed
+      options[:parse_response_by_content_type] = false
+      router = open_api_3_schema.build_router(options)
       validator = router.build_schema_validator(request)
 
       params, _ = Committee::RequestUnpacker.new(
@@ -158,7 +164,10 @@ describe Committee::RequestUnpacker do
       }
       request = Rack::Request.new(env)
 
-      router = open_api_3_schema.build_router({})
+      options = {}
+      # TODO: delete when 5.0.0 released because default value changed
+      options[:parse_response_by_content_type] = false
+      router = open_api_3_schema.build_router(options)
       validator = router.build_schema_validator(request)
 
       params, _ = Committee::RequestUnpacker.new(

data/test/schema_validator/hyper_schema/router_test.rb

@@ -69,6 +69,8 @@ describe Committee::SchemaValidator::HyperSchema::Router do
   end
 
   def hyper_schema_router(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
     schema = Committee::Drivers::HyperSchema::Driver.new.parse(hyper_schema_data)
     validator_option = Committee::SchemaValidator::Option.new(options, schema, :hyper_schema)
 
@@ -76,6 +78,8 @@ describe Committee::SchemaValidator::HyperSchema::Router do
   end
 
   def open_api_2_router(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
     schema = Committee::Drivers::OpenAPI2::Driver.new.parse(open_api_2_data)
     validator_option = Committee::SchemaValidator::Option.new(options, schema, :hyper_schema)
 

data/test/schema_validator/open_api_3/operation_wrapper_test.rb

@@ -9,7 +9,12 @@ describe Committee::SchemaValidator::OpenAPI3::OperationWrapper do
     before do
       @path = '/validate'
       @method = 'post'
-      @validator_option = Committee::SchemaValidator::Option.new({}, open_api_3_schema, :open_api_3)
+
+      # TODO: delete when 5.0.0 released because default value changed
+      options = {}
+      options[:parse_response_by_content_type] = true if options[:parse_response_by_content_type] == nil
+
+      @validator_option = Committee::SchemaValidator::Option.new(options, open_api_3_schema, :open_api_3)
     end
 
     def operation_object

data/test/schema_validator/open_api_3/request_validator_test.rb

@@ -72,6 +72,9 @@ describe Committee::SchemaValidator::OpenAPI3::RequestValidator do
     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/schema_validator/open_api_3/response_validator_test.rb

@@ -12,7 +12,12 @@ describe Committee::SchemaValidator::OpenAPI3::ResponseValidator do
 
     @path = '/validate'
     @method = 'post'
-    @validator_option = Committee::SchemaValidator::Option.new({}, open_api_3_schema, :open_api_3)
+
+    # TODO: delete when 5.0.0 released because default value changed
+    options = {}
+    options[:parse_response_by_content_type] = true if options[:parse_response_by_content_type] == nil
+    
+    @validator_option = Committee::SchemaValidator::Option.new(options, open_api_3_schema, :open_api_3)
   end
 
   it "passes through a valid response" do
@@ -29,7 +34,7 @@ describe Committee::SchemaValidator::OpenAPI3::ResponseValidator do
     call_response_validator
   end
 
-  it "passes through a valid response with no registered Content-Type with strict = true" do
+  it "raises InvalidResponse when a valid response with no registered body with strict option" do
     @headers = { "Content-Type" => "application/xml" }
     assert_raises(Committee::InvalidResponse) {
       call_response_validator(true)
@@ -41,7 +46,7 @@ describe Committee::SchemaValidator::OpenAPI3::ResponseValidator do
     call_response_validator
   end
 
-  it "passes through a valid response with no Content-Type with strict option" do
+  it "raises InvalidResponse when a valid response with no Content-Type headers with strict option" do
     @headers = {}
     assert_raises(Committee::InvalidResponse) {
       call_response_validator(true)

data/test/test/methods_new_version_test.rb

@@ -30,6 +30,9 @@ describe Committee::Test::Methods do
     @committee_schema = nil
 
     @committee_options = {schema: hyper_schema}
+
+    # TODO: delete when 5.0.0 released because default value changed
+    @committee_options[:parse_response_by_content_type] = false
   end
 
   describe "#assert_schema_conform" do

data/test/test/methods_test.rb

@@ -28,7 +28,10 @@ describe Committee::Test::Methods do
     # our purposes here in testing the module.
     @committee_router = nil
     @committee_schema = nil
-    @committee_options = nil
+    @committee_options = {}
+
+    # TODO: delete when 5.0.0 released because default value changed
+    @committee_options[:parse_response_by_content_type] = true
   end
 
   describe "Hyper-Schema" do
@@ -36,7 +39,7 @@ describe Committee::Test::Methods do
       sc = JsonSchema.parse!(hyper_schema_data)
       sc.expand_references!
       s = Committee::Drivers::HyperSchema::Driver.new.parse(sc)
-      @committee_options = {schema: s}
+      @committee_options.merge!({schema: s})
     end
 
     describe "#assert_schema_conform" do
@@ -120,7 +123,7 @@ describe Committee::Test::Methods do
 
   describe "OpenAPI3" do
     before do
-      @committee_options = {schema: open_api_3_schema}
+      @committee_options.merge!({schema: open_api_3_schema})
 
       @correct_response = { string_1: :honoka }
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: committee
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Brandur
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-14 00:00:00.000000000 Z
+date: 2020-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_schema