rails_exception_handler 1.0.0

data/spec/testapp_30/config/environments/test.rb

@@ -0,0 +1,35 @@
+ExceptionHandlerTestApp::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # The test environment is used exclusively to run your application's
+  # test suite.  You never need to work with it otherwise.  Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs.  Don't rely on the data there!
+  config.cache_classes = true
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment
+  config.action_controller.allow_forgery_protection    = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+  # Use SQL instead of Active Record's schema dumper when creating the test database.
+  # This is necessary if your schema can't be completely dumped by the schema dumper,
+  # like if you have constraints or database-specific column types
+  # config.active_record.schema_format = :sql
+
+  # Print deprecation notices to the stderr
+  config.active_support.deprecation = :stderr
+end

data/spec/testapp_30/config/examples/database.yml

@@ -0,0 +1,13 @@
+
+test: &test
+  adapter: mysql2
+  encoding: utf8
+  reconnect: false
+  database: exception_handler_test_app_test
+  pool: 5
+  username: root
+  password:
+  host: localhost
+
+exception_database:
+  <<: *test

data/spec/testapp_30/config/locales/en.yml

@@ -0,0 +1,5 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See http://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  hello: "Hello world"

data/spec/testapp_30/config/routes.rb

@@ -0,0 +1,6 @@
+ExceptionHandlerTestApp::Application.routes.draw do
+  match 'home/controller_error' => 'home#controller_error'
+  match 'home/model_error' => 'home#model_error'
+  match 'home/view_error' => 'home#view_error'
+  match 'home/syntax_error' => 'home#syntax_error'
+end

data/spec/testapp_30/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run ExceptionHandlerTestApp::Application

data/spec/testapp_30/db/migrate/20110630174538_create_error_messages.rb

@@ -0,0 +1,22 @@
+class CreateErrorMessages < ActiveRecord::Migration
+  def self.up
+    create_table :error_messages do |t|
+      t.text :class_name
+      t.text :message
+      t.text :trace
+      t.text :params
+      t.text :target_url
+      t.text :referer_url
+      t.text :user_agent
+      t.string :user_info
+      t.string :app_name
+      t.datetime :created_at
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :error_messages
+  end
+end

data/spec/testapp_30/db/migrate/20110702131654_add_sessions_table.rb

@@ -0,0 +1,16 @@
+class AddSessionsTable < ActiveRecord::Migration
+  def self.up
+    create_table :sessions do |t|
+      t.string :session_id, :null => false
+      t.text :data
+      t.timestamps
+    end
+
+    add_index :sessions, :session_id
+    add_index :sessions, :updated_at
+  end
+
+  def self.down
+    drop_table :sessions
+  end
+end

data/spec/testapp_30/db/schema.rb

@@ -0,0 +1,39 @@
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended to check this file into your version control system.
+
+ActiveRecord::Schema.define(:version => 20110702131654) do
+
+  create_table "error_messages", :force => true do |t|
+    t.text     "class_name"
+    t.text     "message"
+    t.text     "trace"
+    t.text     "params"
+    t.text     "target_url"
+    t.text     "referer_url"
+    t.text     "user_agent"
+    t.string   "user_info"
+    t.string   "app_name"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "sessions", :force => true do |t|
+    t.string   "session_id", :null => false
+    t.text     "data"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  add_index "sessions", ["session_id"], :name => "index_sessions_on_session_id"
+  add_index "sessions", ["updated_at"], :name => "index_sessions_on_updated_at"
+
+end

data/spec/testapp_30/db/seeds.rb

@@ -0,0 +1,7 @@
+# This file should contain all the record creation needed to seed the database with its default values.
+# The data can then be loaded with the rake db:seed (or created alongside the db with db:setup).
+#
+# Examples:
+#
+#   cities = City.create([{ :name => 'Chicago' }, { :name => 'Copenhagen' }])
+#   Mayor.create(:name => 'Daley', :city => cities.first)

