google-cloud-storage 1.29.2 → 1.47.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad286a8539024ffcee1d0239c7db682e3ddb4b6663e5e172354123fa607b96fc
-  data.tar.gz: 29e8c237d1f891d46bddea92ff3151a08c11c32e936376f040d50159668a8f69
+  metadata.gz: fb6046c8eb979e1cbd733518d8fd242e1332813d6241f85e65b07f6d7d9e631f
+  data.tar.gz: 1124d71be6c1954b38f3fb6c8c3814891d9dd108fc0862f2c5436db18c111782
 SHA512:
-  metadata.gz: b7121fbfee2ad413e88d6edfbe83c535a9b17173d2431919e72fed6e8f4eba4c94f84b64d588ade51f50d8f20556a8bef37c6ad8cdaeaca8d6fb58a280168825
-  data.tar.gz: 0cb221a85541a6af70d8be63dd137915110eda09295e9711c566ec669bd574376a1f0125c4ebc559efa0a19268569dc74cd2548891400501d9af6bdfe62da8ce
+  metadata.gz: 2e8598d2cf01a52f20c7bd554b593d7049134a367f17571721e2779a0634013452ad42025c22d59f8542c030a411092c3f2f63edfe8489fee0a9dcb9ccb5c774
+  data.tar.gz: 4918a472cd83aab2c7d1a5ffe6be9957c0113686a00769f082522799fd9cc713c3315de8d8b2d87caa22b37d7d54c2c82702fb2b5b9e1ed30ef011319dc841cf

data/AUTHENTICATION.md

@@ -77,7 +77,8 @@ storage = Google::Cloud::Storage.new
 
 ### Configuration
 
