http.rb 1.5.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72cf60480847b43b60b63378d803acae19a12c127ceb9695ed8b0eca99ca57a4
-  data.tar.gz: aed0e179795a1f408823cb5cecca6bb2c877a1e4a90c3a31f21a115a5270a2e6
+  metadata.gz: 9a0a461fdf56bdea8f5f4b1940f0af469ef67e3fd7bd1319cc33245ff50641bb
+  data.tar.gz: 45e533a1a9cf2934d78cc8b6f29e58e4a73e8d26485a1cef12ad98f4be04b9e7
 SHA512:
-  metadata.gz: b8e095a766f24d074324536e89dc07871bc8670785fe14f95470a06e64a4107e0c7c2df44f746c8dbd9c31d7b79336e8548aaf5601e4121db86f5787c1ee66bb
-  data.tar.gz: c5637e2490a1605d4112162bad17c12d70e1536af814901c1bdc2572eb730f15e54b0eb8db2db3ff6057d872b9969b7852c5767872b9108ce257a160a9ebf24f
+  metadata.gz: 73bc96382cf88af02f52f48e36d004e9b1dfee91e658700495f712632d55793f1543e253bdcccca09c6bda7fc71c59d61448818f89b8b8fc1a355becfd5d3ffb
+  data.tar.gz: 814f7dcd3026a55a675c87d311b8e724f843895768c996c4e4c5f3283c38a81f46d03934256fa832835135229a042439655261a649bccec07cb5e8189006a010

data/CHANGELOG

@@ -1,4 +1,28 @@
-# CHANGELOG
+# http/CHANGELOG
+
+## 20261018
+
+1.7.0: lib/HTTP.rb --> lib/http.rb
+
+1. lib/HTTP.rb --> lib/http.rb, so that it resolves the same on case-sensitive filesystems.
+2. + test/loading_test.rb: lib/ carries http.rb, and require 'http.rb' in a fresh process defines HTTP and HTTP::VERSION.
+3. ~ test/helper.rb: + skip_webmocks_http_rb_adapter()
+4. ~ HTTP::VERSION: /1.6.0/1.7.0/
+
+
+## 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
 

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.7.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/lib/{HTTP.rb → http.rb}

@@ -1,4 +1,4 @@
-# HTTP.rb
+# http.rb
 # HTTP
 
 require 'HTTP/METHODS'

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
 

data/test/helper.rb

@@ -3,16 +3,19 @@
 lib_dir = File.expand_path(File.join(__FILE__, '..', '..', 'lib'))
 $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
 
-# Skip webmock's http_rb adapter: it auto-requires 'http', which collides
-# with this gem's lib/HTTP.rb on case-insensitive filesystems and crashes
-# while trying to monkey-patch the wrong HTTP module.
+# webmock's http_rb adapter's require 'http' finds this gem's lib/http.rb,
+# takes HTTP::VERSION for the http gem's, and crashes trying to
+# monkey-patch an HTTP::Client which isn't there.
+def skip_webmocks_http_rb_adapter
+  gem 'webmock'
 
-gem 'webmock'
+  $LOADED_FEATURES << File.join(
+    Gem.loaded_specs['webmock'].full_gem_path,
+    'lib/webmock/http_lib_adapters/http_rb_adapter.rb'
+  )
+end
 
-$LOADED_FEATURES << File.join(
-  Gem.loaded_specs['webmock'].full_gem_path,
-  'lib/webmock/http_lib_adapters/http_rb_adapter.rb'
-)
+skip_webmocks_http_rb_adapter
 
 require 'minitest/autorun'
 require 'minitest/mock'

data/test/loading_test.rb

@@ -0,0 +1,30 @@
+# test/loading_test.rb
+
+require 'minitest/autorun'
+
+require_relative '../lib/http'
+
+# In its own process, since this one has loaded the file directly and so could
+# not tell what requiring the gem by its own name would bring.
+describe 'loading' do
+  def ruby(source)
+    lib = File.expand_path('../lib', __dir__)
+    IO.popen(['ruby', "-I#{lib}", '-e', source], err: [:child, :out]){|io| io.read}.strip
+  end
+
+  # The gem is http.rb, so require 'http.rb' reads lib/http.rb.  A capitalised
+  # load file answers that only on a case-insensitive filesystem.  Dir.entries
+  # reports the name as stored, so this asks what a case-sensitive filesystem
+  # would ask.
+  it "carries the lowercase file the gem's name asks for" do
+    _(Dir.entries(File.expand_path('../lib', __dir__))).must_include 'http.rb'
+  end
+
+  it "defines HTTP upon requiring the gem by name" do
+    _(ruby('require "http.rb"; print defined?(HTTP)')).must_equal 'constant'
+  end
+
+  it "defines the version too" do
+    _(ruby('require "http.rb"; print HTTP::VERSION')).must_equal HTTP::VERSION
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: http.rb
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.7.0
 platform: ruby
 authors:
 - thoran
@@ -93,7 +93,6 @@ files:
 - README.md
 - Rakefile
 - http.rb.gemspec
-- lib/HTTP.rb
 - lib/HTTP/METHODS.rb
 - lib/HTTP/REDIRECT.rb
 - lib/HTTP/RETRY.rb
@@ -108,6 +107,7 @@ files:
 - lib/Thoran/Hash/XWwwFormUrlencode/x_www_form_urlencode.rb
 - lib/Thoran/String/Urlencode/urlencode.rb
 - lib/URI/Generic/use_sslQ.rb
+- lib/http.rb
 - test/HTTP/METHODS_test.rb
 - test/HTTP/REDIRECT_test.rb
 - test/HTTP/RETRY_test.rb
@@ -126,6 +126,7 @@ files:
 - test/Net/HTTPResponse/StatusPredicates_test.rb
 - test/Thoran/String/Urlencode/urlencode_test.rb
 - test/helper.rb
+- test/loading_test.rb
 homepage: https://github.com/thoran/http
 licenses:
 - MIT