tartarus 1.0.1 → 1.0.3

data/README.rdoc

@@ -17,8 +17,8 @@ dependencies are used:
 === Installation
 
 1. Install the gem from:
-     [sudo] gem install tartarus --source=http://gemcutter.org
-2. Add the exceptional gem dependency to your enviroment.rb:
+    gem install tartarus
+2. Add the tartarus gem dependency to your enviroment.rb:
      config.gem "tartarus"
 3. Run the generator from the root of your Rails application:
      script/generate tartarus
@@ -28,6 +28,15 @@ dependencies are used:
      <script type="text/javascript" src="/javascripts/tartarus.jquery.js"></script>
      <link href="/stylesheets/tartarus.css" media="all" rel="stylesheet" type="text/css" />
 
+=== Configuration
+
+Configuration is handled by config/exceptions.yml, which will be generated for you. You typically
+will not need to change anything in here, however you can use this to set an email address to 
+have exception notifications delivered to, and a threshold. The threshold indicates how frequently 
+to send the notification, and is handled per-exception grouping (you will be notified every time the 
+threshold is reached, so with the default of 10 you will be notified at 10,20,30,etc.). In addition,
+when an email is set, a notification will always be sent everytime a new type of exception is raised.
+
 === License
 
 Copyright (c) 2009 Daniel Insley

data/VERSION

@@ -1 +1 @@
-1.0.1
+1.0.3

data/generators/tartarus/templates/app/views/exceptions/_exception.html.erb

@@ -2,7 +2,7 @@
   <td>
     <strong><%= link_to "#{exception.exception_class}", :action => 'details', :id => exception.group_id %></strong>
     <br />
-    <span><%= truncate(exception.message, :length => 115) %></span>
+    <span><%= truncate(h(exception.message), :length => 115) %></span>
   </td>
 
   <td>

data/generators/tartarus/templates/config/exceptions.yml

@@ -1,9 +1,18 @@
 development:
   logging_enabled: true
   logger_class: <%= class_name %> 
+  notification_address: 
+  notification_sender: noreply@example.com 
+  notification_threshold: 10
 test:
   logging_enabled: false
   logger_class: <%= class_name %> 
+  notification_address: 
+  notification_sender: noreply@example.com 
+  notification_threshold: 10
 production:
   logging_enabled: true
-  logger_class: <%= class_name %> 
+  logger_class: <%= class_name %>
+  notification_address: 
+  notification_sender: noreply@example.com 
+  notification_threshold: 10

data/generators/tartarus/templates/db/migrate/add_logged_exceptions.rb

@@ -10,6 +10,7 @@ class Add<%= class_name %>Table < ActiveRecord::Migration
       t.text     :request
       t.datetime :created_at
     end
+    add_index :<%= plural_name %>, :group_id
   end
 
   def self.down

data/lib/tartarus/logger.rb

@@ -1,4 +1,14 @@
 module Tartarus::Logger
+  def group_count
+    self.class.count( :conditions => ["group_id = ?", group_id] )
+  end
+ 
+  def handle_notifications
+    notification_address =  Tartarus.configuration['notification_address']
+    return unless notification_address.present? 
+    Tartarus::Notifier.deliver_notification( notification_address, self ) if group_count == 1 or (group_count%Tartarus.configuration['notification_threshold']).zero?
+  end
+
   def self.included(base)
     base.extend ClassMethods
     base.serialize :request
@@ -6,38 +16,20 @@ module Tartarus::Logger
 
   module ClassMethods
     def log(controller, exception)
-      create do |logged_exception|
-        group_id = "#{exception.class.name}#{exception.message}#{controller.controller_path}#{controller.action_name}" 
+      logged = create do |logged_exception|
+        group_id = "#{exception.class.name}#{exception.message.gsub(/(#<.+):(.+)(>)/,'\1\3')}#{controller.controller_path}#{controller.action_name}" 
     
         logged_exception.exception_class = exception.class.name
         logged_exception.controller_path = controller.controller_path
         logged_exception.action_name = controller.action_name
         logged_exception.message = exception.message
         logged_exception.backtrace = exception.backtrace * "\n"
-        logged_exception.request = normalize_request_data(controller.request)
+        logged_exception.request = controller.normalize_request_data_for_tartarus
         logged_exception.group_id = Digest::SHA1.hexdigest(group_id)
       end
+      logged.handle_notifications
+      logged
     end
 
-    def normalize_request_data(request)
-      enviroment = request.env.dup
-
-      request_details = {
-        :enviroment => { :process => $$, :server => `hostname -s`.chomp },
-        :session => { :variables => enviroment['rack.session'].to_hash, :cookie => enviroment['rack.request.cookie_hash'] },
-        :http_details => { 
-          :method => request.method.to_s.upcase,
-          :url => "#{request.protocol}#{request.env["HTTP_HOST"]}#{request.request_uri}",
-          :format => request.format.to_s,
-          :parameters => request.parameters
-        }
-      }
-
-      enviroment.each_pair do |key, value|
-        request_details[:enviroment][key.downcase] = value if key.match(/^[A-Z_]*$/)
-      end
-
-      return request_details
-    end
   end
 end

data/lib/tartarus/notifier.rb

@@ -0,0 +1,11 @@
+class Tartarus::Notifier < ActionMailer::Base
+  self.mailer_name = 'tartarus_notifier'
+  self.view_paths << "#{File.dirname(__FILE__)}/../../views"
+  
+  def notification( to, exception )
+    @recipients = to
+    @from = Tartarus.configuration['sender']
+    @subject    = "Exception raised at #{exception.controller_path}##{exception.action_name} (#{exception.exception_class}) #{exception.message}" 
+    @body[:exception] = exception
+  end
+end

data/lib/tartarus/rescue.rb

@@ -14,4 +14,26 @@ module Tartarus::Rescue
 
     rescue_action_without_tartarus(exception)
   end
+    
+  def normalize_request_data_for_tartarus
+    enviroment = request.env.dup
+    filtered_params = respond_to?(:filter_parameters) ? filter_parameters(request.parameters) : request.parameters.dup
+
+    request_details = {
+      :enviroment => { :process => $$, :server => `hostname -s`.chomp },
+      :session => { :variables => enviroment['rack.session'].to_hash, :cookie => enviroment['rack.request.cookie_hash'] },
+      :http_details => { 
+        :method => request.method.to_s.upcase,
+        :url => "#{request.protocol}#{request.env["HTTP_HOST"]}#{request.request_uri}",
+        :format => request.format.to_s,
+        :parameters => filtered_params
+      }
+    }
+
+    enviroment.each_pair do |key, value|
+      request_details[:enviroment][key.downcase] = value if key.match(/^[A-Z_]*$/)
+    end
+
+    return request_details
+  end
 end

data/lib/tartarus.rb

@@ -23,3 +23,4 @@ end
 
 require 'tartarus/logger'
 require 'tartarus/rescue'
+require 'tartarus/notifier'

data/spec/tartarus/logger_spec.rb

@@ -8,7 +8,7 @@ describe Tartarus::Logger do
   describe "#log" do
     before(:each) do
       LoggedException.stub!(:normalize_request_data).and_return({})
-      @controller = mock('controller', :controller_path => 'home', :action_name => 'index', :request => fake_controller_request)
+      @controller = mock('controller', :controller_path => 'home', :normalize_request_data_for_tartarus => 'params', :action_name => 'index', :request => fake_controller_request)
       @exception = StandardError.new('An error has occured!')
       @exception.stub!(:backtrace).and_return(['one', 'two', 'three'])
     end
@@ -25,7 +25,7 @@ describe Tartarus::Logger do
     end
 
     it "should normalize the controller request data" do
