rtomayko-rack-contrib 0.4.0

data/COPYING

@@ -0,0 +1,18 @@
+Copyright (c) 2008 The Committers
+
+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 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,54 @@
+= Contributed Rack Middleware and Utilities
+
+This package includes a variety of add-on components for Rack, a Ruby web server
+interface:
+
+* Rack::ETag - Automatically sets the ETag header on all String bodies.
+* Rack::JSONP - Adds JSON-P support by stripping out the callback param
+  and padding the response with the appropriate callback format.
+* Rack::LighttpdScriptNameFix - Fixes how lighttpd sets the SCRIPT_NAME
+  and PATH_INFO variables in certain configurations.
+* Rack::Locale - Detects the client locale using the Accept-Language request
+  header and sets a rack.locale variable in the environment.
+* Rack::MailExceptions - Rescues exceptions raised from the app and
+  sends a useful email with the exception, stacktrace, and contents of the
+  environment.
+* Rack::PostBodyContentTypeParser - Adds support for JSON request bodies. The
+  Rack parameter hash is populated by deserializing the JSON data provided in
+  the request body when the Content-Type is application/json.
+* Rack::Profiler - Uses ruby-prof to measure request time.
+* Rack::Sendfile - Enables X-Sendfile support for bodies that can be served
+  from file.
+* Rack::TimeZone - Detects the clients timezone using JavaScript and sets
+  a variable in Rack's environment with the offset from UTC.
+
+=== Use
+
+Git is the quickest way to the rack-contrib sources:
+
+  git clone git://github.com/rtomayko/rack-contrib.git
+
+Gems are currently available from GitHub clones:
+
+  gem install rtomayko-rack-contrib --source=http://gems.github.com/
+
+Requiring 'rack/contrib' will add autoloads to the Rack modules for all of the
+components included. The following example shows what a simple rackup
+(+config.ru+) file might look like:
+
+  require 'rack'
+  require 'rack/contrib'
+
+  use Rack::Profiler if ENV['RACK_ENV'] == 'development'
+
+  use Rack::ETag
+  use Rack::MailExceptions
+
+  run theapp
+
+=== Links
+
+rack-contrib on GitHub:: <http://github.com/rtomayko/rack-contrib>
+Rack:: <http://rack.rubyforge.org/>
+Rack On GitHub:: <http://github.org/chneukirchen/rack>
+rack-devel mailing list:: <http://groups.google.com/group/rack-devel>

data/Rakefile

@@ -0,0 +1,84 @@
+# Rakefile for Rack::Contrib.  -*-ruby-*-
+require 'rake/rdoctask'
+require 'rake/testtask'
+
+desc "Run all the tests"
+task :default => [:test]
+
+desc "Generate RDox"
+task "RDOX" do
+  sh "specrb -Ilib:test -a --rdox >RDOX"
+end
+
+desc "Run all the fast tests"
+task :test do
+  sh "specrb -Ilib:test -w #{ENV['TEST'] || '-a'} #{ENV['TESTOPTS']}"
+end
+
+desc "Run all the tests"
+task :fulltest do
+  sh "specrb -Ilib:test -w #{ENV['TEST'] || '-a'} #{ENV['TESTOPTS']}"
+end
+
+desc "Generate RDoc documentation"
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.options << '--line-numbers' << '--inline-source' <<
+    '--main' << 'README' <<
+    '--title' << 'Rack Contrib Documentation' <<
+    '--charset' << 'utf-8'
+  rdoc.rdoc_dir = "doc"
+  rdoc.rdoc_files.include 'README.rdoc'
+  rdoc.rdoc_files.include 'RDOX'
+  rdoc.rdoc_files.include('lib/rack/*.rb')
+  rdoc.rdoc_files.include('lib/rack/*/*.rb')
+end
+task :rdoc => ["RDOX"]
+
+
+# PACKAGING =================================================================
+
+# load gemspec like github's gem builder to surface any SAFE issues.
+require 'rubygems/specification'
+$spec = eval(File.read('rack-contrib.gemspec'))
+
+def package(ext='')
+  "pkg/rack-contrib-#{$spec.version}" + ext
+end
+
+desc 'Build packages'
+task :package => %w[.gem .tar.gz].map {|e| package(e)}
+
+desc 'Build and install as local gem'
+task :install => package('.gem') do
+  sh "gem install #{package('.gem')}"
+end
+
+directory 'pkg/'
+
+file package('.gem') => %w[pkg/ rack-contrib.gemspec] + $spec.files do |f|
+  sh "gem build rack-contrib.gemspec"
+  mv File.basename(f.name), f.name
+end
+
+file package('.tar.gz') => %w[pkg/] + $spec.files do |f|
+  sh "git archive --format=tar HEAD | gzip > #{f.name}"
+end
+
+# GEMSPEC ===================================================================
+
+file 'rack-contrib.gemspec' => FileList['{lib,test}/**','Rakefile', 'README.rdoc'] do |f|
+  # read spec file and split out manifest section
+  spec = File.read(f.name)
+  parts = spec.split("  # = MANIFEST =\n")
+  fail 'bad spec' if parts.length != 3
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").sort.reject{ |file| file =~ /^\./ }.
+    map{ |file| "    #{file}" }.join("\n")
+  # piece file back together and write...
+  parts[1] = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = parts.join("  # = MANIFEST =\n")
+  spec.sub!(/s.date = '.*'/, "s.date = '#{Time.now.strftime("%Y-%m-%d")}'")
+  File.open(f.name, 'w') { |io| io.write(spec) }
+  puts "updated #{f.name}"
+end

