exception_notification 2.6.1 → 3.0.0.rc1

data/CHANGELOG.rdoc

@@ -1,3 +1,15 @@
+== 3.0.0
+
+* enhancements
+  * Campfire integration
+  * Support fot HTML notifications (by @Xenofex)
+  * Be able to override SMTP settings (by @piglop and @Macint)
+
+* bug fixes
+  * Fix encoding issues
+  * Allow default sections to be overridden (by @jfarmer)
+  * Don't automatically deliver background notifications
+
 == 2.6.1
 
 * bug fixes

data/CONTRIBUTING.md

@@ -0,0 +1,33 @@
+# How to contribute
+
+We love your contribution, for it's essential for making ExceptionNotification greater every day.
+In order to keep it as easy as possible to contribute changes, here are a few guidelines that we
+need contributors to follow:
+
+## First of all
+
+* Check if the issue you're going to submit isn't already submitted in
+  the [Issues](https://github.com/smartinez87/exception_notification/issues) page.
+
+## Issues
+
+* Submit a ticket for your issue, assuming one does not already exist.
+* The issue must:
+  * Clearly describe the problem including steps to reproduce when it is a bug.
+  * Also include all the information you can to make it easier for us to reproduce it,
+    like OS version, gem versions, etc...
+  * Even better, provide a failing test case for it.
+
+## Pull Requests
+
+If you've gone the extra mile and have a patch that fixes the issue, you
+should submit a Pull Request!
+
+* Fork the repo on Github.
+* Create a topic branch from where you want to base your work.
+* Add a test for your change. Only refactoring and documentation changes
+  require no new tests. If you are adding functionality or fixing a bug,
+  we need a test!
+* Run _all_ the tests to assure nothine else was broken. We only take pull requests with passing tests.
+* Check for unnecessary whitespace with `git diff --check` before committing.
+* Push to your fork and submit a pull request.

data/Gemfile.lock

@@ -1,52 +1,64 @@
 PATH
   remote: .
   specs:
-    exception_notification (2.6.0)
+    exception_notification (3.0.0.rc1)
       actionmailer (>= 3.0.4)
+      tinder (~> 1.8)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    actionmailer (3.2.3)
-      actionpack (= 3.2.3)
+    actionmailer (3.2.6)
+      actionpack (= 3.2.6)
       mail (~> 2.4.4)
-    actionpack (3.2.3)
-      activemodel (= 3.2.3)
-      activesupport (= 3.2.3)
+    actionpack (3.2.6)
+      activemodel (= 3.2.6)
+      activesupport (= 3.2.6)
       builder (~> 3.0.0)
       erubis (~> 2.7.0)
       journey (~> 1.0.1)
       rack (~> 1.4.0)
       rack-cache (~> 1.2)
       rack-test (~> 0.6.1)
-      sprockets (~> 2.1.2)
-    activemodel (3.2.3)
-      activesupport (= 3.2.3)
+      sprockets (~> 2.1.3)
+    activemodel (3.2.6)
+      activesupport (= 3.2.6)
       builder (~> 3.0.0)
-    activerecord (3.2.3)
-      activemodel (= 3.2.3)
-      activesupport (= 3.2.3)
+    activerecord (3.2.6)
+      activemodel (= 3.2.6)
+      activesupport (= 3.2.6)
       arel (~> 3.0.2)
       tzinfo (~> 0.3.29)
-    activeresource (3.2.3)
-      activemodel (= 3.2.3)
-      activesupport (= 3.2.3)
-    activesupport (3.2.3)
+    activeresource (3.2.6)
+      activemodel (= 3.2.6)
+      activesupport (= 3.2.6)
+    activesupport (3.2.6)
       i18n (~> 0.6)
       multi_json (~> 1.0)
     arel (3.0.2)
     builder (3.0.0)
     erubis (2.7.0)
+    eventmachine (1.0.0)
+    faraday (0.8.4)
+      multipart-post (~> 1.1)
+    faraday_middleware (0.8.8)
+      faraday (>= 0.7.4, < 0.9)
+    hashie (1.2.0)
     hike (1.2.1)
+    http_parser.rb (0.5.3)
     i18n (0.6.0)
-    journey (1.0.3)
-    json (1.6.6)
+    journey (1.0.4)
+    json (1.7.3)
     mail (2.4.4)
       i18n (>= 0.4.0)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
-    mime-types (1.18)
-    multi_json (1.3.2)
+    metaclass (0.0.1)
+    mime-types (1.19)
+    mocha (0.12.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.3.6)
+    multipart-post (1.1.5)
     polyglot (0.3.3)
     rack (1.4.1)
     rack-cache (1.2)
@@ -55,34 +67,49 @@ GEM
       rack
     rack-test (0.6.1)
       rack (>= 1.0)
-    rails (3.2.3)
-      actionmailer (= 3.2.3)
-      actionpack (= 3.2.3)
-      activerecord (= 3.2.3)
-      activeresource (= 3.2.3)
-      activesupport (= 3.2.3)
+    rails (3.2.6)
+      actionmailer (= 3.2.6)
+      actionpack (= 3.2.6)
+      activerecord (= 3.2.6)
+      activeresource (= 3.2.6)
+      activesupport (= 3.2.6)
       bundler (~> 1.0)
-      railties (= 3.2.3)
-    railties (3.2.3)
-      actionpack (= 3.2.3)
-      activesupport (= 3.2.3)
+      railties (= 3.2.6)
+    railties (3.2.6)
+      actionpack (= 3.2.6)
+      activesupport (= 3.2.6)
       rack-ssl (~> 1.3.2)
       rake (>= 0.8.7)
       rdoc (~> 3.4)
-      thor (~> 0.14.6)
+      thor (>= 0.14.6, < 2.0)
     rake (0.9.2.2)
     rdoc (3.12)
       json (~> 1.4)
-    sprockets (2.1.2)
+    simple_oauth (0.1.9)
+    sprockets (2.1.3)
       hike (~> 1.2)
       rack (~> 1.0)
       tilt (~> 1.1, != 1.3.0)
     sqlite3 (1.3.6)
-    thor (0.14.6)
+    thor (0.15.4)
     tilt (1.3.3)
+    tinder (1.9.1)
+      eventmachine (>= 0.12.0, < 2)
+      faraday (~> 0.8)
+      faraday_middleware (~> 0.8)
+      hashie (~> 1.0)
+      json (~> 1.6)
+      mime-types (~> 1.16)
+      multi_json (~> 1.0)
+      multipart-post (~> 1.1)
+      twitter-stream (~> 0.1)
     treetop (1.4.10)
       polyglot
       polyglot (>= 0.3.1)
+    twitter-stream (0.1.16)
+      eventmachine (>= 0.12.8)
+      http_parser.rb (~> 0.5.1)
+      simple_oauth (~> 0.1.4)
     tzinfo (0.3.33)
 
 PLATFORMS
@@ -90,5 +117,6 @@ PLATFORMS
 
 DEPENDENCIES
   exception_notification!
+  mocha (>= 0.11.3)
   rails (>= 3.0.4)
   sqlite3 (>= 1.3.4)

data/README.md

@@ -1,4 +1,4 @@
-Exception Notifier Plugin for Rails ![project status](http://stillmaintained.com/smartinez87/exception_notification.png) [![Travis](http://travis-ci.org/smartinez87/exception_notification.png)](http://travis-ci.org/smartinez87/exception_notification)
+Exception Notifier Plugin for Rails ![project status](http://stillmaintained.com/smartinez87/exception_notification.png) [![Travis](http://travis-ci.org/smartinez87/exception_notification.png)](http://travis-ci.org/smartinez87/exception_notification) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/smartinez87/exception_notification)
 ====
 
 The Exception Notifier plugin provides a mailer object and a default set of
@@ -35,6 +35,25 @@ Whatever::Application.config.middleware.use ExceptionNotifier,
   :exception_recipients => %w{exceptions@example.com}
 ```
 
+Campfire Integration
+---
+
+Additionally, ExceptionNotification supports sending notifications to
+your Campfire room.
+To configure it, you need to set the subdomain, token and room name,
+like this
+
+```ruby
+Whatever::Application.config.middleware.use ExceptionNotifier,
+  :email_prefix => "[Whatever] ",
+  :sender_address => %{"notifier" <notifier@example.com>},
+  :exception_recipients => %w{exceptions@example.com},
+  :campfire => {:subdomain => 'my_subdomain', :token => 'my_token', :room_name => 'my_room'}
+```
+
+For more options to set Campfire, like _ssl_, check
+[here](https://github.com/collectiveidea/tinder/blob/master/lib/tinder/campfire.rb#L17).
+
 Customization
 ---
 
@@ -47,7 +66,7 @@ app/views/exception_notifier directory (e.g., _session.rhtml). Each partial has
 access to the following variables:
 
 ```ruby
-@controller     # the controller that caused the error
+@kontroller     # the controller that caused the error
 @request        # the current request object
 @exception      # the exception that was raised
 @backtrace      # a sanitized version of the exception's backtrace
@@ -55,7 +74,7 @@ access to the following variables:
 @sections       # the array of sections to include in the email
 ```
 
-Background views will not have access to @controller and @request.
+Background views will not have access to @kontroller and @request.
 
 You can reorder the sections, or exclude sections completely, by altering the
 ExceptionNotifier.sections variable. You can even add new sections that
@@ -71,6 +90,9 @@ Whatever::Application.config.middleware.use ExceptionNotifier,
  :sections => %w{my_section1 my_section2} + ExceptionNotifier::Notifier.default_sections
 ```
 
+Place your custom sections under `./app/views/exception_notifier/` with the suffix `.text.erb`, e.g. 
+`./app/views/exception_notifier/_my_section1.text.erb`.
+
 If your new section requires information that isn't available by default, make sure
 it is made available to the email using the exception_data macro:
 
@@ -181,6 +203,11 @@ You can also choose to remove numbers from subject so they thread as a single on
 This is disabled by default.
 Use _:normalize_subject => true_ to enable it.
 
+### HTML
+
+You may want to send multipart notifications instead of just plain text, which ExceptionNotification sends by default.
+You can do so by adding this to the configuration: _:email_format => :html_.
+
 
 Background Notifications
 ---
@@ -193,7 +220,7 @@ like this:
 begin
   some code...
 rescue => e
-  ExceptionNotifier::Notifier.background_exception_notification(e)
+  ExceptionNotifier::Notifier.background_exception_notification(e).deliver
 end
 ```
 
@@ -205,7 +232,7 @@ begin
   some code...
 rescue => exception
   ExceptionNotifier::Notifier.background_exception_notification(exception,
-    :data => {:worker => worker.to_s, :queue => queue, :payload => payload})
+    :data => {:worker => worker.to_s, :queue => queue, :payload => payload}).deliver
 end
 ```
 
@@ -231,12 +258,33 @@ Notification
 ---
 
 After an exception notification has been delivered the rack environment variable
-'exception_notifier.delivered' will be set to +true+.
+'exception_notifier.delivered' will be set to `true`.
+
+
+Override SMTP settings
+---
+
+You can use specific SMTP settings for notifications:
+
+```ruby
+Whatever::Application.config.middleware.use ExceptionNotifier,
+  :email_prefix         => "[Whatever] ",
+  :sender_address       => %{"notifier" <notifier@example.com>},
+  :exception_recipients => %w{exceptions@example.com},
+  :smtp_settings => {
+    :user_name => "bob",
+    :password => "password",
+  }
+```
 
 Versions
 ---
 
-NOTE: Master branch is currently set for v2.6.1
+NOTE: Master branch is currently set for v3.0.0
+
+For v2.6.1, see this tag:
+
+<a href="http://github.com/smartinez87/exception_notification/tree/v2.6.1">http://github.com/smartinez87/exception_notification/tree/v2.6.1</a>
 
 For v2.6.0, see this tag:
 
@@ -246,10 +294,6 @@ For v2.5.2, see this tag:
 
 <a href="http://github.com/smartinez87/exception_notification/tree/v2.5.2">http://github.com/smartinez87/exception_notification/tree/v2.5.2</a>
 
-For v2.5.0, see tag:
-
-<a href="http://github.com/smartinez87/exception_notification/tree/v2.5.0">http://github.com/smartinez87/exception_notification/tree/v2.5.0</a>
-
 For previous releases, visit:
 
 <a href="https://github.com/smartinez87/exception_notification/tags">https://github.com/smartinez87/exception_notification/tags</a>
@@ -265,6 +309,9 @@ If you are running pre-rack Rails then see this tag:
 Support and tickets
 ---
 
-<a href="https://github.com/smartinez87/exception_notification/issues">https://github.com/smartinez87/exception_notification/issues</a>
+Here's the list of [issues](https://github.com/smartinez87/exception_notification/issues) we're currently working on.
+
+To contribute, please read first the [Contributing
+Guide](https://github.com/smartinez87/exception_notification/blob/master/CONTRIBUTING.md).
 
 Copyright (c) 2005 Jamis Buck, released under the MIT license: <a href="http://www.opensource.org/licenses/MIT">http://www.opensource.org/licenses/MIT</a>

data/exception_notification.gemspec

@@ -1,9 +1,9 @@
 Gem::Specification.new do |s|
   s.name = 'exception_notification'
-  s.version = '2.6.1'
+  s.version = '3.0.0.rc1'
   s.authors = ["Jamis Buck", "Josh Peek"]
-  s.date = %q{2012-04-21}
-  s.summary = "Exception notification by email for Rails apps"
+  s.date = %q{2012-10-05}
+  s.summary = "Exception notification for Rails apps"
   s.homepage = "http://smartinez87.github.com/exception_notification"
   s.email = "smartinez87@gmail.com"
 
@@ -12,6 +12,8 @@ Gem::Specification.new do |s|
   s.require_path = 'lib'
 
   s.add_dependency("actionmailer", ">= 3.0.4")
+  s.add_dependency("tinder", "~> 1.8")
   s.add_development_dependency "rails", ">= 3.0.4"
+  s.add_development_dependency "mocha", ">= 0.11.3"
   s.add_development_dependency "sqlite3", ">= 1.3.4"
 end

data/lib/exception_notifier.rb

@@ -1,7 +1,9 @@
 require 'action_dispatch'
 require 'exception_notifier/notifier'
+require 'exception_notifier/campfire_notifier'
 
 class ExceptionNotifier
+
   def self.default_ignore_exceptions
     [].tap do |exceptions|
       exceptions << 'ActiveRecord::RecordNotFound'
@@ -20,10 +22,14 @@ class ExceptionNotifier
     Notifier.default_sender_address       = @options[:sender_address]
     Notifier.default_exception_recipients = @options[:exception_recipients]
     Notifier.default_email_prefix         = @options[:email_prefix]
+    Notifier.default_email_format         = @options[:email_format]
     Notifier.default_sections             = @options[:sections]
     Notifier.default_background_sections  = @options[:background_sections]
     Notifier.default_verbose_subject      = @options[:verbose_subject]
     Notifier.default_normalize_subject    = @options[:normalize_subject]
+    Notifier.default_smtp_settings        = @options[:smtp_settings]
+
+    @campfire = CampfireNotifier.new @options[:campfire]
 
     @options[:ignore_exceptions] ||= self.class.default_ignore_exceptions
     @options[:ignore_crawlers]   ||= self.class.default_ignore_crawlers
@@ -40,6 +46,7 @@ class ExceptionNotifier
            from_crawler(options[:ignore_crawlers], env['HTTP_USER_AGENT']) ||
            conditionally_ignored(options[:ignore_if], env, exception)
       Notifier.exception_notification(env, exception).deliver
+      @campfire.exception_notification(exception)
       env['exception_notifier.delivered'] = true
     end
 

data/lib/exception_notifier/campfire_notifier.rb

@@ -0,0 +1,30 @@
+class ExceptionNotifier
+  class CampfireNotifier
+    require 'tinder'
+
+    attr_accessor :subdomain
+    attr_accessor :token
+    attr_accessor :room
+
+    def initialize(options)
+      begin
+        subdomain = options.delete(:subdomain)
+        room_name = options.delete(:room_name)
+        @campfire = Tinder::Campfire.new subdomain, options
+        @room     = @campfire.find_room_by_name room_name
+      rescue
+        @campfire = @room = nil
+      end
+    end
+
+    def exception_notification(exception)
+      @room.paste "A new exception occurred: '#{exception.message}' on '#{exception.backtrace.first}'" if active?
+    end
+
+    private
+
+    def active?
+      !@room.nil?
+    end
+  end
+end

data/lib/exception_notifier/notifier.rb

@@ -12,10 +12,12 @@ class ExceptionNotifier
       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
 
       def default_sender_address
         @default_sender_address || %("Exception Notifier" <exception.notifier@default.com>)
@@ -29,6 +31,10 @@ class ExceptionNotifier
         @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
@@ -45,14 +51,21 @@ class ExceptionNotifier
         @default_normalize_prefix || false
       end
 
+      def default_smtp_settings
+        @default_smtp_settings || nil
+      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 }
+          :normalize_subject => default_normalize_subject,
+          :template_path => mailer_name,
+          :smtp_settings => default_smtp_settings }
       end
 
       def normalize_digits(string)
@@ -66,60 +79,52 @@ class ExceptionNotifier
     end
 
     def exception_notification(env, exception, options={})
-      self.append_view_path Rails.root.nil? ? "app/views" : "#{Rails.root}/app/views" if defined?(Rails)
+      load_custom_views
 
       @env        = env
       @exception  = exception
-      @options    = (env['exception_notifier.options'] || {}).reverse_merge(self.class.default_options)
+      @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?
-
-      @data.each do |name, value|
-        instance_variable_set("@#{name}", value)
-      end
-      subject = compose_subject(exception, @kontroller)
-
-      mail(:to => @options[:exception_recipients], :from => @options[:sender_address], :subject => subject) do |format|
-        format.text { render "#{mailer_name}/exception_notification" }
-      end
+      
+      compose_email
     end
 
     def background_exception_notification(exception, options={})
-      self.append_view_path Rails.root.nil? ? "app/views" : "#{Rails.root}/app/views" if defined?(Rails)
+      load_custom_views
 
       if @notifier = Rails.application.config.middleware.detect{ |x| x.klass == ExceptionNotifier }
-        @options   = (@notifier.args.first || {}).reverse_merge(self.class.default_options)
+        @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] || {}
 
-        @data.each do |name, value|
-          instance_variable_set("@#{name}", value)
-        end
-        subject  = compose_subject(exception)
-
-        mail(:to => @options[:exception_recipients], :from => @options[:sender_address], :subject => subject) do |format|
-          format.text { render "#{mailer_name}/background_exception_notification" }
-        end.deliver
+        compose_email
       end
     end
 
     private
 
-    def compose_subject(exception, kontroller=nil)
+    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 << "#{@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)
@@ -140,5 +145,29 @@ class ExceptionNotifier
         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'
+
+      mail = mail(:to => @options[:exception_recipients], :from => @options[:sender_address],
+           :subject => subject, :template_name => name) do |format|
+        format.text
+        format.html if html_mail?
+      end
+      
+      mail.delivery_method.settings.merge!(@options[:smtp_settings]) if @options[:smtp_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