chatterbox 0.5.1 → 0.5.3

data/CHANGELOG.markdown

@@ -1,4 +1,9 @@
 HEAD
+0.5.3
+  - exception filtering
+  
+0.5.2
+  - add RAILS_ROOT filtering
 
 0.5.1
   - to_s the env and root from Rails

data/README.markdown

@@ -1,10 +1,9 @@
 Chatterbox
 ==========================================
 
-Simple Notifications.  Publishing and subscribing to notifications is decoupled by default, so bring your own message queue, web service, database, or whatever to act as an intermediary.
+Simple Notifications.  Publishing and subscribing to notifications is decoupled by default, so bring your own message queue, web service, database, or whatever to act as an intermediary.  Of course, you can wire Chatterbox to work directly if you like.
 
-Installing and Running
----------------------------------------
+## Installing and Running
 
 For plain old gem install: 
 
@@ -18,6 +17,12 @@ Then run:
 
     rake gems:install
 
+## Exception Notification
+
+One of the first use cases that Chatterbox was developed for was exception notification.  To setup Chatterbox for exception notification, install it as a gem with the instructions above, then configure a service.
+
+then wire the `RailsCatcher` in your `ApplicationController`:
+
 To enable standard Rails exception catching for your controllers, add the following to `application_controller`
 
     class ApplicationController < ActionController::Base

