rack-test 2.0.2 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c4264ddd984ab1b662efcc68423ca74bc65927f4751cc8ac68a0f1cfe94375c
-  data.tar.gz: 7f4af2a9203533fae754b99db4e577cae6be7170fab447a238a2f266a8183e1b
+  metadata.gz: 2c648ce9c6c053f9168116fa0ff70ac3ce4d6944326cca519fc2f7f1bb3c4f1d
+  data.tar.gz: 8c8d8c7b5c41facc400a1f95533af2e94c7c6eb42ed55ba92b5e38689134e3d9
 SHA512:
-  metadata.gz: 7b4986db539c73a5776e15941a7393b14ebb31afe79068756c2b561211907e013b66a1a7a9980864431b029b71ec0c8180e2dbfe7b4942987ca6d59f01877cb5
-  data.tar.gz: f1c7d0733a7ed4d64e0a9ad51c753485c0472233667181c6fbf2ba09be40936de9a411558be90a49ef9aa5e4804c44dfc3d5c90deda05a22286916e6c7d16e90
+  metadata.gz: 5414edd21a3f105513f6068d799fd25fd61672dcd50d0eedbb04b8e05e5224f62f9fcd5014456c99b17ae02c86e38e16077cce27b2c04bcc285214bb49213d45
+  data.tar.gz: 5f21ac1f5f8ee2f82d6c3ce65e0cb88ed66e055178c120b935be24a838ee1fc126d1a6070ea4833626e314d631c052748eccdce66db801bfafda01d7bc9c2b42

data/History.md