-      LoggedException.should_receive(:normalize_request_data).with(@controller.request)
+      @controller.should_receive(:normalize_request_data_for_tartarus)
       @logged_exception = LoggedException.log(@controller, @exception)
     end
 
@@ -34,31 +34,44 @@ describe Tartarus::Logger do
       @logged_exception.should be_an_instance_of(LoggedException)
     end
   end
-
-  describe "#normalize_request_data" do
-    before(:each) do
-       @request_data = LoggedException.normalize_request_data(fake_controller_request)
+  
+  it 'should return the group count' do 
+    e = LoggedException.create( :group_id => "hash" )
+    LoggedException.should_receive( :count ).with( :conditions => ["group_id = ?", 'hash'] ).and_return( 42 )
+    e.group_count.should == 42
+  end
+  
+  describe '#handle_notifications' do 
+    before(:each) do 
+      @e = LoggedException.create
+      Tartarus.configuration['notification_threshold'] = 10
+      Tartarus.configuration['notification_address'] = 'test@example.com'
     end
     
-    it 'should have a enviroment hash that contains a hash of only the uppercase keys of the original controller request hash' do
-      @request_data[:enviroment].should_not be_blank
-      @request_data[:enviroment].should == { "http_host" => "test_host", "loooooooong_key_two" => "key_two_value", "key_one" => "key_one_value", :server => `hostname -s`.chomp, :process => $$ }
-    end
+    it 'should return and not deliver notification if there is no address present' do 
+      Tartarus::Notifier.should_receive( :deliver_notification ).never
+      Tartarus.configuration['notification_address'] = nil
 
-    it 'should have a session hash' do
-      @request_data[:session].should_not be_blank
-      @request_data[:session].should be_an_instance_of(Hash)
-      @request_data[:session].should == { :cookie => {}, :variables => { :id=>"123123" } }
+      @e.handle_notifications
     end
 
-    it 'should have a http details hash' do
-      @request_data[:http_details].should_not be_blank
-      @request_data[:http_details].should == { :parameters => "params", :format => "html", :method => "POST", :url => "http://test_host/my/uri" }
+    it 'should send email if there is an address present and the count matches the threshold' do 
+      Tartarus::Notifier.should_receive( :deliver_notification ).with( 'test@example.com', @e )
+      @e.stub( :group_count ).and_return( 20 )
+      @e.handle_notifications
     end
-
-    it "should return a hash of request data" do
-      @request_data.should be_an_instance_of(Hash)
+    
+    it 'should send email if there is an address present and it is the first exception in a group' do 
+      Tartarus::Notifier.should_receive( :deliver_notification ).with( 'test@example.com', @e )
+      @e.stub( :group_count ).and_return( 1 )
+      @e.handle_notifications
+    end
+    
+    it 'should not send email if there is an address present and the count does not match the threshold' do 
+      Tartarus::Notifier.should_receive( :deliver_notification ).never
+      @e.stub( :group_count ).and_return( 22 )
+      @e.handle_notifications
     end
-     
   end
+
 end

data/spec/tartarus/rescue_spec.rb

@@ -15,6 +15,36 @@ describe Tartarus::Rescue do
     end
   end
 
+  describe 'when normalizing request data for tartarus' do
+    before( :each ) do 
+      @controller.stub( :request ).and_return( fake_controller_request )
+    end
+
+    it 'should have the session hash' do 
+      params = @controller.normalize_request_data_for_tartarus
+      params[:session].should_not be_blank
+      params[:session].should be_an_instance_of(Hash)
+      params[:session].should == { :cookie => {}, :variables => { :id=>"123123" } }
+    end
+ 
+    it 'should have a enviroment hash that contains a hash of only the uppercase keys of the original controller request hash' do
+      params = @controller.normalize_request_data_for_tartarus
+      params[:enviroment].should_not be_blank
+      params[:enviroment].should == { "http_host" => "test_host", "loooooooong_key_two" => "key_two_value", "key_one" => "key_one_value", :server => `hostname -s`.chomp, :process => $$ }
+    end
+  
+    it 'should have a http details hash' do
+      params = @controller.normalize_request_data_for_tartarus
+      params[:http_details].should_not be_blank
+      params[:http_details].should == { :parameters => "params", :format => "html", :method => "POST", :url => "http://test_host/my/uri" }
+    end
+
+    it "should return a hash of request data" do
+      params = @controller.normalize_request_data_for_tartarus
+      params.should be_an_instance_of(Hash)
+    end
+  end
+
   describe "#rescue_action_with_tartarus" do
     before(:each) do
       @exception = StandardError.new

data/tartarus.gemspec

@@ -1,15 +1,15 @@
 # Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{tartarus}
-  s.version = "1.0.1"
+  s.version = "1.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Daniel Insley"]
-  s.date = %q{2009-11-24}
+  s.date = %q{2010-10-27}
   s.description = %q{Provides exception logging and a generator for creating a clean interface to manage exceptions.}
   s.email = %q{dinsley@gmail.com}
   s.extra_rdoc_files = [
@@ -36,6 +36,7 @@ Gem::Specification.new do |s|
      "generators/tartarus/templates/spec/models/logged_exception_spec.rb",
      "lib/tartarus.rb",
      "lib/tartarus/logger.rb",
+     "lib/tartarus/notifier.rb",
      "lib/tartarus/rescue.rb",
      "rails/init.rb",
      "spec/rails/app/controllers/application_controller.rb",
@@ -61,7 +62,8 @@ Gem::Specification.new do |s|
      "spec/tartarus/logger_spec.rb",
      "spec/tartarus/rescue_spec.rb",
      "spec/tartarus_spec.rb",
-     "tartarus.gemspec"
+     "tartarus.gemspec",
+     "views/tartarus_notifier/notification.html.erb"
   ]
   s.homepage = %q{http://github.com/dinsley/tartarus}
   s.rdoc_options = ["--charset=UTF-8"]
@@ -110,4 +112,3 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<rspec-rails>, [">= 0"])
   end
 end
-

data/views/tartarus_notifier/notification.html.erb

@@ -0,0 +1,9 @@
+A new exception was raised (<%= @exception.created_at.strftime("%m/%d/%Y %I:%M%p") %>):
+
+Class    : <%= @exception.exception_class %>
+Location : <%= @exception.controller_path %>#<%= @exception.action_name %> 
+Message  : <%= @exception.message %>
+Count    : <%= @exception.group_count %>
+
+Backtrace: 
+<%= @exception.backtrace %>

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: tartarus
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
+  hash: 17
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 3
+  version: 1.0.3
 platform: ruby
 authors: 
 - Daniel Insley
@@ -9,49 +15,65 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-24 00:00:00 -08:00
+date: 2010-10-27 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: will_paginate
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: rails
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: rspec
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: rspec-rails
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id004
 description: Provides exception logging and a generator for creating a clean interface to manage exceptions.
 email: dinsley@gmail.com
 executables: []
@@ -81,6 +103,7 @@ files:
 - generators/tartarus/templates/spec/models/logged_exception_spec.rb
 - lib/tartarus.rb
 - lib/tartarus/logger.rb
+- lib/tartarus/notifier.rb
 - lib/tartarus/rescue.rb
 - rails/init.rb
 - spec/rails/app/controllers/application_controller.rb
@@ -107,6 +130,7 @@ files:
 - spec/tartarus/rescue_spec.rb
 - spec/tartarus_spec.rb
 - tartarus.gemspec
+- views/tartarus_notifier/notification.html.erb
 has_rdoc: true
 homepage: http://github.com/dinsley/tartarus
 licenses: []
@@ -117,21 +141,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Exception Logging for Rails