low 0.0.16 → 0.0.17

data/lib/low/rack/exceptions.rb

@@ -0,0 +1,42 @@
+require 'low'
+
+module Low
+  module Rack
+
+    # +Low::Rack::Exceptions+ is like +Rack::ShowExceptions+, except it will
+    # only actually respond with the stack trace when give permission to. Also,
+    # it don't do HTML.
+    class Exceptions
+
+      def initialize(app, opts = {})
+        @app = app
+        @logger_key = opts[:logger_key] || Low::DEFAULT_LOGGER_KEY
+      end
+
+      def call(env)
+        @app.call(env)
+      rescue => exception
+
+        # Format the exception trace
+        trace = exception.message + "\n" + exception.backtrace.join("\n")
+
+        # and log it, if we have a logger, or raw IO.
+        if logger = env[@logger_key]
+          logger.fatal trace
+        elsif io = env['rack.errors']
+          io.puts(trace)
+          io.flush
+        end
+
+        # Respond with the trace if appropriate.
+        if env['low.show_exceptions']
+          message = trace
+        else
+          message = 'An internal server error occurred.'
+        end
+
+        [500, {'Content-Type' => 'text/plain'}, [message]]
+      end
+    end
+  end
+end

data/lib/low/rack/request_logger.rb

@@ -1,4 +1,5 @@
 require 'logger'
+require 'low'
 require 'low/scoped_logger'
 
 module Low
@@ -11,7 +12,7 @@ module Low
 
       def initialize(app, opts = {})
         @app = app
-        @key = opts[:key] || DEFAULT_KEY
+        @key = opts[:key] || Low::DEFAULT_LOGGER_KEY
       end
 
       def call(env)

data/lib/low/version.rb

@@ -1,3 +1,3 @@
 module Low
-  VERSION = '0.0.16'
+  VERSION = '0.0.17'
 end

data/lib/low.rb

@@ -3,4 +3,5 @@ $:.push File.dirname(__FILE__)
 require 'low/version'
 
 module Low
+  DEFAULT_LOGGER_KEY = 'rack.logger'
 end

data/spec/low/rack/exceptions_spec.rb

@@ -0,0 +1,71 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+require 'rack/mock'
+
+require 'low/rack/exceptions'
+require 'low/scoped_logger'
+
+describe Low::Rack::Exceptions do
+
+  it 'should proxy successful calls transparently' do
+    base = lambda do |env|
+      [200, {'Content-Type' => 'text/plain'}, ['No Problems!']]
+    end
+    app = Low::Rack::Exceptions.new(base)
+
+    response = Rack::MockRequest.new(app).get('http://low.edu')
+    response.should be_ok
+    response.body.should == 'No Problems!'
+  end
+
+  it 'should log a stack trace to rack.logger when an error occurs' do
+    base = lambda { |env| raise 'gurp' }
+    app = Low::Rack::Exceptions.new(base)
+    io = StringIO.new
+
+    app.call('rack.logger' => Low::ScopedLogger.new(io))
+    io.rewind
+    lines = io.read.split("\n")
+    lines.length.should be > 5
+    lines.first.should =~ /gurp/
+  end
+
+  it 'should log a stack trace to rack.errors when an error occurs, and ' +
+     'rack.logger is not specified' do
+    base = lambda { |env| raise 'gurp' }
+    app = Low::Rack::Exceptions.new(base)
+    io = StringIO.new
+
+    app.call('rack.errors' => io)
+    io.rewind
+    lines = io.read.split("\n")
+    lines.length.should be > 5
+    lines.first.should =~ /gurp/
+  end
+
+  it 'should respond with a 500 when an error occurs' do
+    base = lambda { |env| raise 'blurp' }
+    app = Low::Rack::Exceptions.new(base)
+
+    response = Rack::MockRequest.new(app).get('http://low.edu')
+    response.status.should == 500
+  end
+
+  it 'should include the trace in the response if low.show_exceptions is true' do
+    base = lambda { |env| raise 'glerb' }
+    app = Low::Rack::Exceptions.new(base)
+
+    response = app.call('low.show_exceptions' => true)
+    lines = response[2].first.split("\n")
+    lines.length.should be > 5
+    lines.first.should =~ /glerb/
+  end
+
+  it 'should show a generic message if low.show_exceptions is falsey' do
+    base = lambda { |env| raise 'glorp' }
+    app = Low::Rack::Exceptions.new(base)
+
+    response = app.call({})
+    response[2].first.should == 'An internal server error occurred.'
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: low
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.17
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-21 00:00:00.000000000 Z
+date: 2013-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -109,6 +109,7 @@ files:
 - lib/low/mongo.rb
 - lib/low/mongo/heroku.rb
 - lib/low/mongo/util.rb
+- lib/low/rack/exceptions.rb
 - lib/low/rack/log_level.rb
 - lib/low/rack/rack_errors.rb
 - lib/low/rack/request_id.rb
@@ -119,6 +120,7 @@ files:
 - low.gemspec
 - spec/low/mongo/util_spec.rb
 - spec/low/mongo_spec.rb
+- spec/low/rack/exceptions_spec.rb
 - spec/low/rack/log_level_spec.rb
 - spec/low/rack/rack_errors_spec.rb
 - spec/low/rack/request_id_spec.rb
@@ -153,6 +155,7 @@ summary: A low-level utility library.
 test_files:
 - spec/low/mongo/util_spec.rb
 - spec/low/mongo_spec.rb
+- spec/low/rack/exceptions_spec.rb
 - spec/low/rack/log_level_spec.rb
 - spec/low/rack/rack_errors_spec.rb
 - spec/low/rack/request_id_spec.rb