eh 0.0.1 → 0.0.3

data/README.md

@@ -1,8 +1,9 @@
 # Eh
 
-The Error handler gem provids the following major functional support for error handling:
+The Error handler gem provides the following major functional support for error handling,
+based on the ideas expressed in the Exceptional Ruby book by Avdi Grimm
 
-o Wrapping of code blocks in exception handling logic, supporting retry, logging and exception consumption
+o Wrapping of code blocks in exception handling logic, supporting retry, logging and exception consumption, as well as a list of handlers that can be injected
 o Provision of fault tolerant logging that logs to configured logger(s), or to stderr should loggers be unavailable
 o Capability to handle unhandled exceptions, log them, email them and either raise them again or convert them to system exit codes (listing of standard linux exit codes provided as constants)
 
@@ -10,10 +11,11 @@ The Error Handler gem allows the wrapping of arbitrary blocks of code in excepti
 
 o The block can be retried 'threshold' times, with a delay of 'delay' seconds in-between retries (EH::retry and EH::retry!)
 o The exception can be logged to a single logger, or an array of loggers
-o The excepion can be re-raised (suppressed during retry, but logged, raised again after retry failure)
+o The exception can be re-raised (suppressed during retry, but logged, raised again after retry failure)
 o The same functionality is available, with retry disabled (EH::run and EH::run!)
 o The list of Linux system exit codes is also provided as EH::EX_<exit>
 o Unhandled exceptions can be logged and emailed in main() using EH::report_unhandled()
+o A list of handlers can be injected to do custom handling, such as email, roll-back, etc.
 
 This gem is sponsored by Hetzner (Pty) Ltd - http://hetzner.co.za
 
@@ -33,14 +35,20 @@ Or install it yourself as:
 
 ## Usage
 
+require 'rubygems'
+require 'eh/eh'
+
 -- Run code block with retry, logging and exception re-raise, specifying logger, number of
-   times to retry, retry delay, and block arguments
+   times to retry, retry delay, and block arguments. Also call handle(exception, message) on
+   the list of handlers provided
 def load_configuration(configuration_path, logger = nil)
   EH::retry!(:logger => logger,
              :message => "Could not parse YAML configuration",
              :args => [configuration_path],
              :threshold => 5,
-             :delay => 0.5) do
+             :delay => 0.5,
+             :exception_filter => [RuntimeError, IOError],
+             :handlers => [MyEmailHandler.new, MyOtherHandler.new]) do
       YAML.load(File.open(configuration_path))
   end
 end
@@ -68,7 +76,7 @@ Any combination of the following options are allowed, both with both flavours of
 :args - code block arguments
 :threshold - the number of execution attempts
 :delay - the number of seconds to delay between retries
-
+:handlers - an array of handlers that implement handle(exception, message)
 
 Function descriptions:
 

data/eh.gemspec

@@ -6,8 +6,8 @@ require 'eh/version'
 Gem::Specification.new do |spec|
   spec.name          = "eh"
   spec.version       = ErrorHandler::VERSION
-  spec.authors       = ["Ernst ban Graan"]
-  spec.email         = ["ernst.van.graan@hetzner.co.za"]
+  spec.authors       = ["Ernst van Graan, Wynand van Dyk"]
+  spec.email         = ["ernst.van.graan@hetzner.co.za", "wynand.van.dyk@hetzner.co.za"]
   spec.description   = %q{Error handler gem that allows wrapping of code blocks with support for block retry, logging, exception filtering and re-raise}
   spec.summary       = %q{Error handler gem that allows wrapping of code blocks with support for block retry, logging, exception filtering and re-raise}
   spec.homepage      = ""

data/lib/eh/eh.rb

@@ -47,7 +47,9 @@ module ErrorHandler
     rescue => e
       raise e if opts.nil? == false and opts[:exception_filter] and not opts[:exception_filter].include? e.class
 
-      EH::log(opts[:logger], "#{opts[:message]}: #{e.message}", EH::log_level(opts)) if opts.nil? == false and not opts[:logger].nil? and not opts[:message].nil?
+      msg = "#{opts[:message]}: #{e.message}"
+      EH::log(opts[:logger], msg, EH::log_level(opts)) if opts.nil? == false and not opts[:logger].nil? and not opts[:message].nil?
+      EH::handle(opts[:handlers], e, msg) if not opts[:handlers].nil?
       raise e
     end
 
@@ -57,9 +59,11 @@ module ErrorHandler
         EH::retry_with_raise(opts, block)
         return true
       rescue => e
+        msg = "#{opts[:message]}: #{e.message}"
         if not opts[:logger].nil?
-          EH::log(opts[:logger], "#{opts[:message]}: #{e.message}", EH::log_level(opts)) if opts[:exception_filter].nil? or opts[:exception_filter].include? e.class
+          EH::log(opts[:logger], msg, EH::log_level(opts)) if opts[:exception_filter].nil? or opts[:exception_filter].include? e.class
         end
