rack-test 0.4.1 → 0.4.2

data/History.txt

@@ -1,3 +1,18 @@
+== 0.4.2 / 2009-09-01
+
+* Minor enhancements
+
+  * Merge in rack/master's build_multipart method which covers additional cases
+  * Accept raw :params string input and merge it with the query string
+  * Stringify and upcase request method (e.g. :post => "POST") (Josh Peek)
+
+* Bug fixes
+
+  * Properly convert hashes with nil values (e.g. :foo => nil becomes simply "foo", not "foo=")
+  * Prepend a slash to the URI path if it doesn't start with one (Josh Peek)
+  * Requiring Rack-Test never modifies the Ruby load path anymore (Josh Peek)
+  * Fixed using multiple cookies in a string on Ruby 1.8 (Tuomas Kareinen and Hermanni Hyytiälä)
+
 == 0.4.1 / 2009-08-06
 
 * Minor enhancements

data/Rakefile

@@ -23,6 +23,8 @@ end
 
 Spec::Rake::SpecTask.new do |t|
   t.spec_opts = ['--options', "\"#{File.dirname(__FILE__)}/spec/spec.opts\""]
+  t.libs << 'lib'
+  t.libs << 'spec'
 end
 
 desc "Run all specs in spec directory with RCov"
@@ -45,7 +47,7 @@ task :whitespace do
   sh %{find . -name '*.rb' -exec sed -i '' 's/ *$//g' {} \\;}
 end
 
-task :spec => :check_dependencies
+task :spec => :check_dependencies if defined?(Jeweler)
 
 desc "Run the specs"
 task :default => :spec

data/lib/rack/test.rb

@@ -1,7 +1,3 @@
-unless $LOAD_PATH.include?(File.expand_path(File.dirname(__FILE__) + "/.."))
-  $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/.."))
-end
-
 require "uri"
 require "rack"
 require "rack/mock_session"
@@ -13,7 +9,7 @@ require "rack/test/uploaded_file"
 
 module Rack
   module Test
-    VERSION = ::File.read(::File.join(::File.dirname(__FILE__), "..", "..", "VERSION")).strip
+    VERSION = "0.4.2"
 
     DEFAULT_HOST = "example.org"
     MULTIPART_BOUNDARY = "----------XnJLe9ZIbbGUYtzPQJ16u1"
@@ -145,6 +141,7 @@ module Rack
 
       def env_for(path, env)
         uri = URI.parse(path)
+        uri.path = "/#{uri.path}" unless uri.path[0] == ?/
         uri.host ||= @default_host
 
         env = default_env.merge(env)
@@ -152,26 +149,32 @@ module Rack
         env.update("HTTPS" => "on")                if URI::HTTPS === uri
         env["X-Requested-With"] = "XMLHttpRequest" if env[:xhr]
 
-        if (env[:method] == "POST" || env["REQUEST_METHOD"] == "POST" ||
-            env[:method] == "PUT" || env["REQUEST_METHOD"] == "PUT") && !env.has_key?(:input)
-          env["CONTENT_TYPE"] ||= "application/x-www-form-urlencoded"
+        # TODO: Remove this after Rack 1.1 has been released.
+        # Stringifying and upcasing methods has be commit upstream
+        env["REQUEST_METHOD"] ||= env[:method] ? env[:method].to_s.upcase : "GET"
 
-          multipart = (Hash === env[:params]) &&
-            env[:params].any? { |_, v| UploadedFile === v }
+        if env["REQUEST_METHOD"] == "GET"
+          params = env[:params] || {}
+          params = parse_nested_query(params) if params.is_a?(String)
+          params.update(parse_query(uri.query))
+          uri.query = build_nested_query(params)
+        elsif !env.has_key?(:input)
+          env["CONTENT_TYPE"] ||= "application/x-www-form-urlencoded"
 
-          if multipart
-            env[:input] = multipart_body(env.delete(:params))
-            env["CONTENT_LENGTH"] ||= env[:input].length.to_s
-            env["CONTENT_TYPE"] = "multipart/form-data; boundary=#{MULTIPART_BOUNDARY}"
+          if env[:params].is_a?(Hash)
+            if data = build_multipart(env[:params])
+              env[:input] = data
+              env["CONTENT_LENGTH"] ||= data.length.to_s
+              env["CONTENT_TYPE"] = "multipart/form-data; boundary=#{MULTIPART_BOUNDARY}"
+            else
+              env[:input] = params_to_string(env[:params])
+            end
           else
-            env[:input] = params_to_string(env.delete(:params))
+            env[:input] = env[:params]
           end
         end
 
-        params = env[:params] || {}
-        params.update(parse_query(uri.query))
-
-        uri.query = requestify(params)
+        env.delete(:params)
 
         if env.has_key?(:cookie)
           set_cookie(env.delete(:cookie), uri)
