tricycle-rack-contrib 0.9.0

data/test/spec_rack_response_cache.rb

@@ -0,0 +1,181 @@
+require 'test/spec'
+require 'rack/mock'
+#require 'rack/contrib/response_cache'
+require File.join(File.dirname(__FILE__), '../lib/rack/contrib/response_cache')
+require 'fileutils'
+
+context Rack::ResponseCache do
+  F = ::File
+
+  def request(opts={}, &block)
+    Rack::MockRequest.new(Rack::ResponseCache.new(block||@def_app, opts[:cache]||@cache, &opts[:rc_block])).send(opts[:meth]||:get, opts[:path]||@def_path, opts[:headers]||{})
+  end
+
+  setup do
+    @cache = {}
+    @def_disk_cache = F.join(F.dirname(__FILE__), 'response_cache_test_disk_cache')
+    @def_value = ["rack-response-cache"]
+    @def_path = '/path/to/blah'
+    @def_app = lambda { |env| [200, {'Content-Type' => env['CT'] || 'text/html'}, @def_value]}
+  end
+  teardown do
+    FileUtils.rm_rf(@def_disk_cache)
+  end
+
+  specify "should cache results to disk if cache is a string" do
+    request(:cache=>@def_disk_cache)
+    F.read(F.join(@def_disk_cache, 'path', 'to', 'blah.html')).should.equal @def_value.first
+    request(:path=>'/path/3', :cache=>@def_disk_cache)
+    F.read(F.join(@def_disk_cache, 'path', '3.html')).should.equal @def_value.first
+  end
+
+  specify "should cache results to given cache if cache is not a string" do
+    request
+    @cache.should.equal('/path/to/blah.html'=>@def_value)
+    request(:path=>'/path/3')
+    @cache.should.equal('/path/to/blah.html'=>@def_value, '/path/3.html'=>@def_value)
+  end
+
+  specify "should not cache results if request method is not GET" do
+    request(:meth=>:post)
+    @cache.should.equal({})
+    request(:meth=>:put)
+    @cache.should.equal({})
+    request(:meth=>:delete)
+    @cache.should.equal({})
+  end
+
+  specify "should not cache results if there is a query string" do
+    request(:path=>'/path/to/blah?id=1')
+    @cache.should.equal({})
+    request(:path=>'/path/to/?id=1')
+    @cache.should.equal({})
+    request(:path=>'/?id=1')
+    @cache.should.equal({})
+  end
+
+  specify "should cache results if there is an empty query string" do
+    request(:path=>'/?')
+    @cache.should.equal('/index.html'=>@def_value)
+  end
+
+  specify "should not cache results if the request is not sucessful (status 200)" do
+    request{|env| [404, {'Content-Type' => 'text/html'}, ['']]}
+    @cache.should.equal({})
+    request{|env| [500, {'Content-Type' => 'text/html'}, ['']]}
+    @cache.should.equal({})
+    request{|env| [302, {'Content-Type' => 'text/html'}, ['']]}
+    @cache.should.equal({})
+  end
+  
+  specify 'should not cache when "no cache" cache control directives' do
+    request{|env| [200, {'Content-Type' => 'text/html', 'Cache-Control' => 'no-cache'}, ['']]}
+    @cache.should.equal({})
+  end
+  
+  specify 'should not cache when "private" cache control directives' do
+    request{|env| [200, {'Content-Type' => 'text/html', 'Cache-Control' => 'private'}, ['']]}
+    request{|env| [200, {'Content-Type' => 'text/html', 'Cache-Control' => "private, max-age=0, must-revalidate"}, ['']]}
+    @cache.should.equal({})
+  end
+  
+  specify 'should cache requests when is "public" cache control directives' do
+    request{|env| [200, {'Content-Type' => 'text/html', 'Cache-Control' => 'public'}, ['one']]}
+    @cache.should.equal({'/path/to/blah.html' => ['one']})
+  end
+  
+  specify 'should cache requests when including "public" cache control directives' do
+    request{|env| [200, {'Content-Type' => 'text/html', 'Cache-Control' => 'max-age=300, public'}, ['many']]}    
+    @cache.should.equal({'/path/to/blah.html' => ['many']})
+  end
+  
+  specify 'should cache when no cache control directives' do
+    request{|env| [200, {'Content-Type' => 'text/html'}, ['none']]}
+    @cache.should.equal({'/path/to/blah.html' => ['none']})
+  end
+
+  specify "should not cache results if the block returns nil or false" do
+    request(:rc_block=>proc{false})
+    @cache.should.equal({})
+    request(:rc_block=>proc{nil})
+    @cache.should.equal({})
+  end
+
+  specify "should cache results to path returned by block" do
+    request(:rc_block=>proc{"1"})
+    @cache.should.equal("1"=>@def_value)
+    request(:rc_block=>proc{"2"})
+    @cache.should.equal("1"=>@def_value, "2"=>@def_value)
+  end
+
+  specify "should pass the environment and response to the block" do
+    e, r = nil, nil
+    request(:rc_block=>proc{|env,res| e, r = env, res; nil})
+    e['PATH_INFO'].should.equal @def_path
+    e['REQUEST_METHOD'].should.equal 'GET'
+    e['QUERY_STRING'].should.equal ''
+    r.should.equal([200, {"Content-Type"=>"text/html"}, ["rack-response-cache"]])
+  end
+
+  specify "should unescape the path by default" do
+    request(:path=>'/path%20with%20spaces')
+    @cache.should.equal('/path with spaces.html'=>@def_value)
+    request(:path=>'/path%3chref%3e')
+    @cache.should.equal('/path with spaces.html'=>@def_value, '/path<href>.html'=>@def_value)
+  end
+
+  specify "should cache html mime_type without extension at .html" do
+    request(:path=>'/a')
+    @cache.should.equal('/a.html'=>@def_value)
+  end
+
+  {
+    :css => %w[text/css],
+    :csv => %w[text/csv],
+    :html => %w[text/html],
+    :js => %w[text/javascript application/javascript],
+    :pdf => %w[application/pdf],
+    :txt => %w[text/plain],
+    :xhtml => %w[application/xhtml+xml],
+    :xml => %w[text/xml],
+  }.each do |extension, mime_types|
+    mime_types.each do |mime_type|
+      specify "should cache #{mime_type} responses with the extension ('#{extension}') unchanged" do
+        request(:path=>"/a.#{extension}", :headers=>{'CT'=>mime_type})
+        @cache.should.equal("/a.#{extension}"=>@def_value)
+      end
+
+      specify "should cache #{mime_type} responses with the relevant extension ('#{extension}') added if not already present" do
+        request(:path=>'/a', :headers=>{'CT'=>mime_type})
+        @cache.should.equal("/a.#{extension}"=>@def_value)
+      end
+    end
+  end
+  
+  specify "should cache 'text/html' responses with the extension ('htm') unchanged" do
+    request(:path=>"/a.htm", :headers=>{'CT'=>"text/html"})
+    @cache.should.equal("/a.htm"=>@def_value)
+  end
+  
+  [:css, :xml, :xhtml, :js, :txt, :pdf, :csv].each do |extension|
+    specify "should not cache if extension and content-type don't agree" do
+      request(:path=>"/d.#{extension}", :headers=>{'CT'=>'text/html'})
+      @cache.should.equal({})
+    end    
+  end
+
+  specify "should cache html responses with empty basename to index.html by default" do
+    request(:path=>'/')
+    @cache.should.equal('/index.html'=>@def_value)
+    request(:path=>'/blah/')
+    @cache.should.equal('/index.html'=>@def_value, '/blah/index.html'=>@def_value)
+    request(:path=>'/blah/2/')
+    @cache.should.equal('/index.html'=>@def_value, '/blah/index.html'=>@def_value, '/blah/2/index.html'=>@def_value)
+  end
+
+  specify "should raise an error if a cache argument is not provided" do
+    app = Rack::Builder.new{use Rack::ResponseCache; run lambda { |env| [200, {'Content-Type' => 'text/plain'}, Rack::Request.new(env).POST]}}
+    proc{Rack::MockRequest.new(app).get('/')}.should.raise(ArgumentError)
+  end
+
+end

data/test/spec_rack_sendfile.rb

@@ -0,0 +1,86 @@
+require 'test/spec'
+require 'rack/mock'
+require 'rack/contrib/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

data/tricycle-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 = 'tricycle-rack-contrib'
+  s.version = '0.9.0'
+  s.date = '2010-01-06'
+
+  s.description = "Contributed Rack Middleware and Utilities, including Tricycle's modifications"
+  s.summary     = "Contributed Rack Middleware and Utilities, including Tricycle's modifications"
+
+  s.authors = ["tricycle", "rack-devel"]
+  s.email = "gems@tricycledevelopments.com"
+
+  # = MANIFEST =
+  s.files = %w[
+    COPYING
+    README.rdoc
+    Rakefile
+    lib/rack/contrib.rb
+    lib/rack/contrib/accept_format.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/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
+    tricycle-rack-contrib.gemspec
+    test/404.html
+    test/Maintenance.html
+    test/mail_settings.rb
+    test/spec_rack_accept_format.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_etag.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/tricycle/rack-contrib/"
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "tricycle-rack-contrib", "--main", "README"]
+  s.require_paths = %w[lib]
+  s.rubygems_version = '1.1.1'
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification 
+name: tricycle-rack-contrib
+version: !ruby/object:Gem::Version 
+  version: 0.9.0
+platform: ruby
+authors: 
+- tricycle
+- rack-devel
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-06 00:00:00 +11:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: test-spec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.9.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: tmail
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "1.2"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "1.1"
+    version: 
+description: Contributed Rack Middleware and Utilities, including Tricycle's modifications
+email: gems@tricycledevelopments.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- COPYING
+files: 
+- COPYING
+- README.rdoc
+- Rakefile
+- lib/rack/contrib.rb
+- lib/rack/contrib/accept_format.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/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
+- tricycle-rack-contrib.gemspec
+- test/404.html
+- test/Maintenance.html
+- test/mail_settings.rb
+- test/spec_rack_accept_format.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_etag.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
+has_rdoc: true
+homepage: http://github.com/tricycle/rack-contrib/
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- tricycle-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.3.5
+signing_key: 
+specification_version: 2
+summary: Contributed Rack Middleware and Utilities, including Tricycle's modifications
+test_files: 
+- test/spec_rack_accept_format.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_etag.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