data/chatterbox.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{chatterbox}
-  s.version = "0.5.1"
+  s.version = "0.5.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Rob Sanheim"]
-  s.date = %q{2009-11-07}
+  s.date = %q{2009-11-13}
   s.description = %q{Send notifications and messages.  However you want.}
   s.email = %q{rsanheim@gmail.com}
   s.extra_rdoc_files = [
@@ -25,9 +25,10 @@ Gem::Specification.new do |s|
      "Rakefile",
      "chatterbox.gemspec",
      "examples/example_helper.rb",
-     "examples/lib/chatterbox/exception_notification/filter_example.rb",
+     "examples/lib/chatterbox/exception_notification/extracter_example.rb",
      "examples/lib/chatterbox/exception_notification/presenter_example.rb",
      "examples/lib/chatterbox/exception_notification/rails_extracter_example.rb",
+     "examples/lib/chatterbox/rails_catcher_controller_example.rb",
      "examples/lib/chatterbox/rails_catcher_example.rb",
      "examples/lib/chatterbox/services/email/mailer_example.rb",
      "examples/lib/chatterbox/services/email_example.rb",
@@ -56,9 +57,10 @@ Gem::Specification.new do |s|
   s.summary = %q{Notifications and messages}
   s.test_files = [
     "examples/example_helper.rb",
-     "examples/lib/chatterbox/exception_notification/filter_example.rb",
+     "examples/lib/chatterbox/exception_notification/extracter_example.rb",
      "examples/lib/chatterbox/exception_notification/presenter_example.rb",
      "examples/lib/chatterbox/exception_notification/rails_extracter_example.rb",
+     "examples/lib/chatterbox/rails_catcher_controller_example.rb",
      "examples/lib/chatterbox/rails_catcher_example.rb",
      "examples/lib/chatterbox/services/email/mailer_example.rb",
      "examples/lib/chatterbox/services/email_example.rb",

data/examples/lib/chatterbox/exception_notification/rails_extracter_example.rb

@@ -36,6 +36,40 @@ describe Chatterbox::ExceptionNotification::RailsExtracter do
         details[:request][:remote_ip].should == "192.5.5.0"
       end
     end
+    
+    describe "cleaning RAILS_ROOT" do
+      it "does nothing if there is no Rails configuration" do
+        backtrace = %w[/some/path/here.rb]
+        lambda {
+          Chatterbox::ExceptionNotification::RailsExtracter.wrap({:backtrace => backtrace})
+        }.should_not raise_error
+      end
+
+      it "does nothing if there is no rails_root on Rails" do
+        Chatterbox::ExceptionNotification::RailsExtracter.any_instance.stubs(:rails_configuration).returns(stub_everything)
+        backtrace = %w[/some/path/here.rb]
+        lambda {
+          Chatterbox::ExceptionNotification::RailsExtracter.wrap({:backtrace => backtrace})
+        }.should_not raise_error
+      end
+      
+      it "should replace the Rails root from the backtrace with RAILS_ROOT" do
+        rails = stub_everything({ :root => "/var/apps/dogs.com" })
+        Chatterbox::ExceptionNotification::RailsExtracter.any_instance.stubs(:rails_configuration).returns(rails)
+        backtrace = %w[
+/Users/rsanheim/.rvm/gems/ruby/1.9.1/gems/actionpack-2.3.4/lib/action_controller/test_process.rb:398:in `get'
+/var/apps/dogs.com/app/controllers/users_controller.rb:5:in `index'
+/var/apps/dogs.com/app/controllers/users_controller.rb:27:in `foo_baz'
+/var/apps/dogs.com/lib/some_module.rb:10:in `something_else']
+        details = Chatterbox::ExceptionNotification::RailsExtracter.wrap({:backtrace => backtrace})
+        rails_lines = details[:backtrace].select { |line| line.include?("users_controller.rb") }
+        rails_lines.should_not be_empty
+        rails_lines.each do |line|
+          line.should_not match(%r{^/var/apps/dogs.com/})
+          line.should match(%r{^\[RAILS_ROOT\]})
+        end
+      end
+    end
   end
   
   describe "rails_configuration" do

data/examples/lib/chatterbox/rails_catcher_controller_example.rb

@@ -0,0 +1,109 @@
+require 'example_helper'
+require 'chatterbox/exception_notification'
+require File.expand_path(File.join(File.dirname(__FILE__), *%w[.. .. .. rails init]))
+
+ActionController::Routing::Routes.draw { |map| map.connect ':controller/:action/:id' }
+
+class WidgetException < RuntimeError; end
+class WidgetsController < ActionController::Base
+  include Chatterbox::RailsCatcher
+
+  def rescue_action(exception)
+    rescue_action_in_public(exception)
+  end
+  
+  def rescue_action_in_public_without_chatterbox(exception)
+    raise exception
+  end
+  
+  def index
+    raise_exception
+    render :text => "hi"
+  end
+  
+  def raise_exception
+    raise WidgetException, "Bad dog!"
+  end
+end
+
+describe WidgetsController do
+  
+  describe "controller haxing" do
+    it "chains the chatterbox method to rescue_action_in_public" do
+      exception = RuntimeError.new
+      @controller.expects(:rescue_action_in_public_without_chatterbox).with(exception)
+      @controller.stubs(:extract_exception_details)
+      @controller.rescue_action_in_public(exception)
+    end
+  
+    it "should have the catcher included in ApplicationController" do
+      WidgetsController.ancestors.should include(Chatterbox::RailsCatcher)
+    end
+    
+    it "should hide aliased methods so they are not exposed as actions" do
+      WidgetsController.hidden_actions.should include("rescue_action_in_public_with_chatterbox")
+      WidgetsController.hidden_actions.should include("rescue_action_in_public_without_chatterbox")
+    end
+  end
+  
+  describe "exception handling" do
+    it "should raise on index" do
+      lambda {
+        get :index
+      }.should raise_error(WidgetException, "Bad dog!")
+    end
+    
+    it "should send exception notice as hash" do
+      Chatterbox.expects(:handle_notice).with(instance_of(Hash))
+      get :index rescue nil
+    end
+  end
+  
+  describe "ignoring exceptions" do
+    describe "when configured to ignore RuntimeError (as class)" do
+      before do
+        Chatterbox::RailsCatcher.configure { |c| c.ignore << RuntimeError }
+      end
+      
+      after do
+        Chatterbox::RailsCatcher.configure { |c| c.ignore = Chatterbox::RailsCatcher.default_ignored_exceptions }
+      end
+      
+      it "handles exceptions normally" do
+        lambda {
+          @controller.rescue_action_in_public(RuntimeError.new)
+        }.should raise_error(RuntimeError)
+      end
+      
+      it "ignores anything configured on the ignore list" do
+        Chatterbox.expects(:handle_notice).never
+        begin
+          @controller.rescue_action_in_public(RuntimeError.new)
+        rescue RuntimeError; end
+      end
+    end
+    
+    describe "when configured to ignore RuntimeError (as String)" do
+      before do
+        Chatterbox::RailsCatcher.configure { |c| c.ignore << "RuntimeError" }
+      end
+      
+      after do
+        Chatterbox::RailsCatcher.configure { |c| c.ignore = Chatterbox::RailsCatcher.default_ignored_exceptions }
+      end
+      
+      it "handles exceptions normally" do
+        lambda {
+          @controller.rescue_action_in_public(RuntimeError.new)
+        }.should raise_error(RuntimeError)
+      end
+      
+      it "ignores anything configured on the ignore list" do
+        Chatterbox.expects(:handle_notice).never
+        begin
+          @controller.rescue_action_in_public(RuntimeError.new)
+        rescue RuntimeError; end
+      end
+    end
+  end
+end

data/examples/lib/chatterbox/rails_catcher_example.rb

@@ -2,60 +2,35 @@ require 'example_helper'
 require 'chatterbox/exception_notification'
 require File.expand_path(File.join(File.dirname(__FILE__), *%w[.. .. .. rails init]))
 
-ActionController::Routing::Routes.draw { |map| map.connect ':controller/:action/:id' }
-
-class WidgetException < RuntimeError; end
-class WidgetsController < ActionController::Base
-  include Chatterbox::RailsCatcher
-
-  def rescue_action e
-    rescue_action_in_public e
-  end
-  
-  def rescue_action_in_public_without_chatterbox e
-    raise e
-  end
+describe Chatterbox::RailsCatcher do
   
-  def index
-    raise_exception
-    render :text => "hi"
+  def helper
+    @helper ||= Class.new {
+      include Chatterbox::RailsCatcher
+    }.new
   end
   
-  def raise_exception
-    raise WidgetException, "Bad dog!"
-  end
-end
-
-describe WidgetsController do
-  
-  describe "controller haxing" do
-    it "chains the chatterbox method to rescue_action_in_public" do
-      exception = RuntimeError.new
-      @controller.expects(:rescue_action_in_public_without_chatterbox).with(exception)
-      @controller.stubs(:extract_exception_details)
-      @controller.rescue_action_in_public(exception)
-    end
-  
-    it "should have the catcher included in ApplicationController" do
-      WidgetsController.ancestors.should include(Chatterbox::RailsCatcher)
-    end
-    
-    it "should hide aliased methods so they are not exposed as actions" do
-      WidgetsController.hidden_actions.should include("rescue_action_in_public_with_chatterbox")
-      WidgetsController.hidden_actions.should include("rescue_action_in_public_without_chatterbox")
+  describe "logger" do
+    it "should delegate to Chatterbox#logger" do
+      Chatterbox.expects(:logger)
+      helper.logger
     end
   end
   
-  describe "exception handling" do
-    it "should raise on index" do
-      lambda {
-        get :index
-      }.should raise_error(WidgetException, "Bad dog!")
+  describe "configuration" do
+    after do
+      Chatterbox::RailsCatcher.configure { |c| c.ignore = Chatterbox::RailsCatcher.default_ignored_exceptions }
+    end
+
+    it "ignores common Rails exceptions by default" do
+      Chatterbox::RailsCatcher.configuration.ignore.should == Chatterbox::RailsCatcher.default_ignored_exceptions
     end
     
-    it "should send exception notice as hash" do
-      Chatterbox.expects(:handle_notice).with(instance_of(Hash))
-      get :index rescue nil
+    it "allows adding exceptions to the ignore list" do
+      Chatterbox::RailsCatcher.configure do |config|
+        config.ignore << "SomeOtherException"
+      end
+      Chatterbox::RailsCatcher.configuration.ignore.should include("SomeOtherException")
     end
   end
 end

data/lib/chatterbox/exception_notification/rails_extracter.rb

@@ -11,11 +11,17 @@ module Chatterbox::ExceptionNotification
     def notice
       hsh = extract_rails_info(@message)
       hsh = extract_request_info(hsh)
+      hsh = filter_rails_root(hsh)
       hsh
     end
-
-    def rails_configuration
-      Object.const_get("Rails") if Object.const_defined?("Rails")
+    
+    def filter_rails_root(hsh)
+      return hsh unless hsh[:backtrace]
+      cleaner = ActiveSupport::BacktraceCleaner.new
+      cleaner.add_filter { |line| line.gsub(rails_root, "[RAILS_ROOT]") }
+      backtrace = cleaner.clean(hsh[:backtrace])
+      hsh[:backtrace] = backtrace
+      hsh
     end
 
     def extract_rails_info(message)
@@ -23,7 +29,7 @@ module Chatterbox::ExceptionNotification
       message.merge({
         :rails_info => {
           :rails_env => rails_configuration.env.to_s,
-          :rails_root => rails_configuration.root.to_s,
+          :rails_root => rails_root,
           :rails_version => rails_configuration.version
         }
       })
@@ -40,12 +46,14 @@ module Chatterbox::ExceptionNotification
         }
       })
     end
