committee 3.2.1 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2af076998ef23743c239df64c5517e3e334422a3523f09e6f8baa4f1a9f1ef77
-  data.tar.gz: a5ae6eca5d34310a69e1c33ca6f11a807e19316c8fad9123521ecf835cfe091c
+  metadata.gz: 0c35304cf9026ae20062ea312cdca6b43af486c4c2e5e7c952b35bbad811ce4e
+  data.tar.gz: d9a96cd2c6c15b9de26fb95ef0b4d59216c999f8589329d6ee6b21b41e2511d9
 SHA512:
-  metadata.gz: 65e65734251a25cb3a3735081c8a3e2e6973b93d1e14b66261d3978e7dac3ea5a9081fe7a530625cf9407d3ac25bc8941d6bea064d07f546186b6a2ebd043fa6
-  data.tar.gz: 7dee370a2748aa7b67d1e360e86aacb204d16a5a68d18ac879ececc3633d6d92f5ad9b49ba36ac8851e1a04f2322fec2269b8926f30f061d1524bf284af90848
+  metadata.gz: 42ffc889dcc301c9de500417390454f4723bf049f0336b9de92b94fcaa2d67f53a7f5c4c9ad5a3a56bd2e9fff70d06ebe7c7279729c616b45ab33625c2a33572
+  data.tar.gz: d3c7ca273497b2eb4444fcdb6eb43f49fed866335d1a627f806586f6755557b8a956b43eb5c9448b7cf19176b9e2a4705c78bf6045dde2e98b19fd55211e0070

data/lib/committee/middleware/base.rb

@@ -8,17 +8,19 @@ module Committee
 
         @error_class = options.fetch(:error_class, Committee::ValidationError)
         @error_handler = options[:error_handler]
+        @ignore_error = options.fetch(:ignore_error, false)
 
         @raise = options[:raise]
         @schema = self.class.get_schema(options)
 
         @router = @schema.build_router(options)
+        @accept_request_filter = options[:accept_request_filter] || -> (_) { true }
       end
 
       def call(env)
         request = Rack::Request.new(env)
 
-        if @router.includes_request?(request)
+        if @router.includes_request?(request) && @accept_request_filter.call(request)
           handle(request)
         else
           @app.call(request.env)

data/lib/committee/middleware/request_validation.rb

@@ -13,27 +13,25 @@ module Committee
       end
 
       def handle(request)
-        schema_validator = build_schema_validator(request)
-        schema_validator.request_validate(request)
-
-        raise Committee::NotFound, "That request method and path combination isn't defined." if !schema_validator.link_exist? && @strict
+        begin
+          schema_validator = build_schema_validator(request)
+          schema_validator.request_validate(request)
+
+          raise Committee::NotFound, "That request method and path combination isn't defined." if !schema_validator.link_exist? && @strict
+        rescue Committee::BadRequest, Committee::InvalidRequest
+          handle_exception($!, request.env)
+          raise if @raise
+          return @error_class.new(400, :bad_request, $!.message).render unless @ignore_error
+        rescue Committee::NotFound => e
+          raise if @raise
+          return @error_class.new(404, :not_found, e.message).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
+        end
 
         @app.call(request.env)
-      rescue Committee::BadRequest, Committee::InvalidRequest
-        handle_exception($!, request.env)
-        raise if @raise
-        @error_class.new(400, :bad_request, $!.message).render
-      rescue Committee::NotFound => e
-        raise if @raise
-        @error_class.new(
-          404,
-          :not_found,
-          e.message
-        ).render
-      rescue JSON::ParserError
-        handle_exception($!, request.env)
-        raise Committee::InvalidRequest if @raise
-        @error_class.new(400, :bad_request, "Request body wasn't valid JSON.").render
       end
 
       private

data/lib/committee/middleware/response_validation.rb

@@ -8,7 +8,6 @@ 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)

data/test/middleware/request_validation_open_api_3_test.rb

