google-cloud-storage 1.34.1 → 1.35.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c1a4e8d81d477657fb10766346d62bf9f4bbc9934af2b63a2cadb57195308df
-  data.tar.gz: 5a40bdb4ecfff8f5e93f3047ed9c6e85ccc5b3bba9a17b00aaeb5dcc979b66b5
+  metadata.gz: 46a00811174d5f74691bc49b43c14fe9a541f3c964c332eb9bccc4d2e85778cd
+  data.tar.gz: 0425d311a50177d6321a172958a6b2afef376a2c13f3dd3d5aa5d07ce974b773
 SHA512:
-  metadata.gz: 5380175443d2e863193a5b176a17e29d76d36eeeaaa7e059569168799a62969f8bd9b4e6359119b035f6586aaeb8af996cadfe01f7e7864db2c183e93e823aa1
-  data.tar.gz: 3954e38231d1cc1bd5679ed011eef6dd69f644e855f621d4af08dd207c815ede1393285953364256b9d1b49175ac6c35710ed01253ecd92b31ab5a66b2143090
+  metadata.gz: dd0fb3dd2b5d31ce65febca446c4826e72384de658bcf9bb66b349a2f8304c8494c86a6a88263dd38add67fd6083f375f436ffcad225413a7d803ee67c4a351c
+  data.tar.gz: f62d337690f49269a0839d1dfe65f998da7fb1e6a530c151a11eb4a890fc1942321b6c34ef34c9b932b59ab33a0a74ffb6a3b082d1e6688cfd4ddf9a48b478b3

data/CHANGELOG.md

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

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,14 +1025,16 @@ 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?
+
         ##
         # Updates the bucket with changes made in the given block in a single
         # PATCH request. The following attributes may be set: {#cors},

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.34.1".freeze
+      VERSION = "1.35.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.34.1
+  version: 1.35.0
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-08 00:00:00.000000000 Z
+date: 2021-12-08 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