rack-exception_notifier 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9bbcffea7a8294e5955073047dac373156125438
+  data.tar.gz: dd3f3a570d8974c93d95108a0bc985e6904b96e0
+SHA512:
+  metadata.gz: cb53f2455e04b8317f10f4f15918263fddc9df5fd5a7bf1e843fab07f479bac7ea06d6d046c78636ee20a12baf531c022975ada05951377ff745e25e9abff585
+  data.tar.gz: 3ff38c7e83cee7cdc410910ee97eed661ba5b2815d2e3310c3703b306694f116508097b9ea335ef622f48a2803d270320b005df7aff68defd07361ed23a2eb21

data/README.md

@@ -0,0 +1,26 @@
+# rack-exception_notifier [![Build Status](https://travis-ci.org/jtdowney/rack-exception_notifier.png?branch=master)](https://travis-ci.org/jtdowney/rack-exception_notifier)
+
+Rack-exception_notifier is a piece of simple rack middleware that will rescue exceptions and send email using the mail gem. This gem is based on Rack::MailExceptions in rack-contrib.
+
+## Usage
+
+First include rack-exception_notifier in your Gemfile:
+
+```ruby
+gem 'rack-exception_notifier'
+```
+
+Next configure the mail gem, by default mail will send email via SMTP to port 25 on localhost. If you would like to change that you can configure the gem according to [their documentation](https://github.com/mikel/mail/).
+
+Then you need to configure rack to use the middleware. Below is an example for sinatra:
+
+```ruby
+use Rack::ExceptionNotifier,
+  :to => 'me@example.com',
+  :from => 'app@example.com',
+  :subject => '[ERROR] %s'
+```
+
+## License
+
+Rack-exception_notifier is released under the [MIT license](http://www.opensource.org/licenses/MIT).

data/lib/rack/exception_notifier.rb

@@ -0,0 +1,73 @@
+module Rack
+  class ExceptionNotifier
+    def initialize(app, options)
+      default_options = {
+        :to => nil,
+        :from => ENV['USER'] || 'rack@localhost',
+        :subject => '[ERROR] %s'
+      }
+      @app = app
+      @options = default_options.merge(options)
+      @template = ERB.new(Template)
+    end
+
+    def call(env)
+      @app.call(env)
+    rescue => e
+      _send_notification(e, env)
+      raise
+    end
+
+    def _send_notification(exception, env)
+      mail = Mail.new
+      mail.to(@options[:to])
+      mail.from(@options[:from])
+      mail.subject(@options[:subject] % [exception.to_s])
+      mail.body(@template.result(binding))
+      mail.deliver!
+    end
+
+    def _extract_body(env)
+      io = env['rack.input']
+      io.rewind if io.respond_to?(:rewind)
+      contents = io.read
+      if contents.empty?
+        false
+      else
+        contents
+      end
+    end
+
+    Template = (<<-'EMAIL').gsub(/^ {4}/, '')
+    A <%= exception.class.to_s %> occured: <%= exception.to_s %>
+    <% if body = _extract_body(env) %>
+
+    ===================================================================
+    Request Body:
+    ===================================================================
+
+    <%= body.gsub(/^/, '  ') %>
+    <% end %>
+
+    ===================================================================
+    Rack Environment:
+    ===================================================================
+
+      PID:                     <%= $$ %>
+      PWD:                     <%= Dir.getwd %>
+
+      <%= env.to_a.
+        sort{|a,b| a.first <=> b.first}.
+        map{ |k,v| "%-25s%p" % [k+':', v] }.
+        join("\n  ") %>
+
+    <% if exception.respond_to?(:backtrace) %>
+    ===================================================================
+    Backtrace:
+    ===================================================================
+
+      <%= exception.backtrace.join("\n  ") %>
+    <% end %>
+    EMAIL
+  end
+end

data/lib/rack/exception_notifier/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class ExceptionNotifier
+    VERSION = '0.1.0'
+  end
+end

data/spec/lib/rack/exception_notifier_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe Rack::ExceptionNotifier do
+  before(:each) do
+    Mail::TestMailer.deliveries.clear
+  end
+
+  let(:good_app) { lambda { |env| [200, {}, ['']] } }
+  let(:bad_app) { lambda { |env| raise TestError, 'Test Message' } }
+  let(:env) { Rack::MockRequest.env_for("/foo", :method => 'GET') }
+  let(:env_with_body) { Rack::MockRequest.env_for("/foo", :method => 'POST', :input => StringIO.new('somethingspecial')) }
+
+  describe 'call' do
+    it 'does not send mail on success' do
+      notifier = Rack::ExceptionNotifier.new(good_app, :to => 'bar@example.com', :from => 'noreply@example.com', :subject => 'testing - %s')
+      notifier.call(env)
+      Mail::TestMailer.deliveries.should be_empty
+    end
+
+    it 'sends mail on exceptions' do
+      notifier = Rack::ExceptionNotifier.new(bad_app, :to => 'bar@example.com', :from => 'noreply@example.com', :subject => 'testing - %s')
+      expect do
+        notifier.call(env)
+      end.to raise_error(TestError)
+
+      mail = Mail::TestMailer.deliveries.first
+      mail.to.should == ['bar@example.com']
+      mail.from.should == ['noreply@example.com']
+      mail.subject.should == 'testing - Test Message'
+      mail.body.raw_source.should_not include('Request Body')
+    end
+
+    it 'sends mail as user by default' do
+      notifier = Rack::ExceptionNotifier.new(bad_app, :to => 'bar@example.com', :subject => 'testing - %s')
+      expect do
+        notifier.call(env)
+      end.to raise_error(TestError)
+
+      mail = Mail::TestMailer.deliveries.first
+      mail.from.should == [ENV['USER']]
+    end
+
+    it 'includes the body' do
+      notifier = Rack::ExceptionNotifier.new(bad_app, :to => 'bar@example.com', :from => 'noreply@example.com', :subject => 'testing - %s')
+      expect do
+        notifier.call(env_with_body)
+      end.to raise_error(TestError)
+
+      mail = Mail::TestMailer.deliveries.first
+      mail.body.raw_source.should include('somethingspecial')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'mail'
+require 'rack/exception_notifier'
+require 'rack/mock'
+
+Mail.defaults do
+  delivery_method :test
+end
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.order = 'random'
+end
+
+class TestError < StandardError
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: rack-exception_notifier
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- John Downey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.5.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.5.3
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.3
+description: Rack middleware to send email when exceptions are raised
+email:
+- jdowney@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rack/exception_notifier/version.rb
+- lib/rack/exception_notifier.rb
+- spec/lib/rack/exception_notifier_spec.rb
+- spec/spec_helper.rb
+- README.md
+homepage: http://github.com/jtdowney/rack-exception_notifier
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.1
+signing_key: 
+specification_version: 4
+summary: Rack middleware to send email when exceptions are raised
+test_files:
+- spec/lib/rack/exception_notifier_spec.rb
+- spec/spec_helper.rb