rack-contrib 1.0.1 → 1.1.0

data/README.rdoc

@@ -26,10 +26,10 @@ interface:
   a request
 * Rack::StaticCache - Modifies the response headers to facilitiate client and proxy caching for
   static files that minimizes http requests and improves overall load times for second time visitors.
-* Rack::TimeZone - Detects the clients timezone using JavaScript and sets
+* Rack::TimeZone - Detects the client's timezone using JavaScript and sets
   a variable in Rack's environment with the offset from UTC.
 * Rack::Evil - Lets the rack application return a response to the client from any place.
-* Rack::Callbacks - Implements DLS for pure before/after filter like Middlewares.
+* Rack::Callbacks - Implements DSL for pure before/after filter like Middlewares.
 * Rack::Config - Shared configuration for cooperative middleware.
 * Rack::NotFound - A default 404 application.
 * Rack::CSSHTTPRequest - Adds CSSHTTPRequest support by encoding responses as
@@ -44,9 +44,10 @@ interface:
 * Rack::AcceptFormat - Adds a format extension at the end of the URI when there is none, corresponding to the mime-type given in the Accept HTTP header.
 * Rack::HostMeta - Configures /host-meta using a block
 * Rack::Cookies - Adds simple cookie jar hash to env
-* Rack::Access - Limit access based on IP address
-* Rack::ResponseHeaders - Manipulate response headers object at runtime
-* Rack::SimpleEndpoint - Create simple endpoints with routing rules, similar to Sinatra actions
+* Rack::Access - Limits access based on IP address
+* Rack::ResponseHeaders - Manipulates response headers object at runtime
+* Rack::SimpleEndpoint - Creates simple endpoints with routing rules, similar to Sinatra actions
+* Rack::TryStatic - Tries to match request to a static file
 
 === Use
 

data/lib/rack/contrib/common_cookies.rb

@@ -0,0 +1,41 @@
+module Rack
+  # Rack middleware to use common cookies across domain and subdomains.
+  class CommonCookies
+    DOMAIN_REGEXP = /([^.]*)\.([^.]*|..\...|...\...|..\....)$/
+    LOCALHOST_OR_IP_REGEXP = /^([\d.]+|localhost)$/
+    PORT = /:\d+$/
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      @app.call(env).tap do |(status, headers, response)|
+        @host = env['HTTP_HOST'].sub PORT, ''
+        share_cookie headers
+      end
+    end
+
+    private
+
+    def domain
+      @domain ||= begin
+        @host =~ DOMAIN_REGEXP
+        ".#{$1}.#{$2}"
+      end
+    end
+
+    def share_cookie(headers)
+      headers['Set-Cookie'] &&= common_cookie(headers) if @host !~ LOCALHOST_OR_IP_REGEXP
+    end
+
+    def cookie(headers)
+      cookies = headers['Set-Cookie']
+      cookies.is_a?(Array) ? cookies.join("\n") : cookies
+    end
+
+    def common_cookie(headers)
+      cookie(headers).gsub(/; domain=[^;]*/, '').gsub(/$/, "; domain=#{domain}")
+    end
+  end
+end

data/lib/rack/contrib/jsonp.rb

@@ -27,7 +27,7 @@ module Rack
         response = pad(request.params.delete('callback'), response)
 
         # No longer json, its javascript!
-        headers['Content-Type'].gsub!('json', 'javascript')
+        headers['Content-Type'] = headers['Content-Type'].gsub('json', 'javascript')
         
         # Set new Content-Length, if it was set before we mutated the response body
         if headers['Content-Length']
@@ -41,7 +41,7 @@ module Rack
     private
     
     def is_json?(headers)
-      headers['Content-Type'].include?('application/json')
+      headers.key?('Content-Type') && headers['Content-Type'].include?('application/json')
     end
     
     def has_callback?(request)

data/lib/rack/contrib/mailexceptions.rb

@@ -70,11 +70,23 @@ module Rack
       env['mail.sent'] = true
       return if smtp[:server] == 'example.com'
 
-      Net::SMTP.start smtp[:server], 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
+      server = service.new(smtp[:server], smtp[:port])
+
+      if smtp[:enable_starttls_auto] == :auto
+        server.enable_starttls_auto 
+      elsif smtp[:enable_starttls_auto]
+        server.enable_starttls 
       end
+
+      server.start smtp[:domain], smtp[:user_name], smtp[:password], smtp[:authentication]
+
+      mail.to.each do |recipient|
+        server.send_message mail.to_s, mail.from, recipient
+      end
+    end
+
+    def service
+      Net::SMTP
     end
 
     def extract_body(env)

data/lib/rack/contrib/try_static.rb

@@ -0,0 +1,36 @@
+module Rack
+
+  # The Rack::TryStatic middleware delegates requests to Rack::Static middleware
+  # trying to match a static file
+  #
+  # Examples
+  #
+  # use Rack::TryStatic,
+  #   :root => "public",  # static files root dir
+  #   :urls => %w[/],     # match all requests
+  #   :try => ['.html', 'index.html', '/index.html'] # try these postfixes sequentially
+  #
+  #   uses same options as Rack::Static with extra :try option which is an array
+  #   of postfixes to find desired file
+
+  class TryStatic
+
+    def initialize(app, options)
+      @app = app
+      @try = ['', *options.delete(:try)]
+      @static = ::Rack::Static.new(
+        lambda { [404, {}, []] },
+        options)
+    end
+
+    def call(env)
+      orig_path = env['PATH_INFO']
+      found = nil
+      @try.each do |path|
+        resp = @static.call(env.merge!({'PATH_INFO' => orig_path + path}))
+        break if 404 != resp[0] && found = resp
+      end
+      found or @app.call(env.merge!('PATH_INFO' => orig_path))
+    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 = '1.0.1'
-  s.date = '2010-06-09'
+  s.version = '1.1.0'
+  s.date = '2010-10-19'
 
   s.description = "Contributed Rack Middleware and Utilities"
   s.summary     = "Contributed Rack Middleware and Utilities"
@@ -24,6 +24,7 @@ Gem::Specification.new do |s|
     lib/rack/contrib/backstage.rb
     lib/rack/contrib/bounce_favicon.rb
     lib/rack/contrib/callbacks.rb
+    lib/rack/contrib/common_cookies.rb
     lib/rack/contrib/config.rb
     lib/rack/contrib/cookies.rb
     lib/rack/contrib/csshttprequest.rb
@@ -51,15 +52,20 @@ Gem::Specification.new do |s|
     lib/rack/contrib/simple_endpoint.rb
     lib/rack/contrib/static_cache.rb
     lib/rack/contrib/time_zone.rb
+    lib/rack/contrib/try_static.rb
     rack-contrib.gemspec
     test/404.html
     test/Maintenance.html
+    test/documents/existing.html
+    test/documents/index.htm
+    test/documents/index.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_common_cookies.rb
     test/spec_rack_config.rb
     test/spec_rack_contrib.rb
     test/spec_rack_cookies.rb
@@ -84,6 +90,7 @@ Gem::Specification.new do |s|
     test/spec_rack_sendfile.rb
     test/spec_rack_simple_endpoint.rb
     test/spec_rack_static_cache.rb
+    test/spec_rack_try_static.rb
     test/statics/test
   ]
   # = MANIFEST =

data/test/documents/existing.html

@@ -0,0 +1 @@
+existing.html

data/test/documents/index.htm

@@ -0,0 +1 @@
+index.htm

data/test/documents/index.html

@@ -0,0 +1 @@
+index.html

data/test/mail_settings.rb

@@ -10,3 +10,11 @@ TEST_SMTP = nil
 #   :user_name      => nil,
 #   :password       => nil
 # }
+#TEST_SMTP_TLS = {
+#    :server         => 'smtp.gmail.com',
+#    :domain         => 'gmail.com',
+#    :port           => 587,
+#    :authentication => 'plain',
+#    :user_name      => nil,
+#    :password       => nil,
+#}

data/test/spec_rack_common_cookies.rb

@@ -0,0 +1,107 @@
+require 'test/spec'
+require 'rack/mock'
+require 'rack/builder'
+require 'rack/contrib/common_cookies'
+
+context Rack::CommonCookies do
+
+  setup do
+    @app = Rack::Builder.new do
+      use Rack::CommonCookies
+      run lambda {|env| [200, {'Set-Cookie' => env['HTTP_COOKIE']}, []] }
+    end
+  end
+
+  def request
+    Rack::MockRequest.new(@app)
+  end
+
+  def make_request(domain, cookies='key=value')
+    request.get '/', 'HTTP_COOKIE' => cookies, 'HTTP_HOST' => domain
+  end
+
+  specify 'should use .domain.com for cookies from domain.com' do
+    response = make_request 'domain.com'
+    response.headers['Set-Cookie'].should == 'key=value; domain=.domain.com'
+  end
+
+  specify 'should use .domain.com for cookies from www.domain.com' do
+    response = make_request 'www.domain.com'
+    response.headers['Set-Cookie'].should == 'key=value; domain=.domain.com'
+  end
+
+  specify 'should use .domain.com for cookies from subdomain.domain.com' do
+    response = make_request 'subdomain.domain.com'
+    response.headers['Set-Cookie'].should == 'key=value; domain=.domain.com'
+  end
+
+  specify 'should use .domain.com for cookies from 0.subdomain1.subdomain2.domain.com' do
+    response = make_request '0.subdomain1.subdomain2.domain.com'
+    response.headers['Set-Cookie'].should == 'key=value; domain=.domain.com'
+  end
+
+  specify 'should use .domain.local for cookies from domain.local' do
+    response = make_request '0.subdomain1.subdomain2.domain.com'
+    response.headers['Set-Cookie'].should == 'key=value; domain=.domain.com'
+  end
+
+  specify 'should use .domain.local for cookies from subdomain.domain.local' do
+    response = make_request 'subdomain.domain.local'
+    response.headers['Set-Cookie'].should == 'key=value; domain=.domain.local'
+  end
+
+  specify 'should use .domain.com.ua for cookies from domain.com.ua' do
+    response = make_request 'domain.com.ua'
+    response.headers['Set-Cookie'].should == 'key=value; domain=.domain.com.ua'
+  end
+
+  specify 'should use .domain.com.ua for cookies from subdomain.domain.com.ua' do
+    response = make_request 'subdomain.domain.com.ua'
+    response.headers['Set-Cookie'].should == 'key=value; domain=.domain.com.ua'
+  end
+
+  specify 'should use .domain.co.uk for cookies from domain.co.uk' do
+    response = make_request 'domain.co.uk'
+    response.headers['Set-Cookie'].should == 'key=value; domain=.domain.co.uk'
+  end
+
+  specify 'should use .domain.co.uk for cookies from subdomain.domain.co.uk' do
+    response = make_request 'subdomain.domain.co.uk'
+    response.headers['Set-Cookie'].should == 'key=value; domain=.domain.co.uk'
+  end
+
+  specify 'should use .domain.eu.com for cookies from domain.eu.com' do
+    response = make_request 'domain.eu.com'
+    response.headers['Set-Cookie'].should == 'key=value; domain=.domain.eu.com'
+  end
+
+  specify 'should use .domain.eu.com for cookies from subdomain.domain.eu.com' do
+    response = make_request 'subdomain.domain.eu.com'
+    response.headers['Set-Cookie'].should == 'key=value; domain=.domain.eu.com'
+  end
+
+  specify 'should work with multiple cookies' do
+    response = make_request 'sub.domain.bz', "key=value\nkey1=value2"
+    response.headers['Set-Cookie'].should == "key=value; domain=.domain.bz\nkey1=value2; domain=.domain.bz"
+  end
+
+  specify 'should work with cookies which have explicit domain' do
+    response = make_request 'sub.domain.bz', "key=value; domain=domain.bz"
+    response.headers['Set-Cookie'].should == "key=value; domain=.domain.bz"
+  end
+
+  specify 'should not touch cookies if domain is localhost' do
+    response = make_request 'localhost'
+    response.headers['Set-Cookie'].should == "key=value"
+  end
+
+  specify 'should not touch cookies if domain is ip address' do
+    response = make_request '127.0.0.1'
+    response.headers['Set-Cookie'].should == "key=value"
+  end
+
+  specify 'should use .domain.com for cookies from subdomain.domain.com:3000' do
+    response = make_request 'subdomain.domain.com:3000'
+    response.headers['Set-Cookie'].should == "key=value; domain=.domain.com"
+  end
+end

data/test/spec_rack_jsonp.rb

@@ -69,5 +69,13 @@ context "Rack::JSONP" do
     body = Rack::JSONP.new(app).call(request).last
     body.should.equal [test_body]
   end
+  
+  specify "should not change anything if there is no Content-Type header" do
+    test_body = '<html><body>404 Not Found</body></html>'
+    app = lambda { |env| [404, {}, [test_body]] }
+    request = Rack::MockRequest.env_for("/", :params => "callback=foo", 'HTTP_ACCEPT' => 'application/json')
+    body = Rack::JSONP.new(app).call(request).last
+    body.should.equal [test_body]
+  end  
 
 end

data/test/spec_rack_mailexceptions.rb

@@ -91,6 +91,80 @@ begin
       STDERR.puts 'WARN: Skipping SMTP tests (edit test/mail_settings.rb to enable)'
     end
 
+    context 'for tls enabled smtp' do
+      setup do
+        @smtp_settings.merge!(TEST_SMTP_TLS)
+        @mailer = 
+          Rack::MailExceptions.new(@app) do |mail|
+            mail.to TEST_SMTP_TLS.values_at(:user_name, :domain).join('@')
+            mail.from 'bar@example.org'
+            mail.subject '[ERROR] %s'
+            mail.smtp @smtp_settings.merge( :enable_starttls_auto => true)
+          end
+      end
+
+      describe 'with :enable_starttls_auto set to :auto' do
+        specify 'sends mail' do
+          @mailer.smtp.merge(:enable_starttls_auto => :auto)
+          lambda { @mailer.call(@env) }.should.raise(TestError)
+          @env['mail.sent'].should.be true
+        end
+      end
+
+      describe 'with :enable_starttls_auto set to true' do
+        specify 'sends mail' do
+          @mailer.smtp.merge(:enable_starttls_auto => true)
+          lambda { @mailer.call(@env) }.should.raise(TestError)
+          @env['mail.sent'].should.be true
+        end
+      end
+    end if defined?(TEST_SMTP_TLS)
+
+    describe 'for tls enabled fake smtp' do
+      class FakeSMTP
+        def initialize(*args); @@_tls = nil; end
+        def start(*args);  end
+        def enable_starttls_auto; @@_tls = :auto; end
+        def enable_starttls; @@_tls = true; end
+        def send_message(*args); end
+        def self.tls; @@_tls; end
+      end
+
+      setup do
+        Rack::MailExceptions.class_eval { def service; FakeSMTP; end}
+        @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.merge( :server => 'server.com')
+          end
+      end
+
+      context 'with :enable_starttls_auto unset' do
+        specify 'sends mail' do
+          @mailer.smtp[:enable_starttls_auto] = nil
+          lambda { @mailer.call(@env) }.should.raise(TestError)
+          FakeSMTP.tls.should.be nil
+        end
+      end
+
+      context 'with :enable_starttls_auto set to true' do
+        specify 'sends mail' do
+          @mailer.smtp[:enable_starttls_auto] = true
+          lambda { @mailer.call(@env) }.should.raise(TestError)
+          FakeSMTP.tls.should == true
+        end
+      end
+
+      context 'with :enable_starttls_auto set to :auto' do
+        specify 'sends mail' do
+          @mailer.smtp[:enable_starttls_auto] = :auto
+          lambda { @mailer.call(@env) }.should.raise(TestError)
+          FakeSMTP.tls.should == :auto
+        end
+      end
+    end
   end
 rescue LoadError => boom
   STDERR.puts "WARN: Skipping Rack::MailExceptions tests (tmail not installed)"

data/test/spec_rack_try_static.rb

@@ -0,0 +1,44 @@
+require 'test/spec'
+
+require 'rack'
+require 'rack/contrib/try_static'
+require 'rack/mock'
+
+def request(options = {})
+  options.merge!({
+    :urls => %w[/],
+    :root => ::File.expand_path(::File.dirname(__FILE__)),
+  })
+
+  @request =
+    Rack::MockRequest.new(
+      Rack::TryStatic.new(
+        lambda {[200, {}, ["Hello World"]]},
+        options))
+end
+
+describe "Rack::TryStatic" do
+  context 'when file cannot be found' do
+    it 'should call call app' do
+      res = request(:try => ['html']).get('/documents')
+      res.should.be.ok
+      res.body.should == "Hello World"
+    end
+  end
+
+  context 'when file can be found' do
+    it 'should serve first found' do
+      res = request(:try => ['.html', '/index.html', '/index.htm']).get('/documents')
+      res.should.be.ok
+      res.body.strip.should == "index.html"
+    end
+  end
+
+  context 'when path_info maps directly to file' do
+    it 'should serve existing' do
+      res = request(:try => ['/index.html']).get('/documents/existing.html')
+      res.should.be.ok
+      res.body.strip.should == "existing.html"
+    end
+  end
+end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rack-contrib
 version: !ruby/object:Gem::Version 
+  hash: 19
   prerelease: false
   segments: 
   - 1
-  - 0
   - 1
-  version: 1.0.1
+  - 0
+  version: 1.1.0
 platform: ruby
 authors: 
 - rack-devel
@@ -14,16 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-09 00:00:00 -07:00
+date: 2010-10-19 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rack
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 57
         segments: 
         - 0
         - 9
@@ -35,9 +38,11 @@ dependencies:
   name: test-spec
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 59
         segments: 
         - 0
         - 9
@@ -49,9 +54,11 @@ dependencies:
   name: tmail
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 11
         segments: 
         - 1
         - 2
@@ -62,9 +69,11 @@ dependencies:
   name: json
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 13
         segments: 
         - 1
         - 1
@@ -91,6 +100,7 @@ files:
 - lib/rack/contrib/backstage.rb
 - lib/rack/contrib/bounce_favicon.rb
 - lib/rack/contrib/callbacks.rb
+- lib/rack/contrib/common_cookies.rb
 - lib/rack/contrib/config.rb
 - lib/rack/contrib/cookies.rb
 - lib/rack/contrib/csshttprequest.rb
@@ -118,15 +128,20 @@ files:
 - lib/rack/contrib/simple_endpoint.rb
 - lib/rack/contrib/static_cache.rb
 - lib/rack/contrib/time_zone.rb
+- lib/rack/contrib/try_static.rb
 - rack-contrib.gemspec
 - test/404.html
 - test/Maintenance.html
+- test/documents/existing.html
+- test/documents/index.htm
+- test/documents/index.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_common_cookies.rb
 - test/spec_rack_config.rb
 - test/spec_rack_contrib.rb
 - test/spec_rack_cookies.rb
@@ -151,6 +166,7 @@ files:
 - test/spec_rack_sendfile.rb
 - test/spec_rack_simple_endpoint.rb
 - test/spec_rack_static_cache.rb
+- test/spec_rack_try_static.rb
 - test/statics/test
 has_rdoc: true
 homepage: http://github.com/rack/rack-contrib/
@@ -167,23 +183,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 2
 summary: Contributed Rack Middleware and Utilities
@@ -192,6 +212,7 @@ test_files:
 - test/spec_rack_access.rb
 - test/spec_rack_backstage.rb
 - test/spec_rack_callbacks.rb
+- test/spec_rack_common_cookies.rb
 - test/spec_rack_config.rb
 - test/spec_rack_contrib.rb
 - test/spec_rack_cookies.rb
@@ -216,3 +237,4 @@ test_files:
 - test/spec_rack_sendfile.rb
 - test/spec_rack_simple_endpoint.rb
 - test/spec_rack_static_cache.rb
+- test/spec_rack_try_static.rb