jersey 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8917e3fd5a219b1f47d717b67c220309e0099e53
-  data.tar.gz: 877d58392cf2c2ed29f0c716be9ae96e013624d0
+  metadata.gz: 7a603102ad901084bf1d4c48b44d4cd7327af468
+  data.tar.gz: 4cb8799276e6a144c644fcc7158c114bf1a0eabc
 SHA512:
-  metadata.gz: d79189492a2066fc625ad5b89c6fd68874d7c820d65a5def6f506b5de8a9f404cb5e8c1d2cb39db9d83db1c42dfae57668100f2f1883951e150d9c6b3105cc6c
-  data.tar.gz: b3321888bd62a38ea83d8552be66df3fc28ec1a64179340cfa1eced4f5ad0da42d9af13b7a0a53ba2dfcd9cd1acc9972a1c1add634471404b95de5f2dc8b48ac
+  metadata.gz: e74e901b329082e4571ad3624164c57fc620648fa2663e64b74d11bde87200bcfd9ee56df6efcf1238dd0fa1d6be3ce3ecb06f155a27ff44ec0ae27514b63085
+  data.tar.gz: 440010607190f4152d45eb196fcfec8f2ca81841c8a3e299ed4eacf688a8370447647c8e0b0a969a0e545d0c0bf358d08ee809ebff11d49aa807c71e25a5063b

data/README.md

