committee 1.14.1 → 1.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6b93ed460e34afc046f016a0b28c53c221bb4eb5
-  data.tar.gz: 0670a4037229f06312799901ade0e94bf416a95e
+  metadata.gz: d5fcb82a192f894e1baec1dcab89f081782d222f
+  data.tar.gz: 54d056b8be5b297b6a524166363f955db7a1bd15
 SHA512:
-  metadata.gz: c64af87f69eeeb24ba0b6dd0e9baa873c436d67e452dfde3c432e318d3cf583ec536dd1faed3c136ce1e4d0a2b90aac17083b861492ce0ed518d24ea2ede4f36
-  data.tar.gz: 9fcc322cc7e10fa8299fc0025dada82a5222c3546988737ed344f06d9e809ccf1c6a010a193d1e49378ba3c2767b0e340652793bcd8f22edf0d7c2590795a96e
+  metadata.gz: f22924efd2696d884eb499978cdb2a9f6e81ead9d25dacbe3ea331b9fb4d771886a4ccea1926fe2d09256886433a451fdbe25ef47cbe8d4c80a07a4157e0b9bc
+  data.tar.gz: db8d1aa50e4f4fa854bda1d5484df09e7262801bd845195c1340a718fc6d0792666360698ea2fe8722f1c57a287fcfb4b1f0258706032f47a2ef7cceaffd7df9

data/lib/committee.rb

@@ -3,6 +3,7 @@ require "json_schema"
 require "rack"
 
 require_relative "committee/errors"
+require_relative "committee/query_params_coercer"
 require_relative "committee/request_unpacker"
 require_relative "committee/request_validator"
 require_relative "committee/response_generator"

data/lib/committee/middleware/request_validation.rb

@@ -2,17 +2,29 @@ module Committee::Middleware
   class RequestValidation < Base
     def initialize(app, options={})
       super
-      @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)
-      @optimistic_json    = options.fetch(:optimistic_json, false)
-      @strict             = options[:strict]
+      @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)
+      @optimistic_json     = options.fetch(:optimistic_json, false)
+      @coerce_query_params = options.fetch(:coerce_query_params, false)
+      @strict              = options[:strict]
 
       # deprecated
       @allow_extra = options[:allow_extra]
     end
 
     def handle(request)
+      link = @router.find_request_link(request)
+
+      if link && @coerce_query_params && !request.GET.nil? && !link.schema.nil?
+        request.env["rack.request.query_hash"].merge!(
+          Committee::QueryParamsCoercer.new(
+            request.GET,
+            link.schema
+          ).call
+        )
+      end
+
       request.env[@params_key] = Committee::RequestUnpacker.new(
         request,
         allow_form_params:  @allow_form_params,
@@ -20,7 +32,7 @@ module Committee::Middleware
         optimistic_json:    @optimistic_json
       ).call
 
-      if link = @router.find_request_link(request)
+      if link
         validator = Committee::RequestValidator.new(link, check_content_type: @check_content_type)
         validator.call(request, request.env[@params_key])
         @app.call(request.env)

data/lib/committee/query_params_coercer.rb

@@ -0,0 +1,45 @@
+# Attempts to coerce params given in the query hash (which are all strings) into
+# the types specified by the schema.
+# Currently supported types: null, integer, number and boolean.
+# +call+ returns a hash of all params which could be coerced - coercion errors
+# are simply ignored and expected to be handled later by schema validation.
+module Committee
+  class QueryParamsCoercer
+    def initialize(query_hash, schema)
+      @query_hash = query_hash
+      @schema = schema
+    end
+
+    def call
+      coerced = {}
+      @schema.properties.each do |k, s|
+        original_val = @query_hash[k]
+        unless original_val.nil?
+          s.type.each do |to_type|
+            case to_type
+            when "null"
+              coerced[k] = nil if original_val.empty?
+            when "integer"
+              begin
+                coerced[k] = Integer(original_val)
+              rescue ArgumentError => e
+                raise e unless e.message =~ /invalid value for Integer/
+              end
+            when "number"
+              begin
+                coerced[k] = Float(original_val)
+              rescue ArgumentError => e
+                raise e unless e.message =~ /invalid value for Float/
+              end
+            when "boolean"
+              coerced[k] = true if original_val == "true"
+              coerced[k] = false if original_val == "false"
+            end
+            break if coerced.key?(k)
+          end
+        end
+      end
+      coerced
+    end
+  end
+end