-  end
-end
-
+    
+    def rails_root
+      rails_configuration.try(:root).to_s
+    end
 
-# 
-# * URL       : <%= @request.protocol %><%= @host %><%= @request.request_uri %>
-# * IP address: <%= @request.env["HTTP_X_FORWARDED_FOR"] || @request.env["REMOTE_ADDR"] %>
-# * Parameters: <%= filter_sensitive_post_data_parameters(@request.parameters).inspect %>
-# * Rails root: <%= @rails_root %>
+    def rails_configuration
+      Object.const_get("Rails") if Object.const_defined?("Rails")
+    end
+    
+  end
+end

data/lib/chatterbox/rails_catcher.rb

@@ -1,6 +1,24 @@
+require 'ostruct'
+
 module Chatterbox
 
   module RailsCatcher
+    delegate :logger, :to => Chatterbox
+    delegate :configuration, :to => self
+    
+    def self.default_ignored_exceptions
+      ['ActiveRecord::RecordNotFound', 'ActionController::RoutingError',
+       'ActionController::InvalidAuthenticityToken', 'ActionController::UnknownAction',
+       'CGI::Session::CookieStore::TamperedWithCookie' ]
+     end
+    
+    def self.configuration
+      @configuration ||= OpenStruct.new(:ignore => default_ignored_exceptions)
+    end
+    
+    def self.configure
+      yield(configuration)
+    end
     
     def self.included(base)
       if base.instance_methods.map(&:to_s).include? 'rescue_action_in_public' and !base.instance_methods.map(&:to_s).include? 'rescue_action_in_public_without_chatterbox'
