chatterbox 0.4.0 → 0.5.0

data/CHANGELOG.markdown

@@ -0,0 +1,15 @@
+HEAD
+
+0.4.2
+
+  - handle_notice returns the message that was passed in
+
+0.4.1
+
+  - top level alias `notify` for `handle_notice`
+  - simplified logging - no longer tries to use Rails logger if it exists
+  
+0.4.0
+  
+  - removed notification wrapper around messages sent to Chatterbox to simplify things
+  

data/README.markdown

@@ -34,7 +34,7 @@ Example 1
 Register the email service to handle messages that get sent to Chatterbox:
 
     Chatterbox::Publishers.register do |notice|
-      Chatterbox::Email.deliver(notice)
+      Chatterbox::Services::Email.deliver(notice)
     end
 
 Then, wherever you want to send email, do this:

data/Rakefile

@@ -5,7 +5,7 @@ begin
   Jeweler::Tasks.new do |gem|
     gem.name = "chatterbox"
     gem.summary = %Q{Notifications and messages}
-    gem.description = %W{Send messages.  However you want.}
+    gem.description = "Send notifications and messages.  However you want."
     gem.email = "rsanheim@gmail.com"
     gem.homepage = "http://github.com/rsanheim/chatterbox"
     gem.authors = ["Rob Sanheim"]
@@ -27,7 +27,7 @@ end
 
 Micronaut::RakeTask.new(:rcov) do |examples|
   examples.pattern = 'examples/**/*_example.rb'
-  examples.rcov_opts = '-Ilib -Iexamples'
+  examples.rcov_opts = %[-Ilib -Iexamples --exclude "examples/*,gems/*,db/*,/Library/Ruby/*,config/*" --text-summary  --sort coverage]
   examples.rcov = true
 end
 

data/chatterbox.gemspec

@@ -1,16 +1,16 @@
 # Generated by jeweler
-# DO NOT EDIT THIS FILE
-# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{chatterbox}
-  s.version = "0.4.0"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Rob Sanheim"]
-  s.date = %q{2009-10-09}
-  s.description = %q{["Send", "messages.", "However", "you", "want."]}
+  s.date = %q{2009-11-06}
+  s.description = %q{Send notifications and messages.  However you want.}
   s.email = %q{rsanheim@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -19,21 +19,31 @@ Gem::Specification.new do |s|
   s.files = [
     ".gitignore",
      ".treasure_map.rb",
+     "CHANGELOG.markdown",
      "LICENSE",
      "README.markdown",
      "Rakefile",
      "chatterbox.gemspec",
-     "examples/chatterbox_example.rb",
      "examples/example_helper.rb",
-     "examples/lib/chatterbox/consumers/email_consumer_example.rb",
-     "examples/lib/chatterbox/notification_example.rb",
+     "examples/lib/chatterbox/exception_notification/filter_example.rb",
+     "examples/lib/chatterbox/exception_notification/presenter_example.rb",
+     "examples/lib/chatterbox/exception_notification/rails_extracter_example.rb",
      "examples/lib/chatterbox/rails_catcher_example.rb",
+     "examples/lib/chatterbox/services/email/mailer_example.rb",
+     "examples/lib/chatterbox/services/email_example.rb",
+     "examples/lib/chatterbox/services_example.rb",
+     "examples/lib/chatterbox_example.rb",
      "init.rb",
      "lib/chatterbox.rb",
-     "lib/chatterbox/notification.rb",
+     "lib/chatterbox/exception_notification.rb",
+     "lib/chatterbox/exception_notification/extracter.rb",
+     "lib/chatterbox/exception_notification/presenter.rb",
+     "lib/chatterbox/exception_notification/rails_extracter.rb",
      "lib/chatterbox/rails_catcher.rb",
-     "lib/consumers.rb",
-     "lib/consumers/email_consumer.rb",
+     "lib/chatterbox/services.rb",
+     "lib/chatterbox/services/email.rb",
+     "lib/chatterbox/services/email/mailer.rb",
+     "lib/chatterbox/services/email/views/chatterbox/services/email/mailer/message.erb",
      "rails/init.rb",
      "todo.markdown",
      "version.yml",
@@ -45,11 +55,15 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.5}
   s.summary = %q{Notifications and messages}
   s.test_files = [
-    "examples/chatterbox_example.rb",
-     "examples/example_helper.rb",
-     "examples/lib/chatterbox/consumers/email_consumer_example.rb",
-     "examples/lib/chatterbox/notification_example.rb",
-     "examples/lib/chatterbox/rails_catcher_example.rb"
+    "examples/example_helper.rb",
+     "examples/lib/chatterbox/exception_notification/filter_example.rb",
+     "examples/lib/chatterbox/exception_notification/presenter_example.rb",
+     "examples/lib/chatterbox/exception_notification/rails_extracter_example.rb",
+     "examples/lib/chatterbox/rails_catcher_example.rb",
+     "examples/lib/chatterbox/services/email/mailer_example.rb",
+     "examples/lib/chatterbox/services/email_example.rb",
+     "examples/lib/chatterbox/services_example.rb",
+     "examples/lib/chatterbox_example.rb"
   ]
 
   if s.respond_to? :specification_version then
@@ -74,3 +88,4 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<micronaut-rails>, [">= 0"])
   end
 end
+

data/examples/example_helper.rb

@@ -3,10 +3,10 @@ require 'action_controller'
 require 'micronaut'
 require 'micronaut-rails'
 require 'mocha'
-
+require 'log_buddy'
+LogBuddy.init
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-# $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib'))
 
 require 'lib/chatterbox'
 
@@ -20,4 +20,14 @@ Micronaut.configure do |c|
   c.filter_run :focused => true
   c.alias_example_to :fit, :focused => true
   c.enable_controller_support :behaviour => { :describes => lambda { |dt| dt < ::ActionController::Base } }
-end
+end
+
+def valid_options(overrides = {})
+  options = { 
+    :message => { :summary => "here is a message" },
+    :config => { 
+      :to => "joe@example.com", 
+      :from => "someone@here.com" 
+    }
+  }.merge(overrides)
+end

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

@@ -0,0 +1,38 @@
+require 'example_helper'
+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
+    end
+
+    it "should extract exception info from an exception in a hash" do
+      exception = raised_exception
+      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"
+      data[:error_message].should == "Your zing bats got mixed up with the snosh frazzles."
+      data[:backtrace].should == exception.backtrace
+      data[:other_info].should == "yo dawg"
+    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[:summary].should == "I know what I'm doing, and we got an error"
+    end
+  end
+end

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

@@ -0,0 +1,89 @@
+require 'example_helper'
+require 'chatterbox/exception_notification'
+
+describe Chatterbox::ExceptionNotification::Presenter  do
+
+  describe "body" do
+    it "should render sections in order" do
+      options = {
+        :environment => { "PATH" => "/usr/bin" },
+        :error_message => "ActionView::MissingTemplate: Missing template projects/show.erb in view path app/views",
+        :ruby_info => {
+          :ruby_version => "1.8.6",
+          :ruby_platform => "darwin"
+        }
+      }
+      presenter = Chatterbox::ExceptionNotification::Presenter.new(options)
+      expected =<<EOL
+Error Message
+----------
+"ActionView::MissingTemplate: Missing template projects/show.erb in view path app/views"
+
+Environment
+----------
+PATH: /usr/bin
+
+Ruby Info
+----------
+ruby_platform: darwin
+ruby_version: 1.8.6
+EOL
+      presenter.body.strip.should == expected.strip
+    end
+  end
+  
+  describe "render_section" do
+    it "should humanzie the title of the section" do
+     presenter = Chatterbox::ExceptionNotification::Presenter.new({"environment" => "foo'"})
+     presenter.render_section("environment").should include("Environment\n")
+    end
+    
+    it "should inspect the value for the key" do
+      presenter = Chatterbox::ExceptionNotification::Presenter.new({"environment" => "foo"})
+      presenter.render_section("environment").should include(%[foo])
+    end
+    
+    it "should return nil if the key does not exist in the options" do
+      presenter = Chatterbox::ExceptionNotification::Presenter.new
+      presenter.render_section("environment").should be_nil
+    end
+  end
+  
+  describe "inspect_value" do
+    it "outputs hashes in key sorted order" do
+      hash = { 
+        "my-key" => "something", 
+        "zephyr" => "something",
+        :nanite => "something",
+        "abcdefg" => "foo"
+      }
+      presenter = Chatterbox::ExceptionNotification::Presenter.new
+      expected =<<-EOL
+abcdefg: foo
+my-key: something
+nanite: something
+zephyr: something
+EOL
+      presenter.inspect_value(hash).should == expected.strip
+    end
+  end
+  
+  describe "prettyify_output" do
+    it "should strip leading --- from to_yaml and retrun pretty output for hashes" do
+      hash = { "my-key" => "some string value", "my-other-key" => "something" }
+      presenter = Chatterbox::ExceptionNotification::Presenter.new
+      output = presenter.inspect_value(hash)
+      # NOTE: Handling different hash order below, between 1.8.x and 1.9.1
+      actual_lines = output.split("\n")
+      expected_lines = ["my-key: some string value", "my-other-key: something"]
+      expected_lines.each { |line| actual_lines.should include(line) }
+    end
+    
+    it "should strip leading --- from strings" do
+      presenter = Chatterbox::ExceptionNotification::Presenter.new
+      output = presenter.inspect_value("just a simple string")
+      output.should == "just a simple string"
+    end
+  end
+  
+end

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

@@ -0,0 +1,50 @@
+require 'example_helper'
+require 'chatterbox/exception_notification'
+
+describe Chatterbox::ExceptionNotification::RailsExtracter do
+
+  describe "wrap" do
+    describe "when Rails is not defined or not found" do
+      it "returns message unchanged" do
+        Object.expects(:const_defined?).with("Rails").returns(false)
+        original_hash = {:foo => "bar", :something => "else"}
+        hsh = Chatterbox::ExceptionNotification::RailsExtracter.wrap(original_hash)
+        hsh.should == original_hash
+      end
+    end
+    
+    describe "when Rails is defined" do
+      it "merges in rails root, env, and version" do
+        rails = stub_everything({
+          :env => "production",
+          :root => "/a/blah/current",
+          :version => "2.3.2"
+        })
+        Chatterbox::ExceptionNotification::RailsExtracter.any_instance.stubs(:rails_configuration).returns(rails)
+        details = Chatterbox::ExceptionNotification::RailsExtracter.wrap({})
+        details[:rails_info][:rails_root].should == "/a/blah/current"
+        details[:rails_info][:rails_env].should == "production"
+        details[:rails_info][:rails_version].should == "2.3.2"
+      end
+    end
+
+    describe "when handed a request as optional data" do
+      it "should inclue url and remote ip" do
+        request = stub_everything(:url => "http://example.com/fail-whale", :remote_ip => "192.5.5.0")
+        details = Chatterbox::ExceptionNotification::RailsExtracter.wrap({:request => request})
+        details[:request][:url].should == "http://example.com/fail-whale"
+        details[:request][:remote_ip].should == "192.5.5.0"
+      end
+    end
+  end
+  
+  describe "rails_configuration" 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.rails_configuration.should == "fake rails const"
+    end
+  end
+
+end

data/examples/lib/chatterbox/rails_catcher_example.rb

@@ -1,4 +1,5 @@
-require File.expand_path(File.join(File.dirname(__FILE__), *%w[.. .. example_helper]))
+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' }
@@ -27,28 +28,34 @@ end
 
 describe WidgetsController do
   
-  describe "rescue aliasing" do
-    
-    it "should alias method chain" 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 to handle_notice" do
-      Chatterbox.expects(:handle_notice).with(instance_of(WidgetException))
+    it "should send exception notice as hash" do
+      Chatterbox.expects(:handle_notice).with(instance_of(Hash))
       get :index rescue nil
     end
-    
   end
-
 end

data/examples/lib/chatterbox/services/email/mailer_example.rb

@@ -0,0 +1,54 @@
+require 'example_helper'
+require 'chatterbox/services/email'
+
+describe Chatterbox::Services::Email::Mailer do
+  before { ActionMailer::Base.delivery_method = :test }
+
+  describe "wiring the email" do
+    it "should set subject to the summary" do
+      email = Chatterbox::Services::Email::Mailer.create_message(valid_options.merge(:message => { :summary => "check this out"}))
+      email.subject.should == "check this out"
+    end
+    
+    it "should not require a body (for emails that are subject only)" do
+      email = Chatterbox::Services::Email::Mailer.create_message(valid_options.merge(:message => { :body => nil}))
+      email.body.should be_blank # not nil for some reason -- ActionMailer provides an empty string somewhere
+    end
+    
+    it "should set body to the body" do
+      email = Chatterbox::Services::Email::Mailer.create_message(valid_options.merge(:message => { :body => "here is my body"}))
+      email.body.should == "here is my body"
+    end
+    
+    it "should set from" do
+      email = Chatterbox::Services::Email::Mailer.create_message(valid_options.merge(:config => { :from => ["from@example.com"] }))
+      email.from.should == ["from@example.com"]
+    end
+  end
+  
+  describe "content type" do
+    
+    it "can be set" do
+      Chatterbox::Services::Email::Mailer.create_message(valid_options.merge(:config => { :content_type => "text/html"})).content_type.should == "text/html"
+    end
+    
+    it "should default to text/plain" do
+      Chatterbox::Services::Email::Mailer.create_message(valid_options).content_type.should == "text/plain"
+    end
+  end
+  
+  [:to, :cc, :bcc, :reply_to].each do |field| 
+    describe "when configuring the #{field} field that takes one or many email addresses" do
+      it "should allow setting a single address" do
+        email = Chatterbox::Services::Email::Mailer.create_message(valid_options.merge(:config => { field => "joe@exmaple.com"}))
+        email.send(field).should == ["joe@exmaple.com"]
+      end
+      
+      it "should allow setting multiple addresses" do
+        email = Chatterbox::Services::Email::Mailer.create_message(valid_options.merge(:config => { field => ["joe@example.com", "frank@example.com"]}))
+        email.send(field).should == ["joe@example.com", "frank@example.com"]
+      end
+    end
+  end
+
+end

data/examples/lib/chatterbox/services/email_example.rb

@@ -0,0 +1,89 @@
+require 'example_helper'
+require 'chatterbox/services/email'
+
+describe Chatterbox::Services::Email do
+  include Chatterbox
+  ActionMailer::Base.delivery_method = :test
+  
+  before { Chatterbox::Services::Email.configure({}) }
+  
+  describe "creation" do
+    it "is wired with valid options" do
+      lambda {
+        Chatterbox::Services::Email.deliver(valid_options)
+      }.should_not raise_error
+    end
+    
+    it "returns TMail::Mail instance" do
+      result = Chatterbox::Services::Email.deliver(valid_options)
+      result.should be_instance_of(TMail::Mail)
+    end
+    
+    it "should preserve HashWithIndifferentAccess with explicit options" do
+      options = { :message => { :summary => "foo" }, :config => {:to => "a", :from => "a"} }.with_indifferent_access
+      service = Chatterbox::Services::Email.new(options)
+      service.options.should be_instance_of(HashWithIndifferentAccess)
+      service.options[:config].should be_instance_of(HashWithIndifferentAccess)
+    end
+    
+    it "should preserve HashWithIndifferentAccess with default configuration" do
+      options = { :message => { :summary => "foo" } }.with_indifferent_access
+      Chatterbox::Services::Email.configure :to => "default-to@example.com", :from => "default-from@example.com"
+      service = Chatterbox::Services::Email.new(options)
+      service.options.should be_instance_of(HashWithIndifferentAccess)
+      service.options[:config].should be_instance_of(HashWithIndifferentAccess)
+    end
+  end
+  
+  describe "validations" do
+    it "should require :message" do
+      lambda {
+        Chatterbox::Services::Email.deliver(:config => { :from => "foo", :to => "foo"})
+      }.should raise_error(ArgumentError, /Must configure with a :message/)
+    end
+    
+    it "should require :message => :summary" do
+      lambda {
+        Chatterbox::Services::Email.deliver(:message => {}, :config => { :from => "foo", :to => "foo"})
+      }.should raise_error(ArgumentError, /Must provide :summary in the :message/)
+    end
+    
+    it "should require :to" do
+      lambda {
+        Chatterbox::Services::Email.deliver(:message => {:summary => ""}, :config => { :from => "anyone" })
+      }.should raise_error(ArgumentError, /Must provide :to in the :config/)
+    end
+  
+    it "should require from address" do
+      lambda {
+        Chatterbox::Services::Email.deliver(:message => {:summary => ""}, :config => { :to => "anyone"})
+      }.should raise_error(ArgumentError, /Must provide :from in the :config/)
+    end
+  end
+  
+  describe "default_configuration=" do
+    it "should default to empty hash" do
+      Chatterbox::Services::Email.default_configuration.should == {}
+    end
+    
+    it "should set a hash of default configuration into :config hash" do
+      Chatterbox::Services::Email.configure :to => "to@example.com", :from => "from@example.com"
+      Chatterbox::Services::Email.default_configuration.should == { :to => "to@example.com", :from => "from@example.com"}
+    end
+    
+    it "should use default configuration" do
+      Chatterbox::Services::Email.configure :to => "to@example.com", :from => "from@example.com"
+      mail = Chatterbox::Services::Email.deliver(:message => {:summary => "summary"})
+      mail.to.should == ["to@example.com"]
+      mail.from.should == ["from@example.com"]
+    end
+    
+    it "should allow message specific configuration" do
+      Chatterbox::Services::Email.configure :to => "default-to@example.com", :from => "default-from@example.com"
+      mail = Chatterbox::Services::Email.deliver(:message => {:summary => "summary"},
+        :config => { :to => "joe@example.com", :from => "harry@example.com"} )
+      mail.to.should == ["joe@example.com"]
+      mail.from.should == ["harry@example.com"]
+    end
+  end
+end

data/examples/{chatterbox_example.rb → lib/chatterbox_example.rb}

@@ -1,53 +1,51 @@
-require File.join(File.dirname(__FILE__), *%w[example_helper])
+require "example_helper"
 
 describe Chatterbox do
 
-  before do
-    Chatterbox.logger = Logger.new(nil)
-    Chatterbox::Publishers.clear!
-  end
-  
-  after do
-    Chatterbox.logger = nil
-  end
+  before { Chatterbox::Publishers.clear! }
   
   describe "handle_notice" do
-    include Chatterbox
+    it "should return notification" do
+      Chatterbox.handle_notice("message").should == "message"
+    end
     
     it "should publish the notice" do
-      Chatterbox.expects(:publish_notice).with("message")
-      Chatterbox.handle_notice("message")
+      Chatterbox.expects(:publish_notice).with({})
+      Chatterbox.handle_notice({})
     end
     
+    it "should alias to notify" do
+      Chatterbox.expects(:publish_notice).with("message")
+      Chatterbox.notify("message")
+    end
   end
   
   describe "logger" do
+    after { Chatterbox.logger = nil }
     
-    it "uses STDOUT logger if Rails not available" do
+    it "should allow a logger to be set" do
+      logger = Logger.new(nil)
+      Chatterbox.logger = logger
+      Chatterbox.logger.should == logger
+    end
+    
+    it "uses logger with nil device by default" do
       Chatterbox.logger = nil
-      
-      Logger.expects(:new).with(STDOUT).returns("logger")
-      Chatterbox.stubs(:rails_default_logger).returns(nil)
+      Logger.expects(:new).with(nil).returns("logger")
       Chatterbox.logger.should == "logger"
     end
   end
   
   describe "publish" do
-    
-    include Chatterbox
-    
     it "should call each publisher with the notice" do
-      notice = stub
       publisher = Chatterbox::Publishers.register { "i'm in your block" }
-      publisher.expects(:call).with(notice)
+      publisher.expects(:call).with({})
       
-      publish_notice(notice)
+      Chatterbox.publish_notice({})
     end
-    
   end
 
   describe "publishers" do
-    
     it "should allow clearing all publishers" do
       Chatterbox::Publishers.register { "sending your messages" }
       Chatterbox::Publishers.publishers.size.should == 1