google-cloud-storage 1.33.0 → 1.36.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6900463b2861e35e33cef3bda84de638f0f9e7d80e8424755f5eef311bd20352
-  data.tar.gz: 6469082cd9d6b158a71a808874104e20128187c4c611a0fe71dbd80b0f68e54e
+  metadata.gz: 70af6e7a7384139db86fc433215199b3a0f6f03fdc36bf2712e3e3e5d5b8b4b5
+  data.tar.gz: 34d028c9cc7b0125861db575ca23cc18601bdfb0f72642d491097f97f4f6a41b
 SHA512:
-  metadata.gz: 4d32314a8813b66cf6ec488be10c8ac174cb71a54d175cff9f33809a529f4851ff2482a43c646f114c91cac4bf7fbc90cc4135caab85d1a55ab8c732f11c1c5f
-  data.tar.gz: '08382f70eb5759b7ccb98ac0bb793bed114bd3fcc24b6ca8e3ecc02af2e60540f1761d36133d8299b043155d260d9a659ab2d5b0cda6a27eb40ead70d7b7d6d1'
+  metadata.gz: cbee86e3123720e8bc8a74daf22cdcf1f5fdfb111279a00d0b4e8f50fd508b92b952651fcdf5efcb3e612be84fc00fec7e897571b62c05917c7ed6a0ccddc40a
+  data.tar.gz: d8c4f3820eb06abb5913623b6e04e42a66e51fb961a046ce99eb78b44b1adca85ec1159018c6b14689e0bcd58807d3f476eb6d945fd01bb7cdf6b69d928ecf23

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,35 @@
 # Release History
 
+### 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

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

@@ -932,11 +932,11 @@ module Google
         end
 
         ##
-        # The value for Public Access Prevention in the bucket's IAM configuration. Currently, `unspecified` and
+        # The value for Public Access Prevention in the bucket's IAM configuration. Currently, `inherited` and
         # `enforced` are supported. When set to `enforced`, Public Access Prevention is enforced in the bucket's IAM
         # configuration. This value can be modified by calling {#public_access_prevention=}.
         #
-        # @return [String, nil] Currently, `unspecified` and `enforced` are supported. Returns `nil` if the bucket has
+        # @return [String, nil] Currently, `inherited` and `enforced` are supported. Returns `nil` if the bucket has
         #    no IAM configuration.
         #
         # @example
@@ -958,7 +958,7 @@ module Google
         # calling {#public_access_prevention}.
         #
         # @param [Symbol, String] new_public_access_prevention The bucket's new Public Access Prevention configuration.
-        #   Currently, `unspecified` and `enforced` are supported. When set to `enforced`, Public Access
+        #   Currently, `inherited` and `enforced` are supported. When set to `enforced`, Public Access
         #   Prevention is enforced in the bucket's IAM configuration.
         #
         # @example Set Public Access Prevention to enforced:
@@ -971,15 +971,15 @@ module Google
         #   bucket.public_access_prevention = :enforced
         #   bucket.public_access_prevention #=> "enforced"
         #
-        # @example Set Public Access Prevention to unspecified:
+        # @example Set Public Access Prevention to inherited:
         #   require "google/cloud/storage"
         #
         #   storage = Google::Cloud::Storage.new
         #
         #   bucket = storage.bucket "my-bucket"
         #
-        #   bucket.public_access_prevention = :unspecified
-        #   bucket.public_access_prevention #=> "unspecified"
+        #   bucket.public_access_prevention = :inherited
+        #   bucket.public_access_prevention #=> "inherited"
         #
         def public_access_prevention= new_public_access_prevention
           @gapi.iam_configuration ||= API::Bucket::IamConfiguration.new
@@ -1011,11 +1011,11 @@ module Google
         end
 
         ##
-        # Whether the value for Public Access Prevention in the bucket's IAM configuration is `unspecified`. The default
+        # Whether the value for Public Access Prevention in the bucket's IAM configuration is `inherited`. The default
         # is `false`. This value can be modified by calling {Bucket#public_access_prevention=}.
         #
         # @return [Boolean] Returns `false` if the bucket has no IAM configuration or if Public Access Prevention is
-        #   not `unspecified` in the IAM configuration. Returns `true` if Public Access Prevention is `unspecified` in
+        #   not `inherited` in the IAM configuration. Returns `true` if Public Access Prevention is `inherited` in
         #   the IAM configuration.
         #
         # @example
@@ -1025,12 +1025,70 @@ module Google
         #
         #   bucket = storage.bucket "my-bucket"
         #
-        #   bucket.public_access_prevention = :unspecified
-        #   bucket.public_access_prevention_unspecified? # true
+        #   bucket.public_access_prevention = :inherited
+        #   bucket.public_access_prevention_inherited? # true
         #
-        def public_access_prevention_unspecified?
+        def public_access_prevention_inherited?
           return false unless @gapi.iam_configuration&.public_access_prevention
-          @gapi.iam_configuration.public_access_prevention.to_s == "unspecified"
+          ["inherited", "unspecified"].include? @gapi.iam_configuration.public_access_prevention.to_s
+        end
+
+        alias public_access_prevention_unspecified? public_access_prevention_inherited?
+
+        ##
+        # Recovery Point Objective (RPO) is another attribute of a bucket, it measures how long it takes for a set of
+        # updates to be asynchronously copied to the other region.
+        # Currently, `DEFAULT` and `ASYNC_TURBO` are supported. When set to `ASYNC_TURBO`, Turbo Replication is enabled
+        # for a bucket. `DEFAULT` is used to reset rpo on an existing bucket with rpo set to `ASYNC_TURBO`.
+        # This value can be modified by calling {#rpo=}.
+        #
+        # @return [String, nil] Currently, `DEFAULT` and `ASYNC_TURBO` are supported. Returns `nil` if the bucket has
+        #    no RPO.
+        #
+        # @example
+        #   require "google/cloud/storage"
+        #
+        #   storage = Google::Cloud::Storage.new
+        #
+        #   bucket = storage.bucket "my-bucket"
+        #
+        #   bucket.rpo = :DEFAULT
+        #   bucket.rpo #=> "DEFAULT"
+        #
+        def rpo
+          @gapi.rpo
+        end
+
+        ##
+        # Sets the value for Recovery Point Objective (RPO) in the bucket. This value can be queried by calling {#rpo}.
+        #
+        # @param [Symbol, String] new_rpo The bucket's new Recovery Point Objective metadata.
+        #   Currently, `DEFAULT` and `ASYNC_TURBO` are supported. When set to `ASYNC_TURBO`, Turbo Replication
+        #   is enabled for a bucket.
+        #
+        # @example Set RPO to DEFAULT:
+        #   require "google/cloud/storage"
+        #
+        #   storage = Google::Cloud::Storage.new
+        #
+        #   bucket = storage.bucket "my-bucket"
+        #
+        #   bucket.rpo = :DEFAULT
+        #   bucket.rpo #=> "DEFAULT"
+        #
+        # @example Set RPO to ASYNC_TURBO:
+        #   require "google/cloud/storage"
+        #
+        #   storage = Google::Cloud::Storage.new
+        #
+        #   bucket = storage.bucket "my-bucket"
+        #
+        #   bucket.rpo = :ASYNC_TURBO
+        #   bucket.rpo #=> "ASYNC_TURBO"
+        #
+        def rpo= new_rpo
+          @gapi.rpo = new_rpo&.to_s
+          patch_gapi! :rpo
         end
 
         ##
@@ -1332,16 +1390,34 @@ module Google
         #   changed to a time in the future. If custom_time must be unset, you
         #   must either perform a rewrite operation, or upload the data again
         #   and create a new file.
+        # @param [Symbol, nil] checksum The type of checksum for the client to
+        #   automatically calculate and send with the create request to verify
+        #   the integrity of the object. If provided, Cloud Storage will only
+        #   create the file if the value calculated by the client matches the
+        #   value calculated by the service.
+        #
+        #   Acceptable values are:
+        #
+        #   * `md5` - Calculate and provide a checksum using the MD5 hash.
+        #   * `crc32c` - Calculate and provide a checksum using the CRC32c hash.
+        #   * `all` - Calculate and provide checksums for all available verifications.
+        #
+        #   Optional. The default is `nil`. Do not provide if also providing a
+        #   corresponding `crc32c` or `md5` argument. See
+        #   [Validation](https://cloud.google.com/storage/docs/hashes-etags)
+        #   for more information.
         # @param [String] crc32c The CRC32c checksum of the file data, as
         #   described in [RFC 4960, Appendix
         #   B](http://tools.ietf.org/html/rfc4960#appendix-B).
         #   If provided, Cloud Storage will only create the file if the value
