wrangler 0.1.13 → 0.1.14

data/lib/wrangler/exception_handler.rb

@@ -181,13 +181,43 @@ module Wrangler
     return nil
   end
 
+
+  # publicly available method for explicitly telling wrangler to handle
+  # a specific error condition without an actual exception. it's useful if you
+  # want to send a notification after detecting an error condition, but don't
+  # want to interrupt the stack by raising an exception. if you did catch an
+  # exception and want to do somethign similar, just call handle_exception
+  # diretly.
+  #
+  # the error condition will get logged and may result in notification,
+  # according to configuration see notify_on_exception?
+  #
+  # arguments:
+  #   - error_messages: a message or array of messages (each gets logged on
+  #                     separate log call) capturing the error condition that
+  #                     occurred. this will get logged AND sent in any
+  #                     notifications sent
+  #
+  # options: also, any of the options accepted by handle_exception
+  #-----------------------------------------------------------------------------
+  def handle_error(error_messages, options = {})
+    options.merge! :error_messages => error_messages
+    handle_exception(nil, options)
+  end
+
+
   # the main exception-handling method. decides whether to notify or not,
   # whether to render an error page or not, and to make it happen.
   #
   # arguments:
-  #   - exception: the exception that was caught
+  #   - exception: the exception that was caught. can be nil, but should
+  #                only be nil if notifications should always be sent,
+  #                as notification rules are bypassed this case
   #
   # options:
+  #   :error_messages: any additional message to log and send in notification.
+  #                    can also be an array of messages (each gets logged
+  #                    separately)
   #   :request: the request object (if any) that resulted in the exception
   #   :render_errors: boolean indicating if an error page should be rendered
   #                   or not (Rails only)
@@ -199,43 +229,62 @@ module Wrangler
     request = options[:request]
     render_errors = options[:render_errors] || false
     proc_name = options[:proc_name] || config[:app_name]
+    error_messages = options[:error_messages]
 
-    status_code =
-      Wrangler::ExceptionHandler.status_code_for_exception(exception)
-    request_data = request_data_from_request(request) unless request.nil?
-
-    log_exception(exception, request_data, status_code)
-
-    if exception.is_a?(Class)
-      exception_classname = exception.name
+    if exception.respond_to?(:backtrace)
+      backtrace = exception.backtrace
     else
-      exception_classname = exception.class.name
+      backtrace = caller
     end
 
-    if exception.respond_to?(:message)
-      exception_string = exception.message
+    if exception.nil?
+      exception_classname = nil
+      status_code = nil
+      log_error error_messages
+      log_error backtrace
+      error_string = ''
     else
-      exception_string = exception.to_s
+      status_code =
+        Wrangler::ExceptionHandler.status_code_for_exception(exception)
+
+      request_data = request_data_from_request(request) unless request.nil?
+
+      log_exception(exception, request_data, status_code, error_messages)
+
+      if exception.is_a?(Class)
+        exception_classname = exception.name
+      else
+        exception_classname = exception.class.name
+      end
+
+      if exception.respond_to?(:message)
+        error_string = exception.message
+      else
+        error_string = exception.to_s
+      end
     end
 
-    if notify_on_exception?(exception, status_code)
-      if notify_with_delayed_job?
+    if (exception && notify_on_exception?(exception, status_code)) ||
+       (exception.nil? && notify_in_context?)
 
+      if notify_with_delayed_job?
         # don't pass in request as it contains not-easily-serializable stuff
         log_error "Wrangler sending email notification asynchronously"
         Wrangler::ExceptionNotifier.send_later(:deliver_exception_notification,
                                               exception_classname,
-                                              exception_string,
+                                              error_string,
+                                              error_messages,
                                               proc_name,
-                                              exception.backtrace,
+                                              backtrace,
                                               status_code,
                                               request_data)
       else
         log_error "Wrangler sending email notification synchronously"
         Wrangler::ExceptionNotifier.deliver_exception_notification(exception_classname,
-                                         exception_string,
+                                         error_string,
+                                         error_messages,
                                          proc_name,
-                                         exception.backtrace,
+                                         backtrace,
                                          status_code,
                                          request_data,
                                          request)
@@ -248,12 +297,12 @@ module Wrangler
   end
 
 
-  # determine if the app is configured to notify for the given exception or
-  # status code
+  # determine if the current context (local?, background) indicates that a
+  # notification should be sent. this applies all of the rules around
+  # notifications EXCEPT for what the current exception or status code is
+  # (see notify_on_exception? for that)
   #-----------------------------------------------------------------------------
-  def notify_on_exception?(exception, status_code = nil)
-    # first determine if we're configured to notify given the context of the
-    # exception
+  def notify_in_context?
     if self.respond_to?(:local_request?)
       if (local_request? && config[:notify_on_local_error]) ||
           (!local_request? && config[:notify_on_public_error])
@@ -265,6 +314,18 @@ module Wrangler
       notify = config[:notify_on_background_error]
     end
 
+    return notify
+  end
+
+
+  # determine if the app is configured to notify for the given exception or
+  # status code
+  #-----------------------------------------------------------------------------
+  def notify_on_exception?(exception, status_code = nil)
+    # first determine if we're configured to notify given the context of the
+    # exception
+    notify = notify_in_context?
+
     # now if config says notify in this case, check if we're configured to
     # notify for this exception or this status code
     return notify &&

data/lib/wrangler/exception_notifier.rb

@@ -20,7 +20,7 @@ module Wrangler
     #-----------------------------------------------------------------------------
     def smtp_settings
       @@smtp_settings_overrides.reverse_merge @@smtp_settings
-    end  
+    end
 
     # the default configuration
     @@config ||= {
@@ -52,8 +52,12 @@ module Wrangler
     # when you call ExceptionNotifier.deliver_exception_notification())
     #
     # arguments:
-    #   - exception_classname: the class of exception that was raised
-    #   - exception_message: the error message carried by the exception
+    #   - exception_classname: the class of exception that was raised, if any
+    #   - error_message: the short version of the error message to display
+    #   - additional_messages: a string or array of additional error messages
+    #                          to be logged or sent in notification...allows
+    #                          for more detail in case it won't all display
+    #                          well in email subject line, for example
     #   - proc_name: the name of the process in which the exception arised
     #   - backtrace: the stack trace from the exception (passing in excplicitly
     #                because serializing the exception does not preserve the
@@ -70,7 +74,8 @@ module Wrangler
     #              delayed_job. Optional.
     #---------------------------------------------------------------------------
     def exception_notification(exception_classname,
-                               exception_message,
+                               error_message,
+                               additional_messages,
                                proc_name,
                                backtrace,
                                status_code = nil,
@@ -89,16 +94,17 @@ module Wrangler
       ensure_session_loaded(request)
 
       # NOTE: be very careful pulling data out of request in the view...it is
-      # NOT cleaned, and may contain private data (e.g. passwords), so 
+      # NOT cleaned, and may contain private data (e.g. passwords), so
       # scrutinize any use of @request in the views!
 
       body_hash =
         { :exception_classname =>    exception_classname,
-          :exception_message => exception_message,
+          :error_message => error_message,
+          :additional_messages => additional_messages,
           :backtrace =>    backtrace,
           :status_code =>  status_code,
           :request_data => request_data,
-          :request =>      request 
+          :request =>      request
         }
 
       body_hash.merge! extract_data_from_request_data(request_data)
@@ -106,8 +112,8 @@ module Wrangler
       recipients   config[:recipient_addresses]
       subject      "[#{proc_name + (proc_name ? ' ' : '')}" +
                    "#{config[:subject_prefix]}] " +
-                   "#{exception_classname}: " +
-                   "#{exception_message}"
+                   "#{exception_classname || 'error'}: " +
+                   "#{error_message}"
       body         body_hash
       sent_on      Time.now
       content_type 'text/plain'

data/lib/wrangler/wrangler_helper.rb

@@ -59,7 +59,8 @@ module Wrangler
   # log the exception using logger if available. if object does not have a
   # logger, will just puts()
   #-----------------------------------------------------------------------------
-  def log_exception(exception, request_data = nil, status_code = nil)
+  def log_exception(exception, request_data = nil,
+                    status_code = nil, error_messages = nil)
     msgs = []
     msgs << "An exception was caught (#{exception.class.name}):"
 
@@ -69,6 +70,12 @@ module Wrangler
       msgs << exception.to_s
     end
 
+    if error_messages.is_a?(Array)
+      msgs.concat error_messages
+    elsif !error_messages.blank?
+      msgs << error_messages
+    end
+
     unless request_data.blank?
       msgs <<  "Request params were:"
       msgs <<  request_data.inspect
@@ -76,7 +83,7 @@ module Wrangler
     unless status_code.blank?
       msgs <<  "Handling with status code: #{status_code}"
     end
-    unless exception.backtrace.blank?
+    if exception.respond_to?(:backtrace) && !exception.backtrace.blank?
       msgs <<  exception.backtrace.join("\n  ")
     end
 

data/views/wrangler/exception_notifier/exception_notification.text.plain.erb

@@ -8,8 +8,14 @@
   <%= @protocol %><%= @host %><%= @uri %>
 <% end -%>
 
-A <%= @exception_classname %> occurred:
- * <%= @exception_message %>
+A<%= @exception_classname || "n error" %> occurred:
+<%= @error_message %>
+<% if @additional_messages.is_a?(Array) -%>
+  <%= @additional_messages.join("\n  ") %>
+<% else -%>
+  <%= @additional_messages %>
+<% end -%>
+
 <% unless @backtrace.blank? -%>
 in <%= @backtrace.first %>
 <% end -%>

data/wrangler.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{wrangler}
-  s.version = "0.1.13"
+  s.version = "0.1.14"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Brian Percival"]
-  s.date = %q{2010-02-18}
+  s.date = %q{2010-02-19}
   s.description = %q{A gem for handling exceptions thrown inside your Rails app. If you include the
 gem in your application controller, wrangler will render the error pages you
 configure for each exception or HTTP error code. It will also handle notifying

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: wrangler
 version: !ruby/object:Gem::Version 
-  version: 0.1.13
+  version: 0.1.14
 platform: ruby
 authors: 
 - Brian Percival
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-18 00:00:00 -08:00
+date: 2010-02-19 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency