super_exception_notifier 2.0.8 → 3.0.1

data/{README.rdoc → README}

@@ -40,7 +40,7 @@ branch.
 
 The venerable original is here:
  
-  http://github.com/rails/exception_notification/tree/master
+  http://github.com/rails/exception_notification
 
 The current version of this gem is a git fork of the original and
 has been updated to include the latest improvements from the original, 
@@ -52,10 +52,6 @@ This fork of Exception Notifier is in production use on several large websites (
 
 == Installation as RubyGem
 
-Gemcutter is the hot new gem host, and you can use it like this:
-
-  [sudo] gem install gemcutter
-  [sudo] gem tumble # makes gemcutter gem source first in line
   [sudo] gem install super_exception_notifier
 
 == Installation as RubyGem from source
@@ -93,7 +89,7 @@ These are settings that are global for SEN wherever it is used in your project.
 You can tweak other values to your liking, as well. In your environment file or initializer,
 just set any or all of the following values (defaults are shown):
 
-  ExceptionNotifier.configure_exception_notifier do |config|
+  ExceptionNotification::Notifier.configure_exception_notifier do |config|
     # If left empty web hooks will not be engaged
     config[:web_hooks]                = []
     config[:app_name]                 = "[MYAPP]"
@@ -158,7 +154,7 @@ to generate error emails (typically ApplicationController):
 
 2. Specify the email recipients in your environment:
 
-  ExceptionNotifier.configure_exception_notifier do |config|
+  ExceptionNotification::Notifier.configure_exception_notifier do |config|
     config[:exception_recipients] = %w(joe@example.com bill@example.com)
   end
 
@@ -307,7 +303,7 @@ Then you can specify which of those should send out emails!
 By default, the email notifier will only notify on critical errors (405 500 503 statuses).
 For example, ActiveRecord::RecordNotFound and ActionController::UnknownAction errors will simply render the contents of #{this gem's root}/rails/app/views/exception_notifiable/###.html file, where ### is 400 and 501 respectively.
 
-  ExceptionNotifier.config[:send_email_error_codes] = %w( 400 405 500 503 )
+  ExceptionNotification::Notifier.config[:send_email_error_codes] = %w( 400 405 500 503 )
 
 You can also configure the text of the HTTP request's response status code: (by default only the last 6 will be handled, the first 6 are made up error classes)
 Example in application.rb or on a per-controller basis:
@@ -345,7 +341,7 @@ They can be used like this in a controller:
    
 You may also configure which HTTP status codes will send out email: (by default = [], email sending is defined by status code only)
 
-  ExceptionNotifier.config[:send_email_error_classes] = [	
+  ExceptionNotification::Notifier.config[:send_email_error_classes] = [
     NameError, 
     TypeError, 
     ActionController::RoutingError 
@@ -356,16 +352,16 @@ Email will be sent if the error matches one of the error classes to send email f
 You can also customize what is rendered. SuperExceptionNotifier will render the first file it finds in this order:
 
   #{RAILS_ROOT}/public/###.html
-  #{RAILS_ROOT}/#{ExceptionNotifier.config[:view_path]}/###.html
+  #{RAILS_ROOT}/#{ExceptionNotification::Notifier.config[:view_path]}/###.html
   #{this gem's root}/rails/app/views/exception_notifiable/#{status_cd}.html
 
 And if none of those paths has a valid file to render, this one wins:
 
   #{this gem's root}/rails/app/views/exception_notifiable/500.html
 
-You can configure ExceptionNotifier.config[:view_path] in your environment file like this:
+You can configure ExceptionNotification::Notifier.config[:view_path] in your environment file like this:
 
-  ExceptionNotifier.config[:view_path] = 'app/views/error'
+  ExceptionNotification::Notifier.config[:view_path] = 'app/views/error'
 
 So public trumps your custom path which trumps the gem's default path.
 
@@ -380,14 +376,14 @@ You can render CUSTOM error pages! Here's how:
   3. Setup SuperExceptionNotifier to handle the error, in app/controllers/application.rb:
     * self.error_class_status_codes = { InsufficientFundsForWithdrawal => "200" }
   4. Set your custom error's view path:
-    * ExceptionNotifier.config[:view_path] = 'app/views/error'
+    * ExceptionNotification::Notifier.config[:view_path] = 'app/views/error'
   5. Create a view for the error. SuperExceptionNotifier munges the error's class by converting to a string and then replacing consecutive ':' with '' and then downcases it:
     * touch app/views/error/insufficient_funds_for_withdrawal.html
   6. If you want a custom layout (by default it will render the error with the layout the controller is using) you just need to set, in application.rb (or per-controller):
     * self.error_layout = 'my_error_layout' #or = true for the same layout as the controller, or = false for no layout
   7. That's it! All errors that are set to be handled with a status of "200" will render a custom page.
   8. If you want to have errors that render custom pages also send emails then you'll need to:
-    * ExceptionNotifier.config[:send_email_error_classes] = [ InsufficientFundsForWithdrawal ]
+    * ExceptionNotification::Notifier.config[:send_email_error_classes] = [ InsufficientFundsForWithdrawal ]
 
 == Customization
 
@@ -407,7 +403,7 @@ access to the following variables:
 * @sections: the array of sections to include in the email
 
 You can reorder the sections, or exclude sections completely, by altering the
-ExceptionNotifier.config[:sections] variable.
+ExceptionNotification::Notifier.config[:sections] variable.
 
 == Not working due to nature of gem vs plugin
 
@@ -509,13 +505,13 @@ so put this in a stylesheet you are including in your app to get you started (li
 == jamescook changes
 
 Hooks into `git blame` output so you can get an idea of who (may) have introduced the bug :)
--- Usage: set ExceptionNotifier.config[:git_repo_path] to the path of your git repo.
+-- Usage: set ExceptionNotification::Notifier.config[:git_repo_path] to the path of your git repo.
 
 == ismasan changes
 
 POST exception data in JSON format to the specified services for processing
 -- Usage:
-  ExceptionNotifier.configure_exception_notifier do |config|
+  ExceptionNotification::Notifier.configure_exception_notifier do |config|
       config[:web_hooks]            = %w(http://some-hook-service.example.com http://another-hook-service.example.com) # defaults to []
       config[:app_name]             = "[APP]" # defaults to [MYAPP]
       config[:exception_recipients] = %w(my@example.com another@example.com) # defaults to []

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
-:major: 2
-:minor: 0
-:patch: 8
+:patch: 1
+:major: 3
 :build: 
+:minor: 0

data/lib/exception_notification.rb

@@ -0,0 +1,15 @@
+require "action_mailer"
+module ExceptionNotification
+  autoload :ExceptionNotifiable, 'exception_notification/exception_notifiable'
+  autoload :Notifiable, 'exception_notification/notifiable'
+  autoload :Notifier, 'exception_notification/notifier'
+  #autoload :NotifierHelper, 'exception_notifiable/notifier_helper'
+  autoload :ConsiderLocal,  'exception_notification/consider_local'
+  autoload :CustomExceptionClasses,  'exception_notification/custom_exception_classes'
+  autoload :CustomExceptionMethods,  'exception_notification/custom_exception_methods'
+  autoload :HelpfulHashes,  'exception_notification/helpful_hashes'
+  autoload :GitBlame,  'exception_notification/git_blame'
+  autoload :DeprecatedMethods,  'exception_notification/deprecated_methods'
+  autoload :HooksNotifier,  'exception_notification/hooks_notifier'
+  autoload :NotifiableHelper,  'exception_notification/notifiable_helper'
+end

data/rails/init.rb

@@ -1,21 +1,17 @@
+puts "Begin Loading ExceptionNotification"
+require 'rake'
+require 'rake/tasklib'
 require "action_mailer"
 
-require "super_exception_notifier/custom_exception_classes"
-require "super_exception_notifier/custom_exception_methods"
-require "super_exception_notifier/helpful_hashes"
-require "super_exception_notifier/git_blame"
-require "super_exception_notifier/deprecated_methods"
-require "super_exception_notifier/hooks_notifier"
-require "super_exception_notifier/notifiable_helper"
+require "exception_notification/notified_task" unless defined?(NotifiedTask)
 
-require "exception_notifier_helper" unless defined?(ExceptionNotifierHelper)
-require "exception_notifier" unless defined?(ExceptionNotifier)
-require "exception_notifiable" unless defined?(ExceptionNotifiable)
-require "notifiable" unless defined?(Notifiable)
+require "exception_notification" unless defined?(ExceptionNotification)
 
 Object.class_eval do
-  include Notifiable
+  include ExceptionNotification::Notifiable
 end
+puts "Object test: #{Object.respond_to?(:notifiable_noisy_environments) ? 'Pass' : 'Fail'}"
+puts "Finished Loading ExceptionNotification"
 
 #It appears that the view path is auto-added by rails... hmmm.
 #if ActionController::Base.respond_to?(:append_view_path)

data/super_exception_notifier.gemspec

@@ -0,0 +1,88 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{super_exception_notifier}
+  s.version = "3.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Peter Boling", "Scott Windsor", "Ismael Celis", "Jacques Crocker", "Jamis Buck"]
+  s.date = %q{2010-05-13}
+  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 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)
+* Can notify of errors occurring in any class/method using notifiable { method }
+* Can notify of errors in Rake tasks using NotifiedTask.new instead of task}
+  s.email = %q{peter.boling@gmail.com}
+  s.extra_rdoc_files = [
+    "README"
+  ]
+  s.files = [
+    "MIT-LICENSE",
+     "README",
+     "VERSION.yml",
+     "init.rb",
+     "lib/exception_notification.rb",
+     "rails/app/views/exception_notifiable/400.html",
+     "rails/app/views/exception_notifiable/403.html",
+     "rails/app/views/exception_notifiable/404.html",
+     "rails/app/views/exception_notifiable/405.html",
+     "rails/app/views/exception_notifiable/410.html",
+     "rails/app/views/exception_notifiable/418.html",
+     "rails/app/views/exception_notifiable/422.html",
+     "rails/app/views/exception_notifiable/423.html",
+     "rails/app/views/exception_notifiable/500.html",
+     "rails/app/views/exception_notifiable/501.html",
+     "rails/app/views/exception_notifiable/503.html",
+     "rails/app/views/exception_notifiable/method_disabled.html.erb",
+     "rails/init.rb",
+     "super_exception_notifier.gemspec"
+  ]
+  s.homepage = %q{http://github.com/pboling/exception_notifiable}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Allows unhandled (and handled!) exceptions to be captured and sent via email}
+  s.test_files = [
+    "test/exception_notifiable_test.rb",
+     "test/exception_notifier_helper_test.rb",
+     "test/exception_notifier_test.rb",
+     "test/exception_notify_functional_test.rb",
+     "test/mocks/controllers.rb",
+     "test/notifiable_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<action_mailer>, [">= 0"])
+      s.add_runtime_dependency(%q<rake>, [">= 0"])
+    else
+      s.add_dependency(%q<action_mailer>, [">= 0"])
+      s.add_dependency(%q<rake>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<action_mailer>, [">= 0"])
+    s.add_dependency(%q<rake>, [">= 0"])
+  end
+end
+

data/test/exception_notifier_helper_test.rb

@@ -1,10 +1,10 @@
 require File.dirname(__FILE__) + '/test_helper'
-require 'exception_notifier_helper'
+#require 'exception_notification/notifier_helper'
 
 class ExceptionNotifierHelperTest < Test::Unit::TestCase
 
   class ExceptionNotifierHelperIncludeTarget
-    include ExceptionNotifierHelper
+    include ExceptionNotification::NotifierHelper
   end
 
   def setup
@@ -61,14 +61,6 @@ class ExceptionNotifierHelperTest < Test::Unit::TestCase
     assert_equal :filtered, @helper.filter_sensitive_post_data_parameters(:secret)
   end
 
-  def test_compat_mode_constant
-    if defined?(RAILS_GEM_VERSION)
-      assert_equal(ExceptionNotifierHelper::COMPAT_MODE, RAILS_GEM_VERSION >= 2)
-    else
-      assert_equal(ExceptionNotifierHelper::COMPAT_MODE, false)
-    end
-  end
-
   private
     def stub_controller(controller)
       @helper.instance_variable_set(:@controller, controller)

data/test/exception_notifier_test.rb

@@ -23,7 +23,7 @@ class ExceptionNotifierTest < Test::Unit::TestCase
       raise 'problem'
     rescue RuntimeError => e
       assert_nothing_raised do
-        ExceptionNotifier.deliver_exception_notification(e)
+        ExceptionNotification::Notifier.deliver_exception_notification(e)
       end
     end
   end
@@ -33,7 +33,7 @@ class ExceptionNotifierTest < Test::Unit::TestCase
       raise 'problem'
     rescue RuntimeError => e
       assert_nothing_raised do
-        ExceptionNotifier.deliver_exception_notification(e, @controller, @controller.request)
+        ExceptionNotification::Notifier.deliver_exception_notification(e, @controller, @controller.request)
       end
     end
   end

data/test/exception_notify_functional_test.rb

@@ -36,9 +36,9 @@ class ExceptionNotifyFunctionalTest < ActionController::TestCase
   def test_view_path_empty; assert_view_path_for_status_cd_is_string(""); end
   def test_view_path_nonsense; assert_view_path_for_status_cd_is_string("slartibartfarst"); end
   def test_view_path_class;
-    exception = SuperExceptionNotifier::CustomExceptionClasses::MethodDisabled
+    exception = ExceptionNotification::CustomExceptionClasses::MethodDisabled
     assert_view_path_for_class_is_string(exception);
-    assert ExceptionNotifier.get_view_path_for_class(exception).match("/rails/app/views/exception_notifiable/method_disabled.html.erb")
+    assert ExceptionNotification::Notifier.get_view_path_for_class(exception).match("/rails/app/views/exception_notifiable/method_disabled.html.erb")
   end
   def test_view_path_class_nil; assert_view_path_for_class_is_string(nil); end
   def test_view_path_class_empty; assert_view_path_for_class_is_string(""); end
@@ -46,7 +46,7 @@ class ExceptionNotifyFunctionalTest < ActionController::TestCase
   def test_view_path_class_integer; assert_view_path_for_class_is_string(Integer); end
 
   def test_exception_to_filenames
-    assert(["super_exception_notifier_custom_exception_classes_method_disabled", "method_disabled"] == ExceptionNotifier.exception_to_filenames(SuperExceptionNotifier::CustomExceptionClasses::MethodDisabled))
+    assert(["exception_notification_custom_exception_classes_method_disabled", "method_disabled"] == ExceptionNotification::Notifier.exception_to_filenames(ExceptionNotification::CustomExceptionClasses::MethodDisabled))
   end
 
   def test_old_style_where_requests_are_local
@@ -59,7 +59,7 @@ class ExceptionNotifyFunctionalTest < ActionController::TestCase
   def test_new_style_where_requests_are_local
     ActionController::Base.consider_all_requests_local = true
     @controller = NewStyle.new
-    ExceptionNotifier.config[:skip_local_notification] = true
+    ExceptionNotification::Notifier.config[:skip_local_notification] = true
     get "runtime_error"
     assert_nothing_mailed
   end
@@ -115,11 +115,11 @@ class ExceptionNotifyFunctionalTest < ActionController::TestCase
   private
 
   def assert_view_path_for_status_cd_is_string(status)
-    assert(ExceptionNotifier.get_view_path_for_status_code(status).is_a?(String), "View Path is not a string for status code '#{status}'")
+    assert(ExceptionNotification::Notifier.get_view_path_for_status_code(status).is_a?(String), "View Path is not a string for status code '#{status}'")
   end
 
   def assert_view_path_for_class_is_string(exception)
-    assert(ExceptionNotifier.get_view_path_for_class(exception).is_a?(String), "View Path is not a string for exception '#{exception}'")
+    assert(ExceptionNotification::Notifier.get_view_path_for_class(exception).is_a?(String), "View Path is not a string for exception '#{exception}'")
   end
 
   def assert_error_mail_contains(text)

data/test/mocks/controllers.rb

@@ -8,7 +8,7 @@ module Rails
   end
 end
 
-class Application < ActionController::Base
+class ApplicationController < ActionController::Base
 
   def runtime_error
     raise "This is a runtime error that we should be emailed about"
@@ -36,40 +36,47 @@ end
 class SpecialErrorThing < RuntimeError
 end
 
-class BasicController < Application
-  include ExceptionNotifiable
+class BasicController < ApplicationController
+  include ExceptionNotification::ExceptionNotifiable
+  self.exception_notifiable_noisy_environments = ['test']
 end
 
-class CustomSilentExceptions < Application
-  include ExceptionNotifiable
+class CustomSilentExceptions < ApplicationController
+  include ExceptionNotification::ExceptionNotifiable
+  self.exception_notifiable_noisy_environments = ['test']
   self.exception_notifiable_verbose = false
   self.exception_notifiable_silent_exceptions = [RuntimeError]
 end
 
-class EmptySilentExceptions < Application
-  include ExceptionNotifiable
+class EmptySilentExceptions < ApplicationController
+  include ExceptionNotification::ExceptionNotifiable
+  self.exception_notifiable_noisy_environments = ['test']
   self.exception_notifiable_verbose = false
   self.exception_notifiable_silent_exceptions = []
 end
 
-class NilSilentExceptions < Application
-  include ExceptionNotifiable
+class NilSilentExceptions < ApplicationController
+  include ExceptionNotification::ExceptionNotifiable
+  self.exception_notifiable_noisy_environments = ['test']
   self.exception_notifiable_verbose = false
   self.exception_notifiable_silent_exceptions = nil
 end
 
-class DefaultSilentExceptions < Application
-  include ExceptionNotifiable
+class DefaultSilentExceptions < ApplicationController
+  include ExceptionNotification::ExceptionNotifiable
+  self.exception_notifiable_noisy_environments = ['test']
   self.exception_notifiable_verbose = false
 end
 
-class OldStyle < Application
-  include ExceptionNotifiable
+class OldStyle < ApplicationController
+  include ExceptionNotification::ExceptionNotifiable
+  self.exception_notifiable_noisy_environments = ['test']
   self.exception_notifiable_verbose = false
 end
 
-class NewStyle < Application
-  include ExceptionNotifiable
+class NewStyle < ApplicationController
+  include ExceptionNotification::ExceptionNotifiable
+  self.exception_notifiable_noisy_environments = ['test']
   self.exception_notifiable_verbose = false
     
   rescue_from ActiveRecord::RecordNotFound do |exception|

data/test/notifiable_test.rb

@@ -5,7 +5,7 @@ require 'test/unit'
 class Spaceship
   # It is included by the init.rb in the Object super class,
   #   so we don't actually need to do anything to get notifiable { method } goodness.
-  #include Notifiable
+  #include ExceptionNotifiable.rb
 end
 
 class SpaceCarrier < Spaceship
@@ -25,7 +25,7 @@ class NotifiableTest < Test::Unit::TestCase
   def test_notifiable_in_noisy_environment
     @class = Spaceship.new
     Spaceship.notifiable_noisy_environments = ['test']
-    ExceptionNotifier.config[:skip_local_notification] = true
+    ExceptionNotification::Notifier.config[:skip_local_notification] = true
     assert_raises( AccessDenied ) {
       notifiable { @class.access_denied }
       assert_error_mail_contains("AccessDenied")
@@ -35,7 +35,7 @@ class NotifiableTest < Test::Unit::TestCase
   def test_notifiable_in_quiet_environment_not_skipping_local
     @class = Spaceship.new
     Spaceship.notifiable_noisy_environments = []
-    ExceptionNotifier.config[:skip_local_notification] = false
+    ExceptionNotification::Notifier.config[:skip_local_notification] = false
     assert_raises( AccessDenied ) {
       notifiable { @class.access_denied }
       assert_error_mail_contains("AccessDenied")
@@ -45,7 +45,7 @@ class NotifiableTest < Test::Unit::TestCase
   def test_notifiable_in_quiet_environment_skipping_local
     @class = Spaceship.new
     Spaceship.notifiable_noisy_environments = []
-    ExceptionNotifier.config[:skip_local_notification] = true
+    ExceptionNotification::Notifier.config[:skip_local_notification] = true
     assert_raises( AccessDenied ) {
       notifiable { @class.access_denied }
       assert_nothing_mailed
@@ -55,11 +55,11 @@ class NotifiableTest < Test::Unit::TestCase
   private
 
   def assert_view_path_for_status_cd_is_string(status)
-    assert(ExceptionNotifier.get_view_path_for_status_code(status).is_a?(String), "View Path is not a string for status code '#{status}'")
+    assert(ExceptionNotification::Notifier.get_view_path_for_status_code(status).is_a?(String), "View Path is not a string for status code '#{status}'")
   end
 
   def assert_view_path_for_class_is_string(exception)
-    assert(ExceptionNotifier.get_view_path_for_class(exception).is_a?(String), "View Path is not a string for exception '#{exception}'")
+    assert(ExceptionNotification::Notifier.get_view_path_for_class(exception).is_a?(String), "View Path is not a string for exception '#{exception}'")
   end
 
   def assert_error_mail_contains(text)