rack-test 0.6.3 → 0.8.3

data/lib/rack/test/uploaded_file.rb

@@ -1,16 +1,15 @@
-require "tempfile"
-require "fileutils"
+require 'fileutils'
+require 'pathname'
+require 'tempfile'
 
 module Rack
   module Test
-
     # Wraps a Tempfile with a content type. Including one or more UploadedFile's
     # in the params causes Rack::Test to build and issue a multipart request.
     #
     # Example:
     #   post "/photos", "file" => Rack::Test::UploadedFile.new("me.jpg", "image/jpeg")
     class UploadedFile
-
       # The filename, *not* including the path, of the "uploaded" file
       attr_reader :original_filename
 
@@ -20,34 +19,66 @@ module Rack
       # The content type of the "uploaded" file
       attr_accessor :content_type
 
-      def initialize(path, content_type = "text/plain", binary = false)
-        raise "#{path} file does not exist" unless ::File.exist?(path)
-
+      # Creates a new UploadedFile instance.
+      #
+      # @param content [IO, Pathname, String, StringIO] a path to a file, or an {IO} or {StringIO} object representing the
+      #   file.
+      # @param content_type [String]
+      # @param binary [Boolean] an optional flag that indicates whether the file should be open in binary mode or not.
+      # @param original_filename [String] an optional parameter that provides the original filename if `content` is a StringIO
+      #   object. Not used for other kind of `content` objects.
+      def initialize(content, content_type = 'text/plain', binary = false, original_filename: nil)
+        if original_filename
+          initialize_from_stringio(content, original_filename)
+        else
+          initialize_from_file_path(content)
+        end
         @content_type = content_type
-        @original_filename = ::File.basename(path)
-
-        @tempfile = Tempfile.new(@original_filename)
-        @tempfile.set_encoding(Encoding::BINARY) if @tempfile.respond_to?(:set_encoding)
         @tempfile.binmode if binary
-
-        FileUtils.copy_file(path, @tempfile.path)
       end
 
       def path
-        @tempfile.path
+        tempfile.path
       end
 
-      alias_method :local_path, :path
+      alias local_path path
 
       def method_missing(method_name, *args, &block) #:nodoc:
-        @tempfile.__send__(method_name, *args, &block)
+        tempfile.public_send(method_name, *args, &block)
       end
 
-      def respond_to?(method_name, include_private = false) #:nodoc:
-        @tempfile.respond_to?(method_name, include_private) || super
+      def respond_to_missing?(method_name, include_private = false) #:nodoc:
+        tempfile.respond_to?(method_name, include_private) || super
       end
 
-    end
+      def self.finalize(file)
+        proc { actually_finalize file }
+      end
+
+      def self.actually_finalize(file)
+        file.close
+        file.unlink
+      end
 
+      private
+
+      def initialize_from_stringio(stringio, original_filename)
+        @tempfile = stringio
+        @original_filename = original_filename || raise(ArgumentError, 'Missing `original_filename` for StringIO object')
+      end
+
+      def initialize_from_file_path(path)
+        raise "#{path} file does not exist" unless ::File.exist?(path)
+
+        @original_filename = ::File.basename(path)
+
+        @tempfile = Tempfile.new([@original_filename, ::File.extname(path)])
+        @tempfile.set_encoding(Encoding::BINARY) if @tempfile.respond_to?(:set_encoding)
+
+        ObjectSpace.define_finalizer(self, self.class.finalize(@tempfile))
+
+        FileUtils.copy_file(path, @tempfile.path)
+      end
+    end
   end
 end

data/lib/rack/test/utils.rb

@@ -1,38 +1,36 @@
 module Rack
   module Test
-
     module Utils # :nodoc:
       include Rack::Utils
+      extend Rack::Utils
 
       def build_nested_query(value, prefix = nil)
         case value
         when Array
-          value.map do |v|
-            unless unescape(prefix) =~ /\[\]$/
-              prefix = "#{prefix}[]"
-            end
-            build_nested_query(v, "#{prefix}")
-          end.join("&")
+          if value.empty?
+            "#{prefix}[]="
+          else
+            value.map do |v|
+              prefix = "#{prefix}[]" unless unescape(prefix) =~ /\[\]$/
+              build_nested_query(v, prefix.to_s)
+            end.join('&')
+          end
         when Hash
           value.map do |k, v|
             build_nested_query(v, prefix ? "#{prefix}[#{escape(k)}]" : escape(k))
-          end.join("&")
+          end.join('&')
         when NilClass
           prefix.to_s
         else
           "#{prefix}=#{escape(value)}"
         end
       end
-
       module_function :build_nested_query
 
-      def build_multipart(params, first = true)
+      def build_multipart(params, first = true, multipart = false)
         if first
-          unless params.is_a?(Hash)
-            raise ArgumentError, "value must be a Hash"
-          end
+          raise ArgumentError, 'value must be a Hash' unless params.is_a?(Hash)
 
-          multipart = false
           query = lambda { |value|
             case value
             when Array
@@ -47,7 +45,7 @@ module Rack
           return nil unless multipart
         end
 
-        flattened_params = Hash.new
+        flattened_params = {}
 
         params.each do |key, value|
           k = first ? key.to_s : "[#{key}]"
@@ -55,23 +53,21 @@ module Rack
           case value
           when Array
             value.map do |v|
-
-              if (v.is_a?(Hash))
+              if v.is_a?(Hash)
                 nested_params = {}
-                build_multipart(v, false).each { |subkey, subvalue|
+                build_multipart(v, false).each do |subkey, subvalue|
                   nested_params[subkey] = subvalue
-                }
+                end
                 flattened_params["#{k}[]"] ||= []
                 flattened_params["#{k}[]"] << nested_params
               else
                 flattened_params["#{k}[]"] = value
               end
-
             end
           when Hash
-            build_multipart(value, false).each { |subkey, subvalue|
+            build_multipart(value, false).each do |subkey, subvalue|
               flattened_params[k + subkey] = subvalue
-            }
+            end
           else
             flattened_params[k] = value
           end
@@ -83,27 +79,28 @@ module Rack
           flattened_params
         end
       end
-
       module_function :build_multipart
 
-    private
+      private
+
       def build_parts(parameters)
         get_parts(parameters).join + "--#{MULTIPART_BOUNDARY}--\r"
       end
+      module_function :build_parts
 
       def get_parts(parameters)
-        parameters.map { |name, value|
-          if name =~ /\[\]\Z/ && value.is_a?(Array) && value.all? {|v| v.is_a?(Hash)}
-            value.map { |hash|
+        parameters.map do |name, value|
+          if name =~ /\[\]\Z/ && value.is_a?(Array) && value.all? { |v| v.is_a?(Hash) }
+            value.map do |hash|
               new_value = {}
-              hash.each { |k, v| new_value[name+k] = v }
+              hash.each { |k, v| new_value[name + k] = v }
               get_parts(new_value).join
-            }.join
+            end.join
           else
             if value.respond_to?(:original_filename)
               build_file_part(name, value)
 
-            elsif value.is_a?(Array) and value.all? { |v| v.respond_to?(:original_filename) }
+            elsif value.is_a?(Array) && value.all? { |v| v.respond_to?(:original_filename) }
               value.map do |v|
                 build_file_part(name, v)
               end.join
@@ -113,15 +110,14 @@ module Rack
               Rack::Test.encoding_aware_strings? ? primitive_part.force_encoding('BINARY') : primitive_part
             end
           end
-        }
+        end
       end
+      module_function :get_parts
 
       def build_primitive_part(parameter_name, value)
-        unless value.is_a? Array
-          value = [value]
-        end
+        value = [value] unless value.is_a? Array
         value.map do |v|
-<<-EOF
+          <<-EOF
 --#{MULTIPART_BOUNDARY}\r
 Content-Disposition: form-data; name="#{parameter_name}"\r
 \r
@@ -129,22 +125,20 @@ Content-Disposition: form-data; name="#{parameter_name}"\r
 EOF
         end.join
       end
+      module_function :build_primitive_part
 
       def build_file_part(parameter_name, uploaded_file)
-        ::File.open(uploaded_file.path, "rb") do |physical_file|
-          physical_file.set_encoding(Encoding::BINARY) if physical_file.respond_to?(:set_encoding)
-<<-EOF
+        uploaded_file.set_encoding(Encoding::BINARY) if uploaded_file.respond_to?(:set_encoding)
+        <<-EOF
 --#{MULTIPART_BOUNDARY}\r
 Content-Disposition: form-data; name="#{parameter_name}"; filename="#{escape(uploaded_file.original_filename)}"\r
 Content-Type: #{uploaded_file.content_type}\r
-Content-Length: #{::File.stat(uploaded_file.path).size}\r
+Content-Length: #{uploaded_file.size}\r
 \r
-#{physical_file.read}\r
+#{uploaded_file.read}\r
 EOF
-        end
       end
-
+      module_function :build_file_part
     end
-
   end
 end

data/lib/rack/test/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  module Test
+    VERSION = '0.8.3'.freeze
+  end
+end

data/lib/rack/test.rb

@@ -1,18 +1,17 @@
-require "uri"
-require "rack"
-require "rack/mock_session"
-require "rack/test/cookie_jar"
-require "rack/test/mock_digest_request"
-require "rack/test/utils"
-require "rack/test/methods"
-require "rack/test/uploaded_file"
+require 'uri'
+require 'rack'
+require 'rack/mock_session'
+require 'rack/test/cookie_jar'
+require 'rack/test/mock_digest_request'
+require 'rack/test/utils'
+require 'rack/test/methods'
+require 'rack/test/uploaded_file'
+require 'rack/test/version'
 
 module Rack
   module Test
-    VERSION = "0.6.3"
-
-    DEFAULT_HOST = "example.org"
-    MULTIPART_BOUNDARY = "----------XnJLe9ZIbbGUYtzPQJ16u1"
+    DEFAULT_HOST = 'example.org'.freeze
+    MULTIPART_BOUNDARY = '----------XnJLe9ZIbbGUYtzPQJ16u1'.freeze
 
     # The common base class for exceptions raised by Rack::Test
     class Error < StandardError; end
@@ -36,11 +35,13 @@ module Rack
       def initialize(mock_session)
         @headers = {}
         @env = {}
+        @digest_username = nil
+        @digest_password = nil
 
-        if mock_session.is_a?(MockSession)
-          @rack_mock_session = mock_session
+        @rack_mock_session = if mock_session.is_a?(MockSession)
+          mock_session
         else
-          @rack_mock_session = MockSession.new(mock_session)
+          MockSession.new(mock_session)
         end
 
         @default_host = @rack_mock_session.default_host
@@ -54,8 +55,7 @@ module Rack
       # Example:
       #   get "/"
       def get(uri, params = {}, env = {}, &block)
-        env = env_for(uri, env.merge(:method => "GET", :params => params))
-        process_request(uri, env, &block)
+        custom_request('GET', uri, params, env, &block)
       end
 
       # Issue a POST request for the given URI. See #get
@@ -63,8 +63,7 @@ module Rack
       # Example:
       #   post "/signup", "name" => "Bryan"
       def post(uri, params = {}, env = {}, &block)
-        env = env_for(uri, env.merge(:method => "POST", :params => params))
-        process_request(uri, env, &block)
+        custom_request('POST', uri, params, env, &block)
       end
 
       # Issue a PUT request for the given URI. See #get
@@ -72,8 +71,7 @@ module Rack
       # Example:
       #   put "/"
       def put(uri, params = {}, env = {}, &block)
-        env = env_for(uri, env.merge(:method => "PUT", :params => params))
-        process_request(uri, env, &block)
+        custom_request('PUT', uri, params, env, &block)
       end
 
       # Issue a PATCH request for the given URI. See #get
@@ -81,8 +79,7 @@ module Rack
       # Example:
       #   patch "/"
       def patch(uri, params = {}, env = {}, &block)
-        env = env_for(uri, env.merge(:method => "PATCH", :params => params))
-        process_request(uri, env, &block)
+        custom_request('PATCH', uri, params, env, &block)
       end
 
       # Issue a DELETE request for the given URI. See #get
@@ -90,8 +87,7 @@ module Rack
       # Example:
       #   delete "/"
       def delete(uri, params = {}, env = {}, &block)
-        env = env_for(uri, env.merge(:method => "DELETE", :params => params))
-        process_request(uri, env, &block)
+        custom_request('DELETE', uri, params, env, &block)
       end
 
       # Issue an OPTIONS request for the given URI. See #get
@@ -99,8 +95,7 @@ module Rack
       # Example:
       #   options "/"
       def options(uri, params = {}, env = {}, &block)
-        env = env_for(uri, env.merge(:method => "OPTIONS", :params => params))
-        process_request(uri, env, &block)
+        custom_request('OPTIONS', uri, params, env, &block)
       end
 
       # Issue a HEAD request for the given URI. See #get
@@ -108,8 +103,7 @@ module Rack
       # Example:
       #   head "/"
       def head(uri, params = {}, env = {}, &block)
-        env = env_for(uri, env.merge(:method => "HEAD", :params => params))
-        process_request(uri, env, &block)
+        custom_request('HEAD', uri, params, env, &block)
       end
 
       # Issue a request to the Rack app for the given URI and optional Rack
@@ -120,10 +114,21 @@ module Rack
       # Example:
       #   request "/"
       def request(uri, env = {}, &block)
+        uri = parse_uri(uri, env)
         env = env_for(uri, env)
         process_request(uri, env, &block)
       end
 
+      # Issue a request using the given verb for the given URI. See #get
+      #
+      # Example:
+      #   custom_request "LINK", "/"
+      def custom_request(verb, uri, params = {}, env = {}, &block)
+        uri = parse_uri(uri, env)
+        env = env_for(uri, env.merge(method: verb.to_s.upcase, params: params))
+        process_request(uri, env, &block)
+      end
+
       # Set a header to be included on all subsequent requests through the
       # session. Use a value of nil to remove a previously configured header.
       #
@@ -159,11 +164,11 @@ module Rack
       # Example:
       #   basic_authorize "bryan", "secret"
       def basic_authorize(username, password)
-        encoded_login = ["#{username}:#{password}"].pack("m*")
+        encoded_login = ["#{username}:#{password}"].pack('m0')
         header('Authorization', "Basic #{encoded_login}")
       end
 
-      alias_method :authorize, :basic_authorize
+      alias authorize basic_authorize
 
       # Set the username and password for HTTP Digest authorization, to be
       # included in subsequent requests in the HTTP_AUTHORIZATION header.
@@ -181,73 +186,73 @@ module Rack
       # a redirect, an error will be raised.
       def follow_redirect!
         unless last_response.redirect?
-          raise Error.new("Last response was not a redirect. Cannot follow_redirect!")
+          raise Error, 'Last response was not a redirect. Cannot follow_redirect!'
+        end
+        if last_response.status == 307
+          send(last_request.request_method.downcase.to_sym, last_response['Location'], last_request.params, 'HTTP_REFERER' => last_request.url)
+        else
+          get(last_response['Location'], {}, 'HTTP_REFERER' => last_request.url)
         end
-
-        get(last_response["Location"], {}, { "HTTP_REFERER" => last_request.url })
       end
 
-    private
+      private
 
-      def env_for(path, env)
-        uri = URI.parse(path)
-        uri.path = "/#{uri.path}" unless uri.path[0] == ?/
-        uri.host ||= @default_host
+      def parse_uri(path, env)
+        URI.parse(path).tap do |uri|
+          uri.path = "/#{uri.path}" unless uri.path[0] == '/'
+          uri.host ||= @default_host
+          uri.scheme ||= 'https' if env['HTTPS'] == 'on'
+        end
+      end
 
+      def env_for(uri, env)
         env = default_env.merge(env)
 
-        env["HTTP_HOST"] ||= [uri.host, (uri.port if uri.port != uri.default_port)].compact.join(":")
+        env['HTTP_HOST'] ||= [uri.host, (uri.port if uri.port != uri.default_port)].compact.join(':')
 
-        env.update("HTTPS" => "on") if URI::HTTPS === uri
-        env["HTTP_X_REQUESTED_WITH"] = "XMLHttpRequest" if env[:xhr]
+        env.update('HTTPS' => 'on') if URI::HTTPS === uri
+        env['HTTP_X_REQUESTED_WITH'] = 'XMLHttpRequest' if env[:xhr]
 
         # 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"
+        env['REQUEST_METHOD'] ||= env[:method] ? env[:method].to_s.upcase : 'GET'
+
+        params = env.delete(:params) do {} end
 
-        if env["REQUEST_METHOD"] == "GET"
+        if env['REQUEST_METHOD'] == 'GET'
           # merge :params with the query string
-          if params = env[:params]
+          if params
             params = parse_nested_query(params) if params.is_a?(String)
-            params.update(parse_nested_query(uri.query))
-            uri.query = build_nested_query(params)
+
+            uri.query = [uri.query, build_nested_query(params)].compact.reject { |v| v == '' }.join('&')
           end
-        elsif !env.has_key?(:input)
-          env["CONTENT_TYPE"] ||= "application/x-www-form-urlencoded"
+        elsif !env.key?(:input)
+          env['CONTENT_TYPE'] ||= 'application/x-www-form-urlencoded' unless params.nil?
 
-          if env[:params].is_a?(Hash)
-            if data = build_multipart(env[:params])
+          if params.is_a?(Hash)
+            if data = build_multipart(params)
               env[:input] = data
-              env["CONTENT_LENGTH"] ||= data.length.to_s
-              env["CONTENT_TYPE"] = "multipart/form-data; boundary=#{MULTIPART_BOUNDARY}"
+              env['CONTENT_LENGTH'] ||= data.length.to_s
+              env['CONTENT_TYPE'] = "multipart/form-data; boundary=#{MULTIPART_BOUNDARY}"
             else
-              env[:input] = params_to_string(env[:params])
+              env[:input] = params_to_string(params)
             end
           else
-            env[:input] = env[:params]
+            env[:input] = params
           end
         end
 
-        env.delete(:params)
-
-        if env.has_key?(:cookie)
-          set_cookie(env.delete(:cookie), uri)
-        end
+        set_cookie(env.delete(:cookie), uri) if env.key?(:cookie)
 
         Rack::MockRequest.env_for(uri.to_s, env)
       end
 
       def process_request(uri, env)
-        uri = URI.parse(uri)
-        uri.host ||= @default_host
-
         @rack_mock_session.request(uri, env)
 
         if retry_with_digest_auth?(env)
-          auth_env = env.merge({
-            "HTTP_AUTHORIZATION"          => digest_auth_header,
-            "rack-test.digest_auth_retry" => true
-          })
+          auth_env = env.merge('HTTP_AUTHORIZATION' => digest_auth_header,
+                               'rack-test.digest_auth_retry' => true)
           auth_env.delete('rack.request')
           process_request(uri.path, auth_env)
         else
@@ -258,26 +263,24 @@ module Rack
       end
 
       def digest_auth_header
-        challenge = last_response["WWW-Authenticate"].split(" ", 2).last
+        challenge = last_response['WWW-Authenticate'].split(' ', 2).last
         params = Rack::Auth::Digest::Params.parse(challenge)
 
-        params.merge!({
-          "username"  => @digest_username,
-          "nc"        => "00000001",
-          "cnonce"    => "nonsensenonce",
-          "uri"       => last_request.fullpath,
-          "method"    => last_request.env["REQUEST_METHOD"],
-        })
+        params.merge!('username' => @digest_username,
+                      'nc'        => '00000001',
+                      'cnonce'    => 'nonsensenonce',
+                      'uri'       => last_request.fullpath,
+                      'method'    => last_request.env['REQUEST_METHOD'])
 
-        params["response"] = MockDigestRequest.new(params).response(@digest_password)
+        params['response'] = MockDigestRequest.new(params).response(@digest_password)
 
         "Digest #{params}"
       end
 
       def retry_with_digest_auth?(env)
         last_response.status == 401 &&
-        digest_auth_configured? &&
-        !env["rack-test.digest_auth_retry"]
+          digest_auth_configured? &&
+          !env['rack-test.digest_auth_retry']
       end
 
       def digest_auth_configured?
@@ -285,15 +288,15 @@ module Rack
       end
 
       def default_env
-        { "rack.test" => true, "REMOTE_ADDR" => "127.0.0.1" }.merge(@env).merge(headers_for_env)
+        { 'rack.test' => true, 'REMOTE_ADDR' => '127.0.0.1' }.merge(@env).merge(headers_for_env)
       end
 
       def headers_for_env
         converted_headers = {}
 
         @headers.each do |name, value|
-          env_key = name.upcase.gsub("-", "_")
-          env_key = "HTTP_" + env_key unless "CONTENT_TYPE" == env_key
+          env_key = name.upcase.tr('-', '_')
+          env_key = 'HTTP_' + env_key unless env_key == 'CONTENT_TYPE'
           converted_headers[env_key] = value
         end
 
@@ -303,16 +306,14 @@ module Rack
       def params_to_string(params)
         case params
         when Hash then build_nested_query(params)
-        when nil  then ""
+        when nil  then ''
         else params
         end
       end
-
     end
 
     def self.encoding_aware_strings?
-      defined?(Encoding) && "".respond_to?(:encode)
+      defined?(Encoding) && ''.respond_to?(:encode)
     end
-
   end
 end