exception_notification 2.5.0 → 2.5.1

data/README.md

@@ -0,0 +1,130 @@
+Exception Notifier Plugin for Rails
+====
+
+The Exception Notifier plugin provides a mailer object and a default set of
+templates for sending email notifications when errors occur in a Rails
+application. The plugin is configurable, allowing programmers to specify:
+
+* the sender address of the email
+* the recipient addresses
+* the text used to prefix the subject line
+
+The email includes information about the current request, session, and
+environment, and also gives a backtrace of the exception.
+
+Installation
+---
+
+You can use the latest ExceptionNotification gem with Rails 3, by adding
+the following line in your Gemfile
+
+    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}
+
+Customization
+---
+
+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
+
+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
+
+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
+      ...
+    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.
+
+Background Notifications
+---
+
+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
+
+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
+
+    def server_error(exception)
+      # Whatever code that handles the exception
+
+      ExceptionNotifier::Notifier.exception_notification(request.env, exception).deliver
+    end
+
+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
+---
+
+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: 
+
+<a href="http://github.com/smartinez87/exception_notification/tree/pre-2-3">http://github.com/smartinez87/exception_notification/tree/pre-2-3</a>
+
+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

data/lib/exception_notification.rb

@@ -0,0 +1 @@
+require 'exception_notifier'

data/lib/exception_notifier.rb

@@ -0,0 +1,37 @@
+require 'action_dispatch'
+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
+    end
+  end
+
+  def initialize(app, options = {})
+    @app, @options = app, options
+
+    Notifier.default_sender_address       = @options[:sender_address]
+    Notifier.default_exception_recipients = @options[:exception_recipients]
+    Notifier.default_email_prefix         = @options[:email_prefix]
+    Notifier.default_sections             = @options[:sections]
+
+    @options[:ignore_exceptions] ||= self.class.default_ignore_exceptions
+  end
+
+  def call(env)
+    @app.call(env)
+  rescue Exception => exception
+    options = (env['exception_notifier.options'] ||= Notifier.default_options)
+    options.reverse_merge!(@options)
+
+    unless Array.wrap(options[:ignore_exceptions]).include?(exception.class)
+      Notifier.exception_notification(env, exception).deliver
+      env['exception_notifier.delivered'] = true
+    end
+
+    raise exception
+  end
+end

data/lib/exception_notifier/notifier.rb

@@ -0,0 +1,108 @@
+require 'action_mailer'
+require 'pp'
+
+class ExceptionNotifier
+  class Notifier < ActionMailer::Base
+    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
+      attr_writer :default_sender_address
+      attr_writer :default_exception_recipients
+      attr_writer :default_email_prefix
+      attr_writer :default_sections
+
+      def default_sender_address
+        @default_sender_address || %("Exception Notifier" <exception.notifier@default.com>)
+      end
+
+      def default_exception_recipients
+        @default_exception_recipients || []
+      end
+
+      def default_email_prefix
+        @default_email_prefix || "[ERROR] "
+      end
+
+      def default_sections
+        @default_sections || %w(request session environment backtrace)
+      end
+
+      def default_options
+        { :sender_address => default_sender_address,
+          :exception_recipients => default_exception_recipients,
+          :email_prefix => default_email_prefix,
+          :sections => default_sections }
+      end
+    end
+
+    class MissingController
+      def method_missing(*args, &block)
+      end
+    end
+
+    def exception_notification(env, exception)
+      @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)
+      @sections   = @options[:sections]
+      data        = env['exception_notifier.exception_data'] || {}
+
+      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
+
+      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)
+      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}"
+
+        @exception = exception
+        @backtrace = exception.backtrace || []
+        @sections  = %w{backtrace}
+
+        mail(:to => @options[:exception_recipients], :from => @options[:sender_address], :subject => subject) do |format|
+          format.text { render "#{mailer_name}/background_exception_notification" }
+        end.deliver
+      end
+    end
+
+    private
+
+    def clean_backtrace(exception)
+      if Rails.respond_to?(:backtrace_cleaner)
+       Rails.backtrace_cleaner.send(:filter, exception.backtrace)
+      else
+       exception.backtrace
+      end
+    end
+
+    helper_method :inspect_object
+
+    def inspect_object(object)
+      case object
+      when Hash, Array
+        object.inspect
+      when ActionController::Base
+        "#{object.controller_name}##{object.action_name}"
+      else
+        object.to_s
+      end
+    end
+  end
+end

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

