tartarus 1.0.3 → 2.0.0

data/spec/rails_app/public/javascripts/rails.js

@@ -0,0 +1,175 @@
+(function() {
+  // Technique from Juriy Zaytsev
+  // http://thinkweb2.com/projects/prototype/detecting-event-support-without-browser-sniffing/
+  function isEventSupported(eventName) {
+    var el = document.createElement('div');
+    eventName = 'on' + eventName;
+    var isSupported = (eventName in el);
+    if (!isSupported) {
+      el.setAttribute(eventName, 'return;');
+      isSupported = typeof el[eventName] == 'function';
+    }
+    el = null;
+    return isSupported;
+  }
+
+  function isForm(element) {
+    return Object.isElement(element) && element.nodeName.toUpperCase() == 'FORM'
+  }
+
+  function isInput(element) {
+    if (Object.isElement(element)) {
+      var name = element.nodeName.toUpperCase()
+      return name == 'INPUT' || name == 'SELECT' || name == 'TEXTAREA'
+    }
+    else return false
+  }
+
+  var submitBubbles = isEventSupported('submit'),
+      changeBubbles = isEventSupported('change')
+
+  if (!submitBubbles || !changeBubbles) {
+    // augment the Event.Handler class to observe custom events when needed
+    Event.Handler.prototype.initialize = Event.Handler.prototype.initialize.wrap(
+      function(init, element, eventName, selector, callback) {
+        init(element, eventName, selector, callback)
+        // is the handler being attached to an element that doesn't support this event?
+        if ( (!submitBubbles && this.eventName == 'submit' && !isForm(this.element)) ||
+             (!changeBubbles && this.eventName == 'change' && !isInput(this.element)) ) {
+          // "submit" => "emulated:submit"
+          this.eventName = 'emulated:' + this.eventName
+        }
+      }
+    )
+  }
+
+  if (!submitBubbles) {
+    // discover forms on the page by observing focus events which always bubble
+    document.on('focusin', 'form', function(focusEvent, form) {
+      // special handler for the real "submit" event (one-time operation)
+      if (!form.retrieve('emulated:submit')) {
+        form.on('submit', function(submitEvent) {
+          var emulated = form.fire('emulated:submit', submitEvent, true)
+          // if custom event received preventDefault, cancel the real one too
+          if (emulated.returnValue === false) submitEvent.preventDefault()
+        })
+        form.store('emulated:submit', true)
+      }
+    })
+  }
+
+  if (!changeBubbles) {
+    // discover form inputs on the page
+    document.on('focusin', 'input, select, texarea', function(focusEvent, input) {
+      // special handler for real "change" events
+      if (!input.retrieve('emulated:change')) {
+        input.on('change', function(changeEvent) {
+          input.fire('emulated:change', changeEvent, true)
+        })
+        input.store('emulated:change', true)
+      }
+    })
+  }
+
+  function handleRemote(element) {
+    var method, url, params;
+
+    var event = element.fire("ajax:before");
+    if (event.stopped) return false;
+
+    if (element.tagName.toLowerCase() === 'form') {
+      method = element.readAttribute('method') || 'post';
+      url    = element.readAttribute('action');
+      params = element.serialize();
+    } else {
+      method = element.readAttribute('data-method') || 'get';
+      url    = element.readAttribute('href');
+      params = {};
+    }
+
+    new Ajax.Request(url, {
+      method: method,
+      parameters: params,
+      evalScripts: true,
+
+      onComplete:    function(request) { element.fire("ajax:complete", request); },
+      onSuccess:     function(request) { element.fire("ajax:success",  request); },
+      onFailure:     function(request) { element.fire("ajax:failure",  request); }
+    });
+
+    element.fire("ajax:after");
+  }
+
+  function handleMethod(element) {
+    var method = element.readAttribute('data-method'),
+        url = element.readAttribute('href'),
+        csrf_param = $$('meta[name=csrf-param]')[0],
+        csrf_token = $$('meta[name=csrf-token]')[0];
+
+    var form = new Element('form', { method: "POST", action: url, style: "display: none;" });
+    element.parentNode.insert(form);
+
+    if (method !== 'post') {
+      var field = new Element('input', { type: 'hidden', name: '_method', value: method });
+      form.insert(field);
+    }
+
+    if (csrf_param) {
+      var param = csrf_param.readAttribute('content'),
+          token = csrf_token.readAttribute('content'),
+          field = new Element('input', { type: 'hidden', name: param, value: token });
+      form.insert(field);
+    }
+
+    form.submit();
+  }
+
+
+  document.on("click", "*[data-confirm]", function(event, element) {
+    var message = element.readAttribute('data-confirm');
+    if (!confirm(message)) event.stop();
+  });
+
+  document.on("click", "a[data-remote]", function(event, element) {
+    if (event.stopped) return;
+    handleRemote(element);
+    event.stop();
+  });
+
+  document.on("click", "a[data-method]", function(event, element) {
+    if (event.stopped) return;
+    handleMethod(element);
+    event.stop();
+  });
+
+  document.on("submit", function(event) {
+    var element = event.findElement(),
+        message = element.readAttribute('data-confirm');
+    if (message && !confirm(message)) {
+      event.stop();
+      return false;
+    }
+
+    var inputs = element.select("input[type=submit][data-disable-with]");
+    inputs.each(function(input) {
+      input.disabled = true;
+      input.writeAttribute('data-original-value', input.value);
+      input.value = input.readAttribute('data-disable-with');
+    });
+
+    var element = event.findElement("form[data-remote]");
+    if (element) {
+      handleRemote(element);
+      event.stop();
+    }
+  });
+
+  document.on("ajax:after", "form", function(event, element) {
+    var inputs = element.select("input[type=submit][disabled=true][data-disable-with]");
+    inputs.each(function(input) {
+      input.value = input.readAttribute('data-original-value');
+      input.removeAttribute('data-original-value');
+      input.disabled = false;
+    });
+  });
+})();

data/spec/rails_app/public/javascripts/tartarus.jquery.js

@@ -0,0 +1,8 @@
+(function($) {
+  $(function() {
+    $('.togglable').each(function() {
+      var toggle_data = $(this).find('.toggle_data');
+      $(this).find('.toggle_link').click(function() { toggle_data.toggle(); })
+    });
+  });
+})(jQuery);

data/spec/rails_app/public/robots.txt

@@ -0,0 +1,5 @@
+# See http://www.robotstxt.org/wc/norobots.html for documentation on how to use the robots.txt file
+#
+# To ban all spiders from the entire site uncomment the next two lines:
+# User-Agent: *
+# Disallow: /

data/spec/rails_app/public/stylesheets/tartarus.css

@@ -0,0 +1,26 @@
+#tartarus { margin: 0px 20px }
+
+#tartarus_cap { padding-bottom: 10px; border-bottom: 1px solid #777; margin: 20px 0px; }
+#tartarus h2 { margin: 10px 0px; } 
+
+#tartarus_nav { float: right }
+.tartarus_pagination { margin-top: 20px; }
+
+#tartarus table { border-collapse: collapse; width: 100%; }
+#tartarus table tr { border-bottom: 1px solid #E0DFE0; }
+#tartarus table th, #tartarus table td { padding: 5px; }
+#tartarus table th { text-align: left; }
+
+#tartarus th#exception_location { width: 150px; }
+#tartarus th#exception_date { width: 150px; }
+#tartarus th#exception_count { text-align: center; }
+
+#tartarus pre { -webkit-border-radius: 5px; -moz-border-radius: 5px; font-size: 10px; color: #fff; background-color: #222; padding: 10px; font-family: Consolas, Monaco, 'Courier New', Courier,monospace; }
+#tartarus a, #tartarus a:visited { text-decoration: underline; #bdf; } 
+#tartarus a:hover { #09f }
+
+#tartarus #exception { clear: both; }
+#tartarus #exception_actions { float: right; }
+
+#tartarus .toggle_data { display: none }
+#tartarus #backtrace_information .toggle_data { display: block; }

