rack-bodyparser 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 743caf986aba0bf3b1de5f82ebf7939f4163cc2f
+  data.tar.gz: 687565e7eaec8e87c5d5d17a728f3dfa800ba4c2
+SHA512:
+  metadata.gz: 214c1fc24ac38fab23bfd4c2fb54435403058eb93c62fa2bd5613bc2990e3447fb2149af7afd5bc0156baae0079163ade0d51ff622e56ea3b485abbabec15df1
+  data.tar.gz: 44c165eb469358d64021a4ee0b393925da606c5896463cb769e49158b5a6da1a844bf004b16637a74a527a79b43de6227c8333b3bd49c1cc3ae04d12dc53ab20

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2016 Aaron Heesakkers
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,134 @@
+# Rack::BodyParser #
+
+Rack middleware that provides a way to parse the request body without touching 
+`params` or `request.params`. 
+
+
+Instead the parser output is available through `env['parsed_body']` or 
+optionally through the Rack::Request object as `request.parsed_body` and/or 
+a custom attribute per parser.
+
+Rack::BodyParser is heavily inspired by 
+[Rack::Parser](https://github.com/achiu/rack-parser).
+
+## Key Features (differences to Rack::Parser) ##
+
+1. separation of `params`/`request.params` and the `parsed_body`.
+1. (optional) patching of `Rack::Request`:
+
+  Access parsed payload through `request.parsed_body` with support 
+  for custom `request.#{your_key_here}` per parser. 
+  Enable with `:patch_request => true`.
+
+Note: Rack::BodyParser **does** **not** contain any parsers by out of the box.
+
+## Installation ##
+
+Via rubygems:
+
+`gem install rack-bodyparser`
+
+## Usage ##
+
+Define your parsers per content_type. 
+
+Rack::BodyParser accepts `String` or `Regexp` keys as content_type, 
+and anything that `respond_to? 'call'` as parser.
+
+Sinatra example:
+
+```ruby
+# app.rb
+
+use Rack::BodyParser, :parsers => { 
+  'application/json' => proc { |data| JSON.parse data },
+  'application/xml'  => proc { |data| XML.parse data },
+  %r{msgpack}        => proc { |data| Msgpack.parse data }
+}
+
+post '/' do
+  puts env['parsed_body']
+end
+```
+
+### Error Handling ###
+
+Rack::BodyParser has one default error handler that can be overridden by 
+setting the 'default' handler. These works like `:parsers`. Use a `String` or 
+`Regexp` as content_type key and anything that `respond_to? 'call'` as the
+error handler. The error handler must accept the two parameters 
+`Error` and `type` (the content type).
+
+```ruby
+use Rack::Parser, :handlers => {
+  'default' => proc { |e, type| 
+    [400, {}, ['[Rack::BodyParser] Failed to parse %s: %s' % [type, e.to_s]]] 
+  }
+}
+```
+
+Rack::BodyParsers will try to `warn` of a `logger` is present.
+
+Note: the error handler rescues exceptions that are descents of `StandardError`. 
+See http://www.mikeperham.com/2012/03/03/the-perils-of-rescue-exception/
+
+## Patch Rack::Request ##
+
+Setting up Rack::BodyParser with `:patch_request => true` will add
+a `parsed_body` method to Rack::Request. Parsers can also provide a
+`:rack_request_key` to define a custom key per parser:
+
+```ruby
+
+# gem 'jsonapi_parser'
+require 'json/api' # JSONAPI document parser/validator
+module Rack::BodyParser::JSONAPI
+  module Parser
+    # This defines the getter key for Rack::Request
+    def self.rack_request_key; :document; end
+
+    def self.call(body)
+      JSON::API.parse(JSON.parse(body))
+    end
+  end
+
+  module Error
+    def self.call(e, type)
+      payload = {
+        errors: {
+          title: 'Failed to parse body as JSONAPI document',
+          detail: e.message
+        }
+      }.to_json
+      [422, {}, [payload]]
+    end
+  end
+end
+
+use Rack::BodyParser, :patch_request => true,
+  :parsers  => { 
+    'application/vnd.api+json' => Rack::BodyParser::JSONAPI::Parser
+  },
+  :handlers => {
+    'application/vnd.api+json' => Rack::BodyParser::JSONAPI::Error
+  }
+
+post '/' do
+  # These all output the same
+  puts env['parsed_body']
+  puts request.parsed_body
+  puts request.document
+end
+```
+
+## Inspirations ##
+
+This project is heavily inspired by [Rack::Parser](https://github.com/achiu/rack-parser). I built
+this because I did not want to mix `params` and the body payload.
+
+## Copyright
+
+`Copyright © 2016 Aaron Heesakkers.`
+
+See [MIT-LICENSE](https://github.com/aars/rack-bodyparser/blob/master/MIT-LICENSE) for details.
+

data/lib/rack/bodyparser.rb

@@ -0,0 +1,62 @@
+module Rack
+  class BodyParser
+    # Where to get input.
+    REQUEST_BODY     = 'rack.input'.freeze
+    # Where to store in env
+    RACK_ENV_KEY     = 'parsed_body'.freeze
+    # Where to store in Rack::Request in case of options[:patch_request]
+    RACK_REQUEST_KEY = 'parsed_body'.freeze
+
+    # Default error handler
+    ERROR_MESSAGE = "[Rack::BodyParser] Failed to parse %s: %s\n"
+    ERROR_HANDLER = proc { |e, type|
+      [400, {}, [ERROR_MESSAGE % [type, e.to_s]]]
+    }
+    attr_reader :parsers, :handlers, :logger
+
+    def initialize(app, options = {})
+      @app      = app
+      @parsers  = options.delete(:parsers)  || {}
+      @handlers = options.delete(:handlers) || {}
+      @handlers = {'default' => ERROR_HANDLER}.merge(@handlers)
+      @options  = options
+    end
+
+    def call(env)
+      type   = Rack::Request.new(env).media_type
+      parser = type && detect(parsers, type)
+      body   = parser && env[REQUEST_BODY].read; env[REQUEST_BODY].rewind
+      if body && !body.empty?
+        parser = parser.last
+        begin
+          parsed = parser.call body
+          env.update RACK_ENV_KEY => parsed
+          patch_rack_request parser, parsed if @options[:patch_request]
+        rescue StandardError => e
+          warn! e, type
+          handler = (detect(handlers, type) || detect(handlers, 'default')).last
+          return handler.call e, type
+        end
+      end
+      @app.call env
+    end
+
+    def patch_rack_request(parser, parsed)
+      if parser.respond_to?(:rack_request_key)
+        Rack::Request.send(:define_method, parser.rack_request_key) { parsed }
+      end
+      Rack::Request.send(:define_method, RACK_REQUEST_KEY) { parsed }
+    end
+
+    def detect(hash, what)
+      hash.detect { |match, _|
+        match.is_a?(Regexp) ? what.match(match) : what.eql?(match)
+      }
+    end
+
+    def warn!(e, type)
+      return unless logger
+      logger.warn ERROR_MESSAGE % [type, e.to_s]
+    end
+  end
+end

data/lib/rack/bodyparser/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class BodyParser
+    VERSION = "0.0.2"
+  end
+end

data/rack-bodyparser.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'rack/bodyparser/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'rack-bodyparser'
+  s.version     = Rack::BodyParser::VERSION
+  s.authors     = ['Aaron Heesakkers']
+  s.email       = ['aaronheesakkers@gmail.com']
+  s.license     = 'MIT'
+  s.homepage    = 'https://www.github.com/aars/rack-bodyparser'
+  s.summary     = 'Rack Middleware for parsing request body'
+  s.description = %(
+    Rack Middleware for parsing request body without touching request.params.
+    Allowing full separation of query_string params and body payload.
+  )
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_dependency 'rack'
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'rack-test'
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: rack-bodyparser
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Aaron Heesakkers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "\n    Rack Middleware for parsing request body without touching request.params.\n
+  \   Allowing full separation of query_string params and body payload.\n  "
+email:
+- aaronheesakkers@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- MIT-LICENSE
+- README.md
+- lib/rack/bodyparser.rb
+- lib/rack/bodyparser/version.rb
+- rack-bodyparser.gemspec
+homepage: https://www.github.com/aars/rack-bodyparser
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: Rack Middleware for parsing request body
+test_files: []