pboling-super_exception_notifier 1.6.8 → 1.7.0

data/README.rdoc

@@ -56,7 +56,7 @@ Gem Using Git building from source:
   git clone git://github.com/pboling/exception_notification.git
   cd exception_notification
   gem build exception_notification.gemspec
-  sudo gem install super_exception_notification-1.6.8.gem # (Or whatever version gets built)
+  sudo gem install super_exception_notification-1.7.0.gem # (Or whatever version gets built)
 
 Then cd to your rails app to optionally freeze the gem into your app:
 
@@ -65,7 +65,7 @@ Then cd to your rails app to optionally freeze the gem into your app:
 Then in your environment.rb:
 
   config.gem 'super_exception_notifier',
-      :version => '~> 1.6.8',
+      :version => '~> 1.7.0',
       :lib => "exception_notifier"
 
 
@@ -77,7 +77,7 @@ Installing Gem from Github's Gem Server:
 Then in your environment.rb:
 
   config.gem 'pboling-super_exception_notifier',
-      :version => '~> 1.6.9',
+      :version => '~> 1.7.0',
       :lib => "exception_notifier",
       :source => 'http://gems.github.com'
 
@@ -170,12 +170,14 @@ The availalbe configuration options are shown with their default settings:
       "501" => "Not Implemented",
       "503" => "Service Unavailable"
     }
+
     # error_layout:
     #   can be defined at controller level to the name of the desired error layout,
     #   or set to true to render the controller's own default layout,
     #   or set to false to render errors with no layout
     #   syntax is the same as the rails 'layout' method (which is to say a string)
     self.error_layout = nil
+
     # Rails error classes to rescue and how to rescue them (which error code to use)
     self.rails_error_classes = {
       # These are standard errors in rails / ruby
@@ -192,6 +194,7 @@ The availalbe configuration options are shown with their default settings:
       NotImplemented => "501",
       MethodDisabled => "200"
     }
+
     # Highly dependent on the verison of rails, so we're very protective about these'
     self.rails_error_classes.merge!({ ActionView::TemplateError => "500"})             if defined?(ActionView)       && ActionView.const_defined?(:TemplateError)
     self.rails_error_classes.merge!({ ActiveRecord::RecordNotFound => "400" })         if defined?(ActiveRecord)     && ActiveRecord.const_defined?(:RecordNotFound)
@@ -205,17 +208,20 @@ The availalbe configuration options are shown with their default settings:
       self.rails_error_classes.merge!({ ActionController::RoutingError => "404" })               if ActionController.const_defined?(:RoutingError)
       self.rails_error_classes.merge!({ ActionController::InvalidAuthenticityToken => "405" })   if ActionController.const_defined?(:InvalidAuthenticityToken)
     end
+
     # Verbosity of the gem (true or false) mainly useful for debugging
     self.exception_notifier_verbose = false
+
     # Do Not Ever send error notification emails for these Error Classes
     self.silent_exceptions = []
     self.silent_exceptions << ActiveRecord::RecordNotFound if defined?(ActiveRecord)
-    self.silent_exceptions << [
-      ActionController::UnknownController,
-      ActionController::UnknownAction,
-      ActionController::RoutingError,
-      ActionController::MethodNotAllowed
-    ] if defined?(ActionController)
+    if defined?(ActionController)
+      self.silent_exceptions << ActionController::UnknownController
+      self.silent_exceptions << ActionController::UnknownAction
+      self.silent_exceptions << ActionController::RoutingError
+      self.silent_exceptions << ActionController::MethodNotAllowed
+    end
+
     # Notification Level
     # Web Hooks, even though they are turned on by default, only get used if you actually configure them in the environment (see above)
     # Email, even though it is turned on by default, only gets used if you actually configure recipients in the environment (see above)

data/VERSION.yml

@@ -1,4 +1,4 @@
 ---
 :major: 1
-:minor: 6
-:patch: 8
+:minor: 7
+:patch: 0

data/exception_notification.gemspec

@@ -1,17 +1,18 @@
 Gem::Specification.new do |s|
   s.name = 'super_exception_notifier'