data/lib/rack/contrib.rb

@@ -0,0 +1,18 @@
+require 'rack'
+module Rack
+  module Contrib
+    def self.release
+      "0.4"
+    end
+  end
+
+  autoload :ETag,                       "rack/etag"
+  autoload :JSONP,                      "rack/jsonp"
+  autoload :LighttpdScriptNameFix,      "rack/lighttpd_script_name_fix"
+  autoload :Locale,                     "rack/locale"
+  autoload :MailExceptions,             "rack/mailexceptions"
+  autoload :PostBodyContentTypeParser,  "rack/post_body_content_type_parser"
+  autoload :Profiler,                   "rack/profiler"
+  autoload :Sendfile,                   "rack/sendfile"
+  autoload :TimeZone,                   "rack/time_zone"
+end

data/lib/rack/etag.rb

@@ -0,0 +1,20 @@
+require 'digest/md5'
+
+module Rack
+  # Automatically sets the ETag header on all String bodies
+  class ETag
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      status, headers, body = @app.call(env)
+
+      if !headers.has_key?('ETag') && body.is_a?(String)
+        headers['ETag'] = %("#{Digest::MD5.hexdigest(body)}")
+      end
+
+      [status, headers, body]
+    end
+  end
+end

data/lib/rack/jsonp.rb

@@ -0,0 +1,38 @@
+module Rack
+  
+  # A Rack middleware for providing JSON-P support.
+  # 
+  # Full credit to Flinn Mueller (http://actsasflinn.com/) for this contribution.
+  # 
+  class JSONP
+    
+    def initialize(app)
+      @app = app
+    end
+    
+    # Proxies the request to the application, stripping out the JSON-P callback
+    # method and padding the response with the appropriate callback format.
+    # 
+    # Changes nothing if no <tt>callback</tt> param is specified.
+    # 
+    def call(env)
+      status, headers, response = @app.call(env)
+      request = Rack::Request.new(env)
+      response = pad(request.params.delete('callback'), response) if request.params.include?('callback')
+      [status, headers, response]
+    end
+    
+    # Pads the response with the appropriate callback format according to the
+    # JSON-P spec/requirements.
+    # 
+    # The Rack response spec indicates that it should be enumerable. The method
+    # of combining all of the data into a sinle string makes sense since JSON
+    # is returned as a full string.
+    # 
+    def pad(callback, response, body = "")
+      response.each{ |s| body << s }
+      "#{callback}(#{body})"
+    end
+    
+  end
+end

data/lib/rack/lighttpd_script_name_fix.rb

@@ -0,0 +1,16 @@
+module Rack
+  # Lighttpd sets the wrong SCRIPT_NAME and PATH_INFO if you mount your
+  # FastCGI app at "/". This middleware fixes this issue.
+
+  class LighttpdScriptNameFix
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      env["PATH_INFO"] = env["SCRIPT_NAME"].to_s + env["PATH_INFO"].to_s
+      env["SCRIPT_NAME"] = ""
+      @app.call(env)
+    end
+  end
+end

data/lib/rack/locale.rb

@@ -0,0 +1,31 @@
+require 'i18n'
+
+module Rack
+  class Locale
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      old_locale = I18n.locale
+      locale = nil
+
+      # http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.4
+      if lang = env["HTTP_ACCEPT_LANGUAGE"]
+        lang = lang.split(",").map { |l|
+          l += ';q=1.0' unless l =~ /;q=\d+\.\d+$/
+          l.split(';q=')
+        }.first
+        locale = lang.first.split("-").first
+      else
+        locale = I18n.default_locale
+      end
+
+      locale = env['rack.locale'] = I18n.locale = locale.to_s
+      status, headers, body = @app.call(env)
+      headers['Content-Language'] = locale
+      I18n.locale = old_locale
+      [status, headers, body]
+    end
+  end
+end

