committee 3.0.3 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be1585b55c1dafdac14680670df3b8a25797c934dc7bbc8f37da20d1d36115dc
-  data.tar.gz: 4e1e8ccf4c4c5fc2a59d9b34cf5b7080b971536c2319ad153293d5b2794f1b70
+  metadata.gz: 0261ef5b9991afdc79316a4aa67e05293b5cc0dc83a8b7dc80a330fcc2d633b9
+  data.tar.gz: a67badbaa49fa492e9bd562293666734a9c733a9d5fa8c54b6a7cf6b3a414305
 SHA512:
-  metadata.gz: 5316997b460f9e3caf062932702c80108d669f9ba9aa125acb87f356c4208a57856e074aea64f6e219978f0ecaac9cebc2043f0c0cc99fd5a4b2636086001360
-  data.tar.gz: 99335b314f5f6083b1078446f0984d53b96f27726246db430b28e8ba06104be97de8a67aef6e51b32c36db08ab6e1bbf3616f89bec554b08519a6ec5337b8ddc
+  metadata.gz: 8de3637d5059cb2dee41b9d78aa6b448d3c60fc246485bca06cbceb1e2f993c8b86f9d76a9388359c1f05b05e429eaf5949d6e6dfd587246ac4ab8c59f0f37bd
+  data.tar.gz: 510f84e62e9f52239845130b14a6f9432bc2c391c92ab5334b74b301c9119378a491add7f7cfb33fd711a522b727da325a045be31e04ac94fd8c0ead858042a6

data/lib/committee/middleware/base.rb

@@ -4,6 +4,7 @@ module Committee::Middleware
       @app = app
 
       @error_class = options.fetch(:error_class, Committee::ValidationError)
+      @error_handler = options[:error_handler]
 
       @raise = options[:raise]
       @schema = self.class.get_schema(options)

data/lib/committee/middleware/request_validation.rb

@@ -17,6 +17,7 @@ module Committee::Middleware
 
       @app.call(request.env)
     rescue Committee::BadRequest, Committee::InvalidRequest
+      @error_handler.call($!) if @error_handler
       raise if @raise
       @error_class.new(400, :bad_request, $!.message).render
     rescue Committee::NotFound => e
@@ -27,6 +28,7 @@ module Committee::Middleware
         e.message
       ).render
     rescue JSON::ParserError
+      @error_handler.call($!) if @error_handler
       raise Committee::InvalidRequest if @raise
       @error_class.new(400, :bad_request, "Request body wasn't valid JSON.").render
     end

data/lib/committee/middleware/response_validation.rb

@@ -5,8 +5,6 @@ module Committee::Middleware
     def initialize(app, options = {})
       super
       @validate_success_only = @schema.validator_option.validate_success_only
-
-      @error_handler = options[:error_handler]
     end
 
     def handle(request)

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

@@ -18,7 +18,7 @@ module Committee
       return {} unless options.coerce_value
 
       request_operation.validate_path_params(options)
-    rescue OpenAPIParser::NotExistRequiredKey => e
+    rescue OpenAPIParser::OpenAPIError => e
       raise Committee::InvalidRequest.new(e.message)
     end
 

data/lib/committee/test/methods.rb

@@ -1,18 +1,27 @@
 module Committee::Test
   module Methods
     def assert_schema_conform
-      @schema ||= Committee::Middleware::Base.get_schema(committee_options)
-      @router ||= @schema.build_router(committee_options)
+      assert_request_schema_confirm unless old_behavior
+      assert_response_schema_confirm
+    end
+
+    def assert_request_schema_confirm
+      unless schema_validator.link_exist?
+        request = "`#{request_object.request_method} #{request_object.path_info}` undefined in schema."
+        raise Committee::InvalidRequest.new(request)
+      end
 
-      v = @router.build_schema_validator(request_object)
+      schema_validator.request_validate(request_object)
+    end
 
-      unless v.link_exist?
+    def assert_response_schema_confirm
+      unless schema_validator.link_exist?
         response = "`#{request_object.request_method} #{request_object.path_info}` undefined in schema."
         raise Committee::InvalidResponse.new(response)
       end
 
       status, headers, body = response_data
-      v.response_validate(status, headers, [body], true) if validate_response?(status)
+      schema_validator.response_validate(status, headers, [body], true) if validate_response?(status)
     end
 
     def committee_options
@@ -30,5 +39,31 @@ module Committee::Test
     def validate_response?(status)
       Committee::Middleware::ResponseValidation.validate?(status, committee_options.fetch(:validate_success_only, false))
     end
