wrangler 0.1.20 → 0.1.21

data/lib/wrangler/exception_handler.rb

@@ -105,7 +105,18 @@ module Wrangler
       # if you do change this, you really should have a good reason for it and
       # really know what you're doing. really.
       :absolute_last_resort_default_error_template =>
-        File.join(WRANGLER_ROOT,'rails','app','views','wrangler','500.html')
+        File.join(WRANGLER_ROOT,'rails','app','views','wrangler','500.html'),
+
+      # allows for inserting additional data/comments/status/environment into
+      # the notification emails. possibilities include fetching the release number,
+      # patch info, current state of different services....
+      # pass a proc instance that accepts a single
+      # argument, the request object (if any).
+      # (e.g. +Proc.new { |request| puts "request is: #{request}" }+, but don't
+      # do that, that would be redundant, silly and not secure).
+      # NOTE: +request+ can be nil (if background process, for example), so
+      # implement accordingly
+      :call_for_supplementary_info => nil
     }
 
     # give access to config
@@ -255,7 +266,9 @@ module Wrangler
     request = options[:request]
     render_errors = options[:render_errors] || false
     proc_name = options[:proc_name] || config[:app_name]
-    error_messages = options[:error_messages]
+    error_messages = options[:error_messages] || ['']
+
+    error_messages = [error_messages] unless error_messages.is_a?(Array)
 
     if exception.respond_to?(:backtrace)
       backtrace = exception.backtrace
@@ -267,18 +280,26 @@ module Wrangler
     # that should NOT be logged/emailed (passwords etc.)
     request_data = request_data_from_request(request) unless request.nil?
 
+    supplementary_info = nil
+
+    unless config[:call_for_supplementary_info].nil?
+      supplementary_info = config[:call_for_supplementary_info].call(request)
+      supplementary_info = [supplementary_info] unless supplementary_info.is_a?(Array)
+    end
+
+    unless supplementary_info.blank?
+      error_messages << "Supplementary info:"
+      error_messages += supplementary_info
+    end
+
     if exception.nil?
       exception_classname = nil
       status_code = nil
-      log_error error_messages
+      log_error error_messages.inspect
       log_error backtrace
       log_error "Request params were:"
       log_error request_data.to_yaml
-      if error_messages.is_a?(Array)
-        error_string = error_messages.first
-      else
-        error_string = error_messages
-      end
+      error_string = error_messages.first
     else
       status_code =
         Wrangler::ExceptionHandler.status_code_for_exception(exception)
@@ -308,6 +329,7 @@ module Wrangler
                                               error_messages,
                                               proc_name,
                                               backtrace,
+                                              supplementary_info,
                                               status_code,
                                               request_data)
       else
@@ -317,6 +339,7 @@ module Wrangler
                                          error_messages,
                                          proc_name,
                                          backtrace,
+                                         supplementary_info,
                                          status_code,
                                          request_data,
                                          request)

data/lib/wrangler/exception_notifier.rb

@@ -62,6 +62,10 @@ module Wrangler
     #   - backtrace: the stack trace from the exception (passing in excplicitly
     #                because serializing the exception does not preserve the
     #                backtrace (in case delayed_job is used to async the email)
+    #   - supplementary_info: any other messages to be dumped into the
+    #                         notification email. these are provided by the
+    #                         client code via the :call_for_supplementary_info
+    #                         option. can be a string or an array of strings.
     #   - status_code: the (string) http status code that the exception has been
     #                  mapped to. Optional, but no default is provided, so
     #                  no status code info will be contained in the email.
@@ -78,6 +82,7 @@ module Wrangler
                                additional_messages,
                                proc_name,
                                backtrace,
+                               supplementary_info,
                                status_code = nil,
                                request_data = nil,
                                request = nil)
@@ -102,6 +107,7 @@ module Wrangler
           :error_message => error_message,
           :additional_messages => additional_messages,
           :backtrace =>    backtrace,
+          :supplementary_info => supplementary_info,
           :status_code =>  status_code,
           :request_data => request_data,
           :request =>      request

data/lib/wrangler/wrangler_helper.rb

@@ -72,7 +72,7 @@ module Wrangler
 
     if error_messages.is_a?(Array)
       msgs.concat error_messages
-    elsif !error_messages.blank?
+    elsif !error_messages.nil? && !error_messages.empty?
       msgs << error_messages
     end
 

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

@@ -8,6 +8,8 @@
   <%= @protocol %><%= @host %><%= @uri %>
 <% end -%>
 
+At <%= Time.now %>:
+
 <% if !@exception_classname.nil? -%>
 A/an <%= @exception_classname %> occurred:
 <% else -%>
@@ -55,3 +57,12 @@ REQUEST DATA
 <%= "#{k}: #{@request_data[k].inspect}" %>
   <% end -%>
 <% end -%>
+
+<% unless @supplementary_info.blank? -%>
+--------------------------------------------------
+SUPPLEMENTARY INFO
+--------------------------------------------------
+<% @supplementary_info.each do |line| -%>
+<%= line %>
+<% end -%>
+<% end -%>

data/wrangler.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{wrangler}
-  s.version = "0.1.20"
+  s.version = "0.1.21"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Brian Percival"]
-  s.date = %q{2010-05-03}
+  s.date = %q{2010-05-18}
   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.20
+  version: 0.1.21
 platform: ruby
 authors: 
 - Brian Percival
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-03 00:00:00 -07:00
+date: 2010-05-18 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency