tartarus 1.0.0

data/spec/rails/config/boot.rb

@@ -0,0 +1,110 @@
+# Don't change this file!
+# Configure your app in config/environment.rb and config/environments/*.rb
+
+RAILS_ROOT = "#{File.dirname(__FILE__)}/.." unless defined?(RAILS_ROOT)
+
+module Rails
+  class << self
+    def boot!
+      unless booted?
+        preinitialize
+        pick_boot.run
+      end
+    end
+
+    def booted?
+      defined? Rails::Initializer
+    end
+
+    def pick_boot
+      (vendor_rails? ? VendorBoot : GemBoot).new
+    end
+
+    def vendor_rails?
+      File.exist?("#{RAILS_ROOT}/vendor/rails")
+    end
+
+    def preinitialize
+      load(preinitializer_path) if File.exist?(preinitializer_path)
+    end
+
+    def preinitializer_path
+      "#{RAILS_ROOT}/config/preinitializer.rb"
+    end
+  end
+
+  class Boot
+    def run
+      load_initializer
+      Rails::Initializer.run(:set_load_path)
+    end
+  end
+
+  class VendorBoot < Boot
+    def load_initializer
+      require "#{RAILS_ROOT}/vendor/rails/railties/lib/initializer"
+      Rails::Initializer.run(:install_gem_spec_stubs)
+      Rails::GemDependency.add_frozen_gem_path
+    end
+  end
+
+  class GemBoot < Boot
+    def load_initializer
+      self.class.load_rubygems
+      load_rails_gem
+      require 'initializer'
+    end
+
+    def load_rails_gem
+      if version = self.class.gem_version
+        gem 'rails', version
+      else
+        gem 'rails'
+      end
+    rescue Gem::LoadError => load_error
+      $stderr.puts %(Missing the Rails #{version} gem. Please `gem install -v=#{version} rails`, update your RAILS_GEM_VERSION setting in config/environment.rb for the Rails version you do have installed, or comment out RAILS_GEM_VERSION to use the latest version installed.)
+      exit 1
+    end
+
+    class << self
+      def rubygems_version
+        Gem::RubyGemsVersion rescue nil
+      end
+
+      def gem_version
+        if defined? RAILS_GEM_VERSION
+          RAILS_GEM_VERSION
+        elsif ENV.include?('RAILS_GEM_VERSION')
+          ENV['RAILS_GEM_VERSION']
+        else
+          parse_gem_version(read_environment_rb)
+        end
+      end
+
+      def load_rubygems
+        min_version = '1.3.2'
+        require 'rubygems'
+        unless rubygems_version >= min_version
+          $stderr.puts %Q(Rails requires RubyGems >= #{min_version} (you have #{rubygems_version}). Please `gem update --system` and try again.)
+          exit 1
+        end
+
+      rescue LoadError
+        $stderr.puts %Q(Rails requires RubyGems >= #{min_version}. Please install RubyGems and try again: http://rubygems.rubyforge.org)
+        exit 1
+      end
+
+      def parse_gem_version(text)
+        $1 if text =~ /^[^#]*RAILS_GEM_VERSION\s*=\s*["']([!~<>=]*\s*[\d.]+)["']/
+      end
+
+      private
+        def read_environment_rb
+          File.read("#{RAILS_ROOT}/config/environment.rb")
+        end
+    end
+  end
+end
+
+# All that for this:
+Rails.boot!

data/spec/rails/config/database.yml

@@ -0,0 +1,5 @@
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000

data/spec/rails/config/environment.rb

@@ -0,0 +1,41 @@
+# Be sure to restart your server when you modify this file
+
+# Specifies gem version of Rails to use when vendor/rails is not present
+RAILS_GEM_VERSION = '2.3.4' unless defined? RAILS_GEM_VERSION
+
+# Bootstrap the Rails environment, frameworks, and default configuration
+require File.join(File.dirname(__FILE__), 'boot')
+
+Rails::Initializer.run do |config|
+  # Settings in config/environments/* take precedence over those specified here.
+  # Application configuration should go into files in config/initializers
+  # -- all .rb files in that directory are automatically loaded.
+
+  # Add additional load paths for your own custom dirs
+  # config.load_paths += %W( #{RAILS_ROOT}/extras )
+
+  # Specify gems that this application depends on and have them installed with rake gems:install
+  # config.gem "bj"
+  # config.gem "hpricot", :version => '0.6', :source => "http://code.whytheluckystiff.net"
+  # config.gem "sqlite3-ruby", :lib => "sqlite3"
+  # config.gem "aws-s3", :lib => "aws/s3"
+
+  # Only load the plugins named here, in the order given (default is alphabetical).
+  # :all can be used as a placeholder for all plugins not explicitly named
+  # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+  # Skip frameworks you're not going to use. To use Rails without a database,
+  # you must remove the Active Record framework.
+  # config.frameworks -= [ :active_record, :active_resource, :action_mailer ]
+
+  # Activate observers that should always be running
+  # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+  # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+  # Run "rake -D time" for a list of tasks for finding time zone names.
+  config.time_zone = 'UTC'
+
+  # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+  # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}')]
+  # config.i18n.default_locale = :de
+end

data/spec/rails/config/environments/development.rb

@@ -0,0 +1,17 @@
+# Settings specified here will take precedence over those in config/environment.rb
+
+# In the development environment your application's code is reloaded on
+# every request.  This slows down response time but is perfect for development
+# since you don't have to restart the webserver when you make code changes.
+config.cache_classes = false
+
+# Log error messages when you accidentally call methods on nil.
+config.whiny_nils = true
+
+# Show full error reports and disable caching
+config.action_controller.consider_all_requests_local = true
+config.action_view.debug_rjs                         = true
+config.action_controller.perform_caching             = false
+
+# Don't care if the mailer can't send
+config.action_mailer.raise_delivery_errors = false

data/spec/rails/config/environments/production.rb

@@ -0,0 +1,28 @@
+# Settings specified here will take precedence over those in config/environment.rb
+
+# The production environment is meant for finished, "live" apps.
+# Code is not reloaded between requests
+config.cache_classes = true
+
+# Full error reports are disabled and caching is turned on
+config.action_controller.consider_all_requests_local = false
+config.action_controller.perform_caching             = true
+config.action_view.cache_template_loading            = true
+
+# See everything in the log (default is :info)
+# config.log_level = :debug
+
+# Use a different logger for distributed setups
+# config.logger = SyslogLogger.new
+
+# Use a different cache store in production
+# config.cache_store = :mem_cache_store
+
+# Enable serving of images, stylesheets, and javascripts from an asset server
+# config.action_controller.asset_host = "http://assets.example.com"
+
+# Disable delivery errors, bad email addresses will be ignored
+# config.action_mailer.raise_delivery_errors = false
+
+# Enable threaded mode
+# config.threadsafe!

data/spec/rails/config/environments/test.rb

@@ -0,0 +1,28 @@
+# Settings specified here will take precedence over those in config/environment.rb
+
+# The test environment is used exclusively to run your application's
+# test suite.  You never need to work with it otherwise.  Remember that
+# your test database is "scratch space" for the test suite and is wiped
+# and recreated between test runs.  Don't rely on the data there!
+config.cache_classes = true
+
+# Log error messages when you accidentally call methods on nil.
+config.whiny_nils = true
+
+# Show full error reports and disable caching
+config.action_controller.consider_all_requests_local = true
+config.action_controller.perform_caching             = false
+config.action_view.cache_template_loading            = true
+
+# Disable request forgery protection in test environment
+config.action_controller.allow_forgery_protection    = false
+
+# Tell Action Mailer not to deliver emails to the real world.
+# The :test delivery method accumulates sent emails in the
+# ActionMailer::Base.deliveries array.
+config.action_mailer.delivery_method = :test
+
+# Use SQL instead of Active Record's schema dumper when creating the test database.
+# This is necessary if your schema can't be completely dumped by the schema dumper,
+# like if you have constraints or database-specific column types
+# config.active_record.schema_format = :sql

data/spec/rails/config/exceptions.yml

@@ -0,0 +1,9 @@
+development:
+  enabled: false
+  logger_class: LoggedException 
+test:
+  enabled: false
+  logger_class: LoggedException 
+production:
+  enabled: true
+  logger_class: LoggedException 

data/spec/rails/config/initializers/backtrace_silencers.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying do debug a problem that might steem from framework code.
+# Rails.backtrace_cleaner.remove_silencers!

data/spec/rails/config/initializers/inflections.rb

@@ -0,0 +1,10 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format 
+# (all these examples are active by default):
+# ActiveSupport::Inflector.inflections do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end

data/spec/rails/config/initializers/mime_types.rb

@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf
+# Mime::Type.register_alias "text/html", :iphone

data/spec/rails/config/initializers/new_rails_defaults.rb

@@ -0,0 +1,21 @@
+# Be sure to restart your server when you modify this file.
+
+# These settings change the behavior of Rails 2 apps and will be defaults
+# for Rails 3. You can remove this initializer when Rails 3 is released.
+
+if defined?(ActiveRecord)
+  # Include Active Record class name as root for JSON serialized output.
+  ActiveRecord::Base.include_root_in_json = true
+
+  # Store the full class name (including module namespace) in STI type column.
+  ActiveRecord::Base.store_full_sti_class = true
+end
+
+ActionController::Routing.generate_best_match = false
+
+# Use ISO 8601 format for JSON serialized times and dates.
+ActiveSupport.use_standard_json_time_format = true
+
+# Don't escape HTML entities in JSON, leave that for the #json_escape helper.
+# if you're including raw json in an HTML page.
+ActiveSupport.escape_html_entities_in_json = false

data/spec/rails/config/initializers/session_store.rb

@@ -0,0 +1,15 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key for verifying cookie session data integrity.
+# If you change this key, all old sessions will become invalid!
+# Make sure the secret is at least 30 characters and all random, 
+# no regular words or you'll be exposed to dictionary attacks.
+ActionController::Base.session = {
+  :key         => '_rails_session',
+  :secret      => 'a83699a376cb974ccfa0c0b7a3739e33d99bf18898217e43161e77e091edf986bae26184b16cb2666557a6a66de441640d557aa67d5ddc7371652cabc3a7ff01'
+}
+
+# Use the database for sessions instead of the cookie-based default,
+# which shouldn't be used to store highly confidential information
+# (create the session table with "rake db:sessions:create")
+# ActionController::Base.session_store = :active_record_store

data/spec/rails/config/locales/en.yml

@@ -0,0 +1,5 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See http://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  hello: "Hello world"

data/spec/rails/config/routes.rb

@@ -0,0 +1,43 @@
+ActionController::Routing::Routes.draw do |map|
+  # The priority is based upon order of creation: first created -> highest priority.
+
+  # Sample of regular route:
+  #   map.connect 'products/:id', :controller => 'catalog', :action => 'view'
+  # Keep in mind you can assign values other than :controller and :action
+
+  # Sample of named route:
+  #   map.purchase 'products/:id/purchase', :controller => 'catalog', :action => 'purchase'
+  # This route can be invoked with purchase_url(:id => product.id)
+
+  # Sample resource route (maps HTTP verbs to controller actions automatically):
+  #   map.resources :products
+
+  # Sample resource route with options:
+  #   map.resources :products, :member => { :short => :get, :toggle => :post }, :collection => { :sold => :get }
+
+  # Sample resource route with sub-resources:
+  #   map.resources :products, :has_many => [ :comments, :sales ], :has_one => :seller
+  
+  # Sample resource route with more complex sub-resources
+  #   map.resources :products do |products|
+  #     products.resources :comments
+  #     products.resources :sales, :collection => { :recent => :get }
+  #   end
+
+  # Sample resource route within a namespace:
+  #   map.namespace :admin do |admin|
+  #     # Directs /admin/products/* to Admin::ProductsController (app/controllers/admin/products_controller.rb)
+  #     admin.resources :products
+  #   end
+
+  # You can have the root of your site routed with map.root -- just remember to delete public/index.html.
+  # map.root :controller => "welcome"
+
+  # See how all your routes lay out with "rake routes"
+
+  # Install the default routes as the lowest priority.
+  # Note: These default routes make all actions in every controller accessible via GET requests. You should
+  # consider removing or commenting them out if you're using named routes and resources.
+  map.connect ':controller/:action/:id'
+  map.connect ':controller/:action/:id.:format'
+end

data/spec/rcov.opts

@@ -0,0 +1,3 @@
+--exclude "spec/*,gems/*,/usr/*,/Library/*,/var/*" 
+--rails
+--text-report

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format progress
+--loadby mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+ENV["RAILS_ENV"] = "test"
+
+require File.expand_path(File.dirname(__FILE__) + "/rails/config/environment")
+require "#{File.expand_path(File.dirname(__FILE__))}/../rails/init"
+require 'spec'
+require 'spec/rails'
+
+
+def fake_controller_request
+  stub('request',
+       :env => {
+         'HTTP_HOST' => 'test_host',
+         'KEY_ONE' => 'key_one_value',
+         'LOOOOOOOONG_KEY_TWO' => 'key_two_value',
+         'rack.session' => { :id => '123123' },
+         'rack.session.options' => {},
+         'rack.request.cookie_hash' => {}
+       },
+       :method => 'post',
+       :parameters => 'params',
+       :format => 'html',
+       :protocol => 'http://',
+       :request_uri => '/my/uri')     
+end
+
+class LoggedException < ActiveRecord::Base
+  include Tartarus::Logger
+end

data/spec/tartarus/logger_spec.rb

@@ -0,0 +1,63 @@
+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
+      LoggedException.stub!(:normalize_request_data).and_return({})
+      @controller = 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
+
+    it "should create a group_id for grouping of exceptions that are the same" do
+      @logged_exception = LoggedException.log(@controller, @exception)
+      @logged_exception.group_id.should == 'ea61658eacfe0930ae2b318297ab51a3c0b5668c'
+    end
+
+    it "should convert the backtrace from an array to a string seperated by newlines" do
+      @logged_exception = LoggedException.log(@controller, @exception)
+      @logged_exception.backtrace.should be_an_instance_of(String)
+      @logged_exception.backtrace.should == "one\ntwo\nthree"
+    end
+
+    it "should normalize the controller request data" do
+      LoggedException.should_receive(:normalize_request_data).with(@controller.request)
+      @logged_exception = LoggedException.log(@controller, @exception)
+    end
+
+    it "should return an instance of the registered logger class" do
+      @logged_exception = LoggedException.log(@controller, @exception)
+      @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)
+    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"}
+    end
+
+    it 'should have a session hash' do
+      @request_data[:session].should_not be_blank
+      @request_data[:session].should == { :cookie => {}, :options => {}, :variables => { :id=>"123123" } }
+    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" }
+    end
+
+    it "should return a hash of request data" do
+      @request_data.should be_an_instance_of(Hash)
+    end
+     
+  end
+end

data/spec/tartarus/rescue_spec.rb

@@ -0,0 +1,43 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+class TartarusRescueTestController < ApplicationController
+end
+
+describe Tartarus::Rescue do
+  before(:each) do
+    @controller = TartarusRescueTestController.new
+  end
+
+  describe 'when mixed into another class' do
+    it 'should alias_method_chain rescue_action method with tartarus' do
+      @controller.should respond_to(:rescue_action_with_tartarus)
+      @controller.should respond_to(:rescue_action_without_tartarus)
+    end
+  end
+
+  describe "#rescue_action_with_tartarus" do
+    before(:each) do
+      @exception = StandardError.new
+      @controller.stub!(:rescue_action_without_tartarus)
+      @controller.stub!(:response_code_for_rescue).and_return(:internal_server_error)
+      Tartarus.stub!(:log)
+    end
+
+    it 'should log the exception with tartarus if the exception code should be an internal server error' do
+      Tartarus.should_receive(:log).with(@controller, @exception)
+      @controller.should_receive(:response_code_for_rescue).and_return(:internal_server_error)
+      @controller.rescue_action_with_tartarus(@exception)
+    end
+
+    it 'should not log the exception with tartarus if the exception code is not an internal server error' do
+      @controller.should_receive(:response_code_for_rescue).and_return(:not_found)
+      @controller.rescue_action_with_tartarus(@exception)
+    end
+
+    it 'should invoke rescue_action_without_tartarus' do
+      @controller.should_receive(:rescue_action_without_tartarus)
+      @controller.rescue_action_with_tartarus(@exception)
+    end
+  end
+end
+

data/spec/tartarus_spec.rb

@@ -0,0 +1,53 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Tartarus do
+  it 'should include rescue module into ActionController::Base if a rails enviroment is loaded' do
+    ActionController::Base.included_modules.include?(Tartarus::Rescue).should be_true
+  end
+
+  describe "#logger_class" do
+    it 'should return the registered loggers class from the configuration' do
+      Tartarus.should_receive(:configuration).and_return({ 'logger_class' => 'LoggedException' })
+      Tartarus.logger_class.should == LoggedException
+    end
+  end
+
+  describe "#log" do
+    before(:each) do
+      @controller = mock('controller')
+      @exception = StandardError.new
+      Tartarus.stub!(:logger_class).and_return(LoggedException)
+    end
+
+    it 'should proxy the log call to the registered logger class' do
+      LoggedException.should_receive(:log).with(@controller, @exception)
+      Tartarus.log(@controller, @exception)
+    end
+
+    it 'should return an instance of the registered logger class' do
+      LoggedException.stub!(:log).and_return(LoggedException.new)
+      Tartarus.log(@controller, @exception).should be_an_instance_of(LoggedException)
+    end
+  end
+
+  describe "#configuration" do
+    before(:each) do
+      YAML.stub!(:load_file).and_return({'development' => { 'enabled' => true }, 'test' => { 'enabled' => false } })
+    end
+
+    it 'should parse the YAML configuration file for exceptional' do
+      YAML.should_receive(:load_file).with("#{Rails.root}/config/exceptions.yml")
+      Tartarus.configuration
+    end
+    
+    it 'should return the configuration from the current rails enviroment' do
+      Tartarus.configuration.should == { 'enabled' => false }
+    end
+    
+    it 'should return a cached config if the configuration has already been loaded before' do
+      Tartarus.configuration
+      YAML.should_receive(:load_file).never
+      Tartarus.configuration.should == { 'enabled' => false }
+    end
+  end
+end