super_exception_notifier 2.0.1 → 2.0.2

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 2
 :minor: 0
-:patch: 1
+:patch: 2

data/lib/exception_notifiable.rb

@@ -102,9 +102,11 @@ module ExceptionNotifiable
         #We only send web hooks if they've been configured in environment
         send_web_hooks = should_web_hook_on_exception?(exception, status_code, verbose)
         the_blamed = ExceptionNotifier.config[:git_repo_path].nil? ? nil : lay_blame(exception)
-        verbose_output(exception, status_code, "rescued by handler", send_email, send_web_hooks, nil, the_blamed) if verbose
-        # Send the exception notificaiton email
-        perform_exception_notify_mailing(exception, data, nil, the_blamed, verbose) if send_email
+        rejected_sections = %w(request session)
+        # Debugging output
+        verbose_output(exception, status_code, "rescued by handler", send_email, send_web_hooks, nil, the_blamed, rejected_sections) if verbose
+        # Send the exception notification email
+        perform_exception_notify_mailing(exception, data, nil, the_blamed, verbose, rejected_sections) if send_email
         # Send Web Hook requests
         HooksNotifier.deliver_exception_to_web_hooks(ExceptionNotifier.config, exception, self, request, data, the_blamed) if send_web_hooks
       end
@@ -134,13 +136,13 @@ module ExceptionNotifiable
       #We only send web hooks if they've been configured in environment
       send_web_hooks = should_web_hook_on_exception?(exception, status_cd, verbose)
       the_blamed = ExceptionNotifier.config[:git_repo_path].nil? ? nil : lay_blame(exception)
-
+      rejected_sections = request.nil? ? %w(request session) : []
       # Debugging output
-      verbose_output(exception, status_cd, file_path, send_email, send_web_hooks, request, the_blamed) if verbose
-
+      verbose_output(exception, status_cd, file_path, send_email, send_web_hooks, request, the_blamed, rejected_sections) if verbose
       #TODO: is _rescue_action something from rails 3?
       #if !(self.controller_name == 'application' && self.action_name == '_rescue_action')
-      perform_exception_notify_mailing(exception, data, request, the_blamed, verbose) if send_email
+      # Send the exception notification email
+      perform_exception_notify_mailing(exception, data, request, the_blamed, verbose, rejected_sections) if send_email
       # Send Web Hook requests
       HooksNotifier.deliver_exception_to_web_hooks(ExceptionNotifier.config, exception, self, request, data, the_blamed) if send_web_hooks
 

data/lib/exception_notifier.rb

@@ -53,6 +53,11 @@ class ExceptionNotifier < ActionMailer::Base
     filenames
   end
 
+  def self.sections_for_email(rejected_sections, request)
+    rejected_sections = rejected_sections.nil? ? request.nil? ? %w(request session) : [] : rejected_sections
+    rejected_sections.empty? ? config[:sections] : config[:sections].reject{|s| rejected_sections.include?(s) }
+  end
+
   # Converts Stringified Class Names to acceptable filename handles with underscores
   def self.filenamify(str)
     str.delete(':').gsub( /([A-Za-z])([A-Z])/, '\1' << '_' << '\2').downcase
@@ -110,8 +115,8 @@ class ExceptionNotifier < ActionMailer::Base
     end
   end
 
-  def exception_notification(exception, class_name = nil, method_name = nil, request = nil, data={}, the_blamed=nil)
-    body_hash = error_environment_data_hash(exception, class_name, method_name, request, data, the_blamed)
+  def exception_notification(exception, class_name = nil, method_name = nil, request = nil, data = {}, the_blamed = nil, rejected_sections = nil)
+    body_hash = error_environment_data_hash(exception, class_name, method_name, request, data, the_blamed, rejected_sections)
     #Prefer to have custom, potentially HTML email templates available
     #content_type  "text/plain"
     recipients    config[:exception_recipients]
@@ -123,30 +128,17 @@ class ExceptionNotifier < ActionMailer::Base
     body          body_hash
   end
   
-  def background_exception_notification(exception, data = {}, the_blamed = nil)
-    exception_notification(exception, nil, nil, data, the_blamed)
+  def background_exception_notification(exception, data = {}, the_blamed = nil, rejected_sections = %w(request session))
+    exception_notification(exception, nil, nil, nil, data, the_blamed, rejected_sections)
   end
 
-  def rake_exception_notification(exception, task, data={})
-    content_type "text/plain"
-
-    subject    "#{email_prefix}#{task.name} (#{exception.class}) #{exception.message.inspect}"
-
-    recipients exception_recipients
-    from       sender_address
-
-    body       data.merge({ :task => task,
-                  :exception => exception,
-                  :backtrace => sanitize_backtrace(exception.backtrace),
-                  :rails_root => rails_root,
-                  :data => data,
-                  :sections => sections.reject{|s| %w(request session).include?(s) } 
-               })
+  def rake_exception_notification(exception, task, data={}, the_blamed = nil, rejected_sections = %w(request session))
+    exception_notification(exception, "", "#{task.name}", nil, data, the_blamed, rejected_sections)
   end
 
   private
 
-    def error_environment_data_hash(exception, class_name = nil, method_name = nil, request = nil, data={}, the_blamed=nil)
+    def error_environment_data_hash(exception, class_name = nil, method_name = nil, request = nil, data = {}, the_blamed = nil, rejected_sections = nil)
       data.merge!({
         :exception => exception,
         :backtrace => sanitize_backtrace(exception.backtrace),
@@ -159,17 +151,16 @@ class ExceptionNotifier < ActionMailer::Base
       data.merge!({:method_name => method_name}) if method_name
       if class_name && method_name
         data.merge!({:location => "#{class_name}##{method_name}"})
+      elsif method_name
+        data.merge!({:location => "#{method_name}"})
       else
         data.merge!({:location => sanitize_backtrace([exception.backtrace.first]).first})
       end
       if request
         data.merge!({:request => request})
         data.merge!({:host => (request.env['HTTP_X_REAL_IP'] || request.env["HTTP_X_FORWARDED_HOST"] || request.env["HTTP_HOST"])})
-        data.merge!({:sections => config[:sections]})
-      else
-        # TODO: with refactoring in the view structure, the environment section could show useful ENV data even without a request?
-        data.merge!({:sections => config[:sections] - %w(request session environment)})
       end
+      data.merge!({:sections => ExceptionNotifier.sections_for_email(rejected_sections, request)})
       return data
     end
 

data/lib/notifiable.rb

@@ -76,9 +76,10 @@ module Notifiable
     #We only send web hooks if they've been configured in environment
     send_web_hooks = should_web_hook_on_exception?(exception, status_code, verbose)
     the_blamed = ExceptionNotifier.config[:git_repo_path].nil? ? nil : lay_blame(exception)
-    verbose_output(exception, status_code, "rescued by handler", send_email, send_web_hooks, nil, the_blamed) if verbose
-    # Send the exception notificaiton email
-    perform_exception_notify_mailing(exception, data, nil, the_blamed, verbose) if send_email
+    rejected_sections = %w(request session)
+    verbose_output(exception, status_code, "rescued by handler", send_email, send_web_hooks, nil, the_blamed, rejected_sections) if verbose
+    # Send the exception notification email
+    perform_exception_notify_mailing(exception, data, nil, the_blamed, verbose, rejected_sections) if send_email
     # Send Web Hook requests
     HooksNotifier.deliver_exception_to_web_hooks(ExceptionNotifier.config, exception, self, request, data, the_blamed) if send_web_hooks
   end

data/lib/super_exception_notifier/notifiable_helper.rb

@@ -27,7 +27,7 @@ module SuperExceptionNotifier
       end
     end
 
-    def verbose_output(exception, status_cd, file_path, send_email, send_web_hooks, request = nil, the_blamed = nil)
+    def verbose_output(exception, status_cd, file_path, send_email, send_web_hooks, request = nil, the_blamed = nil, rejected_sections = nil)
       puts "[EXCEPTION] #{exception}"
       puts "[EXCEPTION CLASS] #{exception.class}"
       puts "[EXCEPTION STATUS_CD] #{status_cd}"
@@ -38,18 +38,19 @@ module SuperExceptionNotifier
       puts "[ERROR WEB HOOKS] #{send_web_hooks ? "YES" : "NO"}"
       puts "[COMPAT MODE] #{ExceptionNotifierHelper::COMPAT_MODE ? "YES" : "NO"}"
       puts "[THE BLAMED] #{the_blamed}"
+      puts "[SECTIONS] #{ExceptionNotifier.sections_for_email(rejected_sections, request)}"
       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)
+    def perform_exception_notify_mailing(exception, data, request = nil, the_blamed = nil, verbose = false, rejected_sections = nil)
       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)
+          request, data, the_blamed, rejected_sections)
         puts "[EMAIL NOTIFICATION] Sent" if verbose
       end
     end

data/views/exception_notifier/rake_exception_notification.text.plain.erb

@@ -0,0 +1,6 @@
+A <%= @exception.class %> occurred in <%= @location %>:
+
+  <%= @exception.message %>
+  <%= @backtrace.first %>
+
+<%= @sections.map { |section| render_section(section) }.join %>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: super_exception_notifier
 version: !ruby/object:Gem::Version 
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors: 
 - Peter Boling
@@ -13,7 +13,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-22 00:00:00 -04:00
+date: 2009-10-23 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -81,6 +81,7 @@ files:
 - views/exception_notifier/_title.html.erb
 - views/exception_notifier/background_exception_notification.text.plain.erb
 - views/exception_notifier/exception_notification.text.plain.erb
+- views/exception_notifier/rake_exception_notification.text.plain.erb
 has_rdoc: true
 homepage: http://github.com/pboling/exception_notification
 licenses: []