google-cloud-storage 1.35.0 → 1.54.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46a00811174d5f74691bc49b43c14fe9a541f3c964c332eb9bccc4d2e85778cd
-  data.tar.gz: 0425d311a50177d6321a172958a6b2afef376a2c13f3dd3d5aa5d07ce974b773
+  metadata.gz: 67fa1effce117003750f759eba79de92380616365652f2a19ba49b1986c75634
+  data.tar.gz: 9729e6dc51f15a9a5e2e0370771f980908f9d6284973503c9c4d4c1e561b8d84
 SHA512:
-  metadata.gz: dd0fb3dd2b5d31ce65febca446c4826e72384de658bcf9bb66b349a2f8304c8494c86a6a88263dd38add67fd6083f375f436ffcad225413a7d803ee67c4a351c
-  data.tar.gz: f62d337690f49269a0839d1dfe65f998da7fb1e6a530c151a11eb4a890fc1942321b6c34ef34c9b932b59ab33a0a74ffb6a3b082d1e6688cfd4ddf9a48b478b3
+  metadata.gz: ec9022c921c0714ebf7f47131c745c113bb0480a34a376ca10055ccdee024821a518d1a87f742486118d7fb3e570beaeef5746f12676d5790e6ae697439dabd9
+  data.tar.gz: d5e57fd75d565a8328cf79ce42374883e4da7f875c7fd9571e928f9648c05578bee5743d68465819f3e5d488469d277749aecebd44810198fd1a1ca0cac6f3c3

data/AUTHENTICATION.md

@@ -112,15 +112,6 @@ those that produce
 post objects. For these methods, authentication using a service account JSON key file
 is required.
 
-[gce-how-to]: https://cloud.google.com/compute/docs/authentication#using
-[dev-console]: https://console.cloud.google.com/project
-
-[enable-apis]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/enable-apis.png
-
-[create-new-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account.png
-[create-new-service-account-existing-keys]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account-existing-keys.png
-[reuse-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/reuse-service-account.png
-
 ## Creating a Service Account
 
 Google Cloud requires a **Project ID** and **Service Account Credentials** to
@@ -130,31 +121,22 @@ connect to most services with google-cloud-storage.
 If you are not running this client on Google Compute Engine, you need a Google
 Developers service account.
 
-1. Visit the [Google Developers Console][dev-console].
+1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
 1. Create a new project or click on an existing project.
-1. Activate the slide-out navigation tray and select **API Manager**. From
+1. Activate the menu in the upper left and select **APIs & Services**. From
    here, you will enable the APIs that your application requires.
 
-   ![Enable the APIs that your application requires][enable-apis]
-
    *Note: You may need to enable billing in order to use these services.*
 
 1. Select **Credentials** from the side navigation.
 
-   You should see a screen like one of the following.
-
-   ![Create a new service account][create-new-service-account]
-
-   ![Create a new service account With Existing Keys][create-new-service-account-existing-keys]
-
-   Find the "Add credentials" drop down and select "Service account" to be
-   guided through downloading a new JSON key file.
-
-   If you want to re-use an existing service account, you can easily generate a
-   new key file. Just select the account you wish to re-use, and click "Generate
-   new JSON key":
+   Find the "Create credentials" drop down near the top of the page, and select
+   "Service account" to be guided through downloading a new JSON key file.
 
-   ![Re-use an existing service account][reuse-service-account]
+   If you want to re-use an existing service account, you can easily generate 
+   a new key file. Just select the account you wish to re-use click the pencil
+   tool on the right side to edit the service account, select the **Keys** tab,
+   and then select **Add Key**.
 
    The key file you download will be used by this library to authenticate API
    requests and should be stored in a secure location.

data/CHANGELOG.md

@@ -1,5 +1,149 @@
 # Release History
 
+### 1.54.0 (2024-12-11)
+
+#### Features
+
+* Updated required Ruby version to 3.0 or later ([#27599](https://github.com/googleapis/google-cloud-ruby/issues/27599)) 
+
+### 1.53.0 (2024-12-04)
+
+#### Features
+
+* add integration test for universe domain ([#27384](https://github.com/googleapis/google-cloud-ruby/issues/27384)) 
+* fetch file and bucket details from url ([#27322](https://github.com/googleapis/google-cloud-ruby/issues/27322)) 
+
+### 1.52.0 (2024-05-31)
+
+#### Features
+
+* support for hierarchical namespace (folders) ([#25967](https://github.com/googleapis/google-cloud-ruby/issues/25967)) 
+
+### 1.51.0 (2024-04-25)
+
+#### Features
+
+* Respect custom endpoint for signed_url ([#25469](https://github.com/googleapis/google-cloud-ruby/issues/25469)) 
+
+### 1.50.0 (2024-04-19)
+
+#### Features
+
+* Add support for soft deletion ([#25340](https://github.com/googleapis/google-cloud-ruby/issues/25340)) 
+#### Bug Fixes
+
+* Set configured univer_domain and endpoint when initializing through Service ([#25665](https://github.com/googleapis/google-cloud-ruby/issues/25665)) 
+
+### 1.49.0 (2024-02-21)
+
+#### Features
+
+* Support of Managed Folders ([#24809](https://github.com/googleapis/google-cloud-ruby/issues/24809)) 
+
+### 1.48.1 (2024-01-26)
+
+#### Bug Fixes
+
+* Raise an error on mismatching universe domain ([#24486](https://github.com/googleapis/google-cloud-ruby/issues/24486)) 
+
+### 1.48.0 (2024-01-25)
+
+#### Features
+
+* Support for universe_domain ([#24449](https://github.com/googleapis/google-cloud-ruby/issues/24449)) 
+
+### 1.47.0 (2024-01-09)
+
+#### Features
+
+* support for object lock / retention ([#23732](https://github.com/googleapis/google-cloud-ruby/issues/23732)) 
+
+### 1.46.0 (2024-01-08)
+
+#### Features
+
+* support match_glob for Object.list 
+
+### 1.45.0 (2023-11-06)
+
+#### Features
+
+* added autoclass v2.1 features ([#23483](https://github.com/googleapis/google-cloud-ruby/issues/23483)) 
+
+### 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
+
+* Document support for dual region buckets
+
+### 1.36.1 / 2022-02-08
+
+#### Documentation
+
+* Update the RPO sample output. ([#17277](https://www.github.com/googleapis/google-cloud-ruby/issues/17277))
+
+### 1.36.0 / 2022-01-12
+
+#### Features
+
+* add support for RPO (turbo replication). ([#14407](https://www.github.com/googleapis/google-cloud-ruby/issues/14407))
+
 ### 1.35.0 / 2021-12-08
 
 #### Features

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/cors.rb

@@ -182,7 +182,7 @@ module Google
               @origin = Array(origin)
               @methods = Array(methods)
               @headers = Array(headers)
-              @max_age = (max_age || 1800)
+              @max_age = max_age || 1800
             end
 
             # @private
@@ -195,7 +195,7 @@ module Google
 
             # @private
             def self.from_gapi gapi
-              new gapi.origin.dup, gapi.http_method.dup, \
+              new gapi.origin.dup, gapi.http_method.dup,
                   headers: gapi.response_header.dup,
                   max_age: gapi.max_age_seconds
             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