merb-exceptions 0.9.9 → 0.9.10

data/README.markdown

@@ -1,4 +1,4 @@
-merb_exceptions
+merb-exceptions
 ===============
 A simple Merb plugin to ease exception notifications.
 
@@ -6,14 +6,14 @@ The notifier currently supports two interfaces, Email Alerts and Web Hooks. Emai
 
 Getting Going
 -------------
-Once you have the Gem installed you will need to add it as a dependency in your projects `init.rb` file
+Once you have the Gem installed you will need to add it as a dependency in your projects `dependencies.rb` file
 
-    dependency 'merb_exceptions'
+    dependency 'merb-exceptions'
 
-Configuration goes in 'config/init.rb' file in 'Merb::BootLoader.before_app_loads'. See 'Settings' below for a full description of the options.
+Configuration goes in your projects `config/init.rb` file inside `Merb::BootLoader.before_app_loads`. See the 'Settings' section below for a full description of the options.
 
     Merb::Plugins.config[:exceptions] = {
-      :web_hooks       => ['http://localhost:4000/exceptions'],
+      :web_hooks       => ['http://example.com'],
       :email_addresses => ['hello@exceptions.com', 'user@myapp.com'],
       :app_name        => "My App Name",
       :email_from      => "exceptions@myapp.com",
@@ -42,17 +42,17 @@ Settings
 
 Advanced usage
 --------------
-Including `MerbExceptions::ControllerExtensions` creates an `internal_server_error` action which renders the default exception page and delivers the exception. If you need to rescue any other exceptions or customize the behavior in any way you can write your own actions in `ExceptionsController` and make a call to `render_and_notify`.
+merb-exceptions will deliver exceptions for any unhandled exceptions (exceptions that do not have views defined in the `Exceptions` controller)
 
-For example to be notified of 404's:
+You can cause handled exceptions to send notifications as well, for example to be notified of 404's:
+
+    after :notify_of_exceptions, :only => :not_found
 
     def not_found
       render_and_notify :format => :html
     end
 
-`render_and_notify` - passes any provided options directly to Merb's render method and then sends the notification after rendering.
-
-`notify_of_exceptions` - if you need to handle the render yourself for some reason then you can call this method directly. It sends notifications without any rendering logic. Note though that if you are sending lots of notifications this could delay sending a response back to the user so try to avoid using it where possible.
+`notify_of_exceptions` - sends notifications without any rendering logic. Note though that if you are sending lots of notifications this could delay sending a response back to the user so it is better to use after rendering.
 
 Web hooks
 ---------

data/Rakefile

@@ -20,7 +20,7 @@ GEM_EMAIL  = "andy@new-bamboo.co.uk"
 
 GEM_NAME    = "merb-exceptions"
 PKG_BUILD   = ENV['PKG_BUILD'] ? '.' + ENV['PKG_BUILD'] : ''
-GEM_VERSION = (Merb::VERSION rescue "0.9.9") + PKG_BUILD
+GEM_VERSION = Merb::VERSION + PKG_BUILD
 
 RELEASE_NAME    = "REL #{GEM_VERSION}"
 
@@ -35,7 +35,7 @@ spec = Gem::Specification.new do |s|
   s.author = GEM_AUTHOR
   s.email = GEM_EMAIL
   s.homepage = PROJECT_URL
-  s.add_dependency('merb-core', '>= 0.9.9')
+  s.add_dependency('merb-core', ">= #{Merb::VERSION}")
   s.require_path = 'lib'
   s.files = %w(LICENSE README.markdown Rakefile) + Dir.glob("{lib,spec}/**/*")
 end
@@ -55,7 +55,7 @@ task :uninstall do
 end
 
 desc "Run all specs"
-Spec::Rake::SpecTask.new("specs") do |t|
+Spec::Rake::SpecTask.new("spec") do |t|
   t.spec_opts = ["--format", "specdoc", "--colour"]
   t.spec_files = Dir["spec/**/*_spec.rb"].sort
 end

data/lib/merb-exceptions.rb

@@ -17,13 +17,14 @@ if defined?(Merb::Plugins)
   Merb::BootLoader.after_app_loads do
     if Object.const_defined?(:Exceptions)
       Exceptions.send(:include, MerbExceptions::ExceptionsHelper)
-      if Merb::Plugins.config[:exceptions][:environments].include?(Merb.env)
-        Exceptions.send(:include, MerbExceptions::ControllerExtensions)
-      end
+    end
+    if Merb::Plugins.config[:exceptions][:environments].include?(Merb.env)
+      Merb::Dispatcher::DefaultException.send(:include, MerbExceptions::ExceptionsHelper)
+      Merb::Dispatcher::DefaultException.send(:include, MerbExceptions::DefaultExceptionExtensions)
     end
   end
 
   require 'merb-exceptions/notification'
-  require 'merb-exceptions/controller_extensions'
-  require 'merb-exceptions/exceptions_helper.rb'
+  require 'merb-exceptions/default_exception_extensions'
+  require 'merb-exceptions/exceptions_helper'
 end

data/lib/merb-exceptions/default_exception_extensions.rb

@@ -0,0 +1,9 @@
+module MerbExceptions
+  module DefaultExceptionExtensions
+    def self.included(mod)
+      mod.class_eval do
+        after :notify_of_exceptions
+      end
+    end
+  end
+end

data/lib/merb-exceptions/exceptions_helper.rb

@@ -1,16 +1,32 @@
 module MerbExceptions
   module ExceptionsHelper
     protected
-
-    # renders unless Merb::Plugins.config[:exceptions][:environments]
-    # includes the current environment, in which case it passes any
-    # provided options directly to Merb's render method and then
-    # sends the notification after rendering.
-    def render_and_notify(*opts)
+    # if you need to handle the render yourself for some reason, you can call
+    # this method directly. It sends notifications without any rendering logic.
+    # Note though that if you are sending lots of notifications this could
+    # delay sending a response back to the user so try to avoid using it
+    # where possible.
+    def notify_of_exceptions
       if Merb::Plugins.config[:exceptions][:environments].include?(Merb.env)
-        self.render_then_call(self.render(*opts)) { notify_of_exceptions }
-      else
-        self.render(*opts)
+        begin
+          request = self.request
+
+          details = {}
+          details['exceptions']      = request.exceptions
+          details['params']          = params
+          details['environment']     = request.env.merge( 'process' => $$ )
+          details['url']             = "#{request.protocol}#{request.env["HTTP_HOST"]}#{request.uri}"
+          MerbExceptions::Notification.new(details).deliver!
+        rescue Exception => e
+          exceptions = request.exceptions << e
+          Merb.logger.fatal!("Exception Notification Failed:\n" + (exceptions).inspect)
+          File.open(Merb.root / 'log' / 'notification_errors.log', 'a') do |log|
+            log.puts("Exception Notification Failed:")
+            exceptions.each do |e|
+              log.puts(Merb.exception(e))
+            end
+          end
+        end
       end
     end
 

data/spec/default_exception_extensions_spec.rb

@@ -0,0 +1,16 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe MerbExceptions::DefaultExceptionExtensions do
+
+  before(:each) do
+    Merb::Router.prepare do
+      default_routes
+    end
+  end
+
+  it "should notify_of_exceptions" do
+    MerbExceptions::Notification.should_receive(:new)
+    request("/raise_error/index")
+  end
+
+end

data/spec/exceptions_helper_spec.rb

@@ -0,0 +1,23 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe MerbExceptions::DefaultExceptionExtensions do
+
+  before(:each) do
+    Merb::Router.prepare do
+      default_routes
+    end
+  end
+
+  it "should notify_of_exceptions" do
+    MerbExceptions::Notification.should_receive(:new)
+    request("/not_found/index")
+  end
+
+  it "should log fatal on failure" do
+    MerbExceptions::Notification.should_receive(:new).and_raise(StandardError)
+    with_level(:fatal) do
+      request("/not_found/index")
+    end.should include_log("Exception Notification Failed:")
+  end
+
+end

data/spec/spec_helper.rb

@@ -2,14 +2,82 @@ $:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 require "rubygems"
 require "merb-core"
 require "spec"
-require "merb_exceptions"
+require "merb-exceptions"
 
-# merb-exceptions needs to include itself into this class
-class Exceptions < Merb::Controller; end
+class Application < Merb::Controller
+end
+
+class RaiseError < Application
+  def index
+    raise StandardError, 'Something went wrong'
+  end
+end
+
+class NotFound < Application
+end
+
+class Exceptions < Application
+  after :notify_of_exceptions, :only => :not_found
+
+  def not_found
+    render '404 not found'
+  end
+end
 
 Merb::Plugins.config[:exceptions][:environments] = 'test'
 Merb.start :environment => 'test'
 
+module Merb
+  module Test
+    module RspecMatchers
+      class IncludeLog
+        def initialize(expected)
+          @expected = expected
+        end
+
+        def matches?(target)
+          target.rewind
+          @text = target.read
+          @text =~ (String === @expected ? /#{Regexp.escape @expected}/ : @expected)
+        end
+
+        def failure_message
+          "expected to find `#{@expected}' in the log but got:\n" <<
+          @text.map {|s| "  #{s}" }.join
+        end
+
+        def negative_failure_message
+          "exected not to find `#{@expected}' in the log but got:\n" <<
+          @text.map {|s| "  #{s}" }.join
+        end
+
+        def description
+          "include #{@text} in the log"
+        end
+      end
+
+      def include_log(expected)
+        IncludeLog.new(expected)
+      end
+    end
+  end
+end
+
+Spec::Runner.configure do |config|
+  config.include Merb::Test::ControllerHelper
+  config.include Merb::Test::RequestHelper
+  config.include Merb::Test::RouteHelper
+  config.include Merb::Test::RspecMatchers
+
+  def with_level(level)
+    Merb::Config[:log_stream] = StringIO.new
+    Merb::Config[:log_level] = level
+    Merb.reset_logger!
+    yield
+    Merb::Config[:log_stream]
+  end
+end
+
 module NotificationSpecHelper
   def mock_details(opts={})
     {
@@ -19,7 +87,7 @@ module NotificationSpecHelper
       'url'            => 'http://www.my-app.com/errors/1'
     }.merge(opts)
   end
-  
+
   def mock_merb_config(opts={})
     Merb::Plugins.config[:exceptions].merge!(opts)
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: merb-exceptions
 version: !ruby/object:Gem::Version 
-  version: 0.9.9
+  version: 0.9.10
 platform: ruby
 authors: 
 - Andy Kent
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-10-13 00:00:00 -07:00
+date: 2008-10-21 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.9.9
+        version: 0.9.10
     version: 
 description: Email and web hook exceptions for Merb.
 email: andy@new-bamboo.co.uk
@@ -36,12 +36,14 @@ files:
 - README.markdown
 - Rakefile
 - lib/merb-exceptions
-- lib/merb-exceptions/controller_extensions.rb
+- lib/merb-exceptions/default_exception_extensions.rb
 - lib/merb-exceptions/exceptions_helper.rb
 - lib/merb-exceptions/notification.rb
 - lib/merb-exceptions/templates
 - lib/merb-exceptions/templates/email.erb
 - lib/merb-exceptions.rb
+- spec/default_exception_extensions_spec.rb
+- spec/exceptions_helper_spec.rb
 - spec/notification_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
@@ -66,7 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.2.0
+rubygems_version: 1.3.0
 signing_key: 
 specification_version: 2
 summary: Email and web hook exceptions for Merb.

data/lib/merb-exceptions/controller_extensions.rb

@@ -1,43 +0,0 @@
-module MerbExceptions
-  module ControllerExtensions
-
-    def self.included(mod)
-      mod.class_eval do
-        def base
-          self.render_and_notify template_or_message, :layout=>false
-        end
-
-        def exception
-          self.render_and_notify template_or_message, :layout=>false
-        end
-
-        private
-
-        def template_or_message
-          if File.exists?(Merb.root / 'app' / 'views' / 'exceptions' / 'internal_server_error.html.erb')
-            :internal_server_error
-          else
-            '500 exception. Please customize this page by creating app/views/exceptions/internal_server_error.html.erb.'
-          end
-        end
-      end
-    end
-
-    # if you need to handle the render yourself for some reason, you can call
-    # this method directly. It sends notifications without any rendering logic.
-    # Note though that if you are sending lots of notifications this could
-    # delay sending a response back to the user so try to avoid using it
-    # where possible.
-    def notify_of_exceptions
-      request = self.request
-
-      details = {}
-      details['exceptions']      = request.exceptions
-      details['params']          = params
-      details['environment']     = request.env.merge( 'process' => $$ )
-      details['url']             = "#{request.protocol}#{request.env["HTTP_HOST"]}#{request.uri}"
-      MerbExceptions::Notification.new(details).deliver!
-    end
-
-  end
-end