super_exception_notifier 2.0.0

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
+
+    protected
+    
+    #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 Method (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
+
+    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/lib/super_exception_notifier/deprecated_methods.rb

@@ -0,0 +1,60 @@
+#Copyright (c) 2008-2009 Peter H. Boling of 9thBit LLC
+#Released under the MIT license
+
+module SuperExceptionNotifier
+  module DeprecatedMethods
+    @@namespacing = "Better namespacing to allow for Notifiable and ExceptionNotifiable to have similar APIs"
+    @@rails2ruby = "An effort to make this a 'Ruby' Gem and not a stricly 'Rails' Gem"
+    
+    def http_error_codes
+      deprecation_warning("http_error_codes", "error_class_status_codes")
+      error_class_status_codes
+    end
+
+    def http_error_codes=(arg)
+      deprecation_warning("http_error_codes", "error_class_status_codes")
+      error_class_status_codes=(arg)
+    end
+
+    def rails_error_codes
+      deprecation_warning("rails_error_codes", "error_class_status_codes", @@rails2ruby)
+      error_class_status_codes
+    end
+
+    def rails_error_codes=(arg)
+      deprecation_warning("rails_error_codes=", "error_class_status_codes=", @@rails2ruby)
+      error_class_status_codes=(arg)
+    end
+
+    # Now defined in Object class by init.rb & Notifiable module,
+    #   so we need to override them for with the controller settings
+    def exception_notifier_verbose
+      deprecation_warning("exception_notifier_verbose", "exception_notifiable_verbose", @@namespacing)
+      exception_notifiable_verbose
+    end
+    def silent_exceptions
+      deprecation_warning("silent_exceptions", "exception_notifiable_silent_exceptions", @@namespacing)
+      exception_notifiable_silent_exceptions
+    end
+    def notification_level
+      deprecation_warning("notification_level", "exception_notifiable_notification_level", @@namespacing)
+      exception_notifiable_notification_level
+    end
+    def exception_notifier_verbose=(arg)
+      deprecation_warning("exception_notifier_verbose=", "exception_notifiable_verbose=", @@namespacing)
+      exception_notifiable_verbose = arg
+    end
+    def silent_exceptions=(arg)
+      deprecation_warning("silent_exceptions=", "exception_notifiable_silent_exceptions=", @@namespacing)
+      exception_notifiable_silent_exceptions = arg
+    end
+    def notification_level=(arg)
+      deprecation_warning("notification_level=", "exception_notifiable_notification_level=", @@namespacing)
+      exception_notifiable_notification_level = arg
+    end
+
+    def deprecation_warning(old, new, reason = "")
+      puts "[DEPRECATION WARNING] ** Method '#{old}' has been replaced by '#{new}', please update your code.#{' Reason for change: ' + reason + '.' if reason}"
+    end
+  end
+end

data/lib/super_exception_notifier/git_blame.rb

@@ -0,0 +1,52 @@
+#Copyright (c) 2008-2009 Peter H. Boling of 9thBit LLC
+#Released under the MIT license
+
+module SuperExceptionNotifier
+  module GitBlame
+
+    def lay_blame(exception)
+      error = {}
+      unless(ExceptionNotifier.config[:git_repo_path].nil?)
+        if(exception.class == ActionView::TemplateError)
+            blame = blame_output(exception.line_number, "app/views/#{exception.file_name}")
+            error[:author] = blame[/^author\s.+$/].gsub(/author\s/,'')
+            error[:line]   = exception.line_number
+            error[:file]   = exception.file_name
+        else
+          exception.backtrace.each do |line|
+            file = exception_in_project?(line[/^.+?(?=:)/])
+            unless(file.nil?)
+              line_number = line[/:\d+:/].gsub(/[^\d]/,'')
+              # Use relative path or weird stuff happens
+              blame = blame_output(line_number, file.gsub(Regexp.new("#{RAILS_ROOT}/"),''))
+              error[:author] = blame[/^author\s.+$/].sub(/author\s/,'')
+              error[:line]   = line_number
+              error[:file]   = file
+              break
+            end
+          end
+        end
+      end
+      error
+    end
+
+    def blame_output(line_number, path)
+      app_directory = Dir.pwd
+      Dir.chdir ExceptionNotifier.config[:git_repo_path]
+      blame = `git blame -p -L #{line_number},#{line_number} #{path}`
+      Dir.chdir app_directory
+
+      blame
+    end
+
+    def exception_in_project?(path) # should be a path like /path/to/broken/thingy.rb
+      dir = File.split(path).first rescue ''
+      if(File.directory?(dir) and !(path =~ /vendor\/plugins/) and !(path =~ /vendor\/gems/) and path.include?(RAILS_ROOT))
+        path
+      else
+        nil
+      end
+    end
+
+  end
+end

data/lib/super_exception_notifier/helpful_hashes.rb

