rack-post-body-to-params 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Niko Dittmann
+
+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.rdoc

@@ -0,0 +1,56 @@
+= Rack::PostBodyToParams
+
+Parses the POST or PUT body to a Hash and put it into the FORM_HASH. Most frameworks get the params hash from there.
+
+You want to build a XMl or JSON API not with Rails? Perhaps Sinatra[http://www.sinatrarb.com/] or Padrino[http://www.padrinorb.com/]? Are you missing the Rails feature that the body of XML and JSON POST or PUT requests are automatically parsed into the params hash? Here you go!
+
+There is something similar already in the {rack-contrib gem}[http://github.com/rack/rack-contrib] called Rack::PostBodyContentTypeParser. Besides being even less creative with the naming Rack::PostBodyToParams sports these features:
+
+* Parses XML as well.
+* Uses ActiveSupport. This may also considered to be a bug but it's in almost every web-framework anyway. The following features sort of depend on it.
+* Uses ActiveSupports settings for XML & JSON parsing, mainly the parser that's used. Including Nokogiri[http://nokogiri.org/] and YAJL[http://github.com/brianmario/yajl-ruby] for more speed and less memory consumption.
+* Parsers are configurable.
+* Parse errors are returned with as status 400 and the error message of the parser.
+
+== Howto use
+
+  use PostBodyToParams
+
+or
+
+  use Rack::PostBodyContentTypeParser,
+         :content_types => ['application/xml'],
+         :parsers => {
+           'application/xml' => Proc.new{|a| my_own_xml_parser a },
+           'application/foo' => Proc.new{|a| my_foo_parser a }
+         }
+
+As you can see you can restrict Rack::PostBodyToParams to only respond to 'application/xml' or 'application/json'.
+
+Make shure ActiveSupport is required and configured. Should look somewhat like this:
+
+  ActiveSupport::JSON.backend = 'Yajl'
+  ActiveSupport::XmlMini.backend = 'Nokogiri'
+
+Note that all current versions of ActiveSupport (up to 3.0.0.beta4) have a bug when requiring the yajl gem. See here for details:
+{Rails Ticket 4897}[https://rails.lighthouseapp.com/projects/8994/tickets/4897-yajl-backend-discovery-fails-in-activesupportjson].
+
+Either you have to patch your ActiveSupport gem or use another parser:
+
+  ActiveSupport::JSON.backend = 'YAML'
+
+== This is early release software. Bug reports and (even more so) fixes are highly welcome!
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Niko Dittmann. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rack-post-body-to-params"
+    gem.summary = %Q{Parses the POST or PUT body to a Hash and put it into the FORM_HASH. Most frameworks get the params hash from there.}
+    
+    gem.email = "mail+git@niko-dittmann.com"
+    gem.homepage = "http://github.com/niko/rack-post-body-to-params"
+    gem.authors = ["Niko Dittmann"]
+    
+    gem.add_development_dependency "shoulda", ">= 0"
+    gem.add_runtime_dependency "activesupport", ">= 2.3"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rack-post-body-to-params #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/rack/post-body-to-params.rb

@@ -0,0 +1,100 @@
+# gem 'activesupport', '=2.3.8'
+gem 'activesupport', '=3.0.0.beta4'
+require 'active_support'
+require 'active_support/core_ext/hash'
+
+module Rack
+
+  # A Rack middleware for parsing POST/PUT body data when
+  # Content-Type is <tt>application/json</tt> or <tt>application/xml</tt>.
+  #
+  # Uses ActiveSupport::JSON.decode for json and ActiveSupports enhanced Hash
+  # #from_xml for xml. Be shure to have ActiveSupport required beforehand.
+  #
+  # Configure parsers for ActiveSupport (you should do this perhaps anyway):
+  #
+  #   ActiveSupport::JSON.backend = 'Yajl'
+  #   ActiveSupport::XmlMini.backend = 'Nokogiri'
+  #
+  # concerning Yajl: https://rails.lighthouseapp.com/projects/8994/tickets/4897-yajl-backend-discovery-fails-in-activesupportjson
+  #
+  # Note that all parsing errors will be rescued and returned back to the client.
+  #
+  # Most parts blantly stolen from http://github.com/rack/rack-contrib.
+  #
+  class PostBodyToParams
+
+    # Constants
+    #
+    CONTENT_TYPE = 'CONTENT_TYPE'.freeze
+    POST_BODY = 'rack.input'.freeze
+    FORM_INPUT = 'rack.request.form_input'.freeze
+    FORM_HASH = 'rack.request.form_hash'.freeze
+
+    # Supported Content-Types
+    #
+    APPLICATION_JSON = 'application/json'.freeze
+    APPLICATION_XML  = 'application/xml'.freeze
+
+    attr_reader :parsers, :error_responses
+
+    # Override the parsers and the error responses as needed:
+    #
+    #   use Rack::PostBodyContentTypeParser,
+    #       :content_types => ['application/xml'],
+    #       :parsers => {
+    #         'application/xml' => Proc.new{|a| my_own_xml_parser a },
+    #         'application/foo' => Proc.new{|a| my_foo_parser a }
+    #       }
+    #
+    def initialize(app, config={})
+      @content_types = config.delete(:content_types) || [APPLICATION_JSON, APPLICATION_XML]
+      
+      @parsers = {
+        APPLICATION_JSON => Proc.new{ |post_body| parse_as_json post_body },
+        APPLICATION_XML =>  Proc.new{ |post_body| parse_as_xml  post_body }
+      }
+      @parsers.update(config[:parsers]) if config[:parsers]
+      
+      @error_responses = {
+        APPLICATION_JSON => Proc.new{ |error| json_error_response error },
+        APPLICATION_XML =>  Proc.new{ |error| xml_error_response  error }
+      }
+      @error_responses.update(config[:error_responses]) if config[:error_responses]
+      
+      @app = app
+    end
+
+    def parse_as_xml(xml_data)
+      Hash.from_xml xml_data
+    end
+    def parse_as_json(json_data)
+      ActiveSupport::JSON.decode json_data
+    end
+
+    def json_error_response(error)
+      [ 400, {'Content-Type' => APPLICATION_JSON}, [ {"json-syntax-error" => error.to_s}.to_json ] ]
+    end
+    def xml_error_response(error)
+      [ 400, {'Content-Type' => APPLICATION_XML}, [ {"xml-syntax-error" => error.to_s}.to_xml(:root => :errors) ] ]
+    end
+
+    def call(env)
+      content_type = env[CONTENT_TYPE]
+      
+      if @content_types.include? content_type
+        post_body = env[POST_BODY].read
+        begin
+          new_form_hash = parsers[content_type].call post_body
+        rescue Exception => error
+          logger.warn "#{self.class} #{content_type} parsing error: #{error.to_s}" if respond_to? :logger
+          return error_responses[content_type].call error
+        end
+        env.update(FORM_HASH => new_form_hash, FORM_INPUT => env[POST_BODY])
+      end
+      
+      @app.call(env)
+    end
+
+  end
+end

data/rack-post-body-to-params.gemspec

@@ -0,0 +1,56 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rack-post-body-to-params}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Niko Dittmann"]
+  s.date = %q{2010-06-21}
+  s.email = %q{mail+git@niko-dittmann.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/rack/post-body-to-params.rb",
+     "rack-post-body-to-params.gemspec",
+     "test/helper.rb",
+     "test/test_post-body-to-params.rb"
+  ]
+  s.homepage = %q{http://github.com/niko/rack-post-body-to-params}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Parses the POST or PUT body to a Hash and put it into the FORM_HASH. Most frameworks get the params hash from there.}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_post-body-to-params.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 2.3"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<activesupport>, [">= 2.3"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<activesupport>, [">= 2.3"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rack/post-body-to-params'
+
+class Test::Unit::TestCase
+end

data/test/test_post-body-to-params.rb

@@ -0,0 +1,123 @@
+require 'helper'
+# ActiveSupport::JSON.backend = 'JSONGem'
+ActiveSupport::JSON.backend = 'Yajl'
+ActiveSupport::XmlMini.backend = 'Nokogiri'
+
+class TestApp
+  def call(env)
+    return env
+  end
+end
+
+module FromXml
+  def from_xml(data)
+    "parsed #{data}"
+  end
+end
+
+class Logger
+  def warn(string)
+    "warning: #{string}"
+  end
+end
+
+class TestPostBodyToParams < Test::Unit::TestCase
+  
+  context "A new app" do
+    context "without further configuration" do
+      setup do
+        @test_app = TestApp.new
+        @app = Rack::PostBodyToParams.new @test_app
+      end
+      should "have the default content_types" do
+        assert_equal ['application/json','application/xml'], @app.instance_variable_get('@content_types').sort
+      end
+      should "have the default parsers" do
+        assert @app.parsers.keys.include? 'application/json'
+        assert @app.parsers.keys.include? 'application/xml'
+        assert @app.parsers['application/json'].is_a? Proc
+        assert @app.parsers['application/xml'].is_a? Proc
+      end
+      should "have the default error responses" do
+        assert @app.error_responses.keys.include? 'application/json'
+        assert @app.error_responses.keys.include? 'application/xml'
+        assert @app.error_responses['application/json'].is_a? Proc
+        assert @app.error_responses['application/xml'].is_a? Proc
+      end
+    end
+
+    context "with further configuration" do
+      should "have different content_types" do
+        app = Rack::PostBodyToParams.new @test_app, :content_types => [:fu]
+        assert_equal [:fu], app.instance_variable_get('@content_types')
+      end
+      should "have different parsers" do
+        app = Rack::PostBodyToParams.new @test_app, :parsers => {'application/json' => :bar}
+        assert_equal :bar, app.parsers['application/json']
+      end
+      should "have different error responses" do
+        app = Rack::PostBodyToParams.new @test_app, :error_responses => {'application/json' => :baz}
+        assert_equal :baz, app.error_responses['application/json']
+      end
+    end
+  end
+  
+  context "the parsers" do
+    setup do
+      @test_app = TestApp.new
+      @app = Rack::PostBodyToParams.new @test_app
+    end
+    should "return the error as xml" do
+      error = 'some error occured'
+      response = [400, {"Content-Type"=>"application/xml"}, ["<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <xml-syntax-error>some error occured</xml-syntax-error>\n</errors>\n"]]
+      assert_equal response, @app.xml_error_response(error)
+    end
+    should "return the error as json" do
+      error = 'some error occured'
+      response = [400, {"Content-Type"=>"application/json"}, ["{\"json-syntax-error\":\"some error occured\"}"]]
+      assert_equal response, @app.json_error_response(error)
+    end
+  end
+  
+  context "the error responses" do
+    setup do
+    end
+  end
+  
+  context "the app itself" do
+    setup do
+      @test_app = TestApp.new
+      @app = Rack::PostBodyToParams.new @test_app
+    end
+    should "put json string data into the form_hash" do
+      env = {
+        'CONTENT_TYPE' => 'application/json',
+        'rack.input' => StringIO.new('{"bla":"blub"}')
+      }
+      new_env = @app.call(env)
+      assert_equal({"bla"=>"blub"}, new_env['rack.request.form_hash'])
+      assert_equal env['rack.input'], new_env['rack.request.form_input']
+    end
+    should "return 400 and the error message on faulty json" do
+      env = {
+        'CONTENT_TYPE' => 'application/json',
+        'rack.input' => StringIO.new('{"bla":"blub"}}')
+      }
+      code, header, body = @app.call(env)
+      assert_equal 400, code
+      assert_equal 'application/json', header['Content-Type']
+      assert_match /json-syntax-error/, body.first
+    end
+    should "return 400 and the error message on faulty xml" do
+      env = {
+        'CONTENT_TYPE' => 'application/xml',
+        'rack.input' => StringIO.new("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<track>\n<title>\nfo\n</title>")
+      }
+      code, header, body = @app.call(env)
+      assert_equal 400, code
+      assert_equal 'application/xml', header['Content-Type']
+      assert_match /xml-syntax-error/, body.first
+    end
+  end
+  
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification 
+name: rack-post-body-to-params
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Niko Dittmann
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-21 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 2
+        - 3
+        version: "2.3"
+  type: :runtime
+  version_requirements: *id002
+description: 
+email: mail+git@niko-dittmann.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/rack/post-body-to-params.rb
+- rack-post-body-to-params.gemspec
+- test/helper.rb
+- test/test_post-body-to-params.rb
+has_rdoc: true
+homepage: http://github.com/niko/rack-post-body-to-params
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Parses the POST or PUT body to a Hash and put it into the FORM_HASH. Most frameworks get the params hash from there.
+test_files: 
+- test/helper.rb
+- test/test_post-body-to-params.rb