super_exception_notifier 2.0.0

data/rails/app/views/exception_notifiable/501.html

@@ -0,0 +1,8 @@
+<!-- This file lives in gems/super_exception_notifier/rails/app/views/exception_notifiable/501.html. See Readme for instructions on customizing. -->
+<div class="dialog">
+  <h1>Not Implemented</h1>
+
+  <p>Please remove bookmarks to this resource.</p>
+	<p>You have tried to access a feature that has not been implemented.</p> 
+	<p>If you arrived here via a link from somewhere else please inform them of the broken link.</p>
+</div>

data/rails/app/views/exception_notifiable/503.html

@@ -0,0 +1,6 @@
+<!-- This file lives in gems/super_exception_notifier/rails/app/views/exception_notifiable/503.html. See Readme for instructions on customizing. -->
+<div class="dialog">
+    <h1>The server is temporarily unavailable.</h1>
+  
+    <p>The resource you requested is temporarilly unavailable due to server overload, maintenance, or other downtime. Generally, this is a temporary state.</p>
+</div>

data/rails/app/views/exception_notifiable/method_disabled.html.erb

@@ -0,0 +1,6 @@
+<!-- This file lives in gems/super_exception_notifier/rails/app/views/exception_notifiable/method_disabled.html.erb. See Readme for instructions on customizing. -->
+<div class="dialog">
+    <h1>Method Disabled.</h1>
+
+    <p>You attempted to access <%= params[:controller].humanize %> <%= params[:action] %> but that method is currently disabled.  Reloading the page will not help unless and until the method is enabled by the system administrator.</p>
+</div>

data/rails/init.rb

@@ -0,0 +1,25 @@
+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_notifier_helper" unless defined?(ExceptionNotifierHelper)
+require "exception_notifier" unless defined?(ExceptionNotifier)
+require "exception_notifiable" unless defined?(ExceptionNotifiable)
+require "notifiable" unless defined?(Notifiable)
+
+Object.class_eval do
+  include Notifiable
+end
+
+#It appears that the view path is auto-added by rails... hmmm.
+#if ActionController::Base.respond_to?(:append_view_path)
+#  puts "view path before: #{ActionController::Base.view_paths}"
+#  ActionController::Base.append_view_path(File.join(File.dirname(__FILE__), 'app', 'views','exception_notifiable'))
+#  puts "view path After: #{ActionController::Base.view_paths}"
+#end

data/tasks/notified_task.rake

@@ -0,0 +1,15 @@
+class NotifiedTask < Rake::TaskLib
+  attr_accessor :name, :block
+
+  def initialize(name, &block)
+    @name = name
+    @block = block
+    define
+  end
+
+  def define
+    task name do |t|
+      notifiable { block.call }
+    end
+  end
+end

data/test/exception_notifiable_test.rb

@@ -0,0 +1,34 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class ExceptionNotifiableTest < Test::Unit::TestCase
+
+  def setup
+    @controller = BasicController.new
+  end
+
+  #Tests for the default values when ExceptionNotifiable is included in a controller
+  def test_default_http_status_codes
+    assert(BasicController.http_status_codes == HTTP_STATUS_CODES, "Default http_status_codes is incorrect")
+  end
+
+  def test_default_error_layout
+    assert(BasicController.error_layout == nil, "Default error_layout is incorrect")
+  end
+
+  def test_default_error_class_status_codes
+    assert(BasicController.error_class_status_codes == BasicController.codes_for_error_classes, "Default error_class_status_codes is incorrect")
+  end
+
+  def test_default_exception_notifiable_verbose
+    assert(BasicController.exception_notifiable_verbose == false, "Default exception_notifiable_verbose is incorrect")
+  end
+
+  def test_default_exception_notifiable_silent_exceptions
+    assert(BasicController.exception_notifiable_silent_exceptions == SILENT_EXCEPTIONS, "Default exception_notifiable_silent_exceptions is incorrect")
+  end
+
+  def test_default_exception_notifiable_notification_level
+    assert(BasicController.exception_notifiable_notification_level == [:render, :email, :web_hooks], "Default exception_notifiable_notification_level is incorrect")
+  end
+
+end

