committee 1.5.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eccf6a4dfc52e5076e090765d4a2ef1eb3ad444b
-  data.tar.gz: 0f8708a47a6ddb941ab7a0a652518b1f91b5c1c8
+  metadata.gz: b5866c6d0e099206a30958c836ad4b49473f68cd
+  data.tar.gz: d05049dcb5e2970c4451ce7e163790fb8199e95e
 SHA512:
-  metadata.gz: dda95c75d4c988448851b8d4021c7401310309b89bbb03ee7b3191f0d96d2762e89ba7a95b586985817301ab141fa855c1bb25eb423eaead9ac584765d8c7bb0
-  data.tar.gz: c8eb5c8fd08fa815ebb2f174cf395b1b5a3b93f5cb41a21648ea600a1397157ed939498663de7fda1e68ae640d49e4680bbd3161ea13787f8def0cbbccf5b0e2
+  metadata.gz: 0c4c4c60032ef9e6b7874e9078f6be8a6d3aee3d32949591abf7b4569057cbd4498c55b1d8d4a10ccd9d0970e7c422dc26933b171bb4efb5a72a9635b90a0247
+  data.tar.gz: 20acabc46e24f3eb85dc8b3dcce37794988a0dd559a534c46b2be17bb8861051f1927914df7f6b28bb4271b813a7228f69c03d9051baa0ae724e307d8dce697a

data/lib/committee/middleware/request_validation.rb

@@ -2,10 +2,11 @@ module Committee::Middleware
   class RequestValidation < Base
     def initialize(app, options={})
       super
-      @allow_form_params = options.fetch(:allow_form_params, true)
-      @optimistic_json   = options.fetch(:optimistic_json, false)
-      @raise             = options[:raise]
-      @strict            = options[:strict]
+      @allow_form_params  = options.fetch(:allow_form_params, true)
+      @allow_query_params = options.fetch(:allow_query_params, true)
+      @optimistic_json    = options.fetch(:optimistic_json, false)
+      @raise              = options[:raise]
+      @strict             = options[:strict]
 
       # deprecated
       @allow_extra = options[:allow_extra]
@@ -14,8 +15,9 @@ module Committee::Middleware
     def handle(request)
       request.env[@params_key] = Committee::RequestUnpacker.new(
         request,
-        allow_form_params: @allow_form_params,
-        optimistic_json:   @optimistic_json
+        allow_form_params:  @allow_form_params,
+        allow_query_params: @allow_query_params,
+        optimistic_json:    @optimistic_json
       ).call
 
       if link = @router.find_request_link(request)

data/lib/committee/middleware/response_validation.rb

@@ -15,7 +15,7 @@ module Committee::Middleware
           full_body << chunk
         end
         data = MultiJson.decode(full_body)
-        Committee::ResponseValidator.new(link).call(headers, data)
+        Committee::ResponseValidator.new(link).call(status, headers, data)
       end
 
       [status, headers, response]

data/lib/committee/request_unpacker.rb

@@ -3,8 +3,9 @@ module Committee
     def initialize(request, options={})
       @request = request
 
-      @allow_form_params = options[:allow_form_params]
-      @optimistic_json   = options[:optimistic_json]
+      @allow_form_params  = options[:allow_form_params]
+      @allow_query_params = options[:allow_query_params]
+      @optimistic_json    = options[:optimistic_json]
     end
 
     def call
@@ -16,7 +17,7 @@ module Committee
         parse_json rescue MultiJson::LoadError nil
       end
 
-      if params
+      params = if params
         params
       elsif @allow_form_params && @request.content_type == "application/x-www-form-urlencoded"
         # Actually, POST means anything in the request body, could be from
@@ -25,6 +26,12 @@ module Committee
       else
         {}
       end
+
+      if @allow_query_params
+        indifferent_params(@request.GET).merge(params)
+      else
+        params
+      end
     end
 
     private

data/lib/committee/response_validator.rb

@@ -9,8 +9,10 @@ module Committee
       @validator = JsonSchema::Validator.new(schema)
     end
 
-    def call(headers, data)
-      check_content_type!(headers)
+    def call(status, headers, data)
+      unless status == 204 # 204 No Content
+        check_content_type!(headers)
+      end
 
       if @link.rel == "instances" && !@link.target_schema
         if !data.is_a?(Array)

data/lib/committee/test/methods.rb

