exception_notification 3.0.1 → 4.0.0.rc1

data/Rakefile

@@ -1,12 +1,14 @@
-require 'bundler'
+require 'rubygems'
+require 'bundler/setup'
 Bundler::GemHelper.install_tasks
+require 'appraisal'
 
 require 'rake/testtask'
 
 task 'setup_dummy_app' do
   unless File.exists? "test/dummy/db/test.sqlite3"
     Bundler.with_clean_env do
-      sh "cd test/dummy; bundle; rake db:migrate; rake db:test:prepare; cd ../../;"
+      sh "cd test/dummy; bundle; bundle exec rake db:migrate; bundle exec rake db:test:prepare; cd ../../;"
     end
   end
 end

data/examples/sinatra/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+gem "exception_notification", path: "../../"
+
+gem "thin", "~> 1.5.1"
+gem "sinatra", "~> 1.3.5"
+gem "foreman"
+gem "mailcatcher"

data/examples/sinatra/Gemfile.lock

@@ -0,0 +1,95 @@
+PATH
+  remote: ../../
+  specs:
+    exception_notification (3.0.1)
+      actionmailer (>= 3.0.4)
+      activesupport (>= 3.0.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (3.2.13)
+      actionpack (= 3.2.13)
+      mail (~> 2.5.3)
+    actionpack (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.5)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.13)
+      activesupport (= 3.2.13)
+      builder (~> 3.0.0)
+    activesupport (3.2.13)
+      i18n (= 0.6.1)
+      multi_json (~> 1.0)
+    builder (3.0.4)
+    daemons (1.1.9)
+    erubis (2.7.0)
+    eventmachine (1.0.3)
+    foreman (0.61.0)
+      thor (>= 0.13.6)
+    haml (4.0.2)
+      tilt
+    hike (1.2.1)
+    i18n (0.6.1)
+    journey (1.0.4)
+    mail (2.5.3)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mailcatcher (0.5.11)
+      activesupport (~> 3.0)
+      eventmachine (~> 1.0.0)
+      haml (>= 3.1, < 5)
+      mail (~> 2.3)
+      sinatra (~> 1.2)
+      skinny (~> 0.2.3)
+      sqlite3 (~> 1.3)
+      thin (~> 1.5.0)
+    mime-types (1.22)
+    multi_json (1.7.2)
+    polyglot (0.3.3)
+    rack (1.4.5)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-protection (1.5.0)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    sinatra (1.3.6)
+      rack (~> 1.4)
+      rack-protection (~> 1.3)
+      tilt (~> 1.3, >= 1.3.3)
+    skinny (0.2.3)
+      eventmachine (~> 1.0.0)
+      thin (~> 1.5.0)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.7)
+    thin (1.5.1)
+      daemons (>= 1.0.9)
+      eventmachine (>= 0.12.6)
+      rack (>= 1.0.0)
+    thor (0.18.1)
+    tilt (1.3.6)
+    treetop (1.4.12)
+      polyglot
+      polyglot (>= 0.3.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  exception_notification!
+  foreman
+  mailcatcher
+  sinatra (~> 1.3.5)
+  thin (~> 1.5.1)

data/examples/sinatra/Procfile

@@ -0,0 +1,2 @@
+web: bundle exec thin start --port 3000
+mail: bundle exec mailcatcher --foreground --smtp-port 1025 --http-port 1080

data/examples/sinatra/README.md

@@ -0,0 +1,11 @@
+# Using Exception Notification with Sinatra
+
+## Quick start
+
+    git clone git@github.com:smartinez87/exception_notification.git
+    cd exception_notification/examples/sinatra
+    bundle install
+    bundle exec foreman start
+
+
+The last command starts two services, a smtp server and the sinatra app itself. Thus, visit [http://localhost:1080/](http://localhost:1080/) to check the emails sent and, in a separated tab, visit [http://localhost:3000](http://localhost:3000) and cause some errors. For more info, use the [source](https://github.com/smartinez87/exception_notification/blob/master/examples/sinatra/sinatra_app.rb) Luke.

data/examples/sinatra/config.ru

@@ -0,0 +1,3 @@
+require ::File.expand_path('../sinatra_app',  __FILE__)
+
+run SinatraApp

data/examples/sinatra/sinatra_app.rb

@@ -0,0 +1,28 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'sinatra/base'
+require 'exception_notification'
+
+class SinatraApp < Sinatra::Base
+  use ExceptionNotification::Rack,
+    :email => {
+      :email_prefix => "[Example] ",
+      :sender_address => %{"notifier" <notifier@example.com>},
+      :exception_recipients => %w{exceptions@example.com},
+      :smtp_settings => { :address => "localhost", :port => 1025 }
+    }
+
+  get '/' do
+    raise StandardError, "ERROR: #{params[:error]}" unless params[:error].blank?
+    'Everything is fine! Now, lets break things clicking <a href="/?error=ops"> here </a>. Dont forget to see the emails at <a href="http://localhost:1080">mailcatcher</a> !'
+  end
+
+  get '/background_notification' do
+    begin
+      1/0
+    rescue Exception => e
+      ExceptionNotifier.notify_exception(e, :data => {:msg => "Cannot divide by zero!"})
+    end
+    'Check email at <a href="http://localhost:1080">mailcatcher</a>.'
+  end
+end

data/exception_notification.gemspec

@@ -1,8 +1,8 @@
 Gem::Specification.new do |s|
   s.name = 'exception_notification'
-  s.version = '3.0.1'
+  s.version = '4.0.0.rc1'
   s.authors = ["Jamis Buck", "Josh Peek"]
-  s.date = %q{2013-02-02}
+  s.date = %q{2013-06-20}
   s.summary = "Exception notification for Rails apps"
   s.homepage = "http://smartinez87.github.com/exception_notification"
   s.email = "smartinez87@gmail.com"
@@ -12,9 +12,15 @@ Gem::Specification.new do |s|
   s.require_path = 'lib'
 
   s.add_dependency("actionmailer", ">= 3.0.4")
+  s.add_dependency("activesupport", ">= 3.0.4")
 
-  s.add_development_dependency "tinder", "~> 1.8"
   s.add_development_dependency "rails", ">= 3.0.4"
-  s.add_development_dependency "mocha", ">= 0.11.3"
+  s.add_development_dependency "resque", "~> 1.2.0"
+  s.add_development_dependency "sidekiq", "~> 2.0"
+  s.add_development_dependency "tinder", "~> 1.8"
+  s.add_development_dependency "httparty", "~> 0.10.2"
+  s.add_development_dependency "mocha", ">= 0.13.0"
   s.add_development_dependency "sqlite3", ">= 1.3.4"
+  s.add_development_dependency "coveralls", "~> 0.6.5"
+  s.add_development_dependency "appraisal", ">= 0"
 end

data/gemfiles/rails3_1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 3.1.0"
+
+gemspec :path=>"../"

data/gemfiles/rails3_2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 3.2.0"
+
+gemspec :path=>"../"

data/gemfiles/rails4_0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "4.0.0.rc2"
+
+gemspec :path=>"../"

data/lib/exception_notification.rb

@@ -1 +1,11 @@
 require 'exception_notifier'
+require 'exception_notification/rack'
+
+module ExceptionNotification
+  # Alternative way to setup ExceptionNotification.
+  # Run 'rails generate exception_notification:install' to create
+  # a fresh initializer with all configuration values.
+  def self.configure
+    yield ExceptionNotifier
+  end
+end

data/lib/exception_notification/rack.rb

@@ -0,0 +1,45 @@
+module ExceptionNotification
+  class Rack
+    def initialize(app, options = {})
+      @app = app
+
+      ExceptionNotifier.ignored_exceptions = options.delete(:ignore_exceptions) if options.key?(:ignore_exceptions)
+
+      if options.key?(:ignore_if)
+        rack_ignore = options.delete(:ignore_if)
+        ExceptionNotifier.ignore_if do |exception, options|
+          options.key?(:env) && rack_ignore.call(options[:env], exception)
+        end
+      end
+
+      if options.key?(:ignore_crawlers)
+        ignore_crawlers = options.delete(:ignore_crawlers)
+        ExceptionNotifier.ignore_if do |exception, options|
+          options.key?(:env) && from_crawler(options[:env], ignore_crawlers)
+        end
+      end
+
+      options.each do |notifier_name, options|
+        ExceptionNotifier.register_exception_notifier(notifier_name, options)
+      end
+    end
+
+    def call(env)
+      @app.call(env)
+    rescue Exception => exception
+      if ExceptionNotifier.notify_exception(exception, :env => env)
+        env['exception_notifier.delivered'] = true
+      end
+      raise exception
+    end
+
+    private
+
+    def from_crawler(env, ignored_crawlers)
+      agent = env['HTTP_USER_AGENT']
+      Array(ignored_crawlers).any? do |crawler|
+        agent =~ Regexp.new(crawler)
+      end
+    end
+  end
+end

data/lib/exception_notification/rails.rb

@@ -0,0 +1,8 @@
+module ExceptionNotification
+  class Engine < ::Rails::Engine
+    config.exception_notification = ExceptionNotifier
+    config.exception_notification.logger = Rails.logger
+
+    config.app_middleware.use ExceptionNotification::Rack
+  end
+end

data/lib/exception_notification/resque.rb

@@ -0,0 +1,24 @@
+require 'resque/failure/base'
+
+module ExceptionNotification
+  class Resque < Resque::Failure::Base
+
+    def self.count
+      Stat[:failed]
+    end
+
+    def save
+      data = {
+        :failed_at     => Time.now.to_s,
+        :queue         => queue,
+        :worker        => worker.to_s,
+        :payload       => payload,
+        :error_class   => exception.class.name,
+        :error_message => exception.message
+      }
+
+      ExceptionNotifier.notify_exception(exception, :data => { :resque => data })
+    end
+
+  end
+end

data/lib/exception_notification/sidekiq.rb

@@ -0,0 +1,22 @@
+require 'sidekiq'
+
+module ExceptionNotification
+  class Sidekiq
+
+    def call(worker, msg, queue)
+      begin
+        yield
+      rescue Exception => exception
+        ExceptionNotifier.notify_exception(exception, :data => { :sidekiq => msg })
+        raise exception
+      end
+    end
+
+  end
+end
+
+::Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add ::ExceptionNotification::Sidekiq
+  end
+end

data/lib/exception_notifier.rb

@@ -1,75 +1,103 @@
-require 'action_dispatch'
-require 'exception_notifier/notifier'
-require 'exception_notifier/campfire_notifier'
+require 'logger'
+require 'active_support/core_ext/string/inflections'
 
-class ExceptionNotifier
+module ExceptionNotifier
 
-  def self.default_ignore_exceptions
-    [].tap do |exceptions|
-      exceptions << 'ActiveRecord::RecordNotFound'
-      exceptions << 'AbstractController::ActionNotFound'
-      exceptions << 'ActionController::RoutingError'
+  autoload :Notifier, 'exception_notifier/notifier'
+  autoload :EmailNotifier, 'exception_notifier/email_notifier'
+  autoload :CampfireNotifier, 'exception_notifier/campfire_notifier'
+  autoload :WebhookNotifier, 'exception_notifier/webhook_notifier'
+
+  class UndefinedNotifierError < StandardError; end
+
+  # Define logger
+  mattr_accessor :logger
+  @@logger = Logger.new(STDOUT)
+
+  # Define a set of exceptions to be ignored, ie, dont send notifications when any of them are raised.
+  mattr_accessor :ignored_exceptions
+  @@ignored_exceptions = %w{ActiveRecord::RecordNotFound AbstractController::ActionNotFound ActionController::RoutingError}
+
+  class << self
+    # Store conditions that decide when exceptions must be ignored or not.
+    @@ignores = []
+
+    # Store notifiers that send notifications when exceptions are raised.
+    @@notifiers = {}
+
+    def notify_exception(exception, options={})
+      return false if ignored_exception?(options[:ignore_exceptions], exception)
+      return false if ignored?(exception, options)
+      selected_notifiers = options.delete(:notifiers) || notifiers
+      [*selected_notifiers].each do |notifier|
+        fire_notification(notifier, exception, options.dup)
+      end
+      true
     end
-  end
 
-  def self.default_ignore_crawlers
-    []
-  end
+    def register_exception_notifier(name, notifier_or_options)
+      if notifier_or_options.respond_to?(:call)
+        @@notifiers[name] = notifier_or_options
+      elsif notifier_or_options.is_a?(Hash)
+        create_and_register_notifier(name, notifier_or_options)
+      else
+        raise ArgumentError, "Invalid notifier '#{name}' defined as #{notifier_or_options.inspect}"
+      end
+    end
+    alias add_notifier register_exception_notifier
 
-  def initialize(app, options = {})
-    @app, @options = app, options
-
-    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]
-    Notifier.default_email_headers        = @options[:email_headers]
-
-    @campfire = CampfireNotifier.new @options[:campfire]
-
-    @options[:ignore_exceptions] ||= self.class.default_ignore_exceptions
-    @options[:ignore_crawlers]   ||= self.class.default_ignore_crawlers
-    @options[:ignore_if]         ||= lambda { |env, e| false }
-  end
+    def unregister_exception_notifier(name)
+      @@notifiers.delete(name)
+    end
 
-  def call(env)
-    @app.call(env)
-  rescue Exception => exception
-    options = (env['exception_notifier.options'] ||= Notifier.default_options)
-    options.reverse_merge!(@options)
-
-    unless ignored_exception(options[:ignore_exceptions], exception)       ||
-           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
+    def registered_exception_notifier(name)
+      @@notifiers[name]
     end
 
-    raise exception
-  end
+    def notifiers
+      @@notifiers.keys
+    end
 
-  private
+    # Adds a condition to decide when an exception must be ignored or not.
+    #
+    #   ExceptionNotifier.ignore_if do |exception, options|
+    #     not Rails.env.production?
+    #   end
+    def ignore_if(&block)
+      @@ignores << block
+    end
 
-  def ignored_exception(ignore_array, exception)
-    Array.wrap(ignore_array).map(&:to_s).include?(exception.class.name)
-  end
+    def clear_ignore_conditions!
+      @@ignores.clear
+    end
 
-  def from_crawler(ignore_array, agent)
-    ignore_array.each do |crawler|
-      return true if (agent =~ Regexp.new(crawler))
-    end unless ignore_array.blank?
-    false
-  end
+    private
+    def ignored?(exception, options)
+      @@ignores.any?{ |condition| condition.call(exception, options) }
+    rescue Exception => e
+      logger.warn "An error occurred when evaluating an ignore condition. #{e.class}: #{e.message}"
+      false
+    end
 
-  def conditionally_ignored(ignore_proc, env, exception)
-    ignore_proc.call(env, exception)
-  rescue Exception => ex
-    false
+    def ignored_exception?(ignore_array, exception)
+      (Array(ignored_exceptions) + Array(ignore_array)).map(&:to_s).include?(exception.class.name)
+    end
+
+    def fire_notification(notifier_name, exception, options)
+      notifier = registered_exception_notifier(notifier_name)
+      notifier.call(exception, options)
+    rescue Exception => e
+      logger.warn "An error occurred when sending a notification using '#{notifier_name}' notifier. #{e.class}: #{e.message}"
+      false
+    end
+
+    def create_and_register_notifier(name, options)
+      notifier_classname = "#{name}_notifier".camelize
+      notifier_class = ExceptionNotifier.const_get(notifier_classname)
+      notifier = notifier_class.new(options)
+      register_exception_notifier(name, notifier)
+    rescue NameError => e
+      raise UndefinedNotifierError, "No notifier named '#{name}' was found. Please, revise your configuration options. Cause: #{e.message}"
+    end
   end
 end