@@ -379,6 +379,13 @@ describe Committee::Middleware::RequestValidation do
     assert_match(/expected integer, but received String: foo/i, last_response.body)
   end
 
+  it "ignores errors when ignore_error: true" do
+    @app = new_rack_app(schema: open_api_3_schema, ignore_error: true)
+    get "/characters?limit=foo"
+
+    assert_equal 200, last_response.status
+  end
+
   it "coerce string to integer" do
     check_parameter_string = lambda { |env|
       assert env['committee.params']['integer'].is_a?(Integer)
@@ -429,6 +436,22 @@ describe Committee::Middleware::RequestValidation do
     end
   end
 
+  describe ':accept_request_filter' do
+    [
+      { description: 'when not specified, includes everything', accept_request_filter: nil, expected: { status: 400 } },
+      { description: 'when predicate matches, performs validation', accept_request_filter: -> (request) { request.path.start_with?('/v1/c') }, expected: { status: 400 } },
+      { description: 'when predicate does not match, skips validation', accept_request_filter: -> (request) { request.path.start_with?('/v1/x') }, expected: { status: 200 } },
+    ].each do |description:, accept_request_filter:, expected:|
+      it description do
+        @app = new_rack_app(prefix: '/v1', schema: open_api_3_schema, accept_request_filter: accept_request_filter)
+
+        post 'v1/characters', JSON.generate(string_post_1: 1)
+
+        assert_equal expected[:status], last_response.status
+      end
+    end
+  end
+
   private
 
   def new_rack_app(options = {})

data/test/middleware/request_validation_test.rb

@@ -296,6 +296,16 @@ describe Committee::Middleware::RequestValidation do
     assert_match(/invalid request/i, last_response.body)
   end
 
+  it "ignores errors when ignore_error: true" do
+    @app = new_rack_app(schema: hyper_schema, ignore_error: true)
+    header "Content-Type", "application/json"
+    params = {
+      "name" => 1
+    }
+    post "/apps", JSON.generate(params)
+    assert_equal 200, last_response.status
+  end
+
   it "calls error_handler (has a arg) when request is invalid" do
     called_err = nil
     pr = ->(e) { called_err = e }
@@ -480,6 +490,22 @@ describe Committee::Middleware::RequestValidation do
     assert_equal 200, last_response.status
   end
 
+  describe ':accept_request_filter' do
+    [
+      { description: 'when not specified, includes everything', accept_request_filter: nil, expected: { status: 400 } },
+      { description: 'when predicate matches, performs validation', accept_request_filter: -> (request) { request.path.start_with?('/v1/a') }, expected: { status: 400 } },
+      { description: 'when predicate does not match, skips validation', accept_request_filter: -> (request) { request.path.start_with?('/v1/x') }, expected: { status: 200 } },
+    ].each do |description:, accept_request_filter:, expected:|
+      it description do
+        @app = new_rack_app(prefix: '/v1', schema: hyper_schema, accept_request_filter: accept_request_filter)
+
+        post '/v1/apps', '{x:y}'
+
+        assert_equal expected[:status], last_response.status
+      end
+    end
+  end
+
   private
 
   def new_rack_app(options = {})

data/test/middleware/response_validation_open_api_3_test.rb

@@ -100,29 +100,41 @@ describe Committee::Middleware::ResponseValidation do
   end
 
   describe 'check header' do
-    it 'valid type header' do
-      @app = new_response_rack({}.to_json, {'x-limit' => 1}, schema: open_api_3_schema, raise: true)
-
-      get "/header"
-
-      assert_equal 200, last_response.status
-    end
-
-    it 'invalid type header' do
-      @app = new_response_rack({}.to_json, {'x-limit' => '1'}, schema: open_api_3_schema, raise: true)
-
-      assert_raises(Committee::InvalidResponse) do
-        get "/header"
+    [
+      { check_header: true, description: 'valid value', header: { 'integer' => 1 }, expected: { status: 200 } },
+      { check_header: true, description: 'missing value', header: { 'integer' => nil }, expected: { error: 'headers/integer/schema does not allow null values' } },
+      { check_header: true, description: 'invalid value', header: { 'integer' => 'x' }, expected: { error: 'headers/integer/schema expected integer, but received String: x' } },
+
+      { check_header: false, description: 'valid value', header: { 'integer' => 1 }, expected: { status: 200 } },
+      { check_header: false, description: 'missing value', header: { 'integer' => nil }, expected: { status: 200 } },
+      { check_header: false, description: 'invalid value', header: { 'integer' => 'x' }, expected: { status: 200 } },
+    ].each do |check_header:, description:, header:, expected:|
+      describe "when #{check_header}" do
+        %w(get post put patch delete).each do |method|
+          describe method do
+            describe description do
+              if expected[:error].nil?
+                it 'should pass' do
+                  @app = new_response_rack({}.to_json, header, schema: open_api_3_schema, raise: true, check_header: check_header)
+
+                  send(method, "/header")
+                  assert_equal expected[:status], last_response.status
+                end
+              else
+                it 'should fail' do
+                  @app = new_response_rack({}.to_json, header, schema: open_api_3_schema, raise: true, check_header: check_header)
+
+                  error = assert_raises(Committee::InvalidResponse) do
+                    get "/header"
+                  end
+                  assert_match(expected[:error], error.message)
+                end
+              end
+            end
+          end
+        end
       end
     end
-
-    it 'invalid type but not check' do
-      @app = new_response_rack({}.to_json, {'x-limit' => '1'}, schema: open_api_3_schema, raise: true, check_header: false)
-
-      get "/header"
-
-      assert_equal 200, last_response.status
-    end
   end
 
   describe 'validate error option' do
@@ -157,6 +169,22 @@ describe Committee::Middleware::ResponseValidation do
     end
   end
 
+  describe ':accept_request_filter' do
+    [
+      { description: 'when not specified, includes everything', accept_request_filter: nil, expected: { status: 500 } },
+      { description: 'when predicate matches, performs validation', accept_request_filter: -> (request) { request.path.start_with?('/v1/c') }, expected: { status: 500 } },
+      { description: 'when predicate does not match, skips validation', accept_request_filter: -> (request) { request.path.start_with?('/v1/x') }, expected: { status: 200 } },
+    ].each do |description:, accept_request_filter:, expected:|
+      it description do
+        @app = new_response_rack('not_json', {}, schema: open_api_3_schema, prefix: '/v1', accept_request_filter: accept_request_filter)
+
+        get 'v1/characters'
+
+        assert_equal expected[:status], last_response.status
+      end
+    end
+  end
+
   private
 
   def new_response_rack(response, headers = {}, options = {}, rack_options = {})

data/test/middleware/response_validation_test.rb

@@ -162,6 +162,22 @@ describe Committee::Middleware::ResponseValidation do
     assert_match(/valid JSON/i, last_response.body)
   end
 
+  describe ':accept_request_filter' do
+    [
+      { description: 'when not specified, includes everything', accept_request_filter: nil, expected: { status: 500 } },
+      { description: 'when predicate matches, performs validation', accept_request_filter: -> (request) { request.path.start_with?('/v1/a') }, expected: { status: 500 } },
+      { description: 'when predicate does not match, skips validation', accept_request_filter: -> (request) { request.path.start_with?('/v1/x') }, expected: { status: 200 } },
+    ].each do |description:, accept_request_filter:, expected:|
+      it description do
+        @app = new_rack_app('not_json', {}, schema: hyper_schema, prefix: '/v1', accept_request_filter: accept_request_filter)
+
+        get '/v1/apps'
+
+        assert_equal expected[:status], last_response.status
+      end
+    end
+  end
+
   private
 
   def new_rack_app(response, headers = {}, options = {})

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: committee
 version: !ruby/object:Gem::Version
-  version: 3.2.1
+  version: 3.3.0
 platform: ruby
 authors:
 - Brandur
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-13 00:00:00.000000000 Z
+date: 2019-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_schema