rack-contrib 0.9.2 → 1.0.0

data/lib/rack/contrib/static_cache.rb

@@ -0,0 +1,93 @@
+module Rack
+
+  #
+  # The Rack::StaticCache middleware automatically adds, removes and modifies
+  # stuffs in response headers to facilitiate client and proxy caching for static files
+  # that minimizes http requests and improves overall load times for second time visitors.
+  #
+  # Once a static content is stored in a client/proxy the only way to enforce the browser
+  # to fetch the latest content and ignore the cache is to rename the static file.
+  #
+  # Alternatively, we can add a version number into the URL to the content to bypass
+  # the caches. Rack::StaticCache by default handles version numbers in the filename.
+  # As an example,
+  # http://yoursite.com/images/test-1.0.0.png and http://yoursite.com/images/test-2.0.0.png
+  # both reffers to the same image file http://yoursite.com/images/test.png
+  #
+  # Another way to bypass the cache is adding the version number in a field-value pair in the
+  # URL query string. As an example, http://yoursite.com/images/test.png?v=1.0.0
+  # In that case, set the option :versioning to false to avoid unneccessary regexp calculations.
+  #
+  # It's better to keep the current version number in some config file and use it in every static
+  # content's URL. So each time we modify our static contents, we just have to change the version
+  # number to enforce the browser to fetch the latest content.
+  #
+  # You can use Rack::Deflater along with Rack::StaticCache for further improvements in page loading time.
+  #
+  # Examples:
+  #     use Rack::StaticCache, :urls => ["/images", "/css", "/js", "/documents*"], :root => "statics"
+  #     will serve all requests beginning with /images, /csss or /js from the
+  #     directory "statics/images",  "statics/css",  "statics/js".
+  #     All the files from these directories will have modified headers to enable client/proxy caching,
+  #     except the files from the directory "documents". Append a * (star) at the end of the pattern
+  #     if you want to disable caching for any pattern . In that case, plain static contents will be served with
+  #     default headers.
+  #
+  #     use Rack::StaticCache, :urls => ["/images"], :duration => 2, :versioning => false
+  #     will serve all requests begining with /images under the current directory (default for the option :root
+  #     is current directory). All the contents served will have cache expiration duration set to 2 years in headers
+  #     (default for :duration is 1 year), and StaticCache will not compute any versioning logics (default for
+  #     :versioning is true)
+  #
+
+
+  class StaticCache
+
+    def initialize(app, options={})
+      @app = app
+      @urls = options[:urls]
+      @no_cache = {}
+      @urls.collect! do |url|
+        if url  =~ /\*$/
+          url.sub!(/\*$/, '')
+          @no_cache[url] = 1
+        end
+        url
+      end
+      root = options[:root] || Dir.pwd
+      @file_server = Rack::File.new(root)
+      @cache_duration = options[:duration] || 1
+      @versioning_enabled = true
+      @versioning_enabled = options[:versioning] unless options[:versioning].nil?
+      @duration_in_seconds = self.duration_in_seconds
+      @duration_in_words    = self.duration_in_words
+    end
+
+    def call(env)
+      path = env["PATH_INFO"]
+      url = @urls.detect{ |u| path.index(u) == 0 }
+      unless url.nil?
+        path.sub!(/-[\d.]+([.][a-zA-Z][\w]+)?$/, '\1') if @versioning_enabled
+        status, headers, body = @file_server.call(env)
+        if @no_cache[url].nil?
+          headers['Cache-Control'] ="max-age=#{@duration_in_seconds}, public"
+          headers['Expires'] = @duration_in_words
+          headers.delete 'Etag'
+          headers.delete 'Pragma'
+          headers.delete 'Last-Modified'
+        end
+        [status, headers, body]
+      else
+        @app.call(env)
+      end
+    end
+
+    def duration_in_words
+      (Time.now + self.duration_in_seconds).strftime '%a, %d %b %Y %H:%M:%S GMT'
+    end
+
+    def duration_in_seconds
+      60 * 60 * 24 * 365 * @cache_duration
+    end
+  end
+end

data/rack-contrib.gemspec

@@ -3,8 +3,8 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
 
   s.name = 'rack-contrib'
-  s.version = '0.9.2'
-  s.date = '2009-03-07'
+  s.version = '1.0.0'
+  s.date = '2010-06-07'
 
   s.description = "Contributed Rack Middleware and Utilities"
   s.summary     = "Contributed Rack Middleware and Utilities"
