chatterbox 0.5.4 → 0.6.0

data/CHANGELOG.markdown

@@ -1,5 +1,8 @@
 HEAD
 
+0.6.0
+  - Extract exception handling to Chatterbox::ExceptionNotification, and have RailsCatcher use that
+  - clean up and standardize names of things
 0.5.4
   - Remove very dangerous delegation from RailsCatcher, as these delegates can override common
     ActionController::Base methods when the catcher is included.  Wishing Ruby had real namespaces

data/VERSION.yml

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

data/chatterbox.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{chatterbox}
-  s.version = "0.5.4"
+  s.version = "0.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Rob Sanheim"]
-  s.date = %q{2009-11-13}
+  s.date = %q{2009-11-15}
   s.description = %q{Send notifications and messages.  However you want.}
   s.email = %q{rsanheim@gmail.com}
   s.extra_rdoc_files = [
@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
      "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/exception_notification_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",
@@ -60,6 +61,7 @@ Gem::Specification.new do |s|
      "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/exception_notification_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",

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

@@ -3,24 +3,22 @@ require 'chatterbox/exception_notification'
 
 describe Chatterbox::ExceptionNotification::Extracter do
 
-  def raised_exception
-    raise RuntimeError, "Your zing bats got mixed up with the snosh frazzles."
-  rescue => e
-    e
-  end
-  
   describe "notice" do
-    it "should extract exception info" do
-      exception = raised_exception
-      data = Chatterbox::ExceptionNotification::Extracter.new(exception).notice
-      data[:summary].should == "RuntimeError: Your zing bats got mixed up with the snosh frazzles."
-      data[:error_class].should == "RuntimeError"
-      data[:error_message].should == "Your zing bats got mixed up with the snosh frazzles."
-      data[:backtrace].should == exception.backtrace
+    it "merges ruby info" do
+      hsh = {}
+      data = Chatterbox::ExceptionNotification::Extracter.new(hsh).notice
+      data[:ruby_info][:ruby_version].should == RUBY_VERSION
+      data[:ruby_info][:ruby_platform].should == RUBY_PLATFORM
+    end
+    
+    it "merges environment hash" do
+      hsh = {}
+      data = Chatterbox::ExceptionNotification::Extracter.new(hsh).notice
+      data[:environment].should == ENV.to_hash
     end
 
     it "should extract exception info from an exception in a hash" do
-      exception = raised_exception
+      exception = RuntimeError.new("Your zing bats got mixed up with the snosh frazzles.")
       data = Chatterbox::ExceptionNotification::Extracter.new(:exception => exception, :other_info => "yo dawg").notice
       data[:summary].should == "RuntimeError: Your zing bats got mixed up with the snosh frazzles."
       data[:error_class].should == "RuntimeError"
@@ -30,8 +28,7 @@ describe Chatterbox::ExceptionNotification::Extracter do
     end
 
     it "should let extra data win over auto extracted exception data" do
-      exception = raised_exception
-      data = Chatterbox::ExceptionNotification::Extracter.new(:exception => exception, :summary => "I know what I'm doing, and we got an error").notice
+      data = Chatterbox::ExceptionNotification::Extracter.new(:exception => Exception.new, :summary => "I know what I'm doing, and we got an error").notice
       data[:summary].should == "I know what I'm doing, and we got an error"
     end
   end

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

@@ -76,7 +76,7 @@ describe Chatterbox::ExceptionNotification::RailsExtracter do
     it "returns top level Rails config if defined" do
       Object.expects(:const_defined?).with("Rails").returns(true)
       Object.expects(:const_get).with("Rails").returns("fake rails const")
-      extracter = Chatterbox::ExceptionNotification::RailsExtracter.new
+      extracter = Chatterbox::ExceptionNotification::RailsExtracter.new({})
       extracter.rails_configuration.should == "fake rails const"
     end
   end

data/examples/lib/chatterbox/exception_notification_example.rb

@@ -0,0 +1,66 @@
+require 'example_helper'
+require 'chatterbox/exception_notification'
+
+describe Chatterbox::ExceptionNotification do
+  
+  describe "handling" do
+    it "accepts exceptions" do
+      Chatterbox::ExceptionNotification.handle(Exception.new)
+    end
+    
+    it "accepts hashes" do
+      Chatterbox::ExceptionNotification.handle(:exception => Exception.new)
+    end
+    
+    describe "when on ignore list" do
+      after do
+        Chatterbox::ExceptionNotification.configure { |c| c.ignore = Chatterbox::ExceptionNotification.default_ignored_exceptions }
+      end
+      
+      it "returns nil for explicit exception" do
+        Chatterbox::ExceptionNotification.configure { |c| c.ignore << RuntimeError }
+        Chatterbox::ExceptionNotification.handle(RuntimeError.new).should be_nil
+      end
+      
+      it "returns nil for :exception => exception" do
+        Chatterbox::ExceptionNotification.configure { |c| c.ignore << RuntimeError }
+        Chatterbox::ExceptionNotification.handle(:exception => RuntimeError.new).should be_nil
+      end
+      
+    end
+  end
+  
+  describe "normalize_to_hash" do
+    it "returns :exception =>  for exception" do
+      exception = RuntimeError.new
+      Chatterbox::ExceptionNotification.normalize_to_hash(exception).should == { :exception => exception }
+    end
+    
+    it "returns hashes as is" do
+      Chatterbox::ExceptionNotification.normalize_to_hash({}).should == {}
+    end
+    
+    it "returns string like objects as :summary => obj.to_s" do
+      Chatterbox::ExceptionNotification.normalize_to_hash("failure").should == { :summary => "failure" }
+    end
+  end
+  
+  describe "configuration" do
+    after do
+      Chatterbox::ExceptionNotification.configure { |c| c.ignore = Chatterbox::ExceptionNotification.default_ignored_exceptions }
+    end
+
+    it "ignores common Rails exceptions by default" do
+      Chatterbox::ExceptionNotification.configuration.ignore.should == Chatterbox::ExceptionNotification.default_ignored_exceptions
+    end
+    
+    it "allows adding exceptions to the ignore list" do
+      Chatterbox::ExceptionNotification.configure do |config|
+        config.ignore << "SomeOtherException"
+      end
+      Chatterbox::ExceptionNotification.configuration.ignore.should include("SomeOtherException")
+    end
+  end
+  
+  
+end

data/examples/lib/chatterbox/rails_catcher_controller_example.rb

@@ -54,7 +54,7 @@ describe WidgetsController do
     end
     
     it "should send exception notice as hash" do
-      Chatterbox.expects(:handle_notice).with(instance_of(Hash))
+      Chatterbox::ExceptionNotification.expects(:handle).with(instance_of(Hash))
       get :index rescue nil
     end
   end
@@ -62,11 +62,11 @@ describe WidgetsController do
   describe "ignoring exceptions" do
     describe "when configured to ignore RuntimeError (as class)" do
       before do
-        Chatterbox::RailsCatcher.configure { |c| c.ignore << RuntimeError }
+        Chatterbox::ExceptionNotification.configure { |c| c.ignore << RuntimeError }
       end
       
       after do
-        Chatterbox::RailsCatcher.configure { |c| c.ignore = Chatterbox::RailsCatcher.default_ignored_exceptions }
+        Chatterbox::ExceptionNotification.configure { |c| c.ignore = Chatterbox::ExceptionNotification.default_ignored_exceptions }
       end
       
       it "handles exceptions normally" do
@@ -85,11 +85,11 @@ describe WidgetsController do
     
     describe "when configured to ignore RuntimeError (as String)" do
       before do
-        Chatterbox::RailsCatcher.configure { |c| c.ignore << "RuntimeError" }
+        Chatterbox::ExceptionNotification.configure { |c| c.ignore << "RuntimeError" }
       end
       
       after do
-        Chatterbox::RailsCatcher.configure { |c| c.ignore = Chatterbox::RailsCatcher.default_ignored_exceptions }
+        Chatterbox::ExceptionNotification.configure { |c| c.ignore = Chatterbox::ExceptionNotification.default_ignored_exceptions }
       end
       
       it "handles exceptions normally" do

data/examples/lib/chatterbox/rails_catcher_example.rb

@@ -5,25 +5,29 @@ require File.expand_path(File.join(File.dirname(__FILE__), *%w[.. .. .. rails in
 describe Chatterbox::RailsCatcher do
   
   def helper
-    @helper ||= Class.new {
+    @helper ||= Class.new do
+      def rescue_action_in_public(exception); end
+      def self.hide_action(*name); end
+      
       include Chatterbox::RailsCatcher
-    }.new
+    end.new
   end
   
-  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
+  describe "rescue_action_in_public_with_chatterbox" do
+    describe "when request is not available" do
+      it "sends exception and request hash to ExceptionNotification" do
+        exception = stub_everything
+        helper.stubs(:request).returns(request = stub_everything)
+        Chatterbox::ExceptionNotification.expects(:handle).with(:exception => exception, :request => request)
+        helper.rescue_action_in_public_with_chatterbox(exception)
+      end
     end
     
-    it "allows adding exceptions to the ignore list" do
-      Chatterbox::RailsCatcher.configure do |config|
-        config.ignore << "SomeOtherException"
+    describe "when request is not available" do
+      it "sends the exception hash on to ExceptionNotification" do
+        Chatterbox::ExceptionNotification.expects(:handle).with(:exception => (exception = stub))
+        helper.rescue_action_in_public_with_chatterbox(exception)
       end
-      Chatterbox::RailsCatcher.configuration.ignore.should include("SomeOtherException")
     end
   end
 end

data/lib/chatterbox/exception_notification/extracter.rb

@@ -1,46 +1,26 @@
 module Chatterbox::ExceptionNotification
   class Extracter
-    attr_reader :message
-
     def self.wrap(notification = {})
       new(notification).notice
     end
 
-    def initialize(message = {})
-      @message = message
+    def initialize(notification)
+      @notification = notification
     end
 
     def notice
-      hash = normalize_message_to_hash(message)
-      hash = exception_to_notice(hash)
-      default_info.merge(hash)
-    end
-
-    def normalize_message_to_hash(message)
-      case
-      when Exception === message
-        { :exception => message }
-      when message.respond_to?(:to_hash)
-        message.to_hash
-      when message.respond_to?(:to_s)
-        string_to_notice(message.to_s)
-      end
+      hash = extract_exception_info(@notification)
+      hash = extract_ruby_info(hash)
+      extract_default_info(hash)
     end
 
-    def default_info
-      default_info     = {
-        :summary       => "N/A",
-        :environment   => env
-      }
-      default_info = add_ruby_info(default_info)
-      default_info
-    end
-
-    def string_to_notice(message)
-      { :summary => message }
+    def extract_default_info(hash)
+      { :summary       => "N/A",
+        :environment   => ENV.to_hash
+      }.merge(hash)
     end
 
-    def exception_to_notice(hash)
+    def extract_exception_info(hash)
       return hash unless hash.key?(:exception)
       exception = hash[:exception]
       {
@@ -51,25 +31,13 @@ module Chatterbox::ExceptionNotification
       }.merge(hash)
     end
 
-    def add_ruby_info(data)
-      data.merge({ 
+    def extract_ruby_info(hash)
+      hash.merge({ 
         :ruby_info => {
-          :ruby_version  => ruby_version,
-          :ruby_platform => ruby_platform
+          :ruby_version  => RUBY_VERSION,
+          :ruby_platform => RUBY_PLATFORM
         }
       })
     end
-
-    def ruby_version
-      RUBY_VERSION
-    end
-
-    def ruby_platform
-      RUBY_PLATFORM
-    end
-
-    def env
-      ENV.to_hash
-    end
   end
 end

data/lib/chatterbox/exception_notification/rails_extracter.rb

@@ -4,29 +4,28 @@ module Chatterbox::ExceptionNotification
       new(notification).notice
     end
 
-    def initialize(message = {})
-      @message = message
+    def initialize(notification)
+      @notification = notification
     end
 
     def notice
-      hsh = extract_rails_info(@message)
+      hsh = extract_rails_info(@notification)
       hsh = extract_request_info(hsh)
-      hsh = filter_rails_root(hsh)
-      hsh
+      filter_rails_root(hsh)
     end
     
-    def filter_rails_root(hsh)
-      return hsh unless hsh[:backtrace]
+    def filter_rails_root(hash)
+      return hash unless hash[:backtrace]
       cleaner = ActiveSupport::BacktraceCleaner.new
       cleaner.add_filter { |line| line.gsub(rails_root, "[RAILS_ROOT]") }
-      backtrace = cleaner.clean(hsh[:backtrace])
-      hsh[:backtrace] = backtrace
-      hsh
+      backtrace = cleaner.clean(hash[:backtrace])
+      hash[:backtrace] = backtrace
+      hash
     end
 
-    def extract_rails_info(message)
-      return message if rails_configuration.nil?
-      message.merge({
+    def extract_rails_info(hash)
+      return hash if rails_configuration.nil?
+      hash.merge({
         :rails_info => {
           :rails_env => rails_configuration.env.to_s,
           :rails_root => rails_root,
@@ -35,10 +34,10 @@ module Chatterbox::ExceptionNotification
       })
     end
     
-    def extract_request_info(message)
-      return message unless message.key?(:request)
-      request = message.delete(:request)
-      message.merge({
+    def extract_request_info(hash)
+      return hash unless hash.key?(:request)
+      request = hash.delete(:request)
+      hash.merge({
         :request => {
           :url => request.url,
           :remote_ip => request.remote_ip,

data/lib/chatterbox/exception_notification.rb

@@ -1,5 +1,60 @@
+require 'ostruct'
+
 module Chatterbox
   module ExceptionNotification
+
+    # Handle the exception
+    # Accepts either an exception, a hash, or an object that responds to to_s
+    #   Exceptions are passed through like normal
+    #   Hashes can have an :exception => exception in them, which will result in 
+    #     the same treatment as a literal exception passed 
+    #   Objects are simply treated as a 'summary' message were an exception may not be necessary
+    def handle(args)
+      hsh = normalize_to_hash(args)
+      return if on_ignore_list?(hsh[:exception])
+      hsh = Extracter.wrap(hsh)
+      hsh = RailsExtracter.wrap(hsh)
+      hsh = Presenter.render(hsh)
+      Chatterbox.notify(hsh)
+    end
+
+    def normalize_to_hash(args)
+      case
+      when Exception === args then           { :exception => args }
+      when args.respond_to?(:to_hash) then   args.to_hash
+      when args.respond_to?(:to_s) then      { :summary => args.to_s }
+      end
+    end
+    
+    def on_ignore_list?(exception)
+      configuration.ignore.include?(exception.class) || 
+      configuration.ignore.include?(exception.class.to_s)
+    end
+
+    def configuration
+      @configuration ||= OpenStruct.new(:ignore => default_ignored_exceptions)
+    end
+    
+    # Configure ExceptionNotification
+    # ex:
+    #   Chatterbox::ExceptionNotification.configure do |config|
+    #      config.ignore << MyOwnExceptionToIgnore
+    #   end
+    #
+    #
+    def configure
+      yield(configuration)
+    end
+    
+    # Default exceptions that ExceptionNotification will ignore
+    def default_ignored_exceptions
+      ['ActiveRecord::RecordNotFound', 'ActionController::RoutingError',
+       'ActionController::InvalidAuthenticityToken', 'ActionController::UnknownAction',
+       'CGI::Session::CookieStore::TamperedWithCookie' ]
+    end
+    
+    extend self
+    
   end
 end
 

data/lib/chatterbox/rails_catcher.rb

@@ -1,23 +1,6 @@
-require 'ostruct'
-
 module Chatterbox
-
   module RailsCatcher
     
-    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'
         base.send(:alias_method, :rescue_action_in_public_without_chatterbox, :rescue_action_in_public)
@@ -29,29 +12,13 @@ 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 { "Chatterbox caught exception #{exception} - about to handle" }
-      unless on_ignore_list?(exception)
-        Chatterbox.handle_notice(extract_exception_details(exception))
-      end
-      Chatterbox.logger.debug { "Chatterbox handing exception #{exception} off to normal rescue handling" }
+      Chatterbox.logger.debug { "Chatterbox caught exception '#{exception}' - about to handle" }
+      options = { :exception => exception }
+      options.merge!(:request => request) if self.respond_to?(:request)
+      Chatterbox::ExceptionNotification.handle(options)
+      Chatterbox.logger.debug { "Chatterbox handing exception '#{exception}' off to normal rescue handling" }
       rescue_action_in_public_without_chatterbox(exception)
     end
     
-    private
-    
-    def on_ignore_list?(exception)
-      Chatterbox::RailsCatcher.configuration.ignore.include?(exception.class) || 
-      Chatterbox::RailsCatcher.configuration.ignore.include?(exception.class.to_s)
-    end
-    
-    def extract_exception_details(exception)
-      options = { :exception => exception, :request => request }
-      options = Chatterbox::ExceptionNotification::Extracter.wrap(options)
-      options = Chatterbox::ExceptionNotification::RailsExtracter.wrap(options)
-      options = Chatterbox::ExceptionNotification::Presenter.render(options)
-      options
-    end
-    
   end
-  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: chatterbox
 version: !ruby/object:Gem::Version 
-  version: 0.5.4
+  version: 0.6.0
 platform: ruby
 authors: 
 - Rob Sanheim
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-13 00:00:00 -05:00
+date: 2009-11-15 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -74,6 +74,7 @@ files:
 - 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/exception_notification_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
@@ -127,6 +128,7 @@ test_files:
 - 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/exception_notification_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