rack_respond_to_malformed_formats 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+*.gem
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,18 @@
+source :rubygems
+
+gemspec
+
+gem "nokogiri", "1.4.4"
+gem "json"
+
+group :development do
+  gem "rspec", "2.1"
+  gem "wirble"
+  gem "gemcutter"
+  gem "rack"
+end
+
+group :test do
+  gem "rspec", "2.1"
+end
+

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2011 Case Commons, LLC
+
+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,39 @@
+= Rack Middleware - respond_to_malformed_formats
+
+* http://github.com/casecommons/rack_respond_to_malformed_formats/
+
+== DESCRIPTION
+
+Return graceful and well formatted errors in the same format of the malformed input for XML, JSON and YAML.
+
+Rails will return HTML 500 errors when you send it badly formatted XML or JSON or YAML. It would be nicer if an XML or JSON client actually received the response back in the same format and also received an HTTP 400 error code which is reserved for malformed syntax errors.
+
+== INSTALL
+
+Add rack_respond_to_malformed_formats to your Gemfile
+
+  gem 'rack_respond_to_malformed_formats'
+
+Then run:
+
+  $ bundle install
+
+=== Rails 3
+
+Create an initializer file in config/initializers/respond_to_malformed_formats.rb
+
+  Rails.application.middleware.with_options :logger => Rails.logger do |m|
+    m.insert_before ActionDispatch::ParamsParser, Rack::RespondToMalformedFormats
+  end
+
+=== Rails 2
+
+TODO
+
+== REQUIREMENTS
+
+* Rack
+
+== LICENSE
+
+MIT

data/Rakefile

@@ -0,0 +1,14 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+require 'rake'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+task :default => :spec
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec)
+

data/lib/rack/respond_to_malformed_formats.rb

@@ -0,0 +1,71 @@
+require "rack/mime"
+require "json"
+require "nokogiri"
+require "yaml"
+
+module Rack
+  class RespondToMalformedFormats
+    VERSION = "0.0.1"
+
+    def initialize(app, options = {})
+      @app = app
+    end
+
+      def call(env)
+      if malformed_response = respond_to_malformed_parameters(env)
+        input = env["rack.input"]
+        input.rewind
+        logger.error "Error occurred while parsing request.\nInput:\n\n#{input.read}" if logger
+        malformed_response
+      else
+        @app.call(env)
+      end
+    end
+
+    private
+
+    def respond_to_malformed_parameters(env)
+      request = Request.new(env)
+
+      case (env["HTTP_X_POST_DATA_FORMAT"] || request.content_type).to_s.downcase
+      when /xml/
+        parse_xml(request.body.read)
+      when /yaml/
+        parse_yaml(request.body.read)
+      when /json/
+        parse_json(request.body.read)
+      else
+        false
+      end
+    end
+
+    def parse_json(body)
+      JSON.parse(body)
+      false
+    rescue JSON::ParserError => e
+      [400, {"Content-Type" => "application/json"}, [{:error => e.to_s}.to_json]]
+    end
+
+    def parse_xml(body)
+      Nokogiri::XML(body) { |config| config.strict }
+      false
+    rescue Nokogiri::XML::SyntaxError => e
+      response = Nokogiri::XML::Builder.new do
+        error e.to_s
+      end
+
+      [400, {"Content-Type" => "application/xml"}, [response.to_xml]]
+    end
+
+    def parse_yaml(body)
+      YAML.load(body)
+      false
+    rescue ArgumentError => e
+      [400, {"Content-Type"=> "application/x-yaml"}, [e.to_s]]
+    end
+
+    def logger
+      defined?(Rails.logger) ? Rails.logger : nil
+    end
+  end
+end

data/lib/respond_to_malformed_formats.rb

@@ -0,0 +1 @@
+require "rack/respond_to_malformed_formats"

data/rack_respond_to_malformed_formats.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require File.join(File.dirname(__FILE__), "lib/rack/respond_to_malformed_formats")
+
+Gem::Specification.new do |s|
+  s.name        = "rack_respond_to_malformed_formats"
+  s.version     = Rack::RespondToMalformedFormats::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Case Commons, LLC"]
+  s.email       = ["casecommons-dev@googlegroups.com"]
+  s.homepage    = "https://github.com/Casecommons/rack_respond_to_malformed_formats"
+  s.license     = "MIT"
+  s.add_dependency('activesupport', '>= 3.0.0')
+  s.summary     = %q{Intercept malformed XML and JSON requests and return XML and JSON 400 responses not HTML 500}
+  s.description = %q{Rails currently returns HTML 500 responses when sent unparsable XML and JSON and gives no way to rescue and handle it}
+
+  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"]
+end

data/spec/respond_to_malformed_formats_spec.rb