data/test/middleware/request_validation_test.rb

@@ -94,6 +94,21 @@ describe Committee::Middleware::RequestValidation do
     assert_equal 200, last_response.status
   end
 
+  it "optionally coerces query params" do
+    @app = new_rack_app(coerce_query_params: true)
+    header "Content-Type", "application/json"
+    get "/search/apps", {"per_page" => "10", "query" => "cloudnasium"}
+    assert_equal 200, last_response.status
+  end
+
+  it "still raises an error if query param coercion is not possible" do
+    @app = new_rack_app(coerce_query_params: true)
+    header "Content-Type", "application/json"
+    get "/search/apps", {"per_page" => "foo", "query" => "cloudnasium"}
+    assert_equal 400, last_response.status
+    assert_match /invalid request/i, last_response.body
+  end
+
   private
 
   def new_rack_app(options = {})

data/test/query_params_coercer_test.rb

@@ -0,0 +1,70 @@
+require_relative "test_helper"
+
+describe Committee::QueryParamsCoercer do
+  before do
+    @schema =
+      JsonSchema.parse!(JSON.parse(File.read("./test/data/schema.json")))
+    @schema.expand_references!
+    # GET /search/apps
+    @link = @link = @schema.properties["app"].links[5]
+  end
+
+  it "doesn't coerce params not in the schema" do
+    data = {"owner" => "admin"}
+    assert_equal({}, call(data))
+  end
+
+  it "skips values for string param" do
+    data = {"name" => "foo"}
+    assert_equal({}, call(data))
+  end
+
+  it "coerces valid values for boolean param" do
+    data = {"deleted" => "true"}
+    assert_equal({"deleted" => true}, call(data))
+    data = {"deleted" => "false"}
+    assert_equal({"deleted" => false}, call(data))
+  end
+
+  it "skips invalid values for boolean param" do
+    data = {"deleted" => "foo"}
+    assert_equal({}, call(data))
+  end
+
+  it "coerces valid values for integer param" do
+    data = {"per_page" => "3"}
+    assert_equal({"per_page" => 3}, call(data))
+  end
+
+  it "skips invalid values for integer param" do
+    data = {"per_page" => "3.5"}
+    assert_equal({}, call(data))
+    data = {"per_page" => "false"}
+    assert_equal({}, call(data))
+    data = {"per_page" => ""}
+    assert_equal({}, call(data))
+  end
+
+  it "coerces valid values for number param" do
+    data = {"threshold" => "3"}
+    assert_equal({"threshold" => 3.0}, call(data))
+    data = {"threshold" => "3.5"}
+    assert_equal({"threshold" => 3.5}, call(data))
+  end
+
+  it "skips invalid values for number param" do
+    data = {"threshold" => "false"}
+    assert_equal({}, call(data))
+  end
+
+  it "coerces valid values for null param" do
+    data = {"threshold" => ""}
+    assert_equal({"threshold" => nil}, call(data))
+  end
+
+  private
+
+  def call(data)
+    Committee::QueryParamsCoercer.new(data, @link.schema).call
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: committee
 version: !ruby/object:Gem::Version
-  version: 1.14.1
+  version: 1.15.0
 platform: ruby
 authors:
 - Brandur
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-26 00:00:00.000000000 Z
+date: 2016-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_schema
@@ -117,6 +117,7 @@ files:
 - lib/committee/middleware/request_validation.rb
 - lib/committee/middleware/response_validation.rb
 - lib/committee/middleware/stub.rb
+- lib/committee/query_params_coercer.rb
 - lib/committee/request_unpacker.rb
 - lib/committee/request_validator.rb
 - lib/committee/response_generator.rb
@@ -128,6 +129,7 @@ files:
 - test/middleware/request_validation_test.rb
 - test/middleware/response_validation_test.rb
 - test/middleware/stub_test.rb
+- test/query_params_coercer_test.rb
 - test/request_unpacker_test.rb
 - test/request_validator_test.rb
 - test/response_generator_test.rb