google-cloud-storage 1.29.2 → 1.33.0

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

@@ -212,8 +212,8 @@ module Google
         def deep_dup
           warn "DEPRECATED: Storage::PolicyV1#deep_dup"
           dup.tap do |p|
-            roles_dup = p.roles.each_with_object({}) do |(k, v), memo|
-              memo[k] = v.dup rescue value
+            roles_dup = p.roles.transform_values do |v|
+              v.dup rescue value
             end
             p.instance_variable_set :@roles, roles_dup
           end

data/lib/google/cloud/storage/policy/binding.rb

@@ -89,7 +89,9 @@ module Google
         #   end
         #
         class Binding
-          attr_reader :role, :members, :condition
+          attr_reader :role
+          attr_reader :members
+          attr_reader :condition
 
           ##
           # Creates a Binding object.
@@ -128,8 +130,8 @@ module Google
             raise ArgumentError, "members is empty, must be provided" if @members.empty?
 
             condition = Condition.new(**condition) if condition.is_a? Hash
-            if condition
-              raise ArgumentError, "expected Condition, not #{condition.inspect}" unless condition.is_a? Condition
+            if condition && !(condition.is_a? Condition)
+              raise ArgumentError, "expected Condition, not #{condition.inspect}"
             end
             @condition = condition
           end

data/lib/google/cloud/storage/policy/bindings.rb

@@ -168,10 +168,10 @@ module Google
           #     puts binding.role
           #   end
           #
-          def each
+          def each &block
             return enum_for :each unless block_given?
 
-            @bindings.each { |binding| yield binding }
+            @bindings.each(&block)
           end
 
           ##

data/lib/google/cloud/storage/policy/condition.rb

@@ -70,7 +70,9 @@ module Google
         #   end
         #
         class Condition
-          attr_reader :title, :description, :expression
+          attr_reader :title
+          attr_reader :description
+          attr_reader :expression
 
           ##
           # Creates a Condition object.
@@ -83,7 +85,7 @@ module Google
           #   one attributes, and statements are combined using logic operators,
           #   following CEL language specification. Required.
           #
-          def initialize title:, description: nil, expression:
+          def initialize title:, expression:, description: nil
             @title = String title
             @description = String description
             @expression = String expression

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

@@ -59,7 +59,8 @@ module Google
       #   post.fields["x-goog-signature"] #=> "4893a0e...cd82"
       #
       class PostObject
-        attr_reader :url, :fields
+        attr_reader :url
+        attr_reader :fields
 
         # @private
         def initialize url, fields

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

@@ -165,6 +165,11 @@ module Google
         #   without verifying the bucket resource exists on the Storage service.
         #   Calls made on this object will raise errors if the bucket resource
         #   does not exist. Default is `false`.
+        # @param [Integer] if_metageneration_match Makes the operation conditional
+        #   on whether the bucket's current metageneration matches the given value.
+        # @param [Integer] if_metageneration_not_match Makes the operation
+        #   conditional on whether the bucket's current metageneration does not
+        #   match the given value.
         # @param [Boolean, String] user_project If this parameter is set to
         #   `true`, transit costs for operations on the requested bucket or a
         #   file it contains will be billed to the current project for this
@@ -208,12 +213,19 @@ module Google
         #                           user_project: "my-other-project"
         #   files = bucket.files # Billed to "my-other-project"
         #
-        def bucket bucket_name, skip_lookup: false, user_project: nil
+        def bucket bucket_name,
+                   skip_lookup: false,
+                   if_metageneration_match: nil,
+                   if_metageneration_not_match: nil,
+                   user_project: nil
           if skip_lookup
             return Bucket.new_lazy bucket_name, service,
                                    user_project: user_project
           end
-          gapi = service.get_bucket bucket_name, user_project: user_project
+          gapi = service.get_bucket bucket_name,
+                                    if_metageneration_match: if_metageneration_match,
+                                    if_metageneration_not_match: if_metageneration_not_match,
+                                    user_project: user_project
           Bucket.from_gapi gapi, service, user_project: user_project
         rescue Google::Cloud::NotFoundError
           nil
@@ -611,11 +623,11 @@ module Google
         #     scopes = ["https://www.googleapis.com/auth/iam"]
         #     iam_client.authorization = Google::Auth.get_application_default scopes
         #
-        #     request = {
-        #       "payload": string_to_sign,
-        #     }
+        #     request = Google::Apis::IamcredentialsV1::SignBlobRequest.new(
+        #       payload: string_to_sign
+        #     )
         #     resource = "projects/-/serviceAccounts/#{issuer}"
-        #     response = iam_client.sign_service_account_blob resource, request, {}
+        #     response = iam_client.sign_service_account_blob resource, request
         #     response.signed_blob
         #   end
         #

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

@@ -83,9 +83,14 @@ module Google
         ##
         # Retrieves bucket by name.
         # Returns Google::Apis::StorageV1::Bucket.
-        def get_bucket bucket_name, user_project: nil
+        def get_bucket bucket_name,
+                       if_metageneration_match: nil,
+                       if_metageneration_not_match: nil,
+                       user_project: nil
           execute do
             service.get_bucket bucket_name,
+                               if_metageneration_match: if_metageneration_match,
+                               if_metageneration_not_match: if_metageneration_not_match,
                                user_project: user_project(user_project)
           end
         end
@@ -106,26 +111,38 @@ module Google
 
         ##
         # Updates a bucket, including its ACL metadata.
-        def patch_bucket bucket_name, bucket_gapi = nil, predefined_acl: nil,
-                         predefined_default_acl: nil, user_project: nil
+        def patch_bucket bucket_name,
+                         bucket_gapi = nil,
+                         predefined_acl: nil,
+                         predefined_default_acl: nil,
+                         if_metageneration_match: nil,
+                         if_metageneration_not_match: nil,
+                         user_project: nil
           bucket_gapi ||= Google::Apis::StorageV1::Bucket.new
           bucket_gapi.acl = [] if predefined_acl
           bucket_gapi.default_object_acl = [] if predefined_default_acl
 
           execute do
-            service.patch_bucket \
-              bucket_name, bucket_gapi,
-              predefined_acl: predefined_acl,
-              predefined_default_object_acl: predefined_default_acl,
-              user_project: user_project(user_project)
+            service.patch_bucket bucket_name,
+                                 bucket_gapi,
+                                 predefined_acl: predefined_acl,
+                                 predefined_default_object_acl: predefined_default_acl,
+                                 if_metageneration_match: if_metageneration_match,
+                                 if_metageneration_not_match: if_metageneration_not_match,
+                                 user_project: user_project(user_project)
           end
         end
 
         ##
         # Permanently deletes an empty bucket.
-        def delete_bucket bucket_name, user_project: nil
+        def delete_bucket bucket_name,
+                          if_metageneration_match: nil,
+                          if_metageneration_not_match: nil,
+                          user_project: nil
           execute do
             service.delete_bucket bucket_name,
+                                  if_metageneration_match: if_metageneration_match,
+                                  if_metageneration_not_match: if_metageneration_not_match,
                                   user_project: user_project(user_project)
           end
         end
@@ -290,41 +307,83 @@ module Google
 
         ##
         # Inserts a new file for the given bucket
-        def insert_file bucket_name, source, path = nil, acl: nil,
-                        cache_control: nil, content_disposition: nil,
-                        content_encoding: nil, content_language: nil,
-                        content_type: nil, custom_time: nil, crc32c: nil, md5: nil, metadata: nil,
-                        storage_class: nil, key: nil, kms_key: nil,
-                        temporary_hold: nil, event_based_hold: nil,
+        def insert_file bucket_name,
+                        source,
+                        path = nil,
+                        acl: nil,
+                        cache_control: nil,
+                        content_disposition: nil,
+                        content_encoding: nil,
+                        content_language: nil,
+                        content_type: nil,
+                        custom_time: nil,
+                        crc32c: nil,
+                        md5: nil,
+                        metadata: nil,
+                        storage_class: nil,
+                        key: nil,
+                        kms_key: nil,
+                        temporary_hold: nil,
+                        event_based_hold: nil,
+                        if_generation_match: nil,
+                        if_generation_not_match: nil,
+                        if_metageneration_match: nil,
+                        if_metageneration_not_match: nil,
                         user_project: nil
-          params =
-            { cache_control: cache_control, content_type: content_type, custom_time: custom_time,
-              content_disposition: content_disposition, md5_hash: md5,
-              content_encoding: content_encoding, crc32c: crc32c,
-              content_language: content_language, metadata: metadata,
-              storage_class: storage_class, temporary_hold: temporary_hold,
-              event_based_hold: event_based_hold }.delete_if { |_k, v| v.nil? }
+          params = {
+            cache_control: cache_control,
+            content_type: content_type,
+            custom_time: custom_time,
+            content_disposition: content_disposition,
+            md5_hash: md5,
+            content_encoding: content_encoding,
+            crc32c: crc32c,
+            content_language: content_language,
+            metadata: metadata,
+            storage_class: storage_class,
+            temporary_hold: temporary_hold,
+            event_based_hold: event_based_hold
+          }.delete_if { |_k, v| v.nil? }
           file_obj = Google::Apis::StorageV1::Object.new(**params)
           content_type ||= mime_type_for(path || Pathname(source).to_path)
 
           execute do
-            service.insert_object \
-              bucket_name, file_obj,
-              name: path, predefined_acl: acl, upload_source: source,
-              content_encoding: content_encoding, content_type: content_type,
-              kms_key_name: kms_key, user_project: user_project(user_project),
-              options: key_options(key)
+            service.insert_object bucket_name,
+                                  file_obj,
+                                  name: path,
+                                  predefined_acl: acl,
+                                  upload_source: source,
+                                  content_encoding: content_encoding,
+                                  content_type: content_type,
+                                  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,
+                                  kms_key_name: kms_key,
+                                  user_project: user_project(user_project),
+                                  options: key_options(key)
           end
         end
 
         ##
         # Retrieves an object or its metadata.
-        def get_file bucket_name, file_path, generation: nil, key: nil,
+        def get_file bucket_name,
+                     file_path,
+                     generation: nil,
+                     if_generation_match: nil,
+                     if_generation_not_match: nil,
+                     if_metageneration_match: nil,
+                     if_metageneration_not_match: nil,
+                     key: nil,
                      user_project: nil
           execute do
             service.get_object \
               bucket_name, file_path,
               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,
               user_project: user_project(user_project),
               options: key_options(key)
           end
@@ -332,42 +391,76 @@ module Google
 
         ## Rewrite a file from source bucket/object to a
         # destination bucket/object.
-        def rewrite_file source_bucket_name, source_file_path,
-                         destination_bucket_name, destination_file_path,
-                         file_gapi = nil, source_key: nil, destination_key: nil,
-                         destination_kms_key: nil, acl: nil, generation: nil,
-                         token: nil, user_project: nil
+        def rewrite_file source_bucket_name,
+                         source_file_path,
+                         destination_bucket_name,
+                         destination_file_path,
+                         file_gapi = nil,
+                         source_key: nil,
+                         destination_key: nil,
+                         destination_kms_key: nil,
+                         acl: nil,
+                         generation: nil,
+                         if_generation_match: nil,
+                         if_generation_not_match: nil,
+                         if_metageneration_match: nil,
+                         if_metageneration_not_match: nil,
+                         if_source_generation_match: nil,
+                         if_source_generation_not_match: nil,
+                         if_source_metageneration_match: nil,
+                         if_source_metageneration_not_match: nil,
+                         token: nil,
+                         user_project: nil
           key_options = rewrite_key_options source_key, destination_key
           execute do
-            service.rewrite_object \
-              source_bucket_name, source_file_path,
-              destination_bucket_name, destination_file_path,
-              file_gapi,
-              destination_kms_key_name: destination_kms_key,
-              destination_predefined_acl: acl,
-              source_generation: generation,
-              rewrite_token: token,
-              user_project: user_project(user_project),
-              options: key_options
+            service.rewrite_object source_bucket_name,
+                                   source_file_path,
+                                   destination_bucket_name,
+                                   destination_file_path,
+                                   file_gapi,
+                                   destination_kms_key_name: destination_kms_key,
+                                   destination_predefined_acl: acl,
+                                   source_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,
+                                   if_source_generation_match: if_source_generation_match,
+                                   if_source_generation_not_match: if_source_generation_not_match,
+                                   if_source_metageneration_match: if_source_metageneration_match,
+                                   if_source_metageneration_not_match: if_source_metageneration_not_match,
+                                   rewrite_token: token,
+                                   user_project: user_project(user_project),
+                                   options: key_options
           end
         end
 
         ## Copy a file from source bucket/object to a
         # destination bucket/object.
-        def compose_file bucket_name, source_files, destination_path,
-                         destination_gapi, acl: nil, key: nil, user_project: nil
+        def compose_file bucket_name,
+                         source_files,
+                         destination_path,
+                         destination_gapi,
+                         acl: nil,
+                         key: nil,
+                         if_source_generation_match: nil,
+                         if_generation_match: nil,
+                         if_metageneration_match: nil,
+                         user_project: nil
 
-          compose_req = Google::Apis::StorageV1::ComposeRequest.new \
-            source_objects: compose_file_source_objects(source_files),
-            destination: destination_gapi
+          source_objects = compose_file_source_objects source_files, if_source_generation_match
+          compose_req = Google::Apis::StorageV1::ComposeRequest.new source_objects: source_objects,
+                                                                    destination: destination_gapi
 
           execute do
-            service.compose_object \
-              bucket_name, destination_path,
-              compose_req,
-              destination_predefined_acl: acl,
-              user_project: user_project(user_project),
-              options: key_options(key)
+            service.compose_object bucket_name,
+                                   destination_path,
+                                   compose_req,
+                                   destination_predefined_acl: acl,
+                                   if_generation_match: if_generation_match,
+                                   if_metageneration_match: if_metageneration_match,
+                                   user_project: user_project(user_project),
+                                   options: key_options(key)
           end
         end
 
@@ -396,24 +489,48 @@ module Google
 
         ##
         # Updates a file's metadata.
-        def patch_file bucket_name, file_path, file_gapi = nil,
-                       predefined_acl: nil, user_project: nil
+        def patch_file bucket_name,
+                       file_path,
+                       file_gapi = nil,
+                       generation: nil,
+                       if_generation_match: nil,
+                       if_generation_not_match: nil,
+                       if_metageneration_match: nil,
+                       if_metageneration_not_match: nil,
+                       predefined_acl: nil,
+                       user_project: nil
           file_gapi ||= Google::Apis::StorageV1::Object.new
           execute do
-            service.patch_object \
-              bucket_name, file_path, file_gapi,
-              predefined_acl: predefined_acl,
-              user_project: user_project(user_project)
+            service.patch_object bucket_name,
+                                 file_path,
+                                 file_gapi,
+                                 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: predefined_acl,
+                                 user_project: user_project(user_project)
           end
         end
 
         ##
         # Permanently deletes a file.
-        def delete_file bucket_name, file_path, generation: nil,
+        def delete_file bucket_name,
+                        file_path,
+                        generation: nil,
+                        if_generation_match: nil,
+                        if_generation_not_match: nil,
+                        if_metageneration_match: nil,
+                        if_metageneration_not_match: nil,
                         user_project: nil
           execute do
             service.delete_object bucket_name, file_path,
                                   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,
                                   user_project: user_project(user_project)
           end
         end
@@ -615,8 +732,8 @@ module Google
             "false" => "NONE" }[str_or_bool.to_s.downcase]
         end
 
-        def compose_file_source_objects source_files
-          source_files.map do |file|
+        def compose_file_source_objects source_files, if_source_generation_match
+          source_objects = source_files.map do |file|
             if file.is_a? Google::Cloud::Storage::File
               Google::Apis::StorageV1::ComposeRequest::SourceObject.new \
                 name: file.name,
@@ -626,6 +743,18 @@ module Google
                 name: file
             end
           end
+          return source_objects unless if_source_generation_match
+          if source_files.count != if_source_generation_match.count
+            raise ArgumentError, "if provided, if_source_generation_match length must match sources length"
+          end
+          if_source_generation_match.each_with_index do |generation, i|
+            next unless generation
+            object_preconditions = Google::Apis::StorageV1::ComposeRequest::SourceObject::ObjectPreconditions.new(
+              if_generation_match: generation
+            )
+            source_objects[i].object_preconditions = object_preconditions
+          end
+          source_objects
         end
 
         def execute