@@ -0,0 +1,93 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "spec_helper"))
+
+describe Rack::RespondToMalformedFormats do
+  context "when the format is HTML" do
+    it "should do nothing" do
+      test_input = '<html></html>'
+      app = lambda { |env| [200, {"CONTEN_TYPE" => "text/html"}, test_input] }
+      request = Rack::MockRequest.env_for("/", :params => "", "CONTENT_TYPE" => "test/html", :input => test_input)
+      body = Rack::RespondToMalformedFormats.new(app).call(request).last
+
+      body.should == test_input
+    end
+  end
+
+  context "when the format is JSON" do
+    context "and it is valid" do
+      it "should do nothing" do
+        test_input = '{"foo":"bar"}'
+        app = lambda { |env| [200, {"CONTENT_TYPE" => "application/json"}, test_input] }
+        request = Rack::MockRequest.env_for("/", :params => "", "CONTENT_TYPE" => "application/json", :input => test_input)
+        body = Rack::RespondToMalformedFormats.new(app).call(request).last
+
+        body.should == test_input
+      end
+    end
+
+    context "and it is invalid" do
+      it "should return a 400 with a message" do
+        test_input = '{"foo":'
+        app = lambda { |env| [200, {"CONTENT_TYPE" => "application/json"}, test_input] }
+        request = Rack::MockRequest.env_for("/", :params => "", "CONTENT_TYPE" => "application/json", :input => test_input)
+        response = Rack::RespondToMalformedFormats.new(app).call(request)
+
+        response[0].should == 400
+        response[1]["Content-Type"].should == "application/json"
+        response[2].first.should =~ /.*error.*unexpected token.*/
+      end
+    end
+  end
+
+  context "when the format is XML" do
+    context "and it is valid" do
+      it "should do nothing" do
+        test_input = '<?xml version="1.0"?><foo>bar</foo>'
+        app = lambda { |env| [200, {"CONTENT_TYPE" => "application/xml"}, test_input] }
+        request = Rack::MockRequest.env_for("/", :params => "", "CONTENT_TYPE" => "application/xml", :input => test_input)
+        body = Rack::RespondToMalformedFormats.new(app).call(request).last
+
+        body.should == test_input
+      end
+    end
+
+    context "and it is invalid" do
+      it "should return a 400 with a message" do
+        test_input = '<ml><foo>bar'
+        app = lambda { |env| [200, {"CONTENT_TYPE" => "application/xml"}, test_input] }
+        request = Rack::MockRequest.env_for("/", :params => "", "CONTENT_TYPE" => "application/xml", :input => test_input)
+        response = Rack::RespondToMalformedFormats.new(app).call(request)
+
+        response[0].should == 400
+        response[1]["Content-Type"].should == "application/xml"
+        response[2].first.should =~ /.*<error>Premature.*<\/error>.*/
+      end
+    end
+  end
+
+  context "when the format is YAML" do
+    context "and it is valid" do
+      it "should do nothing" do
+        test_input = "--- \nfoo: bar\n"
+        app = lambda { |env| [200, {"CONTENT_TYPE" => "application/x-yaml"}, test_input] }
+        request = Rack::MockRequest.env_for("/", :params => "", "CONTENT_TYPE" => "application/x-yaml", :input => test_input)
+        body = Rack::RespondToMalformedFormats.new(app).call(request).last
+
+        body.should == test_input
+      end
+    end
+
+    context "and it is invalid" do
+      it "should return a 400 with a message" do
+        test_input = "--- what:\nawagasd"
+        app = lambda { |env| [200, {"CONTENT_TYPE" => "application/x-yaml"}, test_input] }
+        request = Rack::MockRequest.env_for("/", :params => "", "CONTENT_TYPE" => "application/x-yaml", :input => test_input)
+        response = Rack::RespondToMalformedFormats.new(app).call(request)
+
+        response[0].should == 400
+        response[1]["Content-Type"].should == "application/x-yaml"
+        response[2].first.should =~ /.*syntax error.*/
+      end
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require "rubygems"
+require "rspec"
+require "rack"
+require "rack/mock"
+
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "lib/respond_to_malformed_formats"))
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: rack_respond_to_malformed_formats
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Case Commons, LLC
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-17 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id001
+description: Rails currently returns HTML 500 responses when sent unparsable XML and JSON and gives no way to rescue and handle it
+email: 
+- casecommons-dev@googlegroups.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- lib/rack/respond_to_malformed_formats.rb
+- lib/respond_to_malformed_formats.rb
+- rack_respond_to_malformed_formats.gemspec
+- spec/respond_to_malformed_formats_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: https://github.com/Casecommons/rack_respond_to_malformed_formats
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+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: Intercept malformed XML and JSON requests and return XML and JSON 400 responses not HTML 500
+test_files: 
+- spec/respond_to_malformed_formats_spec.rb
+- spec/spec_helper.rb