public
Description: Email notification and managed error templates for Radiant and other extensions
Homepage: http://digitalpulp.com
Clone URL: git://github.com/digitalpulp/radiant-exception-notification-extension.git
Glenn Murray (author)
Thu Jul 09 00:45:25 -0700 2009
commit  5b316b1cacee6123077f6854b6dac7ca55d9f1e0
tree    23eec830f8d1143a9604358ec602ecede6202ae3
parent  6dc67cbd3d60446db1cfb0ab2b38d34ea7d8cde8
name age message
file README Mon Jul 28 12:58:10 -0700 2008 Initial import [Josh French]
file Rakefile Mon Jul 28 12:58:10 -0700 2008 Initial import [Josh French]
directory app/ Thu Jul 09 00:45:25 -0700 2009 Hack to set template_root; which was being mis-... [Glenn Murray]
file exception_notification_extension.rb Tue May 12 09:05:24 -0700 2009 Update for Radiant 0.8.0RC1 [Josh French]
directory lib/ Loading commit data...
directory test/ Thu Aug 07 14:47:06 -0700 2008 Test for page.request [Josh French]
README
= EXCEPTION NOTIFICATION

Extends Radiant's error handling to include email notification and Radiant-
managed error templates for exceptions raised in other extensions. Based on 
Jamis Buck's original Rails exception notifier.

= USAGE

 1. Enable ActionMailer

    Locate +config.frameworks -= [ :action_mailer ]+ in config/environment.rb.
    Comment out this line, or remove action_mailer from the list of frameworks
    you are skipping.
    
 2. Define the email addresses ExceptionNotifier should use
 
    Set the following somewhere within your environment:
    
    ExceptionNotifier.email_to   = 'send@to.email'
    ExceptionNotifier.email_from = 'sent@from.email'
    
 3. Create some error templates

    Exception Notification adds an additional Page subclass called 
    InternalServerErrorPage. This and its existing sibling, FileNotFoundPage,
    determine what gets rendered when an exception is raised. Create one of
    each within your content tree. ExceptionNotification is aware of the
    multi-site extension, so you can create individual error pages for
    each site.
    
= NOTES

By default, your FileNotFound page will be rendered when the following 
exceptions are caught: 

  * ActiveRecord::RecordNotFound
  * ActionController::UnknownController
  * ActionController::UnknownAction
  * ActionController::RoutingError
  
All other errors will render with an InternalServerErrorPage. Both templates 
are rendered even when running in development mode. If you'd like your stack 
traces displayed (like dev mode in a standard Rails application,) set the
following somewhere within your environment:
  
  Radiant::Config['debug?'] = true
  
==============================================================================

Copyright (c) 2008 Digital Pulp, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.