+        EH::handle(opts[:handlers], e, msg) if not opts[:handlers].nil?
         return false
       end
     end
@@ -69,9 +73,11 @@ module ErrorHandler
       block.call(EH::construct_args(opts))
 
     rescue => e
+      msg = "#{opts[:message]}: #{e.message}"
       if not opts[:logger].nil?
-        EH::log(opts[:logger], "#{opts[:message]}: #{e.message}", EH::log_level(opts)) if opts[:exception_filter].nil? or opts[:exception_filter].include? e.class
+        EH::log(opts[:logger], msg, EH::log_level(opts)) if opts[:exception_filter].nil? or opts[:exception_filter].include? e.class
       end
+      EH::handle(opts[:handlers], e, msg) if not opts[:handlers].nil?
 
       raise e if opts.nil? == false and opts[:exception_filter] and not opts[:exception_filter].include? e.class
       raise e
@@ -82,9 +88,11 @@ module ErrorHandler
       block.call(EH::construct_args(opts))
 
     rescue => e
+      msg = "#{opts[:message]}: #{e.message}"
       if not opts[:logger].nil?
-        EH::log(opts[:logger], "#{opts[:message]}: #{e.message}", EH::log_level(opts)) if opts[:exception_filter].nil? or opts[:exception_filter].include? e.class
+        EH::log(opts[:logger], msg, EH::log_level(opts)) if opts[:exception_filter].nil? or opts[:exception_filter].include? e.class
       end
+      EH::handle(opts[:handlers], e, msg) if not opts[:handlers].nil?
     end
 
     def self.log(facilities, msg, msg_type)
@@ -95,8 +103,23 @@ module ErrorHandler
       end
     end
 
+    def self.generate_log_id
+      ms = Time.now
+    end
+
     private
 
+    def self.handle(handlers, e, msg)
+      return if handlers.nil?
+      if handlers.is_a? Array
+        handlers.each do |handler|
+          handler.handle(e, msg) if not handler.nil?
+        end
+      else
+        handlers.handle(e, msg)
+      end
+    end
+
     def self.construct_args(opts)
       return nil if opts.nil?
       return nil if opts[:args].nil?
@@ -119,30 +142,6 @@ module ErrorHandler
       end
     end
 
-# Coming soon...
-#    def send_email(to, message, opts={})
-#      require 'net/smtp'
-#
-#      opts[:server]      ||= Socket.gethostbyname(Socket.gethostname).first
-#      me = "database-agent@#{opts[:server]}"
-#      opts[:from]        ||= me
-#      opts[:from_alias]  ||= me
-#      opts[:subject]     ||= "Uncaught exception"
-#      opts[:body]        ||= message
-#
-#      msg = <<END_OF_MESSAGE
-#From: #{opts[:from_alias]} <#{opts[:from]}>
-#To: <#{to}>
-#Subject: #{opts[:subject]}
-#
-#    #{opts[:body]}
-#END_OF_MESSAGE
-#
-#      Net::SMTP.start(opts[:server]) do |smtp|
-#        smtp.send_message msg, opts[:from], to
-#      end
-#    end
-
     def self.log_single_logger(logger, msg, msg_type)
       if logger.nil?
         warn msg_type + ': ' + msg
@@ -168,4 +167,4 @@ module ErrorHandler
   end
 end
 
-EH = ErrorHandler::EH
+EH = ErrorHandler::EH

data/lib/eh/version.rb

@@ -1,3 +1,3 @@
 module ErrorHandler
-  VERSION = "0.0.1"
+  VERSION = "0.0.3"
 end

data/spec/eh_spec.rb

@@ -1,10 +1,12 @@
 require "spec_helper"
 require "eh/eh"
 require "mock_logger"
+require "mock_mailer"
 
 describe ErrorHandler do
   before :each do
     @logger = MockLogger.new
+    @mailer = MockMailer.new
   end
 
   context "When executing a block of code without retry" do
@@ -42,6 +44,30 @@ describe ErrorHandler do
         end
       end
 
+      it "should inform all handlers specified of the message and exception" do
+        @mailer.should_receive(:handle)
+        @handler2 = MockMailer.new
+        begin
+          EH::run(:handlers => [@mailer, @handler2], :message => "the message") do
+            raise RuntimeError
+          end
+        end
+
+        @handler2.e.class.should == RuntimeError
+        @handler2.msg.should == "the message: RuntimeError"
+      end
+
+      it "should inform a specified handler of the message and exception" do
+        begin
+          EH::run(:handlers => @mailer, :message => "the message") do
+            raise RuntimeError
+          end
+        end
+
+        @mailer.e.class.should == RuntimeError
+        @mailer.msg.should == "the message: RuntimeError"
+      end
+
       it "should log the message specified with the exception appended, if the exception is in :exception_filter, using the logger specified" do
         @logger.should_receive(:error).with("the message: RuntimeError")
         begin
@@ -105,6 +131,32 @@ describe ErrorHandler do
         end
       end
 
