exception_notification 2.5.2 → 2.6.0.rc1

data/Gemfile.lock

@@ -1,78 +1,89 @@
 PATH
   remote: .
   specs:
-    exception_notification (2.4.1)
+    exception_notification (2.5.2)
       actionmailer (>= 3.0.4)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    abstract (1.0.0)
-    actionmailer (3.0.9)
-      actionpack (= 3.0.9)
-      mail (~> 2.2.19)
-    actionpack (3.0.9)
-      activemodel (= 3.0.9)
-      activesupport (= 3.0.9)
-      builder (~> 2.1.2)
-      erubis (~> 2.6.6)
-      i18n (~> 0.5.0)
-      rack (~> 1.2.1)
-      rack-mount (~> 0.6.14)
-      rack-test (~> 0.5.7)
-      tzinfo (~> 0.3.23)
-    activemodel (3.0.9)
-      activesupport (= 3.0.9)
-      builder (~> 2.1.2)
-      i18n (~> 0.5.0)
-    activerecord (3.0.9)
-      activemodel (= 3.0.9)
-      activesupport (= 3.0.9)
-      arel (~> 2.0.10)
-      tzinfo (~> 0.3.23)
-    activeresource (3.0.9)
-      activemodel (= 3.0.9)
-      activesupport (= 3.0.9)
-    activesupport (3.0.9)
-    arel (2.0.10)
-    builder (2.1.2)
-    erubis (2.6.6)
-      abstract (>= 1.0.0)
-    i18n (0.5.0)
-    mail (2.2.19)
-      activesupport (>= 2.3.6)
+    actionmailer (3.2.3)
+      actionpack (= 3.2.3)
+      mail (~> 2.4.4)
+    actionpack (3.2.3)
+      activemodel (= 3.2.3)
+      activesupport (= 3.2.3)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.1)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.2)
+    activemodel (3.2.3)
+      activesupport (= 3.2.3)
+      builder (~> 3.0.0)
+    activerecord (3.2.3)
+      activemodel (= 3.2.3)
+      activesupport (= 3.2.3)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.3)
+      activemodel (= 3.2.3)
+      activesupport (= 3.2.3)
+    activesupport (3.2.3)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.0)
+    erubis (2.7.0)
+    hike (1.2.1)
+    i18n (0.6.0)
+    journey (1.0.3)
+    json (1.6.6)
+    mail (2.4.4)
       i18n (>= 0.4.0)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
-    mime-types (1.16)
-    polyglot (0.3.2)
-    rack (1.2.3)
-    rack-mount (0.6.14)
-      rack (>= 1.0.0)
-    rack-test (0.5.7)
+    mime-types (1.18)
+    multi_json (1.2.0)
+    polyglot (0.3.3)
+    rack (1.4.1)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
       rack (>= 1.0)
-    rails (3.0.9)
-      actionmailer (= 3.0.9)
-      actionpack (= 3.0.9)
-      activerecord (= 3.0.9)
-      activeresource (= 3.0.9)
-      activesupport (= 3.0.9)
+    rails (3.2.3)
+      actionmailer (= 3.2.3)
+      actionpack (= 3.2.3)
+      activerecord (= 3.2.3)
+      activeresource (= 3.2.3)
+      activesupport (= 3.2.3)
       bundler (~> 1.0)
-      railties (= 3.0.9)
-    railties (3.0.9)
-      actionpack (= 3.0.9)
-      activesupport (= 3.0.9)
+      railties (= 3.2.3)
+    railties (3.2.3)
+      actionpack (= 3.2.3)
+      activesupport (= 3.2.3)
+      rack-ssl (~> 1.3.2)
       rake (>= 0.8.7)
       rdoc (~> 3.4)
-      thor (~> 0.14.4)
-    rake (0.9.2)
-    rdoc (3.8)
-    sqlite3 (1.3.4)
+      thor (~> 0.14.6)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    sprockets (2.1.2)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.5)
     thor (0.14.6)
+    tilt (1.3.3)
     treetop (1.4.10)
       polyglot
       polyglot (>= 0.3.1)
-    tzinfo (0.3.29)
+    tzinfo (0.3.32)
 
 PLATFORMS
   ruby

data/README.md

