captivity 0.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+
+gem "rack"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "jeweler", "~> 1.8.4"
+  gem "rack-test"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Julik Tarkhanov
+
+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.rdoc

@@ -0,0 +1,20 @@
+= captivity
+
+Captivity is a simplistick Rack middleware for capturing and logging exceptions. It is a replacement for the CommonLogger
+middleware which I found lacking and abandoned. It's compatible with any Logger implementation.
+
+== Contributing to captivity
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Julik Tarkhanov. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,38 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+require 'jeweler'
+
+require File.dirname(__FILE__) + "/lib/captivity"
+
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.version = Captivity::VERSION
+  gem.name = "captivity"
+  gem.homepage = "http://github.com/julik/captivity"
+  gem.license = "MIT"
+  gem.summary = %Q{One-line Logger attachment for Rack apps}
+  gem.description = %Q{A simple logging wrapper for Rack}
+  gem.email = "me@julik.nl"
+  gem.authors = ["Julik Tarkhanov"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/captivity.gemspec

@@ -0,0 +1,54 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "captivity"
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Julik Tarkhanov"]
+  s.date = "2012-07-08"
+  s.description = "A simple logging wrapper for Rack"
+  s.email = "me@julik.nl"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "captivity.gemspec",
+    "lib/captivity.rb",
+    "test/helper.rb",
+    "test/test_captivity.rb"
+  ]
+  s.homepage = "http://github.com/julik/captivity"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "One-line Logger attachment for Rack apps"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rack>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_development_dependency(%q<rack-test>, [">= 0"])
+    else
+      s.add_dependency(%q<rack>, [">= 0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_dependency(%q<rack-test>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rack>, [">= 0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    s.add_dependency(%q<rack-test>, [">= 0"])
+  end
+end
+

data/lib/captivity.rb

@@ -0,0 +1,58 @@
+require 'delegate'
+require 'logger'
+require 'rack/commonlogger'
+
+class Captivity
+  VERSION = '0.0.1'
+  
+  # Rack::CommonLogger is so ingeniously put together that
+  # it does not honor the standard logger levels, it uses #write.
+  # The #write method is not even defined on the standard Logger,
+  # so we flee to a delegate which will convert the logs to
+  # info messages
+  class LoggerWithWriteMethod < SimpleDelegator
+    def write(str)
+      info(str)
+    end
+  end
+  
+  def initialize(app, logger_or_stream = STDERR)
+    @logger = configure_logger_or_stream(logger_or_stream)
+    @app = Rack::CommonLogger.new(app, @logger)
+  end
+    
+  # Calls the contained application. The application will receive
+  # the defined Logger object in the "captivity.logger" of the env hash
+  def call(env)
+    env["captivity.logger"] = @logger
+    @app.call(env)
+  rescue StandardError, LoadError, SyntaxError => exception
+    log_exception(exception)
+    # Reraise to display using Rack
+    raise exception
+  end
+  
+  private
+  
+  def log_exception(exception)
+    @logger.fatal(
+      "\t#{exception.class} (#{exception.message}):\n    " +
+      exception.backtrace.join("\n\t\t") +
+      "\n\n"
+    )
+  end
+  
+  def configure_logger_or_stream(logger_or_stream)
+    if logger_or_stream.respond_to?(:warn) && logger_or_stream.respond_to?(:write)
+      logger_or_stream
+    elsif logger_or_stream.respond_to?(:warn)
+      LoggerWithWriteMethod.new(logger_or_stream)
+    elsif logger_or_stream.respond_to?(:write) # IO-ish
+      logger = Logger.new(logger_or_stream)
+      logger.level = Logger::DEBUG
+      configure_logger_or_stream(logger)
+    elsif logger_or_stream.nil?
+      configure_logger_or_stream(STDERR)
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler'
+Bundler.require(:default, :development)
+require 'test/unit'
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'captivity'

data/test/test_captivity.rb

@@ -0,0 +1,37 @@
+require 'helper'
+require "stringio"
+
+ENV['RACK_ENV'] = 'test'
+
+class TestCaptivity < Test::Unit::TestCase
+  include Rack::Test::Methods
+  
+  def app
+    @app
+  end
+  
+  def test_captivity_logs_request_with_io
+    stream = StringIO.new
+    
+    @app = Rack::Builder.app do
+       use Captivity, stream
+       run lambda { |env| [200, {'Content-Type' => 'text/plain'}, 'OK'] }
+    end
+    
+    get '/boom'
+    assert_match /GET \/boom/, stream.string
+  end
+  
+  def test_captivity_logs_request_with_logger_object
+    stream = StringIO.new
+    
+    @app = Rack::Builder.app do
+       use Captivity, Logger.new(stream)
+       run lambda { |env| [200, {'Content-Type' => 'text/plain'}, 'OK'] }
+    end
+    
+    get '/boom'
+    assert_match /GET \/boom/, stream.string
+  end
+  
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: captivity
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Julik Tarkhanov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple logging wrapper for Rack
+email: me@julik.nl
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- captivity.gemspec
+- lib/captivity.rb
+- test/helper.rb
+- test/test_captivity.rb
+homepage: http://github.com/julik/captivity
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1991590435747958573
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: One-line Logger attachment for Rack apps
+test_files: []