data/spec/testapp_30/script/rails

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

data/spec/testapp_30/script/setup

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+require 'fileutils'
+
+Dir.chdir(File.expand_path(File.dirname(__FILE__)) + "/../")
+
+source = "config/examples/database.yml"
+target = "config/database.yml"
+
+if File.exist?(target)
+  puts "#{target} already exists"
+else
+  FileUtils.cp(source, target)
+  puts "#{target} copied"
+end
+
+system "bundle"
+system "bundle exec rake db:create --trace RAILS_ENV=test"
+system "bundle exec rake db:migrate --trace RAILS_ENV=test"

data/spec/unit/configuration_spec.rb

@@ -0,0 +1,37 @@
+
+
+describe RailsExceptionHandler::Configuration do
+  describe ".initialize" do
+    before(:each) do
+      @configuration = RailsExceptionHandler::Configuration.new
+    end
+
+    it "should add :production to environments" do
+      @configuration.environments.should == [:production]
+    end
+
+    it "should set storage_strategies to []" do
+      @configuration.storage_strategies.should == []
+    end
+
+    it "should set store_user_info to false" do
+      @configuration.store_user_info = false
+    end
+
+    it "should set filters to [] " do
+      @configuration.filters.should == []
+    end
+
+    it "should set the 404 response" do
+      @configuration.responses['404'].should match(/Page not found/)
+    end
+
+    it "should set the 500 response" do
+      @configuration.responses['500'].should match(/Internal server error/)
+    end
+
+    it "should set the fallback layout to 'application'" do
+      @configuration.fallback_layout.should == 'application'
+    end
+  end
+end

data/spec/unit/handler_spec.rb

