google-cloud-storage 1.36.2 → 1.44.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c20986682a3f95c8fbea7f0132f5196d35f7978ba2b873530332a9709d3316c
-  data.tar.gz: 14de14960774f46eeaf07bbf9d8188228441dfdd8cb7b2c9a3649869f0909258
+  metadata.gz: 7829a0c2c9afddc17d897bd33e73af95e922a4767bfd6d6e8474eec0bac46194
+  data.tar.gz: 41f4328eb840bb9f2373cd291e2271e95d6f066db1a0dd62dbb7354e9e9c8c0e
 SHA512:
-  metadata.gz: 95d9b766685011b4421ff24fb2ceaa8aa42a8c89e9ad12aab6ca3e496bf01788ef9bd191554acefa9e9d2be0154292fd56d78953bf731446b65a20c97cc3ee51
-  data.tar.gz: b8748e786883a80b98fa77c927342656bb54ba69d8e309b2a11076bde8667671b2f0398abf694b49538761aa4bad08f5b59c4d39a38923f3afd1695f385a8e1c
+  metadata.gz: ec55a9d4632ee6f5d3637e6b4dc5d156ba45fc01da7b20d7f2e69a1fa4945d55d300385ee6aafba2244edcdf8fe0f36be1340adb28c074920cfad4eca667af21
+  data.tar.gz: 2194c91da01d5719d35756e3a9e1aceb49bfd9e15fb0466ddd8a7c4fae64074e06be41ea14437d0ed8698c777ab7c81f5ea6d90d5932336603c7dd99c5907558

data/CHANGELOG.md

@@ -1,5 +1,61 @@
 # Release History
 
