exception_notification 3.0.1 → 4.0.0.rc1

data/lib/exception_notifier/campfire_notifier.rb

@@ -1,6 +1,5 @@
-class ExceptionNotifier
+module ExceptionNotifier
   class CampfireNotifier
-    cattr_accessor :tinder_available, true
 
     attr_accessor :subdomain
     attr_accessor :token
@@ -8,8 +7,6 @@ class ExceptionNotifier
 
     def initialize(options)
       begin
-        return unless tinder_available
-
         subdomain = options.delete(:subdomain)
         room_name = options.delete(:room_name)
         @campfire = Tinder::Campfire.new subdomain, options
@@ -19,7 +16,7 @@ class ExceptionNotifier
       end
     end
 
-    def exception_notification(exception)
+    def call(exception, options={})
       @room.paste "A new exception occurred: '#{exception.message}' on '#{exception.backtrace.first}'" if active?
     end
 
@@ -30,5 +27,3 @@ class ExceptionNotifier
     end
   end
 end
-
-ExceptionNotifier::CampfireNotifier.tinder_available = Gem.loaded_specs.keys.include? 'tinder'

data/lib/exception_notifier/email_notifier.rb

@@ -0,0 +1,181 @@
+require 'action_mailer'
+require 'action_dispatch'
+require 'pp'
+
+module ExceptionNotifier
+  class EmailNotifier < Struct.new(:sender_address, :exception_recipients,
+    :email_prefix, :email_format, :sections, :background_sections,
+    :verbose_subject, :normalize_subject, :delivery_method, :mailer_settings,
+    :email_headers, :mailer_parent, :template_path)
+
+    module Mailer
+      class MissingController
+        def method_missing(*args, &block)
+        end
+      end
+
+      def self.extended(base)
+        base.class_eval do
+          # Append application view path to the ExceptionNotifier lookup context.
+          self.append_view_path "#{File.dirname(__FILE__)}/views"
+
+          def exception_notification(env, exception, options={}, default_options={})
+            load_custom_views
+
+            @env        = env
+            @exception  = exception
+            @options    = options.reverse_merge(env['exception_notifier.options'] || {}).reverse_merge(default_options)
+            @kontroller = env['action_controller.instance'] || MissingController.new
+            @request    = ActionDispatch::Request.new(env)
+            @backtrace  = exception.backtrace ? clean_backtrace(exception) : []
+            @sections   = @options[:sections]
+            @data       = (env['exception_notifier.exception_data'] || {}).merge(options[:data] || {})
+            @sections   = @sections + %w(data) unless @data.empty?
+
+            compose_email
+          end
+
+          def background_exception_notification(exception, options={}, default_options={})
+            load_custom_views
+
+            @exception = exception
+            @options   = options.reverse_merge(default_options)
+            @backtrace = exception.backtrace || []
+            @sections  = @options[:background_sections]
+            @data      = options[:data] || {}
+
+            compose_email
+          end
+
+          private
+
+          def compose_subject
+            subject = "#{@options[:email_prefix]}"
+            subject << "#{@kontroller.controller_name}##{@kontroller.action_name}" if @kontroller
+            subject << " (#{@exception.class})"
+            subject << " #{@exception.message.inspect}" if @options[:verbose_subject]
+            subject = EmailNotifier.normalize_digits(subject) if @options[:normalize_subject]
+            subject.length > 120 ? subject[0...120] + "..." : subject
+          end
+
+          def set_data_variables
+            @data.each do |name, value|
+              instance_variable_set("@#{name}", value)
+            end
+          end
+
+          def clean_backtrace(exception)
+            if defined?(Rails) && Rails.respond_to?(:backtrace_cleaner)
+              Rails.backtrace_cleaner.send(:filter, exception.backtrace)
+            else
+              exception.backtrace
+            end
+          end
+
+          helper_method :inspect_object
+
+          def inspect_object(object)
+            case object
+              when Hash, Array
+                object.inspect
+              else
+                object.to_s
+            end
+          end
+
+          def html_mail?
+            @options[:email_format] == :html
+          end
+
+          def compose_email
+            set_data_variables
+            subject = compose_subject
+            name = @env.nil? ? 'background_exception_notification' : 'exception_notification'
+
+            headers = {
+                :delivery_method => @options[:delivery_method],
+                :to => @options[:exception_recipients],
+                :from => @options[:sender_address],
+                :subject => subject,
+                :template_name => name
+            }.merge(@options[:email_headers])
+
+            mail = mail(headers) do |format|
+              format.text
+              format.html if html_mail?
+            end
+
+            mail.delivery_method.settings.merge!(@options[:mailer_settings]) if @options[:mailer_settings]
+
+            mail
+          end
+
+          def load_custom_views
+            self.prepend_view_path Rails.root.nil? ? "app/views" : "#{Rails.root}/app/views" if defined?(Rails)
+          end
+        end
+      end
+    end
+
+    def initialize(options)
+      delivery_method = (options[:delivery_method] || :smtp)
+      mailer_settings_key = "#{delivery_method}_settings".to_sym
+      options[:mailer_settings] = options.delete(mailer_settings_key)
+
+      super(*options.reverse_merge(EmailNotifier.default_options).values_at(
+        :sender_address, :exception_recipients,
+        :email_prefix, :email_format, :sections, :background_sections,
+        :verbose_subject, :normalize_subject, :delivery_method, :mailer_settings,
+        :email_headers, :mailer_parent, :template_path))
+    end
+
+    def options
+      @options ||= {}.tap do |opts|
+        each_pair { |k,v| opts[k] = v }
+      end
+    end
+
+    def mailer
+      @mailer ||= Class.new(mailer_parent.constantize).tap do |mailer|
+        mailer.extend(EmailNotifier::Mailer)
+        mailer.mailer_name = template_path
+      end
+    end
+
+    def call(exception, options={})
+      create_email(exception, options).deliver
+    end
+
+    def create_email(exception, options={})
+      env = options[:env]
+      default_options = self.options
+      if env.nil?
+        mailer.background_exception_notification(exception, options, default_options)
+      else
+        mailer.exception_notification(env, exception, options, default_options)
+      end
+    end
+
+    def self.default_options
+      {
+        :sender_address => %("Exception Notifier" <exception.notifier@example.com>),
+        :exception_recipients => [],
+        :email_prefix => "[ERROR] ",
+        :email_format => :text,
+        :sections => %w(request session environment backtrace),
+        :background_sections => %w(backtrace data),
+        :verbose_subject => true,
+        :normalize_subject => false,
+        :delivery_method => nil,
+        :mailer_settings => nil,
+        :email_headers => {},
+        :mailer_parent => 'ActionMailer::Base',
+        :template_path => 'exception_notifier'
+      }
+    end
+
+    def self.normalize_digits(string)
+      string.gsub(/[0-9]+/, 'N')
+    end
+  end
+end

