pboling-super_exception_notifier 1.6.5

data/lib/hooks_notifier.rb

@@ -0,0 +1,53 @@
+require 'net/http'
+require 'uri'
+
+module HooksNotifier
+  # Deliver exception data hash to web hooks, if any
+  #
+  def self.deliver_exception_to_web_hooks(config, exception, controller, request, data={}, the_blamed = nil)
+    params = build_web_hook_params(config, exception, controller, request, data, the_blamed)
+    # TODO: use threads here
+    config[:web_hooks].each do |address|
+      post_hook(params, address)
+    end
+  end
+
+
+  # Parameters hash based on Merb Exceptions example
+  #
+  def self.build_web_hook_params(config, exception, controller, request, data={}, the_blamed = nil)
+    host = (request.env["HTTP_X_FORWARDED_HOST"] || request.env["HTTP_HOST"])
+    p = {
+      'environment'              => (defined?(Rails) ? Rails.env : RAILS_ENV),
+      'exceptions'               => [{
+        :class      => exception.class.to_s,
+        :backtrace  => exception.backtrace,
+        :message    => exception.message
+        }],
+      'app_name'                 => config[:app_name],
+      'version'                  => config[:version],
+      'blame'                    => "#{the_blamed}"
+    }
+    if !request.nil?
+      p.merge!({'request_url'         => "#{request.protocol}#{host}#{request.request_uri}"})
+      p.merge!({'request_action'      => request.parameters['action']})
+      p.merge!({'request_params'      => request.parameters.inspect})
+    end
+    p.merge!({'request_controller'    => controller.class.name}) if !controller.nil?
+    p.merge!({'status'                => exception.status}) if exception.respond_to?(:status)
+    return p
+  end
+
+  def self.post_hook(params, address)
+    uri = URI.parse(address)
+    uri.path = '/' if uri.path=='' # set a path if one isn't provided to keep Net::HTTP happy
+    
+    headers = { 'Content-Type' => 'text/x-json' }
+    data = params.to_json
+    Net::HTTP.start(uri.host, uri.port) do |http|
+      http.request_post(uri.path, data, headers)
+    end
+    data
+  end
+
+end

data/lib/notifiable.rb

@@ -0,0 +1,8 @@
+module Notifiable
+  def notifiable(&block)
+    yield
+  rescue => exception
+    ExceptionNotifier.deliver_exception_notification(exception)
+    raise
+  end
+end

data/lib/super_exception_notifier/custom_exception_classes.rb

@@ -0,0 +1,16 @@
+#Copyright (c) 2008-2009 Peter H. Boling of 9thBit LLC
+#Released under the MIT license
+
+module SuperExceptionNotifier
+  module CustomExceptionClasses
+
+    class AccessDenied < StandardError; end
+    class ResourceGone < StandardError; end
+    class NotImplemented < StandardError; end
+    class PageNotFound < StandardError; end
+    class InvalidMethod < StandardError; end
+    class CorruptData < StandardError; end
+    class MethodDisabled < StandardError; end
+    
+  end
+end

data/lib/super_exception_notifier/custom_exception_methods.rb

@@ -0,0 +1,50 @@
+#Copyright (c) 2008-2009 Peter H. Boling of 9thBit LLC
+#Released under the MIT license
+
+module SuperExceptionNotifier
+  module CustomExceptionMethods
+    
+    #For a while after disabling a route/URL that had been functional we should set it to resource gone to inform people to remove bookmarks.
+    def resource_gone
+      raise ResourceGone
+    end
+    #Then for things that have never existed or have not for a long time we call not_implemented
+    def not_implemented
+      raise NotImplemented
+    end
+    #Resources that must be requested with a specific HTTP Meethod (GET, PUT, POST, DELETE, AJAX, etc) but are requested otherwise should:
+    def invalid_method
+      raise InvalidMethod
+    end
+    #If your ever at a spot in the code that should never get reached, but corrupt data might get you there anyways then this is for you:
+    def corrupt_data
+      raise CorruptData
+    end
+    def page_not_found
+      raise PageNotFound
+    end
+    def record_not_found
+      raise ActiveRecord::RecordNotFound
+    end
+    def method_disabled
+      raise MethodDisabled
+    end
+    #The current user does not have enough privileges to access the requested resource
+    def access_denied
+      raise AccessDenied
+    end
+
+  protected
+
+    def generic_error
+      error_stickie("Sorry, an error has occurred.")
+      corrupt_data
+    end
+
+    def invalid_page
+      error_stickie("Sorry, the page number you requested was not valid.")
+      page_not_found
+    end
+
+  end
+end

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

@@ -0,0 +1,5 @@
+<!-- This file lives in gems/super_exception_notifier/rails/app/views/exception_notifiable/400.html. See Readme for instructions on customizing. -->
+<div class="dialog">
+  <h1>Unable to Process Requested Data</h1>
+  <p>Reloading the page will probably not help.</p>
+</div>

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

@@ -0,0 +1,6 @@
+<!-- This file lives in gems/super_exception_notifier/rails/app/views/exception_notifiable/403.html. See Readme for instructions on customizing. -->
+<div class="dialog">
+  <h1>Access Restricted</h1>
+
+  <p>If you need access to this resource please contact support or an administrator.</p>
+</div>

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

