rails_exception_handler 2.3.4 → 2.4.5

data/HISTORY

@@ -1,6 +1,15 @@
 CHANGELOG
 
-v2.3.3 - April 24th 2014
+v2.4.1
+- Fix issue with missing ApplicationMailer
+
+v2.4.0
+- Email storage strategy, by https://github.com/lethunder
+
+v2.3.5 - June 19th 2017
+- Fix compatibility with Ruby 2.4 and Rails 5
+
+v2.3.4 - April 24th 2014
 - Make database name/table configurable for the Active Record storage strategy
 
 v2.3.2 - January 7th 2014

data/README.markdown

@@ -6,7 +6,7 @@ This is a flexible exception handler for Rails intended for those who wish to cr
 
 The exception handler enables you to save the key information from the error message in a database somewhere, via ActiveRecord or HTTP POST, and display a customized error message to the user within the applications layout file. You can hook this exception handler into all your rails apps and gather the exception reports in one place. The exception handler just contains the back end, you will have to create your own front end to view and manage the error reports. A Rails Engine admin interface, [rails_exception_handler_admin](https://github.com/mgwidmann/rails_exception_handler_admin), is a simple drop in interface or to use as an example for building your own.
 
-Does your app have an authorization mechanism? [See wiki](https://github.com/Sharagoz/rails_exception_handler/wiki/Interaction-with-authorization-mechanisms)
+Does your app have an authorization mechanism like Pundit, CanCan or Delarative authorization? [See wiki](https://github.com/Sharagoz/rails_exception_handler/wiki/Interaction-with-authorization-mechanisms)
 
 Do you need to catch ruby errors [outside of Rack](https://github.com/Sharagoz/rails_exception_handler/wiki/Manual-exception-handling-outside-of-rack)?
 ```ruby
@@ -17,7 +17,7 @@ end
 
 ## Compatiblity
 
-The gem should work with all versions of Rails 3 and 4. It does not work with Rails 2.
+The gem should work with all versions of Rails 3, 4, 5 and 6.
 
 See Travis-CI for info on which rubies it is tested against:
 http://travis-ci.org/#!/Sharagoz/rails_exception_handler
@@ -50,6 +50,8 @@ Default value: [:production]
 
 ### fallback_layout
 
+WARNING: This feature is currently broken in Rails v4.2 and above. Make sure your app has the default layout file (layouts/application).
+
 ```ruby
 config.fallback_layout = 'home'
 ```
@@ -233,6 +235,21 @@ config.storage_strategies = [:remote_url => {:target => 'http://example.com/erro
 This option is meant for those who want to store the exception in a database table, but does not have direct access to the database itself, making active record store unsuitable. You need a web app on a server that has access to the database. An HTTP POST request will be sent to the specified URL with the error message as data.
 If you use a Rails app at the other end you should simply be able to do `RailsExceptionHandler::ActiveRecord::ErrorMessage.create(params[:error_message])` or `RailsExceptionHandler::Mongoid::ErrorMessage.create(params[:error_message])` to save the report depending upon your database choice.
 
+### Sending the error report as an email
+
+```ruby
+config.storage_strategies = [:email => {:recipients => "test1@example.com,test2@example.com"}]
+```
+
+Exceptions will be notified by email. Make sure the application got an
+`ApplicationMailer` with default from specified:
+
+```ruby
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+end
+```
+
 # Exception filters
 
 Sometimes it is necessary to filter errors. All filters are disabled by default and I recommend you deploy your application this way initially, and then add filters as they become necessary.
@@ -296,10 +313,6 @@ config.filters = [:referer_url_regxp => /\problematicreferer/i]
 
 https://github.com/Sharagoz/rails_exception_handler/graphs/contributors
 
-Would you like to contribute? Here are some things on the todo list:
-
-* An email storage strategy for those that wish to be notified of the exceptions through email
-
 # Licence
 
-Copyright © 2014 Bjørn Trondsen, released under the MIT license
+Copyright © 2017 Bjørn Trondsen, released under the MIT license

data/Rakefile

@@ -21,7 +21,7 @@ Jeweler::Tasks.new do |gem|
   gem.name = "rails_exception_handler"
   gem.homepage = "http://github.com/Sharagoz/rails_exception_handler"
   gem.license = "MIT"
-  gem.summary = %Q{Exception Handling for Rails 3}
+  gem.summary = %Q{Highly customizable exception handling for Ruby on Rails}
   gem.description = %Q{}
   gem.email = "contact@sharagoz.com"
   gem.authors = ["Sharagoz"]

data/VERSION

@@ -1 +1 @@
-2.3.4
+2.4.5

data/app/controllers/error_response_controller.rb

@@ -1,11 +1,27 @@
 if(RailsExceptionHandler.configuration.activate?)
   class ErrorResponseController < ApplicationController
+
+    if Rails::VERSION::MAJOR > 3
+      skip_before_action :verify_authenticity_token
+    else
+      skip_before_filter :verify_authenticity_token
+    end
+
+
     def index
-      render(:text => @_env['exception_handler.response'], :layout => @_env['exception_handler.layout'])
+      if Rails::VERSION::MAJOR > 4
+        render(:html => request.env['exception_handler.response'].html_safe, :layout => request.env['exception_handler.layout'])
+      else
+        render(:text => @_env['exception_handler.response'], :layout => @_env['exception_handler.layout'])
+      end
     end
 
     def dummy_action
-      render :nothing => true
+      if Rails::VERSION::MAJOR > 4
+        render :body => nil
+      else
+        render :nothing => true
+      end
     end
   end
 end

data/app/mailers/rails_exception_handler/error_mailer.rb

@@ -0,0 +1,15 @@
+class RailsExceptionHandler::ErrorMailer < ApplicationMailer
+  if RailsExceptionHandler.configuration.activate? && RailsExceptionHandler.configuration.email?
+
+    # Subject can be set in your I18n file at config/locales/en.yml
+    # with the following lookup:
+    #
+    #   en.error_mailer.send_error_mail_to_admin.subject
+    #
+    def send_error_mail_to_admin(info,email)
+      @info = JSON.parse(info)
+      mail(to: email, subject: 'An error occured on your application')
+    end
+    
+  end
+end

data/app/models/rails_exception_handler/active_record/error_message.rb

@@ -2,7 +2,7 @@ class RailsExceptionHandler::ActiveRecord
 
   class ErrorMessage < defined?(ActiveRecord) ? ActiveRecord::Base : Object
     if (defined?(ActiveRecord) && RailsExceptionHandler.configuration.activate? && RailsExceptionHandler.configuration.active_record?)
-      establish_connection(RailsExceptionHandler.configuration.active_record_store_in[:database])
+      establish_connection(RailsExceptionHandler.configuration.active_record_store_in[:database].to_sym)
       self.table_name = RailsExceptionHandler.configuration.active_record_store_in[:record_table]
     end
   end

data/app/models/rails_exception_handler/mongoid/error_message.rb

@@ -4,6 +4,7 @@ class RailsExceptionHandler::Mongoid
     if defined?(Mongoid)
       include Mongoid::Document
       include Mongoid::Timestamps
+      include Mongoid::Attributes::Dynamic if defined?(Mongoid::Attributes::Dynamic)
 
       store_in({:database => :exception_database, :collection => :error_message}.merge(RailsExceptionHandler.configuration.mongoid_store_in || {}))
 

data/app/views/rails_exception_handler/error_mailer/send_error_mail_to_admin.html.erb

@@ -0,0 +1,15 @@
+<p>
+    Hi boss,
+</p>
+<p>
+    an error occured at <%= @info["created_at"] %>
+</p>
+
+<% @info.each do |key, value| %>
+  <% next if value.blank? %>
+  <p>
+    <%= key.upcase %><br/>
+    <%= value %>
+  </p>
+
+<% end %>

data/app/views/rails_exception_handler/error_mailer/send_error_mail_to_admin.text.erb

@@ -0,0 +1,8 @@
+Hi boss,
+an error occured at <%= @info["created_at"] %>
+
+<% @info.each do |key, value| %>
+  <% next if value.blank? %>
+    <%= key.upcase %>
+    <%= value %>
+<% end %>

data/gemfiles/rails32.gemfile

@@ -2,7 +2,7 @@
 source "https://rubygems.org"
 
 group :test, :development do
-  gem "rails", '3.2.13'
+  gem "rails", '3.2.22.5'
   gem "rack-test", '0.6.2'
   gem 'rake' # Needed by tavis
   gem 'sqlite3'

data/gemfiles/rails40.gemfile

@@ -2,10 +2,11 @@
 source "https://rubygems.org"
 
 group :test, :development do
-  gem "rails", '4.0.0'
+  gem "rails", '4.0.13'
   gem "rack-test", '0.6.2'
   gem 'rake' # Needed by tavis
   gem 'sqlite3'
+  gem 'mongoid'
   gem 'pry'
   gem "rspec-rails"
   gem "jeweler"

data/gemfiles/rails42.gemfile

@@ -0,0 +1,14 @@
+# encoding: utf-8
+source "https://rubygems.org"
+
+group :test, :development do
+  gem "rails", '4.2.8'
+  gem "rack-test", '0.6.2'
+  gem 'rake' # Needed by tavis
+  gem 'sqlite3'
+  gem 'mongoid'
+  gem 'pry'
+  gem "rspec-rails"
+  gem "jeweler"
+  gem "rails_exception_handler"
+end

data/gemfiles/rails51.gemfile

@@ -0,0 +1,14 @@
+# encoding: utf-8
+source "https://rubygems.org"
+
+group :test, :development do
+  gem "rails", '5.1.1'
+  gem "rack-test", '0.6.2'
+  gem 'rake' # Needed by tavis
+  gem 'sqlite3'
+  gem 'mongoid'
+  gem 'pry'
+  gem "rspec-rails"
+  gem "jeweler"
+  gem "rails_exception_handler"
+end

data/lib/generators/rails_exception_handler/templates/rails_exception_handler.rb

@@ -39,25 +39,25 @@ RailsExceptionHandler.configure do |config|
 
 
   config.store_request_info do |storage,request|
-    storage[:target_url] =    request.url
-    storage[:referer_url] =   request.referer
-    storage[:params] =        request.params.inspect
-    storage[:user_agent] =    request.user_agent
+    storage[:target_url]  = request.url
+    storage[:referer_url] = request.referer
+    storage[:params]      = request.params.inspect
+    storage[:user_agent]  = request.user_agent
   end
 
   config.store_exception_info do |storage,exception|
-    storage[:class_name] =   exception.class.to_s
-    storage[:message] =      exception.to_s
-    storage[:trace] =        exception.backtrace.join("\n")
+    storage[:class_name] = exception.class.to_s
+    storage[:message]    = exception.to_s
+    storage[:trace]      = exception.backtrace.join("\n")
   end
 
   config.store_environment_info do |storage,env|
-    storage[:doc_root] =      env['DOCUMENT_ROOT']
+    storage[:doc_root] = env['DOCUMENT_ROOT']
   end
 
   config.store_global_info do |storage|
-    storage[:app_name] =     Rails.application.class.parent_name
-    storage[:created_at] =   Time.now
+    storage[:app_name]   = Rails.application.class.parent_name
+    storage[:created_at] = Time.now
   end
   # config.store_user_info = {:method => :current_user, :field => :login} # Helper method for easier access to current_user
 end

data/lib/patch/show_exceptions.rb

@@ -3,12 +3,14 @@ module ActionDispatch
   class ShowExceptions
     private
       def render_exception_with_template(env, exception)
+        env = env.env if env.is_a?(ActionDispatch::Request) # Rails 5 passes in the whole request object
         if(RailsExceptionHandler.configuration.environments.include?(Rails.env.to_sym))
           RailsExceptionHandler::Handler.new(env, exception).handle_exception
         else
           raise "RailsExceptionHandler: This patch should not have been loaded"
         end
       end
-      alias_method_chain :render_exception, :template
+      alias_method :render_exception, :render_exception_with_template
+      alias_method :template, :render_exception
   end
 end

data/lib/rails_exception_handler/configuration.rb

@@ -23,6 +23,10 @@ class RailsExceptionHandler::Configuration
     @storage_strategies.include?(:mongoid)
   end
 
+  def email?
+    @storage_strategies.collect{|s| s.is_a?(Hash) ? s.keys : s}.flatten.include?(:email)
+  end
+
   def activate?
     environments.include?(Rails.env.to_sym)
   end

data/lib/rails_exception_handler/handler.rb

@@ -32,6 +32,8 @@ class RailsExceptionHandler::Handler
         RailsExceptionHandler::Storage.send(strategy, @parsed_error.external_info)
       elsif(strategy.class == Hash && strategy[:remote_url])
         RailsExceptionHandler::Storage.remote_url(strategy[:remote_url][:target],@parsed_error.external_info)
+      elsif(strategy.class == Hash && strategy[:email])
+        RailsExceptionHandler::Storage.email(strategy[:email][:recipients],@parsed_error.external_info)
       else
         raise "RailsExceptionHandler: Unknown storage strategy #{strategy.inspect}"
       end
@@ -42,14 +44,26 @@ class RailsExceptionHandler::Handler
     @env['exception_handler.layout'] = response_layout
     @env['exception_handler.response'] = response_text
     response = ErrorResponseController.action(:index).call(@env)
+
     if @parsed_error.routing_error? 
       response[0] = 404
       file = "#{Rails.root}/public/404.html"
-      response[2].body = File.read(file) if File.exists?(file)
+      response = override_body_with_file_if_exists(response, file)
     else
       response[0] = 500
       file = "#{Rails.root}/public/500.html"
-      response[2].body = File.read(file) if File.exists?(file)
+      response = override_body_with_file_if_exists(response, file)
+    end
+    return response
+  end
+
+  def override_body_with_file_if_exists(response, file)
+    return response unless File.exists?(file)
+
+    if defined? response[2].body=()
+      response[2].body = File.read(file)
+    else # Rails >= 4.2.0
+      response[2] = [File.read(file)]
     end
     return response
   end
@@ -58,7 +72,15 @@ class RailsExceptionHandler::Handler
     if(@request.xhr?)
       false
     else
-      default_layout = @controller.send(:_default_layout)
+      if Rails::VERSION::MAJOR > 5
+        paths = @controller.view_paths
+        lookup_context = ActionView::LookupContext.new(paths)
+        default_layout = @controller.send(:_default_layout, lookup_context, [:html])
+      elsif Rails::VERSION::MAJOR > 4
+        default_layout = @controller.send(:_default_layout, [:html])
+      else
+        default_layout = @controller.send(:_default_layout)
+      end
       if(default_layout.class.to_s == "ActionView::Template")
         layout = default_layout.virtual_path
       else

data/lib/rails_exception_handler/storage.rb

@@ -29,6 +29,17 @@ class RailsExceptionHandler::Storage
     Net::HTTP::post_form(uri, params)
   end
 
+  # Notify application admin that an error occured
+  def self.email(recipients,info)
+    return if recipients.blank?
+    if Rails::VERSION::MAJOR == 3 || (Rails::VERSION::MAJOR == 4 && Rails::VERSION::MINOR < 2)
+      delivery_method = :deliver
+    else
+      delivery_method = :deliver_now
+    end
+    RailsExceptionHandler::ErrorMailer.send_error_mail_to_admin(info.to_json,recipients).send(delivery_method)
+  end
+
   private
 
   # Credit: Hash flattening technique borrowed from Peter Marklund: http://marklunds.com/articles/one/314

data/rails_exception_handler.gemspec

@@ -2,20 +2,23 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+# stub: rails_exception_handler 2.4.5 ruby lib
 
 Gem::Specification.new do |s|
-  s.name = "rails_exception_handler"
-  s.version = "2.3.4"
+  s.name = "rails_exception_handler".freeze
+  s.version = "2.4.5"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Sharagoz"]
-  s.date = "2014-04-24"
-  s.description = ""
-  s.email = "contact@sharagoz.com"
+  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib".freeze]
+  s.authors = ["Sharagoz".freeze]
+  s.date = "2019-10-03"
+  s.description = "".freeze
+  s.email = "contact@sharagoz.com".freeze
   s.extra_rdoc_files = [
     "README.markdown"
   ]
   s.files = [
+    ".ruby-version",
     ".travis.yml",
     "Gemfile",
     "Gemfile.lock",
@@ -25,12 +28,17 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "app/controllers/error_response_controller.rb",
+    "app/mailers/rails_exception_handler/error_mailer.rb",
     "app/models/rails_exception_handler/active_record/error_message.rb",
     "app/models/rails_exception_handler/mongoid/error_message.rb",
+    "app/views/rails_exception_handler/error_mailer/send_error_mail_to_admin.html.erb",
+    "app/views/rails_exception_handler/error_mailer/send_error_mail_to_admin.text.erb",
     "gemfiles/rails30.gemfile",
     "gemfiles/rails32.187-ree.gemfile",
     "gemfiles/rails32.gemfile",
     "gemfiles/rails40.gemfile",
+    "gemfiles/rails42.gemfile",
+    "gemfiles/rails51.gemfile",
     "lib/generators/rails_exception_handler/install_generator.rb",
     "lib/generators/rails_exception_handler/templates/rails_exception_handler.rb",
     "lib/patch/show_exceptions.rb",
@@ -44,57 +52,84 @@ Gem::Specification.new do |s|
     "rails_exception_handler.gemspec",
     "spec/dummy_30/.gitignore",
     "spec/dummy_30/lib/tasks/.gitkeep",
+    "spec/dummy_30/public/.gitkeep",
     "spec/dummy_32/.gitignore",
     "spec/dummy_32/app/mailers/.gitkeep",
     "spec/dummy_32/app/models/.gitkeep",
     "spec/dummy_32/log/.gitkeep",
+    "spec/dummy_32/public/.gitkeep",
     "spec/dummy_40/.gitignore",
     "spec/dummy_40/app/assets/images/.keep",
-    "spec/dummy_40/app/controllers/concerns/.keep",
     "spec/dummy_40/app/mailers/.keep",
     "spec/dummy_40/app/models/.keep",
-    "spec/dummy_40/app/models/concerns/.keep",
     "spec/dummy_40/lib/assets/.keep",
     "spec/dummy_40/lib/tasks/.keep",
-    "spec/dummy_40/log/.keep"
+    "spec/dummy_40/log/.keep",
+    "spec/dummy_40/public/.gitkeep",
+    "spec/dummy_42/.gitignore",
+    "spec/dummy_42/app/assets/images/.keep",
+    "spec/dummy_42/app/mailers/.keep",
+    "spec/dummy_42/app/models/.keep",
+    "spec/dummy_42/lib/assets/.keep",
+    "spec/dummy_42/lib/tasks/.keep",
+    "spec/dummy_42/log/.keep",
+    "spec/dummy_42/public/.gitkeep",
+    "spec/dummy_51/.gitignore",
+    "spec/dummy_51/.ruby-version",
+    "spec/dummy_51/app/assets/images/.keep",
+    "spec/dummy_51/app/assets/javascripts/channels/.keep",
+    "spec/dummy_51/app/controllers/concerns/.keep",
+    "spec/dummy_51/app/models/concerns/.keep",
+    "spec/dummy_51/lib/assets/.keep",
+    "spec/dummy_51/lib/tasks/.keep",
+    "spec/dummy_51/log/.keep",
+    "spec/dummy_51/tmp/.keep",
+    "spec/dummy_60/.gitignore",
+    "spec/dummy_60/.ruby-version",
+    "spec/dummy_60/app/assets/images/.keep",
+    "spec/dummy_60/app/controllers/concerns/.keep",
+    "spec/dummy_60/app/models/concerns/.keep",
+    "spec/dummy_60/lib/assets/.keep",
+    "spec/dummy_60/lib/tasks/.keep",
+    "spec/dummy_60/log/.keep",
+    "spec/dummy_60/tmp/.keep"
   ]
-  s.homepage = "http://github.com/Sharagoz/rails_exception_handler"
-  s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.25"
-  s.summary = "Exception Handling for Rails 3"
+  s.homepage = "http://github.com/Sharagoz/rails_exception_handler".freeze
+  s.licenses = ["MIT".freeze]
+  s.rubygems_version = "3.0.4".freeze
+  s.summary = "Highly customizable exception handling for Ruby on Rails".freeze
 
   if s.respond_to? :specification_version then
-    s.specification_version = 3
+    s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rails>, ["= 4.0.2"])
-      s.add_development_dependency(%q<rack-test>, ["= 0.6.2"])
-      s.add_development_dependency(%q<rake>, [">= 0"])
-      s.add_development_dependency(%q<sqlite3>, [">= 0"])
-      s.add_development_dependency(%q<pry>, [">= 0"])
-      s.add_development_dependency(%q<rspec-rails>, [">= 0"])
-      s.add_development_dependency(%q<jeweler>, [">= 0"])
-      s.add_development_dependency(%q<rails_exception_handler>, [">= 0"])
+      s.add_development_dependency(%q<rails>.freeze, ["= 6.0.0"])
+      s.add_development_dependency(%q<rack-test>.freeze, ["= 0.6.3"])
+      s.add_development_dependency(%q<sqlite3>.freeze, ["= 1.4.1"])
+      s.add_development_dependency(%q<rake>.freeze, [">= 0"])
+      s.add_development_dependency(%q<pry>.freeze, [">= 0"])
+      s.add_development_dependency(%q<rspec-rails>.freeze, ["= 3.6.0"])
+      s.add_development_dependency(%q<jeweler>.freeze, [">= 0"])
+      s.add_development_dependency(%q<rails_exception_handler>.freeze, [">= 0"])
     else
-      s.add_dependency(%q<rails>, ["= 4.0.2"])
-      s.add_dependency(%q<rack-test>, ["= 0.6.2"])
-      s.add_dependency(%q<rake>, [">= 0"])
-      s.add_dependency(%q<sqlite3>, [">= 0"])
-      s.add_dependency(%q<pry>, [">= 0"])
-      s.add_dependency(%q<rspec-rails>, [">= 0"])
-      s.add_dependency(%q<jeweler>, [">= 0"])
-      s.add_dependency(%q<rails_exception_handler>, [">= 0"])
+      s.add_dependency(%q<rails>.freeze, ["= 6.0.0"])
+      s.add_dependency(%q<rack-test>.freeze, ["= 0.6.3"])
+      s.add_dependency(%q<sqlite3>.freeze, ["= 1.4.1"])
+      s.add_dependency(%q<rake>.freeze, [">= 0"])
+      s.add_dependency(%q<pry>.freeze, [">= 0"])
+      s.add_dependency(%q<rspec-rails>.freeze, ["= 3.6.0"])
+      s.add_dependency(%q<jeweler>.freeze, [">= 0"])
+      s.add_dependency(%q<rails_exception_handler>.freeze, [">= 0"])
     end
   else
-    s.add_dependency(%q<rails>, ["= 4.0.2"])
-    s.add_dependency(%q<rack-test>, ["= 0.6.2"])
-    s.add_dependency(%q<rake>, [">= 0"])
-    s.add_dependency(%q<sqlite3>, [">= 0"])
-    s.add_dependency(%q<pry>, [">= 0"])
-    s.add_dependency(%q<rspec-rails>, [">= 0"])
-    s.add_dependency(%q<jeweler>, [">= 0"])
-    s.add_dependency(%q<rails_exception_handler>, [">= 0"])
+    s.add_dependency(%q<rails>.freeze, ["= 6.0.0"])
+    s.add_dependency(%q<rack-test>.freeze, ["= 0.6.3"])
+    s.add_dependency(%q<sqlite3>.freeze, ["= 1.4.1"])
+    s.add_dependency(%q<rake>.freeze, [">= 0"])
+    s.add_dependency(%q<pry>.freeze, [">= 0"])
+    s.add_dependency(%q<rspec-rails>.freeze, ["= 3.6.0"])
+    s.add_dependency(%q<jeweler>.freeze, [">= 0"])
+    s.add_dependency(%q<rails_exception_handler>.freeze, [">= 0"])
   end
 end