-The **Project ID** and **Credentials JSON** can be configured instead of placing them in environment variables or providing them as arguments.
+The **Project ID** and the path to the **Credentials JSON** file can be configured
+instead of placing them in environment variables or providing them as arguments.
 
 ```ruby
 require "google/cloud/storage"
@@ -111,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
@@ -129,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,176 @@
 # Release History
 
+### 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
+
+* changed PAP unspecified to inherited
+* support for more client timeout options
+
+#### Bug Fixes
+
+* Update dependency on the addressable gem to 2.8 to remediate a vulnerability
+
+### 1.34.1 / 2021-07-08
+
+#### Documentation
+
+* Update AUTHENTICATION.md in handwritten packages
+
+### 1.34.0 / 2021-06-30
+
+#### Features
+
+* Add support for automatic crc32c and md5 upload verification
+  * Add checksum to Bucket#create_file
+
+### 1.33.0 / 2021-06-29
+
+#### Features
+
+* Add support for PublicAccessPrevention
+  * Add Bucket#public_access_prevention
+  * Add Bucket#public_access_prevention=
+  * Add Bucket#public_access_prevention_enforced?
+  * Add Bucket#public_access_prevention_unspecified?
+  * Add samples for PublicAccessPrevention
+
+### 1.32.0 / 2021-06-22
+
+#### Features
+
+* Add sources_if_generation_match to Bucket#compose
+* Add support for (meta)generation preconditions to File operations
+  * Add if_(meta)generation_match options to Bucket#compose
+  * Add if_(meta)generation_(not_)match options to Bucket#create_file
+  * Add if_(meta)generation_(not_)match options to Bucket#file
+  * Add if_(meta)generation_(not_)match options to File#delete.
+  * Add if_(meta)generation_(not_)match options to File#rewrite
+  * Add generation and if_(meta)generation_(not_)match options to File#update
+  * Add generation and if_(meta)generation_(not_)match options to File::Acl predefined_acl methods
+
+#### Bug Fixes
+
+* Expand googleauth dependency to support future 1.x versions
+* Update File::Verifier to test for File#to_path
+
+### 1.31.1 / 2021-05-19
+
+#### Documentation
+
+* Update IAMCredentialsService#sign_service_account_blob examples
+
+### 1.31.0 / 2021-03-10
+
+#### Features
+
+* Drop support for Ruby 2.4 and add support for Ruby 3.0
+
+### 1.30.0 / 2021-01-13
+
+#### Features
+
+* Replace google-api-client with specific client gems
+  * Remove google-api-client
+  * Add google-apis-iamcredentials_v1
+  * Add google-apis-storage_v1
+
+#### Documentation
+
+* Update Bucket#generate_signed_post_policy_v4 documentation
+
 ### 1.29.2 / 2020-12-14
 
 #### Bug Fixes

data/CONTRIBUTING.md

@@ -24,7 +24,7 @@ be able to accept your pull requests.
 In order to use the google-cloud-storage console and run the project's tests,
 there is a small amount of setup:
 
-1. Install Ruby. google-cloud-storage requires Ruby 2.4+. You may choose to
+1. Install Ruby. google-cloud-storage requires Ruby 2.5+. You may choose to
    manage your Ruby and gem installations with [RVM](https://rvm.io/),
    [rbenv](https://github.com/rbenv/rbenv), or
    [chruby](https://github.com/postmodern/chruby).
@@ -119,15 +119,14 @@ If you alter an example's title, you may encounter breaking tests.
 ### Storage Acceptance Tests
 
 The Storage acceptance tests interact with the live service API. Follow the
-instructions in the {file:AUTHENTICATION.md Authentication guide} for enabling
+instructions in the {file:AUTHENTICATION.md Authentication Guide} for enabling
 the Storage API. Occasionally, some API features may not yet be generally
 available, making it difficult for some contributors to successfully run the
 entire acceptance test suite. However, please ensure that you do successfully
 run acceptance tests for any code areas covered by your pull request.
 
 To run the acceptance tests, first create and configure a project in the Google
-Developers Console, as described in the {file:AUTHENTICATION.md Authentication
-guide}. Be sure to download the JSON KEY file. Make note of the PROJECT_ID and
+Developers Console, as described in the {file:AUTHENTICATION.md Authentication Guide}. Be sure to download the JSON KEY file. Make note of the PROJECT_ID and
 the KEYFILE location on your system.
 
 Before you can run the Storage acceptance tests, you must first create indexes

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

@@ -198,7 +198,7 @@ module Google
             gapi = @service.insert_bucket_acl @bucket, entity, "OWNER",
                                               user_project: user_project
             entity = gapi.entity
-            @owners.push entity unless @owners.nil?
+            @owners&.push entity
             entity
           end
 
@@ -243,7 +243,7 @@ module Google
             gapi = @service.insert_bucket_acl @bucket, entity, "WRITER",
                                               user_project: user_project
             entity = gapi.entity
-            @writers.push entity unless @writers.nil?
+            @writers&.push entity
             entity
           end
 
@@ -288,7 +288,7 @@ module Google
             gapi = @service.insert_bucket_acl @bucket, entity, "READER",
                                               user_project: user_project
             entity = gapi.entity
-            @readers.push entity unless @readers.nil?
+            @readers&.push entity
             entity
           end
 
@@ -323,9 +323,9 @@ module Google
           def delete entity
             @service.delete_bucket_acl @bucket, entity,
                                        user_project: user_project
-            @owners.delete entity  unless @owners.nil?
-            @writers.delete entity unless @writers.nil?
-            @readers.delete entity unless @readers.nil?
+            @owners&.delete entity
+            @writers&.delete entity
+            @readers&.delete entity
             true
           end
 
@@ -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,16 +437,16 @@ 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
 
           def entities_from_acls acls, role
             selected = acls.select { |acl| acl.role == role }
-            entities = selected.map(&:entity)
-            entities
+            selected.map(&:entity)
           end
         end
 
@@ -614,7 +614,7 @@ module Google
             gapi = @service.insert_default_acl @bucket, entity, "OWNER",
                                                user_project: user_project
             entity = gapi.entity
-            @owners.push entity unless @owners.nil?
+            @owners&.push entity
             entity
           end
 
@@ -657,7 +657,7 @@ module Google
             gapi = @service.insert_default_acl @bucket, entity, "READER",
                                                user_project: user_project
             entity = gapi.entity
-            @readers.push entity unless @readers.nil?
+            @readers&.push entity
             entity
           end
 
@@ -690,8 +690,8 @@ module Google
           def delete entity
             @service.delete_default_acl @bucket, entity,
                                         user_project: user_project
-            @owners.delete entity  unless @owners.nil?
-            @readers.delete entity unless @readers.nil?
+            @owners&.delete entity
+            @readers&.delete entity
             true
           end
 
@@ -715,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!
@@ -736,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!
 
@@ -754,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!
 
@@ -772,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
 
           ##
@@ -789,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!
 
@@ -807,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!
@@ -821,16 +821,16 @@ 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
 
           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/bucket/cors.rb

@@ -172,7 +172,10 @@ module Google
           #   rule.max_age #=> 3600
           #
           class Rule
-            attr_accessor :origin, :methods, :headers, :max_age
+            attr_accessor :origin
+            attr_accessor :methods
+            attr_accessor :headers
+            attr_accessor :max_age
 
             # @private
             def initialize origin, methods, headers: nil, max_age: nil