devver-rack-contrib 0.9.3

data/lib/rack/contrib/route_exceptions.rb

@@ -0,0 +1,49 @@
+module Rack
+  class RouteExceptions
+    ROUTES = [
+      [Exception, '/error/internal']
+    ]
+
+    PATH_INFO = 'rack.route_exceptions.path_info'.freeze
+    EXCEPTION = 'rack.route_exceptions.exception'.freeze
+    RETURNED  = 'rack.route_exceptions.returned'.freeze
+
+    class << self
+      def route(exception, to)
+        ROUTES.delete_if{|k,v| k == exception }
+        ROUTES << [exception, to]
+      end
+
+      alias []= route
+    end
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env, try_again = true)
+      returned = @app.call(env)
+    rescue Exception => exception
+      raise(exception) unless try_again
+
+      ROUTES.each do |klass, to|
+        next unless klass === exception
+        return route(to, env, returned, exception)
+      end
+
+      raise(exception)
+    end
+
+    def route(to, env, returned, exception)
+      env.merge!(
+        PATH_INFO => env['PATH_INFO'],
+        EXCEPTION => exception,
+        RETURNED => returned
+      )
+
+      env['PATH_INFO'] = to
+
+      call(env, try_again = false)
+    end
+  end
+end

data/lib/rack/contrib/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/contrib/signals.rb

@@ -0,0 +1,63 @@
+module Rack
+  # Installs signal handlers that are safely processed after a request
+  #
+  # NOTE: This middleware should not be used in a threaded environment
+  #
+  # use Rack::Signals.new do
+  #   trap 'INT', lambda {
+  #     puts "Exiting now"
+  #     exit
+  #   }
+  #
+  #   trap_when_ready 'USR1', lambda {
+  #     puts "Exiting when ready"
+  #     exit
+  #   }
+  # end
+  class Signals
+    class BodyWithCallback
+      def initialize(body, callback)
+        @body, @callback = body, callback
+      end
+
+      def each(&block)
+        @body.each(&block)
+        @callback.call
+      end
+    end
+
+    def initialize(app, &block)
+      @app = app
+      @processing = false
+      @when_ready = nil
+      instance_eval(&block)
+    end
+
+    def call(env)
+      begin
+        @processing, @when_ready = true, nil
+        status, headers, body = @app.call(env)
+
+        if handler = @when_ready
+          body = BodyWithCallback.new(body, handler)
+          @when_ready = nil
+        end
+      ensure
+        @processing = false
+      end
+
+      [status, headers, body]
+    end
+
+    def trap_when_ready(signal, handler)
+      when_ready_handler = lambda { |signal|
+        if @processing
+          @when_ready = lambda { handler.call(signal) }
+        else
+          handler.call(signal)
+        end
+      }
+      trap(signal, when_ready_handler)
+    end
+  end
+end