@@ -0,0 +1,66 @@
+#Copyright (c) 2008-2009 Peter H. Boling of 9thBit LLC
+#Released under the MIT license
+
+module SuperExceptionNotifier
+  module HelpfulHashes
+    unless defined?(SILENT_EXCEPTIONS)
+      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
+    HTTP_STATUS_CODES = {
+      "400" => "Bad Request",
+      "403" => "Forbidden",
+      "404" => "Not Found",
+      "405" => "Method Not Allowed",
+      "410" => "Gone",
+      "418" => "I'm a teapot",
+      "422" => "Unprocessable Entity",
+      "423" => "Locked",
+      "500" => "Internal Server Error",
+      "501" => "Not Implemented",
+      "503" => "Service Unavailable"
+    } unless defined?(HTTP_STATUS_CODES)
+
+    def codes_for_error_classes
+      #TODO: Format whitespace
+      classes = {
+        # These are standard errors in rails / ruby
+        NameError => "503",
+        TypeError => "503",
+        RuntimeError => "500",
+        ArgumentError => "500",
+        # These are custom error names defined in lib/super_exception_notifier/custom_exception_classes
+        AccessDenied => "403",
+        PageNotFound => "404",
+        InvalidMethod => "405",
+        ResourceGone => "410",
+        CorruptData => "422",
+        NoMethodError => "500",
+        NotImplemented => "501",
+        MethodDisabled => "200"
+      }
+      # Highly dependent on the verison of rails, so we're very protective about these'
+      classes.merge!({ ActionView::TemplateError => "500"})             if defined?(ActionView)       && ActionView.const_defined?(:TemplateError)
+      classes.merge!({ ActiveRecord::RecordNotFound => "400" })         if defined?(ActiveRecord)     && ActiveRecord.const_defined?(:RecordNotFound)
+      classes.merge!({ ActiveResource::ResourceNotFound => "404" })     if defined?(ActiveResource)   && ActiveResource.const_defined?(:ResourceNotFound)
+
+      if defined?(ActionController)
+        classes.merge!({ ActionController::UnknownController => "404" })          if ActionController.const_defined?(:UnknownController)
+        classes.merge!({ ActionController::MissingTemplate => "404" })            if ActionController.const_defined?(:MissingTemplate)
+        classes.merge!({ ActionController::MethodNotAllowed => "405" })           if ActionController.const_defined?(:MethodNotAllowed)
+        classes.merge!({ ActionController::UnknownAction => "501" })              if ActionController.const_defined?(:UnknownAction)
+        classes.merge!({ ActionController::RoutingError => "404" })               if ActionController.const_defined?(:RoutingError)
+        classes.merge!({ ActionController::InvalidAuthenticityToken => "405" })   if ActionController.const_defined?(:InvalidAuthenticityToken)
+      end
+    end
+  end
+end

data/lib/super_exception_notifier/hooks_notifier.rb

@@ -0,0 +1,55 @@
+require 'net/http'
+require 'uri'
+
+module SuperExceptionNotifier
+  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
+end

data/lib/super_exception_notifier/notifiable_helper.rb

@@ -0,0 +1,79 @@
+#Copyright (c) 2008-2009 Peter H. Boling of 9thBit LLC
+#Released under the MIT license
+
+module SuperExceptionNotifier
+  module NotifiableHelper
+    include CustomExceptionClasses
+    include CustomExceptionMethods
+    include HelpfulHashes
+    include GitBlame
+    include HooksNotifier
+
+    private
+
+    def get_method_name
+      if  /`(.*)'/.match(caller.first)
+        return $1
+      end
+      nil
+    end
+
+    def get_exception_data
+      deliverer = self.class.exception_data
+      return case deliverer
+        when nil then {}
+        when Symbol then send(deliverer)
+        when Proc then deliverer.call(self)
+      end
+    end
+
+    def verbose_output(exception, status_cd, file_path, send_email, send_web_hooks, request = nil, the_blamed = nil)
+      puts "[EXCEPTION] #{exception}"
+      puts "[EXCEPTION CLASS] #{exception.class}"
+      puts "[EXCEPTION STATUS_CD] #{status_cd}"
+      puts "[ERROR LAYOUT] #{self.class.error_layout}" if self.class.respond_to?(:error_layout)
+      puts "[ERROR VIEW PATH] #{ExceptionNotifier.config[:view_path]}" if !ExceptionNotifier.nil? && !ExceptionNotifier.config[:view_path].nil?
+      puts "[ERROR FILE PATH] #{file_path.inspect}"
+      puts "[ERROR EMAIL] #{send_email ? "YES" : "NO"}"
+      puts "[ERROR WEB HOOKS] #{send_web_hooks ? "YES" : "NO"}"
+      puts "[COMPAT MODE] #{ExceptionNotifierHelper::COMPAT_MODE ? "YES" : "NO"}"
+      puts "[THE BLAMED] #{the_blamed}"
+      req = request ? " for request_uri=#{request.request_uri} and env=#{request.env.inspect}" : ""
+      logger.error("render_error(#{status_cd}, #{self.class.http_status_codes[status_cd]}) invoked#{req}") if self.class.respond_to?(:http_status_codes) && !logger.nil?
+    end
+
+    def perform_exception_notify_mailing(exception, data, request = nil, the_blamed = nil, verbose = false)
+      if ExceptionNotifier.config[:exception_recipients].blank?
+        puts "[EMAIL NOTIFICATION] ExceptionNotifier.config[:exception_recipients] is blank, notification cancelled!" if verbose
+      else
+        class_name = self.respond_to?(:controller_name) ? self.controller_name : self.to_s
+        method_name = self.respond_to?(:action_name) ? self.action_name : get_method_name
+        ExceptionNotifier.deliver_exception_notification(exception, class_name, method_name,
+          request, data, the_blamed)
+        puts "[EMAIL NOTIFICATION] Sent" if verbose
+      end
+    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, 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, verbose)
+    end
+
+    # Relies on the base class to define be_silent_for_exception?
+    def should_notify_on_exception?(exception, status_cd = nil, verbose = false)
+      # don't notify (email or web hooks) on exceptions raised locally
+      verbose && ExceptionNotifier.config[:skip_local_notification] && is_local? ?
+          "[NOTIFY LOCALLY] NO" :
+           nil
+      return false if ExceptionNotifier.config[:skip_local_notification] && is_local?
+      # don't notify (email or web hooks) exceptions raised that match ExceptionNotifiable.notifiable_silent_exceptions
+      return false if self.be_silent_for_exception?(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)
+      return ExceptionNotifier.config[:notify_other_errors]
+    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>