@@ -149,6 +149,51 @@ class API < Sinatra::Base
 end
 ```
 
+#### `Jersey::Middleware::AutoJson`
+
+Uses content type matching regex `/json/` or a request body that
+begins with a `{` to detect and parse json.  Exposes json
+via `request.body` and `params` so you can transparently
+accept form-encoded and json bodies.
+
+Adds a `#json` method to the `Rack::Request` object.
+
+#### Usage
+Use as a Rack middleware
+
+```ruby
+class API < Sinatra::Base
+  use Jersey::Middleware::AutoJson
+
+  post '/test-json' do
+    request.json == env['rack.json']
+  end
+end
+```
+
+#### `Jersey::Helpers::AutoJsonParams`
+Merges sinatra params Hash with json data parsed by a rack middleware
+that has set `rack.json` on the rack env.
+
+If the parsed data is an array, merges by using the array index as a hash key.
+
+Json data gets precendence in naming collisions.
+
+#### Usage
+Use as a Sinatra Helper
+
+Note: works with any Rack middleware that populates `env['rack.json']`
+
+```ruby
+class API < Sinatra::Base
+  helpers Jersey::Helpers::AutoJsonParams
+
+  post "/test-array-params" do
+    params[0]
+  end
+end
+```
+
 #### `Jersey::Middleware::RequestID`
 
 Creates a random request id for every http request, stored both in thread local storage

data/lib/jersey/api.rb

@@ -21,6 +21,8 @@ require 'jersey/http_errors'
 require 'jersey/middleware/request_id'
 require 'jersey/middleware/error_handler'
 require 'jersey/middleware/request_logger'
+require 'jersey/middleware/auto_json'
 require 'jersey/extensions/route_signature'
+require 'jersey/helpers/auto_json_params'
 require 'jersey/helpers/log'
 require 'jersey/helpers/success'

data/lib/jersey/base.rb

@@ -20,10 +20,12 @@ module Jersey::API
     use Jersey::Middleware::RequestID
     use Jersey::Middleware::RequestLogger
     use Jersey::Middleware::ErrorHandler
+    use Jersey::Middleware::AutoJson
 
     helpers Sinatra::JSON
     helpers Jersey::Helpers::Log
     helpers Jersey::Helpers::Success
+    helpers Jersey::Helpers::AutoJsonParams
 
     set :dump_errors, false
     set :raise_errors, true

data/lib/jersey/helpers/auto_json_params.rb

@@ -0,0 +1,29 @@
+module Jersey::Helpers
+  module AutoJsonParams
+    # Merges sinatra @params Hash with
+    # json data parsed by a rack middleware
+    # that has set `rack.json` on the rack env.
+    #
+    # If the parsed data is an array, merges by
+    # using the array index as a hash key.
+    #
+    # Json data gets precendence in naming collisions
+    def params
+      # we have parsed json!
+      if @env['rack.json']
+        json = @env['rack.json']
+        if json.is_a?(Hash)
+          # merge with params
+          super.merge(json)
+        else
+          # covert array to hash by index
+          zipped = json.each_with_index
+          zipped = zipped.to_a.map(&:reverse)
+          super.merge(Hash[zipped])
+        end
+      else
+        super
+      end
+    end
+  end
+end

data/lib/jersey/middleware/auto_json.rb

@@ -0,0 +1,50 @@
+# Detects json by customizable regex and
+# by looking for request bodies that being with
+# '{' or '['
+#
+# Sets `rack.json` on rack env, but leaves
+# other vars alone.
+module Jersey::Middleware
+  class AutoJson
+    JSON_PARSER = lambda { |data| JSON.parse(data) }
+    JSON_REGEX = /json/
+
+    # Configure the :porser and the :json_regex though
+    # if you're going to be strict about this you
+    # probably shouldn't be using this middleware
+    def initialize(app, options = {})
+      @app = app
+      @parser = options.delete(:parser) || JSON_PARSER
+      @json_regex = options.delete(:json_regex) || JSON_REGEX
+    end
+
+    # Make json happen.
+    def call(env)
+      req = Rack::Request.new(env)
+      type = req.media_type
+      if type && type.match(@json_regex)
+        # raise error if parsing declared json
+        begin
+          env['rack.json'] = @parser.call(req.body.read)
+        rescue => ex
+          raise BadRequest, "json parse error in AutoJson: #{ex.message}"
+        end
+      elsif ["{","["].include?(req.body.read(1))
+        # make best effort to parse what looks like json
+        req.body.rewind
+        env['rack.json'] = @parser.call(req.body.read) rescue nil
+      end
+      req.body.rewind
+      @app.call(env)
+    end
+  end
+end
+
+## Let's enable folks to use request.json
+## in their rack apps
+require 'rack/request'
+class Rack::Request
+  def json
+    env['rack.json']
+  end
+end

data/lib/jersey/version.rb

@@ -1,3 +1,3 @@
 module Jersey
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/test/auto_json_test.rb

@@ -0,0 +1,79 @@
+require_relative 'helper'
+
+class AutoJsonTest < ApiTest
+  class App < Jersey::API::Base
+    post '/test-params' do
+      "#{params['one']}:#{params['two']}"
+    end
+
+    post '/test-json' do
+      "#{request.json['one']}:#{request.json['two']}"
+    end
+
+    post "/test-array" do
+      request.json.join(":")
+    end
+
+    post "/test-array-params" do
+      params[0]
+    end
+
+    post "/test-auto-parse-fail" do
+      request.body.read
+    end
+  end
+
+  def test_form_encoded
+    post('/test-params', one: "bar")
+    assert_equal(200, last_response.status)
+    assert_equal("bar:", last_response.body)
+  end
+
+  def test_json
+    post('/test-params', {one: "bar"}.to_json)
+    assert_equal(200, last_response.status)
+    assert_equal("bar:", last_response.body)
+  end
+
+  def test_precedence
+    post('/test-params?one=foo', one: "bar")
+    assert_equal(200, last_response.status)
+    assert_equal("bar:", last_response.body)
+  end
+
+  def test_body_with_json
+    post('/test-params?two=foo', {one: "bar"}.to_json)
+    assert_equal(200, last_response.status)
+    assert_equal("bar:foo", last_response.body)
+  end
+
+  def test_query_string
+    post('/test-params?one=bar')
+    assert_equal(200, last_response.status)
+    assert_equal("bar:", last_response.body)
+  end
+
+  def test_an_array
+    post('/test-array', ['foo', 'bar'].to_json)
+    assert_equal(200, last_response.status)
+    assert_equal("foo:bar", last_response.body)
+  end
+
+  def test_an_array_from_params
+    post('/test-array-params', ['foo', 'bar'].to_json)
+    assert_equal(200, last_response.status)
+    assert_equal("foo", last_response.body)
+  end
+
+  def test_passes_through_auto_parse_fails
+    post('/test-auto-parse-fail', "{ HAHA")
+    assert_equal(200, last_response.status)
+    assert_equal("{ HAHA", last_response.body)
+  end
+
+  def test_query_string_and_body
+    post('/test-params?one=bar', {two: "foo"}.to_json)
+    assert_equal(200, last_response.status)
+    assert_equal("bar:foo", last_response.body)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jersey
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - csquared
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-14 00:00:00.000000000 Z
+date: 2015-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -114,6 +114,7 @@ files:
 - lib/jersey/base.rb
 - lib/jersey/extensions/error_handler.rb
 - lib/jersey/extensions/route_signature.rb
+- lib/jersey/helpers/auto_json_params.rb
 - lib/jersey/helpers/log.rb
 - lib/jersey/helpers/success.rb
 - lib/jersey/http_errors.rb
@@ -122,12 +123,14 @@ files:
 - lib/jersey/logging/json_logger.rb
 - lib/jersey/logging/logfmt_logger.rb
 - lib/jersey/logging/mixins.rb
+- lib/jersey/middleware/auto_json.rb
 - lib/jersey/middleware/error_handler.rb
 - lib/jersey/middleware/request_id.rb
 - lib/jersey/middleware/request_logger.rb
 - lib/jersey/setup.rb
 - lib/jersey/time.rb
 - lib/jersey/version.rb
+- test/auto_json_test.rb
 - test/errors_test.rb
 - test/helper.rb
 - test/log_test.rb
@@ -154,11 +157,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Write APIs in the New Jersey Style
 test_files:
+- test/auto_json_test.rb
 - test/errors_test.rb
 - test/helper.rb
 - test/log_test.rb