@@ -1,3 +1,43 @@
+## 2.2.0 / 2024-12-23
+
+* Bug fixes:
+  * `Rack::Test::Cookie` now parses cookie parameters using a
+    case-insensitive approach (Guillaume Malette #349)
+
+* Minor enhancements:
+  * Arrays of cookies containing a blank cookie are now handled
+    correctly when processing responses.  (Martin Emde #343)
+  * `Rack::Test::UploadedFile` no longer uses a finalizer for named
+    paths to close and unlink the created Tempfile.  Tempfile itself
+    uses a finalizer to close and unlink itself, so there is no
+    reason for `Rack::Test::UploadedFile` to do so (Jeremy Evans #338)
+
+## 2.1.0 / 2023-03-14
+
+* Breaking changes:
+  * Digest authentication support, deprecated in 2.0.0, has been
+    removed (Jeremy Evans #307)
+  * requiring rack/mock_session, deprecated in 2.0.0, has been removed
+    (Jeremy Evans #307)
+
+* Minor enhancements:
+  * The `original_filename` for `Rack::Test::UploadedFile` can now be
+    set even if the content of the file comes from a file path
+    (Stuart Chinery #314)
+  * Add `Rack::Test::Session#restore_state`, for executing a block
+    and restoring current state (last request, last response, and
+    cookies) after the block (Jeremy Evans #316)
+  * Make `Rack::Test::Methods` support `default_host` method similar to
+    `app`, which will set the default host used for requests to the app
+    (Jeremy Evans #317 #318)
+  * Allow responses to set cookie paths not matching the current
+    request URI. Such cookies will only be sent for paths matching
+    the cookie path (Chris Waters #322)
+  * Ignore leading dot for cookie domains, per RFC 6265 (Stephen Crosby
+    #329)
+  * Avoid creating empty multipart body if params is empty in
+    `Rack::Test::Session#env_for` (Ryunosuke Sato #331)
+
 ## 2.0.2 / 2022-06-28
 
 * Bug fixes:

data/README.md

@@ -41,7 +41,7 @@ class HomepageTest < Test::Unit::TestCase
     get '/'
 
     assert last_response.ok?
-    assert_equal last_response.body, 'All responses are OK'
+    assert_equal 'All responses are OK', last_response.body
   end
 
   def delete_with_url_params_and_body

data/lib/rack/test/cookie_jar.rb

@@ -12,7 +12,7 @@ module Rack
 
       # The name of the cookie, will be a string
       attr_reader :name
-      
+
       # The value of the cookie, will be a string or nil if there is no value.
       attr_reader :value
 
@@ -28,10 +28,11 @@ module Rack
         @raw, options = raw.split(/[;,] */n, 2)
 
         @name, @value = parse_query(@raw, ';').to_a.first
-        @options = parse_query(options, ';')
+        @options = Hash[parse_query(options, ';').map { |k, v| [k.downcase, v] }]
 
-        if @options['domain']
+        if domain = @options['domain']
           @exact_domain_match = false
+          domain[0] = '' if domain[0] == '.'
         else
           # If the domain attribute is not present in the cookie,
           # the domain must match exactly.
@@ -68,7 +69,7 @@ module Rack
       # Whether the cookie has the httponly flag, indicating it is not available via
       # a javascript API.
       def http_only?
-        @options.key?('HttpOnly') || @options.key?('httponly')
+        @options.key?('httponly')
       end
 
       # The explicit or implicit path for the cookie.
@@ -92,15 +93,13 @@ module Rack
 
         uri.host = @default_host if uri.host.nil?
 
-        real_domain = domain =~ /^\./ ? domain[1..-1] : domain
         !!((!secure? || (secure? && uri.scheme == 'https')) &&
-          uri.host =~ Regexp.new("#{'^' if @exact_domain_match}#{Regexp.escape(real_domain)}$", Regexp::IGNORECASE) &&
-          uri.path =~ Regexp.new("^#{Regexp.escape(path)}"))
+          uri.host =~ Regexp.new("#{'^' if @exact_domain_match}#{Regexp.escape(domain)}$", Regexp::IGNORECASE))
       end
 
       # Cookies that do not match the URI will not be sent in requests to the URI.
       def matches?(uri)
-        !expired? && valid?(uri)
+        !expired? && valid?(uri) && uri.path.start_with?(path)
       end
 
       # Order cookies by name, path, and domain.
@@ -110,11 +109,13 @@ module Rack
 
       # A hash of cookie options, including the cookie value, but excluding the cookie name.
       def to_h
-        @options.merge(
+        hash = @options.merge(
           'value'    => @value,
           'HttpOnly' => http_only?,
           'secure'   => secure?
         )
+        hash.delete('httponly')
+        hash
       end
       alias to_hash to_h
 
@@ -138,6 +139,12 @@ module Rack
         @cookies = cookies.sort!
       end
 
+      # Ensure the copy uses a distinct cookies array.
+      def initialize_copy(other)
+        super
+        @cookies = @cookies.dup
+      end
+
       # Return the value for first cookie with the given name, or nil
       # if no such cookie exists.
       def [](name)
@@ -177,12 +184,10 @@ module Rack
       def merge(raw_cookies, uri = nil)
         return unless raw_cookies
 
-        if raw_cookies.is_a? String
-          raw_cookies = raw_cookies.split("\n")
-          raw_cookies.reject!(&:empty?)
-        end
+        raw_cookies = raw_cookies.split("\n") if raw_cookies.is_a? String
 
         raw_cookies.each do |raw_cookie|
+          next if raw_cookie.empty?
           cookie = Cookie.new(raw_cookie, uri, @default_host)
           self << cookie if cookie.valid?(uri)
         end

data/lib/rack/test/methods.rb

@@ -42,7 +42,11 @@ module Rack
           # Backwards compatibility for capybara
           build_rack_mock_session
         else
-          Session.new(app)
+          if respond_to?(:default_host)
+            Session.new(app, default_host)
+          else
+            Session.new(app)
+          end
         end
       end
 
@@ -61,11 +65,6 @@ module Rack
         @_rack_test_current_session = session
       end
 
-      def digest_authorize(username, password) # :nodoc:
-        warn 'digest authentication support will be removed in rack-test 2.1', uplevel: 1
-        current_session._digest_authorize(username, password)
-      end
-
       def_delegators(:current_session,
         :request,
         :get,

data/lib/rack/test/uploaded_file.rb

@@ -27,16 +27,18 @@ module Rack
       # content :: is a path to a file, or an {IO} or {StringIO} object representing the content.
       # content_type :: MIME type of the file
       # binary :: Whether the file should be set to binmode (content treated as binary).
-      # original_filename :: The filename to use for the file if +content+ is a StringIO.
+      # original_filename :: The filename to use for the file. Required if content is StringIO, optional override if not
       def initialize(content, content_type = 'text/plain', binary = false, original_filename: nil)
+        @content_type = content_type
+        @original_filename = original_filename
+
         case content
         when StringIO
-          initialize_from_stringio(content, original_filename)
+          initialize_from_stringio(content)
         else
           initialize_from_file_path(content)
         end
 
-        @content_type = content_type
         @tempfile.binmode if binary
       end
 
@@ -70,38 +72,26 @@ module Rack
         tempfile.respond_to?(method_name, include_private) || super
       end
 
-      # A proc that can be used as a finalizer to close and unlink the tempfile.
-      def self.finalize(file)
-        proc { actually_finalize file }
-      end
-
-      # Close and unlink the given file, used as a finalizer for the tempfile,
-      # if the tempfile is backed by a file in the filesystem.
-      def self.actually_finalize(file)
-        file.close
-        file.unlink
-      end
-
       private
 
       # Use the StringIO as the tempfile.
-      def initialize_from_stringio(stringio, original_filename)
+      def initialize_from_stringio(stringio)
+        raise(ArgumentError, 'Missing `original_filename` for StringIO object') unless @original_filename
+
         @tempfile = stringio
-        @original_filename = original_filename || raise(ArgumentError, 'Missing `original_filename` for StringIO object')
       end
 
-      # Create a tempfile and copy the content from the given path into the tempfile.
+      # Create a tempfile and copy the content from the given path into the tempfile, optionally renaming if
+      # original_filename has been set.
       def initialize_from_file_path(path)
         raise "#{path} file does not exist" unless ::File.exist?(path)
 
-        @original_filename = ::File.basename(path)
+        @original_filename ||= ::File.basename(path)
         extension = ::File.extname(@original_filename)
 
         @tempfile = Tempfile.new([::File.basename(@original_filename, extension), extension])
         @tempfile.set_encoding(Encoding::BINARY)
 
-        ObjectSpace.define_finalizer(self, self.class.finalize(@tempfile))
-
         FileUtils.copy_file(path, @tempfile.path)
       end
     end

data/lib/rack/test/version.rb

@@ -1,5 +1,5 @@
 module Rack
   module Test
-    VERSION = '2.0.2'.freeze
+    VERSION = '2.2.0'.freeze
   end
 end

data/lib/rack/test.rb

@@ -98,8 +98,6 @@ module Rack
       # If a block is given, #last_response is also yielded to the block.
       def initialize(app, default_host = DEFAULT_HOST)
         @env = {}
-        @digest_username = nil
-        @digest_password = nil
         @app = app
         @after_request = []
         @default_host = default_host
@@ -204,21 +202,6 @@ module Rack
 
       alias authorize basic_authorize
 
-      # Set the username and password for HTTP Digest authorization, to be
-      # included in subsequent requests in the HTTP_AUTHORIZATION header.
-      # This method is deprecated and will be removed in rack-test 2.1
-      #
-      # Example:
-      #   digest_authorize "bryan", "secret"
-      def digest_authorize(username, password)
-        warn 'digest authentication support will be removed in rack-test 2.1', uplevel: 1
-        _digest_authorize(username, password)
-      end
-      def _digest_authorize(username, password) # :nodoc:
-        @digest_username = username
-        @digest_password = password
-      end
-
       # Rack::Test will not follow any redirects automatically. This method
       # will follow the redirect returned (including setting the Referer header
       # on the new request) in the last response. If the last response was not
@@ -251,6 +234,25 @@ module Rack
         )
       end
 
+      # Yield to the block, and restore the last request, last response, and
+      # cookie jar to the state they were prior to block execution upon
+      # exiting the block.
+      def restore_state
+        request = @last_request
+        response = @last_response
+        cookie_jar = @cookie_jar.dup
+        after_request = @after_request.dup
+
+        begin
+          yield
+        ensure
+          @last_request = request
+          @last_response = response
+          @cookie_jar = cookie_jar
+          @after_request = after_request
+        end
+      end
+
       private
 
       # :nocov:
@@ -310,7 +312,7 @@ module Rack
           multipart = env.has_key?(:multipart) ? env.delete(:multipart) : env['CONTENT_TYPE'].start_with?('multipart/')
 
           if params.is_a?(Hash)
-            if data = build_multipart(params, false, multipart)
+            if !params.empty? && data = build_multipart(params, false, multipart)
               env[:input] = data
               env['CONTENT_LENGTH'] ||= data.length.to_s
               env['CONTENT_TYPE'] = "#{multipart_content_type(env)}; boundary=#{MULTIPART_BOUNDARY}"
@@ -363,43 +365,9 @@ module Rack
         @after_request.each(&:call)
         @last_response.finish
 
-        if retry_with_digest_auth?(env)
-          auth_env = env.merge('HTTP_AUTHORIZATION' => digest_auth_header,
-                               'rack-test.digest_auth_retry' => true)
-          auth_env.delete('rack.request')
-          process_request(uri, auth_env)
-        else
-          yield last_response if block_given?
-
-          last_response
-        end
-      end
-
-      def digest_auth_header
-        require_relative 'test/mock_digest_request'
-
-        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['response'] = MockDigestRequest_.new(params).response(@digest_password)
+        yield @last_response if block_given?
 
-        "Digest #{params}"
-      end
-
-      def retry_with_digest_auth?(env)
-        last_response.status == 401 &&
-          digest_auth_configured? &&
-          !env['rack-test.digest_auth_retry']
-      end
-
-      def digest_auth_configured?
-        @digest_username
+        @last_response
       end
     end
 

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rack-test
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.2.0
 platform: ruby
 authors:
 - Jeremy Evans
 - Bryan Helmkamp
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-28 00:00:00.000000000 Z
+date: 2024-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -81,11 +81,9 @@ files:
 - History.md
 - MIT-LICENSE.txt
 - README.md
-- lib/rack/mock_session.rb
 - lib/rack/test.rb
 - lib/rack/test/cookie_jar.rb
 - lib/rack/test/methods.rb
-- lib/rack/test/mock_digest_request.rb
 - lib/rack/test/uploaded_file.rb
 - lib/rack/test/utils.rb
 - lib/rack/test/version.rb
@@ -97,7 +95,7 @@ metadata:
   bug_tracker_uri: https://github.com/rack/rack-test/issues
   mailing_list_uri: https://github.com/rack/rack-test/discussions
   changelog_uri: https://github.com/rack/rack-test/blob/main/History.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -112,8 +110,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key: 
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 summary: Simple testing API built on Rack
 test_files: []

data/lib/rack/mock_session.rb

@@ -1,2 +0,0 @@
-warn("requiring rack/mock_session is deprecated, require rack/test and use Rack::Test::Session", uplevel: 1)
-require_relative 'test'

data/lib/rack/test/mock_digest_request.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-# :nocov:
-require 'rack/auth/digest' unless defined?(Rack::Auth::Digest)
-# :nocov:
-
-module Rack
-  module Test
-    class MockDigestRequest_ # :nodoc:
-      def initialize(params)
-        @params = params
-      end
-
-      def method_missing(sym)
-        if @params.key? k = sym.to_s
-          return @params[k]
-        end
-
-        super
-      end
-
-      def method
-        @params['method']
-      end
-
-      def response(password)
-        Rack::Auth::Digest::MD5.new(nil).send :digest, self, password
-      end
-    end
-    MockDigestRequest = MockDigestRequest_
-    # :nocov:
-    deprecate_constant :MockDigestRequest if respond_to?(:deprecate_constant, true)
-    # :nocov:
-  end
-end