ixtlan-error-handler 0.1.0 → 0.1.1

data/lib/ixtlan/errors/error_dumper.rb

@@ -1,4 +1,6 @@
 require 'ixtlan/errors/mailer'
+require 'fileutils'
+
 module Ixtlan
   module Errors
     class ErrorDumper
@@ -15,16 +17,16 @@ module Ixtlan
       end
 
       def dump_dir
-        unless @dump_dir
+        if @dump_dir.blank?
           @dump_dir = File.join(Rails.root, "log", "errors")
           FileUtils.mkdir_p(@dump_dir)
         end
         @dump_dir 
       end
 
-      def dump_dir=(dr)
+      def dump_dir=(dir)
         @dump_dir = dir
-        FileUtils.mkdir_p(@dump_dir) if dir
+        FileUtils.mkdir_p(@dump_dir) unless dir.blank?
         @dump_dir
       end
       
@@ -34,7 +36,7 @@ module Ixtlan
         logger = Logger.new(log_file)
 
         dump_environment(logger, exception, controller)
-        Mailer.deliver_error_notification(@email_from, @email_to, exception, log_file) unless (@email_to.blank? || @email_from.blank?)
+        Mailer.error_notification(@email_from, @email_to, exception, log_file).deliver unless (@email_to.blank? || @email_from.blank?)
         log_file
       end
 
@@ -65,7 +67,7 @@ module Ixtlan
 
         dump_environment_header(logger, "EXCEPTION");
         logger.error("#{exception.class}:#{exception.message}")
-        logger.error("\t" + exception.backtrace.join("\n\t"))
+        logger.error("\t" + exception.backtrace.join("\n\t")) if exception.backtrace
       end
 
       def dump_hashmap(logger, map)

data/lib/ixtlan/errors/error_handler.rb

@@ -5,28 +5,32 @@ module Ixtlan
       protected
 
       def internal_server_error(exception)
+        log_user_error(exception)
         dump_error(exception)
-        status = :internal_server_error
-        error_page(:internal_server_error, exception, "internal server error: #{exception.class.name}")
+        error_page(:internal_server_error, "internal server error: #{exception.class.name}")
       end
 
       def page_not_found(exception)
         log_user_error(exception)
-        status = rescue_responses[exception.class.name]
-        status = status == :internal_server_error ? :not_found : status
-        error_page(status, exception, "page not found")
+        error_page(:not_found, "page not found")
       end
+        #status = rescue_responses[exception.class.name]
+        #status = status == :internal_server_error ? :not_found : status
+        #error_page(status, "page not found")
 
       def stale_resource(exception)
         log_user_error(exception)
-        respond_to do |format|
-          format.html {
-            render_stale_error_page
-          }
-          format.xml { head :conflict }
-        end
+        error_page(:conflict, "stale resource")
       end
 
+      #   respond_to do |format|
+      #     format.html {
+      #       render_stale_error_page
+      #     }
+      #     format.xml { head :conflict }
+      #   end
+      # end
+
       def render_error_page_with_session(status)
         render :template => "errors/error_with_session", :status => status
       end
@@ -35,15 +39,15 @@ module Ixtlan
         render :template => "errors/error", :status => status
       end
 
-      def render_stale_error_page
-        render :template => "errors/stale", :status => :conflict
-      end
+      # def render_stale_error_page
+      #   render :template => "errors/stale", :status => :conflict
+      # end
 
       private
 
       if defined? ::Ixtlan::Audit
         def user_logger
-          @user_logger ||= Ixtlan::Audit::UserLogger.new(Rails.application.config.audit_manager)
+          @user_logger ||= Ixtlan::Audit::UserLogger.new(Rails.configuration.audit_manager)
         end
 
         def log_user_error(exception)
@@ -56,7 +60,7 @@ module Ixtlan
         end
       end
 
-      def error_page(status, exception, notice)
+      def error_page(status, notice)
         respond_to do |format|
           format.html {
             @notice = notice
@@ -72,7 +76,6 @@ module Ixtlan
       end
 
       def dump_error(exception)
-        log_user_error(exception)
         Rails.configuration.error_dumper.dump(self, exception)
       end
     end

data/lib/ixtlan/errors/mailer.rb

@@ -4,7 +4,7 @@ module Ixtlan
       
       def error_notification(email_from, emails_to, exception, error_file)
         @subject    = exception.message
-        @body       = {:text => "#{error_file}"}
+        @text       = "#{error_file}"
         @recipients = emails_to
         @from       = email_from
         @sent_on    = Time.now

data/lib/ixtlan/errors/railtie.rb

@@ -9,7 +9,7 @@ module Ixtlan
 
       config.before_configuration do |app|
         
-        path = File.join(File.dirname(__FILE__), "mailer")
+        path = File.join(File.dirname(__FILE__), "..", "..")
         unless ActionMailer::Base.view_paths.member? path
           ActionMailer::Base.view_paths= [ActionMailer::Base.view_paths, path].flatten 
         end

data/spec/error_dumper_spec.rb

@@ -0,0 +1,113 @@
+module Ixtlan
+  module Errors
+    module ActionMailer
+      class Base
+        
+        def self.method_missing(method, *args)
+          self.new
+        end
+
+        def self.deliver(val = nul)
+          @delivered = val if val
+          @delivered
+        end
+        def deliver
+          self.class.deliver(true)
+        end
+      end
+    end
+  end
+end
+
+require 'ixtlan/errors/error_dumper'
+require 'date'
+require 'logger'
+
+class Controller
+
+  def request
+    self
+  end
+  def env
+    @env ||= {:one => 1, :two => 2, :three => 3}
+  end
+
+  def response
+    self
+  end
+
+  def headers
+    @headers ||= { 'ONE' => 1, "TWO" => 2 }
+  end
+
+  def session
+    @session ||= { "user" => "me" }
+  end
+
+  def params
+    @params ||= { :query => "all" }
+  end
+end
+
+class NilClass
+  def blank?
+    true
+  end
+end
+
+class String
+  def blank?
+    size == 0
+  end
+end
+
+class Fixnum
+  def ago
+    DateTime.now - self.to_i
+  end
+end
+
+class DateTime
+  def tv_sec
+    sec
+  end
+  def tv_usec
+    0
+  end
+end
+
+describe Ixtlan::Errors::ErrorDumper do
+
+  before :each do
+    @dumper = Ixtlan::Errors::ErrorDumper.new
+    @dumper.dump_dir = "target"
+    @controller = Controller.new
+  end
+
+  it "should dump env and not send notification" do
+    file = @dumper.dump(@controller, StandardError.new("dump it"))
+    File.exists?(file).should be_true
+    @dumper.email_from = "asd"
+    file = @dumper.dump(@controller, StandardError.new("dump it"))
+    File.exists?(file).should be_true
+    @dumper.email_from = nil
+    @dumper.email_to = "dsa"
+    file = @dumper.dump(@controller, StandardError.new("dump it"))
+    File.exists?(file).should be_true
+  end
+
+  it "should clean up error dumps" do
+    @dumper.keep_dumps = 0
+    @dumper.dump(@controller, StandardError.new("dump it"))
+    Dir['target/error-*'].size.should == 1
+    @dumper.dump(@controller, StandardError.new("dump it"))
+    Dir['target/error-*'].size.should == 1
+  end
+
+  it "should send notifications" do
+    @dumper.email_to = "das"
+    @dumper.email_from = "asd"
+    @dumper.dump(@controller, StandardError.new("dump it"))
+    Ixtlan::Errors::ActionMailer::Base.delivered.should be_true
+  end
+end

data/spec/error_handler_spec.rb

@@ -0,0 +1,138 @@
+require 'ixtlan/errors/error_handler'
+#require 'date'
+require 'logger'
+
+class Controller
+  def logger
+    @logger ||= Logger.new(STDOUT)
+  end
+
+  def respond_to(&block)
+    block.call self
+  end
+
+  def html(&block)
+    block.call self
+  end
+
+  def xml(&block)
+    block.call self
+  end
+  
+  def json(&block)
+    block.call self
+  end
+
+  def stati
+    @stati ||= []
+  end
+
+  def head(status)
+    stati << status
+  end
+
+  def render(options = nil)
+    @render = options if options
+    @render
+  end
+end
+
+class Rails
+  def self.configuration
+    self
+  end
+
+  def self.error_dumper
+    self
+  end
+  
+  def self.dump(controller, exception)
+    @dumped = exception
+  end
+
+  def self.dumped
+    r = @dumped
+    @dumped = nil
+    r
+  end
+end
+
+describe Ixtlan::Errors::ErrorHandler do
+
+  before :each do
+    @controller = Controller.new
+    Controller.send :include, Ixtlan::Errors::ErrorHandler
+  end
+
+  describe "without session" do
+    
+    it "should handle internal server error" do
+      exp = StandardError.new("internal")
+      @controller.send :internal_server_error, exp
+      Rails.dumped.should == exp
+      @controller.render.should_not be_nil
+      @controller.render[:status].should == :internal_server_error
+      @controller.render[:template].should == "errors/error"
+      @controller.stati.should == [:internal_server_error, :internal_server_error]
+    end
+
+    it "should handle not found" do
+      exp = StandardError.new("not found")
+      @controller.send :page_not_found, exp
+      Rails.dumped.should be_nil
+      @controller.render.should_not be_nil
+      @controller.render[:status].should == :not_found
+      @controller.render[:template].should == "errors/error"
+      @controller.stati.should == [:not_found, :not_found]
+    end
+
+    it "should handle stale resource" do
+      exp = StandardError.new("stale")
+      @controller.send :stale_resource, exp
+      Rails.dumped.should be_nil
+      @controller.render.should_not be_nil
+      @controller.render[:status].should == :conflict
+      @controller.render[:template].should == "errors/error"
+      @controller.stati.should == [:conflict, :conflict]
+    end
+  end
+
+  describe "with session" do
+    
+    before :each do
+      def @controller.current_user
+        Object.new
+      end
+    end
+    
+    it "should handle internal server error" do
+      exp = StandardError.new("internal")
+      @controller.send :internal_server_error, exp
+      Rails.dumped.should == exp
+      @controller.render.should_not be_nil
+      @controller.render[:status].should == :internal_server_error
+      @controller.render[:template].should == "errors/error_with_session"
+      @controller.stati.should == [:internal_server_error, :internal_server_error]
+    end
+
+    it "should handle not found" do
+      exp = StandardError.new("not found")
+      @controller.send :page_not_found, exp
+      Rails.dumped.should be_nil
+      @controller.render.should_not be_nil
+      @controller.render[:status].should == :not_found
+      @controller.render[:template].should == "errors/error_with_session"
+      @controller.stati.should == [:not_found, :not_found]
+    end
+
+    it "should handle stale resource" do
+      exp = StandardError.new("stale")
+      @controller.send :stale_resource, exp
+      Rails.dumped.should be_nil
+      @controller.render.should_not be_nil
+      @controller.render[:status].should == :conflict
+      @controller.render[:template].should == "errors/error_with_session"
+      @controller.stati.should == [:conflict, :conflict]
+    end
+  end
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
     - 0
     - 1
-    - 0
-  version: 0.1.0
+    - 1
+  version: 0.1.1
 platform: ruby
 authors: 
   - mkristian
@@ -14,35 +14,35 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-01 00:00:00 +05:30
+date: 2011-03-22 00:00:00 +05:30
 default_executable: 
 dependencies: 
   - !ruby/object:Gem::Dependency 
-    name: rails
+    name: rspec
     prerelease: false
     requirement: &id001 !ruby/object:Gem::Requirement 
       requirements: 
         - - "="
           - !ruby/object:Gem::Version 
             segments: 
-              - 3
+              - 2
+              - 4
               - 0
-              - 1
-            version: 3.0.1
+            version: 2.4.0
     type: :development
     version_requirements: *id001
   - !ruby/object:Gem::Dependency 
-    name: rspec
+    name: rake
     prerelease: false
     requirement: &id002 !ruby/object:Gem::Requirement 
       requirements: 
         - - "="
           - !ruby/object:Gem::Version 
             segments: 
-              - 2
               - 0
-              - 1
-            version: 2.0.1
+              - 8
+              - 7
+            version: 0.8.7
     type: :development
     version_requirements: *id002
   - !ruby/object:Gem::Dependency 
@@ -50,29 +50,15 @@ dependencies:
     prerelease: false
     requirement: &id003 !ruby/object:Gem::Requirement 
       requirements: 
-        - - "="
+        - - ">="
           - !ruby/object:Gem::Version 
             segments: 
               - 0
-              - 9
-              - 4
-            version: 0.9.4
-    type: :development
-    version_requirements: *id003
-  - !ruby/object:Gem::Dependency 
-    name: rake
-    prerelease: false
-    requirement: &id004 !ruby/object:Gem::Requirement 
-      requirements: 
-        - - "="
-          - !ruby/object:Gem::Version 
-            segments: 
               - 0
-              - 8
-              - 7
-            version: 0.8.7
+              - 0
+            version: 0.0.0
     type: :development
-    version_requirements: *id004
+    version_requirements: *id003
 description: dump errors on filesystem and notify developers, map different errors to specific pages
 email: 
   - m.kristian@web.de
@@ -83,9 +69,6 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-  - README.textile
-  - features/step_definitions/simple_steps.rb
-  - features/generators.feature
   - lib/ixtlan-error-handler.rb
   - lib/ixtlan/errors/railtie.rb
   - lib/ixtlan/errors/error_handler.rb
@@ -93,10 +76,12 @@ files:
   - lib/ixtlan/errors/rescue_module.rb
   - lib/ixtlan/errors/error_dumper.rb
   - lib/ixtlan/errors/mailer/error_notification.erb
+  - spec/error_dumper_spec.rb
+  - spec/error_handler_spec.rb
 has_rdoc: true
 homepage: http://github.com/mkristian/ixtlan-error-handler
-licenses: []
-
+licenses: 
+  - MIT-LICENSE
 post_install_message: 
 rdoc_options: 
   - --main
@@ -124,5 +109,6 @@ rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: dump errors on filesystem and notify developers
-test_files: []
-
+test_files: 
+  - spec/error_dumper_spec.rb
+  - spec/error_handler_spec.rb

data/README.textile

@@ -1,31 +0,0 @@
-h1. Rails Error Dumper
-
-p. the main idea here is notify the developers on error but in a way to protect privacy of the users of the system. to do so ALL data need to remain on the server and they need to be deleted after period of time.
-
-* first to dump as much as possible onto the filesystem of the server when an error occurs, i.e. the environment, the request, the response, the session, etc
-
-* notify the developers
-
-* delete expired error dumps
-
-p. the next idea is to collect all possible rails exception and map them to three error pages and pass on a message. for each exception you can decide whether an error dump is needed or not.
-
-h2. install
-
-p. in Gemfile add *gem 'ixtlan-error-handler'*
-
-p. for the configuration add for example in _config/initializers/error_handler.rb_
-
-bc. config.error_dumper.dump_dir = Rails.root + "/log/errors" # default: log/errors
-config.error_dumper.email_from = "no-reply@example.com"
-config.error_dumper.email_to = "developer1@example.com,developer2@example.com"
-config.error_dumper.keep_dumps = 30 # days
-config.skip_rescue_module = true # do not include the predefined Rescue 
-
-h2. relation to ixtlan gem
-
-p. the ixtlan gem provides a setup generator which adds configuration examples for this gem in _config/initializer/ixtlan.rb_ (the dynamic configuration is part of the ixtlan gem and it is just easier to keep that inside that gem !!!)
-
-h2. relation to ixtlan-audit gem
-
-p. if that gem is present and loaded than any error will be log with the help of _Ixtlan::Audit::UserLogger_

data/features/generators.feature

@@ -1,5 +0,0 @@
-Feature: Generators for Ixtlan Audit
-
-  Scenario: The slf4r rails template creates a rails application which uses slf4r-wrapper
-    Given I create new rails application with template "simple.template"
-    Then the output should contain "setup slf4r logger wrapper with ActiveSupport::BufferedLogger"

data/features/step_definitions/simple_steps.rb

@@ -1,22 +0,0 @@
-require 'fileutils'
-Given /^I create new rails application with template "(.*)"$/ do |template|
-  name = template.sub(/.template$/, '')
-  directory = File.join('target', name)
-  rails_version = ENV['RAILS_VERSION'] || '3.0.1'
-
-  ruby = defined?(JRUBY_VERSION) ? "jruby" : "ruby"
-  rails_command = "#{ENV['GEM_HOME']}/bin/rails"
-  rails_command = "-S rails" unless File.exists?(rails_command)
-  command = "#{rails_command} _#{rails_version}_ new #{directory} -f -m templates/#{template}"
-  FileUtils.rm_rf(directory)
-
-  system "#{ruby} #{command}"
-  
-  @result = File.read("target/#{name}/log/development.log")
-  puts @result
-end
-
-Then /^the output should contain \"(.*)\"$/ do |expected|
-  (@result =~ /.*#{expected}.*/).should_not be_nil
-end
-