rack-parser 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in rack-parser.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2011 Arthur Chiu
+
+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,82 @@
+# Rack::Parser #
+
+Rack::Parser is a Rack Middleware for parsing post body data for JSON/XML, and custom
+content types using MultiJson, MultiXML, or any thing that you want to
+use.
+
+What this allows your rack application to do is decode/parse incoming post data
+into param hashes for your applications to use.
+
+## Installation ##
+
+install it via rubygems:
+
+```
+gem install rack-parser
+```
+
+or put it in your Gemfile:
+
+```ruby
+# Gemfile
+
+gem 'rack-parser', :require => 'rack/parser'
+```
+
+
+## Usage ##
+
+
+In a Sinatra or [Padrino](http://padrinorb.com) application, it would probably be something like:
+
+```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' }
+  }
+```
+
+
+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
+engine of your choice by setting the engine like so:
+
+
+```ruby
+# app.rb
+
+MultiJson.engine = :yajl  # Yajl-ruby for json decoding
+MultiXml.parser = :libxml # libxml for XML parsing
+
+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' }
+  }
+```
+
+To set your own custom engine that perhaps neither MultiJson or MultiXml
+support, just make it a Proc:
+
+
+```ruby
+use Rack::Parser, :content_types => {
+  'application/json' => Proc.new { |body| MyCustomJsonEngine.do_it body }
+}
+```
+
+## Inspirations ##
+
+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.
+
+## Copyright
+
+Copyright © 2011 Arthur Chiu. See [MIT-LICENSE](https://github.com/achiu/rack-parser/blob/master/MIT-LICENSE) for details.
+

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+  test.ruby_opts << '-rubygems'
+end

data/lib/rack/parser.rb

@@ -0,0 +1,59 @@
+require 'multi_json'
+require 'multi_xml'
+
+module Rack
+
+  # Rack::Parser allows you to set custom parsers for incoming post body data. As a default,
+  # Rack::Parser uses MultiJson and MultiXml to do the decoding/parsing for you. This allows you to
+  # 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.
+  #
+  class Parser
+
+    # Rack Constants
+    HEADER_CONTENT_TYPE = 'Content-Type'.freeze
+    POST_BODY           = 'rack.input'.freeze
+    FORM_INPUT          = 'rack.request.form_input'.freeze
+    FORM_HASH           = 'rack.request.form_hash'.freeze
+
+    # Default Settings
+    DEFAULT_CONTENT_TYPE = {
+      'application/xml'  => Proc.new { |body| MultiXml.parse(body)   },
+      'application/json' => Proc.new { |body| MultiJson.decode(body) }
+    }
+
+    attr_reader :content_types
+
+    # Usage:
+    # 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   }
+    # }
+    def initialize(app, options = {})
+      @app           = app
+      @content_types = DEFAULT_CONTENT_TYPE.merge(options.delete(:content_types) || {})
+    end
+
+    def call(env)
+      dup._call(env)
+    end
+
+    def _call(env)
+      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 = env[HEADER_CONTENT_TYPE]
+      format       = content_type.split('/').last
+      begin
+        result = @content_types[content_type].call(body)
+        env.update FORM_HASH => result, FORM_INPUT => 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.
+        [400, { 'Content-Type' => content_type }, [ {'errors' => e.to_s}.method("to_#{format}").call ] ] # Finally, return an error response.
+      end
+    end
+
+  end
+end

data/rack-parser.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "rack-parser"
+  s.version     = "0.0.1"
+  s.authors     = ["Arthur Chiu"]
+  s.email       = ["mr.arthur.chiu@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Rack Middleware for parsing post body data}
+  s.description = %q{Rack Middleware for parsing post body data for json/xml and various content types}
+
+  s.rubyforge_project = "rack-parser"
+
+  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_dependency 'multi_json'
+  s.add_dependency 'multi_xml'
+  s.add_development_dependency 'riot'
+  s.add_development_dependency 'rack-test'
+  s.add_development_dependency 'json'
+end

data/test/parser_test.rb

@@ -0,0 +1,66 @@
+require File.expand_path('../teststrap', __FILE__)
+
+class FooApp
+  def call(env); env; end
+end
+
+context "Rack::Parser" do
+
+  context "default configuration" do
+    setup do
+      Rack::Parser.new(FooApp.new).content_types
+    end
+
+    asserts(:[],'application/xml').kind_of Proc
+    asserts(:[],'application/json').kind_of Proc
+  end
+
+  context "with custom configuration" do
+    setup do
+      Rack::Parser.new(FooApp.new, :content_types => {
+        'application/xml' => :meh,
+        'application/foo' => :bar
+      }).content_types
+    end
+
+    asserts(:[], 'application/xml').equals :meh
+    asserts(:[], 'application/foo').equals :bar
+  end
+
+  context "with json" do
+    setup do
+      post '/post', "{\"test\":1,\"foo\":2,\"bar\":\"3\"}", { 'Content-Type' => 'application/json' }
+    end
+
+    asserts(:status).equals 200
+    asserts(:body).equals "{\"test\"=>1, \"foo\"=>2, \"bar\"=>\"3\"}"
+  end
+
+  context "with xml" do
+    setup do
+      put '/post', "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<hash>\n  <a type=\"integer\">1</a>\n</hash>\n", { 'Content-Type' => 'application/xml'}
+    end
+
+    asserts(:status).equals 200
+    asserts(:body).equals "{\"hash\"=>{\"a\"=>1}}"
+  end
+
+  context "with custom 'foo'" do
+    setup do
+      post '/post', 'something that does not matter', { 'Content-Type' => 'application/foo' }
+    end
+
+    asserts(:status).equals 200
+    asserts(:body).equals 'foo'
+  end
+
+  context "with bad data" do
+    setup do
+      post '/post', "fuuuuuuuuuu", { 'Content-Type' => 'application/json' }
+    end
+
+    asserts(:status).equals 400
+    asserts(:body).equals "{\"errors\":\"706: unexpected token at 'fuuuuuuuuuu'\"}"
+  end
+
+end

data/test/teststrap.rb

@@ -0,0 +1,33 @@
+require 'rack'
+require 'riot'
+require 'rack/test'
+require 'rack/builder'
+require 'json'
+
+require File.expand_path('../../lib/rack/parser', __FILE__)
+
+class Riot::Situation
+  include Rack::Test::Methods
+
+  def app
+    main_app = lambda { |env|
+      request = Rack::Request.new(env)
+      return_code, body_text =
+      case request.path
+      when '/' then [200,'Hello world']
+      when '/post' then [200, env['rack.request.form_hash']]
+      else
+        [404,'Nothing here']
+      end
+      [return_code,{'Content-type' => 'text/plain'}, [body_text]]
+    }
+
+    builder = Rack::Builder.new
+    builder.use Rack::Parser, :content_types => { 'application/foo' => Proc.new { |b| 'foo' } }
+    builder.run main_app
+    builder.to_app
+  end
+end
+
+class Riot::Context
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification 
+name: rack-parser
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Arthur Chiu
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-13 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    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 
+    none: false
+    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 
+    none: false
+    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 
+    none: false
+    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 
+    none: false
+    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 
+    none: false
+    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: 
+- mr.arthur.chiu@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/rack/parser.rb
+- rack-parser.gemspec
+- test/parser_test.rb
+- test/teststrap.rb
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: rack-parser
+rubygems_version: 1.8.4
+signing_key: 
+specification_version: 3
+summary: Rack Middleware for parsing post body data
+test_files: 
+- test/parser_test.rb
+- test/teststrap.rb