relevance-chatterbox 0.3.0 → 0.3.1

data/chatterbox.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{chatterbox}
-  s.version = "0.3.0"
+  s.version = "0.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Rob Sanheim"]

data/examples/lib/chatterbox/consumers/email_consumer_example.rb

@@ -4,7 +4,7 @@ require 'chatterbox'
 describe Chatterbox::Mailer do
   
   it "displays environment vars sorted" do
-    data = {
+    notice = {
       :environment => {
         "PATH" => "/usr/bin",
         "PS1" => "$",
@@ -16,16 +16,33 @@ PATH => /usr/bin
 PS1 => $
 TMPDIR => /tmp
 EOL
-    mail = Chatterbox::Mailer.create_exception_notification(data)
+    mail = Chatterbox::Mailer.create_exception_notification(notice)
     mail.body.should include(expected.strip)
   end
 
+  it "displays any other details in the hash in the email body" do
+    notice = { 
+      :details => {
+        :message_id => 'user01-create', :current_user => "Chris Liebing"}, 
+        :environment => { :path => "foo" }
+        }
+    Chatterbox::Mailer.create_exception_notification(notice)
+    expected = <<EOL
+Details
+-------
+current_user => Chris Liebing
+message_id => user01-create
+EOL
+    mail = Chatterbox::Mailer.create_exception_notification(notice)
+    mail.body.should include(expected.strip)
+  end
+  
   it "does not mutate the provided hash" do
-    input = {'foo' => 'bar', :environment => {}}
-    Chatterbox::Mailer.create_exception_notification(input)
-    input.should == {'foo' => 'bar', :environment => {}}
+    notice = {'foo' => 'bar', :environment => {}}
+    Chatterbox::Mailer.create_exception_notification(notice)
+    notice.should == {'foo' => 'bar', :environment => {}}
   end
-
+  
   describe "subject" do
     
     it "extracts the subject from the given data hash when the key is a symbol" do

data/lib/consumers/email_consumer.rb

@@ -14,6 +14,13 @@ module Chatterbox
   
   end
   
+  # Things taken out of the hash for exception emails:
+  #
+  # :details => a hash of details about the context of the error -- ie current state, request info, etc...any info
+  #   related to the exception that is domain specific
+  # :error_class => taken from the Exception
+  # :error_message => taken from the Exception
+  # :backtrace => taken from the Exception
   class Mailer < ActionMailer::Base
     @@sender_address = %("Exception Notifier" <exception.notifier@default.com>)
     cattr_accessor :sender_address
@@ -29,11 +36,11 @@ module Chatterbox
     def self.reloadable?() false end
 
     def exception_notification(data={})
-      data = data.symbolize_keys
+      data = data.dup.symbolize_keys
       
       content_type "text/plain"
 
-      subject    "#{email_prefix} Error - #{data[:summary]}"
+      subject    "#{email_prefix} Error - #{data.delete(:summary)}"
 
       recipients exception_recipients
       from       sender_address

data/version.yml

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

data/views/chatterbox/mailer/exception_notification.erb

@@ -2,12 +2,18 @@ Error Message
 --------------
 <%= @error_class %>: <%= @error_message %>
 
+Details
+-------
+<% @details.keys.map(&:to_s).sort.each do |key| -%>
+<%= %[#{key} => #{@details[key.to_sym]}] %>
+<% end if @details -%>
+
 Backtrace
 ----------
 <%= @backtrace.join "\n" if @backtrace %>
 
 Environment
 ------------
-<% @environment.keys.sort.each do |key| %>
-<%= %[#{key} => #{@environment[key]}] -%>
+<% @environment.keys.sort.each do |key| -%>
+<%= %[#{key} => #{@environment[key]}] %>
 <% end -%>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: relevance-chatterbox
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors: 
 - Rob Sanheim
@@ -46,6 +46,7 @@ files:
 - views/chatterbox/mailer/exception_notification.erb
 has_rdoc: false
 homepage: http://github.com/relevance/chatterbox
+licenses: 
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -66,7 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: TODO