@@ -1,4 +1,4 @@
-Exception Notifier Plugin for Rails
+Exception Notifier Plugin for Rails ![project status](http://stillmaintained.com/smartinez87/exception_notification.png) [![Travis](http://travis-ci.org/smartinez87/exception_notification.png)](http://travis-ci.org/smartinez87/exception_notification)
 ====
 
 The Exception Notifier plugin provides a mailer object and a default set of
@@ -12,72 +12,178 @@ application. The plugin is configurable, allowing programmers to specify:
 The email includes information about the current request, session, and
 environment, and also gives a backtrace of the exception.
 
+There's a great [Railscast about Exception Notifications](http://railscasts.com/episodes/104-exception-notifications-revised)
+you can see that may help you getting started.
+
 Installation
 ---
 
 You can use the latest ExceptionNotification gem with Rails 3, by adding
 the following line in your Gemfile
 
-    gem 'exception_notification'
+```ruby
+gem 'exception_notification'
+```
 
 As of Rails 3 ExceptionNotification is used as a rack middleware, so you can
 configure its options on your config.ru file, or in the environment you
 want it to run. In most cases you would want ExceptionNotification to
 run on production. You can make it work by
 
-    Whatever::Application.config.middleware.use ExceptionNotifier,
-      :email_prefix => "[Whatever] ",
-      :sender_address => %{"notifier" <notifier@example.com>},
-      :exception_recipients => %w{exceptions@example.com}
+```ruby
+Whatever::Application.config.middleware.use ExceptionNotifier,
+  :email_prefix => "[Whatever] ",
+  :sender_address => %{"notifier" <notifier@example.com>},
+  :exception_recipients => %w{exceptions@example.com}
+```
 
 Customization
 ---
 
+### Sections
+
 By default, the notification email includes four parts: request, session,
 environment, and backtrace (in that order). You can customize how each of those
 sections are rendered by placing a partial named for that part in your
 app/views/exception_notifier directory (e.g., _session.rhtml). Each partial has
 access to the following variables:
 
-    @controller     # the controller that caused the error
-    @request        # the current request object
-    @exception      # the exception that was raised
-    @backtrace      # a sanitized version of the exception's backtrace
-    @data           # a hash of optional data values that were passed to the notifier
-    @sections       # the array of sections to include in the email
+```ruby
+@controller     # the controller that caused the error
+@request        # the current request object
+@exception      # the exception that was raised
+@backtrace      # a sanitized version of the exception's backtrace
+@data           # a hash of optional data values that were passed to the notifier
+@sections       # the array of sections to include in the email
+```
+
+Background views will not have access to @controller and @request.
 
 You can reorder the sections, or exclude sections completely, by altering the
 ExceptionNotifier.sections variable. You can even add new sections that
 describe application-specific data--just add the section's name to the list
-(wherever you'd like), and define the corresponding partial. 
-   
-    #Example with two new added sections
-    Whatever::Application.config.middleware.use ExceptionNotifier,
-	   :email_prefix => "[Whatever] ",
-	   :sender_address => %{"notifier" <notifier@example.com>},
-	   :exception_recipients => %w{exceptions@example.com},
-	   :sections => %w{my_section1 my_section2} + ExceptionNotifier::Notifier.default_sections
+(wherever you'd like), and define the corresponding partial.
+
+```ruby
+#Example with two new added sections
+Whatever::Application.config.middleware.use ExceptionNotifier,
+ :email_prefix => "[Whatever] ",
+ :sender_address => %{"notifier" <notifier@example.com>},
+ :exception_recipients => %w{exceptions@example.com},
+ :sections => %w{my_section1 my_section2} + ExceptionNotifier::Notifier.default_sections
+```
 
 If your new section requires information that isn't available by default, make sure
 it is made available to the email using the exception_data macro:
 
-    class ApplicationController < ActionController::Base
-      before_filter :log_additional_data
-      ...
-      protected
-        def log_additional_data
-          request.env["exception_notifier.exception_data"] = {
-            :document => @document,
-            :person => @person
-          }
-        end
-      ...
+```ruby
+class ApplicationController < ActionController::Base
+  before_filter :log_additional_data
+  ...
+  protected
+    def log_additional_data
+      request.env["exception_notifier.exception_data"] = {
+        :document => @document,
+        :person => @person
+      }
     end
+  ...
+end
+```
 
 In the above case, @document and @person would be made available to the email
 renderer, allowing your new section(s) to access and display them. See the
 existing sections defined by the plugin for examples of how to write your own.
 
+You may want to include different sections for background notifications:
+
+```ruby
+#Example with two new added sections
+Whatever::Application.config.middleware.use ExceptionNotifier,
+ :email_prefix => "[Whatever] ",
+ :sender_address => %{"notifier" <notifier@example.com>},
+ :exception_recipients => %w{exceptions@example.com},
+ :background_sections => %w{my_section1 my_section2} + ExceptionNotifier::Notifier.default_background_sections
+```
+
+By default, the backtrace and data sections are included in background
+notifications.
+
+### Ignore Exceptions
+
+You can choose to ignore certain exceptions, which will make
+ExceptionNotifier avoid sending notifications for those specified.
+There are three ways of specifying which exceptions to ignore:
+
+- `:ignore_exceptions` - By exception class (i.e. ignore RecordNotFound ones)
+
+- `:ignore_crawlers`   - From crawler (i.e. ignore ones originated by Googlebot)
+
+- `:ignore_if`         - Custom (i.e. ignore exceptions that satisfy some condition)
+
+---
+
+* _:ignore_exceptions_
+
+Ignore specified exception types.
+To achieve that, you should use the _:ignore_exceptions_ option, like this:
+
+```ruby
+Whatever::Application.config.middleware.use ExceptionNotifier,
+  :email_prefix         => "[Whatever] ",
+  :sender_address       => %{"notifier" <notifier@example.com>},
+  :exception_recipients => %w{exceptions@example.com},
+  :ignore_exceptions    => ['ActionView::TemplateError'] + ExceptionNotifier.default_ignore_exceptions
+```
+
+The above will make ExceptionNotifier ignore a *TemplateError*
+exception, plus the ones ignored by default.
+By default, ExceptionNotifier ignores _ActiveRecord::RecordNotFound_,
+_AbstractController::ActionNotFound_ and
+_ActionController::RountingError_.
+
+* _:ignore_crawlers_
+
+In some cases you may want to avoid getting notifications from exceptions
+made by crawlers. Using _:ignore_crawlers_ option like this,
+
+```ruby
+Whatever::Application.config.middleware.use ExceptionNotifier,
+  :email_prefix         => "[Whatever] ",
+  :sender_address       => %{"notifier" <notifier@example.com>},
+  :exception_recipients => %w{exceptions@example.com},
+  :ignore_crawlers      => %w{Googlebot bingbot}
+```
+
+will prevent sending those unwanted notifications.
+
+* _:ignore_if_
+
+Last but not least, you can ignore exceptions based on a condition, by
+
+```ruby
+Whatever::Application.config.middleware.use ExceptionNotifier,
+  :email_prefix         => "[Whatever] ",
+  :sender_address       => %{"notifier" <notifier@example.com>},
+  :exception_recipients => %w{exceptions@example.com},
+  :ignore_if            => lambda { |env, e| e.message =~ /^Couldn't find Page with ID=/ }
+```
+
+You can make use of both the environment and the exception inside the lambda to decide wether to
+avoid or not sending the notification.
+
+### Verbose
+
+You can also choose to exclude the exception message from the subject, which is included by default.
+Use _:verbose_subject => false_ to exclude it.
+
+### Normalize subject
+
+You can also choose to remove numbers from subject so they thread as a single one.
+This is disabled by default.
+Use _:normalize_subject => true_ to enable it.
+
+
 Background Notifications
 ---
 
@@ -85,11 +191,26 @@ If you want to send notifications from a background process like
 DelayedJob, you should use the background_exception_notification method
 like this:
 
-    begin
-      some code...
-    rescue => e
-      ExceptionNotifier::Notifier.background_exception_notification(e)
-    end
+```ruby
+begin
+  some code...
+rescue => e
+  ExceptionNotifier::Notifier.background_exception_notification(e)
+end
+```
+
+You can include information about the background process that created
+the error by including a data parameter:
+
+```ruby
+begin
+  some code...
+rescue => exception
+  ExceptionNotifier::Notifier.background_exception_notification(exception,
+    :data => {:worker => worker.to_s, :queue => queue, :payload => payload})
+end
+```
+
 
 Manually notify of exception
 ---
@@ -97,13 +218,16 @@ Manually notify of exception
 If your controller action manually handles an error, the notifier will never be
 run. To manually notify of an error you can do something like the following:
 
-    rescue_from Exception, :with => :server_error
+```ruby
+rescue_from Exception, :with => :server_error
 
-    def server_error(exception)
-      # Whatever code that handles the exception
+def server_error(exception)
+  # Whatever code that handles the exception
 
-      ExceptionNotifier::Notifier.exception_notification(request.env, exception).deliver
-    end
+  ExceptionNotifier::Notifier.exception_notification(request.env, exception,
+    :data => {:message => "was doing something wrong"}).deliver
+end
+```
 
 Notification
 ---
@@ -111,14 +235,32 @@ Notification
 After an exception notification has been delivered the rack environment variable
 'exception_notifier.delivered' will be set to +true+.
 
-Rails 2.3 stable and earlier
+Versions
 ---
 
-If you are running Rails 2.3 then see the branch for that: 
- 
+NOTE: Master branch is currently set for v2.6.0
+
+For v2.5.2, see this tag:
+
+<a href="http://github.com/smartinez87/exception_notification/tree/v2.5.2">http://github.com/smartinez87/exception_notification/tree/v2.5.2</a>
+
+For v2.5.0, see tag:
+
+<a href="http://github.com/smartinez87/exception_notification/tree/v2.5.0">http://github.com/smartinez87/exception_notification/tree/v2.5.0</a>
+
+For v2.4.1, see tag:
+
+<a href="http://github.com/smartinez87/exception_notification/tree/v2.4.1">http://github.com/smartinez87/exception_notification/tree/v2.4.1</a>
+
+For v2.4.0, see tag:
+
+<a href="http://github.com/smartinez87/exception_notification/tree/v2.4.0">http://github.com/smartinez87/exception_notification/tree/v2.4.0</a>
+
+If you are running Rails 2.3 then see the branch for that:
+
 <a href="http://github.com/smartinez87/exception_notification/tree/2-3-stable">http://github.com/smartinez87/exception_notification/tree/2-3-stable</a>
 
-If you are running pre-rack Rails then see this tag: 
+If you are running pre-rack Rails then see this tag:
 
 <a href="http://github.com/smartinez87/exception_notification/tree/pre-2-3">http://github.com/smartinez87/exception_notification/tree/pre-2-3</a>
 
@@ -127,4 +269,4 @@ Support and tickets
 
 <a href="https://github.com/smartinez87/exception_notification/issues">https://github.com/smartinez87/exception_notification/issues</a>
 
-Copyright (c) 2005 Jamis Buck, released under the MIT license
+Copyright (c) 2005 Jamis Buck, released under the MIT license: <a href="http://www.opensource.org/licenses/MIT">http://www.opensource.org/licenses/MIT</a>

data/exception_notification.gemspec

@@ -1,9 +1,10 @@
 Gem::Specification.new do |s|
   s.name = 'exception_notification'
-  s.version = '2.5.2'
+  s.version = '2.6.0.rc1'
   s.authors = ["Jamis Buck", "Josh Peek"]
-  s.date = %q{2011-08-29}
+  s.date = %q{2012-04-05}
   s.summary = "Exception notification by email for Rails apps"
+  s.homepage = "https://github.com/smartinez87/exception_notification"
   s.email = "smartinez87@gmail.com"
 
   s.files = `git ls-files`.split("\n")

data/lib/exception_notifier.rb

@@ -4,12 +4,16 @@ require 'exception_notifier/notifier'
 class ExceptionNotifier
   def self.default_ignore_exceptions
     [].tap do |exceptions|
-      exceptions << ::ActiveRecord::RecordNotFound if defined? ::ActiveRecord::RecordNotFound
-      exceptions << ::AbstractController::ActionNotFound if defined? ::AbstractController::ActionNotFound
-      exceptions << ::ActionController::RoutingError if defined? ::ActionController::RoutingError
+      exceptions << 'ActiveRecord::RecordNotFound'
+      exceptions << 'AbstractController::ActionNotFound'
+      exceptions << 'ActionController::RoutingError'
     end
   end
 
+  def self.default_ignore_crawlers
+    []
+  end
+
   def initialize(app, options = {})
     @app, @options = app, options
 
@@ -17,8 +21,13 @@ class ExceptionNotifier
     Notifier.default_exception_recipients = @options[:exception_recipients]
     Notifier.default_email_prefix         = @options[:email_prefix]
     Notifier.default_sections             = @options[:sections]
+    Notifier.default_background_sections  = @options[:background_sections]
+    Notifier.default_verbose_subject      = @options[:verbose_subject]
+    Notifier.default_normalize_subject    = @options[:normalize_subject]
 
     @options[:ignore_exceptions] ||= self.class.default_ignore_exceptions
+    @options[:ignore_crawlers]   ||= self.class.default_ignore_crawlers
+    @options[:ignore_if]         ||= lambda { |env, e| false }
   end
 
   def call(env)
@@ -27,11 +36,32 @@ class ExceptionNotifier
     options = (env['exception_notifier.options'] ||= Notifier.default_options)
     options.reverse_merge!(@options)
 
-    unless Array.wrap(options[:ignore_exceptions]).include?(exception.class)
+    unless ignored_exception(options[:ignore_exceptions], exception)       ||
+           from_crawler(options[:ignore_crawlers], env['HTTP_USER_AGENT']) ||
+           conditionally_ignored(options[:ignore_if], env, exception)
       Notifier.exception_notification(env, exception).deliver
       env['exception_notifier.delivered'] = true
     end
 
     raise exception
   end
+
+  private
+
+  def ignored_exception(ignore_array, exception)
+    Array.wrap(ignore_array).map(&:to_s).include?(exception.class.name)
+  end
+
+  def from_crawler(ignore_array, agent)
+    ignore_array.each do |crawler|
+      return true if (agent =~ Regexp.new(crawler))
+    end unless ignore_array.blank?
+    false
+  end
+
+  def conditionally_ignored(ignore_proc, env, exception)
+    ignore_proc.call(env, exception)
+  rescue Exception => ex
+    false
+  end
 end

data/lib/exception_notifier/notifier.rb

@@ -6,7 +6,6 @@ class ExceptionNotifier
     self.mailer_name = 'exception_notifier'
 
     #Append application view path to the ExceptionNotifier lookup context.
-    self.append_view_path Rails.root.nil? ? "app/views" : "#{Rails.root}/app/views"  if defined?(Rails)
     self.append_view_path "#{File.dirname(__FILE__)}/views"
 
     class << self
@@ -14,6 +13,9 @@ class ExceptionNotifier
       attr_writer :default_exception_recipients
       attr_writer :default_email_prefix
       attr_writer :default_sections
+      attr_writer :default_background_sections
+      attr_writer :default_verbose_subject
+      attr_writer :default_normalize_subject
 
       def default_sender_address
         @default_sender_address || %("Exception Notifier" <exception.notifier@default.com>)
@@ -31,11 +33,30 @@ class ExceptionNotifier
         @default_sections || %w(request session environment backtrace)
       end
 
+      def default_background_sections
+        @default_background_sections || %w(backtrace data)
+      end
+
+      def default_verbose_subject
+        @default_verbose_subject.nil? || @default_verbose_subject
+      end
+
+      def default_normalize_subject
+        @default_normalize_prefix || false
+      end
+
       def default_options
         { :sender_address => default_sender_address,
           :exception_recipients => default_exception_recipients,
           :email_prefix => default_email_prefix,
-          :sections => default_sections }
+          :sections => default_sections,
+          :background_sections => default_background_sections,
+          :verbose_subject => default_verbose_subject,
+          :normalize_subject => default_normalize_subject }
+      end
+
+      def normalize_digits(string)
+        string.gsub(/[0-9]+/, 'N')
       end
     end
 
@@ -44,37 +65,41 @@ class ExceptionNotifier
       end
     end
 
-    def exception_notification(env, exception)
+    def exception_notification(env, exception, options={})
+      self.append_view_path Rails.root.nil? ? "app/views" : "#{Rails.root}/app/views" if defined?(Rails)
+
       @env        = env
       @exception  = exception
       @options    = (env['exception_notifier.options'] || {}).reverse_merge(self.class.default_options)
       @kontroller = env['action_controller.instance'] || MissingController.new
       @request    = ActionDispatch::Request.new(env)
-      @backtrace  = clean_backtrace(exception)
+      @backtrace  = exception.backtrace ? clean_backtrace(exception) : []
       @sections   = @options[:sections]
-      data        = env['exception_notifier.exception_data'] || {}
+      @data       = (env['exception_notifier.exception_data'] || {}).merge(options[:data] || {})
+      @sections   = @sections + %w(data) unless @data.empty?
 
-      data.each do |name, value|
+      @data.each do |name, value|
         instance_variable_set("@#{name}", value)
       end
-
-      prefix  = "#{@options[:email_prefix]}#{@kontroller.controller_name}##{@kontroller.action_name}"
-      subject = "#{prefix} (#{@exception.class}) #{@exception.message.inspect}"
-      subject = subject.length > 120 ? subject[0...120] + "..." : subject
+      subject = compose_subject(exception, @kontroller)
 
       mail(:to => @options[:exception_recipients], :from => @options[:sender_address], :subject => subject) do |format|
         format.text { render "#{mailer_name}/exception_notification" }
       end
     end
 
-    def background_exception_notification(exception)
+    def background_exception_notification(exception, options={})
       if @notifier = Rails.application.config.middleware.detect{ |x| x.klass == ExceptionNotifier }
-        @options = (@notifier.args.first || {}).reverse_merge(self.class.default_options)
-        subject  = "#{@options[:email_prefix]} (#{exception.class}) #{exception.message.inspect}"
-
+        @options   = (@notifier.args.first || {}).reverse_merge(self.class.default_options)
         @exception = exception
         @backtrace = exception.backtrace || []
-        @sections  = %w{backtrace}
+        @sections  = @options[:background_sections]
+        @data      = options[:data] || {}
+
+        @data.each do |name, value|
+          instance_variable_set("@#{name}", value)
+        end
+        subject  = compose_subject(exception)
 
         mail(:to => @options[:exception_recipients], :from => @options[:sender_address], :subject => subject) do |format|
           format.text { render "#{mailer_name}/background_exception_notification" }
@@ -84,6 +109,15 @@ class ExceptionNotifier
 
     private
 
+    def compose_subject(exception, kontroller=nil)
+      subject = "#{@options[:email_prefix]}"
+      subject << "#{kontroller.controller_name}##{kontroller.action_name}" if kontroller
+      subject << " (#{exception.class})"
+      subject << " #{exception.message.inspect}" if @options[:verbose_subject]
+      subject = normalize_digits(subject) if @options[:normalize_subject]
+      subject.length > 120 ? subject[0...120] + "..." : subject
+    end
+
     def clean_backtrace(exception)
       if Rails.respond_to?(:backtrace_cleaner)
        Rails.backtrace_cleaner.send(:filter, exception.backtrace)

data/lib/exception_notifier/views/exception_notifier/_data.text.erb

@@ -0,0 +1 @@
+* data: <%= raw PP.pp(@data, "") %>

data/lib/exception_notifier/views/exception_notifier/_environment.text.erb

@@ -1,8 +1,8 @@
 <% filtered_env = @request.filtered_env -%>
-<% max = filtered_env.keys.max { |a, b| a.length <=> b.length } -%>
-<% filtered_env.keys.sort.each do |key| -%>
+<% max = filtered_env.keys.map(&:to_s).max { |a, b| a.length <=> b.length } -%>
+<% filtered_env.keys.map(&:to_s).sort.each do |key| -%>
 * <%= raw("%-*s: %s" % [max.length, key, inspect_object(filtered_env[key])]) %>
 <% end -%>
 
 * Process: <%= raw $$ %>
-* Server : <%= raw `hostname -s`.chomp %>
+* Server : <%= raw `hostname`.chomp %>

data/lib/exception_notifier/views/exception_notifier/_request.text.erb

@@ -2,3 +2,4 @@
 * IP address: <%= raw @request.remote_ip %>
 * Parameters: <%= raw @request.filtered_parameters.inspect %>
 * Rails root: <%= raw Rails.root %>
+* Timestamp : <%= raw Time.current %>

data/lib/exception_notifier/views/exception_notifier/_session.text.erb

@@ -1,2 +1,2 @@
-* session id: <%= @request.ssl? ? "[FILTERED]" : (raw @request.session['session_id'].inspect.html_safe) %>
+* session id: <%= @request.ssl? ? "[FILTERED]" : (raw (@request.session['session_id'] || @request.env["rack.session.options"][:id]).inspect.html_safe) %>
 * data: <%= raw PP.pp(@request.session, "") %>

data/lib/exception_notifier/views/exception_notifier/background_exception_notification.text.erb

@@ -1,4 +1,4 @@
-A <%= @exception.class %> occurred in background:
+A <%= @exception.class %> occurred in background at <%= raw Time.current %> :
 
   <%= @exception.message %>
   <%= @backtrace.first %>

data/lib/exception_notifier/views/exception_notifier/exception_notification.text.erb

@@ -3,11 +3,22 @@ A <%= @exception.class %> occurred in <%= @kontroller.controller_name %>#<%= @ko
   <%= raw @exception.message %>
   <%= raw @backtrace.first %>
 
-<%  sections = @sections.map do |section|
-      summary = render(section).strip
-      unless summary.blank?
+<%
+    sections = @sections.map do |section|
+      begin
+        summary = render(section).strip
+        unless summary.blank?
+          title = render("title", :title => section).strip
+          "#{title}\n\n#{summary.gsub(/^/, "  ")}\n\n"
+        end
+
+      rescue Exception => e
         title = render("title", :title => section).strip
-        "#{title}\n\n#{summary.gsub(/^/, "  ")}\n\n"
+        summary = ["ERROR: Failed to generate exception summary:", [e.class.to_s, e.message].join(": "), e.backtrace && e.backtrace.join("\n")].compact.join("\n\n")
+
+        [title, summary.gsub(/^/, "  "), nil].join("\n\n")
       end
-    end %>
+    end
+%>
+
 <%= raw sections.join %>

data/test/background_exception_notification_test.rb

@@ -6,7 +6,9 @@ class BackgroundExceptionNotificationTest < ActiveSupport::TestCase
       1/0
     rescue => e
       @exception = e
-      @mail = ExceptionNotifier::Notifier.background_exception_notification(@exception)
+      @time = Time.current
+      @mail = ExceptionNotifier::Notifier.background_exception_notification(@exception,
+        :data => {:job => 'DivideWorkerJob', :payload => '1/0', :message => 'My Custom Message'})
     end
   end
 
@@ -27,17 +29,24 @@ class BackgroundExceptionNotificationTest < ActiveSupport::TestCase
   end
 
   test "mail should have a descriptive subject" do
-    assert @mail.subject.include? "[Dummy ERROR]  (ZeroDivisionError) \"divided by 0\""
+    assert @mail.subject == "[Dummy ERROR]  (ZeroDivisionError) \"divided by 0\""
   end
 
-  test "mail should say exception was raised in background" do
-    assert @mail.body.include? "A ZeroDivisionError occurred in background"
+  test "mail should say exception was raised in background at show timestamp" do
+    assert @mail.body.include? "A ZeroDivisionError occurred in background at #{@time}"
   end
 
   test "mail should contain backtrace in body" do
     assert @mail.body.include? "test/background_exception_notification_test.rb:6"
   end
 
+  test "mail should contain data in body" do
+    assert @mail.body.include? '* data:'
+    assert @mail.body.include? ':payload=>"1/0"'
+    assert @mail.body.include? ':job=>"DivideWorkerJob"'
+    assert @mail.body.include? "My Custom Message"
+  end
+
   test "mail should not contain any attachments" do
     assert @mail.attachments == []
   end
@@ -47,7 +56,7 @@ class BackgroundExceptionNotificationTest < ActiveSupport::TestCase
       raise ActiveRecord::RecordNotFound
     rescue => e
       @ignored_exception = e
-      unless ExceptionNotifier.default_ignore_exceptions.include?(@ignored_exception.class)
+      unless ExceptionNotifier.default_ignore_exceptions.include?(@ignored_exception.class.name)
         @ignored_mail = ExceptionNotifier::Notifier.background_exception_notification(@ignored_exception)
       end
     end

data/test/dummy/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../../..
   specs:
-    exception_notification (2.4.1)
+    exception_notification (2.5.2)
       actionmailer (>= 3.0.4)
 
 GEM

data/test/dummy/app/views/exception_notifier/_new_section.text.erb

@@ -0,0 +1 @@
+* New section for testing

data/test/dummy/config/environment.rb

@@ -4,7 +4,8 @@ require File.expand_path('../application', __FILE__)
 Dummy::Application.config.middleware.use ExceptionNotifier,
   :email_prefix => "[Dummy ERROR] ",
   :sender_address => %{"Dummy Notifier" <dummynotifier@example.com>},
-  :exception_recipients => %w{dummyexceptions@example.com}
+  :exception_recipients => %w{dummyexceptions@example.com},
+  :sections => ['new_section', 'request', 'session', 'environment', 'backtrace']
 
 # Initialize the rails application
 Dummy::Application.initialize!

data/test/dummy/test/functional/posts_controller_test.rb

@@ -7,7 +7,7 @@ class PostsControllerTest < ActionController::TestCase
       post :create, :post => @post.attributes
     rescue => e
       @exception = e
-      @mail = ExceptionNotifier::Notifier.exception_notification(request.env, @exception)
+      @mail = ExceptionNotifier::Notifier.exception_notification(request.env, @exception, {:data => {:message => 'My Custom Message'}})
     end
   end
 
@@ -28,13 +28,25 @@ class PostsControllerTest < ActionController::TestCase
   end
 
   test "mail should have a descriptive subject" do
-    assert @mail.subject.include? "[Dummy ERROR] # (NoMethodError)"
+    assert @mail.subject.include? "[Dummy ERROR] # (NoMethodError) \"undefined method `nw'"
   end
 
   test "mail should contain backtrace in body" do
     assert @mail.body.include? "`method_missing'\n  app/controllers/posts_controller.rb:17:in `create'\n"
   end
 
+  test "mail should contain timestamp of exception in body" do
+    assert @mail.body.include? "Timestamp : #{Time.current}"
+  end
+
+  test "mail should contain the newly defined section" do
+    assert @mail.body.include? "* New section for testing"
+  end
+
+  test "mail should contain the custom message" do
+    assert @mail.body.include? "My Custom Message"
+  end
+
   test "should filter sensible data" do
     assert @mail.body.include? "secret\"=>\"[FILTERED]"
   end
@@ -48,7 +60,7 @@ class PostsControllerTest < ActionController::TestCase
       get :show, :id => @post.to_param + "10"
     rescue => e
       @ignored_exception = e
-      unless ExceptionNotifier.default_ignore_exceptions.include?(@ignored_exception.class)
+      unless ExceptionNotifier.default_ignore_exceptions.include?(@ignored_exception.class.name)
         @ignored_mail = ExceptionNotifier::Notifier.exception_notification(request.env, @ignored_exception)
       end
     end
@@ -69,4 +81,87 @@ class PostsControllerTest < ActionController::TestCase
     assert request.ssl?
     assert @secured_mail.body.include? "* session id: [FILTERED]\n  *"
   end
+
+  test "should ignore exception if from unwanted cralwer" do
+    request.env['HTTP_USER_AGENT'] = "Mozilla/5.0 (compatible; Googlebot/2.1; +http://www.google.com/bot.html)"
+    begin
+      @post = posts(:one)
+      post :create, :post => @post.attributes
+    rescue => e
+      @exception = e
+      custom_env = request.env
+      custom_env['exception_notifier.options'] ||= {}
+      custom_env['exception_notifier.options'].merge!(:ignore_crawlers => %w(Googlebot))
+      ignore_array = custom_env['exception_notifier.options'][:ignore_crawlers]
+      unless ExceptionNotifier.new(Dummy::Application, custom_env['exception_notifier.options']).send(:from_crawler, ignore_array, custom_env['HTTP_USER_AGENT'])
+        @ignored_mail = ExceptionNotifier::Notifier.exception_notification(custom_env, @exception)
+      end
+    end
+
+    assert_nil @ignored_mail
+  end
+
+  test "should ignore exception if satisfies conditional ignore" do
+    request.env['IGNOREME'] = "IGNOREME"
+    begin
+      @post = posts(:one)
+      post :create, :post => @post.attributes
+    rescue => e
+      @exception = e
+      custom_env = request.env
+      custom_env['exception_notifier.options'] ||= {}
+      ignore_cond = {:ignore_if => lambda {|env, e| (env['IGNOREME'] == 'IGNOREME') && (e.message =~ /undefined method/)}}
+      custom_env['exception_notifier.options'].merge!(ignore_cond)
+      unless ExceptionNotifier.new(Dummy::Application, custom_env['exception_notifier.options']).send(:conditionally_ignored, ignore_cond[:ignore_if], custom_env, @exception)
+        @ignored_mail = ExceptionNotifier::Notifier.exception_notification(custom_env, @exception)
+      end
+    end
+
+    assert_nil @ignored_mail
+  end
+end
+
+class PostsControllerTestWithoutVerboseSubject < ActionController::TestCase
+  tests PostsController
+  setup do
+    ExceptionNotifier::Notifier.default_verbose_subject = false
+    begin
+      @post = posts(:one)
+      post :create, :post => @post.attributes
+    rescue => e
+      @exception = e
+      @mail = ExceptionNotifier::Notifier.exception_notification(request.env, @exception)
+    end
+  end
+
+  test "should not include exception message in subject" do
+    assert_equal "[ERROR] # (NoMethodError)", @mail.subject
+  end
+end
+
+class PostsControllerTestBadRequestData < ActionController::TestCase
+  tests PostsController
+  setup do
+    begin
+      # This might seem synthetic, but the point is that the data used by
+      # ExceptionNotification could be rendered "invalid" by e.g. a badly
+      # behaving middleware, and we want to test that ExceptionNotification
+      # still manages to send off an email in those cases.
+      #
+      # The trick here is to trigger an exception in the template used by
+      # ExceptionNotification. (The original test stuffed request.env with
+      # badly encoded strings, but that only works in Ruby 1.9+.)
+      request.send :instance_variable_set, :@env, {}
+
+      @post = posts(:one)
+      post :create, :post => @post.attributes
+    rescue => e
+      @exception = e
+      @mail = ExceptionNotifier::Notifier.exception_notification(request.env, @exception)
+    end
+  end
+
+  test "should include error message in body" do
+    assert_match /ERROR: Failed to generate exception summary/, @mail.body.to_s
+  end
 end

data/test/exception_notification_test.rb

@@ -2,7 +2,7 @@ require 'test_helper'
 
 class ExceptionNotificationTest < ActiveSupport::TestCase
   test "should have default ignored exceptions" do
-    assert ExceptionNotifier.default_ignore_exceptions == [ActiveRecord::RecordNotFound, AbstractController::ActionNotFound, ActionController::RoutingError]
+    assert ExceptionNotifier.default_ignore_exceptions == ['ActiveRecord::RecordNotFound', 'AbstractController::ActionNotFound', 'ActionController::RoutingError']
   end
 
   test "should have default sender address overriden" do
@@ -14,6 +14,29 @@ class ExceptionNotificationTest < ActiveSupport::TestCase
   end
 
   test "should have default sections" do
-    assert ExceptionNotifier::Notifier.default_sections == %w(request session environment backtrace)
+    for section in %w(request session environment backtrace)
+      assert ExceptionNotifier::Notifier.default_sections.include? section
+    end
+  end
+
+  test "should have default background sections" do
+    assert ExceptionNotifier::Notifier.default_background_sections == %w(backtrace data)
+  end
+
+  test "should have verbose subject by default" do
+    assert ExceptionNotifier::Notifier.default_options[:verbose_subject] == true
+  end
+
+  test "should have ignored crawler by default" do
+    assert ExceptionNotifier.default_ignore_crawlers == []
+  end
+
+  test "should normalize multiple digits into one N" do
+    assert_equal 'N foo N bar N baz N',
+      ExceptionNotifier::Notifier.normalize_digits('1 foo 12 bar 123 baz 1234')
+  end
+
+  test "should have normalize_subject false by default" do
+    assert ExceptionNotifier::Notifier.default_options[:normalize_subject] == false
   end
 end

metadata

@@ -1,81 +1,71 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: exception_notification
-version: !ruby/object:Gem::Version 
-  hash: 31
-  prerelease: 
-  segments: 
-  - 2
-  - 5
-  - 2
-  version: 2.5.2
+version: !ruby/object:Gem::Version
+  version: 2.6.0.rc1
+  prerelease: 6
 platform: ruby
-authors: 
+authors:
 - Jamis Buck
 - Josh Peek
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-08-29 00:00:00 -03:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-04-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: actionmailer
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 3
-        - 0
-        - 4
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 3.0.4
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rails
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.4
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 3
-        - 0
-        - 4
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 3.0.4
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: sqlite3
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 19
-        segments: 
-        - 1
-        - 3
-        - 4
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.4
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.3.4
   type: :development
-  version_requirements: *id003
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.4
 description: 
 email: smartinez87@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gemtest
 - Gemfile
 - Gemfile.lock
@@ -86,6 +76,7 @@ files:
 - lib/exception_notifier.rb
 - lib/exception_notifier/notifier.rb
 - lib/exception_notifier/views/exception_notifier/_backtrace.text.erb
+- lib/exception_notifier/views/exception_notifier/_data.text.erb
 - lib/exception_notifier/views/exception_notifier/_environment.text.erb
 - lib/exception_notifier/views/exception_notifier/_request.text.erb
 - lib/exception_notifier/views/exception_notifier/_session.text.erb
@@ -102,6 +93,7 @@ files:
 - test/dummy/app/helpers/application_helper.rb
 - test/dummy/app/helpers/posts_helper.rb
 - test/dummy/app/models/post.rb
+- test/dummy/app/views/exception_notifier/_new_section.text.erb
 - test/dummy/app/views/layouts/application.html.erb
 - test/dummy/app/views/posts/_form.html.erb
 - test/dummy/app/views/posts/new.html.erb
@@ -146,41 +138,31 @@ files:
 - test/dummy/test/test_helper.rb
 - test/exception_notification_test.rb
 - test/test_helper.rb
-has_rdoc: true
-homepage: 
+homepage: https://github.com/smartinez87/exception_notification
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+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 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.5.2
+rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
 summary: Exception notification by email for Rails apps
-test_files: 
+test_files:
 - test/background_exception_notification_test.rb
 - test/dummy/.gitignore
 - test/dummy/Gemfile
@@ -191,6 +173,7 @@ test_files:
 - test/dummy/app/helpers/application_helper.rb
 - test/dummy/app/helpers/posts_helper.rb
 - test/dummy/app/models/post.rb
+- test/dummy/app/views/exception_notifier/_new_section.text.erb
 - test/dummy/app/views/layouts/application.html.erb
 - test/dummy/app/views/posts/_form.html.erb
 - test/dummy/app/views/posts/new.html.erb