committee 3.1.1 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 169dfa8f079626447ca5086429c0bd025d8180f3ef5b7a7194d1333bdeff8fab
-  data.tar.gz: 2c8eeece5b411266f482808b7caf08d2de285f64e78e705990a4b7b9606902d3
+  metadata.gz: c978ba3ca98ab6a684b1555ebc3e3575ee5fb20ae11c17bc7b8c2baebd71eb86
+  data.tar.gz: 0424b819be1a1b0872894d8c0b897e325868347e54d19b443a351f1270d3b097
 SHA512:
-  metadata.gz: b891ea4d1498b2fc16f0d241520486736b0b707bf401e96bdab09795ff165c23d86344a2b29cfcf1dbca83d8a773b85a08e59dc09220c5acca2738e485c3994f
-  data.tar.gz: ca657dfb18edaf157cb01ca48b522882c165a8c06216c84deda9a88a7718fb61da4ea3a3b017e4ac8594e83f97f904d4f0f1ad1947ee9418b977ddf4884e8c52
+  metadata.gz: 306d7ebf406280f3ad9279543e010046a691bed7b6ba89c61b20663e256e6e7efacd7a4c2a0a2b021d405ab603519c887319ec3963204de09fb9405a66144032
+  data.tar.gz: d0043bd37f971a053843acc791bb9f9216ef8b2aa58946e5ab6a7d0ddcb9f4190deec402fc5424d4a2c14fe074f581576663f69252319d7c7085b9355ec48355

data/lib/committee/middleware/response_validation.rb

@@ -8,25 +8,29 @@ module Committee
       def initialize(app, options = {})
         super
         @validate_success_only = @schema.validator_option.validate_success_only
+        @ignore_error = options.fetch(:ignore_error, false)
       end
 
       def handle(request)
-        status, headers, response = @app.call(request.env)
+        begin
+          status, headers, response = @app.call(request.env)
 
-        v = build_schema_validator(request)
-        v.response_validate(status, headers, response) if v.link_exist? && self.class.validate?(status, validate_success_only)
+          v = build_schema_validator(request)
+          v.response_validate(status, headers, response) if v.link_exist? && self.class.validate?(status, validate_success_only)
 
-        [status, headers, response]
-      rescue Committee::InvalidResponse
-        handle_exception($!, request.env)
+        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 if @raise
-        @error_class.new(500, :invalid_response, $!.message).render
-      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
+        end
 
-        raise Committee::InvalidResponse if @raise
-        @error_class.new(500, :invalid_response, "Response wasn't valid JSON.").render
+        [status, headers, response]
       end
 
       class << self

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

@@ -64,6 +64,10 @@ module Committee
           end
         end
 
+        def request_content_types
+          request_operation.operation_object&.request_body&.content&.keys || []
+        end
+
         private
 
         attr_reader :request_operation

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

@@ -25,7 +25,17 @@ module Committee
           return true unless request.post? || request.put? || request.patch?
           return true if @operation_object.valid_request_content_type?(content_type)
 
-          raise Committee::InvalidRequest, %{"Content-Type" request header must be set to "#{@operation_object}".}
+          message = if valid_content_types.size > 1
+                      types = valid_content_types.map {|x| %{"#{x}"} }.join(', ')
+                      %{"Content-Type" request header must be set to any of the following: [#{types}].}
+                    else
+                      %{"Content-Type" request header must be set to "#{valid_content_types.first}".}
+                    end
+          raise Committee::InvalidRequest, message
+        end
+
+        def valid_content_types
+          @operation_object&.request_content_types
         end
       end
     end

data/test/middleware/response_validation_open_api_3_test.rb

@@ -26,6 +26,14 @@ describe Committee::Middleware::ResponseValidation do
     assert_equal "{\"id\":\"invalid_response\",\"message\":\"Response wasn't valid JSON.\"}", last_response.body
   end
 
+  it "passes through a invalid json with ignore_error option" do
+    @app = new_response_rack("not_json", {}, schema: open_api_3_schema, ignore_error: true)
+
+    get "/characters"
+
+    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"

data/test/middleware/response_validation_test.rb

@@ -38,6 +38,12 @@ describe Committee::Middleware::ResponseValidation do
     assert_match(/{} is not an array/i, last_response.body)
   end
 
+  it "detects a response invalid due to schema with ignore_error option" do
+    @app = new_rack_app("{}", {}, schema: hyper_schema, ignore_error: true)
+    get "/apps"
+    assert_equal 200, last_response.status
+  end
+
   it "detects a response invalid due to not being JSON" do
     @app = new_rack_app("{_}", {}, schema: hyper_schema)
     get "/apps"

data/test/schema_validator/open_api_3/operation_wrapper_test.rb

@@ -146,5 +146,21 @@ describe Committee::SchemaValidator::OpenAPI3::OperationWrapper do
         assert e.message.start_with?("a class is String but")
       end
     end
+
+    describe '#content_types' do
+      it 'returns supported content types' do
+        @path = '/validate_content_types'
+        @method = 'post'
+
+        assert_equal ["application/json", "application/binary"], operation_object.request_content_types
+      end
+
+      it 'returns an empty array when the content of requestBody does not exist' do
+        @path = '/characters'
+        @method = 'get'
+
+        assert_equal [], operation_object.request_content_types
+      end
+    end
   end
 end

data/test/schema_validator/open_api_3/request_validator_test.rb

@@ -10,7 +10,7 @@ describe Committee::SchemaValidator::OpenAPI3::RequestValidator do
       @app
     end
 
-    it "skip validaiton when link does not exist" do
+    it "skip validation when link does not exist" do
       @app = new_rack_app(schema: open_api_3_schema)
       params = {}
       header "Content-Type", "application/json"
@@ -21,11 +21,34 @@ describe Committee::SchemaValidator::OpenAPI3::RequestValidator do
     it "optionally content_type check" do
       @app = new_rack_app(check_content_type: true, schema: open_api_3_schema)
       params = {
-          "string_post_1" => "cloudnasium"
+        "string_post_1" => "cloudnasium"
       }
       header "Content-Type", "text/html"
       post "/characters", JSON.generate(params)
       assert_equal 400, last_response.status
+
+      body = JSON.parse(last_response.body)
+      message =
+          %{"Content-Type" request header must be set to "application/json".}
+
+      assert_equal "bad_request", body['id']
+      assert_equal message, body['message']
+    end
+
+    it "validates content_type" do
+      @app = new_rack_app(check_content_type: true, schema: open_api_3_schema)
+      params = {
+        "string_post_1" => "cloudnasium"
+      }
+      header "Content-Type", "text/html"
+      post "/validate_content_types", JSON.generate(params)
+      assert_equal 400, last_response.status
+
+      body = JSON.parse(last_response.body)
+      message =
+        %{"Content-Type" request header must be set to any of the following: ["application/json", "application/binary"].}
+
+      assert_equal message, body['message']
     end
 
     it "optionally skip content_type check" do
@@ -38,7 +61,7 @@ describe Committee::SchemaValidator::OpenAPI3::RequestValidator do
       assert_equal 200, last_response.status
     end
 
-    it "if not exist requsetBody definition, skip content_type check" do
+    it "if not exist requestBody definition, skip content_type check" do
       @app = new_rack_app(check_content_type: true, schema: open_api_3_schema)
       params = {
           "string_post_1" => "cloudnasium"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: committee
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.2.0
 platform: ruby
 authors:
 - Brandur
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-04 00:00:00.000000000 Z
+date: 2019-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_schema