+
+    def schema
+      @schema ||= Committee::Middleware::Base.get_schema(committee_options)
+    end
+
+    def router
+      @router ||= schema.build_router(committee_options)
+    end
+
+    def schema_validator
+      @schema_validator ||= router.build_schema_validator(request_object)
+    end
+
+    def old_behavior
+      old_assert_behavior = committee_options.fetch(:old_assert_behavior, nil)
+      if old_assert_behavior.nil?
+        warn <<-MSG
+        [DEPRECATION] now assert_schema_confirm check response schema only.
+          but we will change check request and response in future major version.
+          so if you want to conform response only, please use assert_response_schema_confirm,
+          or you can suppress this message and keep old behavior by setting old_assert_behavior=true.
+        MSG
+        old_assert_behavior = true
+      end
+      old_assert_behavior
+    end
   end
 end

data/test/middleware/request_validation_open_api_3_test.rb

@@ -322,6 +322,17 @@ describe Committee::Middleware::RequestValidation do
     assert_match(/required parameters query_string not exist in/i, e.message)
   end
 
+  it "raises error when required path parameter is invalid" do
+    @app = new_rack_app(raise: true, schema: open_api_3_schema)
+
+    e = assert_raises(Committee::InvalidRequest) do
+      not_an_integer = 'abc'
+      get "/coerce_path_params/#{not_an_integer}", nil
+    end
+
+    assert_match(/is String but it's not valid integer in/i, e.message)
+  end
+
   it "optionally raises an error" do
     @app = new_rack_app(raise: true, schema: open_api_3_schema)
     header "Content-Type", "application/json"

data/test/middleware/request_validation_test.rb

@@ -61,6 +61,18 @@ describe Committee::Middleware::RequestValidation do
     assert_equal 200, last_response.status
   end
 
+  it "doesn't call error_handler when request is valid" do
+    called_error = false
+    pr = ->(_) { called_error = true }
+    @app = new_rack_app(schema: hyper_schema, error_handler: pr)
+    params = {
+      "name" => "cloudnasium"
+    }
+    header "Content-Type", "application/json"
+    post "/apps", JSON.generate(params)
+    assert !called_error
+  end
+
   it "passes given a datetime and with coerce_date_times enabled on GET endpoint" do
     key_name = "update_time"
     params = {
@@ -270,6 +282,18 @@ describe Committee::Middleware::RequestValidation do
     assert_match(/invalid request/i, last_response.body)
   end
 
+  it "calls error_handler when request is invalid" do
+    called_err = nil
+    pr = ->(e) { called_err = e }
+    @app = new_rack_app(schema: hyper_schema, error_handler: pr)
+    header "Content-Type", "application/json"
+    params = {
+      "name" => 1
+    }
+    post "/apps", JSON.generate(params)
+    assert_kind_of Committee::InvalidRequest, called_err
+  end
+
   it "rescues JSON errors" do
     @app = new_rack_app(schema: hyper_schema)
     header "Content-Type", "application/json"
@@ -278,6 +302,15 @@ describe Committee::Middleware::RequestValidation do
     assert_match(/valid json/i, last_response.body)
   end
 
+  it "calls error_handler when it rescues JSON errors" do
+    called_err = nil
+    pr = ->(e) { called_err = e }
+    @app = new_rack_app(schema: hyper_schema, error_handler: pr)
+    header "Content-Type", "application/json"
+    post "/apps", "{x:y}"
+    assert_kind_of JSON::ParserError, called_err
+  end
+
   it "takes a prefix" do
     @app = new_rack_app(prefix: "/v1", schema: hyper_schema)
     params = {

data/test/schema_validator/hyper_schema/response_generator_test.rb

@@ -43,7 +43,7 @@ describe Committee::SchemaValidator::HyperSchema::ResponseGenerator do
     data, _schema = call
 
     # We're testing for legacy behavior here: even without a `targetSchema` as
-    # long as `rel` is set to `instances` we still wrap the the result in an
+    # long as `rel` is set to `instances` we still wrap the result in an
     # array.
     assert_equal "instances", @list_link.rel
 

data/test/schema_validator/hyper_schema/response_validator_test.rb

@@ -43,7 +43,7 @@ describe Committee::SchemaValidator::HyperSchema::ResponseValidator do
     @link.target_schema = nil
 
     # We're testing for legacy behavior here: even without a `targetSchema` as
-    # long as `rel` is set to `instances` we still wrap the the result in an
+    # long as `rel` is set to `instances` we still wrap the result in an
     # array.
     assert_equal "instances", @link.rel
 
@@ -59,7 +59,7 @@ describe Committee::SchemaValidator::HyperSchema::ResponseValidator do
     @link.target_schema = nil
 
     # We're testing for legacy behavior here: even without a `targetSchema` as
-    # long as `rel` is set to `instances` we still wrap the the result in an
+    # long as `rel` is set to `instances` we still wrap the result in an
     # array.
     assert_equal "instances", @link.rel
 

data/test/test/methods_test.rb

@@ -52,6 +52,67 @@ describe Committee::Test::Methods do
         end
         assert_match(/response header must be set to/i, e.message)
       end
+
+      it "outputs deprecation warning" do
+        @app = new_rack_app(JSON.generate([ValidApp]))
+        get "/apps"
+        _, err = capture_io do
+          assert_schema_conform
+        end
+        assert_match(/\[DEPRECATION\]/i, err)
+      end
+    end
+
+    describe "assert_request_schema_confirm" do
+      it "passes through a valid request" do
+        @app = new_rack_app([])
+        get "/apps"
+        assert_request_schema_confirm
+      end
+
+      it "not exist required" do
+        @app = new_rack_app([])
+        get "/search/apps", {}
+        e = assert_raises(Committee::InvalidRequest) do
+          assert_request_schema_confirm
+        end
+        assert_match(/"query" wasn't supplied\./i, e.message)
+      end
+
+      it "path undefined in schema" do
+        @app = new_rack_app([])
+        get "/undefined"
+        e = assert_raises(Committee::InvalidRequest) do
+          assert_request_schema_confirm
+        end
+        assert_match(/`GET \/undefined` undefined in schema/i, e.message)
+      end
+    end
+
+    describe "#assert_response_schema_confirm" do
+      it "passes through a valid response" do
+        @app = new_rack_app(JSON.generate([ValidApp]))
+        get "/apps"
+        assert_response_schema_confirm
+      end
+
+      it "detects an invalid response Content-Type" do
+        @app = new_rack_app(JSON.generate([ValidApp]), {})
+        get "/apps"
+        e = assert_raises(Committee::InvalidResponse) do
+          assert_response_schema_confirm
+        end
+        assert_match(/response header must be set to/i, e.message)
+      end
+
+      it "path undefined in schema" do
+        @app = new_rack_app(JSON.generate([ValidApp]))
+        get "/undefined"
+        e = assert_raises(Committee::InvalidResponse) do
+          assert_response_schema_confirm
+        end
+        assert_match(/`GET \/undefined` undefined in schema/i, e.message)
+      end
     end
   end
 
@@ -88,6 +149,78 @@ describe Committee::Test::Methods do
         end
         assert_match(/don't exist status code definition/i, e.message)
       end
+
+      it "outputs deprecation warning" do
+        @app = new_rack_app(JSON.generate(@correct_response))
+        get "/characters"
+        _, err = capture_io do
+          assert_schema_conform
+        end
+        assert_match(/\[DEPRECATION\]/i, err)
+      end
+    end
+
+    describe "assert_request_schema_confirm" do
+      it "passes through a valid request" do
+        @app = new_rack_app([])
+        get "/characters"
+        assert_request_schema_confirm
+      end
+
+      it "not exist required" do
+        @app = new_rack_app([])
+        get "/validate", {"query_string" => "query", "query_integer_list" => [1, 2]}
+        e = assert_raises(Committee::InvalidRequest) do
+          assert_request_schema_confirm
+        end
+        assert_match(/required parameters query_string not exist in #\/paths/i, e.message)
+      end
+
+      it "path undefined in schema" do
+        @app = new_rack_app([])
+        get "/undefined"
+        e = assert_raises(Committee::InvalidRequest) do
+          assert_request_schema_confirm
+        end
+        assert_match(/`GET \/undefined` undefined in schema/i, e.message)
+      end
+    end
+
+    describe "#assert_response_schema_confirm" do
+      it "passes through a valid response" do
+        @app = new_rack_app(JSON.generate(@correct_response))
+        get "/characters"
+        assert_response_schema_confirm
+      end
+
+      it "detects an invalid response Content-Type" do
+        @app = new_rack_app(JSON.generate([@correct_response]), {})
+        get "/characters"
+        e = assert_raises(Committee::InvalidResponse) do
+          assert_response_schema_confirm
+        end
+        assert_match(/don't exist response definition/i, e.message)
+      end
+
+      it "detects an invalid response status code" do
+        @app = new_rack_app(JSON.generate([@correct_response]), {}, 419)
+
+        get "/characters"
+
+        e = assert_raises(Committee::InvalidResponse) do
+          assert_response_schema_confirm
+        end
+        assert_match(/don't exist status code definition/i, e.message)
+      end
+
+      it "path undefined in schema" do
+        @app = new_rack_app(JSON.generate(@correct_response))
+        get "/undefined"
+        e = assert_raises(Committee::InvalidResponse) do
+          assert_response_schema_confirm
+        end
+        assert_match(/`GET \/undefined` undefined in schema/i, e.message)
+      end
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: committee
 version: !ruby/object:Gem::Version
-  version: 3.0.3
+  version: 3.1.0
 platform: ruby
 authors:
 - Brandur
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-17 00:00:00.000000000 Z
+date: 2019-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_schema