data/test/exception_notifier_helper_test.rb

@@ -0,0 +1,76 @@
+require File.dirname(__FILE__) + '/test_helper'
+require 'exception_notifier_helper'
+
+class ExceptionNotifierHelperTest < Test::Unit::TestCase
+
+  class ExceptionNotifierHelperIncludeTarget
+    include ExceptionNotifierHelper
+  end
+
+  def setup
+    @helper = ExceptionNotifierHelperIncludeTarget.new
+  end
+
+  # No controller
+
+  def test_should_not_exclude_raw_post_parameters_if_no_controller
+    assert !@helper.exclude_raw_post_parameters?
+  end
+
+  # Controller, no filtering
+
+  class ControllerWithoutFilterParameters; end
+
+  def test_should_not_filter_env_values_for_raw_post_data_keys_if_controller_can_not_filter_parameters
+    stub_controller(ControllerWithoutFilterParameters.new)
+    assert @helper.filter_sensitive_post_data_from_env("RAW_POST_DATA", "secret").include?("secret")
+  end
+  def test_should_not_exclude_raw_post_parameters_if_controller_can_not_filter_parameters
+    stub_controller(ControllerWithoutFilterParameters.new)
+    assert !@helper.exclude_raw_post_parameters?
+  end
+  def test_should_return_params_if_controller_can_not_filter_parameters
+    stub_controller(ControllerWithoutFilterParameters.new)
+    assert_equal :params, @helper.filter_sensitive_post_data_parameters(:params)
+  end
+
+  # Controller with filter paramaters method, no params to filter
+
+  class ControllerWithFilterParametersThatDoesntFilter
+    def filter_parameters(params); params end
+  end
+
+  def test_should_filter_env_values_for_raw_post_data_keys_if_controller_can_filter_parameters
+    stub_controller(ControllerWithFilterParametersThatDoesntFilter.new)
+    assert !@helper.filter_sensitive_post_data_from_env("RAW_POST_DATA", "secret").include?("secret")
+    assert @helper.filter_sensitive_post_data_from_env("SOME_OTHER_KEY", "secret").include?("secret")
+  end
+  def test_should_exclude_raw_post_parameters_if_controller_can_filter_parameters
+    stub_controller(ControllerWithFilterParametersThatDoesntFilter.new)
+    assert @helper.exclude_raw_post_parameters?
+  end
+
+  # Controller with filter paramaters method, filtering a secret param
+
+  class ControllerWithFilterParametersThatDoesFilter
+    def filter_parameters(params); :filtered end
+  end
+
+  def test_should_delegate_param_filtering_to_controller_if_controller_can_filter_parameters
+    stub_controller(ControllerWithFilterParametersThatDoesFilter.new)
+    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)
+    end
+end

data/test/exception_notifier_test.rb

@@ -0,0 +1,41 @@
+require File.dirname(__FILE__) + '/test_helper'
+require 'action_controller/test_process'
+
+class ExceptionNotifierTest < Test::Unit::TestCase
+  
+  def setup
+    @controller = ActionController::Base.new
+    @controller.request = ActionController::TestRequest.new
+    @controller.response = ActionController::TestResponse.new
+    @controller.params = {}
+    @controller.send(:initialize_current_url)
+    ActionController::Base.consider_all_requests_local = false
+    @@delivered_mail = []
+    ActionMailer::Base.class_eval do
+      def deliver!(mail = @mail)
+        @@delivered_mail << mail
+      end
+    end
+  end
+
+  def test_should_generate_message_without_controller
+    begin
+      raise 'problem'
+    rescue RuntimeError => e
+      assert_nothing_raised do
+        ExceptionNotifier.deliver_exception_notification(e)
+      end
+    end
+  end
+
+  def test_should_generate_message_with_controller
+    begin
+      raise 'problem'
+    rescue RuntimeError => e
+      assert_nothing_raised do
+        ExceptionNotifier.deliver_exception_notification(e, @controller, @controller.request)
+      end
+    end
+  end
+
+end

data/test/exception_notify_functional_test.rb

@@ -0,0 +1,139 @@
+require File.expand_path(File.dirname(__FILE__) + '/test_helper')
+require 'test/unit'
+
+require File.join(File.dirname(__FILE__), 'mocks/controllers')
+
+ActionController::Routing::Routes.clear!
+ActionController::Routing::Routes.draw {|m| m.connect ':controller/:action/:id' }
+
+class ExceptionNotifyFunctionalTest < ActionController::TestCase
+  
+  def setup
+    @request    = ActionController::TestRequest.new
+    @response   = ActionController::TestResponse.new    
+    ActionController::Base.consider_all_requests_local = false
+    @@delivered_mail = []
+    ActionMailer::Base.class_eval do
+      def deliver!(mail = @mail)
+        @@delivered_mail << mail
+      end
+    end    
+  end
+
+  def test_view_path_200; assert_view_path_for_status_cd_is_string("200"); end
+  def test_view_path_400; assert_view_path_for_status_cd_is_string("400"); end
+  def test_view_path_403; assert_view_path_for_status_cd_is_string("403"); end
+  def test_view_path_404; assert_view_path_for_status_cd_is_string("404"); end
+  def test_view_path_405; assert_view_path_for_status_cd_is_string("405"); end
+  def test_view_path_410; assert_view_path_for_status_cd_is_string("410"); end
+  def test_view_path_418; assert_view_path_for_status_cd_is_string("422"); end
+  def test_view_path_422; assert_view_path_for_status_cd_is_string("422"); end
+  def test_view_path_423; assert_view_path_for_status_cd_is_string("423"); end
+  def test_view_path_500; assert_view_path_for_status_cd_is_string("500"); end
+  def test_view_path_501; assert_view_path_for_status_cd_is_string("501"); end
+  def test_view_path_503; assert_view_path_for_status_cd_is_string("503"); end
+  def test_view_path_nil; assert_view_path_for_status_cd_is_string(nil); end
+  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
+    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")
+  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
+  def test_view_path_class_nonsense; assert_view_path_for_class_is_string("slartibartfarst"); end
+  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))
+  end
+
+  def test_old_style_where_requests_are_local
+    ActionController::Base.consider_all_requests_local = true
+    @controller = OldStyle.new
+    get "runtime_error"    
+    assert_nothing_mailed
+  end
+
+  def test_new_style_where_requests_are_local
+    ActionController::Base.consider_all_requests_local = true
+    @controller = NewStyle.new
+    ExceptionNotifier.config[:skip_local_notification] = true
+    get "runtime_error"
+    assert_nothing_mailed
+  end
+  
+  def test_old_style_runtime_error_sends_mail
+    @controller = OldStyle.new
+    get "runtime_error"
+    assert_error_mail_contains("This is a runtime error that we should be emailed about")
+  end
+  
+  def test_old_style_record_not_found_does_not_send_mail
+    @controller = OldStyle.new
+    get "ar_record_not_found"
+    assert_nothing_mailed
+  end
+  
+  def test_new_style_runtime_error_sends_mail
+    @controller = NewStyle.new
+    get "runtime_error"
+    assert_error_mail_contains("This is a runtime error that we should be emailed about")    
+  end
+  
+  def test_new_style_record_not_found_does_not_send_mail
+    @controller = NewStyle.new
+    get "ar_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 "ar_record_not_found"
+    assert_error_mail_contains("ActiveRecord::RecordNotFound")
+  end
+
+  def test_controller_with_nil_silent_exceptions
+    @controller = NilSilentExceptions.new
+    get "ar_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)
+    assert(ExceptionNotifier.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}'")
+  end
+
+  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}")
+  end
+  
+  def assert_nothing_mailed
+    assert @@delivered_mail.empty?, "Expected to have NOT mailed out a notification about an error occuring, but mailed: \n#{@@delivered_mail}"
+  end
+  
+  def mailed_error
+    assert @@delivered_mail.last, "Expected to have mailed out a notification about an error occuring, but none mailed"
+    @@delivered_mail.last.encoded
+  end
+  
+end

data/test/mocks/controllers.rb

