google-cloud-storage 1.30.0 → 1.39.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3b78945de5adc36366ded346357d71f954327a48b11d9d909ad5b8443f51c95
-  data.tar.gz: adcc876f70b87130ca732a591a9f1d6aa278e03a0356ea012620f30650c3b25e
+  metadata.gz: a376f2dab9dec5118be28f8fa76c2684e0606aee749fa8387eb6672ba5fb8023
+  data.tar.gz: 1dc9bcc3f0c2cee2ee822211ea8a67f740fdd30f827715da6a8e50b98a64b21b
 SHA512:
-  metadata.gz: e46be5fe50420e4a674add04d12a06243dba3438aafedc9356246ac8e5fa66aa0db547d9264a70b940cd46133aed1b7256cdad02397c93b0eeb73d312fffdd48
-  data.tar.gz: 0a89f487726406d8865b1c675d43f1153e3cf78d0e5b8df1ebc4eb1f09a051f9dd45c328503d500dda6aee4bcd60c3693104d0371755154263eb52ccceaf3b1b
+  metadata.gz: 26b8b0c1544f7e0b1d20b82e539ddaf9431caeb359b177f637f3642eccb58b089b4a9e6202b3c9f051d6c75b01b31cba4b53870b9bf3e190934c0b2d3767e302
+  data.tar.gz: 7d1b0bcfc59f1ad50831489bf2c6f1740ddae969869e221eb809be0b9107f66170f14cb9ed16d50b6d73d76621e59c6b2f5bbb8018725b2d50643fa665645177

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"

data/CHANGELOG.md

@@ -1,5 +1,111 @@
 # Release History
 
+### 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

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,36 @@ 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}
+```
+
 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
 
@@ -445,8 +445,7 @@ module Google
 
           def entities_from_acls acls, role
             selected = acls.select { |acl| acl.role == role }
-            entities = selected.map(&:entity)
-            entities
+            selected.map(&:entity)
           end
         end
 
@@ -614,7 +613,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 +656,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 +689,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
 
@@ -829,8 +828,7 @@ module Google
 
           def entities_from_acls acls, role
             selected = acls.select { |acl| acl.role == role }
-            entities = selected.map(&:entity)
-            entities
+            selected.map(&:entity)
           end
         end
       end

data/lib/google/cloud/storage/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

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"
@@ -371,17 +435,19 @@ module Google
           #   end
           #
           class Rule
-            attr_accessor :action,
-                          :storage_class,
-                          :age,
-                          :created_before,
-                          :custom_time_before,
-                          :days_since_custom_time,
-                          :days_since_noncurrent_time,
-                          :is_live,
-                          :matches_storage_class,
-                          :noncurrent_time_before,
-                          :num_newer_versions
+            attr_accessor :action
+            attr_accessor :storage_class
+            attr_accessor :age
+            attr_accessor :created_before
+            attr_accessor :custom_time_before
+            attr_accessor :days_since_custom_time
+            attr_accessor :days_since_noncurrent_time
+            attr_accessor :is_live
+            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/list.rb

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