data/lib/rack/mailexceptions.rb

@@ -0,0 +1,120 @@
+require 'net/smtp'
+require 'tmail'
+require 'erb'
+
+module Rack
+  # Catches all exceptions raised from the app it wraps and
+  # sends a useful email with the exception, stacktrace, and
+  # contents of the environment.
+
+  class MailExceptions
+    attr_reader :config
+
+    def initialize(app)
+      @app = app
+      @config = {
+        :to      => nil,
+        :from    => ENV['USER'] || 'rack',
+        :subject => '[exception] %s',
+        :smtp    => {
+          :server         => 'localhost',
+          :domain         => 'localhost',
+          :port           => 25,
+          :authentication => :login,
+          :user_name      => nil,
+          :password       => nil
+        }
+      }
+      @template = ERB.new(TEMPLATE)
+      yield self if block_given?
+    end
+
+    def call(env)
+      status, headers, body =
+        begin
+          @app.call(env)
+        rescue => boom
+          # TODO don't allow exceptions from send_notification to
+          # propogate
+          send_notification boom, env
+          raise
+        end
+      send_notification env['mail.exception'], env if env['mail.exception']
+      [status, headers, body]
+    end
+
+    %w[to from subject].each do |meth|
+      define_method(meth) { |value| @config[meth.to_sym] = value }
+    end
+
+    def smtp(settings={})
+      @config[:smtp].merge! settings
+    end
+
+  private
+    def generate_mail(exception, env)
+      mail = TMail::Mail.new
+      mail.to = Array(config[:to])
+      mail.from = config[:from]
+      mail.subject = config[:subject] % [exception.to_s]
+      mail.date = Time.now
+      mail.set_content_type 'text/plain'
+      mail.charset = 'UTF-8'
+      mail.body = @template.result(binding)
+      mail
+    end
+
+    def send_notification(exception, env)
+      mail = generate_mail(exception, env)
+      smtp = config[:smtp]
+      env['mail.sent'] = true
+      return if smtp[:server] == 'example.com'
+
+      Net::SMTP.start smtp[:address], smtp[:port], smtp[:domain], smtp[:user_name], smtp[:password], smtp[:authentication] do |server|
+        mail.to.each do |recipient|
+          server.send_message mail.to_s, mail.from, recipient
+        end
+      end
+    end
+
+    def extract_body(env)
+      if io = env['rack.input']
+        io.rewind if io.respond_to?(:rewind)
+        io.read
+      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/post_body_content_type_parser.rb

@@ -0,0 +1,40 @@
+begin
+  require 'json'
+rescue LoadError => e
+  require 'json/pure'
+end
+
+module Rack
+  
+  # A Rack middleware for parsing POST/PUT body data when Content-Type is
+  # not one of the standard supported types, like <tt>application/json</tt>.
+  # 
+  # TODO: Find a better name.
+  # 
+  class PostBodyContentTypeParser
+    
+    # Constants
+    # 
+    CONTENT_TYPE = 'CONTENT_TYPE'.freeze
+    POST_BODY = 'rack.input'.freeze
+    FORM_INPUT = 'rack.request.form_input'.freeze
+    FORM_HASH = 'rack.request.form_hash'.freeze
+    
+    # Supported Content-Types
+    # 
+    APPLICATION_JSON = 'application/json'.freeze
+    
+    def initialize(app)
+      @app = app
+    end
+    
+    def call(env)
+      case env[CONTENT_TYPE]
+      when APPLICATION_JSON
+        env.update(FORM_HASH => JSON.parse(env[POST_BODY].read), FORM_INPUT => env[POST_BODY])
+      end
+      @app.call(env)
+    end
+    
+  end
+end

data/lib/rack/profiler.rb