-  s.version = '1.6.8'
-  s.date = '2009-08-15'
+  s.version = '1.7.0'
+  s.date = '2009-08-16'
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
 
   s.summary = %q{Allows unhandled (and handled!) exceptions to be captured and sent via email}
   s.description = %q{Allows customization of:
+* Specify which level of notification you would like with an array of optional styles of notification (email, webhooks)
 * the sender address of the email
 * the recipient addresses
 * the text used to prefix the subject line
-* the HTTP status codes to send emails for
+* the HTTP status codes to notify for
 * the error classes to send emails for
-* alternatively, the error classes to not send emails for
+* alternatively, the error classes to not notify for
 * whether to send error emails or just render without sending anything
 * the HTTP status and status code that gets rendered with specific errors
 * the view path to the error page templates
@@ -21,7 +22,7 @@ Gem::Specification.new do |s|
 * Override the gem's handling and rendering with explicit rescue statements inline.
 * Hooks into `git blame` output so you can get an idea of who (may) have introduced the bug
 * Hooks into other website services (e.g. you can send exceptions to to Switchub.com)
-* Specify which level of notification you would like with an array of optional styles of notification}
+  }
   
   s.authors = ['Peter Boling', 'Jacques Crocker', 'Jamis Buck']
   s.email = 'peter.boling@gmail.com'

data/lib/exception_notifiable.rb

@@ -6,14 +6,15 @@ module ExceptionNotifiable
   include HooksNotifier
 
   unless defined?(SILENT_EXCEPTIONS)
-    SILENT_EXCEPTIONS = []
-    SILENT_EXCEPTIONS << ActiveRecord::RecordNotFound if defined?(ActiveRecord)
-    SILENT_EXCEPTIONS << [
-      ActionController::UnknownController,
-      ActionController::UnknownAction,
-      ActionController::RoutingError,
-      ActionController::MethodNotAllowed
-    ] if defined?(ActionController)
+    noiseless = []
+    noiseless << ActiveRecord::RecordNotFound if defined?(ActiveRecord)
+    if defined?(ActionController)
+      noiseless << ActionController::UnknownController
+      noiseless << ActionController::UnknownAction
+      noiseless << ActionController::RoutingError
+      noiseless << ActionController::MethodNotAllowed
+    end
+    SILENT_EXCEPTIONS = noiseless
   end
 
   # TODO: use ActionController::StatusCodes
@@ -230,26 +231,21 @@ module ExceptionNotifiable
     end
 
     def should_email_on_exception?(exception, status_cd = nil, verbose = false)
-      notification_level_sends_email? && !ExceptionNotifier.config[:exception_recipients].empty? && should_notify_on_exception?(exception, status_cd)
+      notification_level_sends_email? && !ExceptionNotifier.config[:exception_recipients].empty? && should_notify_on_exception?(exception, status_cd, verbose)
     end
 
     def should_web_hook_on_exception?(exception, status_cd = nil, verbose = false)
-      notification_level_sends_web_hooks? && !ExceptionNotifier.config[:web_hooks].empty? && should_notify_on_exception?(exception, status_cd)
+      notification_level_sends_web_hooks? && !ExceptionNotifier.config[:web_hooks].empty? && should_notify_on_exception?(exception, status_cd, verbose)
     end
 
     def should_notify_on_exception?(exception, status_cd = nil, verbose = false)
-      puts "checking if should notify on exception E:#{exception} C: #{exception} SC: #{status_cd}" if verbose
       # don't notify (email or web hooks) on exceptions raised locally
       puts "skipping local notification" if verbose && ExceptionNotifier.config[:skip_local_notification] && is_local?
       return false if ExceptionNotifier.config[:skip_local_notification] && is_local?
       # don't notify (email or web hooks) exceptions raised that match ExceptionNotifiable.silent_exceptions
-      puts "skipping silent exception notification: K:#{klass} E:#{exception} C:#{exception.class}" if verbose && self.class.silent_exceptions.any? {|klass| klass === exception }
-      return false if self.class.silent_exceptions.any? {|klass| klass === exception }
-      puts "notifying for: E:#{exception} C:#{exception.class}" if verbose && ExceptionNotifier.config[:notify_error_classes].include?(exception)
-      return true if ExceptionNotifier.config[:notify_error_classes].include?(exception)
-      puts "notifying for status code: #{status_cd}" if verbose && !status_cd.nil? && ExceptionNotifier.config[:notify_error_codes].include?(status_cd)
+      return false if self.class.silent_exceptions.respond_to?(:any?) && self.class.silent_exceptions.any? {|klass| klass === exception }
+      return true if ExceptionNotifier.config[:notify_error_classes].include?(exception.class)
       return true if !status_cd.nil? && ExceptionNotifier.config[:notify_error_codes].include?(status_cd)
-      puts "Notify [#{ExceptionNotifier.config[:notify_other_errors] ? "YES" : "NO"}] Other Error: status code: #{status_cd} E:#{exception} C:#{exception.class}" if verbose
       return ExceptionNotifier.config[:notify_other_errors]
     end
 

data/test/exception_notify_functional_test.rb

@@ -91,7 +91,31 @@ class ExceptionNotifyFunctionalTest < ActionController::TestCase
     get "record_not_found"    
     assert_nothing_mailed
   end
