committee 3.0.0.beta3 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4af30e34beff4126b7d69135a887fd8e984741f0700be148eaad1109b7b96511
-  data.tar.gz: 98075cfbcf0207f6d4278eaef4d6fb9d13681648748d768a35e637c45e96be5b
+  metadata.gz: a4f07f61485c78ec77763069cef3c82cbb3682768d5fa8b6d87383c78be3bf29
+  data.tar.gz: e6620a92bec74e0624f5c43591b552b5533551d66007ca24baa032e615d96551
 SHA512:
-  metadata.gz: 3f8c7471aaba3b7df58bb4c5e2f5b6311dfd91d2e6d8fd28848b715f4f2d59a418c275a76ecdbce34c1aa5222c1a2c18198ffcd815588f81f6d319ff09e1e1f5
-  data.tar.gz: dbc206cf90277dad16b2611fd489889c229d27616c0eecbdcf9ed59e494c588b1d0e3eba31e98e8da44417c13d15c6566fe28d9cb2e1df11cc552a0553c1dca5
+  metadata.gz: 82cf11b46ef546e5b47270829b9acded9d85c871b00eb914308c80044d1991fb89c8dac82ea3b0ab6cf8a92230d50ecc348c3f489d3306dce2876f727f7ff41a
+  data.tar.gz: d62d6a02b5885f25755fe88028fe8431111edcaa1d3dd2885dc7c1d5ed136676e89af8b5d7cc2a06c5846a058ec018f14460b1be934b65a49a9192e6c5eac8eb

data/lib/committee/drivers.rb

@@ -68,6 +68,11 @@ module Committee
         raise "needs implementation"
       end
 
+      # Use GET request body to request parameter (request body merge to parameter)
+      def default_allow_get_body
+        raise "needs implementation"
+      end
+
       # Whether parameters in a request's path will be considered and coerced
       # by default.
       def default_path_params

data/lib/committee/drivers/hyper_schema.rb

@@ -9,6 +9,10 @@ module Committee::Drivers
       false
     end
 
+    def default_allow_get_body
+      true
+    end
+
     # Whether parameters in a request's path will be considered and coerced by
     # default.
     def default_path_params

data/lib/committee/drivers/open_api_2.rb

@@ -9,6 +9,10 @@ module Committee::Drivers
       true
     end
 
+    def default_allow_get_body
+      true
+    end
+
     # Whether parameters in a request's path will be considered and coerced by
     # default.
     def default_path_params

data/lib/committee/drivers/open_api_3.rb

@@ -9,6 +9,10 @@ module Committee::Drivers
       true
     end
 
+    def default_allow_get_body
+      false
+    end
+
     # Whether parameters in a request's path will be considered and coerced by
     # default.
     def default_path_params

data/lib/committee/request_unpacker.rb

@@ -4,6 +4,7 @@ module Committee
       @request = request
 
       @allow_form_params  = options[:allow_form_params]
+      @allow_get_body     = options[:allow_get_body]
       @allow_query_params = options[:allow_query_params]
       @coerce_form_params = options[:coerce_form_params]
       @optimistic_json    = options[:optimistic_json]
@@ -70,20 +71,21 @@ module Committee
     end
 
     def parse_json
-      if (body = @request.body.read).length != 0
-        @request.body.rewind
-        hash = JSON.parse(body)
-        # We want a hash specifically. '42', 42, and [42] will all be
-        # decoded properly, but we can't use them here.
-        if !hash.is_a?(Hash)
-          raise BadRequest,
-            "Invalid JSON input. Require object with parameters as keys."
-        end
-        indifferent_params(hash)
+      return nil if @request.request_method == "GET" && !@allow_get_body
+
+      body = @request.body.read
       # if request body is empty, we just have empty params
-      else
-        nil
+      return nil if body.length == 0
+
+      @request.body.rewind
+      hash = JSON.parse(body)
+      # We want a hash specifically. '42', 42, and [42] will all be
+      # decoded properly, but we can't use them here.
+      if !hash.is_a?(Hash)
+        raise BadRequest,
+              "Invalid JSON input. Require object with parameters as keys."
       end