+### 1.44.0 (2022-11-02)
+
+#### Features
+
+* support autoclass 
+
+### 1.43.0 (2022-09-30)
+
+#### Features
+
+* Add retry conformance test ([#18230](https://github.com/googleapis/google-cloud-ruby/issues/18230)) 
+
+### 1.42.0 (2022-09-21)
+
+#### Features
+
+* send invocation_id header in all requests ([#19161](https://github.com/googleapis/google-cloud-ruby/issues/19161)) 
+
+### 1.41.0 (2022-09-16)
+
+#### Features
+
+* add retry support for non-idempotent operations ([#19134](https://github.com/googleapis/google-cloud-ruby/issues/19134)) 
+#### Bug Fixes
+
+* Correct options checks in retry operations ([#19135](https://github.com/googleapis/google-cloud-ruby/issues/19135)) 
+* Update api for bucket update ([#19110](https://github.com/googleapis/google-cloud-ruby/issues/19110)) 
+
+### 1.40.0 (2022-09-13)
+
+#### Features
+
+* Update all patch bucket helper methods to accept preconditions ([#19117](https://github.com/googleapis/google-cloud-ruby/issues/19117)) 
+
+### 1.39.0 (2022-08-24)
+
+#### Features
+
+* add support for conditional idempotent operations ([#18834](https://github.com/googleapis/google-cloud-ruby/issues/18834)) 
+
+### 1.38.0 (2022-07-31)
+
+#### Features
+
+* Add support for dual region gcs buckets ([#18862](https://github.com/googleapis/google-cloud-ruby/issues/18862)) 
+
+### 1.37.0 (2022-06-30)
+
+#### Features
+
+* support OLM Prefix/Suffix ([#18190](https://github.com/googleapis/google-cloud-ruby/issues/18190)) 
+* allow retry options to be configurable on client initialization ([#18332](https://github.com/googleapis/google-cloud-ruby/issues/18332)) 
+#### Bug Fixes
+
+* update object path parsing to handle hashes in them 
+
 ### 1.36.2 (2022-04-20)
 
 #### Documentation

data/OVERVIEW.md

@@ -563,6 +563,38 @@ require "google/cloud/storage"
 storage = Google::Cloud::Storage.new retries: 10, timeout: 120
 ```
 
+The library by default retries all API requests which are always idempotent on a
+"transient" error.
+
+For API requests which are idempotent only if the some conditions are satisfied
+(For ex. a file has the same "generation"), the library retries only if the
+condition is specified.
+
+Rather than using this default behaviour, you may choose to disable the retries
+on your own.
+
+You can pass `retries` as `0` to disable retries for all operations regardless
+of their idempotencies.
+
+```ruby
+require "google/cloud/storage"
+
+storage = Google::Cloud::Storage.new retries: 0
+```
+
+You can also disable retries for a particular operation by passing `retries` as
+`0` in the `options` field.
+
+```ruby
+require "google/cloud/storage"
+
+storage = Google::Cloud::Storage.new
+service = storage.service
+service.get_bucket bucket_name, options: {retries: 0}
+```
+
+For those API requests which are never idempotent, the library passes retries=0 by default, suppressing any retries.
+
 See the [Storage status and error
 codes](https://cloud.google.com/storage/docs/json_api/v1/status-codes)
 for a list of error conditions.

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

@@ -349,8 +349,8 @@ module Google
           #
           #   bucket.acl.auth!
           #
-          def auth!
-            update_predefined_acl! "authenticatedRead"
+          def auth! if_metageneration_match: nil
+            update_predefined_acl! "authenticatedRead", if_metageneration_match: if_metageneration_match
           end
           alias authenticatedRead! auth!
           alias auth_read! auth!
@@ -370,8 +370,8 @@ module Google
           #
           #   bucket.acl.private!
           #
-          def private!
-            update_predefined_acl! "private"
+          def private! if_metageneration_match: nil
+            update_predefined_acl! "private", if_metageneration_match: if_metageneration_match
           end
 
           ##
@@ -387,8 +387,8 @@ module Google
           #
           #   bucket.acl.project_private!
           #
-          def project_private!
-            update_predefined_acl! "projectPrivate"
+          def project_private! if_metageneration_match: nil
+            update_predefined_acl! "projectPrivate", if_metageneration_match: if_metageneration_match
           end
           alias projectPrivate! project_private!
 
@@ -405,8 +405,8 @@ module Google
           #
           #   bucket.acl.public!
           #
-          def public!
-            update_predefined_acl! "publicRead"
+          def public! if_metageneration_match: nil
+            update_predefined_acl! "publicRead", if_metageneration_match: if_metageneration_match
           end
           alias publicRead! public!
           alias public_read! public!
@@ -423,8 +423,8 @@ module Google
           #
           #   bucket.acl.public_write!
           #
-          def public_write!
-            update_predefined_acl! "publicReadWrite"
+          def public_write! if_metageneration_match: nil
+            update_predefined_acl! "publicReadWrite", if_metageneration_match: if_metageneration_match
           end
           alias publicReadWrite! public_write!
 
@@ -437,9 +437,10 @@ module Google
             self
           end
 
-          def update_predefined_acl! acl_role
+          def update_predefined_acl! acl_role, if_metageneration_match: nil
             @service.patch_bucket @bucket, predefined_acl: acl_role,
-                                           user_project: user_project
+                                           user_project: user_project,
+                                           if_metageneration_match: if_metageneration_match
             clear!
           end
 
@@ -714,8 +715,8 @@ module Google
           #
           #   bucket.default_acl.auth!
           #
-          def auth!
-            update_predefined_default_acl! "authenticatedRead"
+          def auth! if_metageneration_match: nil
+            update_predefined_default_acl! "authenticatedRead", if_metageneration_match: if_metageneration_match
           end
           alias authenticatedRead! auth!
           alias auth_read! auth!
@@ -735,8 +736,8 @@ module Google
           #
           #   bucket.default_acl.owner_full!
           #
-          def owner_full!
-            update_predefined_default_acl! "bucketOwnerFullControl"
+          def owner_full! if_metageneration_match: nil
+            update_predefined_default_acl! "bucketOwnerFullControl", if_metageneration_match: if_metageneration_match
           end
           alias bucketOwnerFullControl! owner_full!
 
@@ -753,8 +754,8 @@ module Google
           #
           #   bucket.default_acl.owner_read!
           #
-          def owner_read!
-            update_predefined_default_acl! "bucketOwnerRead"
+          def owner_read! if_metageneration_match: nil
+            update_predefined_default_acl! "bucketOwnerRead", if_metageneration_match: if_metageneration_match
           end
           alias bucketOwnerRead! owner_read!
 
@@ -771,8 +772,8 @@ module Google
           #
           #   bucket.default_acl.private!
           #
-          def private!
-            update_predefined_default_acl! "private"
+          def private! if_metageneration_match: nil
+            update_predefined_default_acl! "private", if_metageneration_match: if_metageneration_match
           end
 
           ##
@@ -788,8 +789,8 @@ module Google
           #
           #   bucket.default_acl.project_private!
           #
-          def project_private!
-            update_predefined_default_acl! "projectPrivate"
+          def project_private! if_metageneration_match: nil
+            update_predefined_default_acl! "projectPrivate", if_metageneration_match: if_metageneration_match
           end
           alias projectPrivate! project_private!
 
@@ -806,8 +807,8 @@ module Google
           #
           #   bucket.default_acl.public!
           #
-          def public!
-            update_predefined_default_acl! "publicRead"
+          def public! if_metageneration_match: nil
+            update_predefined_default_acl! "publicRead", if_metageneration_match: if_metageneration_match
           end
           alias publicRead! public!
           alias public_read! public!
@@ -820,9 +821,10 @@ module Google
             self
           end
 
-          def update_predefined_default_acl! acl_role
+          def update_predefined_default_acl! acl_role, if_metageneration_match: nil
             @service.patch_bucket @bucket, predefined_default_acl: acl_role,
-                                           user_project: user_project
+                                           user_project: user_project,
+                                           if_metageneration_match: if_metageneration_match
             clear!
           end
 

data/lib/google/cloud/storage/bucket/lifecycle.rb

@@ -53,6 +53,8 @@ module Google
         #   rule.storage_class #=> "COLDLINE"
         #   rule.age #=> 10
         #   rule.matches_storage_class #=> ["STANDARD", "NEARLINE"]
+        #   rule.matches_prefix #=> ["myprefix/foo"]
+        #   rule.matches_suffix #=> [".jpg", ".png"]
         #
         # @example Updating the bucket's lifecycle management rules in a block.
         #   require "google/cloud/storage"
@@ -138,6 +140,12 @@ module Google
           #   files. If the value is N, this condition is satisfied when there
           #   are at least N versions (including the live version) newer than
           #   this version of the file.
+          # @param [Array<String,Symbol>] matches_prefix
+          #  Files having their name with the specified list of prefixs will be matched.
+          #  Arguments will be converted from symbols to strings.
+          # @param [Array<String,Symbol>] matches_suffix
+          #  Files having their name with the specified list of suffixes will be matched.
+          #  Arguments will be converted from symbols to strings.
           #
           # @example
           #   require "google/cloud/storage"
@@ -157,7 +165,9 @@ module Google
                                          is_live: nil,
                                          matches_storage_class: nil,
                                          noncurrent_time_before: nil,
-                                         num_newer_versions: nil
+                                         num_newer_versions: nil,
+                                         matches_prefix: nil,
+                                         matches_suffix: nil
             push Rule.new(
               "SetStorageClass",
               storage_class: storage_class_for(storage_class),
@@ -169,12 +179,14 @@ module Google
               is_live: is_live,
               matches_storage_class: storage_class_for(matches_storage_class),
               noncurrent_time_before: noncurrent_time_before,
-              num_newer_versions: num_newer_versions
+              num_newer_versions: num_newer_versions,
+              matches_prefix: Array(matches_prefix),
+              matches_suffix: Array(matches_suffix)
             )
           end
 
           ##
-          # Adds a SetStorageClass lifecycle rule to the Object Lifecycle
+          # Adds a Delete lifecycle rule to the Object Lifecycle
           # Management rules for a bucket.
           #
           # @see https://cloud.google.com/storage/docs/lifecycle Object
@@ -221,6 +233,12 @@ module Google
           #   files. If the value is N, this condition is satisfied when there
           #   are at least N versions (including the live version) newer than
           #   this version of the file.
+          # @param [Array<String,Symbol>] matches_prefix
+          #  Files having their name with the specified list of prefixs will be matched.
+          #  Arguments will be converted from symbols to strings.
+          # @param [Array<String,Symbol>] matches_suffix
+          #  Files having their name with the specified list of suffixes will be matched.
+          #  Arguments will be converted from symbols to strings.
           #
           # @example
           #   require "google/cloud/storage"
@@ -239,7 +257,9 @@ module Google
                               is_live: nil,
                               matches_storage_class: nil,
                               noncurrent_time_before: nil,
-                              num_newer_versions: nil
+                              num_newer_versions: nil,
+                              matches_prefix: nil,
+                              matches_suffix: nil
             push Rule.new(
               "Delete",
               age: age,
@@ -250,7 +270,49 @@ module Google
               is_live: is_live,
               matches_storage_class: storage_class_for(matches_storage_class),
               noncurrent_time_before: noncurrent_time_before,
-              num_newer_versions: num_newer_versions
+              num_newer_versions: num_newer_versions,
+              matches_prefix: Array(matches_prefix),
+              matches_suffix: Array(matches_suffix)
+            )
+          end
+
+          ##
+          # Adds a AbortIncompleteMultipartUpload lifecycle rule to the Object Lifecycle
+          # Management rules for a bucket.
+          #
+          # @see https://cloud.google.com/storage/docs/lifecycle Object
+          #   Lifecycle Management
+          # @see https://cloud.google.com/storage/docs/managing-lifecycles
+          #   Managing Object Lifecycles
+          #
+          # @param [Integer] age The age of a file (in days). This condition is
+          #   satisfied when a file reaches the specified age.
+          # @param [Array<String,Symbol>] matches_prefix
+          #  Files having their name with the specified list of prefixs will be matched.
+          #  Arguments will be converted from symbols to strings.
+          # @param [Array<String,Symbol>] matches_suffix
+          #  Files having their name with the specified list of suffixes will be matched.
+          #  Arguments will be converted from symbols to strings.
+          #
+          # @example
+          #   require "google/cloud/storage"
+          #
+          #   storage = Google::Cloud::Storage.new
+          #
+          #   bucket = storage.create_bucket "my-bucket" do |b|
+          #     b.lifecycle.add_abort_incomplete_multipart_upload_rule age: 10,
+          #                                                            matches_prefix: ["images/"],
+          #                                                            matches_suffix: [".pdf"]
+          #   end
+          #
+          def add_abort_incomplete_multipart_upload_rule age: nil,
+                                                         matches_prefix: nil,
+                                                         matches_suffix: nil
+            push Rule.new(
+              "AbortIncompleteMultipartUpload",
+              age: age,
+              matches_prefix: Array(matches_prefix),
+              matches_suffix: Array(matches_suffix)
             )
           end
 
@@ -346,6 +408,8 @@ module Google
           #   rule.storage_class #=> "COLDLINE"
           #   rule.age #=> 10
           #   rule.matches_storage_class #=> ["STANDARD", "NEARLINE"]
+          #   rule.matches_prefix #=> ["myprefix/foo"]
+          #   rule.matches_suffix #=> [".jpg", ".png"]
           #
           # @example Updating the bucket's lifecycle rules in a block.
           #   require "google/cloud/storage"
@@ -382,6 +446,8 @@ module Google
             attr_accessor :matches_storage_class
             attr_accessor :noncurrent_time_before
             attr_accessor :num_newer_versions
+            attr_accessor :matches_prefix
+            attr_accessor :matches_suffix
 
             # @private
             def initialize action,
@@ -394,7 +460,9 @@ module Google
                            is_live: nil,
                            matches_storage_class: nil,
                            noncurrent_time_before: nil,
-                           num_newer_versions: nil
+                           num_newer_versions: nil,
+                           matches_prefix: nil,
+                           matches_suffix: nil
               @action = action
               @storage_class = storage_class
               @age = age
@@ -406,6 +474,8 @@ module Google
               @matches_storage_class = Array(matches_storage_class)
               @noncurrent_time_before = noncurrent_time_before
               @num_newer_versions = num_newer_versions
+              @matches_prefix = Array(matches_prefix)
+              @matches_suffix = Array(matches_suffix)
             end
 
             # @private
@@ -420,7 +490,9 @@ module Google
                 is_live,
                 matches_storage_class,
                 noncurrent_time_before,
-                num_newer_versions
+                num_newer_versions,
+                matches_prefix,
+                matches_suffix
               )
               Google::Apis::StorageV1::Bucket::Lifecycle::Rule.new(
                 action: action_gapi(action, storage_class),
@@ -445,7 +517,9 @@ module Google
                                is_live,
                                matches_storage_class,
                                noncurrent_time_before,
-                               num_newer_versions
+                               num_newer_versions,
+                               matches_prefix,
+                               matches_suffix
               Google::Apis::StorageV1::Bucket::Lifecycle::Rule::Condition.new(
                 age: age,
                 created_before: created_before,
@@ -455,7 +529,9 @@ module Google
                 is_live: is_live,
                 matches_storage_class: Array(matches_storage_class),
                 noncurrent_time_before: noncurrent_time_before,
-                num_newer_versions: num_newer_versions
+                num_newer_versions: num_newer_versions,
+                matches_prefix: Array(matches_prefix),
+                matches_suffix: Array(matches_suffix)
               )
             end
 
@@ -475,7 +551,9 @@ module Google
                 is_live: c.is_live,
                 matches_storage_class: c.matches_storage_class,
                 noncurrent_time_before: c.noncurrent_time_before,
-                num_newer_versions: c.num_newer_versions
+                num_newer_versions: c.num_newer_versions,
+                matches_prefix: c.matches_prefix,
+                matches_suffix: c.matches_suffix
               )
             end
 

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

@@ -109,6 +109,15 @@ module Google
           @gapi.id
         end
 
+        ##
+        # The autoclass configuration of the bucket
+        #
+        # @return [Google::Apis::StorageV1::Bucket::Autoclass]
+        #
+        def autoclass
+          @gapi.autoclass
+        end
+
         ##
         # The name of the bucket.
         #
@@ -301,6 +310,20 @@ module Google
           @gapi.location_type
         end
 
+        ##
+        # Returns the list of regional locations for custom dual-region buckets.
+        #
+        # @return [String, nil] Returns nil if the property has not been set before creation,
+        # if the bucket's resource has not been loaded from the server,
+        # or if the bucket is not a dual-regions bucket.
+
+        # @see https://cloud.google.com/storage/docs/json_api/v1/buckets and
+        # https://cloud.google.com/storage/docs/locations
+        #
+        def data_locations
+          @gapi.custom_placement_config&.data_locations
+        end
+
         ##
         # The destination bucket name for the bucket's logs.
         #
@@ -393,6 +416,43 @@ module Google
           patch_gapi! :storage_class
         end
 
+        ##
+        # Whether Autoclass is enabled for the bucket.
+        #
+        # @return [Boolean]
+        #
+        def autoclass_enabled
+          @gapi.autoclass&.enabled?
+        end
+
+        ##
+        # Toggle time of the autoclass
+        #
+        # @return [DateTime]
+        #
+        def autoclass_toggle_time
+          @gapi.autoclass&.toggle_time
+        end
+
+        ##
+        # Updates bucket's autoclass configuration. This defines the default class for objects in the
+        # bucket and down/up-grades the storage class of objects based on the access patterns.
+        # Accepted values are `:false`, and `:true`.
+        #
+        # For more information, see [Storage
+        # Classes](https://cloud.google.com/storage/docs/using-autoclass).
+        #
+        # Note: Only patch requests that disable autoclass are currently supported.
+        # To enable autoclass, you must set it at bucket creation time.
+        #
+        # @param [Boolean] toggle for autoclass configuration of the bucket.
+        #
+        def autoclass_enabled= toggle
+          @gapi.autoclass ||= API::Bucket::Autoclass.new
+          @gapi.autoclass.enabled = toggle
+          patch_gapi! :autoclass
+        end
+
         ##
         # Whether [Object
         # Versioning](https://cloud.google.com/storage/docs/object-versioning)
@@ -1156,9 +1216,9 @@ module Google
           updater.check_for_mutable_cors!
           updater.check_for_mutable_lifecycle!
           return if updater.updates.empty?
-          patch_gapi! updater.updates,
-                      if_metageneration_match: if_metageneration_match,
-                      if_metageneration_not_match: if_metageneration_not_match
+          update_gapi! updater.updates,
+                       if_metageneration_match: if_metageneration_match,
+                       if_metageneration_not_match: if_metageneration_not_match
         end
 
         ##
@@ -2891,6 +2951,26 @@ module Google
           self
         end
 
+        def update_gapi! attributes,
+                         if_metageneration_match: nil,
+                         if_metageneration_not_match: nil
+          attributes = Array(attributes)
+          attributes.flatten!
+          return if attributes.empty?
+          ensure_service!
+          update_args = Hash[attributes.map do |attr|
+            [attr, @gapi.send(attr)]
+          end]
+          update_gapi = API::Bucket.new(**update_args)
+          @gapi = service.update_bucket name,
+                                        update_gapi,
+                                        if_metageneration_match: if_metageneration_match,
+                                        if_metageneration_not_match: if_metageneration_not_match,
+                                        user_project: user_project
+          @lazy = nil
+          self
+        end
+
         ##
         # Raise an error if the file is not found.
         def ensure_io_or_file_exists! file

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

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

@@ -326,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

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

@@ -290,9 +290,9 @@ module Google
         #     access, and allUsers get READER access.
         # @param [String] location The location of the bucket. Optional.
         #   If not passed, the default location, 'US', will be used.
-        #   If specifying a dual-region location, the regions can be specified
-        #   by joining them with a plus sign, for example 'US-CENTRAL1+US-WEST1'. See:
-        #   [Storage Locaitons](https://cloud.google.com/storage/docs/locations).
+        #   If specifying a dual-region location, the `customPlacementConfig`
+        #   property should be set in conjunction. See:
+        #   [Storage Locations](https://cloud.google.com/storage/docs/locations).
         # @param [String] logging_bucket The destination bucket for the bucket's
         #   logs. For more information, see [Access
         #   Logs](https://cloud.google.com/storage/docs/access-logs).
@@ -327,6 +327,11 @@ module Google
         #   other than the current project, and that project is authorized for
         #   the currently authenticated service account, transit costs will be
         #   billed to the given project. The default is `nil`.
+        # @param [Boolean] autoclass_enabled The bucket's autoclass configuration.
+        #   Buckets can have either StorageClass OLM rules or Autoclass, but
+        #   not both. When Autoclass is enabled on a bucket, adding StorageClass
+        #   OLM rules will result in failure. For more information, see
+        #   [Autoclass](https://cloud.google.com/storage/docs/autoclass).
         #
         #   The value provided will be applied to all operations on the returned
         #   bucket instance and its files.
@@ -367,6 +372,7 @@ module Google
                           acl: nil,
                           default_acl: nil,
                           location: nil,
+                          custom_placement_config: nil,
                           storage_class: nil,
                           logging_bucket: nil,
                           logging_prefix: nil,
@@ -374,16 +380,19 @@ module Google
                           website_404: nil,
                           versioning: nil,
                           requester_pays: nil,
-                          user_project: nil
+                          user_project: nil,
+                          autoclass_enabled: false
           params = {
             name: bucket_name,
-            location: location
+            location: location,
+            custom_placement_config: custom_placement_config
           }.delete_if { |_, v| v.nil? }
           new_bucket = Google::Apis::StorageV1::Bucket.new(**params)
           storage_class = storage_class_for storage_class
           updater = Bucket::Updater.new(new_bucket).tap do |b|
             b.logging_bucket = logging_bucket unless logging_bucket.nil?
             b.logging_prefix = logging_prefix unless logging_prefix.nil?
+            b.autoclass_enabled = autoclass_enabled
             b.storage_class = storage_class unless storage_class.nil?
             b.website_main = website_main unless website_main.nil?
             b.website_404 = website_404 unless website_404.nil?