@@ -12,15 +30,26 @@ module Chatterbox
     
     # Overrides the rescue_action method in ActionController::Base, but does not inhibit
     # any custom processing that is defined with Rails 2's exception helpers.
-    def rescue_action_in_public_with_chatterbox exception
-      Chatterbox.logger.debug { "#{self.class}#rescue_action_in_public_with_chatterbox: caught exception #{exception} - about to handle"}
-      options = extract_exception_details(exception)
-      Chatterbox.handle_notice(options)
-      Chatterbox.logger.debug { "#{self.class}#rescue_action_in_public_with_chatterbox: handing exception #{exception} off to normal rescue handling"}
-      
+    def rescue_action_in_public_with_chatterbox(exception)
+      logger.debug { "#{log_prefix} caught exception #{exception} - about to handle" }
+      unless on_ignore_list?(exception)
+        Chatterbox.handle_notice(extract_exception_details(exception))
+      end
+      logger.debug { "#{log_prefix} handing exception #{exception} off to normal rescue handling" }
       rescue_action_in_public_without_chatterbox(exception)
     end
     
+    private
+    
+    def log_prefix
+      "#{self.class}#rescue_action_in_public_with_chatterbox:"
+    end
+    
+    def on_ignore_list?(exception)
+      configuration.ignore.include?(exception.class) || 
+      configuration.ignore.include?(exception.class.to_s)
+    end
+    
     def extract_exception_details(exception)
       options = { :exception => exception, :request => request }
       options = Chatterbox::ExceptionNotification::Extracter.wrap(options)

data/version.yml

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: chatterbox
 version: !ruby/object:Gem::Version 
-  version: 0.5.1
+  version: 0.5.3
 platform: ruby
 authors: 
 - Rob Sanheim
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-07 00:00:00 -05:00
+date: 2009-11-13 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -70,9 +70,10 @@ files:
 - Rakefile
 - chatterbox.gemspec
 - examples/example_helper.rb
-- examples/lib/chatterbox/exception_notification/filter_example.rb
+- examples/lib/chatterbox/exception_notification/extracter_example.rb
 - examples/lib/chatterbox/exception_notification/presenter_example.rb
 - examples/lib/chatterbox/exception_notification/rails_extracter_example.rb
+- examples/lib/chatterbox/rails_catcher_controller_example.rb
 - examples/lib/chatterbox/rails_catcher_example.rb
 - examples/lib/chatterbox/services/email/mailer_example.rb
 - examples/lib/chatterbox/services/email_example.rb
@@ -123,9 +124,10 @@ specification_version: 3
 summary: Notifications and messages
 test_files: 
 - examples/example_helper.rb
-- examples/lib/chatterbox/exception_notification/filter_example.rb
+- examples/lib/chatterbox/exception_notification/extracter_example.rb
 - examples/lib/chatterbox/exception_notification/presenter_example.rb
 - examples/lib/chatterbox/exception_notification/rails_extracter_example.rb
+- examples/lib/chatterbox/rails_catcher_controller_example.rb
 - examples/lib/chatterbox/rails_catcher_example.rb
 - examples/lib/chatterbox/services/email/mailer_example.rb
 - examples/lib/chatterbox/services/email_example.rb