chatterbox 0.5.3 → 0.5.4

data/CHANGELOG.markdown

@@ -1,4 +1,11 @@
 HEAD
+
+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
+    right about now
+  - Remove #log_prefix from RailsCatcher, simpler and not needed
+    
 0.5.3
   - exception filtering
   

data/README.markdown

@@ -19,21 +19,23 @@ Then run:
 
 ## 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.
+One of the most handy use cases Chatterbox was developed for was Rails exception notification.  To setup Chatterbox for exception notification, install it as a gem with the instructions above, then configure it inside an initializer:
 
-then wire the `RailsCatcher` in your `ApplicationController`:
+    Chatterbox::Services::Email.configure :to => "errors@example.com", :from => "donotreply@example.com"
+
+    Chatterbox::Publishers.register do |notification|
+      Chatterbox::Services::Email.deliver(notification)
+    end
 
-To enable standard Rails exception catching for your controllers, add the following to `application_controller`
+then wire the `RailsCatcher` in your `ApplicationController`:
 
     class ApplicationController < ActionController::Base
       include Chatterbox::RailsCatcher
-      # ...
     end
-    
-Then, wire up a producer
 
+And you are done!  Exceptions thrown in controllers will automatically be processed and sent by Chatterbox, and then raised to be handled (or not handled) as normally.
 
-Example 1
+## Example: Sending Emails
 ---------------------------------------
 
 Register the email service to handle messages that get sent to Chatterbox:
@@ -46,20 +48,10 @@ Then, wherever you want to send email, do this:
 
     message = {
       :config => { :to => "joe@example.com", :from => "donotreply@example.com" },
-      :message => { :summary => "your subject line here" }
+      :message => { :summary => "your subject line here", :body => "Email body here" }
     }
     Chatterbox.handle_notice(options)
 
-Example 2
----------------------------------------
-
-Wiring up notices to be sent to an exceptions queue, defined in RosettaQueue
-
-    Chatterbox::Publishers.register do |notice|
-      RosettaQueue::Producer.publish(:exceptions, notice)
-    end
-
-
 Bugs & Patches
 --------------
 

data/{version.yml → VERSION.yml}

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

data/chatterbox.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{chatterbox}
-  s.version = "0.5.3"
+  s.version = "0.5.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Rob Sanheim"]
@@ -23,6 +23,7 @@ Gem::Specification.new do |s|
      "LICENSE",
      "README.markdown",
      "Rakefile",
+     "VERSION.yml",
      "chatterbox.gemspec",
      "examples/example_helper.rb",
      "examples/lib/chatterbox/exception_notification/extracter_example.rb",
@@ -47,7 +48,6 @@ Gem::Specification.new do |s|
      "lib/chatterbox/services/email/views/chatterbox/services/email/mailer/message.erb",
      "rails/init.rb",
      "todo.markdown",
-     "version.yml",
      "views/chatterbox/mailer/exception_notification.erb"
   ]
   s.homepage = %q{http://github.com/rsanheim/chatterbox}

data/examples/lib/chatterbox/rails_catcher_example.rb

@@ -10,13 +10,6 @@ describe Chatterbox::RailsCatcher do
     }.new
   end
   
-  describe "logger" do
-    it "should delegate to Chatterbox#logger" do
-      Chatterbox.expects(:logger)
-      helper.logger
-    end
-  end
-  
   describe "configuration" do
     after do
       Chatterbox::RailsCatcher.configure { |c| c.ignore = Chatterbox::RailsCatcher.default_ignored_exceptions }

data/lib/chatterbox/rails_catcher.rb

@@ -3,14 +3,12 @@ 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
+    end
     
     def self.configuration
       @configuration ||= OpenStruct.new(:ignore => default_ignored_exceptions)
@@ -31,23 +29,19 @@ 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)
-      logger.debug { "#{log_prefix} caught exception #{exception} - about to handle" }
+      Chatterbox.logger.debug { "Chatterbox 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" }
+      Chatterbox.logger.debug { "Chatterbox 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)
+      Chatterbox::RailsCatcher.configuration.ignore.include?(exception.class) || 
+      Chatterbox::RailsCatcher.configuration.ignore.include?(exception.class.to_s)
     end
     
     def extract_exception_details(exception)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: chatterbox
 version: !ruby/object:Gem::Version 
-  version: 0.5.3
+  version: 0.5.4
 platform: ruby
 authors: 
 - Rob Sanheim
@@ -68,6 +68,7 @@ files:
 - LICENSE
 - README.markdown
 - Rakefile
+- VERSION.yml
 - chatterbox.gemspec
 - examples/example_helper.rb
 - examples/lib/chatterbox/exception_notification/extracter_example.rb
@@ -92,7 +93,6 @@ files:
 - lib/chatterbox/services/email/views/chatterbox/services/email/mailer/message.erb
 - rails/init.rb
 - todo.markdown
-- version.yml
 - views/chatterbox/mailer/exception_notification.erb
 has_rdoc: true
 homepage: http://github.com/rsanheim/chatterbox