chatterbox 0.4.0 → 0.5.0

data/lib/chatterbox/{notification.rb → exception_notification/extracter.rb}

@@ -1,19 +1,21 @@
-module Chatterbox
-  
-  class Notification
-    
+module Chatterbox::ExceptionNotification
+  class Extracter
     attr_reader :message
-    
-    def initialize(message = nil)
+
+    def self.wrap(notification = {})
+      new(notification).notice
+    end
+
+    def initialize(message = {})
       @message = message
     end
-    
+
     def notice
       hash = normalize_message_to_hash(message)
       hash = exception_to_notice(hash)
       default_info.merge(hash)
     end
-    
+
     def normalize_message_to_hash(message)
       case
       when Exception === message
@@ -24,23 +26,20 @@ module Chatterbox
         string_to_notice(message.to_s)
       end
     end
-    
+
     def default_info
       default_info     = {
         :summary       => "N/A",
-        :environment   => env,
-        :ruby_version  => ruby_version,
-        :ruby_platform => ruby_platform
+        :environment   => env
       }
       default_info = add_ruby_info(default_info)
-      default_info = add_rails_info(default_info) if rails_configuration
       default_info
     end
-    
+
     def string_to_notice(message)
       { :summary => message }
     end
-    
+
     def exception_to_notice(hash)
       return hash unless hash.key?(:exception)
       exception = hash[:exception]
@@ -51,37 +50,26 @@ module Chatterbox
         :backtrace     => exception.backtrace,
       }.merge(hash)
     end
-    
-    def add_rails_info(data)
-      data.merge({
-        :rails_env => rails_configuration.env,
-        :rails_root => rails_configuration.root,
-        :rails_version => rails_configuration.version
-      })
-    end
-    
+
     def add_ruby_info(data)
-      data.merge({
-        :ruby_version  => ruby_version,
-        :ruby_platform => ruby_platform
+      data.merge({ 
+        :ruby_info => {
+          :ruby_version  => ruby_version,
+          :ruby_platform => ruby_platform
+        }
       })
     end
 
     def ruby_version
       RUBY_VERSION
     end
-    
+
     def ruby_platform
       RUBY_PLATFORM
     end
-    
+
     def env
       ENV.to_hash
     end
-    
-    def rails_configuration
-      defined?(Rails) && Rails
-    end
-    
   end
-end
+end

data/lib/chatterbox/exception_notification/presenter.rb

@@ -0,0 +1,81 @@
+require 'yaml'
+
+module Chatterbox::ExceptionNotification
+  class Presenter
+    attr_reader :options
+    
+    def self.render(options)
+      new(options).to_message
+    end
+    
+    def initialize(options = {})
+      @options = options
+      @config = options[:config]
+    end
+    
+    def summary
+      options.delete(:summary)
+    end
+    
+    def to_message
+      { :message => { :summary => summary, :body => body },
+        :config => @config }
+    end
+    
+    def section_order
+      [: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
+      body
+    end
+    
+    def render_section(key)
+      return nil unless options.key?(key)
+      output = key.to_s.titleize
+      output << "\n"
+      output << "----------\n"
+      output << "#{inspect_value(options[key])}\n\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)
+      end
+    end
+    
+    def render_non_hash(object)
+      object.to_yaml.sub(/^---\s*\n?/, "")
+    end
+    
+    # renders hashes with keys in sorted order
+    def render_hash(hsh)
+      str = ""
+      indiff_hsh = hsh.with_indifferent_access
+      indiff_hsh.keys.sort.each do |key|
+        value = indiff_hsh[key]
+        str << "#{key}: #{render_obj(value)}"
+      end
+      str
+    end
+  end
+end

data/lib/chatterbox/exception_notification/rails_extracter.rb

@@ -0,0 +1,51 @@
+module Chatterbox::ExceptionNotification
+  class RailsExtracter
+    def self.wrap(notification = {})
+      new(notification).notice
+    end
+
+    def initialize(message = {})
+      @message = message
+    end
+
+    def notice
+      hsh = extract_rails_info(@message)
+      hsh = extract_request_info(hsh)
+      hsh
+    end
+
+    def rails_configuration
+      Object.const_get("Rails") if Object.const_defined?("Rails")
+    end
+
+    def extract_rails_info(message)
+      return message if rails_configuration.nil?
+      message.merge({
+        :rails_info => {
+          :rails_env => rails_configuration.env,
+          :rails_root => rails_configuration.root,
+          :rails_version => rails_configuration.version
+        }
+      })
+    end
+    
+    def extract_request_info(message)
+      return message unless message.key?(:request)
+      request = message.delete(:request)
+      message.merge({
+        :request => {
+          :url => request.url,
+          :remote_ip => request.remote_ip,
+          :parameters => request.parameters
+        }
+      })
+    end
+  end
+end
+
+
+# 
+# * URL       : <%= @request.protocol %><%= @host %><%= @request.request_uri %>
+# * IP address: <%= @request.env["HTTP_X_FORWARDED_FOR"] || @request.env["REMOTE_ADDR"] %>
+# * Parameters: <%= filter_sensitive_post_data_parameters(@request.parameters).inspect %>
+# * Rails root: <%= @rails_root %>

data/lib/chatterbox/exception_notification.rb

@@ -0,0 +1,8 @@
+module Chatterbox
+  module ExceptionNotification
+  end
+end
+
+require 'chatterbox/exception_notification/extracter'
+require 'chatterbox/exception_notification/rails_extracter'
+require 'chatterbox/exception_notification/presenter'

data/lib/chatterbox/rails_catcher.rb

@@ -6,6 +6,7 @@ module Chatterbox
       if base.instance_methods.map(&:to_s).include? 'rescue_action_in_public' and !base.instance_methods.map(&:to_s).include? 'rescue_action_in_public_without_chatterbox'
         base.send(:alias_method, :rescue_action_in_public_without_chatterbox, :rescue_action_in_public)
         base.send(:alias_method, :rescue_action_in_public, :rescue_action_in_public_with_chatterbox)
+        base.hide_action(:rescue_action_in_public_with_chatterbox, :rescue_action_in_public_without_chatterbox)
       end
     end
     
@@ -13,12 +14,21 @@ module Chatterbox
     # any custom processing that is defined with Rails 2's exception helpers.
     def rescue_action_in_public_with_chatterbox exception
       Chatterbox.logger.debug { "#{self.class}#rescue_action_in_public_with_chatterbox: caught exception #{exception} - about to handle"}
-      Chatterbox.handle_notice(exception)
+      options = extract_exception_details(exception)
+      Chatterbox.handle_notice(options)
       Chatterbox.logger.debug { "#{self.class}#rescue_action_in_public_with_chatterbox: handing exception #{exception} off to normal rescue handling"}
       
       rescue_action_in_public_without_chatterbox(exception)
     end
     
+    def extract_exception_details(exception)
+      options = { :exception => exception, :request => request }
+      options = Chatterbox::ExceptionNotification::Extracter.wrap(options)
+      options = Chatterbox::ExceptionNotification::RailsExtracter.wrap(options)
+      options = Chatterbox::ExceptionNotification::Presenter.render(options)
+      options
+    end
+    
   end
   
 end

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

@@ -0,0 +1,28 @@
+require 'action_mailer'
+
+module Chatterbox::Services
+  class Email
+    class Mailer < ActionMailer::Base
+      self.template_root = File.join(File.dirname(__FILE__), *%w[views])
+
+      def self.reloadable?() false end
+
+      def message(data={})
+        data = data.dup.symbolize_keys
+    
+        content_type data[:config][:content_type] || "text/plain" 
+
+        recipients data[:config][:to]
+        from       data[:config][:from]
+
+        reply_to   data[:config][:reply_to] if data[:config][:reply_to]
+        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]
+      end
+    
+    end
+  end
+end

data/lib/chatterbox/services/email.rb

@@ -0,0 +1,66 @@
+require 'chatterbox'
+require 'chatterbox/services/email/mailer'
+
+module Chatterbox::Services
+  class Email
+    attr_reader :options
+    @default_configuration = {}
+
+    def self.default_configuration
+      @default_configuration
+    end
+    
+    def self.configure(config_options)
+      @default_configuration = config_options
+    end
+    
+    def self.deliver(options = {})
+      new(options).deliver
+    end
+    
+    def initialize(options = {})
+      @options = options
+      merge_configs
+      validate_options
+    end
+    
+    def deliver
+      Mailer.deliver_message(options)
+    end
+    
+    private
+    
+    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_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)
+      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
+    end
+  end
+end

data/lib/chatterbox/services.rb

@@ -0,0 +1,4 @@
+module Chatterbox
+  module Services
+  end
+end

data/lib/chatterbox.rb

@@ -1,51 +1,48 @@
-require File.join(File.dirname(__FILE__), *%w[chatterbox notification])
-require File.join(File.dirname(__FILE__), *%w[consumers])
+require 'active_support'
 
 module Chatterbox
-
   def handle_notice(message)
     publish_notice(message)
+    message
   end
+  
+  alias_method :notify, :handle_notice
 
   def publish_notice(message)
-    Publishers.publishers.each { |p| p.call(message) }
+    Publishers.publishers.each { |p| p.call(message.with_indifferent_access) }
   end
   
   def logger
-    @logger ||= rails_default_logger || Logger.new(STDOUT)
+    @logger ||= Logger.new(nil)
   end
   
   def logger=(logger)
     @logger = logger
   end
   
-  def rails_default_logger
-    defined?(RAILS_DEFAULT_LOGGER) ? RAILS_DEFAULT_LOGGER : nil
+  def register(&blk)
+    Publishers.register(&blk)
   end
   
   extend self
   
   module Publishers
-
-    class << self
-
-      def publishers
-        @publishers ||= []
-      end
-      
-      def register(&blk)
-        Chatterbox.logger.debug { "Registering publisher: #{blk}"}
-        publishers << blk
-        blk
-      end
+    def publishers
+      @publishers ||= []
+    end
       
-      def clear!
-        @publishers = []
-      end
-
+    def register(&blk)
+      Chatterbox.logger.debug { "Registering publisher: #{blk}"}
+      publishers << blk
+      blk
     end
     
+    def clear!
+      @publishers = []
+    end
+
+    extend self
   end
-  
 end
 
+require "chatterbox/services"

data/todo.markdown

@@ -1,5 +1,3 @@
-* shouldn't require _action_mailer_ unless really needed by the mailer
-
 # rails catcher
   * make sure we push through request info for exceptions
   * wire ignore exceptions in rails catcher

data/version.yml

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: chatterbox
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Rob Sanheim
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-09 00:00:00 -06:00
+date: 2009-11-06 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -52,7 +52,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
-description: "[\"Send\", \"messages.\", \"However\", \"you\", \"want.\"]"
+description: Send notifications and messages.  However you want.
 email: rsanheim@gmail.com
 executables: []
 
@@ -64,21 +64,31 @@ extra_rdoc_files:
 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
@@ -112,8 +122,12 @@ signing_key:
 specification_version: 3
 summary: Notifications and messages
 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/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

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

@@ -1,65 +0,0 @@
-require File.expand_path(File.join(File.dirname(__FILE__), *%w[.. .. .. example_helper]))
-require 'chatterbox'
-
-describe Chatterbox::Mailer do
-  
-  it "displays environment vars sorted" do
-    notice = {
-      :environment => {
-        "PATH" => "/usr/bin",
-        "PS1" => "$",
-        "TMPDIR" => "/tmp"
-      }
-    }
-    expected = <<EOL
-PATH => /usr/bin
-PS1 => $
-TMPDIR => /tmp
-EOL
-    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 => { "foo" => "path" }
-      }
-    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
-    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
-      mail = Chatterbox::Mailer.create_exception_notification(:environment => {}, :summary => 'foo')
-      mail.subject.should include('foo')
-    end
-
-    it "extracts the subject from the given data hash when the key is a string" do
-      mail = Chatterbox::Mailer.create_exception_notification(:environment => {}, 'summary' => 'foo')
-      mail.subject.should include('foo')
-    end
-    
-    it "includes the given prefix" do
-      Chatterbox::Mailer.email_prefix = '[super important email]'
-      mail = Chatterbox::Mailer.create_exception_notification(:environment => {})
-      mail.subject.should match(/\[super important email\]/)
-    end
-    
-  end
-
-end