@@ -0,0 +1,80 @@
+gem 'ruby-prof', '>= 0.7.1'
+require 'ruby-prof'
+require 'set'
+
+module Rack
+  # Set the profile=process_time query parameter to download a
+  # calltree profile of the request.
+  class Profiler
+    MODES = %w(
+      process_time
+      wall_time
+      cpu_time
+      allocations
+      memory
+      gc_runs
+      gc_time
+    ).to_set
+
+    PRINTER_CONTENT_TYPE = {
+      RubyProf::FlatPrinter => 'text/plain',
+      RubyProf::GraphPrinter => 'text/plain',
+      RubyProf::GraphHtmlPrinter => 'text/html',
+      RubyProf::CallTreePrinter => 'application/octet-stream'
+    }
+
+    def initialize(app, printer = RubyProf::GraphHtmlPrinter)
+      @app = app
+      @printer = printer
+    end
+
+    def call(env)
+      if mode = profiling?(env)
+        profile(env, mode)
+      else
+        @app.call(env)
+      end
+    end
+
+    private
+      def profiling?(env)
+        unless RubyProf.running?
+          request = Rack::Request.new(env)
+          if mode = request.params.delete('profile')
+            if MODES.include?(mode)
+              mode
+            else
+              env['rack.errors'].write "Invalid RubyProf measure_mode: " +
+                "#{mode}. Use one of #{MODES.to_a.join(', ')}"
+              false
+            end
+          end
+        end
+      end
+
+      def profile(env, mode)
+        RubyProf.measure_mode = RubyProf.const_get(mode.upcase)
+        result = RubyProf.profile { @app.call(env) }
+        headers = headers(@printer, env, mode)
+        body = print(@printer, result)
+        [200, headers, body]
+      end
+
+      def print(printer, result)
+        body = StringIO.new
+        printer.new(result).print(body, :min_percent => 0.01)
+        body.rewind
+        body
+      end
+
+      def headers(printer, env, mode)
+        headers = { 'Content-Type' => PRINTER_CONTENT_TYPE[printer] }
+        if printer == RubyProf::CallTreePrinter
+          filename = ::File.basename(env['PATH_INFO'])
+          headers['Content-Disposition'] = "attachment; " +
+            "filename=\"#{filename}.#{mode}.tree\")"
+        end
+        headers
+      end
+  end
+end

data/lib/rack/sendfile.rb