@@ -14,20 +14,24 @@ Gem::Specification.new do |s|
 
   # = MANIFEST =
   s.files = %w[
+    AUTHORS
     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/etag.rb
     lib/rack/contrib/evil.rb
+    lib/rack/contrib/expectation_cascade.rb
     lib/rack/contrib/garbagecollector.rb
+    lib/rack/contrib/host_meta.rb
     lib/rack/contrib/jsonp.rb
     lib/rack/contrib/lighttpd_script_name_fix.rb
     lib/rack/contrib/locale.rb
@@ -39,24 +43,32 @@ Gem::Specification.new do |s|
     lib/rack/contrib/profiler.rb
     lib/rack/contrib/relative_redirect.rb
     lib/rack/contrib/response_cache.rb
+    lib/rack/contrib/response_headers.rb
     lib/rack/contrib/route_exceptions.rb
+    lib/rack/contrib/runtime.rb
     lib/rack/contrib/sendfile.rb
     lib/rack/contrib/signals.rb
+    lib/rack/contrib/simple_endpoint.rb
+    lib/rack/contrib/static_cache.rb
     lib/rack/contrib/time_zone.rb
     rack-contrib.gemspec
     test/404.html
     test/Maintenance.html
+    test/documents/test
     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_cookies.rb
     test/spec_rack_csshttprequest.rb
     test/spec_rack_deflect.rb
-    test/spec_rack_etag.rb
     test/spec_rack_evil.rb
+    test/spec_rack_expectation_cascade.rb
     test/spec_rack_garbagecollector.rb
+    test/spec_rack_host_meta.rb
     test/spec_rack_jsonp.rb
     test/spec_rack_lighttpd_script_name_fix.rb
     test/spec_rack_mailexceptions.rb
@@ -67,7 +79,12 @@ Gem::Specification.new do |s|
     test/spec_rack_profiler.rb
     test/spec_rack_relative_redirect.rb
     test/spec_rack_response_cache.rb
+    test/spec_rack_response_headers.rb
+    test/spec_rack_runtime.rb
     test/spec_rack_sendfile.rb
+    test/spec_rack_simple_endpoint.rb
+    test/spec_rack_static_cache.rb
+    test/statics/test
   ]
   # = MANIFEST =
 
@@ -75,7 +92,7 @@ Gem::Specification.new do |s|
 
   s.extra_rdoc_files = %w[README.rdoc COPYING]
   s.add_dependency 'rack', '>= 0.9.1'
-  s.add_dependency 'test-spec', '~> 0.9.0'
+  s.add_development_dependency 'test-spec', '>= 0.9.0'
   s.add_development_dependency 'tmail', '>= 1.2'
   s.add_development_dependency 'json', '>= 1.1'
 

data/test/documents/test

@@ -0,0 +1 @@
+nocache

data/test/spec_rack_access.rb

@@ -0,0 +1,154 @@
+require 'test/spec'
+require 'rack/mock'
+require 'rack/contrib/access'
+
+context "Rack::Access" do
+
+  setup do
+    @app = lambda { |env| [200, { 'Content-Type' => 'text/plain' }, 'hello'] }
+    @mock_addr_1 = '111.111.111.111'
+    @mock_addr_2 = '192.168.1.222'
+    @mock_addr_localhost = '127.0.0.1'
+    @mock_addr_range = '192.168.1.0/24'
+  end
+
+  def mock_env(remote_addr, path = '/')
+    Rack::MockRequest.env_for(path, { 'REMOTE_ADDR' => remote_addr })
+  end
+
+  def middleware(options = {})
+    Rack::Access.new(@app, options)
+  end
+
+  specify "default configuration should deny non-local requests" do
+    app = middleware
+    status, headers, body = app.call(mock_env(@mock_addr_1))
+    status.should.equal 403
+    body.should.equal ''
+  end
+
+  specify "default configuration should allow requests from 127.0.0.1" do
+    app = middleware
+    status, headers, body = app.call(mock_env(@mock_addr_localhost))
+    status.should.equal 200
+    body.should.equal 'hello'
+  end
+
+  specify "should allow remote addresses in allow_ipmasking" do
+    app = middleware('/' => [@mock_addr_1])
+    status, headers, body = app.call(mock_env(@mock_addr_1))
+    status.should.equal 200
+    body.should.equal 'hello'
+  end
+
+  specify "should deny remote addresses not in allow_ipmasks" do
+    app = middleware('/' => [@mock_addr_1])
+    status, headers, body = app.call(mock_env(@mock_addr_2))
+    status.should.equal 403
+    body.should.equal ''
+  end
+
+  specify "should allow remote addresses in allow_ipmasks range" do
+    app = middleware('/' => [@mock_addr_range])
+    status, headers, body = app.call(mock_env(@mock_addr_2))
+    status.should.equal 200
+    body.should.equal 'hello'
+  end
+
+  specify "should deny remote addresses not in allow_ipmasks range" do
+    app = middleware('/' => [@mock_addr_range])
+    status, headers, body = app.call(mock_env(@mock_addr_1))
+    status.should.equal 403
+    body.should.equal ''
+  end
+
+  specify "should allow remote addresses in one of allow_ipmasking" do
+    app = middleware('/' => [@mock_addr_range, @mock_addr_localhost])
+
+    status, headers, body = app.call(mock_env(@mock_addr_2))
+    status.should.equal 200
+    body.should.equal 'hello'
+
+    status, headers, body = app.call(mock_env(@mock_addr_localhost))
+    status.should.equal 200
+    body.should.equal 'hello'
+  end
+
+  specify "should deny remote addresses not in one of allow_ipmasks" do
+    app = middleware('/' => [@mock_addr_range, @mock_addr_localhost])
+    status, headers, body = app.call(mock_env(@mock_addr_1))
+    status.should.equal 403
+    body.should.equal ''
+  end
+
+  specify "handles paths correctly" do
+    app = middleware({
+      'http://foo.org/bar' => [@mock_addr_localhost],
+      '/foo' => [@mock_addr_localhost],
+      '/foo/bar' => [@mock_addr_range, @mock_addr_localhost]
+    })
+
+    status, headers, body = app.call(mock_env(@mock_addr_1, "/"))
+    status.should.equal 200
+    body.should.equal 'hello'
+
+    status, headers, body = app.call(mock_env(@mock_addr_1, "/qux"))
+    status.should.equal 200
+    body.should.equal 'hello'
+
+    status, headers, body = app.call(mock_env(@mock_addr_1, "/foo"))
+    status.should.equal 403
+    body.should.equal ''
+    status, headers, body = app.call(mock_env(@mock_addr_localhost, "/foo"))
+    status.should.equal 200
+    body.should.equal 'hello'
+
+    status, headers, body = app.call(mock_env(@mock_addr_1, "/foo/"))
+    status.should.equal 403
+    body.should.equal ''
+    status, headers, body = app.call(mock_env(@mock_addr_localhost, "/foo/"))
+    status.should.equal 200
+    body.should.equal 'hello'
+
+    status, headers, body = app.call(mock_env(@mock_addr_1, "/foo/bar"))
+    status.should.equal 403
+    body.should.equal ''
+    status, headers, body = app.call(mock_env(@mock_addr_localhost, "/foo/bar"))
+    status.should.equal 200
+    body.should.equal 'hello'
+    status, headers, body = app.call(mock_env(@mock_addr_2, "/foo/bar"))
+    status.should.equal 200
+    body.should.equal 'hello'
+
+    status, headers, body = app.call(mock_env(@mock_addr_1, "/foo/bar/"))
+    status.should.equal 403
+    body.should.equal ''
+    status, headers, body = app.call(mock_env(@mock_addr_localhost, "/foo/bar/"))
+    status.should.equal 200
+    body.should.equal 'hello'
+
+    status, headers, body = app.call(mock_env(@mock_addr_1, "/foo///bar//quux"))
+    status.should.equal 403
+    body.should.equal ''
+    status, headers, body = app.call(mock_env(@mock_addr_localhost, "/foo///bar//quux"))
+    status.should.equal 200
+    body.should.equal 'hello'
+
+    status, headers, body = app.call(mock_env(@mock_addr_1, "/foo/quux"))
+    status.should.equal 403
+    body.should.equal ''
+    status, headers, body = app.call(mock_env(@mock_addr_localhost, "/foo/quux"))
+    status.should.equal 200
+    body.should.equal 'hello'
+
+    status, headers, body = app.call(mock_env(@mock_addr_1, "/bar"))
+    status.should.equal 200
+    body.should.equal 'hello'
+    status, headers, body = app.call(mock_env(@mock_addr_1, "/bar").merge('HTTP_HOST' => 'foo.org'))
+    status.should.equal 403
+    body.should.equal ''
+    status, headers, body = app.call(mock_env(@mock_addr_localhost, "/bar").merge('HTTP_HOST' => 'foo.org'))
+    status.should.equal 200
+    body.should.equal 'hello'
+  end
+end

data/test/spec_rack_cookies.rb

@@ -0,0 +1,56 @@
+require 'test/spec'
+require 'rack/mock'
+require 'rack/contrib/cookies'
+
+context "Rack::Cookies" do
+  specify "should be able to read received cookies" do
+    app = lambda { |env|
+      cookies = env['rack.cookies']
+      foo, quux = cookies[:foo], cookies['quux']
+      [200, {'Content-Type' => 'text/plain'}, ["foo: #{foo}, quux: #{quux}"]]
+    }
+    app = Rack::Cookies.new(app)
+
+    response = Rack::MockRequest.new(app).get('/', 'HTTP_COOKIE' => 'foo=bar;quux=h&m')
+    response.body.should.equal('foo: bar, quux: h&m')
+  end
+
+  specify "should be able to set new cookies" do
+    app = lambda { |env|
+      cookies = env['rack.cookies']
+      cookies[:foo] = 'bar'
+      cookies['quux'] = 'h&m'
+      [200, {'Content-Type' => 'text/plain'}, []]
+    }
+    app = Rack::Cookies.new(app)
+
+    response = Rack::MockRequest.new(app).get('/')
+    response.headers['Set-Cookie'].should.equal("quux=h%26m; path=/\nfoo=bar; path=/")
+  end
+
+  specify "should be able to set cookie with options" do
+    app = lambda { |env|
+      cookies = env['rack.cookies']
+      cookies['foo'] = { :value => 'bar', :path => '/login', :secure => true }
+      [200, {'Content-Type' => 'text/plain'}, []]
+    }
+    app = Rack::Cookies.new(app)
+
+    response = Rack::MockRequest.new(app).get('/')
+    response.headers['Set-Cookie'].should.equal('foo=bar; path=/login; secure')
+  end
+
+  specify "should be able to delete received cookies" do
+    app = lambda { |env|
+      cookies = env['rack.cookies']
+      cookies.delete(:foo)
+      foo, quux = cookies['foo'], cookies[:quux]
+      [200, {'Content-Type' => 'text/plain'}, ["foo: #{foo}, quux: #{quux}"]]
+    }
+    app = Rack::Cookies.new(app)
+
+    response = Rack::MockRequest.new(app).get('/', 'HTTP_COOKIE' => 'foo=bar;quux=h&m')
+    response.body.should.equal('foo: , quux: h&m')
+    response.headers['Set-Cookie'].should.equal('foo=; path=/; expires=Thu, 01-Jan-1970 00:00:00 GMT')
+  end
+end

data/test/spec_rack_expectation_cascade.rb

@@ -0,0 +1,72 @@
+require 'test/spec'
+require 'rack/mock'
+require 'rack/contrib/expectation_cascade'
+
+context "Rack::ExpectationCascade" do
+  specify "with no apps returns a 404 if no expectation header was set" do
+    app = Rack::ExpectationCascade.new
+    env = {}
+    response = app.call(env)
+    response[0].should.equal 404
+    env.should.equal({})
+  end
+
+  specify "with no apps returns a 417 if expectation header was set" do
+    app = Rack::ExpectationCascade.new
+    env = {"Expect" => "100-continue"}
+    response = app.call(env)
+    response[0].should.equal 417
+    env.should.equal({"Expect" => "100-continue"})
+  end
+
+  specify "returns first successful response" do
+    app = Rack::ExpectationCascade.new do |cascade|
+      cascade << lambda { |env| [417, {"Content-Type" => "text/plain"}, []] }
+      cascade << lambda { |env| [200, {"Content-Type" => "text/plain"}, ["OK"]] }
+    end
+    response = app.call({})
+    response[0].should.equal 200
+    response[2][0].should.equal "OK"
+  end
+
+  specify "expectation is set if it has not been already" do
+    app = Rack::ExpectationCascade.new do |cascade|
+      cascade << lambda { |env| [200, {"Content-Type" => "text/plain"}, ["Expect: #{env["Expect"]}"]] }
+    end
+    response = app.call({})
+    response[0].should.equal 200
+    response[2][0].should.equal "Expect: 100-continue"
+  end
+
+  specify "returns a 404 if no apps where matched and no expectation header was set" do
+    app = Rack::ExpectationCascade.new do |cascade|
+      cascade << lambda { |env| [417, {"Content-Type" => "text/plain"}, []] }
+    end
+    response = app.call({})
+    response[0].should.equal 404
+    response[2][0].should.equal nil
+  end
+
+  specify "returns a 417 if no apps where matched and a expectation header was set" do
+    app = Rack::ExpectationCascade.new do |cascade|
+      cascade << lambda { |env| [417, {"Content-Type" => "text/plain"}, []] }
+    end
+    response = app.call({"Expect" => "100-continue"})
+    response[0].should.equal 417
+    response[2][0].should.equal nil
+  end
+
+  specify "nests expectation cascades" do
+    app = Rack::ExpectationCascade.new do |c1|
+      c1 << Rack::ExpectationCascade.new do |c2|
+        c2 << lambda { |env| [417, {"Content-Type" => "text/plain"}, []] }
+      end
+      c1 << Rack::ExpectationCascade.new do |c2|
+        c2 << lambda { |env| [200, {"Content-Type" => "text/plain"}, ["OK"]] }
+      end
+    end
+    response = app.call({})
+    response[0].should.equal 200
+    response[2][0].should.equal "OK"
+  end
+end