README in exception_notification-1.0.20090728 vs README in exception_notification-2.3.3.0

@@ -15,32 +15,41 @@
 
 First, include the ExceptionNotifiable mixin in whichever controller you want
 to generate error emails (typically ApplicationController):
 
   class ApplicationController < ActionController::Base
-    include ExceptionNotifiable
+    include ExceptionNotification::Notifiable
     ...
   end
 
 Then, specify the email recipients in your environment:
 
-  ExceptionNotifier.exception_recipients = %w([e-mail] [e-mail])
+  ExceptionNotification::Notifier.exception_recipients = %w([e-mail] [e-mail])
 
 And that's it! The defaults take care of the rest.
 
 == Configuration
 
 You can tweak other values to your liking, as well. In your environment file,
 just set any or all of the following values:
 
   # defaults to [e-mail]
-  ExceptionNotifier.sender_address =
+  ExceptionNotification::Notifier.sender_address =
     %("Application Error" <[e-mail]>)
 
   # defaults to "[ERROR] "
-  ExceptionNotifier.email_prefix = "[APP] "
+  ExceptionNotification::Notifier.email_prefix = "[APP] "
 
+Even if you have mixed into ApplicationController you can skip notification in
+some controllers by
+  
+  class MyController  < ApplicationController
+    skip_exception_notifications
+  end
+  
+== Deprecated local_request? overriding
+
 Email notifications will only occur when the IP address is determined not to
 be local. You can specify certain addresses to always be local so that you'll
 get a detailed error instead of the generic error page. You do this in your
 controller (or even per-controller):
 
@@ -55,10 +64,23 @@
 reset the list of all addresses (for instance, if you wanted "127.0.0.1" to
 NOT be considered local), you can simply do, somewhere in your controller:
 
   local_addresses.clear
 
+NOTE: The above functionality has has been pulled out to consider_local.rb,
+as interfering with rails local determination is orthogonal to notification, 
+unnecessarily clutters backtraces, and even occasionally errs on odd ip or 
+requests bugs. To return original functionality add an initializer with:
+ 
+  ActionController::Base.send :include, ConsiderLocal
+
+or just include it per controller that wants it
+
+ class MyController  < ApplicationController
+   include ExceptionNotification::ConsiderLocal
+ end
+
 == 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
@@ -73,11 +95,11 @@
 * @rails_root: a sanitized version of RAILS_ROOT
 * @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
+ExceptionNotification::Notifier.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:
 
@@ -95,18 +117,24 @@
 
 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.
 
-== Advanced Customization
+== 404s errors
 
-By default, the email notifier will only notify on critical errors. For
-ActiveRecord::RecordNotFound and ActionController::UnknownAction, it will
-simply render the contents of your public/404.html file. Other exceptions
-will render public/500.html and will send the email notification. If you want
-to use different rules for the notification, you will need to implement your
-own rescue_action_in_public method. You can look at the default implementation
-in ExceptionNotifiable for an example of how to go about that.
+Notification is skipped if you return a 404 status, which happens by default 
+for an ActiveRecord::RecordNotFound or ActionController::UnknownAction error.
 
+== Manually notifying of error in a rescue block
 
-Copyright (c) 2005 Jamis Buck, released under the MIT license
-Copyright (c) 2008-2009 Jeremy Evans
+If your controller action manually handles an error, the notifier will never be
+run.  To manually notify of an error call notify_about_exception from within the
+rescue block
+
+  def index
+    #risky operation here
+  rescue StandardError => error
+    #custom error handling here
+    notify_about_exception(error)
+  end
+
+Copyright (c) 2005 Jamis Buck, released under the MIT license
\ No newline at end of file