@@ -0,0 +1,142 @@
+require 'rack/file'
+
+module Rack
+  class File #:nodoc:
+    alias :to_path :path
+  end
+
+  # = Sendfile
+  #
+  # The Sendfile middleware intercepts responses whose body is being
+  # served from a file and replaces it with a server specific X-Sendfile
+  # header. The web server is then responsible for writing the file contents
+  # to the client. This can dramatically reduce the amount of work required
+  # by the Ruby backend and takes advantage of the web servers optimized file
+  # delivery code.
+  #
+  # In order to take advantage of this middleware, the response body must
+  # respond to +to_path+ and the request must include an X-Sendfile-Type
+  # header. Rack::File and other components implement +to_path+ so there's
+  # rarely anything you need to do in your application. The X-Sendfile-Type
+  # header is typically set in your web servers configuration. The following
+  # sections attempt to document
+  #
+  # === Nginx
+  #
+  # Nginx supports the X-Accel-Redirect header. This is similar to X-Sendfile
+  # but requires parts of the filesystem to be mapped into a private URL
+  # hierarachy.
+  #
+  # The following example shows the Nginx configuration required to create
+  # a private "/files/" area, enable X-Accel-Redirect, and pass the special
+  # X-Sendfile-Type and X-Accel-Mapping headers to the backend:
+  #
+  #   location /files/ {
+  #     internal;
+  #     alias /var/www/;
+  #   }
+  #
+  #   location / {
+  #     proxy_redirect     false;
+  #
+  #     proxy_set_header   Host                $host;
+  #     proxy_set_header   X-Real-IP           $remote_addr;
+  #     proxy_set_header   X-Forwarded-For     $proxy_add_x_forwarded_for;
+  #
+  #     proxy_set_header   X-Sendfile-Type     X-Accel-Redirect
+  #     proxy_set_header   X-Accel-Mapping     /files/=/var/www/;
+  #
+  #     proxy_pass         http://127.0.0.1:8080/;
+  #   }
+  #
+  # Note that the X-Sendfile-Type header must be set exactly as shown above. The
+  # X-Accel-Mapping header should specify the name of the private URL pattern,
+  # followed by an equals sign (=), followed by the location on the file system
+  # that it maps to. The middleware performs a simple substitution on the
+  # resulting path.
+  #
+  # See Also: http://wiki.codemongers.com/NginxXSendfile
+  #
+  # === lighttpd
+  #
+  # Lighttpd has supported some variation of the X-Sendfile header for some
+  # time, although only recent version support X-Sendfile in a reverse proxy
+  # configuration.
+  #
+  #   $HTTP["host"] == "example.com" {
+  #      proxy-core.protocol = "http"
+  #      proxy-core.balancer = "round-robin"
+  #      proxy-core.backends = (
+  #        "127.0.0.1:8000",
+  #        "127.0.0.1:8001",
+  #        ...
+  #      )
+  #
+  #      proxy-core.allow-x-sendfile = "enable"
+  #      proxy-core.rewrite-request = (
+  #        "X-Sendfile-Type" => (".*" => "X-Sendfile")
+  #      )
+  #    }
+  #
+  # See Also: http://redmine.lighttpd.net/wiki/lighttpd/Docs:ModProxyCore
+  #
+  # === Apache
+  #
+  # X-Sendfile is supported under Apache 2.x using a separate module:
+  #
+  # http://tn123.ath.cx/mod_xsendfile/
+  #
+  # Once the module is compiled and installed, you can enable it using
+  # XSendFile config directive:
+  #
+  #   RequestHeader Set X-Sendfile-Type X-Sendfile
+  #   ProxyPassReverse / http://localhost:8001/
+  #   XSendFile on
+
+  class Sendfile
+    F = ::File
+
+    def initialize(app, variation=nil)
+      @app = app
+      @variation = variation
+    end
+
+    def call(env)
+      status, headers, body = @app.call(env)
+      if body.respond_to?(:to_path)
+        case type = variation(env)
+        when 'X-Accel-Redirect'
+          path = F.expand_path(body.to_path)
+          if url = map_accel_path(env, path)
+            headers[type] = url
+            body = []
+          else
+            env['rack.errors'] << "X-Accel-Mapping header missing"
+          end
+        when 'X-Sendfile', 'X-Lighttpd-Send-File'
+          path = F.expand_path(body.to_path)
+          headers[type] = path
+          body = []
+        when '', nil
+        else
+          env['rack.errors'] << "Unknown x-sendfile variation: '#{variation}'.\n"
+        end
+      end
+      [status, headers, body]
+    end
+
+  private
+    def variation(env)
+      @variation ||
+        env['sendfile.type'] ||
+        env['HTTP_X_SENDFILE_TYPE']
+    end
+
+    def map_accel_path(env, file)
+      if mapping = env['HTTP_X_ACCEL_MAPPING']
+        internal, external = mapping.split('=', 2).map{ |p| p.strip }
+        file.sub(/^#{internal}/i, external)
+      end
+    end
+  end
+end

data/lib/rack/time_zone.rb

@@ -0,0 +1,25 @@
+module Rack
+  class TimeZone
+    Javascript = <<-EOJ
+    function setTimezoneCookie() {
+      var offset = (new Date()).getTimezoneOffset()
+      var date = new Date();
+      date.setTime(date.getTime()+3600000);
+      document.cookie = "utc_offset="+offset+"; expires="+date.toGMTString();+"; path=/";
+    }
+EOJ
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      request = Rack::Request.new(env)
+      if utc_offset = request.cookies["utc_offset"]
+        env["rack.timezone.utc_offset"] = -(utc_offset.to_i * 60)
+      end
+
+      @app.call(env)
+    end
+  end
+end

data/rack-contrib.gemspec

@@ -0,0 +1,54 @@
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+
+  s.name = 'rack-contrib'
+  s.version = '0.4.0'
+  s.date = '2008-12-09'
+
+  s.description = "Contributed Rack Middleware and Utilities"
+  s.summary     = "Contributed Rack Middleware and Utilities"
+
+  s.authors = ["rack-devel"]
+  s.email = "rack-devel@googlegroups.com"
+
+  # = MANIFEST =
+  s.files = %w[
+    COPYING
+    README.rdoc
+    Rakefile
+    lib/rack/contrib.rb
+    lib/rack/etag.rb
+    lib/rack/jsonp.rb
+    lib/rack/lighttpd_script_name_fix.rb
+    lib/rack/locale.rb
+    lib/rack/mailexceptions.rb
+    lib/rack/post_body_content_type_parser.rb
+    lib/rack/profiler.rb
+    lib/rack/sendfile.rb
+    lib/rack/time_zone.rb
+    rack-contrib.gemspec
+    test/mail_settings.rb
+    test/spec_rack_contrib.rb
+    test/spec_rack_etag.rb
+    test/spec_rack_jsonp.rb
+    test/spec_rack_lighttpd_script_name_fix.rb
+    test/spec_rack_mailexceptions.rb
+    test/spec_rack_post_body_content_type_parser.rb
+    test/spec_rack_sendfile.rb
+  ]
+  # = MANIFEST =
+
+  s.test_files = s.files.select {|path| path =~ /^test\/spec_.*\.rb/}
+
+  s.extra_rdoc_files = %w[README.rdoc COPYING]
+  s.add_dependency 'rack', '~> 0.4'
+  s.add_dependency 'tmail', '>= 1.2'
+  s.add_dependency 'json', '>= 1.1'
+
+  s.has_rdoc = true
+  s.homepage = "http://github.com/rtomayko/rack-contrib/"
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "rack-contrib", "--main", "README"]
+  s.require_paths = %w[lib]
+  s.rubygems_version = '1.1.1'
+end

