google-cloud-storage 1.30.0 → 1.39.0

data/lib/google/cloud/storage/credentials.rb

@@ -38,20 +38,22 @@ module Google
       #   storage.project_id #=> "my-project"
       #
       class Credentials < Google::Auth::Credentials
-        SCOPE = \
-          ["https://www.googleapis.com/auth/devstorage.full_control"].freeze
-        PATH_ENV_VARS = %w[STORAGE_CREDENTIALS
-                           STORAGE_KEYFILE
-                           GOOGLE_CLOUD_CREDENTIALS
-                           GOOGLE_CLOUD_KEYFILE
-                           GCLOUD_KEYFILE].freeze
-        JSON_ENV_VARS = %w[STORAGE_CREDENTIALS_JSON
-                           STORAGE_KEYFILE_JSON
-                           GOOGLE_CLOUD_CREDENTIALS_JSON
-                           GOOGLE_CLOUD_KEYFILE_JSON
-                           GCLOUD_KEYFILE_JSON].freeze
-        DEFAULT_PATHS = \
-          ["~/.config/gcloud/application_default_credentials.json"].freeze
+        SCOPE = ["https://www.googleapis.com/auth/devstorage.full_control"].freeze
+        PATH_ENV_VARS = [
+          "STORAGE_CREDENTIALS",
+          "STORAGE_KEYFILE",
+          "GOOGLE_CLOUD_CREDENTIALS",
+          "GOOGLE_CLOUD_KEYFILE",
+          "GCLOUD_KEYFILE"
+        ].freeze
+        JSON_ENV_VARS = [
+          "STORAGE_CREDENTIALS_JSON",
+          "STORAGE_KEYFILE_JSON",
+          "GOOGLE_CLOUD_CREDENTIALS_JSON",
+          "GOOGLE_CLOUD_KEYFILE_JSON",
+          "GCLOUD_KEYFILE_JSON"
+        ].freeze
+        DEFAULT_PATHS = ["~/.config/gcloud/application_default_credentials.json"].freeze
       end
     end
   end

data/lib/google/cloud/storage/file/acl.rb

@@ -190,7 +190,7 @@ module Google
                                             generation: generation,
                                             user_project: user_project
             entity = gapi.entity
-            @owners.push entity unless @owners.nil?
+            @owners&.push entity
             entity
           end
 
@@ -241,7 +241,7 @@ module Google
                                             generation: generation,
                                             user_project: user_project
             entity = gapi.entity
-            @readers.push entity unless @readers.nil?
+            @readers&.push entity
             entity
           end
 
@@ -281,8 +281,8 @@ module Google
             @service.delete_file_acl \
               @bucket, @file, entity,
               generation: generation, user_project: user_project
-            @owners.delete entity  unless @owners.nil?
-            @readers.delete entity unless @readers.nil?
+            @owners&.delete entity
+            @readers&.delete entity
             true
           end
 
@@ -297,6 +297,22 @@ module Google
           # Convenience method to apply the `authenticatedRead` predefined ACL
           # rule to the file.
           #
+          # @param [Integer] generation Select a specific revision of the file to
+          #   update. The default is the latest version.
+          # @param [Integer] if_generation_match Makes the operation conditional
+          #   on whether the file's current generation matches the given value.
+          #   Setting to 0 makes the operation succeed only if there are no live
+          #   versions of the file.
+          # @param [Integer] if_generation_not_match Makes the operation conditional
+          #   on whether the file's current generation does not match the given
+          #   value. If no live file exists, the precondition fails. Setting to 0
+          #   makes the operation succeed only if there is a live version of the file.
+          # @param [Integer] if_metageneration_match Makes the operation conditional
+          #   on whether the file's current metageneration matches the given value.
+          # @param [Integer] if_metageneration_not_match Makes the operation
+          #   conditional on whether the file's current metageneration does not
+          #   match the given value.
+          #
           # @example
           #   require "google/cloud/storage"
           #
@@ -307,8 +323,17 @@ module Google
           #   file = bucket.file "path/to/my-file.ext"
           #   file.acl.auth!
           #
-          def auth!
-            update_predefined_acl! "authenticatedRead"
+          def auth! generation: nil,
+                    if_generation_match: nil,
+                    if_generation_not_match: nil,
+                    if_metageneration_match: nil,
+                    if_metageneration_not_match: nil
+            update_predefined_acl! "authenticatedRead",
+                                   generation: generation,
+                                   if_generation_match: if_generation_match,
+                                   if_generation_not_match: if_generation_not_match,
+                                   if_metageneration_match: if_metageneration_match,
+                                   if_metageneration_not_match: if_metageneration_not_match
           end
           alias authenticatedRead! auth!
           alias auth_read! auth!
@@ -319,6 +344,22 @@ module Google
           # Convenience method to apply the `bucketOwnerFullControl` predefined
           # ACL rule to the file.
           #
+          # @param [Integer] generation Select a specific revision of the file to
+          #   update. The default is the latest version.
+          # @param [Integer] if_generation_match Makes the operation conditional
+          #   on whether the file's current generation matches the given value.
+          #   Setting to 0 makes the operation succeed only if there are no live
+          #   versions of the file.
+          # @param [Integer] if_generation_not_match Makes the operation conditional
+          #   on whether the file's current generation does not match the given
+          #   value. If no live file exists, the precondition fails. Setting to 0
+          #   makes the operation succeed only if there is a live version of the file.
+          # @param [Integer] if_metageneration_match Makes the operation conditional
+          #   on whether the file's current metageneration matches the given value.
+          # @param [Integer] if_metageneration_not_match Makes the operation
+          #   conditional on whether the file's current metageneration does not
+          #   match the given value.
+          #
           # @example
           #   require "google/cloud/storage"
           #
@@ -329,8 +370,17 @@ module Google
           #   file = bucket.file "path/to/my-file.ext"
           #   file.acl.owner_full!
           #
-          def owner_full!
-            update_predefined_acl! "bucketOwnerFullControl"
+          def owner_full! generation: nil,
+                          if_generation_match: nil,
+                          if_generation_not_match: nil,
+                          if_metageneration_match: nil,
+                          if_metageneration_not_match: nil
+            update_predefined_acl! "bucketOwnerFullControl",
+                                   generation: generation,
+                                   if_generation_match: if_generation_match,
+                                   if_generation_not_match: if_generation_not_match,
+                                   if_metageneration_match: if_metageneration_match,
+                                   if_metageneration_not_match: if_metageneration_not_match
           end
           alias bucketOwnerFullControl! owner_full!
 
@@ -338,6 +388,22 @@ module Google
           # Convenience method to apply the `bucketOwnerRead` predefined ACL
           # rule to the file.
           #
+          # @param [Integer] generation Select a specific revision of the file to
+          #   update. The default is the latest version.
+          # @param [Integer] if_generation_match Makes the operation conditional
+          #   on whether the file's current generation matches the given value.
+          #   Setting to 0 makes the operation succeed only if there are no live
+          #   versions of the file.
+          # @param [Integer] if_generation_not_match Makes the operation conditional
+          #   on whether the file's current generation does not match the given
+          #   value. If no live file exists, the precondition fails. Setting to 0
+          #   makes the operation succeed only if there is a live version of the file.
+          # @param [Integer] if_metageneration_match Makes the operation conditional
+          #   on whether the file's current metageneration matches the given value.
+          # @param [Integer] if_metageneration_not_match Makes the operation
+          #   conditional on whether the file's current metageneration does not
+          #   match the given value.
+          #
           # @example
           #   require "google/cloud/storage"
           #
@@ -348,8 +414,17 @@ module Google
           #   file = bucket.file "path/to/my-file.ext"
           #   file.acl.owner_read!
           #
