exception_notifier 1.0.0

data/README

@@ -0,0 +1,73 @@
+= 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.
+
+== Usage
+
+As of Rails 3 ExceptionNotifier is used as a rack middleware
+
+  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
+(whereever you'd like), and define the corresponding partial. Then, 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.
+
+== Rails 2.3 stable and earlier
+
+If you are running Rails 2.3 then see the branch for that: 
+ 
+  http://github.com/rails/exception_notification/tree/2-3-stable
+
+If you are running pre-rack Rails then see this tag: 
+
+  http://github.com/rails/exception_notification/tree/pre-2-3
+
+
+Copyright (c) 2005 Jamis Buck, released under the MIT license

data/lib/exception_notifier.rb

@@ -0,0 +1,30 @@
+require 'action_dispatch'
+require 'exception_notifier/notifier'
+
+class ExceptionNotifier
+  def self.default_ignore_exceptions
+    [].tap do |exceptions|
+      exceptions << ActiveRecord::RecordNotFound if defined? ActiveRecord
+      exceptions << AbstractController::ActionNotFound if defined? AbstractController
+      exceptions << ActionController::RoutingError if defined? ActionController
+    end
+  end
+
+  def initialize(app, options = {})
+    @app, @options = app, options
+    @options[:ignore_exceptions] ||= self.class.default_ignore_exceptions
+  end
+
+  def call(env)
+    @app.call(env)
+  rescue Exception => exception
+    options = (env['exception_notifier.options'] ||= {})
+    options.reverse_merge!(@options)
+
+    unless Array.wrap(options[:ignore_exceptions]).include?(exception.class)
+      Notifier.exception_notification(env, exception).deliver
+    end
+
+    raise exception
+  end
+end

data/lib/exception_notifier/notifier.rb

@@ -0,0 +1,63 @@
+require 'action_mailer'
+require 'pp'
+
+class ExceptionNotifier
+  class Notifier < ActionMailer::Base
+    self.mailer_name = 'exception_notifier'
+    self.append_view_path "#{File.dirname(__FILE__)}/views"
+
+    class << self
+      def default_sender_address
+        %("Exception Notifier" <exception.notifier@default.com>)
+      end
+
+      def default_exception_recipients
+        []
+      end
+
+      def default_email_prefix
+        "[ERROR] "
+      end
+
+      def 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
+
+    def exception_notification(env, exception)
+      @env        = env
+      @exception  = exception
+      @options    = (env['exception_notifier.options'] || {}).reverse_merge(self.class.default_options)
+      @controller = env['action_controller.instance']
+      @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]}#{@controller.controller_name}##{@controller.action_name}"
+      subject  = "#{prefix} (#{@exception.class}) #{@exception.message.inspect}"
+      
+      mail(:to => @options[:exception_recipients], :from => @options[:sender_address], :subject => subject) do |format|
+        format.text { render "#{mailer_name}/exception_notification" }
+      end
+    end
+
+    private
+      def clean_backtrace(exception)
+        Rails.respond_to?(:backtrace_cleaner) ?
+          Rails.backtrace_cleaner.send(:filter, exception.backtrace) :
+          exception.backtrace
+      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, filtered_env[key].to_s.strip]) %>
+<% 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.fitered_params.inspect %>
+* Rails root: <%= raw Rails.root %>

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

@@ -0,0 +1,2 @@
+* session id: <%= raw @request.session['session_id'].inspect.html_safe %>
+* data: <%= raw PP.pp(@request.session.inspect.gsub(/\n/, "\n  ").strip.html_safe) %>

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/exception_notification.text.erb

@@ -0,0 +1,13 @@
+A <%= @exception.class %> occurred in <%= @controller.controller_name %>#<%= @controller.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

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: exception_notifier
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Jamis Buck
+- Josh Peek
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-13 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: 
+email: timocratic@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- 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/exception_notification.text.erb
+- lib/exception_notifier.rb
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Exception notification by email for Rails apps
+test_files: []
+