@@ -0,0 +1 @@
+<%= raw @backtrace.join("\n") %>

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

@@ -0,0 +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| -%>
+* <%= raw("%-*s: %s" % [max.length, key, inspect_object(filtered_env[key])]) %>
+<% end -%>
+
+* Process: <%= raw $$ %>
+* Server : <%= raw `hostname -s`.chomp %>

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

@@ -0,0 +1,4 @@
+* URL       : <%= raw @request.url %>
+* IP address: <%= raw @request.remote_ip %>
+* Parameters: <%= raw @request.filtered_parameters.inspect %>
+* Rails root: <%= raw Rails.root %>

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

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

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

@@ -0,0 +1,3 @@
+-------------------------------
+<%= raw title.to_s.humanize %>:
+-------------------------------

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

@@ -0,0 +1,13 @@
+A <%= @exception.class %> occurred in background:
+
+  <%= @exception.message %>
+  <%= @backtrace.first %>
+
+  <%  sections = @sections.map do |section|
+        summary = render(section).strip
+        unless summary.blank?
+          title = render("title", :title => section).strip
+          "#{title}\n\n#{summary.gsub(/^/, "  ")}\n\n"
+        end
+      end %>
+  <%= raw sections.join %>

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

@@ -0,0 +1,13 @@
+A <%= @exception.class %> occurred in <%= @kontroller.controller_name %>#<%= @kontroller.action_name %>:
+
+  <%= raw @exception.message %>
+  <%= raw @backtrace.first %>
+
+<%  sections = @sections.map do |section|
+      summary = render(section).strip
+      unless summary.blank?
+        title = render("title", :title => section).strip
+        "#{title}\n\n#{summary.gsub(/^/, "  ")}\n\n"
+      end
+    end %>
+<%= raw sections.join %>

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: exception_notification
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 2
   - 5
-  - 0
-  version: 2.5.0
+  - 1
+  version: 2.5.1
 platform: ruby
 authors: 
 - Jamis Buck
@@ -16,8 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-27 00:00:00 -03:00
-default_executable: 
+date: 2011-08-29 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: actionmailer
@@ -76,12 +75,22 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- lib/exception_notification.rb
+- lib/exception_notifier.rb
+- lib/exception_notifier/notifier.rb
+- lib/exception_notifier/views/exception_notifier/_backtrace.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
+- lib/exception_notifier/views/exception_notifier/_title.text.erb
+- lib/exception_notifier/views/exception_notifier/background_exception_notification.text.erb
+- lib/exception_notifier/views/exception_notifier/exception_notification.text.erb
 - Rakefile
 - .gemtest
-- test/exception_notification_test.rb
-- test/dummy/test/functional/posts_controller_test.rb
+- README.md
 - test/background_exception_notification_test.rb
-has_rdoc: true
+- test/dummy/test/functional/posts_controller_test.rb
+- test/exception_notification_test.rb
 homepage: 
 licenses: []
 
@@ -111,11 +120,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.0
+rubygems_version: 1.7.1
 signing_key: 
 specification_version: 3
 summary: Exception notification by email for Rails apps
 test_files: 
-- test/exception_notification_test.rb
-- test/dummy/test/functional/posts_controller_test.rb
 - test/background_exception_notification_test.rb
+- test/dummy/test/functional/posts_controller_test.rb
+- test/exception_notification_test.rb