-          def owner_read!
-            update_predefined_acl! "bucketOwnerRead"
+          def owner_read! generation: nil,
+                          if_generation_match: nil,
+                          if_generation_not_match: nil,
+                          if_metageneration_match: nil,
+                          if_metageneration_not_match: nil
+            update_predefined_acl! "bucketOwnerRead",
+                                   generation: generation,
+                                   if_generation_match: if_generation_match,
+                                   if_generation_not_match: if_generation_not_match,
+                                   if_metageneration_match: if_metageneration_match,
+                                   if_metageneration_not_match: if_metageneration_not_match
           end
           alias bucketOwnerRead! owner_read!
 
@@ -357,6 +432,22 @@ module Google
           # Convenience method to apply the `private` predefined ACL
           # rule to the file.
           #
+          # @param [Integer] generation Select a specific revision of the file to
+          #   update. The default is the latest version.
+          # @param [Integer] if_generation_match Makes the operation conditional
+          #   on whether the file's current generation matches the given value.
+          #   Setting to 0 makes the operation succeed only if there are no live
+          #   versions of the file.
+          # @param [Integer] if_generation_not_match Makes the operation conditional
+          #   on whether the file's current generation does not match the given
+          #   value. If no live file exists, the precondition fails. Setting to 0
+          #   makes the operation succeed only if there is a live version of the file.
+          # @param [Integer] if_metageneration_match Makes the operation conditional
+          #   on whether the file's current metageneration matches the given value.
+          # @param [Integer] if_metageneration_not_match Makes the operation
+          #   conditional on whether the file's current metageneration does not
+          #   match the given value.
+          #
           # @example
           #   require "google/cloud/storage"
           #
@@ -367,14 +458,39 @@ module Google
           #   file = bucket.file "path/to/my-file.ext"
           #   file.acl.private!
           #
-          def private!
-            update_predefined_acl! "private"
+          def private! generation: nil,
+                       if_generation_match: nil,
+                       if_generation_not_match: nil,
+                       if_metageneration_match: nil,
+                       if_metageneration_not_match: nil
+            update_predefined_acl! "private",
+                                   generation: generation,
+                                   if_generation_match: if_generation_match,
+                                   if_generation_not_match: if_generation_not_match,
+                                   if_metageneration_match: if_metageneration_match,
+                                   if_metageneration_not_match: if_metageneration_not_match
           end
 
           ##
           # Convenience method to apply the `projectPrivate` predefined ACL
           # rule to the file.
           #
+          # @param [Integer] generation Select a specific revision of the file to
+          #   update. The default is the latest version.
+          # @param [Integer] if_generation_match Makes the operation conditional
+          #   on whether the file's current generation matches the given value.
+          #   Setting to 0 makes the operation succeed only if there are no live
+          #   versions of the file.
+          # @param [Integer] if_generation_not_match Makes the operation conditional
+          #   on whether the file's current generation does not match the given
+          #   value. If no live file exists, the precondition fails. Setting to 0
+          #   makes the operation succeed only if there is a live version of the file.
+          # @param [Integer] if_metageneration_match Makes the operation conditional
+          #   on whether the file's current metageneration matches the given value.
+          # @param [Integer] if_metageneration_not_match Makes the operation
+          #   conditional on whether the file's current metageneration does not
+          #   match the given value.
+          #
           # @example
           #   require "google/cloud/storage"
           #
@@ -385,8 +501,17 @@ module Google
           #   file = bucket.file "path/to/my-file.ext"
           #   file.acl.project_private!
           #
-          def project_private!
-            update_predefined_acl! "projectPrivate"
+          def project_private! generation: nil,
+                               if_generation_match: nil,
+                               if_generation_not_match: nil,
+                               if_metageneration_match: nil,
+                               if_metageneration_not_match: nil
+            update_predefined_acl! "projectPrivate",
+                                   generation: generation,
+                                   if_generation_match: if_generation_match,
+                                   if_generation_not_match: if_generation_not_match,
+                                   if_metageneration_match: if_metageneration_match,
+                                   if_metageneration_not_match: if_metageneration_not_match
           end
           alias projectPrivate! project_private!
 
@@ -394,6 +519,22 @@ module Google
           # Convenience method to apply the `publicRead` predefined ACL
           # rule to the file.
           #
+          # @param [Integer] generation Select a specific revision of the file to
+          #   update. The default is the latest version.
+          # @param [Integer] if_generation_match Makes the operation conditional
+          #   on whether the file's current generation matches the given value.
+          #   Setting to 0 makes the operation succeed only if there are no live
+          #   versions of the file.
+          # @param [Integer] if_generation_not_match Makes the operation conditional
+          #   on whether the file's current generation does not match the given
+          #   value. If no live file exists, the precondition fails. Setting to 0
+          #   makes the operation succeed only if there is a live version of the file.
+          # @param [Integer] if_metageneration_match Makes the operation conditional
+          #   on whether the file's current metageneration matches the given value.
+          # @param [Integer] if_metageneration_not_match Makes the operation
+          #   conditional on whether the file's current metageneration does not
+          #   match the given value.
+          #
           # @example
           #   require "google/cloud/storage"
           #
@@ -404,8 +545,17 @@ module Google
           #   file = bucket.file "path/to/my-file.ext"
           #   file.acl.public!
           #
-          def public!
-            update_predefined_acl! "publicRead"
+          def public! generation: nil,
+                      if_generation_match: nil,
+                      if_generation_not_match: nil,
+                      if_metageneration_match: nil,
+                      if_metageneration_not_match: nil
+            update_predefined_acl! "publicRead",
+                                   generation: generation,
+                                   if_generation_match: if_generation_match,
+                                   if_generation_not_match: if_generation_not_match,
+                                   if_metageneration_match: if_metageneration_match,
+                                   if_metageneration_not_match: if_metageneration_not_match
           end
           alias publicRead! public!
           alias public_read! public!
@@ -418,9 +568,21 @@ module Google
             self
           end
 
-          def update_predefined_acl! acl_role
+          def update_predefined_acl! acl_role,
+                                     generation: nil,
+                                     if_generation_match: nil,
+                                     if_generation_not_match: nil,
+                                     if_metageneration_match: nil,
+                                     if_metageneration_not_match: nil
             patched_file = Google::Apis::StorageV1::Object.new acl: []
-            @service.patch_file @bucket, @file, patched_file,
+            @service.patch_file @bucket,
+                                @file,
+                                patched_file,
+                                generation: generation,
+                                if_generation_match: if_generation_match,
+                                if_generation_not_match: if_generation_not_match,
+                                if_metageneration_match: if_metageneration_match,
+                                if_metageneration_not_match: if_metageneration_not_match,
                                 predefined_acl: acl_role,
                                 user_project: user_project
             clear!
@@ -428,8 +590,7 @@ module Google
 
           def entities_from_acls acls, role
             selected = acls.select { |acl| acl.role == role }
-            entities = selected.map(&:entity)
-            entities
+            selected.map(&:entity)
           end
         end
       end

data/lib/google/cloud/storage/file/list.rb

@@ -141,17 +141,17 @@ module Google
           #     puts file.name
           #   end
           #
-          def all request_limit: nil
+          def all request_limit: nil, &block
             request_limit = request_limit.to_i if request_limit
             unless block_given?
               return enum_for :all, request_limit: request_limit
             end
             results = self
             loop do
-              results.each { |r| yield r }
+              results.each(&block)
               if request_limit
                 request_limit -= 1
-                break if request_limit < 0
+                break if request_limit.negative?
               end
               break unless results.next?
               results = results.next

data/lib/google/cloud/storage/file/signer_v2.rb

@@ -48,7 +48,7 @@ module Google
           #
           def ext_path
             path = "/#{@bucket}/#{@path}"
-            escaped = Addressable::URI.escape path
+            escaped = Addressable::URI.encode_component path, Addressable::URI::CharacterClasses::PATH
             special_var = "${filename}"
             # Restore the unencoded `${filename}` variable, if present.
             if path.include? special_var
@@ -147,10 +147,8 @@ module Google
               "&Expires=#{expires}" \
               "&Signature=#{url_escape signed_string}"
 
-            if query
-              query.each do |name, value|
-                url << "&#{url_escape name}=#{url_escape value}"
-              end
+            query&.each do |name, value|
+              url << "&#{url_escape name}=#{url_escape value}"
             end
 
             url

data/lib/google/cloud/storage/file/signer_v4.rb

@@ -60,7 +60,7 @@ module Google
 
             p = {}
             p["conditions"] = policy_conditions base_fields, conditions, fields
-            expires ||= 60*60*24
+            expires ||= 60 * 60 * 24
             p["expiration"] = (now + expires).strftime "%Y-%m-%dT%H:%M:%SZ"
 
             policy_str = escape_characters p.to_json
@@ -100,7 +100,7 @@ module Google
 
             algorithm = "GOOG4-RSA-SHA256"
             expires = determine_expires expires
-            credential = issuer + "/" + scope
+            credential = "#{issuer}/#{scope}"
             canonical_query_str = canonical_query query, algorithm, credential, goog_date, expires, signed_headers_str
 
             # From AWS: You don't include a payload hash in the Canonical
@@ -129,11 +129,10 @@ module Google
           end
 
           # methods below are public visibility only for unit testing
+          # rubocop:disable Style/StringLiterals
           def escape_characters str
             str.split("").map do |s|
-              if !s.ascii_only?
-                escape_special_unicode s
-              else
+              if s.ascii_only?
                 case s
                 when "\\"
                   '\\'
@@ -152,12 +151,15 @@ module Google
                 else
                   s
                 end
+              else
+                escape_special_unicode s
               end
             end.join
           end
+          # rubocop:enable Style/StringLiterals
 
           def escape_special_unicode str
-            str.unpack("U*").map { |i| '\u' + i.to_s(16).rjust(4, "0") }.join
+            str.unpack("U*").map { |i| "\\u#{i.to_s(16).rjust(4, '0')}" }.join
           end
 
           protected
@@ -212,14 +214,14 @@ module Google
             if signer.is_a? Proc
               lambda do |string_to_sign|
                 sig = signer.call string_to_sign
-                sig.unpack("H*").first
+                sig.unpack1 "H*"
               end
             else
               signer = OpenSSL::PKey::RSA.new signer unless signer.respond_to? :sign
               # Sign string to sign
               lambda do |string_to_sign|
                 sig = signer.sign OpenSSL::Digest::SHA256.new, string_to_sign
-                sig.unpack("H*").first
+                sig.unpack1 "H*"
               end
             end
           end
@@ -324,7 +326,7 @@ module Google
           #
           def post_object_ext_path
             path = "/#{@bucket_name}/#{@file_name}"
-            escaped = Addressable::URI.escape path
+            escaped = Addressable::URI.encode_component path, Addressable::URI::CharacterClasses::PATH
             special_var = "${filename}"
             # Restore the unencoded `${filename}` variable, if present.
             if path.include? special_var
@@ -359,7 +361,7 @@ module Google
               end
               packed_signature = signing_key.sign OpenSSL::Digest::SHA256.new, data
             end
-            packed_signature.unpack("H*").first.force_encoding "utf-8"
+            packed_signature.unpack1("H*").force_encoding "utf-8"
           end
         end
       end

data/lib/google/cloud/storage/file/verifier.rb

@@ -50,7 +50,7 @@ module Google
           end
 
           def self.md5_for local_file
-            if local_file.respond_to? :path
+            if local_file.respond_to? :to_path
               ::File.open Pathname(local_file).to_path, "rb" do |f|
                 ::Digest::MD5.file(f).base64digest
               end
@@ -63,7 +63,7 @@ module Google
           end
 
           def self.crc32c_for local_file
-            if local_file.respond_to? :path
+            if local_file.respond_to? :to_path
               ::File.open Pathname(local_file).to_path, "rb" do |f|
                 ::Digest::CRC32c.file(f).base64digest
               end