data/test/mail_settings.rb

@@ -0,0 +1,12 @@
+TEST_SMTP = nil
+
+# Enable SMTP tests by providing the following for your SMTP server.
+#
+# TEST_SMTP = {
+#   :server         => 'localhost',
+#   :domain         => 'localhost',
+#   :port           => 25,
+#   :authentication => :login,
+#   :user_name      => nil,
+#   :password       => nil
+# }

data/test/spec_rack_contrib.rb

@@ -0,0 +1,7 @@
+require 'rack/contrib'
+
+context "Rack::Contrib" do
+  specify "should expose release" do
+    Rack::Contrib.should.respond_to :release
+  end
+end

data/test/spec_rack_etag.rb

@@ -0,0 +1,22 @@
+require 'rack/mock'
+require 'rack/etag'
+
+context "Rack::ETag" do
+  specify "sets ETag if none is set" do
+    app = lambda { |env| [200, {'Content-Type' => 'text/plain'}, "Hello, World!"] }
+    response = Rack::ETag.new(app).call({})
+    response[1]['ETag'].should.equal "\"65a8e27d8879283831b664bd8b7f0ad4\""
+  end
+
+  specify "does not change ETag if it is already set" do
+    app = lambda { |env| [200, {'Content-Type' => 'text/plain', 'ETag' => '"abc"'}, "Hello, World!"] }
+    response = Rack::ETag.new(app).call({})
+    response[1]['ETag'].should.equal "\"abc\""
+  end
+
+  specify "does not set ETag if steaming body" do
+    app = lambda { |env| [200, {'Content-Type' => 'text/plain'}, ["Hello", "World"]] }
+    response = Rack::ETag.new(app).call({})
+    response[1]['ETag'].should.equal nil
+  end
+end

data/test/spec_rack_jsonp.rb

@@ -0,0 +1,20 @@
+require 'rack/mock'
+require 'rack/jsonp'
+
+context "Rack::JSONP" do
+  
+  specify "should wrap the response body in the Javascript callback when provided" do
+    app = lambda { |env| [200, {'Content-Type' => 'text/plain'}, '{"bar":"foo"}'] }
+    request = Rack::MockRequest.env_for("/", :input => "foo=bar&callback=foo")
+    body = Rack::JSONP.new(app).call(request).last
+    body.should == 'foo({"bar":"foo"})'
+  end
+  
+  specify "should not change anything if no :callback param is provided" do
+    app = lambda { |env| [200, {'Content-Type' => 'text/plain'}, '{"bar":"foo"}'] }
+    request = Rack::MockRequest.env_for("/", :input => "foo=bar")
+    body = Rack::JSONP.new(app).call(request).last
+    body.should == '{"bar":"foo"}'
+  end
+  
+end

data/test/spec_rack_lighttpd_script_name_fix.rb

@@ -0,0 +1,15 @@
+require 'rack/mock'
+require 'rack/lighttpd_script_name_fix'
+
+context "Rack::LighttpdScriptNameFix" do
+  specify "corrects SCRIPT_NAME and PATH_INFO set by lighttpd " do
+    env = {
+      "PATH_INFO" => "/foo/bar/baz",
+      "SCRIPT_NAME" => "/hello"
+    }
+    app = lambda { |env| [200, {'Content-Type' => 'text/plain'}, "Hello, World!"] }
+    response = Rack::LighttpdScriptNameFix.new(app).call(env)
+    env['SCRIPT_NAME'].should.be.empty
+    env['PATH_INFO'].should.equal '/hello/foo/bar/baz'
+  end
+end

data/test/spec_rack_mailexceptions.rb

