tartarus 1.0.3 → 2.0.0

data/.gitignore

@@ -1,5 +1,6 @@
 *.sw?
 .DS_Store
+.bundle
 coverage
 rdoc
 pkg

data/.rvmrc

@@ -0,0 +1,2 @@
+rvm_install_on_use_flag=1
+rvm ruby-1.8.7-p302@tartarus

data/Gemfile

@@ -0,0 +1,10 @@
+source :gemcutter
+
+gemspec
+
+gem 'rails', '~> 3.0.0'
+gem 'rspec', '~> 2.3.0'
+gem 'rspec-rails', '~> 2.3.1'
+gem 'rcov', '~> 0.9.9'
+gem 'json', '~> 1.4.6'
+gem 'sqlite3-ruby', :require => 'sqlite3'

data/Gemfile.lock

@@ -0,0 +1,104 @@
+PATH
+  remote: .
+  specs:
+    tartarus (2.0.0)
+      json (~> 1.4.6)
+      will_paginate (~> 3.0.pre2)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.0)
+      actionpack (= 3.0.0)
+      mail (~> 2.2.5)
+    actionpack (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4.1)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.12)
+      rack-test (~> 0.5.4)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activerecord (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+      arel (~> 1.0.0)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+    activesupport (3.0.0)
+    arel (1.0.1)
+      activesupport (~> 3.0.0)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    i18n (0.4.2)
+    json (1.4.6)
+    mail (2.2.13)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.6)
+      rack (>= 1.0)
+    rails (3.0.0)
+      actionmailer (= 3.0.0)
+      actionpack (= 3.0.0)
+      activerecord (= 3.0.0)
+      activeresource (= 3.0.0)
+      activesupport (= 3.0.0)
+      bundler (~> 1.0.0)
+      railties (= 3.0.0)
+    railties (3.0.0)
+      actionpack (= 3.0.0)
+      activesupport (= 3.0.0)
+      rake (>= 0.8.4)
+      thor (~> 0.14.0)
+    rake (0.8.7)
+    rcov (0.9.9)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    rspec-rails (2.3.1)
+      actionpack (~> 3.0)
+      activesupport (~> 3.0)
+      railties (~> 3.0)
+      rspec (~> 2.3.0)
+    sqlite3-ruby (1.3.2)
+    thor (0.14.6)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.23)
+    will_paginate (3.0.pre2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  json (~> 1.4.6)
+  rails (~> 3.0.0)
+  rcov (~> 0.9.9)
+  rspec (~> 2.3.0)
+  rspec-rails (~> 2.3.1)
+  sqlite3-ruby
+  tartarus!
+  will_paginate (~> 3.0.pre2)

data/README.rdoc

@@ -12,23 +12,44 @@ If you wish to use the generator to build the exception viewing/manging interfac
 dependencies are used:
 
 * will_paginate
+* json
 * jquery
 
 === Installation
 
+==== Rails 2.x
+
 1. Install the gem from:
-    gem install tartarus
+    gem install tartarus --version=1.0.3
+
 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
-4. Run the migration that was generated:
+
+==== Rails 3.x
+
+1. Add the tartarus gem to your Gemfile:
+    gem 'tartarus', '2.0.0'
+
+2. Run 'bundle install' to install the gem.
+
+3. Run the generator from the root of your Rails application:
+     rails generate tartarus
+
+
+==== Complete Setup
+1. Run the migration that was generated:
      rake db:migrate
-5. Add the javascript and stylesheet includes in your layout:
+
+2. Add "config.middleware.use 'Tartarus::Rack' to the enviroments that you'd like logging in.
+
+3. Add the javascript and stylesheet includes in your layout:
      <script type="text/javascript" src="/javascripts/tartarus.jquery.js"></script>
      <link href="/stylesheets/tartarus.css" media="all" rel="stylesheet" type="text/css" />
 
-=== Configuration
+==== 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 
@@ -37,6 +58,11 @@ to send the notification, and is handled per-exception grouping (you will be not
 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.
 
+==== TODO
+
+  * Campfire notifications
+  * Move configuration from the YAML file into the middleware initializer.
+
 === License
 
 Copyright (c) 2009 Daniel Insley

data/Rakefile

@@ -1,38 +1,20 @@
 require 'rubygems'
 require 'rake'
+require 'bundler'
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "tartarus"
-    gem.summary = %Q{Exception Logging for Rails}
-    gem.description = %Q{Provides exception logging and a generator for creating a clean interface to manage exceptions.}
-    gem.email = "dinsley@gmail.com"
-    gem.homepage = "http://github.com/dinsley/tartarus"
-    gem.authors = ["Daniel Insley"]
-    gem.add_dependency "will_paginate"
-    gem.add_development_dependency "rails"
-    gem.add_development_dependency "rspec"
-    gem.add_development_dependency "rspec-rails"
-    # Gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
-end
+Bundler::GemHelper.install_tasks
 
-require 'spec/rake/spectask'
+require "rspec/core/rake_task"
 
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.spec_opts = ['--options', "spec/spec.opts"]
-  spec.libs << 'lib' << 'spec'
-  spec.spec_files = FileList['spec/**/*_spec.rb']
-  spec.rcov = true
-  spec.rcov_opts = lambda do
-    IO.readlines("spec/rcov.opts").map { |l| l.chomp.split " " }.flatten
-  end
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.rspec_opts = ['--color', '--format progress']
+  spec.pattern = 'spec/**/*_spec.rb'
+#  spec.rcov = true
+#  spec.rcov_opts = lambda do
+#    IO.readlines("spec/rcov.opts").map { |l| l.chomp.split " " }.flatten
+#  end
 end
 
-task :spec => :check_dependencies
 task :default => :spec
 
 require 'rake/rdoctask'

data/{generators → lib/generators}/tartarus/USAGE

@@ -5,10 +5,11 @@ Usage:
     If you do not pass any arguments, the model class will default to "LoggedException".
 
 Examples:
-    script/generate tartarus
+    rails generate tartarus
 
         Creates default logged exception model, controller, and views.
 
-    script/generate tartarus MyException
+    rails generate tartarus MyException
+
+        Creates a custom model, controller, and views.
 
-        Creates a custom model, controller, and views.

data/lib/generators/tartarus/tartarus_generator.rb

@@ -0,0 +1,36 @@
+class TartarusGenerator < Rails::Generators::NamedBase
+  include Rails::Generators::Migration
+
+  source_root File.expand_path('../templates', __FILE__)  
+  argument :name, :type => 'string', :default => 'LoggedException'
+
+  def generate_tartarus 
+    template 'config/exceptions.yml', 'config/exceptions.yml'
+    template 'app/models/logged_exception.rb', "app/models/#{file_name}.rb"
+    template 'spec/models/logged_exception_spec.rb', "spec/models/#{file_name}_spec.rb"
+   
+    template 'app/controllers/exceptions_controller.rb', "app/controllers/#{plural_name}_controller.rb"
+    template 'spec/controllers/exceptions_controller_spec.rb', "spec/controllers/#{plural_name}_controller_spec.rb"
+
+    copy_file 'app/views/exceptions/index.html.erb', "app/views/#{plural_name}/index.html.erb"
+    copy_file 'app/views/exceptions/details.html.erb', "app/views/#{plural_name}/details.html.erb"
+    copy_file 'app/views/exceptions/_exception.html.erb', "app/views/#{plural_name}/_exception.html.erb"
+    
+    copy_file 'public/javascripts/tartarus.jquery.js', 'public/javascripts/tartarus.jquery.js'
+    copy_file 'public/stylesheets/tartarus.css', 'public/stylesheets/tartarus.css'
+
+    migration_template "db/migrate/add_logged_exceptions.rb", "db/migrate/add_#{singular_name}_table"
+  end
+
+  def after_generate
+    puts "\nIn order for exceptional to function properly, you'll need to complete the following steps to complete the installation process: \n\n"
+    puts "  1) Run 'rake db:migrate' to generate the logging table for your model.\n"
+    puts "  2) Add \"config.middleware.use 'Tartarus::Rack'\" to the enviroments that you'd like logging."
+    puts "  3) Add '/javascripts/tartarus.jquery.js', and 'stylesheets/tartarus.css' to your applications layout.\n"
+  end
+
+  def self.next_migration_number(path)
+    Time.now.utc.strftime("%Y%m%d%H%M%S")
+  end
+
+end

data/{generators → lib/generators}/tartarus/templates/spec/controllers/exceptions_controller_spec.rb

@@ -24,7 +24,7 @@ describe ExceptionsController do
       <%= class_name %>.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
+      get :details, :id => '89hasd98ashdasas98dhsda', :page => '1'
       assigns[:exceptions].should == [@exception, @exception2]
     end
 

data/lib/tartarus.rb

@@ -2,9 +2,11 @@ require 'yaml'
 require 'will_paginate'
 
 class Tartarus
+  module Notifiers; end
+
   class << self
     def configuration
-      @cached_config ||= YAML.load_file("#{Rails.root}/config/exceptions.yml")[Rails.env]
+      @cached_configuration ||= YAML.load_file("#{Rails.root}/config/exceptions.yml")[Rails.env]
     end
 
     def logger_class
@@ -21,6 +23,8 @@ class Tartarus
   end
 end
 
+require 'tartarus/rack'
 require 'tartarus/logger'
-require 'tartarus/rescue'
-require 'tartarus/notifier'
+require 'tartarus/notifiers/mail'
+require 'tartarus/railtie'
+

data/lib/tartarus/logger.rb

@@ -1,35 +1,71 @@
 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
+    base.send :include, InstanceMethods
+    base.send :before_save, :json_serialize  
+    base.send :after_save, :json_deserialize
+    base.send :after_find, :json_deserialize
+  end
+
+  module InstanceMethods
+    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::Notifiers::Mail.deliver_notification( notification_address, self ) if group_count == 1 or (group_count%Tartarus.configuration['notification_threshold']).zero?
+    end
+
+    def json_serialize    
+      self.request = self.request.to_json
+    end
+
+    def json_deserialize    
+      self.request = JSON.parse(request)
+    end
+
   end
 
   module ClassMethods
-    def log(controller, exception)
+    def log(env, exception)
       logged = create do |logged_exception|
+        controller = env['action_controller.instance']
         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 = controller.normalize_request_data_for_tartarus
+        logged_exception.request = self.normalize_request_data(env)
         logged_exception.group_id = Digest::SHA1.hexdigest(group_id)
       end
       logged.handle_notifications
       logged
     end
 
+    def normalize_request_data(env)
+      request = env['action_controller.instance'].request
+ 
+      request_details = {
+        :enviroment => { :process => $$, :server => `hostname -s`.chomp },
+        :session => { :variables => request.env['rack.session'].to_hash, :cookie => request.env['rack.request.cookie_hash'] },
+        :http_details => { 
+          :method => request.method.to_s.upcase,
+          :url => "#{request.protocol}#{request.env["HTTP_HOST"]}#{request.fullpath}",
+          :format => request.format.to_s,
+          :parameters => request.filtered_parameters
+        }
+      }
+
+      request.env.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/notifiers/mail.rb

@@ -0,0 +1,25 @@
+class Tartarus::Notifiers::Mail < ActionMailer::Base
+  
+  def notification(address, exception)
+    subject = "Exception raised at #{exception.controller_path}##{exception.action_name} (#{exception.exception_class}) #{exception.message}" 
+    mail(:to => address, :from => Tartarus.configuration['sender'], :subject => subject) do |format|
+      format.text do 
+        render :text => %{
+          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}
+
+          Request: 
+          #{exception.request}
+        }
+      end
+    end
+  end
+
+end