[rubygems/rubygems] Let s3_uri_signer accept the HTTP method

ruby/rubygems@35fc7f9547

Author: rye-stripe

lib/rubygems/remote_fetcher.rb

@@ -267,16 +267,16 @@ def fetch_path(uri, mtime = nil, head = false)
 
   def fetch_s3(uri, mtime = nil, head = false)
     begin
-      public_uri = s3_uri_signer(uri, head).sign
+      public_uri = s3_uri_signer(uri, head ? "HEAD" : "GET").sign
     rescue Gem::S3URISigner::ConfigurationError, Gem::S3URISigner::InstanceProfileError => e
       raise FetchError.new(e.message, "s3://#{uri.host}")
     end
     fetch_https public_uri, mtime, head
   end
 
   # we have our own signing code here to avoid a dependency on the aws-sdk gem
-  def s3_uri_signer(uri, head)
-    Gem::S3URISigner.new(uri, head)
+  def s3_uri_signer(uri, method)
+    Gem::S3URISigner.new(uri, method)
   end
 
   ##

lib/rubygems/s3_uri_signer.rb

@@ -27,11 +27,11 @@ def to_s # :nodoc:
   end
 
   attr_accessor :uri
-  attr_accessor :head
+  attr_accessor :method
 
-  def initialize(uri, head)
+  def initialize(uri, method)
     @uri = uri
-    @head = head
+    @method = method
   end
 
   ##
@@ -75,7 +75,7 @@ def generate_canonical_query_params(s3_config, date_time, credential_info, expir
 
   def generate_canonical_request(canonical_host, query_params)
     [
-      head ? "HEAD" : "GET",
+      method.upcase,
       uri.path,
       query_params,
       "host:#{canonical_host}",

test/rubygems/test_gem_remote_fetcher_s3.rb

@@ -18,7 +18,7 @@ def setup
     @a1.loaded_from = File.join(@gemhome, "specifications", @a1.full_name)
   end
 
-  def assert_fetch_s3(url, signature, token=nil, region="us-east-1", instance_profile_json=nil, head=false)
+  def assert_fetch_s3(url, signature, token=nil, region="us-east-1", instance_profile_json=nil, method="GET")
     fetcher = Gem::RemoteFetcher.new nil
     @fetcher = fetcher
     $fetched_uri = nil
@@ -33,9 +33,9 @@ def res.body
       res
     end
 
-    def fetcher.s3_uri_signer(uri, head)
+    def fetcher.s3_uri_signer(uri, method)
       require "json"
-      s3_uri_signer = Gem::S3URISigner.new(uri, head)
+      s3_uri_signer = Gem::S3URISigner.new(uri, method)
       def s3_uri_signer.ec2_metadata_credentials_json
         JSON.parse($instance_profile)
       end
@@ -45,13 +45,13 @@ def s3_uri_signer.ec2_metadata_credentials_json
       s3_uri_signer
     end
 
-    res = fetcher.fetch_s3 Gem::URI.parse(url), nil, head
+    res = fetcher.fetch_s3 Gem::URI.parse(url), nil, (method == "HEAD")
 
     assert_equal "https://my-bucket.s3.#{region}.amazonaws.com/gems/specs.4.8.gz?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=testuser%2F20190624%2F#{region}%2Fs3%2Faws4_request&X-Amz-Date=20190624T051941Z&X-Amz-Expires=86400#{token ? "&X-Amz-Security-Token=" + token : ""}&X-Amz-SignedHeaders=host&X-Amz-Signature=#{signature}", $fetched_uri.to_s
-    if !head
-      assert_equal "success", res
-    else
+    if method == "HEAD"
       assert_equal 200, res.code
+    else
+      assert_equal "success", res
     end
   ensure
     $fetched_uri = nil
@@ -78,8 +78,8 @@ def test_fetch_s3_head_request
       token = nil
       region = "us-east-1"
       instance_profile_json = nil
-      head = true
-      assert_fetch_s3 url, "a3c6cf9a2db62e85f4e57f8fc8ac8b5ff5c1fdd4aeef55935d05e05174d9c885", token, region, instance_profile_json, head
+      method = "HEAD"
+      assert_fetch_s3 url, "a3c6cf9a2db62e85f4e57f8fc8ac8b5ff5c1fdd4aeef55935d05e05174d9c885", token, region, instance_profile_json, method
     end
   ensure
     Gem.configuration[:s3_source] = nil