@@ -0,0 +1,96 @@
+require 'rack/mock'
+
+begin
+  require 'tmail'
+  require 'rack/mailexceptions'
+
+  require File.dirname(__FILE__) + '/mail_settings.rb'
+
+  class TestError < RuntimeError
+  end
+
+  def test_exception
+    raise TestError, 'Suffering Succotash!'
+  rescue => boom
+    return boom
+  end
+
+  context 'Rack::MailExceptions' do
+
+    setup do
+      @app = lambda { |env| raise TestError, 'Why, I say' }
+      @env = Rack::MockRequest.env_for("/foo",
+        'FOO' => 'BAR',
+        :method => 'GET',
+        :input => 'THE BODY'
+      )
+      @smtp_settings = {
+        :server         => 'example.com',
+        :domain         => 'example.com',
+        :port           => 500,
+        :authentication => :login,
+        :user_name      => 'joe',
+        :password       => 'secret'
+      }
+    end
+
+    specify 'yields a configuration object to the block when created' do
+      called = false
+      mailer =
+        Rack::MailExceptions.new(@app) do |mail|
+          called = true
+          mail.to 'foo@example.org'
+          mail.from 'bar@example.org'
+          mail.subject '[ERROR] %s'
+          mail.smtp @smtp_settings
+        end
+      called.should.be == true
+    end
+
+    specify 'generates a TMail object with configured settings' do
+      mailer =
+        Rack::MailExceptions.new(@app) do |mail|
+          mail.to 'foo@example.org'
+          mail.from 'bar@example.org'
+          mail.subject '[ERROR] %s'
+          mail.smtp @smtp_settings
+        end
+
+      tmail = mailer.send(:generate_mail, test_exception, @env)
+      tmail.to.should.equal ['foo@example.org']
+      tmail.from.should.equal ['bar@example.org']
+      tmail.subject.should.equal '[ERROR] Suffering Succotash!'
+      tmail.body.should.not.be.nil
+      tmail.body.should.be =~ /FOO:\s+"BAR"/
+      tmail.body.should.be =~ /^\s*THE BODY\s*$/
+    end
+
+    specify 'catches exceptions raised from app, sends mail, and re-raises' do
+      mailer =
+        Rack::MailExceptions.new(@app) do |mail|
+          mail.to 'foo@example.org'
+          mail.from 'bar@example.org'
+          mail.subject '[ERROR] %s'
+          mail.smtp @smtp_settings
+        end
+      lambda { mailer.call(@env) }.should.raise(TestError)
+      @env['mail.sent'].should.be == true
+    end
+
+    if TEST_SMTP && ! TEST_SMTP.empty?
+      specify 'sends mail' do
+        mailer =
+          Rack::MailExceptions.new(@app) do |mail|
+            mail.config.merge! TEST_SMTP
+          end
+        lambda { mailer.call(@env) }.should.raise(TestError)
+        @env['mail.sent'].should.be == true
+      end
+    else
+      STDERR.puts 'WARN: Skipping SMTP tests (edit test/mail_settings.rb to enable)'
+    end
+
+  end
+rescue LoadError => boom
+  STDERR.puts "WARN: Skipping Rack::MailExceptions tests (tmail not installed)"
+end

data/test/spec_rack_post_body_content_type_parser.rb

@@ -0,0 +1,31 @@
+require 'rack/mock'
+
+begin
+  require 'rack/post_body_content_type_parser'
+  
+  context "Rack::PostBodyContentTypeParser" do
+    
+    specify "should handle requests with POST body Content-Type of application/json" do
+      app = lambda { |env| [200, {'Content-Type' => 'text/plain'}, Rack::Request.new(env).POST] }
+      env = env_for_post_with_headers('/', {'Content_Type'.upcase => 'application/json'}, {:body => "asdf", :status => "12"}.to_json)
+      body = Rack::PostBodyContentTypeParser.new(app).call(env).last
+      body['body'].should.equal "asdf"
+      body['status'].should.equal "12"
+    end
+    
+    specify "should change nothing when the POST body content type isn't application/json" do
+      app = lambda { |env| [200, {'Content-Type' => 'text/plain'}, Rack::Request.new(env).POST] }
+      body = app.call(Rack::MockRequest.env_for("/", :input => "body=asdf&status=12")).last
+      body['body'].should.equal "asdf"
+      body['status'].should.equal "12"
+    end
+    
+  end
+  
+  def env_for_post_with_headers(path, headers, body)
+    Rack::MockRequest.env_for(path, {:method => "POST", :input => body}.merge(headers))
+  end
+rescue LoadError => e
+  # Missing dependency JSON, skipping tests.
+  STDERR.puts "WARN: Skipping Rack::PostBodyContentTypeParser tests (json not installed)"
+end

data/test/spec_rack_sendfile.rb

