request_exception_handler 0.3 → 0.4

data/README.md

@@ -1,18 +1,16 @@
-RequestExceptionHandler
-=======================
+# RequestExceptionHandler
 
-Rails is not capable of calling Your exception handlers when an error occurs
+Rails is not capable of calling your exception handlers when an error occurs
 during the parsing of request parameters (e.g. in case of invalid XML body).
 
-This will hopefully change someday, but until then I have created this biutiful 
+This will hopefully change someday, but until then I have created this biutiful
 monkey-patch for request parameter parsing to allow more flexibility when
 an invalid request body is received.
 
-Code has been tested on 2.3, 2.2.3 and 2.1 as well as on Rails 3.0 / 3.1.
+Tested on 3.0, 3.1 and 3.2 it should still work on Rails 2.3 and 2.2.3 as well.
 
 
-Install
-=======
+## Install
 
     gem 'request_exception_handler'
 
@@ -20,15 +18,14 @@ or as a plain-old rails plugin :
 
     script/plugin install git://github.com/kares/request_exception_handler.git
 
-Example
-=======
+## Example
 
-The code hooks into parameter parsing and allows a request to be constructed 
-even if the params can not be parsed from the submitted raw content. A before 
-filter is installed that checks for a request exception and re-raises it thus 
-it seems to Rails that the exception comes from the application code and is 
-processed as all other "business" exceptions. 
-You might skip this filter and install Your own to handle such cases (it's good 
+The code hooks into parameter parsing and allows a request to be constructed
+even if the params can not be parsed from the submitted raw content. A before
+filter is installed that checks for a request exception and re-raises it thus
+it seems to Rails that the exception comes from the application code and is
+processed as all other "business" exceptions.
+you might skip this filter and install your own to handle such cases (it's good
 to make sure the filter gets to the beginning of the chain) :
 
     class MyController < ApplicationController
@@ -51,7 +48,7 @@ to make sure the filter gets to the beginning of the chain) :
     end
 
 Another option of how to modify the returned 500 status is to use exception
-handlers the same way You're (hopefully) using them for Your own exceptions :
+handlers the same way you're (hopefully) using them for your own exceptions :
 
     class ApplicationController < ActionController::Base
 
@@ -61,9 +58,14 @@ handlers the same way You're (hopefully) using them for Your own exceptions :
 
     end
 
-If You're not using REXML as a parsing backend the exception might vary, e.g.
+If you're not using REXML as a parsing backend the exception might vary, e.g.
 for Nokogiri the rescue block would look something like :
 
     rescue_from 'Nokogiri::XML::SyntaxError' do |exception|
       render :text => exception.to_s, :status => 422
     end