+      indifferent_params(hash)
     end
 
     def headers

data/lib/committee/schema_validator/hyper_schema.rb

@@ -66,6 +66,7 @@ class Committee::SchemaValidator
         request.env[validator_option.params_key], request.env[validator_option.headers_key] = Committee::RequestUnpacker.new(
             request,
             allow_form_params:  validator_option.allow_form_params,
+            allow_get_body:     validator_option.allow_get_body,
             allow_query_params: validator_option.allow_query_params,
             coerce_form_params: validator_option.coerce_form_params,
             optimistic_json:    validator_option.optimistic_json,

data/lib/committee/schema_validator/open_api_3.rb

@@ -65,6 +65,7 @@ class Committee::SchemaValidator
       request.env[validator_option.params_key], request.env[validator_option.headers_key] = Committee::RequestUnpacker.new(
           request,
           allow_form_params:  validator_option.allow_form_params,
+          allow_get_body:     validator_option.allow_get_body,
           allow_query_params: validator_option.allow_query_params,
           coerce_form_params: validator_option.coerce_form_params,
           optimistic_json:    validator_option.optimistic_json,

data/lib/committee/schema_validator/option.rb

@@ -1,28 +1,45 @@
 class Committee::SchemaValidator
   class Option
-    attr_reader :coerce_recursive, :params_key, :allow_form_params, :allow_query_params, :optimistic_json, :coerce_form_params, :headers_key, :coerce_query_params, :coerce_path_params, :check_content_type, :check_header, :coerce_date_times, :prefix, :validate_success_only
+    # Boolean Options
+    attr_reader :allow_form_params,
+                :allow_get_body,
+                :allow_query_params,
+                :check_content_type,
+                :check_header,
+                :coerce_date_times,
+                :coerce_form_params,
+                :coerce_path_params,
+                :coerce_query_params,
+                :coerce_recursive,
+                :optimistic_json,
+                :validate_success_only
+
+    # Non-boolean options:
+    attr_reader :headers_key,
+                :params_key,
+                :prefix
 
     def initialize(options, schema, schema_type)
+      # Non-boolean options
       @headers_key         = options[:headers_key] || "committee.headers"
       @params_key          = options[:params_key] || "committee.params"
-
       @prefix              = options[:prefix]
 
-      # response option
-      @validate_success_only = options.fetch(:validate_success_only, schema.driver.default_validate_success_only)
-
-      @coerce_recursive    = options.fetch(:coerce_recursive, true)
+      # Boolean options and have a common value by default
       @allow_form_params   = options.fetch(:allow_form_params, true)
       @allow_query_params  = options.fetch(:allow_query_params, true)
+      @check_content_type  = options.fetch(:check_content_type, true)
+      @check_header        = options.fetch(:check_header, true)
+      @coerce_recursive    = options.fetch(:coerce_recursive, true)
       @optimistic_json     = options.fetch(:optimistic_json, false)
 
-      @coerce_form_params  = options.fetch(:coerce_form_params, schema.driver.default_coerce_form_params)
+      # Boolean options and have a different value by default
+      @allow_get_body      = options.fetch(:allow_get_body, schema.driver.default_allow_get_body)
       @coerce_date_times   = options.fetch(:coerce_date_times, schema.driver.default_coerce_date_times)
-      @coerce_query_params = options.fetch(:coerce_query_params, schema.driver.default_query_params)
+      @coerce_form_params  = options.fetch(:coerce_form_params, schema.driver.default_coerce_form_params)
       @coerce_path_params  = options.fetch(:coerce_path_params, schema.driver.default_path_params)
-
-      @check_content_type  = options.fetch(:check_content_type, true)
-      @check_header        = options.fetch(:check_header, true)
+      @coerce_query_params = options.fetch(:coerce_query_params, schema.driver.default_query_params)
+      @validate_success_only = options.fetch(:validate_success_only, schema.driver.default_validate_success_only)
     end
   end
 end

data/test/drivers_test.rb

@@ -93,6 +93,7 @@ end
 
 describe Committee::Drivers::Driver do
   DRIVER_METHODS = {
+    :default_allow_get_body     => [],
     :default_coerce_form_params => [],
     :default_path_params        => [],
     :default_query_params       => [],

data/test/middleware/request_validation_open_api_3_test.rb

@@ -42,7 +42,25 @@ describe Committee::Middleware::RequestValidation do
     assert_equal 200, last_response.status
   end
 
-  it "passes given a datetime and with coerce_date_times enabled on GET endpoint with request body(old behavior)" do
+  it "passes given a valid parameter on GET endpoint with request body and allow_get_body=true" do
+    params = { "data" => "abc" }
+
+    @app = new_rack_app(schema: open_api_3_schema, allow_get_body: true)
+
+    get "/get_endpoint_with_requered_parameter", { no_problem: true }, { input: params.to_json }
+    assert_equal 200, last_response.status
+  end
+
+  it "errors given valid parameter on GET endpoint with request body and allow_get_body=false" do
+    params = { "data" => "abc" }
+
+    @app = new_rack_app(schema: open_api_3_schema, allow_get_body: false)
+
+    get "/get_endpoint_with_requered_parameter", { no_problem: true }, { input: params.to_json }
+    assert_equal 400, last_response.status
+  end
+
+  it "passes given a datetime and with coerce_date_times enabled on GET endpoint with request body" do
     params = { "datetime_string" => "2016-04-01T16:00:00.000+09:00" }
 
     check_parameter = lambda { |env|
@@ -50,9 +68,12 @@ describe Committee::Middleware::RequestValidation do
       [200, {}, []]
     }
 
-    @app = new_rack_app_with_lambda(check_parameter, schema: open_api_3_schema, coerce_date_times: true)
+    @app = new_rack_app_with_lambda(check_parameter,
+                                    schema: open_api_3_schema,
+                                    coerce_date_times: true,
+                                    allow_get_body: true)
 
-    get "/get_body_test", { no_problem: true }, { input: params.to_json }
+    get "/string_params_coercer", { no_problem: true }, { input: params.to_json }
     assert_equal 200, last_response.status
   end
 

data/test/request_unpacker_test.rb

@@ -234,4 +234,26 @@ describe Committee::RequestUnpacker do
     _, headers = Committee::RequestUnpacker.new(request, { allow_header_params: true }).call
     assert_equal({ "FOO-BAR" => "some header value" }, headers)
   end
+
+  it "includes request body when`use_get_body` is true" do
+    env = {
+        "rack.input" => StringIO.new('{"x":1, "y":2}'),
+        "REQUEST_METHOD" => "GET",
+        "QUERY_STRING"=>"data=value&x=aaa",
+    }
+    request = Rack::Request.new(env)
+    params, _ = Committee::RequestUnpacker.new(request, { allow_query_params: true, allow_get_body: true }).call
+    assert_equal({ 'data' => 'value', 'x' => 1, 'y' => 2 }, params)
+  end
+
+  it "doesn't include request body when `use_get_body` is false" do
+    env = {
+        "rack.input" => StringIO.new('{"x":1, "y":2}'),
+        "REQUEST_METHOD" => "GET",
+        "QUERY_STRING"=>"data=value&x=aaa",
+    }
+    request = Rack::Request.new(env)
+    params, _ = Committee::RequestUnpacker.new(request, { allow_query_params: true, use_get_body: false }).call
+    assert_equal({ 'data' => 'value', 'x' => 'aaa' }, params)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: committee
 version: !ruby/object:Gem::Version
-  version: 3.0.0.beta3
+  version: 3.0.0
 platform: ruby
 authors:
 - Brandur
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-25 00:00:00.000000000 Z
+date: 2019-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_schema
@@ -237,9 +237,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.0.1
 signing_key: