http.rb 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72cf60480847b43b60b63378d803acae19a12c127ceb9695ed8b0eca99ca57a4
-  data.tar.gz: aed0e179795a1f408823cb5cecca6bb2c877a1e4a90c3a31f21a115a5270a2e6
+  metadata.gz: 2483f99ec13020c1e1c780b84c7dcddc68437687b1176e7fb88ba228adf084af
+  data.tar.gz: 710dd8eed5142ac832553595e581bd2597174dd1131fb14a7c51d4e7f17f4992
 SHA512:
-  metadata.gz: b8e095a766f24d074324536e89dc07871bc8670785fe14f95470a06e64a4107e0c7c2df44f746c8dbd9c31d7b79336e8548aaf5601e4121db86f5787c1ee66bb
-  data.tar.gz: c5637e2490a1605d4112162bad17c12d70e1536af814901c1bdc2572eb730f15e54b0eb8db2db3ff6057d872b9969b7852c5767872b9108ce257a160a9ebf24f
+  metadata.gz: dbe519101ddbd07038de07ca7bbcb28bbb2b7c53d0f650df86092433271469da3491326dce2d9c3698f78cb381de5a9f48b57054b0b8b8301adc1118e2cead87
+  data.tar.gz: 87e66da4b78467b289dafc3a280a7f9592af77e39f6878128c3586a0ea7ade24e2589239e8beb35d43c8e52e31ca79626f04d1ee1f31347b55f5ddf41945145a

data/CHANGELOG

@@ -1,5 +1,19 @@
 # CHANGELOG
 
+## 20261011
+
+1.6.0: The response's uri is the URI it came from, which, where redirects were followed, is where they ended.
+
+Nothing recorded where a response had come from: the request objects are made from a path rather than a URI, so Net::HTTP left response.uri nil, and a caller whose request was redirected had no way of knowing where to. A spider resolving the links on a page against the page's address needs it, as does anything noticing that it has been sent to a login page.
+
+1. ~ lib/HTTP/REDIRECT.rb: + HTTP.response_uri, which leaves out any credentials embedded in the URI, a response being something which is passed around and printed.
+2. ~ HTTP.request: response.uri is set to response_uri of the URI requested, so that after redirects it is the last of them.
+3. ~ HTTP::TooManyRedirects: the message names the URI of the redirect not followed as well as its Location.
+4. ~ test/HTTP/REDIRECT_test.rb: + the final URI without a redirect, after one, with no_redirect, and without embedded credentials; the URI of the redirect TooManyRedirects carries. All fail against 1.5.0.
+5. ~ README.md: + the response's uri, under Redirections, and in the Limiting redirections example.
+6. ~ HTTP::VERSION: /1.5.0/1.6.0/
+
+
 ## 20261011
 
 1.5.0: + max_redirects; + HTTP::TooManyRedirects.

data/README.md

@@ -112,6 +112,14 @@ A body repeated keeps its `Content-Type`, form data's included. Where the method
 
 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.
 
+The response's `uri` is the URI it came from, which, where redirects were followed, is where they ended:
+
+```ruby
+response = HTTP.get('http://example.com/moved')
+response.uri
+# => #<URI::HTTP http://example.com/new_location>
+```
+
 ### Preventing redirections
 
 ```ruby
@@ -129,6 +137,7 @@ HTTP.get('http://example.com', {}, {}, {max_redirects: 5})
 begin
   HTTP.get('http://example.com/loop')
 rescue HTTP::TooManyRedirects => e
+  e.response.uri
   e.response['location']
 end
 ```

data/lib/HTTP/REDIRECT.rb

@@ -13,7 +13,7 @@ module HTTP
 
     def initialize(response)
       @response = response
-      super("Too many redirects: #{response.code} to #{response['location']}")
+      super("Too many redirects: #{response.code} from #{response.uri} to #{response['location']}")
     end
   end
 
@@ -68,4 +68,14 @@ module HTTP
     options.reject{|k, v| %i{username password}.include?(k)}
   end
   module_function :redirect_options
+
+  # Embedded credentials are left out, a response being something which is passed
+  # around and printed.  URI#userinfo= ignores nil, whereas URI#user= takes the password
+  # with it.
+  def response_uri(uri)
+    uri = uri.dup
+    uri.user = nil if uri.user
+    uri
+  end
+  module_function :response_uri
 end

data/lib/HTTP/VERSION.rb

@@ -2,5 +2,5 @@
 # HTTP::VERSION
 
 module HTTP
-  VERSION = '1.5.0'
+  VERSION = '1.6.0'
 end

data/lib/HTTP/request.rb

@@ -41,6 +41,7 @@ module HTTP
         http.request(request_object)
       end
     )
+    response.uri = response_uri(uri)
     if !no_redirect && redirect?(response)
       raise TooManyRedirects.new(response) if max_redirects < 1
       redirect_uri = uri.merge(response['location'])

data/test/HTTP/REDIRECT_test.rb

@@ -7,6 +7,29 @@ describe "redirect behaviour" do
   let(:same_origin_uri){'http://example.com/elsewhere'}
   let(:other_origin_uri){'http://redirected.com/path'}
 
+  describe "the final URI" do
+    it "is the requested URI when there is no redirect" do
+      stub_request(:get, uri).to_return(status: 200)
+      _(HTTP.get(uri).uri.to_s).must_equal(uri)
+    end
+
+    it "is the URI redirected to 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)
+      _(HTTP.get(uri).uri.to_s).must_equal(other_origin_uri)
+    end
+
+    it "is the URI which redirected when no_redirect is set" do
+      stub_request(:get, uri).to_return(status: 302, headers: {'location' => other_origin_uri})
+      _(HTTP.get(uri, {}, {}, {no_redirect: true}).uri.to_s).must_equal(uri)
+    end
+
+    it "carries no embedded credentials" do
+      stub_request(:get, uri).with(basic_auth: ['alice', 'secret']).to_return(status: 200)
+      _(HTTP.get('http://alice:secret@example.com/path').uri.to_s).must_equal(uri)
+    end
+  end
+
   describe "headers" do
     %w{301 302 303 307 308}.each do |code|
       it "are carried through a #{code}" do
@@ -230,6 +253,7 @@ describe "redirect behaviour" do
     it "raises TooManyRedirects, with the redirect not followed, when there are more" do
       error = _(->{HTTP.get('http://example.com/0', {}, {}, {max_redirects: 1})}).must_raise(HTTP::TooManyRedirects)
       _(error.response['location']).must_equal('/2')
+      _(error.response.uri.to_s).must_equal('http://example.com/1')
       assert_not_requested(:get, 'http://example.com/2')
     end
 

metadata

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