r3_exception_logger 0.1.10 → 0.1.11

data/History.txt

@@ -0,0 +1,75 @@
+== 0.1.6 (2010-08-24)
+
+=== New
+
+* Generator: exception_logger:stylescripts
+** copies the stylesheet for the exception logger to the public dir
+** copies the javascript for the exception logger to the public dir
+
+=== Changes
+
+* Generator: exception_migration renamed to exception_logger:migration
+
+=== Testing
+
+* Create Rails Test App at test/rails_root on demand
+** just store needed files and create the other by the rails generator
+* Create Tests for logged_exception (Model)
+* Create Tests for logged_exceptions_controller (Controller)
+** Added Tests for GET requests
+** Added Tests for XHR requests
+
+=== Optimization
+
+* Do not require RedCloth (fallback to simple_format if RedCloth not available)
+
+== 0.1.5 (2010-08-17)
+
+=== New
+
+* Gem: Post Installer Infos
+
+=== Changes
+
+* remove unmaintained code to send emails
+** use http://github.com/rails/exception_notification instead.
+** instructions added to the readme
+* layout file for index and show
+
+=== Migration
+
+* adapt class find methods to use new syntax
+
+== 0.1.4 (2010-08-15)
+
+=== Optimization
+
+* 'query' function now uses the new rails api (ActiveRelation and Scopes)
+
+=== Migration
+
+* 'Delete Visible' link now does what it was intended to do (again).
+
+== 0.1.3 (2010-08-14)
+
+=== Migration
+
+* pagination links now work w/ and w/o javascript (again).
+
+== 0.1.2 (2010-08-14)
+
+=== Bugfixes
+* wrong path of rake tasks file solved
+
+== 0.1.1 (2010-08-14)
+
+=== Migration
+* Raketasks (no one defined yet, but it is again possible to define one.)
+* Generator (Fix the exception_migration Generator from the plugin to be available through the gem)
+
+== 0.1.0 (2010-08-14)
+
+* First Released Version of Gem on RubyGems.org
+
+=== Migration
+* Many changes to migrate the plugin to a gem for Rails3

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Roland Guem
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.old

@@ -0,0 +1,107 @@
+ExceptionLogger
+===============
+
+The Exception Logger (forgive the horrible name) logs your Rails exceptions in the database and provides a funky web interface to manage them.
+
+First you need to generate the migration:
+
+  ./script/generate exception_migration
+
+Next, you'll need to include the ExceptionLoggable module into ApplicationController.  Once that's done you might want to modify key methods to customize the logging:
+
+  render_404(exception) - Shows the 404 template.
+  
+  render_500(exception) - Shows the 500 template.
+  
+  log_exception(exception) - Logs the actual exception in the database.
+  
+  rescue_action_in_public(exception) - Does not log these exceptions: ActiveRecord::RecordNotFound, ActionController::UnknownController, ActionController::UnknownAction
+
+Now add a new route to your routes.rb:
+
+ map.connect "logged_exceptions/:action/:id", :controller => "logged_exceptions"
+
+If you want the RSS Feed mapping, add this right after:
+
+  map.connect "logged_exceptions/:action.:format", :controller => "logged_exceptions"
+
+After that, visit /logged_exceptions in your application to manage the exceptions.
+
+Email notify config:
+LoggedExceptionsMailer.mailer_config.update( {
+  :subject     => 'Exception',
+  :recipients  => "me@gmail.com",
+  :from        => 'system@domain.com',
+  :link        => 'http://domain.com',
+  :deliver     => true # dispatching on
+})
+
+It's understandable that you may want to require authentication. You can do this by creating your own controller extending your ApplicationController (thereby leveraging all the existing authorization rules you may have) and include the ExceptionLoggableControllerMixin module. For example:
+
+  class LoggedExceptionsController < ApplicationController
+    include ExceptionLoggableControllerMixin
+    self.application_name = "My Application Name"  # this will show up in the title of the Rss feed
+
+    # add your regular permission checking here, e.g.:
+    protected
+      # only allow admins
+      # this obviously depends on how your auth system works
+      def authorized?
+        current_user.is_a?(Admin)
+      end
+      
+      # assume app's login required doesn't use http basic
+      def login_required_with_basic
+        respond_to do |accepts|
+          # alias_method_chain will alias the app's login_required to login_required_without_basic
+          accepts.html { login_required_without_basic }
+          
+          # access_denied_with_basic_auth is defined in ExceptionLoggableControllerMixin
+          # get_auth_data returns back the user/password pair
+          accepts.rss do
+            access_denied_with_basic_auth unless self.current_user = User.authenticate(*get_auth_data)
+          end
+        end
+      end
+      
+      alias_method_chain :login_required, :basic
+  end
+
+The exact code of course depends on the specific needs of your application.
+
+You can use ActionController::Base.filter_parameter_logging in the LoggedExceptionsController.
+In the code given above, do something like
+
+  LoggedExceptionsController.class_eval do
+    filter_parameter_logging :password
+  end
+
+When viewing a logged exception, parameters whose name has "password" as a substring
+will show their values as "[FILTERED]". There is a link to toggle this filtering, in
+case you really must have a look.
+
+Note that GET parameters will still be shown unfiltered within the logged URL.
+
+Catching exceptions from rake tasks:
+desc ''
+task :bar => :environment do |rake_task|
+  begin
+    raise Exception, ''
+  rescue Exception => e
+    LoggedExceptionRake.save_exception e, rake_task, ENV
+  end
+end
+
+CREDITS
+
+Jamis Buck  - original exception_notification plugin
+Rick Olson  - model/controller code
+Josh Goebel - design
+
+UPDATES
+
+Chris Wanstrath - use will_paginate
+Henrik Nyh (DanceJam) - log exceptions in dev, linkable exceptions, parameter filtering etc
+Zhurbiy Oleg (Ol.keene) - exception notify by email, exceptions catching from rake tasks, will_paginate fix
+David Rubin - Merged in different peoples branches. Fixed minor bugs and cleaned up the code.
+Jason Knight - Pagination support, built on/inspired by Ryanb's willpaginate support.

data/README.rdoc

@@ -0,0 +1,154 @@
+= Exception Logger for Rails3
+
+You liked the exception logger from http://github.com/defunkt/exception_logger for Rails2?
+
+You want to have the same functionallity using Rails3?
+
+You want to upgrade your Rails2 application and the old plugin breaks?
+
+You ...
+
+Then just use the exception_logger gem instead and tell your friends to do the same ;)
+
+== Hosted on RubyGems.org
+
+This gem is hosted on RubyGems.org: http://rubygems.org/gems/exception_logger
+
+== Install
+
+Inside your Gemfile:
+
+  gem "exception_logger", :require => "exception_logger"
+
+and then run:
+
+  bundle install
+
+=== Gem Dependencies
+
+Please check if all those requirements are satisfied on your environment.
+
+* i18n >= 0.4.1
+* meta_where >= 0.5.2 # (used to avoid SQL inside the CODE)
+* will_paginate >= 3.0.pre2 # (used for pagination)
+* rails >= 3.0.0
+
+=== Inside your ApplicationController:
+
+  include ExceptionLogger::ExceptionLoggable # loades the module
+  rescue_from Exception, :with => :log_exception_handler # tells rails to forward the 'Exception' (you can change the type) to the handler of the module
+
+== Generators
+
+=== Database Setup
+
+Use
+
+  rails g exception_logger:migration
+
+This will create a database migration
+
+  TIMESTAMP_add_exception_table.rb
+
+inside db/migrations
+
+=== Stylesheet and Javascript
+
+You can copy the stylesheet and javascript to your applications public directory by using
+
+  rails g exception_logger:stylescripts
+
+This allows you to customize those files.
+
+This will be also necessary if you use a webserver ( e.g. passenger+nginx ) in front of rails which does the static file handling for you.
+
+== Routing
+
+The gem is preconfigured to extend your routes automatically. You can access the logged exceptions by pointing to "/logged_exceptions" inside your application.
+
+You can use the rake tasks
+
+  rake routes
+
+to see and check the routes.
+
+== Exception Notification
+
+=== by Email
+
+Rails directly provides a plugin called "Exception Notification" ( http://github.com/rails/exception_notification ).
+
+Just download the plugin and follow the usage instructions from the README file ( http://github.com/rails/exception_notification/blob/master/README ) and add this code to one of your initializer files
+
+  # Example: put this to config/initializers/exception_notification.rb
+  Whatever::Application.config.middleware.use ExceptionNotifier,
+    :email_prefix => "[Whatever] ",
+    :sender_address => %{"notifier" <notifier@example.com>},
+    :exception_recipients => %w{exceptions@example.com}
+
+Restart your server and you are done. (Don't forget to setup your email settings inside your environment files.)
+
+== Authentication
+
+If you want, and believe me you want that, you can add the following lines to your environment to enable Authentication
+
+Example uses the declarative_authorization gem
+
+in config/environment/production.rb:
+
+  config.after_initialize do
+    LoggedExceptionsController.class_eval do
+      # include any custom auth modules you need
+      # (declarative authorization gem used)
+      filter_resource_access
+      # just add any code you want to be included in the controller ;)
+      # optional, sets the application name for the rss feeds
+      self.application_name = "Your Application Name"
+    end
+  end
+
+and (if you use declarative_authorization) add this to your authorization_rules.rb file:
+
+  role :admin do
+    has_permission_on :logged_exceptions, :to => :manage
+    ...
+
+== Upgrading from the old plugin
+
+If you have used the exception_logger plugin for your rails2 application and want to migrate to rails 3 then:
+
+* Remove the old plugin (just delete the vendor/plugins/exception_logger folder)
+* Install the new gem version (see Install)
+* DONE. (if I forgot something, then let me know.)
+
+== Legacy
+
+For more and older details read the README.old File.
+
+== Testing & Development
+
+Testing should always start before the actual development.
+
+You can test this gem very easily. Just run:
+
+  rake test:basic
+
+from the console of the cloned github repository of the exception logger.
+
+This rake task will create a rails app inside the test directory called rails_root and will install the exception logger and migrate the database of that application just in time.
+
+The generator which generates the rails app in your test directory will skip over every existing file, hence if you want to customize a file, then just add/create it.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Roland Guem. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,66 @@
+require 'rubygems'
+require 'rake'
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "exception_logger"
+    gem.summary = "Exception Logger for Rails 3"
+    gem.description = "Logs exceptions inside a database table. Now available as gem for Rails3 (previously a plugin for Rails2)"
+    gem.email = "roland.guem@gmail.com"
+    gem.homepage = "http://github.com/QuBiT/exception_logger"
+    gem.authors = ["Roland Guem"]
+    gem.files = Dir["{lib}/**/*", "{app}/**/*", "{config}/**/*", "{public}/**/*"]
+    gem.test_files = Dir["{test}/**/*"]
+    gem.add_dependency 'rails', '>=3.0.0'
+    gem.add_dependency "kaminari"
+    gem.add_dependency "squeel"
+    gem.add_dependency "i18n", ">= 0.4.1"
+    gem.add_development_dependency "shoulda", ">= 2.11.3"
+    gem.extra_rdoc_files = ["LICENSE","README.rdoc"]
+    gem.post_install_message = %q{
+_()_()_()_()_()_()_()_()_()_()_()_()_()_()_()_()_()_()_()_()_()_()_()_()_()_()_
+    Thank you for installing exception_logger.
+    Please be sure to read the README and HISTORY on
+        http://github.com/QuBiT/exception_logger
+    for important information about this release. Happy logging!
+_()_()_()_()_()_()_()_()_()_()_()_()_()_()_()_()_()_()_()_()_()_()_()_()_()_()_
+    }
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+ENV['BUNDLE_GEMFILE'] = File.dirname(__FILE__) + '/test/rails_root/Gemfile'
+
+#require 'rake'
+require 'rake/testtask'
+require 'cucumber/rake/task'
+require 'spec/rake/spectask'
+
+namespace :test do
+  Rake::TestTask.new(:basic => %w(test:generator:rails_setup test:generator:exception_migration)) do |task|
+    task.libs << "lib"
+    task.libs << "test"
+    task.pattern = "test/**/*_test.rb"
+    #task.verbose = false
+  end
+
+  Cucumber::Rake::Task.new(:features) do |t|
+    t.cucumber_opts = "--format progress"
+    t.profile = 'features'
+  end
+
+  namespace :generator do
+
+    task :rails_setup do
+      system "cd test && rails new rails_root --skip"
+    end
+
+    task :exception_migration do
+      system "cd test/rails_root && bundle install && ./script/rails generate exception_logger:migration && rake db:migrate db:test:prepare"
+    end
+  end
+
+end

data/VERSION.yml

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

data/app/controllers/logged_exceptions_controller.rb

@@ -0,0 +1,86 @@
+class LoggedExceptionsController < ApplicationController
+
+  cattr_accessor :application_name
+
+  #ApplicationController.class_eval do
+  #  rescue_from Exception, :with => :log_exception_handler
+  #end
+
+  def index
+    @exception_names    = LoggedException.class_names
+    @controller_actions = LoggedException.controller_actions
+    query
+  end
+
+  def query
+    exceptions = LoggedException.sorted
+    unless params[:id].blank?
+      exceptions = exceptions.where(:id => params[:id])
+    end
+    unless params[:query].blank?
+      exceptions = exceptions.message_like(params[:query])
+    end
+    unless params[:date_ranges_filter].blank?
+      exceptions = exceptions.days_old(params[:date_ranges_filter])
+    end
+    unless params[:exception_names_filter].blank?
+      exceptions = exceptions.by_exception_class(params[:exception_names_filter])
+    end
+    unless params[:controller_actions_filter].blank?
+      c_a_params = params[:controller_actions_filter].split('/')
+      controller_filter = c_a_params.first.underscore
+      action_filter = c_a_params.last.downcase
+      exceptions = exceptions.by_controller(controller_filter)
+      exceptions = exceptions.by_action(action_filter)
+    end
+    @exceptions = exceptions.page(params[:page]).per(30)
+
+    respond_to do |format|
+      format.html { redirect_to :action => 'index' unless action_name == 'index' }
+      format.js
+    end
+  end
+  
+  def feed
+    @exceptions = LoggedException.all
+
+    respond_to do |format|
+      format.rss { render :layout => false }
+    end
+  end
+
+  def show
+    @exception = LoggedException.where(:id => params[:id]).first
+    
+    respond_to do |format|
+      format.js
+      format.html
+    end
+  end
+
+  def destroy
+    @exception = LoggedException.where(:id => params[:id]).first
+    @exception.destroy
+  end
+
+  def destroy_all
+    LoggedException.delete_all(:id => params[:ids]) unless params[:ids].blank?
+    query 
+  end
+
+  private
+  def access_denied_with_basic_auth
+    headers["Status"]           = "Unauthorized"
+    headers["WWW-Authenticate"] = %(Basic realm="Web Password")
+    render :text => "Could't authenticate you", :status => '401 Unauthorized'
+  end
+
+  @@http_auth_headers = %w(X-HTTP_AUTHORIZATION HTTP_AUTHORIZATION Authorization)
+  # gets BASIC auth info
+  def get_auth_data
+    auth_key  = @@http_auth_headers.detect { |h| request.env.has_key?(h) }
+    auth_data = request.env[auth_key].to_s.split unless auth_key.blank?
+    return auth_data && auth_data[0] == 'Basic' ? Base64.decode64(auth_data[1]).split(':')[0..1] : [nil, nil]
+  end
+end
+