rails_exception_handler 2.3.5 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32267ce6778cb1486e485a000b8482d24b5bd360
-  data.tar.gz: 767c02c57f3382f54d447dad4c9adf3902467d2a
+  metadata.gz: f1f7fe95e0609f50a4e9b019cc4c685aec54d4a9
+  data.tar.gz: 7cf25f2fd396d8d98ad82f9aeda580a99bcd42a6
 SHA512:
-  metadata.gz: 45d7d4b55c3d36a96acfae8237899e065f3d1da54b00ac67cd3bd250b0ca2d8ac367d4bcbe5c8ec4f222cd78e4714404fea80324efeb49472652dec79893adc2
-  data.tar.gz: 820ffdb2a5f84bc7626328f7f6219f21f640564d570613fed23111c7d6dd6ca962d08869f61b5e363d714a4ca1b4e587dc9ad744cf1cb9198670eae2d487b1b2
+  metadata.gz: '08740c06d7c7e5de8b75e2dc693d40d6aed88c3f7ee1b2b141f3b4599a719cb9931cc5c47316238f6f0c936967541c0581b6980880ecc55ae2e329e3ea01fd7d'
+  data.tar.gz: 26b7059fd57c9b393eb50cf04d264b9646c82a819161a5516022321d11b50b4e870d5bedb84f12fac2754c9f2c0b53b71431e931a0a306b33a79540972526fa9

data/Gemfile

@@ -1,5 +1,6 @@
 source "http://rubygems.org"
 ruby File.read(".ruby-version").strip
+#ruby '1.9.3', :patchlevel => "125"
 
 group :test, :development do
 
@@ -7,10 +8,12 @@ group :test, :development do
    #gem "rack-test", '0.5.7'
    #gem 'mongoid'
    #gem 'bson_ext'
+   #gem 'nokogiri', '1.6.8.1'
 
   #gem "rails", '3.2.22.5'
    #gem "rack-test", '0.6.2'
    #gem 'mongoid'
+   #gem 'nokogiri', '1.6.8.1'
 
   #gem "rails", '4.0.13'
     #gem "rack-test", '0.6.3'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rails_exception_handler (2.3.4)
+    rails_exception_handler (2.4.0)
 
 GEM
   remote: http://rubygems.org/
@@ -45,14 +45,14 @@ GEM
       tzinfo (~> 1.1)
     addressable (2.4.0)
     arel (8.0.0)
-    bson (4.2.1)
+    bson (4.2.2)
     builder (3.2.3)
     coderay (1.1.1)
     concurrent-ruby (1.0.5)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.3)
-    erubi (1.6.0)
+    erubi (1.6.1)
     faraday (0.9.2)
       multipart-post (>= 1.2, < 3)
     git (1.3.0)
@@ -65,10 +65,10 @@ GEM
       oauth2 (~> 1.0)
     globalid (0.4.0)
       activesupport (>= 4.2.0)
-    hashie (3.5.5)
+    hashie (3.5.6)
     highline (1.7.8)
-    i18n (0.8.4)
-    jeweler (2.3.6)
+    i18n (0.8.6)
+    jeweler (2.3.7)
       builder
       bundler (>= 1)
       git (>= 1.2.5)
@@ -87,10 +87,10 @@ GEM
     method_source (0.8.2)
     mime-types (2.99.3)
     mini_portile2 (2.2.0)
-    minitest (5.10.2)
-    mongo (2.4.2)
+    minitest (5.10.3)
+    mongo (2.4.3)
       bson (>= 4.2.1, < 5.0.0)
-    mongoid (6.2.0)
+    mongoid (6.2.1)
       activemodel (~> 5.1)
       mongo (>= 2.4.1, < 3.0.0)
     multi_json (1.12.1)
@@ -165,7 +165,7 @@ GEM
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
     sqlite3 (1.3.13)
-    thor (0.19.4)
+    thor (0.20.0)
     thread_safe (0.3.6)
     tzinfo (1.2.3)
       thread_safe (~> 0.1)
@@ -191,4 +191,4 @@ RUBY VERSION
    ruby 2.4.1p111
 
 BUNDLED WITH
-   1.15.1
+   1.15.4

data/HISTORY

@@ -1,5 +1,8 @@
 CHANGELOG
 
+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
 

data/README.markdown

@@ -235,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.
@@ -298,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 © 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.5
+2.4.0

data/app/mailers/rails_exception_handler/error_mailer.rb

@@ -0,0 +1,15 @@
+if(RailsExceptionHandler.configuration.activate?)
+  class RailsExceptionHandler::ErrorMailer < ApplicationMailer
+
+    # 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/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/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

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_later
+    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,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: rails_exception_handler 2.3.5 ruby lib
+# stub: rails_exception_handler 2.4.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "rails_exception_handler".freeze
-  s.version = "2.3.5"
+  s.version = "2.4.0"
 
   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 = "2017-06-19"
+  s.date = "2017-08-29"
   s.description = "".freeze
   s.email = "contact@sharagoz.com".freeze
   s.extra_rdoc_files = [
@@ -28,8 +28,11 @@ 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",
@@ -85,7 +88,7 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/Sharagoz/rails_exception_handler".freeze
   s.licenses = ["MIT".freeze]
   s.rubygems_version = "2.6.12".freeze
-  s.summary = "Exception Handling for Rails 3".freeze
+  s.summary = "Highly customizable exception handling for Ruby on Rails".freeze
 
   if s.respond_to? :specification_version then
     s.specification_version = 4

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_exception_handler
 version: !ruby/object:Gem::Version
-  version: 2.3.5
+  version: 2.4.0
 platform: ruby
 authors:
 - Sharagoz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-19 00:00:00.000000000 Z
+date: 2017-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -153,8 +153,11 @@ files:
 - 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
@@ -229,5 +232,5 @@ rubyforge_project:
 rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
-summary: Exception Handling for Rails 3
+summary: Highly customizable exception handling for Ruby on Rails
 test_files: []