@@ -233,7 +236,7 @@ module Rack
 
       def params_to_string(params)
         case params
-        when Hash then requestify(params)
+        when Hash then build_nested_query(params)
         when nil  then ""
         else params
         end

data/lib/rack/test/cookie_jar.rb

@@ -116,7 +116,8 @@ module Rack
       def merge(raw_cookies, uri = nil)
         return unless raw_cookies
 
-        Array(raw_cookies).join("\n").split("\n").each do |raw_cookie|
+        raw_cookies = raw_cookies.split("\n") if raw_cookies.is_a? String
+        raw_cookies.each do |raw_cookie|
           cookie = Cookie.new(raw_cookie, uri, @default_host)
           self << cookie if cookie.valid?(uri)
         end

data/lib/rack/test/utils.rb

@@ -4,70 +4,96 @@ module Rack
     module Utils
       include Rack::Utils
 
-      def requestify(value, prefix = nil)
+      def build_nested_query(value, prefix = nil)
         case value
         when Array
           value.map do |v|
-            requestify(v, "#{prefix}[]")
+            build_nested_query(v, "#{prefix}[]")
           end.join("&")
         when Hash
           value.map do |k, v|
-            requestify(v, prefix ? "#{prefix}[#{escape(k)}]" : escape(k))
+            build_nested_query(v, prefix ? "#{prefix}[#{escape(k)}]" : escape(k))
           end.join("&")
+        when NilClass
+          prefix.to_s
         else
           "#{prefix}=#{escape(value)}"
         end
       end
 
-      module_function :requestify
+      module_function :build_nested_query
 
-      def multipart_requestify(params, first=true)
-        p = Hash.new
+      def build_multipart(params, first = true)
+        if first
+          unless params.is_a?(Hash)
+            raise ArgumentError, "value must be a Hash"
+          end
+
+          multipart = false
+          query = lambda { |value|
+            case value
+            when Array
+              value.each(&query)
+            when Hash
+              value.values.each(&query)
+            when UploadedFile
+              multipart = true
+            end
+          }
+          params.values.each(&query)
+          return nil unless multipart
+        end
+
+        flattened_params = Hash.new
 
         params.each do |key, value|
           k = first ? key.to_s : "[#{key}]"
 
-          if Hash === value
-            multipart_requestify(value, false).each do |subkey, subvalue|
-              p[k + subkey] = subvalue
-            end
+          case value
+          when Array
+            value.map { |v|
+              build_multipart(v, false).each { |subkey, subvalue|
+                flattened_params["#{k}[]#{subkey}"] = subvalue
+              }
+            }
+          when Hash
+            build_multipart(value, false).each { |subkey, subvalue|
+              flattened_params[k + subkey] = subvalue
+            }
           else
-            p[k] = value
+            flattened_params[k] = value
           end
         end
 
-        return p
-      end
-
-      module_function :multipart_requestify
-
-      def multipart_body(params)
-        multipart_requestify(params).map do |key, value|
-          if value.respond_to?(:original_filename)
-            ::File.open(value.path, "rb") do |f|
-              f.set_encoding(Encoding::BINARY) if f.respond_to?(:set_encoding)
-
-              <<-EOF
+        if first
+          flattened_params.map { |name, file|
+            if file.respond_to?(:original_filename)
+              ::File.open(file.path, "rb") do |f|
+                f.set_encoding(Encoding::BINARY) if f.respond_to?(:set_encoding)
+<<-EOF
 --#{MULTIPART_BOUNDARY}\r
-Content-Disposition: form-data; name="#{key}"; filename="#{escape(value.original_filename)}"\r
-Content-Type: #{value.content_type}\r
-Content-Length: #{::File.stat(value.path).size}\r
+Content-Disposition: form-data; name="#{name}"; filename="#{escape(file.original_filename)}"\r
+Content-Type: #{file.content_type}\r
+Content-Length: #{::File.stat(file.path).size}\r
 \r
 #{f.read}\r
 EOF
-            end
-          else
+              end
+            else
 <<-EOF
 --#{MULTIPART_BOUNDARY}\r
-Content-Disposition: form-data; name="#{key}"\r
+Content-Disposition: form-data; name="#{name}"\r
 \r
-#{value}\r
+#{file}\r
 EOF
-          end
-        end.join("")+"--#{MULTIPART_BOUNDARY}--\r"
+            end
+          }.join + "--#{MULTIPART_BOUNDARY}--\r"
+        else
+          flattened_params
+        end
       end
 
-      module_function :multipart_body
+      module_function :build_multipart
 
     end
 

data/rack-test.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rack-test}
-  s.version = "0.4.1"
+  s.version = "0.4.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Bryan Helmkamp"]
-  s.date = %q{2009-08-06}
+  s.date = %q{2009-09-01}
   s.email = %q{bryan@brynary.com}
   s.extra_rdoc_files = [
     "MIT-LICENSE.txt",
@@ -22,7 +22,6 @@ Gem::Specification.new do |s|
      "MIT-LICENSE.txt",
      "README.rdoc",
      "Rakefile",
-     "VERSION",
      "lib/rack/mock_session.rb",
      "lib/rack/test.rb",
      "lib/rack/test/cookie_jar.rb",
@@ -47,7 +46,7 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{rack-test}
-  s.rubygems_version = %q{1.3.4}
+  s.rubygems_version = %q{1.3.5}
   s.summary = %q{Simple testing API built on Rack}
   s.test_files = [
     "spec/fixtures/fake_app.rb",

data/spec/fixtures/fake_app.rb

@@ -92,6 +92,12 @@ module Rack
         "Set"
       end
 
+      get "/cookies/set-multiple" do
+        response.set_cookie("key1", :value => "value1")
+        response.set_cookie("key2", :value => "value2")
+        "Set"
+      end
+
       post "/" do
         "Hello, POST: #{params.inspect}"
       end

data/spec/rack/test/cookie_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + "/../../spec_helper"
+require "spec_helper"
 
 describe Rack::Test::Session do
   def have_body(string)
@@ -144,6 +144,12 @@ describe Rack::Test::Session do
       last_request.cookies.should == { "value" => "10", "foo" => "bar" }
     end
 
+    it "parses multiple cookies properly" do
+      get "/cookies/set-multiple"
+      get "/cookies/show"
+      last_request.cookies.should == { "key1" => "value1", "key2" => "value2" }
+    end
+
     it "supports multiple sessions" do
       with_session(:first) do
         get "/cookies/set", "value" => "1"

data/spec/rack/test/digest_auth_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + "/../../spec_helper"
+require "spec_helper"
 
 describe Rack::Test::Session do
   context "HTTP Digest authentication" do

data/spec/rack/test/multipart_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + "/../../spec_helper"
+require "spec_helper"
 
 describe Rack::Test::Session do
 

data/spec/rack/test/utils_spec.rb

@@ -1,44 +1,97 @@
-require File.dirname(__FILE__) + "/../../spec_helper"
+require "spec_helper"
 
 describe Rack::Test::Utils do
   include Rack::Test::Utils
 
-  describe "requestify" do
+  describe "build_nested_query" do
     it "converts empty strings to =" do
-      requestify("").should == "="
+      build_nested_query("").should == "="
     end
 
-    it "converts nil to =" do
-      requestify(nil).should == "="
+    it "converts nil to an empty string" do
+      build_nested_query(nil).should == ""
+    end
+
+    it "converts hashes with nil values" do
+      build_nested_query(:a => nil).should == "a"
     end
 
     it "converts hashes" do
-      requestify(:a => 1).should == "a=1"
+      build_nested_query(:a => 1).should == "a=1"
     end
 
     it "converts hashes with multiple keys" do
       hash = { :a => 1, :b => 2 }
-      ["a=1&b=2", "b=2&a=1"].should include(requestify(hash))
+      ["a=1&b=2", "b=2&a=1"].should include(build_nested_query(hash))
     end
 
     it "converts arrays with one element" do
-      requestify(:a => [1]).should == "a[]=1"
+      build_nested_query(:a => [1]).should == "a[]=1"
     end
 
     it "converts arrays with multiple elements" do
-      requestify(:a => [1, 2]).should == "a[]=1&a[]=2"
+      build_nested_query(:a => [1, 2]).should == "a[]=1&a[]=2"
     end
 
     it "converts nested hashes" do
-      requestify(:a => { :b => 1 }).should == "a[b]=1"
+      build_nested_query(:a => { :b => 1 }).should == "a[b]=1"
     end
 
     it "converts arrays nested in a hash" do
-      requestify(:a => { :b => [1, 2] }).should == "a[b][]=1&a[b][]=2"
+      build_nested_query(:a => { :b => [1, 2] }).should == "a[b][]=1&a[b][]=2"
     end
 
     it "converts arrays of hashes" do
-      requestify(:a => [{ :b => 2}, { :c => 3}]).should == "a[][b]=2&a[][c]=3"
+      build_nested_query(:a => [{ :b => 2}, { :c => 3}]).should == "a[][b]=2&a[][c]=3"
+    end
+  end
+
+  describe "build_multipart" do
+    it "builds multipart bodies" do
+      files = Rack::Test::UploadedFile.new(multipart_file("foo.txt"))
+      data  = build_multipart("submit-name" => "Larry", "files" => files)
+
+      options = {
+        "CONTENT_TYPE" => "multipart/form-data; boundary=#{Rack::Test::MULTIPART_BOUNDARY}",
+        "CONTENT_LENGTH" => data.length.to_s,
+        :input => StringIO.new(data)
+      }
+      env = Rack::MockRequest.env_for("/", options)
+      params = Rack::Utils::Multipart.parse_multipart(env)
+      params["submit-name"].should == "Larry"
+      params["files"][:filename].should == "foo.txt"
+      params["files"][:tempfile].read.should == "bar\n"
+    end
+
+    it "builds nested multipart bodies" do
+      files = Rack::Test::UploadedFile.new(multipart_file("foo.txt"))
+      data  = build_multipart("people" => [{"submit-name" => "Larry", "files" => files}])
+
+      options = {
+        "CONTENT_TYPE" => "multipart/form-data; boundary=#{Rack::Test::MULTIPART_BOUNDARY}",
+        "CONTENT_LENGTH" => data.length.to_s,
+        :input => StringIO.new(data)
+      }
+      env = Rack::MockRequest.env_for("/", options)
+      params = Rack::Utils::Multipart.parse_multipart(env)
+      params["people"][0]["submit-name"].should == "Larry"
+      params["people"][0]["files"][:filename].should == "foo.txt"
+      params["people"][0]["files"][:tempfile].read.should == "bar\n"
+    end
+
+    it "should return nil if no UploadedFiles were used" do
+      data = build_multipart("people" => [{"submit-name" => "Larry", "files" => "contents"}])
+      data.should be_nil
+    end
+
+    it "raises ArgumentErrors if params is not a Hash" do
+      lambda {
+        build_multipart("foo=bar")
+      }.should raise_error(ArgumentError, "value must be a Hash")
+    end
+
+    def multipart_file(name)
+      File.join(File.dirname(__FILE__), "..", "..", "fixtures", name.to_s)
     end
   end
 end

data/spec/rack/test_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + "/../spec_helper"
+require "spec_helper"
 
 describe Rack::Test::Session do
   describe "initialization" do
@@ -71,6 +71,41 @@ describe Rack::Test::Session do
       last_response.body.should be_empty
     end
 
+    it "allows passing :input in for POSTs" do
+      request "/", :method => :post, :input => "foo"
+      last_request.env["rack.input"].read.should == "foo"
+    end
+
+    it "converts method names to a uppercase strings" do
+      request "/", :method => :put
+      last_request.env["REQUEST_METHOD"].should == "PUT"
+    end
+
+    it "prepends a slash to the URI path" do
+      request "foo"
+      last_request.env["PATH_INFO"].should == "/foo"
+    end
+
+    it "accepts params and builds query strings for GET requests" do
+      request "/foo?baz=2", :params => {:foo => {:bar => "1"}}
+      last_request.env["QUERY_STRING"].should == "baz=2&foo[bar]=1"
+    end
+
+    it "accepts raw input in params for GET requests" do
+      request "/foo?baz=2", :params => "foo[bar]=1"
+      last_request.env["QUERY_STRING"].should == "baz=2&foo[bar]=1"
+    end
+
+    it "accepts params and builds url encoded params for POST requests" do
+      request "/foo", :method => :post, :params => {:foo => {:bar => "1"}}
+      last_request.env["rack.input"].read.should == "foo[bar]=1"
+    end
+    
+    it "accepts raw input in params for POST requests" do
+      request "/foo", :method => :post, :params => "foo[bar]=1"
+      last_request.env["rack.input"].read.should == "foo[bar]=1"
+    end
+
     context "when input is given" do
       it "should send the input" do
         request "/", :method => "POST", :input => "foo"
@@ -105,6 +140,11 @@ describe Rack::Test::Session do
     end
 
     context "when the URL is https://" do
+      it "sets rack.url_scheme to https" do
+        get "https://example.org/"
+        last_request.env["rack.url_scheme"].should == "https"
+      end
+
       it "sets SERVER_PORT to 443" do
         get "https://example.org/"
         last_request.env["SERVER_PORT"].should == "443"

data/spec/spec_helper.rb

@@ -3,7 +3,7 @@ require "spec"
 
 gem "rack", "~> 1.0.0"
 
-require File.expand_path(File.dirname(__FILE__) + "/../lib/rack/test")
+require "rack/test"
 require File.dirname(__FILE__) + "/fixtures/fake_app"
 
 Spec::Runner.configure do |config|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rack-test
 version: !ruby/object:Gem::Version 
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors: 
 - Bryan Helmkamp
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-06 00:00:00 -04:00
+date: 2009-09-01 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -29,7 +29,6 @@ files:
 - MIT-LICENSE.txt
 - README.rdoc
 - Rakefile
-- VERSION
 - lib/rack/mock_session.rb
 - lib/rack/test.rb
 - lib/rack/test/cookie_jar.rb
@@ -73,7 +72,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: rack-test
-rubygems_version: 1.3.4
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: Simple testing API built on Rack

data/VERSION

@@ -1 +0,0 @@
-0.4.1