@@ -0,0 +1,85 @@
+require 'rack/mock'
+require 'rack/sendfile'
+
+context "Rack::File" do
+  specify "should respond to #to_path" do
+    Rack::File.new(Dir.pwd).should.respond_to :to_path
+  end
+end
+
+context "Rack::Sendfile" do
+  def sendfile_body
+    res = ['Hello World']
+    def res.to_path ; "/tmp/hello.txt" ; end
+    res
+  end
+
+  def simple_app(body=sendfile_body)
+    lambda { |env| [200, {'Content-Type' => 'text/plain'}, body] }
+  end
+
+  def sendfile_app(body=sendfile_body)
+    Rack::Sendfile.new(simple_app(body))
+  end
+
+  setup do
+    @request = Rack::MockRequest.new(sendfile_app)
+  end
+
+  def request(headers={})
+    yield @request.get('/', headers)
+  end
+
+  specify "does nothing when no X-Sendfile-Type header present" do
+    request do |response|
+      response.should.be.ok
+      response.body.should.equal 'Hello World'
+      response.headers.should.not.include 'X-Sendfile'
+    end
+  end
+
+  specify "sets X-Sendfile response header and discards body" do
+    request 'HTTP_X_SENDFILE_TYPE' => 'X-Sendfile' do |response|
+      response.should.be.ok
+      response.body.should.be.empty
+      response.headers['X-Sendfile'].should.equal '/tmp/hello.txt'
+    end
+  end
+
+  specify "sets X-Lighttpd-Send-File response header and discards body" do
+    request 'HTTP_X_SENDFILE_TYPE' => 'X-Lighttpd-Send-File' do |response|
+      response.should.be.ok
+      response.body.should.be.empty
+      response.headers['X-Lighttpd-Send-File'].should.equal '/tmp/hello.txt'
+    end
+  end
+
+  specify "sets X-Accel-Redirect response header and discards body" do
+    headers = {
+      'HTTP_X_SENDFILE_TYPE' => 'X-Accel-Redirect',
+      'HTTP_X_ACCEL_MAPPING' => '/tmp/=/foo/bar/'
+    }
+    request headers do |response|
+      response.should.be.ok
+      response.body.should.be.empty
+      response.headers['X-Accel-Redirect'].should.equal '/foo/bar/hello.txt'
+    end
+  end
+
+  specify 'writes to rack.error when no X-Accel-Mapping is specified' do
+    request 'HTTP_X_SENDFILE_TYPE' => 'X-Accel-Redirect' do |response|
+      response.should.be.ok
+      response.body.should.equal 'Hello World'
+      response.headers.should.not.include 'X-Accel-Redirect'
+      response.errors.should.include 'X-Accel-Mapping'
+    end
+  end
+
+  specify 'does nothing when body does not respond to #to_path' do
+    @request = Rack::MockRequest.new(sendfile_app(['Not a file...']))
+    request 'HTTP_X_SENDFILE_TYPE' => 'X-Sendfile' do |response|
+      response.body.should.equal 'Not a file...'
+      response.headers.should.not.include 'X-Sendfile'
+    end
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification 
+name: rtomayko-rack-contrib
+version: !ruby/object:Gem::Version 
+  version: 0.4.0
+platform: ruby
+authors: 
+- rack-devel
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-09 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0.4"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: tmail
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "1.2"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "1.1"
+    version: 
+description: Contributed Rack Middleware and Utilities
+email: rack-devel@googlegroups.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- COPYING
+files: 
+- COPYING
+- README.rdoc
+- Rakefile
+- lib/rack/contrib.rb
+- lib/rack/etag.rb
+- lib/rack/jsonp.rb
+- lib/rack/lighttpd_script_name_fix.rb
+- lib/rack/locale.rb
+- lib/rack/mailexceptions.rb
+- lib/rack/post_body_content_type_parser.rb
+- lib/rack/profiler.rb
+- lib/rack/sendfile.rb
+- lib/rack/time_zone.rb
+- rack-contrib.gemspec
+- test/mail_settings.rb
+- test/spec_rack_contrib.rb
+- test/spec_rack_etag.rb
+- test/spec_rack_jsonp.rb
+- test/spec_rack_lighttpd_script_name_fix.rb
+- test/spec_rack_mailexceptions.rb
+- test/spec_rack_post_body_content_type_parser.rb
+- test/spec_rack_sendfile.rb
+has_rdoc: true
+homepage: http://github.com/rtomayko/rack-contrib/
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- rack-contrib
+- --main
+- README
+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.2.0
+signing_key: 
+specification_version: 2
+summary: Contributed Rack Middleware and Utilities
+test_files: 
+- test/spec_rack_contrib.rb
+- test/spec_rack_etag.rb
+- test/spec_rack_jsonp.rb
+- test/spec_rack_lighttpd_script_name_fix.rb
+- test/spec_rack_mailexceptions.rb
+- test/spec_rack_post_body_content_type_parser.rb
+- test/spec_rack_sendfile.rb