@@ -0,0 +1,136 @@
+require File.expand_path(File.dirname(__FILE__)) + '/../spec_helper.rb'
+
+describe RailsExceptionHandler::Handler do
+  before(:each) do
+    @handler = RailsExceptionHandler::Handler.new(create_env, create_exception)
+  end
+
+  describe ".handle_exception" do
+    it "should parse error" do
+      @handler.handle_exception
+      @handler.instance_variable_get(:@parsed_error).should_not == nil
+    end
+
+    it "should store error" do
+      @handler.should_receive(:store_error)
+      @handler.handle_exception
+    end
+
+    it "should return a rack tripple" do
+      response = @handler.handle_exception
+      response.length.should == 3
+      response[0].should == 200 # response code
+      response[1].class.should == Hash # headers
+      response[2].class.should == ActionDispatch::Response # body
+    end
+  end
+
+  describe ".store_error" do
+    it "should store an error message in the database when storage_strategies includes :active_record" do
+      RailsExceptionHandler.configure { |config| config.storage_strategies = [:active_record] }
+      @handler.handle_exception
+      ErrorMessage.count.should == 1
+      msg = ErrorMessage.first
+      msg.app_name.should ==      'ExceptionHandlerTestApp'
+      msg.class_name.should ==    'NoMethodError'
+      msg.message.should ==       "undefined method `foo' for nil:NilClass"
+      msg.trace.should match      /active_support\/whiny_nil/
+      msg.params.should match     /\"foo\"=>\"bar\"/
+      msg.user_agent.should ==    'Mozilla/4.0 (compatible; MSIE 8.0)'
+      msg.target_url.should ==    'http://example.org/home?foo=bar'
+      msg.referer_url.should ==   'http://google.com/'
+      msg.created_at.should be >  5.seconds.ago
+      msg.created_at.should be <  Time.now
+    end
+
+    it "should not store an error message in the database when storage_strategies does not include :active_record" do
+      RailsExceptionHandler.configure { |config| config.storage_strategies = [] }
+      ErrorMessage.count.should == 0
+    end
+
+    it "it should log an error to the rails log when storage_strategies includes :rails_log" do
+      RailsExceptionHandler.configure { |config| config.storage_strategies = [:rails_log] }
+      read_test_log.should == ''
+      @handler.handle_exception
+      read_test_log.should match /NoMethodError \(undefined method `foo' for nil:NilClass\)/
+      read_test_log.should match /lib\/active_support\/whiny_nil\.rb:48/
+      read_test_log.should match /PARAMS:\s+{\"foo\"=>\"bar\"}/
+      read_test_log.should match /USER_AGENT:\s+Mozilla\/4.0 \(compatible; MSIE 8\.0\)/
+      read_test_log.should match /TARGET:\s+http:\/\/example\.org\/home\?foo=bar/
+      read_test_log.should match /REFERER:\s+http:\/\/google\.com\//
+    end
+
+    it "should not log an error to the rails log when storage_strategies does not include :rails_log" do
+      RailsExceptionHandler.configure { |config| config.storage_strategies = [] }
+      read_test_log.should == ''
+      @handler.handle_exception
+      read_test_log.should == ''
+    end
+
+    it "should send the error_message as an HTTP POST request when :remote_url is included" do
+      Time.stub!(:now => Time.now) # Otherwise the timestamps will be different, and comparison fail
+      @handler.handle_exception
+      parser = @handler.instance_variable_get(:@parsed_error)
+      RailsExceptionHandler.configure { |config| config.storage_strategies = [:remote_url => {:target => 'http://example.com/error_messages'}] }
+      uri = URI.parse('http://example.com/error_messages')
+      params = {}
+      parser.relevant_info.each do |key,value|
+        params["error_message[#{key}]"] = value
+      end
+      Net::HTTP.should_receive(:post_form).with(uri, params)
+      @handler.handle_exception
+    end
+
+    it "should not send the error_message as an HTTP POST request when :remote_url is not included" do
+      RailsExceptionHandler.configure { |config| config.storage_strategies = [] }
+      Net::HTTP.should_not_receive(:post_form)
+      @handler.handle_exception
+    end
+
+    it "should be able to use multiple storage strategies" do
+      RailsExceptionHandler.configure { |config| config.storage_strategies = [:active_record, :rails_log] }
+      read_test_log.should == ''
+      @handler.handle_exception
+      read_test_log.should match /NoMethodError \(undefined method `foo' for nil:NilClass\)/
+      ErrorMessage.count.should == 1
+    end
+  end
+
+  describe '.response' do
+    it "should call index action on ErrorResponseController" do
+      ErrorResponseController.should_receive(:action).with(:index).and_return(mock(Object, :call => true))
+      @handler.handle_exception
+    end
+
+    it "should set response_code to '404' on routing errors" do
+      exception = create_exception
+      env = create_env
+      exception.stub!(:class => ActiveRecord::RecordNotFound)
+      handler = RailsExceptionHandler::Handler.new(env, exception)
+      handler.handle_exception
+      env['exception_handler.response_code'].should == '404'
+    end
+
+    it "should set response_code to '500' on all other errors" do
+      env = create_env
+      handler = RailsExceptionHandler::Handler.new(env, create_exception)
+      handler.handle_exception
+      env['exception_handler.response_code'].should == '500'
+    end
+
+    it "should save the layout in env" do
+      env = create_env
+      handler = RailsExceptionHandler::Handler.new(env, create_exception)
+      handler.instance_variable_set("@controller",mock(Object, :_default_layout => 'home'))
+      handler.handle_exception
+      env['exception_handler.layout'].should == 'home'
+    end
+
+    it "should use the fallback layout when no layout is defined" do
+      env = create_env
+      handler = RailsExceptionHandler::Handler.new(env, create_exception)
+      handler.handle_exception
+      env['exception_handler.layout'].should == 'fallback'
+    end
+  end
+end

data/spec/unit/parser_spec.rb

@@ -0,0 +1,112 @@
+require File.expand_path(File.dirname(__FILE__)) + '/../spec_helper.rb'
+
+describe RailsExceptionHandler::Parser do
+  before(:each) do
+    env = create_env
+    controller = mock(ApplicationController, :current_user => mock(Object, :login => 'matz'))
+    request = ActionDispatch::Request.new(env)
+    @parser = RailsExceptionHandler::Parser.new(create_exception, request, controller)
+  end
+
+  describe ".relevant_info" do
+    it("should return app_name") { @parser.relevant_info[:app_name].should == 'ExceptionHandlerTestApp' }
+    it("should return class_name") { @parser.relevant_info[:class_name].should == 'NoMethodError' }
+    it("should return message") { @parser.relevant_info[:message].should == "undefined method `foo' for nil:NilClass" }
+    it("should return trace") { @parser.relevant_info[:trace].should match /active_support\/whiny_nil/ }
+    it("should return target_url") { @parser.relevant_info[:target_url].should == 'http://example.org/home?foo=bar' }
+    it("should return referer_url") { @parser.relevant_info[:referer_url].should == 'http://google.com/' }
+    it("should return params") { @parser.relevant_info[:params].should match(/\"foo\"=>\"bar\"/) }
+    it("should return user_agent") { @parser.relevant_info[:user_agent].should == "Mozilla/4.0 (compatible; MSIE 8.0)" }
+    it("should return user_info") { @parser.relevant_info[:user_info].should == nil }
+    it("should return created_at") { @parser.relevant_info[:created_at].should be > 5.seconds.ago }
+    it("should return created_at") { @parser.relevant_info[:created_at].should be < Time.now }
+  end
+
+  describe ".ignore?" do
+    context "routing errors" do
+      it "should return true on routing errors when the filter contains :all_404s" do
+        RailsExceptionHandler.configure { |config| config.filters = [:all_404s] }
+        exception = create_exception
+        exception.stub!(:class => ActionController::RoutingError)
+        parser = create_parser(exception, nil, nil)
+        parser.ignore?.should == true
+      end
+
+      it "should return true on routing errors without referer when the filter contains :no_referer_404s" do
+        RailsExceptionHandler.configure { |config| config.filters = [:no_referer_404s] }
+        exception = create_exception
+        exception.stub!(:class => ActionController::RoutingError)
+        request = ActionDispatch::Request.new(create_env(:referer => '/'))
+        parser = create_parser(exception, request, nil)
+        parser.ignore?.should == true
+      end
+
+      it "should return true when the user agent matches against the filters :user_agent_regxp" do
+        RailsExceptionHandler.configure { |config| config.filters = [{:user_agent_regxp => /\b(Mozilla)\b/}] }
+        parser = create_parser(nil, nil, nil)
+        parser.ignore?.should == true
+      end
+
+      it "should return true when the url matches against the filters :target_url_regxp" do
+        RailsExceptionHandler.configure { |config| config.filters = [{:target_url_regxp => /\b(home)\b/}] }
+        parser = create_parser(nil, nil, nil)
+        parser.ignore?.should == true
+      end
+
+      it "should return false when the request is not caught by a filter" do
+        RailsExceptionHandler.configure { |config| config.filters = [] }
+        parser = create_parser(nil, nil, nil)
+        parser.ignore?.should == false
+      end
+    end
+  end
+
+  describe "routing_error?" do
+    it "should return true on ActionController::RoutingError" do
+      exception = create_exception
+      exception.stub!(:class => ActionController::RoutingError)
+      parser = create_parser(exception, nil, nil)
+      parser.routing_error?.should == true
+    end
+
+    it "should return true on AbstractController::ActionNotFound" do
+      exception = create_exception
+      exception.stub!(:class => AbstractController::ActionNotFound)
+      parser = create_parser(exception, nil, nil)
+      parser.routing_error?.should == true
+    end
+
+    it "should return true on ActiveRecord::RecordNotFound" do
+      exception = create_exception
+      exception.stub!(:class => ActiveRecord::RecordNotFound)
+      parser = create_parser(exception, nil, nil)
+      parser.routing_error?.should == true
+    end
+
+    it "should return false on all other errors" do
+      @parser.routing_error?.should == false
+    end
+  end
+
+  describe "user_info" do
+    it "should store user info based on the method and field provided" do
+      RailsExceptionHandler.configure {|config| config.store_user_info = {:method => :current_user, :field => :login}}
+      controller = mock(ApplicationController, :current_user => mock(Object, :login => 'matz'))
+      parser = create_parser(nil, nil, controller)
+      parser.relevant_info[:user_info].should == 'matz'
+    end
+    it "should store 'Anonymous' when store_user_info is enabled and no user is logged in" do
+      RailsExceptionHandler.configure {|config| config.store_user_info = {:method => :current_user, :field => :login}}
+      controller = mock(ApplicationController, :current_user => nil)
+      parser = create_parser(nil, nil, controller)
+      parser.relevant_info[:user_info].should == 'Anonymous'
+    end
+
+    it "should not store any info when configured store_user_info is false" do
+      RailsExceptionHandler.configure {|config| config.store_user_info = false}
+      controller = mock(ApplicationController, :current_user => mock(Object, :login => 'matz'))
+      parser = create_parser(nil, nil, controller)
+      parser.relevant_info[:user_info].should == nil
+    end
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification 
+name: rails_exception_handler
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Sharagoz
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-17 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: ""
+email: contact@sharagoz.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENCE
+- README.markdown
+- Rakefile
+- VERSION
+- app/controllers/error_response_controller.rb
+- app/models/error_message.rb
+- lib/patch/show_exceptions.rb
+- lib/rails_exception_handler.rb
+- lib/rails_exception_handler/configuration.rb
+- lib/rails_exception_handler/handler.rb
+- lib/rails_exception_handler/parser.rb
+- rails_exception_handler.gemspec
+- spec/integration/configuration_spec.rb
+- spec/integration/rails_exception_handler_spec.rb
+- spec/spec_helper.rb
+- spec/test_macros.rb
+- spec/testapp_30/.gitignore
+- spec/testapp_30/Gemfile
+- spec/testapp_30/Gemfile.lock
+- spec/testapp_30/Rakefile
+- spec/testapp_30/app/controllers/application_controller.rb
+- spec/testapp_30/app/controllers/home_controller.rb
+- spec/testapp_30/app/helpers/application_helper.rb
+- spec/testapp_30/app/models/stored_exception.rb
+- spec/testapp_30/app/views/home/view_error.html.erb
+- spec/testapp_30/app/views/layouts/fallback.html.erb
+- spec/testapp_30/app/views/layouts/home.html.erb
+- spec/testapp_30/config.ru
+- spec/testapp_30/config/application.rb
+- spec/testapp_30/config/boot.rb
+- spec/testapp_30/config/database.yml
+- spec/testapp_30/config/environment.rb
+- spec/testapp_30/config/environments/development.rb
+- spec/testapp_30/config/environments/production.rb
+- spec/testapp_30/config/environments/test.rb
+- spec/testapp_30/config/examples/database.yml
+- spec/testapp_30/config/locales/en.yml
+- spec/testapp_30/config/routes.rb
+- spec/testapp_30/db/migrate/20110630174538_create_error_messages.rb
+- spec/testapp_30/db/migrate/20110702131654_add_sessions_table.rb
+- spec/testapp_30/db/schema.rb
+- spec/testapp_30/db/seeds.rb
+- spec/testapp_30/lib/tasks/.gitkeep
+- spec/testapp_30/script/rails
+- spec/testapp_30/script/setup
+- spec/testapp_30/vendor/plugins/.gitkeep
+- spec/unit/configuration_spec.rb
+- spec/unit/handler_spec.rb
+- spec/unit/parser_spec.rb
+has_rdoc: true
+homepage: http://github.com/Sharagoz/rails_exception_handler
+licenses: 
+- MIT
+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: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Exception Handling for Rails 3
+test_files: []
+