data/lib/rack/contrib/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,88 @@
+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 = 'devver-rack-contrib'
+  s.version = '0.9.3'
+  s.date = '2010-01-10'
+
+  s.description = "The Devver fork of rack-contrib"
+  s.summary     = "This gem is the Devver fork of rack-contrib (http://github.com/rack/rack-contrib) so we can play around with new features we're building. You should not use this version and use the official rack-contrib gem instead."
+
+  s.authors = ["rack-devel"]
+  s.email = "rack-devel@googlegroups.com"
+
+  # = MANIFEST =
+  s.files = %w[
+    COPYING
+    README.rdoc
+    Rakefile
+    lib/rack/contrib.rb
+    lib/rack/contrib/accept_format.rb
+    lib/rack/contrib/access.rb
+    lib/rack/contrib/backstage.rb
+    lib/rack/contrib/bounce_favicon.rb
+    lib/rack/contrib/callbacks.rb
+    lib/rack/contrib/config.rb
+    lib/rack/contrib/cookies.rb
+    lib/rack/contrib/csshttprequest.rb
+    lib/rack/contrib/deflect.rb
+    lib/rack/contrib/evil.rb
+    lib/rack/contrib/garbagecollector.rb
+    lib/rack/contrib/jsonp.rb
+    lib/rack/contrib/lighttpd_script_name_fix.rb
+    lib/rack/contrib/locale.rb
+    lib/rack/contrib/mailexceptions.rb
+    lib/rack/contrib/nested_params.rb
+    lib/rack/contrib/not_found.rb
+    lib/rack/contrib/post_body_content_type_parser.rb
+    lib/rack/contrib/proctitle.rb
+    lib/rack/contrib/profiler.rb
+    lib/rack/contrib/relative_redirect.rb
+    lib/rack/contrib/response_cache.rb
+    lib/rack/contrib/route_exceptions.rb
+    lib/rack/contrib/sendfile.rb
+    lib/rack/contrib/signals.rb
+    lib/rack/contrib/time_zone.rb
+    rack-contrib.gemspec
+    test/404.html
+    test/Maintenance.html
+    test/mail_settings.rb
+    test/spec_rack_accept_format.rb
+    test/spec_rack_access.rb
+    test/spec_rack_backstage.rb
+    test/spec_rack_callbacks.rb
+    test/spec_rack_config.rb
+    test/spec_rack_contrib.rb
+    test/spec_rack_csshttprequest.rb
+    test/spec_rack_deflect.rb
+    test/spec_rack_evil.rb
+    test/spec_rack_garbagecollector.rb
+    test/spec_rack_jsonp.rb
+    test/spec_rack_lighttpd_script_name_fix.rb
+    test/spec_rack_mailexceptions.rb
+    test/spec_rack_nested_params.rb
+    test/spec_rack_not_found.rb
+    test/spec_rack_post_body_content_type_parser.rb
+    test/spec_rack_proctitle.rb
+    test/spec_rack_profiler.rb
+    test/spec_rack_relative_redirect.rb
+    test/spec_rack_response_cache.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.9.1'
+  s.add_development_dependency 'test-spec', '~> 0.9.0'
+  s.add_development_dependency 'tmail', '>= 1.2'
+  s.add_development_dependency 'json', '>= 1.1'
+
+  s.has_rdoc = true
+  s.homepage = "http://github.com/rack/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/404.html

@@ -0,0 +1 @@
+Not Found

data/test/Maintenance.html

@@ -0,0 +1 @@
+Under maintenance.

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_accept_format.rb

@@ -0,0 +1,72 @@
+require 'test/spec'
+require 'rack/mock'
+require 'rack/contrib/accept_format'
+require 'rack/mime'
+
+context "Rack::AcceptFormat" do
+  app = lambda { |env| [200, {'Content-Type' => 'text/plain'}, env['PATH_INFO']] }
+
+  specify "should do nothing when a format extension is already provided" do
+    request = Rack::MockRequest.env_for("/resource.json")
+    body = Rack::AcceptFormat.new(app).call(request).last
+    body.should == "/resource.json"
+  end
+
+  context "default extention" do
+    specify "should allow custom default" do
+      request = Rack::MockRequest.env_for("/resource")
+      body = Rack::AcceptFormat.new(app, '.xml').call(request).last
+      body.should == "/resource.xml"
+    end
+
+    specify "should default to html" do
+      request = Rack::MockRequest.env_for("/resource")
+      body = Rack::AcceptFormat.new(app).call(request).last
+      body.should == "/resource.html"
+    end
+
+    specify "should notmalize custom extention" do
+      request = Rack::MockRequest.env_for("/resource")
+
+      body = Rack::AcceptFormat.new(app,'xml').call(request).last #no dot prefix
+      body.should == "/resource.xml"
+
+      body = Rack::AcceptFormat.new(app, :xml).call(request).last
+      body.should == "/resource.xml"
+    end
+  end
+
+  context "there is no format extension" do
+    Rack::Mime::MIME_TYPES.clear
+
+    def mime(ext, type)
+      ext = ".#{ext}" unless ext.to_s[0] == ?.
+      Rack::Mime::MIME_TYPES[ext.to_s] = type
+    end
+
+    specify "should add the default extension if no Accept header" do
+      request = Rack::MockRequest.env_for("/resource")
+      body = Rack::AcceptFormat.new(app).call(request).last
+      body.should == "/resource.html"
+    end
+
+    specify "should add the default extension if the Accept header is not registered in the Mime::Types" do
+      request = Rack::MockRequest.env_for("/resource", 'HTTP_ACCEPT' => 'application/json;q=1.0, text/html;q=0.8, */*;q=0.1')
+      body = Rack::AcceptFormat.new(app).call(request).last
+      body.should == "/resource.html"
+    end
+
+    specify "should add the correct extension if the Accept header is registered in the Mime::Types" do
+      mime :json, 'application/json'
+      request = Rack::MockRequest.env_for("/resource", 'HTTP_ACCEPT' => 'application/json;q=1.0, text/html;q=0.8, */*;q=0.1')
+      body = Rack::AcceptFormat.new(app).call(request).last
+      body.should == "/resource.json"
+    end
+  end
+
+  specify "shouldn't confuse extention when there are dots in path" do
+    request = Rack::MockRequest.env_for("/parent.resource/resource")
+    body = Rack::AcceptFormat.new(app, '.html').call(request).last
+    body.should == "/parent.resource/resource.html"
+  end
+end