http.rb 1.3.8 → 1.3.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5cab4dfd9757c08463389bff8595489378a59ecb3149cbdfcc465ab6a508536e
-  data.tar.gz: 5fe112a78858fc9deee9a1b8ab29cf71325a7e0801fd6b6d33e3f48835aba2dd
+  metadata.gz: 873748118e3dfd0adeeccf8c1fe6db2e407eb2f6c34515bbc3fafbdf332e8b7b
+  data.tar.gz: 9a9df13975fdacee8e5e9933e5ed31fed099fa4d0601e722a805fa60048a7cf0
 SHA512:
-  metadata.gz: a9678a45ae024d10874c9fdd9781e785b64f2e9818c85cc991b7af6bff8f56d38d3cad1f53d606bf36ff758581a1c2106e3b38c5f88224aa6d5272833ee97482
-  data.tar.gz: 8f9c36f7f2496a752c55a3352eb867585e787d72d63e87c8a124576b849517e213bd997d92415d2819eaac3f21a47099bef2f3a2f8e85e473aea6d8a3c9ab560
+  metadata.gz: 46f719719823a8e30ec6e5690973f10ab6f8ea81037d1083079a8ae574a0ed311ebb378dbf452c5667b649bf50a333497342e751677f4f35d14f27493c6f57ab
+  data.tar.gz: 0cc192a342f6c171d38b6338996aac5f96369e59ced845c0171048253d1ee44b5efe5bc67ec4fa19e5f9ca4d759949785156196832ff751f597d41f1ae09a5c5

data/CHANGELOG

@@ -1,5 +1,30 @@
 # CHANGELOG
 
+## 20261011
+
+1.3.10: A block is yielded to once, with the response.
+
+With a block, a followed redirect yielded the final response to it, and then yielded again whatever the block had returned, since that is what the redirected request returned and it was taken for the response: a block which returned an Array was handed that Array. With no_redirect set, the block was yielded the redirect and the redirect was then followed regardless, the branch yielding without returning, so the block was yielded to three times and a request was made which had been asked not to be.
+
+1. ~ HTTP.request: a followed redirect returns what the redirected request returns, which has already been yielded where there is a block, rather than yielding it again.
+2. ~ HTTP.request: no_redirect is a condition of following rather than a branch of its own, so that the redirect is yielded or returned as any other response is, and not followed.
+3. ~ test/HTTP/REDIRECT_test.rb: + one yield with the final response when a redirect is followed, and one with the redirect when no_redirect is set. Both fail against 1.3.9.
+4. ~ HTTP::VERSION: /1.3.9/1.3.10/
+
+
+## 20261011
+
+1.3.9: Only a 301, 302, 303, 307, or 308 with a Location is followed.
+
+Any 3xx was taken for a redirect. A 304 Not Modified carries no Location, so URI#merge was handed nil and raised ArgumentError, as did any 3xx without one. And a 300 Multiple Choices was followed to whatever its Location named, though it is a list of choices for the caller, the Location being only the server's preference among them. These are answers rather than redirects, and are now returned as they are.
+
+1. ~ lib/HTTP/REDIRECT.rb: + HTTP::REDIRECT::CODES (301, 302, 303, 307, 308); + HTTP.redirect?, which is true of a response with one of those codes and a Location.
+2. ~ HTTP.request: follows what redirect? is true of, rather than whatever begins with a 3.
+3. ~ test/HTTP/REDIRECT_test.rb: + 300 and 304 returned as they are, as is a 302 without a Location. All three fail against 1.3.8: the 300 and the 304 were followed, and the 302 raised.
+4. ~ README.md: + which responses are followed, under Redirections.
+5. ~ HTTP::VERSION: /1.3.8/1.3.9/
+
+
 ## 20261011
 
 1.3.8: Headers are carried through a 301, 302, or 303.

data/README.md

@@ -95,6 +95,8 @@ When both are supplied, the options hash wins.
 
 ### Redirections
 