@@ -19,7 +19,7 @@ module Committee::Test
       end
 
       data = MultiJson.decode(last_response.body)
-      Committee::ResponseValidator.new(link).call(last_response.headers, data)
+      Committee::ResponseValidator.new(link).call(last_response.status, last_response.headers, data)
     end
 
     def assert_schema_content_type

data/test/request_unpacker_test.rb

@@ -72,6 +72,27 @@ describe Committee::RequestUnpacker do
     assert_equal({ "x" => "y" }, params)
   end
 
+  it "unpacks form & query params with allow_form_params and allow_query_params" do
+    env = {
+      "CONTENT_TYPE" => "application/x-www-form-urlencoded",
+      "rack.input"   => StringIO.new("x=y"),
+      "QUERY_STRING" => "a=b"
+    }
+    request = Rack::Request.new(env)
+    params = Committee::RequestUnpacker.new(request, allow_form_params: true, allow_query_params: true).call
+    assert_equal({ "x" => "y", "a" => "b" }, params)
+  end
+
+  it "unpacks query params with allow_query_params" do
+    env = {
+      "rack.input"   => StringIO.new(""),
+      "QUERY_STRING" => "a=b"
+    }
+    request = Rack::Request.new(env)
+    params = Committee::RequestUnpacker.new(request, allow_query_params: true).call
+    assert_equal({ "a" => "b" }, params)
+  end
+
   it "errors if JSON is not an object" do
     env = {
       "CONTENT_TYPE" => "application/json",

data/test/request_validator_test.rb

@@ -37,6 +37,18 @@ describe Committee::RequestValidator do
     assert_equal message, e.message
   end
 
+  it "detects an missing parameter in GET requests" do
+    # GET /apps/search?query=...
+    @link = @link = @schema.properties["app"].links[5]
+    @request = Rack::Request.new({})
+    e = assert_raises(Committee::InvalidRequest) do
+      call({})
+    end
+    message =
+      %{Invalid request.\n\n#: failed schema #/definitions/app/links/5/schema: "query" wasn't supplied.}
+    assert_equal message, e.message
+  end
+
   it "allows an invalid Content-Type with an empty body" do
     @request =
       Rack::Request.new({
@@ -53,7 +65,7 @@ describe Committee::RequestValidator do
     e = assert_raises(Committee::InvalidRequest) do
       call(data)
     end
-    message = %{Invalid request.\n\n#/name: failed schema #/definitions/app/links/0/schema/properties/name: Expected string to match pattern "/^[a-z][a-z0-9-]{3,30}$/", value was: %@!.}
+    message = %{Invalid request.\n\n#/name: failed schema #/definitions/app/links/0/schema/properties/name: %@! does not match /^[a-z][a-z0-9-]{3,30}$/.}
     assert_equal message, e.message
   end
 

data/test/response_validator_test.rb

@@ -2,10 +2,11 @@ require_relative "test_helper"
 
 describe Committee::ResponseValidator do
   before do
-    @data = ValidApp.dup
+    @status = 200
     @headers = {
       "Content-Type" => "application/json"
     }
+    @data = ValidApp.dup
     @schema =
       JsonSchema.parse!(MultiJson.decode(File.read("./test/data/schema.json")))
     @schema.expand_references!
@@ -42,6 +43,11 @@ describe Committee::ResponseValidator do
     assert_equal message, e.message
   end
 
+  it "allows no Content-Type for 204 No Content" do
+    @status, @headers = 204, {}
+    call
+  end
+
   it "allows application/schema+json in responses as well" do
     @headers = { "Content-Type" => "application/schema+json" }
     call
@@ -50,13 +56,13 @@ describe Committee::ResponseValidator do
   it "raises errors generated by json_schema" do
     @data.merge!("name" => "%@!")
     e = assert_raises(Committee::InvalidResponse) { call }
-    message = %{Invalid response.\n\n#/name: failed schema #/definitions/app/properties/name: Expected string to match pattern "/^[a-z][a-z0-9-]{3,30}$/", value was: %@!.}
+    message = %{Invalid response.\n\n#/name: failed schema #/definitions/app/properties/name: %@! does not match /^[a-z][a-z0-9-]{3,30}$/.}
     assert_equal message, e.message
   end
 
   private
 
   def call
-    Committee::ResponseValidator.new(@link).call(@headers, @data)
+    Committee::ResponseValidator.new(@link).call(@status, @headers, @data)
   end
 end

metadata

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