data/spec/rails_app/script/rails

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

data/spec/rails_app/spec/controllers/logged_exceptions_controller_spec.rb

@@ -0,0 +1,83 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe LoggedExceptionsController do 
+  before(:each) do
+    @exception = LoggedException.new
+  end
+
+  describe "#index" do
+    it 'should set an assigns of exceptions with the collection of all exception groups' do
+      LoggedException.should_receive(:all).with(:select => '*, COUNT(*) as count', :group => 'group_id', :order => 'created_at DESC').and_return([@exception])
+
+      get :index
+      assigns[:exceptions].should == [@exception]
+    end
+  end
+
+  describe "#details" do
+    before(:each) do
+      @exception2 = LoggedException.new
+      LoggedException.stub!(:paginate).and_return([@exception, @exception2])
+    end
+
+    it 'should set an assigns of exceptions with a paginated collection' do
+      LoggedException.should_receive(:paginate).with(:all, :conditions => { :group_id => '89hasd98ashdasas98dhsda' }, 
+                                                     :order => 'created_at DESC', :page => '1', :per_page => 1).and_return([@exception, @exception2])
+
+      get :details, :id => '89hasd98ashdasas98dhsda', :page => '1'
+      assigns[:exceptions].should == [@exception, @exception2]
+    end
+
+    it 'should set an assigns of exception with the first exception from the paginated collection' do
+      get :details, :id => '89hasd98ashdasas98dhsda'
+      assigns[:exception].should == @exception
+    end
+  end
+  
+  describe "#remove_all" do
+    it 'should delete all exceptions' do
+      LoggedException.should_receive(:delete_all)
+      get :remove_all
+    end
+
+    it 'should redirect to exceptions#index' do
+      get :remove_all
+      response.should redirect_to(:action => :index)
+    end
+  end
+
+  describe "#remove_group" do
+    it 'should delete all exceptions in a specific group' do
+      LoggedException.should_receive(:delete_all).with(:group_id => '892h39fds')
+      get :remove_group, :id => '892h39fds'
+    end
+
+    it 'should redirect to exceptions#index' do
+      get :remove_group, :id => '892h39fds'
+      response.should redirect_to(:action => :index)
+    end
+  end
+
+  describe "#remove_individual" do
+    before(:each) do
+      LoggedException.stub!(:find_by_id).and_return(@exception)
+    end
+
+    it 'should remove a single exception' do
+      @exception.should_receive(:destroy)
+      get :remove_individual, :id => 1      
+    end
+
+    it 'should redirect to exceptions#index if the exception group contains no more exceptions' do
+      LoggedException.stub!(:count).and_return(0)
+      get :remove_individual, :id => 1
+      response.should redirect_to(:action => :index)
+    end
+
+    it 'should redirect to exceptions#details if the exception group contains more exceptions' do
+      LoggedException.stub!(:count).and_return(1)
+      get :remove_individual, :id => 1
+      response.should redirect_to(:action => :details)
+    end
+  end
+end

data/spec/rails_app/spec/models/logged_exception_spec.rb

@@ -0,0 +1,7 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe LoggedException do 
+  it "should include the Tartarus::Logger module" do
+    LoggedException.included_modules.include?(Tartarus::Logger)
+  end
+end

data/spec/rails_app/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+ENV["RAILS_ENV"] ||= 'test'
+require File.expand_path("../../config/environment", __FILE__)
+require 'rspec/rails'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[Rails.root.join("spec/support/**/*.rb")].each {|f| require f}
+
+RSpec.configure do |config|
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec
+
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+end

data/spec/spec_helper.rb

@@ -1,10 +1,17 @@
-ENV["RAILS_ENV"] = "test"
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+ENV["RAILS_ENV"] ||= 'test'
+require File.expand_path(File.dirname(__FILE__) + "/rails_app/config/environment", __FILE__)
+require 'rspec/rails'
 