@@ -0,0 +1,6 @@
+<!-- This file lives in gems/super_exception_notifier/rails/app/views/exception_notifiable/404.html. See Readme for instructions on customizing. -->
+<div class="dialog">
+  <h1>The page you were looking for doesn't exist.</h1>
+
+  <p>You may have mistyped the address or the page may have moved.</p>
+</div>

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

@@ -0,0 +1,6 @@
+<!-- This file lives in gems/super_exception_notifier/rails/app/views/exception_notifiable/404.html. See Readme for instructions on customizing. -->
+<div class="dialog">
+  <h1>Invalid Method.</h1>
+
+  <p>This resource only accepts certain HTTP methods.</p>
+</div>

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

@@ -0,0 +1,7 @@
+<!-- This file lives in gems/super_exception_notifier/rails/app/views/exception_notifiable/410.html. See Readme for instructions on customizing. -->
+<div class="dialog">
+  <h1>Requested resource is no longer available</h1>
+
+  <p>Please remove bookmarks to this resource.</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/418.html

@@ -0,0 +1,6 @@
+<!-- This file lives in gems/super_exception_notifier/rails/app/views/exception_notifiable/418.html. See Readme for instructions on customizing. -->
+<div class="dialog">
+    <h1>418 I�m a teapot</h1>
+  
+    <p>I MAY be short and stout. Defined by the April Fools specification RFC 2324. See Hyper Text Coffee Pot Control Protocol for more information.</p>
+</div>

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

@@ -0,0 +1,5 @@
+<!-- This file lives in gems/super_exception_notifier/rails/app/views/exception_notifiable/422.html. See Readme for instructions on customizing. -->
+<div class="dialog">
+  <h1>Unprocessable Request</h1>
+  <p>The request was well-formed but was unable to be followed due to semantic errors.</p>
+</div>

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

@@ -0,0 +1,6 @@
+<!-- This file lives in gems/super_exception_notifier/rails/app/views/exception_notifiable/423.html. See Readme for instructions on customizing. -->
+<div class="dialog">
+  <h1>The change you wanted was rejected because the resource is locked</h1>
+  <p>It might become available again soon, if you try again!</p>
+  <p>Maybe you tried to change something you didn't have access to.</p>
+</div>

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/init.rb

@@ -0,0 +1,18 @@
+require "action_mailer"
+
+require File.join(File.dirname(__FILE__), '..', 'lib', "super_exception_notifier", "custom_exception_classes")
+require File.join(File.dirname(__FILE__), '..', 'lib', "super_exception_notifier", "custom_exception_methods")
+
+$:.unshift "#{File.dirname(__FILE__)}/lib"
+
+require "hooks_notifier"
+require "exception_notifier"
+require "exception_notifiable"
+require "exception_notifier_helper"
+require "notifiable"
+
+Object.class_eval do include Notifiable end
+
+if ActionController::Base.respond_to?(:append_view_path)
+  ActionController::Base.append_view_path(File.join(File.dirname(__FILE__), 'app', 'views'))
+end

data/test/exception_notifier_helper_test.rb

@@ -0,0 +1,76 @@
+require File.expand_path(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_notify_functional_test.rb

@@ -0,0 +1,102 @@
+require File.expand_path(File.dirname(__FILE__) + '/test_helper')
+require 'test/unit'
+
+RAILS_DEFAULT_LOGGER = Logger.new(nil)
+
+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_string("200"); end
+  def test_view_path_400; assert_view_path_string("400"); end
+  def test_view_path_403; assert_view_path_string("403"); end
+  def test_view_path_404; assert_view_path_string("404"); end
+  def test_view_path_405; assert_view_path_string("405"); end
+  def test_view_path_410; assert_view_path_string("410"); end
+  def test_view_path_418; assert_view_path_string("422"); end
+  def test_view_path_422; assert_view_path_string("422"); end
+  def test_view_path_423; assert_view_path_string("423"); end
+  def test_view_path_500; assert_view_path_string("500"); end
+  def test_view_path_501; assert_view_path_string("501"); end
+  def test_view_path_503; assert_view_path_string("503"); end
+  def test_view_path_nil; assert_view_path_string(nil); end
+  def test_view_path_empty; assert_view_path_string(""); end
+  def test_view_path_nonsense; assert_view_path_string("slartibartfarst"); 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
+    get "runtime_error"    
+    
+    # puts @response.body
+    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 "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 "record_not_found"    
+    assert_nothing_mailed
+  end
+    
+  private
+
+  def assert_view_path_string(status)
+    assert(ExceptionNotifier.get_view_path(status).is_a?(String), "View Path is not a string for status code '#{status}'")
+  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/404.html

@@ -0,0 +1 @@
+simulate 404 error file in public

data/test/mocks/500.html

@@ -0,0 +1 @@
+simulate 500 error file in public

data/test/mocks/controllers.rb

@@ -0,0 +1,46 @@
+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 record_not_found
+    raise ActiveRecord::RecordNotFound
+  end
+  
+  def local_request?
+    false
+  end
+  
+end
+
+class OldStyle < Application
+  include ExceptionNotifiable
+  self.exception_notifier_verbose = false
+end
+
+class SpecialErrorThing < RuntimeError
+end
+
+class NewStyle < Application
+  include ExceptionNotifiable
+  self.exception_notifier_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