-    
+
+  def test_controller_with_custom_silent_exceptions
+    @controller = CustomSilentExceptions.new
+    get "runtime_error"
+    assert_nothing_mailed
+  end
+
+  def test_controller_with_empty_silent_exceptions
+    @controller = EmptySilentExceptions.new
+    get "record_not_found"
+    assert_error_mail_contains("ActiveRecord::RecordNotFound")
+  end
+
+  def test_controller_with_nil_silent_exceptions
+    @controller = NilSilentExceptions.new
+    get "record_not_found"
+    assert_error_mail_contains("ActiveRecord::RecordNotFound")
+  end
+
+  def test_controller_with_default_silent_exceptions
+    @controller = DefaultSilentExceptions.new
+    get "unknown_controller"
+    assert_nothing_mailed
+  end
+
   private
 
   def assert_view_path_for_status_cd_is_string(status)
@@ -104,7 +128,7 @@ class ExceptionNotifyFunctionalTest < ActionController::TestCase
 
   def assert_error_mail_contains(text)
     assert(mailed_error.index(text), 
-      "Expected mailed error body to contain '#{text}', but not found. \n actual contents: \n#{mailed_error}")    
+          "Expected mailed error body to contain '#{text}', but not found. \n actual contents: \n#{mailed_error}")
   end
   
   def assert_nothing_mailed

data/test/mocks/controllers.rb

@@ -13,23 +13,51 @@ class Application < ActionController::Base
   def runtime_error
     raise "This is a runtime error that we should be emailed about"
   end
-  
+
   def record_not_found
     raise ActiveRecord::RecordNotFound
   end
-  
+
+  def unknown_controller
+    raise ActionController::UnknownController
+  end
+
   def local_request?
     false
   end
   
 end
 
-class OldStyle < Application
+class SpecialErrorThing < RuntimeError
+end
+
+class CustomSilentExceptions < Application
   include ExceptionNotifiable
   self.exception_notifier_verbose = false
+  self.silent_exceptions = [RuntimeError]
 end
 
-class SpecialErrorThing < RuntimeError
+class EmptySilentExceptions < Application
+  include ExceptionNotifiable
+  self.exception_notifier_verbose = false
+  self.silent_exceptions = []
+end
+
+class NilSilentExceptions < Application
+  include ExceptionNotifiable
+  self.exception_notifier_verbose = false
+  self.silent_exceptions = nil
+end
+
+class DefaultSilentExceptions < Application
+  include ExceptionNotifiable
+  self.exception_notifier_verbose = false
+  puts self.silent_exceptions.inspect
+end
+
+class OldStyle < Application
+  include ExceptionNotifiable
+  self.exception_notifier_verbose = false
 end
 
 class NewStyle < Application

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: pboling-super_exception_notifier
 version: !ruby/object:Gem::Version 
-  version: 1.6.8
+  version: 1.7.0
 platform: ruby
 authors: 
 - Peter Boling
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-15 00:00:00 -07:00
+date: 2009-08-16 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -24,7 +24,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "2.1"
     version: 
-description: "Allows customization of: * the sender address of the email * the recipient addresses * the text used to prefix the subject line * the HTTP status codes to send emails for * the error classes to send emails for * alternatively, the error classes to not send emails for * whether to send error emails or just render without sending anything * the HTTP status and status code that gets rendered with specific errors * the view path to the error page templates * custom errors, with custom error templates * define error layouts at application or controller level, or use the controller's own default layout, or no layout at all * get error notification for errors that occur in the console, using notifiable method * Override the gem's handling and rendering with explicit rescue statements inline. * Hooks into `git blame` output so you can get an idea of who (may) have introduced the bug * Hooks into other website services (e.g. you can send exceptions to to Switchub.com) * Specify which level of notification you would like with an array of optional styles of notification"
+description: "Allows customization of: * Specify which level of notification you would like with an array of optional styles of notification (email, webhooks) * the sender address of the email * the recipient addresses * the text used to prefix the subject line * the HTTP status codes to notify for * the error classes to send emails for * alternatively, the error classes to not notify for * whether to send error emails or just render without sending anything * the HTTP status and status code that gets rendered with specific errors * the view path to the error page templates * custom errors, with custom error templates * define error layouts at application or controller level, or use the controller's own default layout, or no layout at all * get error notification for errors that occur in the console, using notifiable method * Override the gem's handling and rendering with explicit rescue statements inline. * Hooks into `git blame` output so you can get an idea of who (may) have introduced the bug * Hooks into other website services (e.g. you can send exceptions to to Switchub.com)"
 email: peter.boling@gmail.com
 executables: []