parsnip 0.0.1 → 0.0.2

data/README.rdoc

@@ -0,0 +1,21 @@
+== Welcome to Parsnip
+
+Parsnip is a rack middlware component primarily targeted to Rails 3.x developers
+creating RESTful apis.  Particularly those tired of ActionDispatch::ParamsParser 
+spewing internal server errors when clients supply malformed XML or JSON in the 
+body of PUT/POST requests.  Parsnip will find unparsable XML or JSON and return
+response with a status code of 400 and JSON or XML body content describing the 
+parsing error encountered.
+
+
+== Getting Started
+
+Rails: Parsnip uses the railties facility to work as a plug and play gem for Rails
+applications (verified with Rails 3.2.x). 
+
+1. Add <tt>gem 'parsnip'</tt> to your Gemfile
+
+2. Run <tt>bundle</tt> from your project root
+
+3. Run <tt>rake middleware</tt> from your project root and verify that 
+   Parsnip::Middleware appears before ActionDispatch::ParamsParser

data/lib/parsnip/railtie.rb

@@ -0,0 +1,11 @@
+module Parsnip
+
+  class Railtie < Rails::Railtie
+
+    initializer 'parsnip.add_middleware' do | app |
+      app.config.middleware.insert_before(ActionDispatch::ParamsParser, Parsnip::Middleware)
+    end
+
+  end
+
+end

data/lib/parsnip/version.rb

@@ -1,3 +1,3 @@
 module Parsnip
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/lib/parsnip.rb

@@ -1,4 +1,5 @@
 require 'parsnip/version'
+require 'parsnip/railtie' if defined? Rails
 require 'sinatra/base'
 require 'json'
 require 'nokogiri'
@@ -7,6 +8,10 @@ module Parsnip
 
   class Middleware < Sinatra::Base
 
+    disable :show_exceptions
+
+    enable :raise_errors
+
     post '*' do
       parse_nip(request) || pass
     end
@@ -29,7 +34,7 @@ module Parsnip
     def json_nip(body)
       JSON.parse(body) and nil
     rescue JSON::ParserError => e
-      nip({ error: e.to_s }.to_json, 'application/json')
+      nip({ error: e.to_s }.to_json, 'application/json; charset=utf-8')
     end
 
     def xml_nip(body)
@@ -38,7 +43,7 @@ module Parsnip
       error = Nokogiri::XML::Builder.new(encoding: 'UTF-8') do | xml |
         xml.error e.to_s
       end
-      nip(error.to_xml, 'application/xml')
+      nip(error.to_xml, 'application/xml; charset=utf-8')
     end
 
     def nip(body, type)

data/parsnip.gemspec

@@ -8,6 +8,7 @@ Gem::Specification.new do |s|
   s.authors     = ['Sean M. Duncan']
   s.email       = ['bitbutcher@gmail.com']
   s.summary     = %q{Rack Middleware that nips parsing errors in the bud before they manifest as internal server errors}
+  s.homepage    = 'https://github.com/bitbutcher/parsnip'
 
   s.rubyforge_project = "parsnip"
 
@@ -15,7 +16,6 @@ Gem::Specification.new do |s|
   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_development_dependency 'rspec'
   s.add_runtime_dependency 'sinatra'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: parsnip
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-07 00:00:00.000000000 Z
+date: 2012-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70107460324580 !ruby/object:Gem::Requirement
+  requirement: &70130805860420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70107460324580
+  version_requirements: *70130805860420
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &70107460323420 !ruby/object:Gem::Requirement
+  requirement: &70130805858960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70107460323420
+  version_requirements: *70130805858960
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70107460322800 !ruby/object:Gem::Requirement
+  requirement: &70130805858060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70107460322800
+  version_requirements: *70130805858060
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70107460322200 !ruby/object:Gem::Requirement
+  requirement: &70130805857360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70107460322200
+  version_requirements: *70130805857360
 description: 
 email:
 - bitbutcher@gmail.com
@@ -64,11 +64,13 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- README.rdoc
 - Rakefile
 - lib/parsnip.rb
+- lib/parsnip/railtie.rb
 - lib/parsnip/version.rb
 - parsnip.gemspec
-homepage: 
+homepage: https://github.com/bitbutcher/parsnip
 licenses: []
 post_install_message: 
 rdoc_options: []