+      it "should inform all handlers specified of the message and exception" do
+        @mailer.should_receive(:handle)
+        @handler2 = MockMailer.new
+        begin
+          EH::run(:handlers => [@mailer, @handler2], :message => "the message") do
+            raise RuntimeError
+          end
+        rescue => e
+        end
+
+        @handler2.e.class.should == RuntimeError
+        @handler2.msg.should == "the message: RuntimeError"
+      end
+
+      it "should inform a specified handler of the message and exception" do
+        begin
+          EH::run(:handlers => @mailer, :message => "the message") do
+            raise RuntimeError
+          end
+        rescue => e
+        end
+
+        @mailer.e.class.should == RuntimeError
+        @mailer.msg.should == "the message: RuntimeError"
+      end
+
       it "should log the message specified with the exception appended, if the exception is in :exception_filter, using the logger specified" do
         @logger.should_receive(:error).with("the message: RuntimeError")
         begin
@@ -213,6 +265,30 @@ describe ErrorHandler do
         end
       end
 
+      it "should inform all handlers specified of the message and exception" do
+        @mailer.should_receive(:handle)
+        @handler2 = MockMailer.new
+        begin
+          EH::run(:handlers => [@mailer, @handler2], :message => "the message") do
+            raise RuntimeError
+          end
+        end
+
+        @handler2.e.class.should == RuntimeError
+        @handler2.msg.should == "the message: RuntimeError"
+      end
+
+      it "should inform a specified handler of the message and exception" do
+        begin
+          EH::run(:handlers => @mailer, :message => "the message") do
+            raise RuntimeError
+          end
+        end
+
+        @mailer.e.class.should == RuntimeError
+        @mailer.msg.should == "the message: RuntimeError"
+      end
+
       it "should log the message specified with the exception appended, if the exception is in :exception_filter, using the logger specified" do
         @logger.should_receive(:error).with("the message: RuntimeError")
         begin
@@ -300,6 +376,32 @@ describe ErrorHandler do
         end
       end
 
+      it "should inform all handlers specified of the message and exception" do
+        @mailer.should_receive(:handle)
+        @handler2 = MockMailer.new
+        begin
+          EH::run(:handlers => [@mailer, @handler2], :message => "the message") do
+            raise RuntimeError
+          end
+        rescue => e
+        end
+
+        @handler2.e.class.should == RuntimeError
+        @handler2.msg.should == "the message: RuntimeError"
+      end
+
+      it "should inform a specified handler of the message and exception" do
+        begin
+          EH::run(:handlers => @mailer, :message => "the message") do
+            raise RuntimeError
+          end
+        rescue => e
+        end
+
+        @mailer.e.class.should == RuntimeError
+        @mailer.msg.should == "the message: RuntimeError"
+      end
+
       it "should log the message specified with the exception appended, if the exception is in :exception_filter, using the logger specified" do
         @logger.should_receive(:error).with("the message: RuntimeError")
         begin

data/spec/mock_mailer.rb

@@ -0,0 +1,9 @@
+class MockMailer
+  attr_accessor :e
+  attr_accessor :msg
+
+  def handle(e, msg)
+    @e = e
+    @msg = msg
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'rspec'
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib', 'eh'))
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -1,88 +1,90 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: eh
-version: !ruby/object:Gem::Version
-  version: 0.0.1
+version: !ruby/object:Gem::Version 
+  hash: 25
   prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 3
+  version: 0.0.3
 platform: ruby
-authors:
-- Ernst ban Graan
+authors: 
+- Ernst van Graan, Wynand van Dyk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-06 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2013-03-07 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 1
+        - 3
+        version: "1.3"
   type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: simplecov
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-description: Error handler gem that allows wrapping of code blocks with support for
-  block retry, logging, exception filtering and re-raise
-email:
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: Error handler gem that allows wrapping of code blocks with support for block retry, logging, exception filtering and re-raise
+email: 
 - ernst.van.graan@hetzner.co.za
+- wynand.van.dyk@hetzner.co.za
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - Gemfile
 - LICENSE.txt
@@ -94,38 +96,43 @@ files:
 - lib/error_handler.rb
 - spec/eh_spec.rb
 - spec/mock_logger.rb
-homepage: ''
-licenses:
+- spec/mock_mailer.rb
+- spec/spec_helper.rb
+homepage: ""
+licenses: 
 - MIT
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
       - 0
-      hash: 798203344795618863
-required_rubygems_version: !ruby/object:Gem::Requirement
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
       - 0
-      hash: 798203344795618863
+      version: "0"
 requirements: []
+
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Error handler gem that allows wrapping of code blocks with support for block
-  retry, logging, exception filtering and re-raise
-test_files:
+summary: Error handler gem that allows wrapping of code blocks with support for block retry, logging, exception filtering and re-raise
+test_files: 
 - spec/eh_spec.rb
 - spec/mock_logger.rb
+- spec/mock_mailer.rb
+- spec/spec_helper.rb