chatterbox 0.8.1 → 0.8.2

data/CHANGELOG.markdown

@@ -1,5 +1,8 @@
 # Changelog
 
+### 0.8.2
+  - Fix Github Issue #2: In email service, change incoming default configuration to HashWithIndifferentAccess: fixes a bug that would result in default configuration always winning over per-message configuration.
+  
 ### 0.8.1
   - Make sure Arrays format nicely for ExceptionNotification, so backtraces are easy to read
   

data/README.markdown

@@ -94,15 +94,19 @@ And you are done!  Exceptions thrown in controllers will automatically be proces
 
 Bugs & Patches
 --------------
-Please submit to [Github Issues](http://github.com/rsanheim/chatterbox/TODO).
+Please submit to [Github Issues](http://github.com/rsanheim/chatterbox/issues).
 
-All patches must have spec coverage and a passing build, or they will be pushed back.
+All patches must have spec coverage and a passing build.
 
 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
 -------------
 
+Bugs/Issues: http://github.com/rsanheim/chatterbox/issues
+CI: http://runcoderun.com/rsanheim/chatterbox
+Docs: http://rdoc.info/projects/rsanheim/chatterbox
+
 Contributors
 ------------
 * Rob Sanheim (creator)

data/VERSION.yml

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

data/chatterbox.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{chatterbox}
-  s.version = "0.8.1"
+  s.version = "0.8.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Rob Sanheim"]
-  s.date = %q{2009-11-26}
+  s.date = %q{2009-12-02}
   s.description = %q{Send notifications and messages.  However you want.}
   s.email = %q{rsanheim@gmail.com}
   s.extra_rdoc_files = [

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

@@ -19,14 +19,14 @@ describe Chatterbox::Services::Email do
       result.should be_instance_of(TMail::Mail)
     end
     
-    it "should preserve HashWithIndifferentAccess with explicit options" do
+    it "preserves HashWithIndifferentAccess with explicit options" do
       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
+    it "preserves HashWithIndifferentAccess with default configuration" do
       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)
@@ -65,14 +65,14 @@ describe Chatterbox::Services::Email do
     end
   end
   
-  describe "default_configuration=" do
+  describe "default configuration" do
     it "defaults to empty hash" do
       Chatterbox::Services::Email.default_configuration.should == {}
     end
     
     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"}
+      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 "uses default configuration if no per-message configuration provided" do
@@ -83,11 +83,19 @@ describe Chatterbox::Services::Email do
     end
     
     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"
+      Chatterbox::Services::Email.configure "to" => "default-to@example.com", :from => "default-from@example.com"
       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"]
     end
+
+    it "allows per message configuration with string keys to override default configuration" do
+      Chatterbox::Services::Email.configure "to" => "default-to@example.com", :from => "default-from@example.com"
+      mail = Chatterbox::Services::Email.deliver(:summary => "summary",
+        :config => { "to" => "joe@example.com" })
+      mail.to.should == ["joe@example.com"]
+      mail.from.should == ["default-from@example.com"]
+    end
   end
 end

data/features/email_service.feature

@@ -22,6 +22,7 @@ Feature: Sending email
     Then the exit code should be 0
     And the stdout should match "To: joe@example.com"
   
+  @wip
   Scenario: Sending with default configuration
     Given a file named "default_configuration_email_send.rb" with:
       """
@@ -35,12 +36,13 @@ Feature: Sending email
       Chatterbox::Services::Email.configure({
         :to => "to@example.com", :from => "from@example.com", :summary_prefix => "[CUKE] "
       })
-      Chatterbox.notify :message => { :summary => "subject goes here!", :body => "body" }
+      Chatterbox.notify :summary => "subject goes here!", :body => "body",
+        :config => { :to => "override@example.com" }
       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 "To: override@example.com"
     And the stdout should match "From: from@example.com"
     And the stdout should match "Subject: [CUKE] subject goes here!"
 

data/lib/chatterbox.rb

@@ -1,6 +1,17 @@
 require 'active_support'
 
 module Chatterbox
+  # Send a notification with Chatterbox
+  # Returns the message itself
+  #
+  # <tt>message</tt> is an options hash that allows the following options:
+  # 
+  # :summary - The summary of the message - required.  If your service only supports
+  #   'short' notifications, like Twitter, this is generally what you should send.
+  # :body - The body of the message - this may not be used if the service you are using 
+  #   doesn't support 'bodies' -- for example, Twitter.
+  # :config - The configuration settings for the different services the notification should use.
+  #   See the individual services you are using for what configuration options should be used.
   def notify(message)
     publish_notice(message)
     message
@@ -10,6 +21,7 @@ module Chatterbox
     Publishers.publishers.each { |p| p.call(message.with_indifferent_access) }
   end
   
+  # Deprecated version of #notify
   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)
@@ -30,6 +42,13 @@ module Chatterbox
     @logger = logger
   end
   
+  # Register a service for sending notifications
+  #
+  # ===== Example:
+  #
+  #   Chatterbox::Publishers.register do |notice|
+  #     Chatterbox::Services::Email.deliver(notice)
+  #    end
   def register(&blk)
     Publishers.register(&blk)
   end

data/lib/chatterbox/exception_notification.rb

@@ -5,10 +5,10 @@ module Chatterbox
 
     # 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 
+    # * 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
+    # * 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])

data/lib/chatterbox/services/email.rb

@@ -4,20 +4,38 @@ require 'chatterbox/services/email/mailer'
 module Chatterbox::Services
   class Email
     attr_reader :options
-    @default_configuration = {}
-
+    # Return default configuration - defaults to empty hash
     def self.default_configuration
-      @default_configuration
+      @default_configuration ||= {}
     end
-    
+
+    # Configure Email service with default options
     def self.configure(config_options)
-      @default_configuration = config_options
+      @default_configuration = config_options.with_indifferent_access
     end
     
+    # Deliver the a notification via email
+    #
+    # ==== Options
+    #
+    # * :summary - The subject of the message - required.
+    # * :body - The body of the email - if none provided, you will just send an email with a blank body.
+    # * :config - A sub-hash of configuration options.  
+    #   Optional if you have configured a default configuration with #configure.
+    #   Config can contain any of the following options, all of which are pretty self explanatory:
+    #
+    #     :to
+    #     :from
+    #     :content_type
+    #     :reply_to
+    #     :bcc
+    #     :cc
     def self.deliver(options = {})
       new(options).deliver
     end
     
+    # Creates a new Email service with provided options.
+    # See Email::deliver for the valid options
     def initialize(options = {})
       @options = options
       merge_configs
@@ -25,6 +43,7 @@ module Chatterbox::Services
       validate_options
     end
     
+    # Deliver a notificaiton -- normally you should just use the class level method Email::deliver
     def deliver
       Mailer.deliver_message(options)
     end

data/todo.markdown

@@ -1,5 +1 @@
-# rails catcher
-  * make sure we push through request info for exceptions
-  * wire ignore exceptions in rails catcher
-  * wire up common idioms (or easy ability to) to grab current_user from request, current_url, etc
-  
+* have ExceptionNotification add top_level method to Chatterbox -- #notify_exception?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: chatterbox
 version: !ruby/object:Gem::Version 
-  version: 0.8.1
+  version: 0.8.2
 platform: ruby
 authors: 
 - Rob Sanheim
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-26 00:00:00 -05:00
+date: 2009-12-02 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency