rack-contrib 1.0.0 → 1.0.1

data/lib/rack/contrib.rb

@@ -3,7 +3,7 @@ require 'rack'
 module Rack
   module Contrib
     def self.release
-      "0.9.1"
+      "1.0.1"
     end
   end
 
@@ -13,7 +13,6 @@ module Rack
   autoload :Cookies,                    "rack/contrib/cookies"
   autoload :CSSHTTPRequest,             "rack/contrib/csshttprequest"
   autoload :Deflect,                    "rack/contrib/deflect"
-  autoload :ETag,                       "rack/contrib/etag"
   autoload :ExpectationCascade,         "rack/contrib/expectation_cascade"
   autoload :GarbageCollector,           "rack/contrib/garbagecollector"
   autoload :JSONP,                      "rack/contrib/jsonp"
@@ -36,5 +35,5 @@ module Rack
   autoload :NotFound,                   "rack/contrib/not_found"
   autoload :ResponseCache,              "rack/contrib/response_cache"
   autoload :RelativeRedirect,           "rack/contrib/relative_redirect"
-  autoload :StaticCache,           	"rack/contrib/static_cache"
+  autoload :StaticCache,                "rack/contrib/static_cache"
 end

data/lib/rack/contrib/access.rb

@@ -70,7 +70,7 @@ module Rack
     end
 
     def forbidden!
-      [403, { 'Content-Type' => 'text/html', 'Content-Length' => '0' }, '']
+      [403, { 'Content-Type' => 'text/html', 'Content-Length' => '0' }, []]
     end
 
     def ip_authorized?(ipmasks)

data/lib/rack/contrib/deflect.rb

@@ -63,7 +63,7 @@ module Rack
     end
 
     def deflect!
-      [403, { 'Content-Type' => 'text/html', 'Content-Length' => '0' }, '']
+      [403, { 'Content-Type' => 'text/html', 'Content-Length' => '0' }, []]
     end
 
     def deflect? env

data/lib/rack/contrib/jsonp.rb

@@ -5,36 +5,59 @@ module Rack
   # Full credit to Flinn Mueller (http://actsasflinn.com/) for this contribution.
   #
   class JSONP
+    include Rack::Utils
 
     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.
+    # method and padding the response with the appropriate callback format if
+    # the returned body is application/json
     #
     # Changes nothing if no <tt>callback</tt> param is specified.
     #
     def call(env)
       status, headers, response = @app.call(env)
+
+      headers = HeaderHash.new(headers)
       request = Rack::Request.new(env)
-      if request.params.include?('callback')
+      
+      if is_json?(headers) && has_callback?(request)
         response = pad(request.params.delete('callback'), response)
-        headers['Content-Length'] = response.length.to_s
+
+        # No longer json, its javascript!
+        headers['Content-Type'].gsub!('json', 'javascript')
+        
+        # Set new Content-Length, if it was set before we mutated the response body
+        if headers['Content-Length']
+          length = response.to_ary.inject(0) { |len, part| len + bytesize(part) }
+          headers['Content-Length'] = length.to_s
+        end
       end
       [status, headers, response]
     end
+    
+    private
+    
+    def is_json?(headers)
+      headers['Content-Type'].include?('application/json')
+    end
+    
+    def has_callback?(request)
+      request.params.include?('callback')
+    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 single string makes sense since JSON
-    # is returned as a full string.
+    # The Rack response spec indicates that it should be enumerable. The
+    # method of combining all of the data into a single string makes sense
+    # since JSON is returned as a full string.
     #
     def pad(callback, response, body = "")
       response.each{ |s| body << s.to_s }
-      "#{callback}(#{body})"
+      ["#{callback}(#{body})"]
     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.0'
-  s.date = '2010-06-07'
+  s.version = '1.0.1'
+  s.date = '2010-06-09'
 
   s.description = "Contributed Rack Middleware and Utilities"
   s.summary     = "Contributed Rack Middleware and Utilities"

data/test/spec_rack_access.rb

@@ -5,7 +5,7 @@ require 'rack/contrib/access'
 context "Rack::Access" do
 
   setup do
-    @app = lambda { |env| [200, { 'Content-Type' => 'text/plain' }, 'hello'] }
+    @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'
@@ -24,42 +24,42 @@ context "Rack::Access" do
     app = middleware
     status, headers, body = app.call(mock_env(@mock_addr_1))
     status.should.equal 403
-    body.should.equal ''
+    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'
+    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'
+    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 ''
+    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'
+    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 ''
+    body.should.equal []
   end
 
   specify "should allow remote addresses in one of allow_ipmasking" do
@@ -67,18 +67,18 @@ context "Rack::Access" do
 
     status, headers, body = app.call(mock_env(@mock_addr_2))
     status.should.equal 200
-    body.should.equal 'hello'
+    body.should.equal ['hello']
 
     status, headers, body = app.call(mock_env(@mock_addr_localhost))
     status.should.equal 200
-    body.should.equal 'hello'
+    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 ''
+    body.should.equal []
   end
 
   specify "handles paths correctly" do
@@ -90,65 +90,65 @@ context "Rack::Access" do
 
     status, headers, body = app.call(mock_env(@mock_addr_1, "/"))
     status.should.equal 200
-    body.should.equal 'hello'
+    body.should.equal ['hello']
 
     status, headers, body = app.call(mock_env(@mock_addr_1, "/qux"))
     status.should.equal 200
-    body.should.equal 'hello'
+    body.should.equal ['hello']
 
     status, headers, body = app.call(mock_env(@mock_addr_1, "/foo"))
     status.should.equal 403
-    body.should.equal ''
+    body.should.equal []
     status, headers, body = app.call(mock_env(@mock_addr_localhost, "/foo"))
     status.should.equal 200
-    body.should.equal 'hello'
+    body.should.equal ['hello']
 
     status, headers, body = app.call(mock_env(@mock_addr_1, "/foo/"))
     status.should.equal 403
-    body.should.equal ''
+    body.should.equal []
     status, headers, body = app.call(mock_env(@mock_addr_localhost, "/foo/"))
     status.should.equal 200
-    body.should.equal 'hello'
+    body.should.equal ['hello']
 
     status, headers, body = app.call(mock_env(@mock_addr_1, "/foo/bar"))
     status.should.equal 403
-    body.should.equal ''
+    body.should.equal []
     status, headers, body = app.call(mock_env(@mock_addr_localhost, "/foo/bar"))
     status.should.equal 200
-    body.should.equal 'hello'
+    body.should.equal ['hello']
     status, headers, body = app.call(mock_env(@mock_addr_2, "/foo/bar"))
     status.should.equal 200
-    body.should.equal 'hello'
+    body.should.equal ['hello']
 
     status, headers, body = app.call(mock_env(@mock_addr_1, "/foo/bar/"))
     status.should.equal 403
-    body.should.equal ''
+    body.should.equal []
     status, headers, body = app.call(mock_env(@mock_addr_localhost, "/foo/bar/"))
     status.should.equal 200
-    body.should.equal 'hello'
+    body.should.equal ['hello']
 
     status, headers, body = app.call(mock_env(@mock_addr_1, "/foo///bar//quux"))
     status.should.equal 403
-    body.should.equal ''
+    body.should.equal []
     status, headers, body = app.call(mock_env(@mock_addr_localhost, "/foo///bar//quux"))
     status.should.equal 200
-    body.should.equal 'hello'
+    body.should.equal ['hello']
 
     status, headers, body = app.call(mock_env(@mock_addr_1, "/foo/quux"))
     status.should.equal 403
-    body.should.equal ''
+    body.should.equal []
     status, headers, body = app.call(mock_env(@mock_addr_localhost, "/foo/quux"))
     status.should.equal 200
-    body.should.equal 'hello'
+    body.should.equal ['hello']
 
     status, headers, body = app.call(mock_env(@mock_addr_1, "/bar"))
     status.should.equal 200
-    body.should.equal 'hello'
+    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 ''
+    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'
+    body.should.equal ['hello']
   end
 end

data/test/spec_rack_deflect.rb

@@ -5,7 +5,7 @@ require 'rack/contrib/deflect'
 context "Rack::Deflect" do
 
   setup do
-    @app = lambda { |env| [200, { 'Content-Type' => 'text/plain' }, 'cookies'] }
+    @app = lambda { |env| [200, { 'Content-Type' => 'text/plain' }, ['cookies']] }
     @mock_addr_1 = '111.111.111.111'
     @mock_addr_2 = '222.222.222.222'
     @mock_addr_3 = '333.333.333.333'
@@ -23,7 +23,7 @@ context "Rack::Deflect" do
     app = mock_deflect
     status, headers, body = app.call mock_env(@mock_addr_1)
     status.should.equal 200
-    body.should.equal 'cookies'
+    body.should.equal ['cookies']
   end
 
   specify "should deflect requests exceeding the request threshold" do
@@ -35,14 +35,14 @@ context "Rack::Deflect" do
     5.times do
       status, headers, body = app.call env
       status.should.equal 200
-      body.should.equal 'cookies'
+      body.should.equal ['cookies']
     end
 
     # Remaining requests should fail for 10 seconds
     10.times do
       status, headers, body = app.call env
       status.should.equal 403
-      body.should.equal ''
+      body.should.equal []
     end
 
     # Log should reflect that we have blocked an address
@@ -58,13 +58,13 @@ context "Rack::Deflect" do
     5.times do
       status, headers, body = app.call env
       status.should.equal 200
-      body.should.equal 'cookies'
+      body.should.equal ['cookies']
     end
 
     # Exceeds request threshold
     status, headers, body = app.call env
     status.should.equal 403
-    body.should.equal ''
+    body.should.equal []
 
     # Allow block to expire
     sleep 3
@@ -73,7 +73,7 @@ context "Rack::Deflect" do
     5.times do
       status, headers, body = app.call env
       status.should.equal 200
-      body.should.equal 'cookies'
+      body.should.equal ['cookies']
     end
 
     # Log should reflect block and release
@@ -88,7 +88,7 @@ context "Rack::Deflect" do
     10.times do
       status, headers, body = app.call env
       status.should.equal 200
-      body.should.equal 'cookies'
+      body.should.equal ['cookies']
     end
   end
 
@@ -97,11 +97,11 @@ context "Rack::Deflect" do
 
     status, headers, body = app.call mock_env(@mock_addr_1)
     status.should.equal 200
-    body.should.equal 'cookies'
+    body.should.equal ['cookies']
 
     status, headers, body = app.call mock_env(@mock_addr_2)
     status.should.equal 403
-    body.should.equal ''
+    body.should.equal []
   end
 
 end

data/test/spec_rack_jsonp.rb

@@ -5,30 +5,69 @@ require 'rack/contrib/jsonp'
 context "Rack::JSONP" do
 
   context "when a callback parameter is provided" do
-    specify "should wrap the response body in the Javascript callback" do
+    specify "should wrap the response body in the Javascript callback if JSON" do
+      test_body = '{"bar":"foo"}'
+      callback = 'foo'
+      app = lambda { |env| [200, {'Content-Type' => 'application/json'}, [test_body]] }
+      request = Rack::MockRequest.env_for("/", :params => "foo=bar&callback=#{callback}")
+      body = Rack::JSONP.new(app).call(request).last
+      body.should.equal ["#{callback}(#{test_body})"]
+    end
+    
+    specify "should not wrap the response body in a callback if body is not JSON" do
       test_body = '{"bar":"foo"}'
       callback = 'foo'
       app = lambda { |env| [200, {'Content-Type' => 'text/plain'}, [test_body]] }
       request = Rack::MockRequest.env_for("/", :params => "foo=bar&callback=#{callback}")
       body = Rack::JSONP.new(app).call(request).last
-      body.should.equal "#{callback}(#{test_body})"
+      body.should.equal ['{"bar":"foo"}']
     end
+    
+    specify "should update content length if it was set" do
+      test_body = '{"bar":"foo"}'
+      callback = 'foo'
+      app = lambda { |env| [200, {'Content-Type' => 'application/json', 'Content-Length' => test_body.length}, [test_body]] }
+      request = Rack::MockRequest.env_for("/", :params => "foo=bar&callback=#{callback}")
 
-    specify "should modify the content length to the correct value" do
+      headers = Rack::JSONP.new(app).call(request)[1]
+      expected_length = test_body.length + callback.length + "()".length
+      headers['Content-Length'].should.equal(expected_length.to_s)
+    end
+    
+    specify "should not touch content length if not set" do
       test_body = '{"bar":"foo"}'
       callback = 'foo'
-      app = lambda { |env| [200, {'Content-Type' => 'text/plain'}, [test_body]] }
+      app = lambda { |env| [200, {'Content-Type' => 'application/json'}, [test_body]] }
       request = Rack::MockRequest.env_for("/", :params => "foo=bar&callback=#{callback}")
       headers = Rack::JSONP.new(app).call(request)[1]
-      headers['Content-Length'].should.equal((test_body.length + callback.length + 2).to_s) # 2 parentheses
+      headers['Content-Length'].should.equal nil
     end
+    
+    specify "should modify the content type to application/javascript" do
+      test_body = '{"bar":"foo"}'
+      callback = 'foo'
+      app = lambda { |env| [200, {'Content-Type' => 'application/json'}, [test_body]] }
+      request = Rack::MockRequest.env_for("/", :params => "foo=bar&callback=#{callback}")
+      headers = Rack::JSONP.new(app).call(request)[1]
+      headers['Content-Type'].should.equal('application/javascript')
+    end
+    
   end
 
   specify "should not change anything if no callback param is provided" do
-    app = lambda { |env| [200, {'Content-Type' => 'text/plain'}, ['{"bar":"foo"}']] }
+    test_body = ['{"bar":"foo"}']
+    app = lambda { |env| [200, {'Content-Type' => 'application/json'}, test_body] }
     request = Rack::MockRequest.env_for("/", :params => "foo=bar")
     body = Rack::JSONP.new(app).call(request).last
-    body.join.should.equal '{"bar":"foo"}'
+    body.should.equal test_body
+  end
+
+  specify "should not change anything if it's not a json response" do
+    test_body = '<html><body>404 Not Found</body></html>'
+    app = lambda { |env| [404, {'Content-Type' => 'text/html'}, [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
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 0
-  - 0
-  version: 1.0.0
+  - 1
+  version: 1.0.1
 platform: ruby
 authors: 
 - rack-devel
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-07 00:00:00 -07:00
+date: 2010-06-09 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency