rack-exception_notifier 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c74dd74a2958cfa551a3ef9b173147e027b35f2
-  data.tar.gz: 3d83cd0869babccda39cac01dfdb4f84737a77ee
+  metadata.gz: d74186879da5241fb7327492cb6374f6b5172360
+  data.tar.gz: f2c670e0354515d0ed102d6c7c874ec4fd74194a
 SHA512:
-  metadata.gz: bc17a8caf8ffd765ac0cc0a41f9870b6257782618e2e1163e11ae7a30721af061103c478b9713c21e31b12aa91ae5e02b1504b6cebb7d4e2121268f38cd88c93
-  data.tar.gz: 7beefdccac76e1ec1f84152673334916b0d9559a95cbe456e54a43ce6276d178d4f7176b00cfc661aab99cb6959c5cc6f16810fbce771c729331556b35d8540e
+  metadata.gz: 9a5c62ac24cb6a9cf0d63472119caf7fdd847f9b001621aa3a9451e94ce4b2b5dc4421456d2bc5fff60923524e57a78c768743b40c2d16e0249ebcae94448d4e
+  data.tar.gz: 6a4de62c65be5c9ce3a4c139209a00e8fff01dd552857d048c85e5e44852efa1546a61cda1c61035fd4cfdc32cf97859943a0b66c6477e792b6c6ddf88e4583e

data/README.md

@@ -22,6 +22,13 @@ use Rack::ExceptionNotifier,
   :subject => '[ERROR] %s'
 ```
 
+## Options
+
+* `:to` - destination for email exceptions (required)
+* `:from` - address to originate email exceptions from (default: running username)
+* `:subject` - subject line for emails, %s will be interpolated with the exception #to_s (default: [ERROR] %s)
+* `:include_body` - should the body of the request be included in the email (default: false)
+
 ## License
 
 Rack-exception_notifier is released under the [MIT license](http://www.opensource.org/licenses/MIT).

data/lib/rack/exception_notifier.rb

@@ -7,11 +7,16 @@ module Rack
       default_options = {
         :to => nil,
         :from => ENV['USER'] || 'rack@localhost',
-        :subject => '[ERROR] %s'
+        :subject => '[ERROR] %s',
+        :include_body => false
       }
       @app = app
       @options = default_options.merge(options)
       @template = ERB.new(Template)
+
+      if @options[:to].nil?
+        raise ArgumentError.new('to address is required')
+      end
     end
 
     def call(env)
@@ -30,26 +35,29 @@ module Rack
       mail.deliver!
     end
 
+    def _body_present?(env)
+      env['rack.input'].size > 0
+    end
+
+    def _render_body?(env)
+      _body_present?(env) && @options[:include_body]
+    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
+      io.read
     end
 
     Template = (<<-'EMAIL').gsub(/^ {4}/, '')
     A <%= exception.class.to_s %> occured: <%= exception.to_s %>
-    <% if body = _extract_body(env) %>
+    <% if _render_body?(env) %>
 
     ===================================================================
     Request Body:
     ===================================================================
 
-    <%= body.gsub(/^/, '  ') %>
+    <%= _extract_body(env).gsub(/^/, '  ') %>
     <% end %>
 
     ===================================================================

data/lib/rack/exception_notifier/version.rb

@@ -1,5 +1,5 @@
 module Rack
   class ExceptionNotifier
-    VERSION = '0.2.0'
+    VERSION = '0.3.0'
   end
 end

data/spec/lib/rack/exception_notifier_spec.rb

@@ -10,6 +10,14 @@ describe Rack::ExceptionNotifier do
   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 'initialize' do
+    it 'requires a to option' do
+      expect do
+        Rack::ExceptionNotifier.new(good_app, {})
+      end.to raise_error(ArgumentError, 'to address is required')
+    end
+  end
+
   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')
@@ -27,7 +35,6 @@ describe Rack::ExceptionNotifier do
       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
@@ -40,13 +47,34 @@ describe Rack::ExceptionNotifier do
       mail.from.should == [ENV['USER']]
     end
 
-    it 'includes the body' do
+    it 'does not include body by default' 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_not include('Request Body')
+    end
+
+    it 'does not include body if not present in request' do
+      notifier = Rack::ExceptionNotifier.new(bad_app, :to => 'bar@example.com', :from => 'noreply@example.com', :subject => 'testing - %s', :include_body => true)
+      expect do
+        notifier.call(env)
+      end.to raise_error(TestError)
+
+      mail = Mail::TestMailer.deliveries.first
+      mail.body.raw_source.should_not include('Request Body')
+    end
+
+    it 'includes the body if configured' do
+      notifier = Rack::ExceptionNotifier.new(bad_app, :to => 'bar@example.com', :from => 'noreply@example.com', :subject => 'testing - %s', :include_body => true)
+      expect do
+        notifier.call(env_with_body)
+      end.to raise_error(TestError)
+
+      mail = Mail::TestMailer.deliveries.first
+      mail.body.raw_source.should include('somethingspecial')
       mail.body.raw_source.should include('somethingspecial')
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-exception_notifier
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - John Downey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-12 00:00:00.000000000 Z
+date: 2013-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mail