@@ -0,0 +1,82 @@
+module Rails
+  def self.public_path
+    File.dirname(__FILE__)
+  end
+
+  def self.env
+    'test'
+  end
+end
+
+class Application < ActionController::Base
+
+  def runtime_error
+    raise "This is a runtime error that we should be emailed about"
+  end
+
+  def ar_record_not_found
+    #From SuperExceptionNotifier::CustomExceptionMethods
+    record_not_found
+  end
+
+  def name_error
+    raise NameError
+  end
+
+  def unknown_controller
+    raise ActionController::UnknownController
+  end
+
+  def local_request?
+    false
+  end
+  
+end
+
+class SpecialErrorThing < RuntimeError
+end
+
+class BasicController < Application
+  include ExceptionNotifiable
+end
+
+class CustomSilentExceptions < Application
+  include ExceptionNotifiable
+  self.exception_notifiable_verbose = false
+  self.exception_notifiable_silent_exceptions = [RuntimeError]
+end
+
+class EmptySilentExceptions < Application
+  include ExceptionNotifiable
+  self.exception_notifiable_verbose = false
+  self.exception_notifiable_silent_exceptions = []
+end
+
+class NilSilentExceptions < Application
+  include ExceptionNotifiable
+  self.exception_notifiable_verbose = false
+  self.exception_notifiable_silent_exceptions = nil
+end
+
+class DefaultSilentExceptions < Application
+  include ExceptionNotifiable
+  self.exception_notifiable_verbose = false
+end
+
+class OldStyle < Application
+  include ExceptionNotifiable
+  self.exception_notifiable_verbose = false
+end
+
+class NewStyle < Application
+  include ExceptionNotifiable
+  self.exception_notifiable_verbose = false
+    
+  rescue_from ActiveRecord::RecordNotFound do |exception|
+    render :text => "404", :status => 404
+  end
+
+  rescue_from RuntimeError do |exception|
+    render :text => "500", :status => 500
+  end
+end

data/test/notifiable_test.rb

@@ -0,0 +1,79 @@
+# This is to test the ability to handle exceptions raised outside of the request response cycle
+require File.expand_path(File.dirname(__FILE__) + '/test_helper')
+require 'test/unit'
+
+class Spaceship
+  # It is included by the init.rb in hte Object super class,
+  #   so we don't actually need to do anything to get notifiable { method } goodness.
+  #include Notifiable
+end
+
+class SpaceCarrier < Spaceship
+end
+
+class NotifiableTest < Test::Unit::TestCase
+
+  def setup
+    @@delivered_mail = []
+    ActionMailer::Base.class_eval do
+      def deliver!(mail = @mail)
+        @@delivered_mail << mail
+      end
+    end
+  end
+
+  def test_notifiable_in_noisy_environment
+    @class = Spaceship.new
+    Spaceship.notifiable_noisy_environments = ['test']
+    ExceptionNotifier.config[:skip_local_notification] = true
+    assert_raises( AccessDenied ) {
+      notifiable { @class.access_denied }
+      assert_error_mail_contains("AccessDenied")
+    }
+  end
+
+  def test_notifiable_in_quiet_environment_not_skipping_local
+    @class = Spaceship.new
+    Spaceship.notifiable_noisy_environments = []
+    ExceptionNotifier.config[:skip_local_notification] = false
+    assert_raises( AccessDenied ) {
+      notifiable { @class.access_denied }
+      assert_error_mail_contains("AccessDenied")
+    }
+  end
+
+  def test_notifiable_in_quiet_environment_skipping_local
+    @class = Spaceship.new
+    Spaceship.notifiable_noisy_environments = []
+    ExceptionNotifier.config[:skip_local_notification] = true
+    assert_raises( AccessDenied ) {
+      notifiable { @class.access_denied }
+      assert_nothing_mailed
+    }
+  end
+
+  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}'")
+  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}'")
+  end
+
+  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}")
+  end
+
+  def assert_nothing_mailed
+    assert @@delivered_mail.empty?, "Expected to have NOT mailed out a notification about an error occuring, but mailed: \n#{@@delivered_mail}"
+  end
+
+  def mailed_error
+    assert @@delivered_mail.last, "Expected to have mailed out a notification about an error occuring, but none mailed"
+    @@delivered_mail.last.encoded
+  end
+
+end