+
+## Copyright
+
+Copyright (c) 2009-2012 [Karol Bucek](https://github.com/kares). 
+See LICENSE (http://www.apache.org/licenses/LICENSE-2.0) for details.

data/Rakefile

@@ -1,10 +1,9 @@
-require 'rake'
-require 'rake/testtask'
-require 'rake/rdoctask'
+#!/usr/bin/env rake
 
 desc 'Default: run unit tests.'
 task :default => :test
 
+require 'rake/testtask'
 desc 'Test the request_exception_handler plugin.'
 Rake::TestTask.new(:test) do |t|
   t.libs << 'lib'
@@ -12,11 +11,9 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = true
 end
 
-desc 'Generate documentation for the request_exception_handler plugin.'
-Rake::RDocTask.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'RequestExceptionHandler'
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+begin
+  require 'bundler/gem_helper'
+  Bundler::GemHelper.class_eval { def version_tag; "#{version}"; end }
+  require 'bundler/gem_tasks'
+rescue LoadError
+end

data/lib/request_exception_handler.rb

@@ -1,8 +1,11 @@
-
+# The mixin that provides the +request_exception+
+# by default included into +ActionController::Base+
 module RequestExceptionHandler
 
+  THREAD_LOCAL_NAME = :_request_exception
+  
   @@parse_request_parameters_exception_handler = lambda do |request, exception|
-    Thread.current[:request_exception] = exception
+    Thread.current[THREAD_LOCAL_NAME] = exception
     request_body = request.respond_to?(:body) ? request.body : request.raw_post
 
     logger = RequestExceptionHandler.logger
@@ -25,12 +28,19 @@ module RequestExceptionHandler
     { "body" => request_body, "content_type" => content_type, "content_length" => request.content_length }
   end
   
-  mattr_accessor :parse_request_parameters_exception_handler
+  begin
+    mattr_accessor :parse_request_parameters_exception_handler
+  rescue NoMethodError => e
+    require('active_support/core_ext/module/attribute_accessors') && retry
+    raise e
+  end
 
+  # Resets the current +request_exception+ (to nil).
   def self.reset_request_exception
-    Thread.current[:request_exception] = nil
+    Thread.current[THREAD_LOCAL_NAME] = nil
   end
 
+  # Retrieves the Rails logger.
   def self.logger
     defined?(Rails.logger) ? Rails.logger : 
       defined?(RAILS_DEFAULT_LOGGER) ? RAILS_DEFAULT_LOGGER : 
@@ -41,14 +51,16 @@ module RequestExceptionHandler
     base.prepend_before_filter :check_request_exception
   end
 
+  # Checks and raises a +request_exception+ (gets prepended as a before filter).
   def check_request_exception
     e = request_exception
     raise e if e && e.is_a?(Exception)
   end
 
+  # Retrieves and keeps track of the current request exception if any.
   def request_exception
     return @_request_exception if defined? @_request_exception
-    @_request_exception = Thread.current[:request_exception]
+    @_request_exception = Thread.current[THREAD_LOCAL_NAME]
     RequestExceptionHandler.reset_request_exception
     @_request_exception
   end

data/test/test_helper.rb

@@ -1,4 +1,5 @@
 require 'rubygems'
+gem 'test-unit' rescue nil
 require 'test/unit'
 
 # enable testing with different version of rails via argv :
@@ -15,15 +16,15 @@ version =
 if version
   RAILS_VERSION = version
   gem 'activesupport', "= #{RAILS_VERSION}"
-  gem 'activerecord', "= #{RAILS_VERSION}"
+  #gem 'activerecord', "= #{RAILS_VERSION}"
   gem 'actionpack', "= #{RAILS_VERSION}"
-  gem 'actionmailer', "= #{RAILS_VERSION}"
+  #gem 'actionmailer', "= #{RAILS_VERSION}"
   gem 'rails', "= #{RAILS_VERSION}"
 else
   gem 'activesupport'
-  gem 'activerecord'
+  #gem 'activerecord'
   gem 'actionpack'
-  gem 'actionmailer'
+  #gem 'actionmailer'
   gem 'rails'
 end
 

metadata

@@ -1,54 +1,66 @@
 --- !ruby/object:Gem::Specification 
 name: request_exception_handler
 version: !ruby/object:Gem::Version 
-  hash: 13
   prerelease: 
-  segments: 
-  - 0
-  - 3
-  version: "0.3"
+  version: "0.4"
 platform: ruby
 authors: 
-- Karol Bucek
+  - Karol Bucek
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2011-08-31 00:00:00 +02:00
-default_executable: 
+date: 2012-11-15 00:00:00 Z
 dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: actionpack
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 1
-        segments: 
-        - 2
-        - 1
-        version: "2.1"
-  type: :runtime
-  version_requirements: *id001
+  - !ruby/object:Gem::Dependency 
+    name: actionpack
+    version_requirements: &id001 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "2.1"
+    requirement: *id001
+    prerelease: false
+    type: :runtime
+  - !ruby/object:Gem::Dependency 
+    name: rake
+    version_requirements: &id002 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    requirement: *id002
+    prerelease: false
+    type: :development
+  - !ruby/object:Gem::Dependency 
+    name: test-unit
+    version_requirements: &id003 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "2.4"
+    requirement: *id003
+    prerelease: false
+    type: :development
 description: a rails hook that allows one to handle request parameter parsing exceptions (invalid XML, JSON) with a rescue block
 email: 
-- self@kares.org
+  - self@kares.org
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- README.md
+  - README.md
 files: 
-- lib/request_exception_handler.rb
-- LICENSE
-- README.md
-- Rakefile
-- test/request_exception_handler_test.rb
-- test/test_helper.rb
-has_rdoc: true
+  - lib/request_exception_handler.rb
+  - LICENSE
+  - README.md
+  - Rakefile
+  - test/test_helper.rb
+  - test/request_exception_handler_test.rb
 homepage: http://github.com/kares/request_exception_handler
 licenses: []
 
@@ -56,32 +68,32 @@ post_install_message:
 rdoc_options: []
 
 require_paths: 
-- lib
+  - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 2
+        segments: 
+          - 0
+        version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 2
+        segments: 
+          - 0
+        version: "0"
 requirements: []
 
 rubyforge_project: "[none]"
-rubygems_version: 1.6.1
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: handler for all the request (parsing) related exceptions
+summary: handler for all request (parsing) related exceptions
 test_files: 
-- test/request_exception_handler_test.rb
-- test/test_helper.rb
+  - test/test_helper.rb
+  - test/request_exception_handler_test.rb