rack-parser 0.0.4 → 0.1.0

data/README.md

@@ -32,14 +32,12 @@ In a Sinatra or [Padrino](http://padrinorb.com) application, it would probably b
 ```ruby
 # app.rb
 
-use Rack::Parser, :content_types => {
-  'application/json' => Proc.new { |body| MultiJson.decode body     },
-  'application/xml'  => Proc.new { |body| MultiXml.decode body      },
-  'application/roll' => Proc.new { |body| 'never gonna give you up' }
-  }
+use Rack::Parser
 ```
 
 
+### Content Type Parsing ###
+
 By default, Rack::Parser uses MultiJson and MultiXml to decode/parse
 your JSON/XML Data. these can be overwritten if you choose not to use
 them. However, through using them you can just as easily leverage the
@@ -69,6 +67,29 @@ use Rack::Parser, :content_types => {
 }
 ```
 
+### Error Handling ###
+
+Rack::Parser comes with a default error handling response that is sent
+if an error is to occur. If a `logger` is present, it will try to `warn`
+with the content type and error message.
+
+You can additionally customize the error handling response as well to
+whatever it is you like:
+
+```ruby
+use Rack::Parser, :error_responses => {
+  'default'          => Proc.new { |e, content_type| [500, {}, ["boo hoo"] ] },
+  'application/json' => Proc.new { |e, content_type| [400, {'Content-Type'=>content_type}, ["broke"]] }
+  }
+```
+
+The error handler expects to pass both the `error` and `content_type` so
+that you can use them within your responses. In addition, you can
+override the default response as well.
+
+If no content_type error handling response is present, it will use the
+`default`.
+
 ## Inspirations ##
 
 This project came to being because of:
@@ -76,6 +97,11 @@ This project came to being because of:
 * [Niko Dittmann's](https://www.github.com/niko) [rack-post-body-to-params](https://www.github.com/niko/rack-post-body-to-params) which some of its ideas are instilled in this middleware.
 * Rack::PostBodyContentTypeParser from rack-contrib which proved to be an inspiration for both libraries.
 
+
+## Contributors ##
+
+* [Stephen Becker IV](https://github.com/sbeckeriv) - For initial custom error response handling work.
+
 ## Copyright
 
 Copyright © 2011 Arthur Chiu. See [MIT-LICENSE](https://github.com/achiu/rack-parser/blob/master/MIT-LICENSE) for details.

data/lib/rack/parser.rb

@@ -8,6 +8,8 @@ module Rack
   # designate any engine you wish that is compatible with the MultiJson/MultiXml libraries.
   # You can also conveniently use another library by as well by wrapping it as a Proc or add additional
   # content types which are not default in this middleware.
+  # In addition, you can set custom error handling for each content_type. If no error response is defined for
+  # a particular content_type, it will use the default error response, which can also be overrided.
   #
   class Parser
 
@@ -22,17 +24,37 @@ module Rack
       'application/json' => Proc.new { |body| MultiJson.decode(body) }
     }
 
-    attr_reader :content_types
+    DEFAULT_ERROR_RESPONSE = {
+      'default' =>
+      Proc.new do |e, content_type|
+        format = content_type.split('/').last
+        meth   = "to_#{format}"
+        meth   = "inspect" unless ::Hash.respond_to? meth
+        [400, {'Content-Type' => content_type }, [ { 'errors' => e.to_s }.method(meth).call ] ]
+      end
+    }
+
+    attr_reader :content_types, :error_responses
 
     # Usage:
-    # use Rack::Parser, :content_types = {
+    # use Rack::Parser, :content_types => {
     #   'application/xml'  => Proc.new { |body| XmlParser.parse body   } # if you don't want the default
     #   'application/json' => Proc.new { |body| JsonParser.decode body } # if you don't want the default
-    #   'application/foo'  => Proc.new { |body| FooParser.parse body   }
+    #   'application/foo'  => Proc.new { |body| FooParser.parse body   } # Add custom content_types to parse.
     # }
+    #
+    # # use Rack::Parser,
+    #   :content_types  => {
+    #     'application/xml'  => Proc.new { |body| XmlParser.parse body   } # if you don't want the default
+    #   },
+    #   :error_responses => {
+    #     'default'          => Proc.new { |e, content_type| [500, {}, ["boo hoo"] ] },                         # Override the default error response..
+    #     'application/json' => Proc.new { |e, content_type| [400, {'Content-Type'=>content_type}, ["broke"]] } # Customize error responses based on content type.
+    #   }
     def initialize(app, options = {})
-      @app           = app
-      @content_types = DEFAULT_CONTENT_TYPE.merge(options.delete(:content_types) || {})
+      @app             = app
+      @content_types   = DEFAULT_CONTENT_TYPE.merge(options.delete(:content_types) || {})
+      @error_responses = DEFAULT_ERROR_RESPONSE.merge(options.delete(:error_responses) || {})
     end
 
     def call(env)
@@ -43,16 +65,14 @@ module Rack
       body = env[POST_BODY].read
       return @app.call(env) if (body.respond_to?(:empty?) ? body.empty? : !body) # Send it down the stack immediately
       content_type = Rack::Request.new(env).media_type
-      format       = content_type.split('/').last
       begin
         result = @content_types[content_type].call(body)
         env.update FORM_HASH => result, FORM_INPUT => env[POST_BODY]
         @app.call env
       rescue Exception => e
-        logger.warn "#{self.class} #{content_type} parsing error: #{e.to_s}" if respond_to? :logger      # Send to logger if its there.
-        meth = "to_#{format}"
-        meth = "inspect" unless Hash.respond_to? meth
-        [400, { 'Content-Type' => content_type }, [ {'errors' => e.to_s}.method(meth).call ] ] # Finally, return an error response.
+        logger.warn "#{self.class} #{content_type} parsing error: #{e.to_s}" if respond_to? :logger # Send to logger if its there.
+        err = @error_responses[content_type] ? content_type : 'default'
+        @error_responses[err].call(e, content_type) # call the error responses
       end
     end
 

data/rack-parser.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "rack-parser"
-  s.version     = "0.0.4"
+  s.version     = "0.1.0"
   s.authors     = ["Arthur Chiu"]
   s.email       = ["mr.arthur.chiu@gmail.com"]
   s.homepage    = "https://www.github.com/achiu/rack-parser"

data/test/parser_test.rb

@@ -54,13 +54,25 @@ context "Rack::Parser" do
     asserts(:body).equals({'foo' => 'bar'}.inspect)
   end
 
-  context "with bad data" do
-    setup do
-      post '/post', "fuuuuuuuuuu", { 'CONTENT_TYPE' => 'application/json' }
+  context "for errors" do
+
+    context "with default error message" do
+      setup do
+        post '/post', "fuuuuuuuuuu", { 'CONTENT_TYPE' => 'application/json' }
+      end
+
+      asserts(:status).equals 400
+      asserts(:body).equals "{\"errors\":\"710: unexpected token at 'fuuuuuuuuuu'\"}"
     end
 
-    asserts(:status).equals 400
-    asserts(:body).equals "{\"errors\":\"706: unexpected token at 'fuuuuuuuuuu'\"}"
+    context "with custom default error message" do
+      setup do
+        post '/post', "fuuuuuuuuuu", { 'CONTENT_TYPE' => 'application/wahh' }
+      end
+
+      asserts(:status).equals 500
+      asserts(:body).equals "wahh"
+    end
   end
 
 end

data/test/teststrap.rb

@@ -24,7 +24,13 @@ class Riot::Situation
     }
 
     builder = Rack::Builder.new
-    builder.use Rack::Parser, :content_types => { 'application/foo' => Proc.new { |b| {'foo' => 'bar'} } }
+    builder.use Rack::Parser,
+      :content_types => {
+        'application/foo' => Proc.new { |b| {'foo' => 'bar'} } 
+      },
+      :error_responses => {
+        'application/wahh' => Proc.new { |e, content_type| [500,{'Content-Type' => content_type},['wahh']]}
+      }
     builder.run main_app
     builder.to_app
   end

metadata

@@ -1,93 +1,90 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rack-parser
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.1.0
   prerelease: 
-  version: 0.0.4
 platform: ruby
-authors: 
+authors:
 - Arthur Chiu
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-07-15 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-08-19 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rack
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2152833180 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: multi_json
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2152833180
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: &2152832740 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: multi_xml
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *2152832740
+- !ruby/object:Gem::Dependency
+  name: multi_xml
+  requirement: &2152832320 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: riot
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *2152832320
+- !ruby/object:Gem::Dependency
+  name: riot
+  requirement: &2152831900 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: rack-test
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *2152831900
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: &2152831480 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: json
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: *2152831480
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &2152831060 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id006
-description: Rack Middleware for parsing post body data for json/xml and various content types
-email: 
+  prerelease: false
+  version_requirements: *2152831060
+description: Rack Middleware for parsing post body data for json/xml and various content
+  types
+email:
 - mr.arthur.chiu@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - MIT-LICENSE
@@ -99,31 +96,28 @@ files:
 - test/teststrap.rb
 homepage: https://www.github.com/achiu/rack-parser
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: rack-parser
-rubygems_version: 1.8.4
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: Rack Middleware for parsing post body data
-test_files: 
+test_files:
 - test/parser_test.rb
 - test/teststrap.rb