data/lib/exception_notifier/notifier.rb

@@ -1,185 +1,16 @@
-require 'action_mailer'
-require 'pp'
+require 'active_support/deprecation'
 
-class ExceptionNotifier
-  class Notifier < ActionMailer::Base
-    self.mailer_name = 'exception_notifier'
+module ExceptionNotifier
+  class Notifier
 
-    #Append application view path to the ExceptionNotifier lookup context.
-    self.append_view_path "#{File.dirname(__FILE__)}/views"
-
-    class << self
-      attr_writer :default_sender_address
-      attr_writer :default_exception_recipients
-      attr_writer :default_email_prefix
-      attr_writer :default_email_format
-      attr_writer :default_sections
-      attr_writer :default_background_sections
-      attr_writer :default_verbose_subject
-      attr_writer :default_normalize_subject
-      attr_writer :default_smtp_settings
-      attr_writer :default_email_headers
-
-      def default_sender_address
-        @default_sender_address || %("Exception Notifier" <exception.notifier@default.com>)
-      end
-
-      def default_exception_recipients
-        @default_exception_recipients || []
-      end
-
-      def default_email_prefix
-        @default_email_prefix || "[ERROR] "
-      end
-
-      def default_email_format
-        @default_email_format || :text
-      end
-
-      def default_sections
-        @default_sections || %w(request session environment backtrace)
-      end
-
-      def default_background_sections
-        @default_background_sections || %w(backtrace data)
-      end
-
-      def default_verbose_subject
-        @default_verbose_subject.nil? || @default_verbose_subject
-      end
-
-      def default_normalize_subject
-        @default_normalize_prefix || false
-      end
-
-      def default_smtp_settings
-        @default_smtp_settings || nil
-      end
-
-      def default_email_headers
-        @default_email_headers || {}
-      end
-
-      def default_options
-        { :sender_address => default_sender_address,
-          :exception_recipients => default_exception_recipients,
-          :email_prefix => default_email_prefix,
-          :email_format => default_email_format,
-          :sections => default_sections,
-          :background_sections => default_background_sections,
-          :verbose_subject => default_verbose_subject,
-          :normalize_subject => default_normalize_subject,
-          :template_path => mailer_name,
-          :smtp_settings => default_smtp_settings,
-          :email_headers => default_email_headers }
-      end
-
-      def normalize_digits(string)
-        string.gsub(/[0-9]+/, 'N')
-      end
-    end
-
-    class MissingController
-      def method_missing(*args, &block)
-      end
-    end
-
-    def exception_notification(env, exception, options={})
-      load_custom_views
-
-      @env        = env
-      @exception  = exception
-      @options    = options.reverse_merge(env['exception_notifier.options'] || {}).reverse_merge(self.class.default_options)
-      @kontroller = env['action_controller.instance'] || MissingController.new
-      @request    = ActionDispatch::Request.new(env)
-      @backtrace  = exception.backtrace ? clean_backtrace(exception) : []
-      @sections   = @options[:sections]
-      @data       = (env['exception_notifier.exception_data'] || {}).merge(options[:data] || {})
-      @sections   = @sections + %w(data) unless @data.empty?
-      
-      compose_email
-    end
-
-    def background_exception_notification(exception, options={})
-      load_custom_views
-
-      if @notifier = Rails.application.config.middleware.detect{ |x| x.klass == ExceptionNotifier }
-        @options   = options.reverse_merge(@notifier.args.first || {}).reverse_merge(self.class.default_options)
-        @exception = exception
-        @backtrace = exception.backtrace || []
-        @sections  = @options[:background_sections]
-        @data      = options[:data] || {}
-
-        compose_email
-      end
-    end
-
-    private
-
-    def compose_subject
-      subject = "#{@options[:email_prefix]}"
-      subject << "#{@kontroller.controller_name}##{@kontroller.action_name}" if @kontroller
-      subject << " (#{@exception.class})"
-      subject << " #{@exception.message.inspect}" if @options[:verbose_subject]
-      subject = normalize_digits(subject) if @options[:normalize_subject]
-      subject.length > 120 ? subject[0...120] + "..." : subject
-    end
-
-    def set_data_variables
-      @data.each do |name, value|
-        instance_variable_set("@#{name}", value)
-      end
-    end
-
-    def clean_backtrace(exception)
-      if Rails.respond_to?(:backtrace_cleaner)
-       Rails.backtrace_cleaner.send(:filter, exception.backtrace)
-      else
-       exception.backtrace
-      end
-    end
-
-    helper_method :inspect_object
-
-    def inspect_object(object)
-      case object
-      when Hash, Array
-        object.inspect
-      when ActionController::Base
-        "#{object.controller_name}##{object.action_name}"
-      else
-        object.to_s
-      end
-    end
-
-    def html_mail?
-      @options[:email_format] == :html
-    end
-
-    def compose_email
-      set_data_variables
-      subject = compose_subject
-      name = @env.nil? ? 'background_exception_notification' : 'exception_notification'
-
-      headers = {
-        :to => @options[:exception_recipients], 
-        :from => @options[:sender_address],
-        :subject => subject, 
-        :template_name => name
-      }.merge(@options[:email_headers])
-
-      mail = mail(headers) do |format|
-        format.text
-        format.html if html_mail?
-      end
-      
-      mail.delivery_method.settings.merge!(@options[:smtp_settings]) if @options[:smtp_settings]
-      
-      mail
+    def self.exception_notification(env, exception, options={})
+      ActiveSupport::Deprecation.warn "Please use ExceptionNotifier.notify_exception(exception, options.merge(:env => env))."
+      ExceptionNotifier.registered_exception_notifier(:email).create_email(exception, options.merge(:env => env))
     end
 
