chatterbox 0.6.2 → 0.8.1

data/CHANGELOG.markdown

@@ -1,4 +1,20 @@
-HEAD
+# Changelog
+
+### 0.8.1
+  - Make sure Arrays format nicely for ExceptionNotification, so backtraces are easy to read
+  
+### 0.8.0
+  - Simplify API - prefer :summary and :body at top level, instead of inside a nested :message hash
+  - Simplify output for exception notification; using pretty print so hashes render well, even if they are nested
+  - Deprecate `Chatterbox#handle_notice` -- use `#notify` instead; will be removed for 1.0
+  - Any user provided data sent to ExceptionNotification will be rendered first in the body, as we assume its the application specific data and most useful; details like the environment vars and Ruby/Rails details will follow beneath
+  
+### 0.7.0
+  - Add ability to configure `summary_prefix` for emails, for common case of "[my-app] " prefix line in the subject line for emails
+  
+### 0.6.2
+  - Change to ExceptionNotification: render any other data in the hash that is not 
+    enumerated in 'ordered sections'
 
 ### 0.6.1 
   - Handle case where there is no Rails Root defined

data/README.markdown

@@ -1,25 +1,81 @@
 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.  Of course, you can wire Chatterbox to work directly if you like.
+Chatterbox is a library to send notifications and messages over whatever service you like, whether it be email, Twitter, Campfire, IRC, or some combination therein.  The goal of Chatterbox is to be able to send a message from your application via whatever service the user prefers simple by tweaking the configuration hash that gets sent to Chatterbox.
+
+Publishing and subscribing to notifications can be decoupled easily, so bring your own message queue, web service, database, or whatever to act as an intermediary.  Or keep it simple and wire Chatterbox directly - its your choice.
 
 ## Installing and Running
 
 For plain old gem install: 
 
-    gem install chatterbox "source" => "http://gemcutter.org"
+    gem install chatterbox
 
 To install within a Rails app, add the following to your environment.rb file:
 
-    config.gem "chatterbox", :source => "http://gemcutter.org"
+    config.gem "chatterbox"
 
 Then run:
 
     rake gems:install
 
+## Services
+
+Services are used to send notifications in Chatterbox.  Chatterbox comes with an email service for use out of the box, which uses ActionMailer and works pretty much how you would expect.
+
+## Email Service Configuration
+
+Register the email service to handle messages that get sent to Chatterbox:
+
+    Chatterbox::Publishers.register do |notice|
+      Chatterbox::Services::Email.deliver(notice)
+    end
+
+Then, wherever you want to send email, do this:
+
+    options = {
+      :summary => "your subject line here", :body => "Email body here",
+      :config => { :to => "joe@example.com", :from => "donotreply@example.com" },
+    }
+    Chatterbox.notify(options)
+
+You can configure defaults for the email service:
+
+    Chatterbox::Services::Email.configure({
+      :to => "joe@example.com",
+      :from => "jane@example.com", 
+      :summary_prefix => "[my-prefix] "
+    })
+
+Then when you deliver messages, the provided options will be merged with the defaults:
+
+    Chatterbox.notify(:message => { :summary => "my subject" })
+
+Sends:
+
+    To: joe@example.com
+    From: jane@example.com
+    Subject: [my-prefix] my subject
+
+While the following overrides the default to and from addresses...
+
+    options = {
+      :summary => "my subject",
+      :config => { :to => "distro@example.com", :from => "reply@example.com" },
+    }
+    Chatterbox.notify(options)
+
+Sends:
+
+    To: distro@example.com
+    From: reply@example.com
+    Subject: [my-prefix] my subject
+
 ## Exception Notification
 
-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:
+One of the most handy use cases Chatterbox was developed for is exception notification.  Chatterbox can be configured for Rails exception catching from controllers, and can be used in a plain Ruby app as well.  
+
+To setup Chatterbox for Rails exception notification, install it as a gem with the instructions above, then configure it inside an initializer:
 
     Chatterbox::Services::Email.configure :to => "errors@example.com", :from => "donotreply@example.com"
 
@@ -35,33 +91,23 @@ then wire the `RailsCatcher` in your `ApplicationController`:
 
 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: Sending Emails
----------------------------------------
-
-Register the email service to handle messages that get sent to Chatterbox:
-
-    Chatterbox::Publishers.register do |notice|
-      Chatterbox::Services::Email.deliver(notice)
-    end
-
-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", :body => "Email body here" }
-    }
-    Chatterbox.handle_notice(options)
 
 Bugs & Patches
 --------------
+Please submit to [Github Issues](http://github.com/rsanheim/chatterbox/TODO).
+
+All patches must have spec coverage and a passing build, or they will be pushed back.
+
+You can easily verify your build by pushing the project to [RunCodeRun](http://runcoderun.com).  View the [master build](http://runcoderun.com/rsanheim/chatterbox) to confirm that HEAD is stable and passing.
 
 Links
 -------------
 
 Contributors
 ------------
-* Rob Sanheim
+* Rob Sanheim (creator)
+* Chad Humphries (API ideas)
 
 Copyrights
 ------------
-* Copyright © 2008-2009 [Relevance, Inc.](http://www.thinkrelevance.com/), under the MIT license
+Copyright © 2008-2009 Rob Sanheim under the MIT license

data/Rakefile

@@ -1,4 +1,5 @@
 require 'rake'
+require 'cucumber/rake/task'
 
 begin
   require 'jeweler'
@@ -31,7 +32,15 @@ Micronaut::RakeTask.new(:rcov) do |examples|
   examples.rcov = true
 end
 
-task :default => :examples
+Cucumber::Rake::Task.new :features do |t|
+  t.cucumber_opts = %w{--format progress}
+end
+
+if RUBY_VERSION == '1.9.1'
+  task :default => [:examples, :features]
+else
+  task :default => [:rcov, :features]
+end
 
 begin
   %w{sdoc sdoc-helpers rdiscount}.each { |name| gem name }

data/VERSION.yml

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

data/chatterbox.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{chatterbox}
-  s.version = "0.6.2"
+  s.version = "0.8.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Rob Sanheim"]
-  s.date = %q{2009-11-17}
+  s.date = %q{2009-11-26}
   s.description = %q{Send notifications and messages.  However you want.}
   s.email = %q{rsanheim@gmail.com}
   s.extra_rdoc_files = [
@@ -18,7 +18,6 @@ Gem::Specification.new do |s|
   ]
   s.files = [
     ".gitignore",
-     ".treasure_map.rb",
      "CHANGELOG.markdown",
      "LICENSE",
      "README.markdown",
@@ -32,10 +31,16 @@ Gem::Specification.new do |s|
      "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/campfire_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",
+     "features/api.feature",
+     "features/email_service.feature",
+     "features/services.feature",
+     "features/step_definitions/email_service_steps.rb",
+     "features/support/env.rb",
      "init.rb",
      "lib/chatterbox.rb",
      "lib/chatterbox/exception_notification.rb",
@@ -44,10 +49,12 @@ Gem::Specification.new do |s|
      "lib/chatterbox/exception_notification/rails_extracter.rb",
      "lib/chatterbox/rails_catcher.rb",
      "lib/chatterbox/services.rb",
+     "lib/chatterbox/services/campfire.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",
+     "tmp/.gitignore",
      "todo.markdown",
      "views/chatterbox/mailer/exception_notification.erb"
   ]
@@ -64,6 +71,7 @@ Gem::Specification.new do |s|
      "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/campfire_example.rb",
      "examples/lib/chatterbox/services/email/mailer_example.rb",
      "examples/lib/chatterbox/services/email_example.rb",
      "examples/lib/chatterbox/services_example.rb",

data/examples/example_helper.rb

@@ -24,7 +24,7 @@ end
 
 def valid_options(overrides = {})
   options = { 
-    :message => { :summary => "here is a message" },
+    :summary => "here is a message",
     :config => { 
       :to => "joe@example.com", 
       :from => "someone@here.com" 

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

@@ -4,11 +4,9 @@ require 'chatterbox/exception_notification'
 describe Chatterbox::ExceptionNotification::Extracter do
 
   describe "notice" do
-    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
+    it "merges default summary if none provided" do
+      data = Chatterbox::ExceptionNotification::Extracter.new({}).notice
+      data[:summary].should == "N/A"
     end
     
     it "merges environment hash" do
@@ -17,6 +15,13 @@ describe Chatterbox::ExceptionNotification::Extracter do
       data[:environment].should == ENV.to_hash
     end
 
+    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 "should extract exception info from an exception in a hash" do
       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/examples/lib/chatterbox/exception_notification/presenter_example.rb

@@ -6,6 +6,12 @@ describe Chatterbox::ExceptionNotification::Presenter  do
   describe "body" do
     it "should render sections in order" do
       options = {
+        :request => {
+          :parameters => {
+            :remote_ip => "10.0.0.1",
+            :array => [1,2,3]
+          }
+        },
         :environment => { "PATH" => "/usr/bin" },
         :error_message => "ActionView::MissingTemplate: Missing template projects/show.erb in view path app/views",
         :ruby_info => {
@@ -17,33 +23,68 @@ describe Chatterbox::ExceptionNotification::Presenter  do
       expected =<<EOL
 Error Message
 ----------
-"ActionView::MissingTemplate: Missing template projects/show.erb in view path app/views"
+ActionView::MissingTemplate: Missing template projects/show.erb in view path app/views
+
+Request
+----------
+parameters: {"remote_ip"=>"10.0.0.1", "array"=>[1, 2, 3]}
 
 Environment
 ----------
-PATH: /usr/bin
+PATH: "/usr/bin"
 
 Ruby Info
 ----------
-ruby_platform: darwin
-ruby_version: 1.8.6
+ruby_platform: "darwin"
+ruby_version: "1.8.6"
 EOL
-      presenter.body.strip.should == expected.strip
+      presenter.render_body.strip.should == expected.strip
     end
     
-    it "renders un ordered sections" do
-      options = {:exception => Exception.new, :other => "values and things", :hey => {"dragons" => "here"}}
+    it "renders 'extra' sections before explicitly named, ordered sections" do
+      options = {
+        :environment => { "PATH" => "/usr/bin" },
+        :special_details => "alert! system compromised in sector 8!"
+      }
       presenter = Chatterbox::ExceptionNotification::Presenter.new(options)
       expected =<<EOL
-Other
+Special Details
 ----------
-values and things
+alert! system compromised in sector 8!
 
-Hey
+Environment
 ----------
-dragons: here
+PATH: "/usr/bin"
 EOL
-      presenter.body.should include(expected)
+      presenter.render_body.strip.should == expected.strip
+    end
+    
+    it "renders unordered sections" do
+      options = {:error_message => "Runtime error has occured", :details => "values and things"}
+      presenter = Chatterbox::ExceptionNotification::Presenter.new(options)
+      expected =<<EOL
+Details
+----------
+values and things
+EOL
+      presenter.render_body.should include(expected)
+    end
+    
+    it "renders backtrace cleanly" do
+      backtrace = ["/codes/file.rb:52:in `some_method'", 
+        "/codes/file.rb:10:in `different_method'",
+        "/gems/some_gem/gem_name.rb:104:in `main'"]
+      options = { :backtrace => backtrace }
+      presenter = Chatterbox::ExceptionNotification::Presenter.new(options)
+      expected =<<EOL
+Backtrace
+----------
+/codes/file.rb:52:in `some_method'
+/codes/file.rb:10:in `different_method'
+/gems/some_gem/gem_name.rb:104:in `main'
+
+EOL
+      presenter.render_body.should == expected
     end
   end
   
@@ -64,7 +105,7 @@ EOL
     end
   end
   
-  describe "inspect_value" do
+  describe "render_hash" do
     it "outputs hashes in key sorted order" do
       hash = { 
         "my-key" => "something", 
@@ -74,31 +115,12 @@ EOL
       }
       presenter = Chatterbox::ExceptionNotification::Presenter.new
       expected =<<-EOL
-abcdefg: foo
-my-key: something
-nanite: something
-zephyr: something
+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"
+      presenter.render_hash(hash).should == expected
     end
   end
-  
 end

data/examples/lib/chatterbox/rails_catcher_controller_example.rb

@@ -76,7 +76,7 @@ describe WidgetsController do
       end
       
       it "ignores anything configured on the ignore list" do
-        Chatterbox.expects(:handle_notice).never
+        Chatterbox.expects(:notify).never
         begin
           @controller.rescue_action_in_public(RuntimeError.new)
         rescue RuntimeError; end
@@ -99,7 +99,7 @@ describe WidgetsController do
       end
       
       it "ignores anything configured on the ignore list" do
-        Chatterbox.expects(:handle_notice).never
+        Chatterbox.expects(:notify).never
         begin
           @controller.rescue_action_in_public(RuntimeError.new)
         rescue RuntimeError; end

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

@@ -6,17 +6,24 @@ describe Chatterbox::Services::Email::Mailer do
 
   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 = Chatterbox::Services::Email::Mailer.create_message(valid_options(:summary => "check this out"))
       email.subject.should == "check this out"
     end
     
+    it "should use :summary_prefix if provided" do
+      options = valid_options.dup
+      options[:config] = valid_options[:config].merge(:summary_prefix => "[my-app] [notifications] ")
+      email = Chatterbox::Services::Email::Mailer.create_message(options)
+      email.subject.should == "[my-app] [notifications] here is a message"
+    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 = Chatterbox::Services::Email::Mailer.create_message(valid_options.merge(: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 = Chatterbox::Services::Email::Mailer.create_message(valid_options(:body => "here is my body"))
       email.body.should == "here is my body"
     end
     
@@ -27,7 +34,6 @@ describe Chatterbox::Services::Email::Mailer do
   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

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

@@ -20,14 +20,14 @@ describe Chatterbox::Services::Email do
     end
     
     it "should preserve HashWithIndifferentAccess with explicit options" do
-      options = { :message => { :summary => "foo" }, :config => {:to => "a", :from => "a"} }.with_indifferent_access
+      options = { :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
+      options = { :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)
@@ -36,51 +36,55 @@ describe Chatterbox::Services::Email do
   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/)
+    describe ":summary requirement" do
+      it "allows top level :summary" do
+        Chatterbox::Services::Email.deliver(:summary => "summary!", :config => { :from => "foo", :to => "foo"})
+      end
+      
+      it "allows nested :message for backwards compatibility" do
+        Chatterbox::Services::Email.deliver(:message => {:summary => "summary!"}, :config => { :from => "foo", :to => "foo"})
+      end
+      
+      it "requires top level :summary" do
+        lambda {
+          Chatterbox::Services::Email.deliver(:config => { :from => "foo", :to => "foo"})
+        }.should raise_error(ArgumentError, /Must provide a :summary for your message/)
+      end
     end
     
-    it "should require :to" do
+    it "requires :to address" do
       lambda {
-        Chatterbox::Services::Email.deliver(:message => {:summary => ""}, :config => { :from => "anyone" })
+        Chatterbox::Services::Email.deliver(:summary => "", :config => { :from => "anyone" })
       }.should raise_error(ArgumentError, /Must provide :to in the :config/)
     end
   
-    it "should require from address" do
+    it "requires :from address" do
       lambda {
-        Chatterbox::Services::Email.deliver(:message => {:summary => ""}, :config => { :to => "anyone"})
+        Chatterbox::Services::Email.deliver(: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
+    it "defaults to empty hash" do
       Chatterbox::Services::Email.default_configuration.should == {}
     end
     
-    it "should set a hash of default configuration into :config hash" do
+    it "sets default configuration into :config" 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
+    it "uses default configuration if no per-message configuration provided" do
       Chatterbox::Services::Email.configure :to => "to@example.com", :from => "from@example.com"
-      mail = Chatterbox::Services::Email.deliver(:message => {:summary => "summary"})
+      mail = Chatterbox::Services::Email.deliver(:summary => "summary")
       mail.to.should == ["to@example.com"]
       mail.from.should == ["from@example.com"]
     end
     
-    it "should allow message specific configuration" do
+    it "allows per message configuration (if provided) to override default configuration" do
       Chatterbox::Services::Email.configure :to => "default-to@example.com", :from => "default-from@example.com"
-      mail = Chatterbox::Services::Email.deliver(:message => {:summary => "summary"},
+      mail = Chatterbox::Services::Email.deliver(:summary => "summary",
         :config => { :to => "joe@example.com", :from => "harry@example.com"} )
       mail.to.should == ["joe@example.com"]
       mail.from.should == ["harry@example.com"]

data/examples/lib/chatterbox_example.rb

@@ -4,19 +4,36 @@ describe Chatterbox do
 
   before { Chatterbox::Publishers.clear! }
   
-  describe "handle_notice" do
+  describe "notify" do
     it "should return notification" do
-      Chatterbox.handle_notice("message").should == "message"
+      Chatterbox.notify("message").should == "message"
     end
     
-    it "should publish the notice" do
+    it "should publish the notification" do
       Chatterbox.expects(:publish_notice).with({})
-      Chatterbox.handle_notice({})
+      Chatterbox.notify({})
     end
     
-    it "should alias to notify" do
-      Chatterbox.expects(:publish_notice).with("message")
-      Chatterbox.notify("message")
+    describe "handle_notice alias" do
+      it "is an publishes notification" do
+        Chatterbox.expects(:publish_notice).with({})
+        ActiveSupport::Deprecation.silence do
+          Chatterbox.handle_notice({})
+        end
+      end
+      
+      it "is deprecated" do
+        Chatterbox.expects(:deprecate).with("Chatterbox#handle_notice is deprecated and will be removed from Chatterbox 1.0. Call Chatterbox#notify instead.", anything)
+        Chatterbox.handle_notice("message")
+      end
+    end
+  end
+  
+  describe "deprecation" do
+    it "uses ActiveSupport's Deprecation#warn" do
+      stack = caller
+      ActiveSupport::Deprecation.expects(:warn).with("deprecation warning here", stack)
+      Chatterbox.deprecate("deprecation warning here", stack)
     end
   end
   
@@ -60,4 +77,11 @@ describe Chatterbox do
     end
   end
   
+  describe "register" do
+    it "registers publisher" do
+      pub = Chatterbox.register { "publisher" }
+      Chatterbox::Publishers.publishers.should == [pub]
+    end
+  end
+  
 end

data/features/api.feature

@@ -0,0 +1,20 @@
+Feature: Chatterbox API
+
+  As a Chatterbox user
+  I want to send messages using a simple API
+  So that I can deliver many different types of notifications using different services
+
+  Scenario: API ideas
+  Given a file named "api_testing.rb" with:
+    """
+    Chatterbox.notify(:summary => "subject", :body => "body", 
+      :via => { :service => :email, :to => "jdoe@example.com", :from => "foo.com" },
+      :via => { :service => :twitter, :to => "rsanheim" },
+      :via => { :destinations => ["my-inbox", "joes-house" }
+
+    Chatterbox.notify(:summary => "subject", :body => "body") do |via|
+      via.email :to => "jdoe@example.com", :from => "foo.com"
+      via.twitter :to => "twitter"
+    end
+    """
+    

data/features/email_service.feature

@@ -0,0 +1,46 @@
+Feature: Sending email
+
+  As a Chatterbox user
+  I want to send emails using the same options as any other service
+  So that I can deliver notifications over email
+
+  Scenario: Simple email sending
+    Given a file named "simple_email_sending.rb" with:
+      """
+      require "chatterbox"
+      require "chatterbox/services/email"
+      ActionMailer::Base.delivery_method = :test
+      
+      Chatterbox::Publishers.register do |notice|
+        Chatterbox::Services::Email.deliver(notice)
+      end
+      Chatterbox.notify :summary => "subject", :body => "body",
+        :config => { :to => "joe@example.com", :from => "sender@example.com" }
+      puts ActionMailer::Base.deliveries.last.encoded
+      """
+    When I run "simple_email_sending.rb"
+    Then the exit code should be 0
+    And the stdout should match "To: joe@example.com"
+  
+  Scenario: Sending with default configuration
+    Given a file named "default_configuration_email_send.rb" with:
+      """
+      require "chatterbox"
+      require "chatterbox/services/email"
+      ActionMailer::Base.delivery_method = :test
+
+      Chatterbox::Publishers.register do |notice|
+        Chatterbox::Services::Email.deliver(notice)
+      end
+      Chatterbox::Services::Email.configure({
+        :to => "to@example.com", :from => "from@example.com", :summary_prefix => "[CUKE] "
+      })
+      Chatterbox.notify :message => { :summary => "subject goes here!", :body => "body" }
+      puts ActionMailer::Base.deliveries.last.encoded
+      """
+    When I run "default_configuration_email_send.rb"
+    Then the exit code should be 0
+    And the stdout should match "To: to@example.com"
+    And the stdout should match "From: from@example.com"
+    And the stdout should match "Subject: [CUKE] subject goes here!"
+

data/features/services.feature

@@ -0,0 +1,30 @@
+Feature: Configurable Services
+
+  As a Chatterbox user
+  I want to be able to configure only the services I need
+  So that I can avoid unnecessary dependecies
+
+  Scenario: No services loaded
+  Given a file named "no_services_loaded.rb" with:
+    """
+    require "chatterbox"
+    require "spec"
+    require "spec/expectations"
+    Chatterbox::Services.constants.should == []
+    """
+  When I run "no_services_loaded.rb"
+  Then the exit code should be 0
+
+  Scenario: Email service only
+  Given a file named "email_service_only.rb" with:
+    """
+    require "chatterbox"
+    require "chatterbox/services/email"
+    require "spec"
+    require "spec/expectations"
+    Chatterbox::Services.constants.size.should == 1
+    Chatterbox::Services.constants.first.to_sym.should == :Email
+    """
+  When I run "email_service_only.rb"
+  Then the exit code should be 0
+

data/features/step_definitions/email_service_steps.rb

@@ -0,0 +1,31 @@
+Given %r{^a file named "([^"]+)" with:$} do |file_name, code|
+  create_file(file_name, code)
+end
+
+When /^I run "([^\"]*)"$/ do |command|
+  ruby command
+end
+
+Then /^the exit code should be (\d+)$/ do |exit_code|
+  if last_exit_code != exit_code.to_i
+    raise "Did not exit with #{exit_code}, but with #{last_exit_code}. Standard error:\n#{last_stderr}"
+  end
+end
+
+Then /^the (.*) should match (.*)$/ do |stream, string_or_regex|
+  written = case(stream)
+    when 'stdout' then last_stdout
+    when 'stderr' then last_stderr
+    else raise "Unknown stream: #{stream}"
+  end
+  written.should smart_match(string_or_regex)
+end
+
+Then /^the (.*) should not match (.*)$/ do |stream, string_or_regex|
+  written = case(stream)
+    when 'stdout' then last_stdout
+    when 'stderr' then last_stderr
+    else raise "Unknown stream: #{stream}"
+  end
+  written.should_not smart_match(string_or_regex)
+end

data/features/support/env.rb

@@ -0,0 +1,71 @@
+require 'tempfile'
+require 'pathname'
+require 'spec'
+require 'spec/expectations'
+
+class ChatterboxWorld
+  
+  def root
+    @root ||= Pathname(__FILE__).join(*%w[.. .. ..]).expand_path
+  end
+  
+  def working_dir
+    @working_dir ||= root.join(*%w[tmp cuke_generated]).expand_path
+    @working_dir.mkpath
+    @working_dir
+  end
+  
+  def chatterbox_lib
+    root.join("lib")
+  end
+  
+  def create_file(file_name, contents)
+    file_path = File.join(working_dir, file_name)
+    File.open(file_path, "w") { |f| f << contents }
+  end
+  
+  def stderr_file
+    return @stderr_file if @stderr_file
+    @stderr_file =  Tempfile.new('chatterbox_stderr')
+    @stderr_file.close
+    @stderr_file
+  end
+  
+  def last_stderr
+    @stderr
+  end
+  
+  def last_stdout
+    @stdout
+  end
+  
+  def last_exit_code
+    @exit_code
+  end
+  
+  def ruby(args)
+    Dir.chdir(working_dir) do
+      cmd = %[ruby -I#{chatterbox_lib} -rrubygems #{args} 2> #{stderr_file.path}]
+      @stdout = `#{cmd}`
+    end
+    @stderr = IO.read(stderr_file.path)
+    @exit_code = $?.to_i
+  end
+end
+
+World do
+  ChatterboxWorld.new
+end
+
+Spec::Matchers.define :smart_match do |expected|
+  match do |actual|
+    case expected
+    when /^\/.*\/?$/
+      actual =~ eval(expected)
+    when /^".*"$/
+      actual.index(eval(expected))
+    else
+      false
+    end
+  end
+end

data/lib/chatterbox.rb

@@ -1,21 +1,31 @@
 require 'active_support'
 
 module Chatterbox
-  def handle_notice(message)
+  def notify(message)
     publish_notice(message)
     message
   end
   
-  alias_method :notify, :handle_notice
-
   def publish_notice(message)
     Publishers.publishers.each { |p| p.call(message.with_indifferent_access) }
   end
   
+  def handle_notice(message)
+    warning = "Chatterbox#handle_notice is deprecated and will be removed from Chatterbox 1.0. Call Chatterbox#notify instead."
+    deprecate(warning, caller)
+    notify(message)
+  end
+  
+  def deprecate(message, callstack)
+    ActiveSupport::Deprecation.warn(message, callstack)
+  end
+  
+  # Retrieve (lazily loaded) logger; defaults to a nil Logger
   def logger
     @logger ||= Logger.new(nil)
   end
   
+  # Set default logger for Chatterbox to use; mostly for development and debugging purposes
   def logger=(logger)
     @logger = logger
   end

data/lib/chatterbox/exception_notification/extracter.rb

@@ -15,8 +15,8 @@ module Chatterbox::ExceptionNotification
     end
 
     def extract_default_info(hash)
-      { :summary       => "N/A",
-        :environment   => ENV.to_hash
+      hsh = { :summary       => "N/A",
+              :environment   => ENV.to_hash
       }.merge(hash)
     end
 

data/lib/chatterbox/exception_notification/presenter.rb

@@ -1,4 +1,5 @@
 require 'yaml'
+require 'pp'
 
 module Chatterbox::ExceptionNotification
   class Presenter
@@ -18,66 +19,65 @@ module Chatterbox::ExceptionNotification
     end
     
     def to_message
-      { :message => { :summary => summary, :body => body },
+      { :summary => summary, 
+        :body => render_body,
         :config => @config }
     end
     
-    def section_order
+    def error_details
       [:error_message, :request, :backtrace, :environment, :ruby_info, :rails_info]
     end
     
-    def body
-      body = ""
-      section_order.each do |section|
-        output = render_section(section)
-        body << output if output
-      end
-      options.keys.each do |other_sections|
-        output = render_section(other_sections)
-        body << output if output
-      end
+    def render_body
+      processed_keys = []
+      extra_sections = options.keys - error_details
+      body = render_sections(extra_sections, processed_keys)
+      body << render_sections(error_details, processed_keys)
       body
     end
     
-    def render_section(key)
+    def render_sections(keys, already_processed)
+      keys.inject(String.new) do |str, key|
+        output = render_section(key, already_processed)
+        str << output if output
+        str
+      end
+    end
+    
+    def render_section(key, processed_keys = [])
+      processed_keys << key
       return nil unless options.key?(key)
-      output = key.to_s.titleize
-      output << "\n"
+      output = "#{key.to_s.titleize}\n"
       output << "----------\n"
-      output << "#{inspect_value(options.delete(key))}\n\n"
+      output << render_obj(options[key])
+      output << "\n"
       output
     end
     
-    # Taken from exception_notification - thanks Jamis.
-    def inspect_value(value)
-      object_to_yaml(value).strip
-    end
-
-    def object_to_yaml(object)
-      result = ""
-      result << render_obj(object)
-      result
-    end
-    
     def render_obj(object)
-      if object.is_a?(Hash)
-        render_hash(object)
-      else
-        render_non_hash(object)
+      case object
+      when Hash then render_hash(object)
+      when Array then render_array(object)
+      else render_object(object)
       end
     end
-    
-    def render_non_hash(object)
-      object.to_yaml.sub(/^---\s*\n?/, "")
+
+    def render_array(object)
+      render_object(object.join("\n"))
+    end
+
+    def render_object(object)
+      "#{object}\n"
     end
     
-    # renders hashes with keys in sorted order
+    # renders hashes with keys in alpha-sorted order
     def render_hash(hsh)
       str = ""
       indiff_hsh = hsh.with_indifferent_access
       indiff_hsh.keys.sort.each do |key|
+        str << "#{key}: "
         value = indiff_hsh[key]
-        str << "#{key}: #{render_obj(value)}"
+        PP::pp(value, str)
       end
       str
     end

data/lib/chatterbox/rails_catcher.rb

@@ -19,6 +19,5 @@ module Chatterbox
       Chatterbox.logger.debug { "Chatterbox handing exception '#{exception}' off to normal rescue handling" }
       rescue_action_in_public_without_chatterbox(exception)
     end
-    
   end
 end

data/lib/chatterbox/services/campfire.rb

@@ -0,0 +1,8 @@
+require "chatterbox"
+require "chatterbox/services"
+require "tinder"
+
+module Chatterbox::Services
+  class Campfire
+  end
+end

data/lib/chatterbox/services/email.rb

@@ -21,6 +21,7 @@ module Chatterbox::Services
     def initialize(options = {})
       @options = options
       merge_configs
+      merge_message
       validate_options
     end
     
@@ -30,37 +31,36 @@ module Chatterbox::Services
     
     private
     
+    def merge_message
+      if @options[:message]
+        @options.merge!(@options[:message])
+      end
+    end
+    
     def merge_configs
       @options[:config] ||= {}
       @options[:config] = self.class.default_configuration.merge(options[:config])
     end
     
     def validate_options
-      require_message
-      require_message_keys(:summary)
+      require_summary
       
       require_config
       require_config_keys(:to, :from)
     end
     
-    def require_message
-      raise(ArgumentError, "Must configure with a :message - you provided #{options.inspect}") unless options.key?(:message)
-    end
-    
     def require_config
       raise(ArgumentError, "Must configure with a :config or set default_configuration") unless options.key?(:config)
     end
     
     def require_config_keys(*keys)
       Array(keys).each do |key|
-        raise(ArgumentError, "Must provide #{key.inspect} in the :config\nYou provided #{options.inspect}") unless options[:config].key?(key)
+        raise(ArgumentError, "Must provide #{key.inspect} in the :config - you provided:\n#{options.inspect}") unless options[:config].key?(key)
       end
     end
     
-    def require_message_keys(*keys)
-      Array(keys).each do |key|
-        raise(ArgumentError, "Must provide #{key.inspect} in the :message") unless options[:message].key?(key)
-      end
+    def require_summary
+      raise(ArgumentError, "Must provide a :summary for your message - you provided:\n#{options.inspect}") unless options.key?(:summary)
     end
   end
 end

data/lib/chatterbox/services/email/mailer.rb

@@ -19,10 +19,10 @@ module Chatterbox::Services
         bcc        data[:config][:bcc] if data[:config][:bcc]
         cc         data[:config][:cc] if data[:config][:cc]
       
-        subject    data[:message][:summary]
-        body       data[:message][:body] if data[:message][:body]
+        subject    [data[:config][:summary_prefix], data[:summary]].join
+        body       data[:body] if data[:body]
       end
-    
+      
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: chatterbox
 version: !ruby/object:Gem::Version 
-  version: 0.6.2
+  version: 0.8.1
 platform: ruby
 authors: 
 - Rob Sanheim
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-17 00:00:00 -05:00
+date: 2009-11-26 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -63,7 +63,6 @@ extra_rdoc_files:
 - README.markdown
 files: 
 - .gitignore
-- .treasure_map.rb
 - CHANGELOG.markdown
 - LICENSE
 - README.markdown
@@ -77,10 +76,16 @@ files:
 - 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/campfire_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
+- features/api.feature
+- features/email_service.feature
+- features/services.feature
+- features/step_definitions/email_service_steps.rb
+- features/support/env.rb
 - init.rb
 - lib/chatterbox.rb
 - lib/chatterbox/exception_notification.rb
@@ -89,10 +94,12 @@ files:
 - lib/chatterbox/exception_notification/rails_extracter.rb
 - lib/chatterbox/rails_catcher.rb
 - lib/chatterbox/services.rb
+- lib/chatterbox/services/campfire.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
+- tmp/.gitignore
 - todo.markdown
 - views/chatterbox/mailer/exception_notification.erb
 has_rdoc: true
@@ -131,6 +138,7 @@ test_files:
 - 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/campfire_example.rb
 - examples/lib/chatterbox/services/email/mailer_example.rb
 - examples/lib/chatterbox/services/email_example.rb
 - examples/lib/chatterbox/services_example.rb

data/.treasure_map.rb

@@ -1,22 +0,0 @@
-map_for(:chatterbox) do |map|
-  
-  map.keep_a_watchful_eye_for 'lib', 'examples', 'rails'
-
-  # map.add_mapping %r%examples/(.*)_example\.rb% do |match|
-  #   ["examples/#{match[1]}_example.rb"]
-  # end
-  # 
-  # map.add_mapping %r%examples/example_helper\.rb% do |match|
-  #   Dir["examples/**/*_example.rb"]
-  # end
-  #  
-  # map.add_mapping %r%lib/(.*)\.rb% do |match|
-  #   Dir["examples/#{match[1]}_example.rb"]
-  # end
-  
-  map.add_mapping %r%rails/(.*)\.rb% do |match|
-    ["examples/#{match[1]}_example.rb"]
-  end
-  
-  
-end