-require File.expand_path(File.dirname(__FILE__) + "/rails/config/environment")
-require "#{File.expand_path(File.dirname(__FILE__))}/../rails/init"
-require 'spec'
-require 'spec/rails'
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[Rails.root.join("spec/support/**/*.rb")].each {|f| require f}
 
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+  config.use_transactional_fixtures = true
+end
 
 def fake_controller_request
   stub('request',
@@ -17,10 +24,10 @@ def fake_controller_request
          'rack.request.cookie_hash' => {}
        },
        :method => 'post',
-       :parameters => 'params',
+       :filtered_parameters => 'params',
        :format => 'html',
        :protocol => 'http://',
-       :request_uri => '/my/uri')     
+       :fullpath => '/my/uri')     
 end
 
 class LoggedException < ActiveRecord::Base

data/spec/tartarus/logger_spec.rb

@@ -1,14 +1,11 @@
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe Tartarus::Logger do
-  it 'should serialize the request attribute' do
-    LoggedException.serialized_attributes.include?('request').should be_true
-  end
-
   describe "#log" do
     before(:each) do
+      Tartarus.stub(:configuration).and_return({ 'test' => { :enabled => true, "logger_class"=>"LoggedException" } })
       LoggedException.stub!(:normalize_request_data).and_return({})
-      @controller = mock('controller', :controller_path => 'home', :normalize_request_data_for_tartarus => 'params', :action_name => 'index', :request => fake_controller_request)
+      @controller = { 'action_controller.instance' => mock('controller', :controller_path => 'home', :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 +22,7 @@ describe Tartarus::Logger do
     end
 
     it "should normalize the controller request data" do
-      @controller.should_receive(:normalize_request_data_for_tartarus)
+      LoggedException.should_receive(:normalize_request_data).with(@controller)
       @logged_exception = LoggedException.log(@controller, @exception)
     end
 
@@ -36,41 +33,72 @@ describe Tartarus::Logger do
   end
   
   it 'should return the group count' do 
-    e = LoggedException.create( :group_id => "hash" )
+    e = LoggedException.create( :group_id => "hash", :request => {})
     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'
+      @logged_exception = LoggedException.create(:request => {})
+      Tartarus.stub(:configuration).and_return({ 'notification_threshold' => 10, 'notification_address' => 'test@example.com', 'enabled' => true, "logger_class"=>"LoggedException" })
     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 return and not deliver notification if there is no address present' do
+      Tartarus.should_receive(:configuration).and_return({ 'enabled' => true, "logger_class"=>"LoggedException" })
+      Tartarus::Notifiers::Mail.should_receive( :deliver_notification ).never
 
-      @e.handle_notifications
+      @logged_exception.handle_notifications
     end
 
     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
+      Tartarus::Notifiers::Mail.should_receive( :deliver_notification ).with( 'test@example.com', @logged_exception )
+      @logged_exception.stub( :group_count ).and_return( 20 )
+      @logged_exception.handle_notifications
     end
     
     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
+      Tartarus::Notifiers::Mail.should_receive( :deliver_notification ).with( 'test@example.com', @logged_exception )
+      @logged_exception.stub( :group_count ).and_return( 1 )
+      @logged_exception.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
+      Tartarus::Notifiers::Mail.should_receive( :deliver_notification ).never
+      @logged_exception.stub( :group_count ).and_return( 22 )
+      @logged_exception.handle_notifications
+    end
+  end
+
+  describe 'when normalizing request data for tartarus' do
+    before(:each) do
+      @mock_env = { 'action_controller.instance' => stub('controller_instance', :request => fake_controller_request) }
+      @logged_exception = LoggedException.create(:request => {})
+      Tartarus.stub(:configuration).and_return({ 'notification_threshold' => 10, 'notification_address' => 'test@example.com', 'enabled' => true, "logger_class"=>"LoggedException" })
+    end
+
+    it 'should have the session hash' do 
+      params = LoggedException.normalize_request_data(@mock_env)
+      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 = LoggedException.normalize_request_data(@mock_env)
+      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 = LoggedException.normalize_request_data(@mock_env)
+      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 = LoggedException.normalize_request_data(@mock_env)
+      params.should be_an_instance_of(Hash)
     end
   end