-    def load_custom_views
-      self.prepend_view_path Rails.root.nil? ? "app/views" : "#{Rails.root}/app/views" if defined?(Rails)
+    def self.background_exception_notification(exception, options={})
+      ActiveSupport::Deprecation.warn "Please use ExceptionNotifier.notify_exception(exception, options)."
+      ExceptionNotifier.registered_exception_notifier(:email).create_email(exception, options)
     end
   end
 end

data/lib/exception_notifier/views/exception_notifier/_backtrace.html.erb

@@ -1 +1,3 @@
-<%= raw @backtrace.join("\n") %>
+<pre style="font-size: 12px; padding: 10px; border: 1px solid #e1e1e8; background-color:#f5f5f5">
+  <%= raw @backtrace.join("\n") %>
+</pre>

data/lib/exception_notifier/views/exception_notifier/_data.html.erb

@@ -1 +1,6 @@
-* data: <%= raw PP.pp(@data, "") %>
+<ul style="list-style: none">
+  <li>
+    <strong>data:</strong>
+    <span><%= raw PP.pp(@data, "") %></span>
+  </li>
+</ul>

data/lib/exception_notifier/views/exception_notifier/_environment.html.erb

@@ -1,8 +1,18 @@
 <% filtered_env = @request.filtered_env -%>
-<% max = filtered_env.keys.map(&:to_s).max { |a, b| a.length <=> b.length } -%>
-<% filtered_env.keys.map(&:to_s).sort.each do |key| -%>
-* <%= raw("%-*s: %s" % [max.length, key, inspect_object(filtered_env[key])]) %>
-<% end -%>
 
-* Process: <%= raw $$ %>
-* Server : <%= raw `hostname`.chomp %>
+<ul style="list-style: none">
+  <% filtered_env.keys.map(&:to_s).sort.each do |key| -%>
+    <li>
+      <strong><%= key %>:</strong>
+      <span><%= inspect_object(filtered_env[key]) %></span>
+    </li>
+  <% end -%>
+  <li>
+    <strong>Process:</strong>
+    <span><%= raw $$ %></span>
+  </li>
+  <li>
+    <strong>Server:</strong>
+    <span><%= raw Socket.gethostname %></span>
+  </li>
+</ul>

data/lib/exception_notifier/views/exception_notifier/_environment.text.erb

@@ -5,4 +5,4 @@
 <% end -%>
 
 * Process: <%= raw $$ %>
-* Server : <%= raw `hostname`.chomp %>
+* Server : <%= raw Socket.gethostname %>