-        #   matches the value calculated by the service. See
+        #   matches the value calculated by the service. Do not provide if also
+        #   providing a `checksum: :crc32c` or `checksum: :all` argument. See
         #   [Validation](https://cloud.google.com/storage/docs/hashes-etags)
         #   for more information.
         # @param [String] md5 The MD5 hash of the file data. If provided, Cloud
         #   Storage will only create the file if the value matches the value
-        #   calculated by the service. See
+        #   calculated by the service. Do not provide if also providing a
+        #   `checksum: :md5` or `checksum: :all` argument. See
         #   [Validation](https://cloud.google.com/storage/docs/hashes-etags) for
         #   more information.
         # @param [Hash] metadata A hash of custom, user-provided web-safe keys
@@ -1473,6 +1549,7 @@ module Google
                         content_language: nil,
                         content_type: nil,
                         custom_time: nil,
+                        checksum: nil,
                         crc32c: nil,
                         md5: nil,
                         metadata: nil,
@@ -1490,7 +1567,8 @@ module Google
           path ||= file.path if file.respond_to? :path
           path ||= file if file.is_a? String
           raise ArgumentError, "must provide path" if path.nil?
-
+          crc32c = crc32c_for file, checksum, crc32c
+          md5 = md5_for file, checksum, md5
 
           gapi = service.insert_file name,
                                      file,
@@ -2821,6 +2899,18 @@ module Google
           raise ArgumentError, "cannot find file #{file}"
         end
 
+        def crc32c_for source, checksum, crc32c
+          return crc32c unless [:crc32c, :all].include? checksum
+          raise ArgumentError, "'checksum: :crc32c' or 'checksum: :all' is present with 'crc32c' arg" if crc32c
+          File::Verifier.crc32c_for source
+        end
+
+        def md5_for source, checksum, md5
+          return md5 unless [:md5, :all].include? checksum
+          raise ArgumentError, "'checksum: :md5' or 'checksum: :all' is present with 'md5' arg" if md5
+          File::Verifier.md5_for source
+        end
+
         ##
         # Yielded to a block to accumulate changes for a patch request.
         class Updater < Bucket

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

@@ -364,11 +364,18 @@ module Google
         #     b.lifecycle.add_set_storage_class_rule "COLDLINE", age: 10
         #   end
         #
-        def create_bucket bucket_name, acl: nil, default_acl: nil,
-                          location: nil, storage_class: nil,
-                          logging_bucket: nil, logging_prefix: nil,
-                          website_main: nil, website_404: nil, versioning: nil,
-                          requester_pays: nil, user_project: nil
+        def create_bucket bucket_name,
+                          acl: nil,
+                          default_acl: nil,
+                          location: nil,
+                          storage_class: nil,
+                          logging_bucket: nil,
+                          logging_prefix: nil,
+                          website_main: nil,
+                          website_404: nil,
+                          versioning: nil,
+                          requester_pays: nil,
+                          user_project: nil
           params = {
             name: bucket_name,
             location: location

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

@@ -38,17 +38,18 @@ module Google
 
         ##
         # Creates a new Service instance.
-        def initialize project, credentials,
-                       retries: nil, timeout: nil, host: nil, quota_project: nil
+        def initialize project, credentials, retries: nil,
+                       timeout: nil, open_timeout: nil, read_timeout: nil,
+                       send_timeout: nil, host: nil, quota_project: nil
           @project = project
           @credentials = credentials
           @service = API::StorageService.new
           @service.client_options.application_name    = "gcloud-ruby"
           @service.client_options.application_version = \
             Google::Cloud::Storage::VERSION
-          @service.client_options.open_timeout_sec = timeout
-          @service.client_options.read_timeout_sec = timeout
-          @service.client_options.send_timeout_sec = timeout
+          @service.client_options.open_timeout_sec = (open_timeout || timeout)
+          @service.client_options.read_timeout_sec = (read_timeout || timeout)
+          @service.client_options.send_timeout_sec = (send_timeout || timeout)
           @service.client_options.transparent_gzip_decompression = false
           @service.request_options.retries = retries || 3
           @service.request_options.header ||= {}

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Storage
-      VERSION = "1.33.0".freeze
+      VERSION = "1.36.0".freeze
     end
   end
 end

data/lib/google/cloud/storage.rb

@@ -55,7 +55,11 @@ module Google
       #   * `https://www.googleapis.com/auth/devstorage.full_control`
       # @param [Integer] retries Number of times to retry requests on server
       #   error. The default value is `3`. Optional.
-      # @param [Integer] timeout Default timeout to use in requests. Optional.
+      # @param [Integer] timeout (default timeout) The max duration, in seconds, to wait before timing out. Optional.
+      #    If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol.
+      # @param [Integer] open_timeout How long, in seconds, before failed connections time out. Optional.
+      # @param [Integer] read_timeout How long, in seconds, before requests time out. Optional.
+      # @param [Integer] send_timeout How long, in seconds, before receiving response from server times out. Optional.
       # @param [String] endpoint Override of the endpoint host name. Optional.
       #   If the param is nil, uses the default endpoint.
       # @param [String] project Alias for the `project_id` argument. Deprecated.
@@ -75,13 +79,18 @@ module Google
       #   bucket = storage.bucket "my-bucket"
       #   file = bucket.file "path/to/my-file.ext"
       #
+      # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
       def self.new project_id: nil, credentials: nil, scope: nil, retries: nil,
-                   timeout: nil, endpoint: nil, project: nil, keyfile: nil
-        scope       ||= configure.scope
-        retries     ||= configure.retries
-        timeout     ||= configure.timeout
-        endpoint    ||= configure.endpoint
-        credentials ||= (keyfile || default_credentials(scope: scope))
+                   timeout: nil, open_timeout: nil, read_timeout: nil,
+                   send_timeout: nil, endpoint: nil, project: nil, keyfile: nil
+        scope        ||= configure.scope
+        retries      ||= configure.retries
+        timeout      ||= configure.timeout
+        open_timeout ||= (configure.open_timeout || timeout)
+        read_timeout ||= (configure.read_timeout || timeout)
+        send_timeout ||= (configure.send_timeout || timeout)
+        endpoint     ||= configure.endpoint
+        credentials  ||= (keyfile || default_credentials(scope: scope))
 
         unless credentials.is_a? Google::Auth::Credentials
           credentials = Storage::Credentials.new credentials, scope: scope
@@ -93,11 +102,13 @@ module Google
         Storage::Project.new(
           Storage::Service.new(
             project_id, credentials,
-            retries: retries, timeout: timeout, host: endpoint,
-            quota_project: configure.quota_project
+            retries: retries, timeout: timeout, open_timeout: open_timeout,
+            read_timeout: read_timeout, send_timeout: send_timeout,
+            host: endpoint, quota_project: configure.quota_project
           )
         )
       end
+      # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
       ##
       # Creates an unauthenticated, anonymous client for retrieving public data
@@ -105,7 +116,11 @@ module Google
       #
       # @param [Integer] retries Number of times to retry requests on server
       #   error. The default value is `3`. Optional.
-      # @param [Integer] timeout Default timeout to use in requests. Optional.
+      # @param [Integer] timeout (default timeout) The max duration, in seconds, to wait before timing out. Optional.
+      #    If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol.
+      # @param [Integer] open_timeout How long, in seconds, before failed connections time out. Optional.
+      # @param [Integer] read_timeout How long, in seconds, before requests time out. Optional.
+      # @param [Integer] send_timeout How long, in seconds, before receiving response from server times out. Optional.
       # @param [String] endpoint Override of the endpoint host name. Optional.
       #   If the param is nil, uses the default endpoint.
       #
@@ -123,10 +138,15 @@ module Google
       #   downloaded.rewind
       #   downloaded.read #=> "Hello world!"
       #
-      def self.anonymous retries: nil, timeout: nil, endpoint: nil
+      def self.anonymous retries: nil, timeout: nil, open_timeout: nil,
+                         read_timeout: nil, send_timeout: nil, endpoint: nil
+        open_timeout ||= timeout
+        read_timeout ||= timeout
+        send_timeout ||= timeout
         Storage::Project.new(
           Storage::Service.new(
-            nil, nil, retries: retries, timeout: timeout, host: endpoint
+            nil, nil, retries: retries, timeout: timeout, open_timeout: open_timeout,
+            read_timeout: read_timeout, send_timeout: send_timeout, host: endpoint
           )
         )
       end
@@ -148,7 +168,11 @@ module Google
       #   the set of resources and operations that the connection can access.
       # * `retries` - (Integer) Number of times to retry requests on server
       #   error.
-      # * `timeout` - (Integer) Default timeout to use in requests.
+      # * `timeout` - (Integer) (default timeout) The max duration, in seconds, to wait before timing out.
+      #       If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol.
+      # * `open_timeout` - (Integer) How long, in seconds, before failed connections time out.
+      # * `read_timeout` - (Integer) How long, in seconds, before requests time out.
+      # * `send_timeout` - (Integer) How long, in seconds, before receiving response from server times out.
       #
       # @return [Google::Cloud::Config] The configuration object the
       #   Google::Cloud::Storage library uses.

data/lib/google-cloud-storage.rb

@@ -45,7 +45,11 @@ module Google
     #   * `https://www.googleapis.com/auth/devstorage.full_control`
     # @param [Integer] retries Number of times to retry requests on server
     #   error. The default value is `3`. Optional.
-    # @param [Integer] timeout Default timeout to use in requests. Optional.
+    # @param [Integer] timeout (default timeout) The max duration, in seconds, to wait before timing out. Optional.
+    #    If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol.
+    # @param [Integer] open_timeout How long, in seconds, before failed connections time out. Optional.
+    # @param [Integer] read_timeout How long, in seconds, before requests time out. Optional.
+    # @param [Integer] send_timeout How long, in seconds, before receiving response from server times out. Optional.
     #
     # @return [Google::Cloud::Storage::Project]
     #
@@ -64,10 +68,13 @@ module Google
     #   readonly_scope = "https://www.googleapis.com/auth/devstorage.read_only"
     #   readonly_storage = gcloud.storage scope: readonly_scope
     #
-    def storage scope: nil, retries: nil, timeout: nil
+    def storage scope: nil, retries: nil, timeout: nil, open_timeout: nil, read_timeout: nil, send_timeout: nil
       Google::Cloud.storage @project, @keyfile, scope: scope,
                                                 retries: (retries || @retries),
-                                                timeout: (timeout || @timeout)
+                                                timeout: (timeout || @timeout),
+                                                open_timeout: (open_timeout || timeout),
+                                                read_timeout: (read_timeout || timeout),
+                                                send_timeout: (send_timeout || timeout)
     end
 
     ##
@@ -93,7 +100,11 @@ module Google
     #   * `https://www.googleapis.com/auth/devstorage.full_control`
     # @param [Integer] retries Number of times to retry requests on server
     #   error. The default value is `3`. Optional.
-    # @param [Integer] timeout Default timeout to use in requests. Optional.
+    # @param [Integer] timeout (default timeout) The max duration, in seconds, to wait before timing out. Optional.
+    #    If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol.
+    # @param [Integer] open_timeout How long, in seconds, before failed connections time out. Optional.
+    # @param [Integer] read_timeout How long, in seconds, before requests time out. Optional.
+    # @param [Integer] send_timeout How long, in seconds, before receiving response from server times out. Optional.
     #
     # @return [Google::Cloud::Storage::Project]
     #
@@ -107,12 +118,16 @@ module Google
     #   file = bucket.file "path/to/my-file.ext"
     #
     def self.storage project_id = nil, credentials = nil, scope: nil,
-                     retries: nil, timeout: nil
+                     retries: nil, timeout: nil, open_timeout: nil, read_timeout: nil, send_timeout: nil
       require "google/cloud/storage"
       Google::Cloud::Storage.new project_id: project_id,
                                  credentials: credentials,
-                                 scope: scope, retries: retries,
-                                 timeout: timeout
+                                 scope: scope,
+                                 retries: retries,
+                                 timeout: timeout,
+                                 open_timeout: (open_timeout || timeout),
+                                 read_timeout: (read_timeout || timeout),
+                                 send_timeout: (send_timeout || timeout)
     end
   end
 end
@@ -139,6 +154,9 @@ Google::Cloud.configure.add_config! :storage do |config|
   config.add_field! :quota_project, nil, match: String
   config.add_field! :retries, nil, match: Integer
   config.add_field! :timeout, nil, match: Integer
+  config.add_field! :open_timeout, nil, match: Integer
+  config.add_field! :read_timeout, nil, match: Integer
+  config.add_field! :send_timeout, nil, match: Integer
   # TODO: Remove once discovery document is updated.
   config.add_field! :endpoint, "https://storage.googleapis.com/", match: String
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-storage
 version: !ruby/object:Gem::Version
-  version: 1.33.0
+  version: 1.36.0
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-29 00:00:00.000000000 Z
+date: 2022-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -93,14 +93,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '2.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '2.8'
 - !ruby/object:Gem::Dependency
   name: mini_mime
   requirement: !ruby/object:Gem::Requirement
@@ -318,7 +318,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.17
+rubygems_version: 3.3.4
 signing_key: 
 specification_version: 4
 summary: API Client library for Google Cloud Storage