committee 1.4.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5df4889fdc12ca417905836122278186b8b37537
-  data.tar.gz: a5767dff6a739d8d0a358db520e782c715e9dcf4
+  metadata.gz: eccf6a4dfc52e5076e090765d4a2ef1eb3ad444b
+  data.tar.gz: 0f8708a47a6ddb941ab7a0a652518b1f91b5c1c8
 SHA512:
-  metadata.gz: 75c86fa439582888348d8d0aff22751bbdda562a3a26bbdd3d38520f1a49d8aa048d73597916aea4c69f2a02cd20194cd300172a295aa473703331d0b417bd51
-  data.tar.gz: d510c1e51446ff10df678ea1cf95aef77896e31f3d28d6c24c722fcb6a1267644049638b905faec17d5035a4b42f73193d42c78c4d53e86874361d577d0ddacb
+  metadata.gz: dda95c75d4c988448851b8d4021c7401310309b89bbb03ee7b3191f0d96d2762e89ba7a95b586985817301ab141fa855c1bb25eb423eaead9ac584765d8c7bb0
+  data.tar.gz: c8eb5c8fd08fa815ebb2f174cf395b1b5a3b93f5cb41a21648ea600a1397157ed939498663de7fda1e68ae640d49e4680bbd3161ea13787f8def0cbbccf5b0e2

data/lib/committee/middleware/request_validation.rb

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

data/lib/committee/request_unpacker.rb

@@ -1,28 +1,24 @@
 module Committee
   class RequestUnpacker
-    def initialize(request)
+    def initialize(request, options={})
       @request = request
+
+      @allow_form_params = options[:allow_form_params]
+      @optimistic_json   = options[:optimistic_json]
     end
 
     def call
-      if !@request.content_type || @request.content_type =~ %r{application/json}
-        # if Content-Type is empty or JSON, and there was a request body, try
-        # to interpret it as JSON
-        if (body = @request.body.read).length != 0
-          @request.body.rewind
-          hash = MultiJson.decode(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)
-        # if request body is empty, we just have empty params
-        else
-          {}
-        end
-      elsif @request.content_type == "application/x-www-form-urlencoded"
+      # if Content-Type is empty or JSON, and there was a request body, try to
+      # interpret it as JSON
+      params = if !@request.content_type || @request.content_type =~ %r{application/json}
+        parse_json
+      elsif @optimistic_json
+        parse_json rescue MultiJson::LoadError nil
+      end
+
+      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
         # PUT or PATCH too. Silly Rack.
         indifferent_params(@request.POST)
@@ -55,5 +51,22 @@ module Committee
         object
       end
     end
+
+    def parse_json
+      if (body = @request.body.read).length != 0
+        @request.body.rewind
+        hash = MultiJson.decode(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)
+      # if request body is empty, we just have empty params
+      else
+        nil
+      end
+    end
   end
 end

data/test/request_unpacker_test.rb

@@ -22,6 +22,26 @@ describe Committee::RequestUnpacker do
     assert_equal({ "x" => "y" }, params)
   end
 
+  it "doesn't unpack JSON under other Content-Types" do
+    env = {
+      "CONTENT_TYPE" => "application/x-www-form-urlencoded",
+      "rack.input"   => StringIO.new('{"x":"y"}'),
+    }
+    request = Rack::Request.new(env)
+    params = Committee::RequestUnpacker.new(request).call
+    assert_equal({}, params)
+  end
+
+  it "unpacks JSON under other Content-Types with optimistic_json" do
+    env = {
+      "CONTENT_TYPE" => "application/x-www-form-urlencoded",
+      "rack.input"   => StringIO.new('{"x":"y"}'),
+    }
+    request = Rack::Request.new(env)
+    params = Committee::RequestUnpacker.new(request, optimistic_json: true).call
+    assert_equal({ "x" => "y" }, params)
+  end
+
   it "unpacks an empty hash on an empty request body" do
     env = {
       "CONTENT_TYPE" => "application/json",
@@ -32,13 +52,23 @@ describe Committee::RequestUnpacker do
     assert_equal({}, params)
   end
 
-  it "unpacks params on Content-Type: application/x-www-form-urlencoded" do
+  it "doesn't unpack form params" do
     env = {
       "CONTENT_TYPE" => "application/x-www-form-urlencoded",
       "rack.input"   => StringIO.new("x=y"),
     }
     request = Rack::Request.new(env)
     params = Committee::RequestUnpacker.new(request).call
+    assert_equal({}, params)
+  end
+
+  it "unpacks form params with allow_form_params" do
+    env = {
+      "CONTENT_TYPE" => "application/x-www-form-urlencoded",
+      "rack.input"   => StringIO.new("x=y"),
+    }
+    request = Rack::Request.new(env)
+    params = Committee::RequestUnpacker.new(request, allow_form_params: true).call
     assert_equal({ "x" => "y" }, params)
   end
 

metadata

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