newbamboo-merb_exceptions 0.1.0

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2008-05-01
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 FIXME full name
+
+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.markdown

@@ -0,0 +1,111 @@
+merb_exceptions
+===============
+A simple Merb plugin to ease exception notifications.
+
+The notifier currently supports two interfaces, Email Alerts and Web Hooks. Emails are formatted as plain text and sent using your Merb environment's mail settings. Web hooks as sent as post requests.
+
+Instead of a messy port of a rails plugin this is a complete rewrite from scratch and so is able to take full advantage of Merb's exception handling functionality.
+
+Getting Going
+-------------
+Once you have the Gem installed you will need to add it as a dependency in your projects `init.rb` file
+
+    dependency 'merb_exceptions'
+
+Configuration goes in `config/plugins.yml` file (which you may need to create). See 'Settings' below for a full description of the options.
+
+    :exceptions:
+      :app_name: My App Name
+      :email_from: exceptions@myapp.com
+      :web_hooks: http://localhost:4000/exceptions
+      :email_addresses: 
+      - user@myapp.com
+      - hello@exceptions.com
+    :environments:
+      - staging
+      - production
+
+The plugin doesn't modify any existing code or do anything particularly magical so you will need to explicitly include it. Just include this module in your `ExceptionsController`.
+
+    include MerbExceptions::ControllerExtensions
+
+If you have specified any email addresses and are not already requiring merb-mailer then you need to do so. It also needs configuration.
+
+    dependency 'merb-mailer'
+
+Settings
+--------
+`web_hooks`, `email_addresses`, and `environments` can either be a single string or an array of strings.
+
+`app_name`: Used to customise emails (default "My App")
+
+`email_from`: Exceptions are sent from this address
+
+`web_hooks`: Each url is sent a post request. See 'Web Hooks' for more info.
+
+`email_addresses`: Each email address is sent an exception notification using Merb's built in mailer settings.
+
+`environments`: Notifications will only be sent for environments in this list, defaults to `production`
+
+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`.
+
+For example to be notified of 404's:
+
+    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.
+
+Web hooks
+---------
+Web hooks are a great way to push your data beyond your app to the outside world. For each address on your `web_hooks` list we will send a HTTP:POST request with the following parameters for you to consume.
+
+`request_url`  
+`request_controller`  
+`request_action`  
+`request_params`  
+`request_status_code`  
+`exception_name`  
+`exception_message`  
+`exception_backtrace`  
+`merb_exception_class`  
+`original_exception_class`  
+`environment`  
+
+Requirements
+------------
+* Edge Merb
+
+Install
+-------
+* `rake install_gem`
+
+Licence
+-------
+(The MIT License)
+
+Copyright (c) 2008 New Bamboo
+
+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/Rakefile

@@ -0,0 +1,11 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+require 'spec/rake/spectask'
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }
+
+  Spec::Rake::SpecTask.new('spec') do |t|
+    t.spec_opts << '--format' << 'specdoc' << '--colour'
+    t.spec_opts << '--loadby' << 'random'
+    t.spec_files = Dir["spec/**/*_spec.rb"]
+  end

data/lib/merb_exceptions.rb

@@ -0,0 +1,13 @@
+unless defined?(Merb::Plugins)
+  raise %q{merb_exceptions says, "Something's not right, bub.  You should run me inside Merb."}
+end
+
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require "merb_exceptions/notification"
+require 'merb_exceptions/controller_extensions'
+
+module MerbExceptions
+  
+end

data/lib/merb_exceptions/controller_extensions.rb

@@ -0,0 +1,32 @@
+module MerbExceptions
+  module ControllerExtensions
+    
+    def self.included(mod)
+      mod.class_eval do
+        def internal_server_error
+          # These two variables are required by the default exception template
+          @exception = self.params[:exception]
+          @exception_name = @exception.name.split("_").map {|x| x.capitalize}.join(" ")
+          self.render_and_notify :layout=>false
+        end
+      end
+    end
+    
+
+    def render_and_notify(opts={})
+      self.render_then_call(render(opts)) { notify_of_exceptions }
+    end
+
+    def notify_of_exceptions
+      exception = self.params[:exception]
+      request = self.request
+      orig_params = self.params[:original_params]
+      details = {}
+      details['exception']       = exception
+      details['params']          = orig_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

data/lib/merb_exceptions/notification.rb

@@ -0,0 +1,122 @@
+require 'net/http'
+require 'uri'
+require "erb"
+
+module MerbExceptions
+  class Notification
+    attr_reader :details
+
+    def initialize(details = {})
+      @details = details
+      @config = {
+        :web_hooks       => [],
+        :email_addresses => [],
+        :app_name        => "Merb Application",
+        :email_from      => "exceptions@app.com",
+        :environments    => ['production']
+      }.merge(Merb::Plugins.config[:exceptions] || {})
+    end
+
+    def deliver!
+      deliver_web_hooks!
+      deliver_emails!
+    end
+
+    def deliver_web_hooks!
+      return unless should_deliver_notifications?
+      Merb.logger.info "DELIVERING EXCEPTION WEB HOOKS"
+      web_hooks.each do |address| 
+        post_hook(address)
+      end
+    end
+
+    def deliver_emails!
+      return unless should_deliver_notifications?
+      Merb.logger.info  "DELIVERING EXCEPTION EMAILS"
+      email_addresses.each do |address| 
+        send_notification_email(address)
+      end
+    end
+
+    def web_hooks; option_as_array(:web_hooks); end
+
+    def email_addresses; option_as_array(:email_addresses); end
+
+    def environments; option_as_array(:environments); end
+
+    def exception
+      @details['exception']
+    end
+    
+    def should_deliver_notifications?
+      environments.include? Merb.env
+    end
+    
+    # this is a horrid hack because I can't find any easy way to get the exceptions class out of Merb
+    # I tried .exception but this seems to recursivly give you Merb exceptions not the original
+    def original_exception_class
+      exception.to_yaml.match(/^exception: !ruby\/exception:(.+)/)[1] rescue 'N/A'
+    end
+    
+    def params
+      {
+        'request_url'              => details['url'],
+        'request_controller'       => details['params'][:controller],
+        'request_action'           => details['params'][:action],
+        'request_params'           => details['params'],
+        'request_status_code'      => exception.class::STATUS,
+        'exception_name'           => exception.name,
+        'exception_message'        => exception.message,
+        'exception_backtrace'      => (exception.backtrace or []).join("\n"),
+        'merb_exception_class'     => exception.class,
+        'original_exception_class' => original_exception_class,
+        'environment'              => details['environment']
+
+      }
+    end
+
+  private
+    
+    def post_hook(address)
+      Merb.logger.info "- hooking to #{address}"
+      uri = URI.parse(address)
+      uri.path = '/' if uri.path=='' # set a path if one isn't provided to keep Net::HTTP happy
+      Net::HTTP.post_form( uri, params ).body
+    end
+    
+    def send_email(address, body)
+      Merb.logger.info "- emailing to #{address}"
+      email = Merb::Mailer.new({
+        :to => address,
+        :from => "#{@config[:app_name]} <#{@config[:email_from]}>",
+        :subject => "[#{@config[:app_name]} EXCEPTION] #{exception.message}",
+        :text => body
+      })
+      email.deliver!
+    end
+    
+    def send_notification_email(address)
+      send_email(address, plain_text_mail_body)
+    end
+
+    def plain_text_mail_body
+      path = File.join(File.dirname(__FILE__), 'templates', 'email.erb')
+      template = ERB.new File.open(path,'r') { |f| f.read }
+      template.result(binding)
+    end
+    
+    # Used so that we can accept either a single value or array (e.g. of 
+    # webhooks) in our YAML file.
+    def option_as_array(option)
+      value = @config[option]
+      case value
+      when Array
+        value.reject { |e| e.nil? } # Don't accept nil values
+      when String
+        [value]
+      else
+        []
+      end
+    end
+  end
+end

data/lib/merb_exceptions/templates/email.erb

@@ -0,0 +1,34 @@
+Woops! Sorry but it looks like something went wrong.
+With any luck the details below will aid you in solving the problem.
+
+
+REQUEST
+--------
+URL: <%= params['request_url'] %>
+Controller: <%= params['request_controller'] %>
+Action:  <%= params['request_action'] %>
+Status Code: <%= params['request_status_code'] %>
+
+
+EXCEPTION
+----------
+Name: <%= params['exception_name'] %>
+Merb Exception Class: <%= params['merb_exception_class'] %>
+Original Exception Class: <%= params['original_exception_class'] %>
+message: <%= params['exception_message'] %>
+
+
+PARAMETERS
+-----------
+<% params['request_params'].each do |key,value| %><%= key %>: <%= value %>
+<% end %>
+
+BACKTRACE
+----------
+<%= params['exception_backtrace'] %>
+
+
+ENVIRONMENT
+------------
+<% params['environment'].each do |key,value| %><%= key %>: <%= value %>
+<% end %>

data/lib/merb_exceptions/version.rb

@@ -0,0 +1,9 @@
+module MerbExceptions #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,47 @@
+require 'rubygems'
+require 'spec'
+require File.dirname(__FILE__) + '/../lib/merb_exceptions'
+
+# Mock out Merb bits that a re required for testing
+module Merb
+  class Plugins
+    def self.config; NotificationSpecHelper.merb_config || {}; end
+  end
+  
+  class Logger
+    def info(msg=''); msg; end
+  end
+  
+  class << self
+    def env; 'production'; end
+    def logger; Logger.new; end
+  end
+end
+
+module NotificationSpecHelper
+  def mock_details(opts={})
+    {
+      'exception'      => {},
+      'params'         => { :controller=>'errors', :action=>'show' },
+      'environment'    => { 'key1'=>'value1', 'key2'=>'value2' },
+      'url'            => 'http://www.my-app.com/errors/1'
+    }.merge(opts)
+  end
+  
+  def default_config
+    {
+      :web_hooks       => [],
+      :email_addresses => [],
+      :app_name        => "Merb Application",
+      :environments    => ['production']
+    }
+  end
+  
+  def mock_merb_config(opts={})
+    NotificationSpecHelper.merb_config = {:exceptions => opts}
+  end
+  
+  class << self
+    attr_accessor :merb_config
+  end
+end

data/spec/unit/notification_spec.rb

@@ -0,0 +1,91 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+include MerbExceptions
+include NotificationSpecHelper
+
+describe MerbExceptions::Notification do
+  describe "#new" do
+    it "should create a new notification without errors" do
+      lambda { Notification.new(mock_details) }.should_not raise_error
+    end
+    
+    it "should set the detail values to those provided" do
+      Notification.new(mock_details).details.should == mock_details
+    end
+    
+    it "should set config defaults when values aren't provided" do
+      config = Notification.new(mock_details).instance_variable_get(:@config)
+      config.should == default_config
+    end
+    
+    it "should allow overriding of default configuration options through the Merb::Plugins.config hash" do
+      opts = { :app_name=>'Testy Mc Testerson', :email_addresses=>['test1@test.com', 'test2@test.com'] }
+      mock_merb_config(opts)
+      config = Notification.new(mock_details).instance_variable_get(:@config)
+      config.should == default_config.merge(opts)
+    end
+  end
+  
+  describe ".deliver!" do
+    before :each do
+      @notification = Notification.new(mock_details)
+      @notification.stub!('deliver_emails!')
+      @notification.stub!('deliver_web_hooks!')
+    end
+    
+    it "should deliver web hooks" do
+      @notification.should_receive('deliver_web_hooks!')
+      @notification.deliver!
+    end
+
+    it "should deliver emails" do
+      @notification.should_receive('deliver_emails!')
+      @notification.deliver!
+    end
+  end
+  
+  describe ".deliver_web_hooks!" do
+    before :each do
+      mock_merb_config({ :web_hooks => ['http://www.test1.com', 'http://www.test2.com'] })
+      @notification = Notification.new(mock_details)
+      @notification.stub!(:post_hook)
+    end
+    
+    it "should call post_hook for each url" do
+      @notification.should_receive(:post_hook).once.with('http://www.test1.com')
+      @notification.should_receive(:post_hook).once.with('http://www.test2.com')
+      @notification.deliver_web_hooks!
+    end
+  end
+
+  describe ".deliver_emails!" do
+    before :each do
+      mock_merb_config({ :email_addresses => ['user1@test.com', 'user2@test.com'] })
+      @notification = Notification.new(mock_details)
+      @notification.stub!(:send_notification_email)
+    end
+
+    it "should call send_notification_email for each address" do
+      @notification.should_receive(:send_notification_email).once.with('user1@test.com')
+      @notification.should_receive(:send_notification_email).once.with('user2@test.com')
+      @notification.deliver_emails!
+    end
+  end
+  
+  describe ".should_deliver_notifications?" do
+    it "should return true if the current environment is on the config[:environments] list of one item" do
+        mock_merb_config({ :environments => 'production' })
+        Notification.new(mock_details).should_deliver_notifications?.should be_true
+    end
+    
+    it "should return true if the current environment is on the config[:environments] list as an array" do
+        mock_merb_config({ :environments => ['staging', 'production'] })
+        Notification.new(mock_details).should_deliver_notifications?.should be_true
+    end
+
+    it "should return false if the current environment is not on the config[:environments] list" do
+        mock_merb_config({ :environments => ['staging', 'development'] })
+        Notification.new(mock_details).should_deliver_notifications?.should be_false
+    end
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: newbamboo-merb_exceptions
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Andy Kent
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-05-12 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Allows Merb to forward exceptions to emails or web hooks
+email: 
+- andy@new-bamboo.co.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- License.txt
+files: 
+- History.txt
+- License.txt
+- README.markdown
+- Rakefile
+- lib/merb_exceptions.rb
+- lib/merb_exceptions/controller_extensions.rb
+- lib/merb_exceptions/notification.rb
+- lib/merb_exceptions/templates/email.erb
+- lib/merb_exceptions/version.rb
+- spec/spec_helper.rb
+- spec/unit/notification_spec.rb
+has_rdoc: true
+homepage: http://github.com/newbamboo/merb_exceptions/
+post_install_message: 
+rdoc_options: 
+- --main
+- README.markdown
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: Allows Merb to forward exceptions to emails or web hooks
+test_files: 
+- spec/unit/notification_spec.rb