+301, 302, 303, 307, and 308 responses with a `Location` are followed. Other 3xx responses, such as 300 and 304, are returned as they are.
+
 Redirects are followed with the headers they were given, except that `Authorization` and `Cookie`, and the `username:` and `password:` options, go no further than the origin (scheme, host, and port) they were given to. Where a redirect makes the request a GET, `Content-Type` is left behind, there being no body for it to describe.
 
 ### Preventing redirections

data/lib/HTTP/REDIRECT.rb

@@ -3,9 +3,17 @@
 
 module HTTP
   module REDIRECT
+    CODES = %w{301 302 303 307 308}.freeze
     CREDENTIAL_HEADERS = %w{authorization cookie}.freeze
   end
 
+  # A 300 or a 304 is an answer rather than somewhere else to go, and a 3xx without a
+  # Location has nowhere to send it.
+  def redirect?(response)
+    REDIRECT::CODES.include?(response.code) && !response['location'].to_s.empty?
+  end
+  module_function :redirect?
+
   def same_origin?(a, b)
     [a.scheme, a.host, a.port] == [b.scheme, b.host, b.port]
   end

data/lib/HTTP/VERSION.rb

@@ -2,5 +2,5 @@
 # HTTP::VERSION
 
 module HTTP
-  VERSION = '1.3.8'
+  VERSION = '1.3.10'
 end

data/lib/HTTP/request.rb

@@ -40,19 +40,14 @@ module HTTP
         http.request(request_object)
       end
     )
-    if response.code =~ /^3/
-      if block_given? && no_redirect
-        yield response
-      elsif no_redirect
-        return response
-      end
+    if !no_redirect && redirect?(response)
       redirect_uri = uri.merge(response['location'])
       onward_options = redirect_options(given_options, uri, redirect_uri)
       if response.code =~ /^30[78]$/
         data = METHODS::WITH_BODY.include?(request_method) ? request_object.body : {}
-        response = send(request_method, redirect_uri.to_s, data, redirect_headers(headers, uri, redirect_uri), onward_options, &block)
+        return send(request_method, redirect_uri.to_s, data, redirect_headers(headers, uri, redirect_uri), onward_options, &block)
       else
-        response = get(redirect_uri.to_s, {}, redirect_headers(headers, uri, redirect_uri, drop_content_type: true), onward_options, &block)
+        return get(redirect_uri.to_s, {}, redirect_headers(headers, uri, redirect_uri, drop_content_type: true), onward_options, &block)
       end
     end
     if block_given?

data/test/HTTP/REDIRECT_test.rb

@@ -96,4 +96,37 @@ describe "redirect behaviour" do
       assert_requested(:get, other_origin_uri){|request| !request.headers.key?('Authorization')}
     end
   end
+
+  describe "3xx responses which are not followed" do
+    %w{300 304}.each do |code|
+      it "return a #{code} as it is" do
+        stub_request(:get, uri).to_return(status: code.to_i, headers: {'location' => other_origin_uri})
+        _(HTTP.get(uri).code).must_equal(code)
+        assert_not_requested(:get, other_origin_uri)
+      end
+    end
+
+    it "return a redirect without a Location as it is" do
+      stub_request(:get, uri).to_return(status: 302)
+      _(HTTP.get(uri).code).must_equal('302')
+    end
+  end
+
+  describe "with a block" do
+    it "yields once when a redirect is followed" do
+      stub_request(:get, uri).to_return(status: 302, headers: {'location' => other_origin_uri})
+      stub_request(:get, other_origin_uri).to_return(status: 200)
+      yielded = []
+      HTTP.get(uri){|response| yielded << response.code}
+      _(yielded).must_equal(['200'])
+    end
+
+    it "yields once, with the redirect, when no_redirect is set" do
+      stub_request(:get, uri).to_return(status: 302, headers: {'location' => other_origin_uri})
+      yielded = []
+      HTTP.get(uri, {}, {}, {no_redirect: true}){|response| yielded << response.code}
+      _(yielded).must_equal(['302'])
+      assert_not_requested(:get, other_origin_uri)
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: http.rb
 version: !ruby/object:Gem::Version
-  version: 1.3.8
+  version: 1.3.10
 platform: ruby
 authors:
 - thoran