exception_notification 2.4.0 → 2.4.1

data/README.md

@@ -0,0 +1,95 @@
+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', :require => 'exception_notifier'
+
+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
+(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.
+
+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

@@ -12,13 +12,19 @@ class ExceptionNotifier
 
   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'] ||= {})
+    options = (env['exception_notifier.options'] ||= Notifier.default_options)
     options.reverse_merge!(@options)
 
     unless Array.wrap(options[:ignore_exceptions]).include?(exception.class)

data/lib/exception_notifier/notifier.rb

@@ -7,20 +7,25 @@ class ExceptionNotifier
     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
-        %("Exception Notifier" <exception.notifier@default.com>)
+        @default_sender_address || %("Exception Notifier" <exception.notifier@default.com>)
       end
 
       def default_exception_recipients
-        []
+        @default_exception_recipients || []
       end
 
       def default_email_prefix
-        "[ERROR] "
+        @default_email_prefix || "[ERROR] "
       end
 
       def default_sections
-        %w(request session environment backtrace)
+        @default_sections || %w(request session environment backtrace)
       end
 
       def default_options
@@ -52,6 +57,7 @@ class ExceptionNotifier
 
       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" }

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: exception_notification
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 29
   prerelease: 
   segments: 
   - 2
   - 4
-  - 0
-  version: 2.4.0
+  - 1
+  version: 2.4.1
 platform: ruby
 authors: 
 - Jamis Buck
@@ -16,8 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-09 00:00:00 -02:00
-default_executable: 
+date: 2011-06-09 00:00:00 Z
 dependencies: []
 
 description: 
@@ -29,16 +28,16 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- README
+- README.md
+- lib/exception_notification.rb
 - lib/exception_notifier/notifier.rb
-- lib/exception_notifier/views/exception_notifier/_request.text.erb
+- 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/exception_notification.text.erb
-- lib/exception_notifier/views/exception_notifier/_backtrace.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: []
 
@@ -68,7 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.2
+rubygems_version: 1.7.1
 signing_key: 
 specification_version: 3
 summary: Exception notification by email for Rails apps

data/README

@@ -1,81 +0,0 @@
-= 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.
-
-== 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: 
- 
-  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
-
-== Support and tickets
-
-https://github.com/smartinez87/exception_notification/issues
-
-Copyright (c) 2005 Jamis Buck, released under the MIT license