google-cloud-storage 1.18.1 → 1.44.0

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

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

data/lib/google/cloud/storage.rb

@@ -55,7 +55,18 @@ 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] max_elapsed_time Total time in seconds that requests are allowed to keep being retried.
+      # @param [Float] base_interval The initial interval in seconds between tries.
+      # @param [Integer] max_interval The maximum interval in seconds that any individual retry can reach.
+      # @param [Integer] multiplier Each successive interval grows by this factor. A multipler of 1.5 means the next
+      #                  interval will be 1.5x the current interval.
+      # @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.
       # @param [String] keyfile Alias for the `credentials` argument.
       #   Deprecated.
@@ -73,30 +84,44 @@ module Google
       #   bucket = storage.bucket "my-bucket"
       #   file = bucket.file "path/to/my-file.ext"
       #
+      # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/AbcSize
       def self.new project_id: nil, credentials: nil, scope: nil, retries: nil,
-                   timeout: nil, project: nil, keyfile: nil
-        project_id  ||= (project || default_project_id)
-        scope       ||= configure.scope
-        retries     ||= configure.retries
-        timeout     ||= configure.timeout
-        credentials ||= (keyfile || default_credentials(scope: scope))
+                   timeout: nil, open_timeout: nil, read_timeout: nil,
+                   send_timeout: nil, endpoint: nil, project: nil, keyfile: nil,
+                   max_elapsed_time: nil, base_interval: nil, max_interval: nil,
+                   multiplier: 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))
+        max_elapsed_time  ||= configure.max_elapsed_time
+        base_interval     ||= configure.base_interval
+        max_interval      ||= configure.max_interval
+        multiplier        ||= configure.multiplier
 
         unless credentials.is_a? Google::Auth::Credentials
           credentials = Storage::Credentials.new credentials, scope: scope
         end
 
-        if credentials.respond_to? :project_id
-          project_id ||= credentials.project_id
-        end
-        project_id = project_id.to_s # Always cast to a string
+        project_id = resolve_project_id(project_id || project, credentials)
         raise ArgumentError, "project_id is missing" if project_id.empty?
 
         Storage::Project.new(
           Storage::Service.new(
-            project_id, credentials, retries: retries, timeout: timeout
+            project_id, credentials,
+            retries: retries, timeout: timeout, open_timeout: open_timeout,
+            read_timeout: read_timeout, send_timeout: send_timeout,
+            host: endpoint, quota_project: configure.quota_project,
+            max_elapsed_time: max_elapsed_time, base_interval: base_interval,
+            max_interval: max_interval, multiplier: multiplier
           )
         )
       end
+      # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/AbcSize
 
       ##
       # Creates an unauthenticated, anonymous client for retrieving public data
@@ -104,7 +129,18 @@ 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] max_elapsed_time Total time in seconds that requests are allowed to keep being retried.
+      # @param [Float] base_interval The initial interval in seconds between tries.
+      # @param [Integer] max_interval The maximum interval in seconds that any individual retry can reach.
+      # @param [Integer] multiplier Each successive interval grows by this factor. A multipler of 1.5 means the next
+      #                  interval will be 1.5x the current interval.
+      # @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.
       #
       # @return [Google::Cloud::Storage::Project]
       #
@@ -120,9 +156,20 @@ module Google
       #   downloaded.rewind
       #   downloaded.read #=> "Hello world!"
       #
-      def self.anonymous retries: nil, timeout: nil
+      def self.anonymous retries: nil, timeout: nil, open_timeout: nil,
+                         read_timeout: nil, send_timeout: nil, endpoint: nil,
+                         max_elapsed_time: nil, base_interval: nil, max_interval: nil,
+                         multiplier: nil
+        open_timeout ||= timeout
+        read_timeout ||= timeout
+        send_timeout ||= timeout
         Storage::Project.new(
-          Storage::Service.new(nil, nil, retries: retries, timeout: timeout)
+          Storage::Service.new(
+            nil, nil, retries: retries, timeout: timeout, open_timeout: open_timeout,
+            read_timeout: read_timeout, send_timeout: send_timeout, host: endpoint,
+            max_elapsed_time: max_elapsed_time, base_interval: base_interval,
+            max_interval: max_interval, multiplier: multiplier
+          )
         )
       end
 
@@ -137,11 +184,24 @@ module Google
       #   the keyfile as a String, the contents of the keyfile as a Hash, or a
       #   Google::Auth::Credentials object. (See {Storage::Credentials}) (The
       #   parameter `keyfile` is considered deprecated, but may also be used.)
+      # * `endpoint` - (String) Override of the endpoint host name, or `nil`
+      #   to use the default endpoint.
       # * `scope` - (String, Array<String>) The OAuth 2.0 scopes controlling
       #   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.
+      # * `max_elapsed_time` - (Integer) Total time in seconds that requests
+      #    are allowed to keep being retried.
+      # * `base_interval` - (Float) The initial interval in seconds between tries.
+      # * `max_interval` - (Integer) The maximum interval in seconds that any
+      #   individual retry can reach.
+      # * `multiplier` - (Integer) Each successive interval grows by this factor.
+      #    A multipler of 1.5 means the next interval will be 1.5x the current interval.
+      # * `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.
@@ -152,6 +212,16 @@ module Google
         Google::Cloud.configure.storage
       end
 
+      ##
+      # @private Resolve project.
+      def self.resolve_project_id given_project, credentials
+        project_id = given_project || default_project_id
+        if credentials.respond_to? :project_id
+          project_id ||= credentials.project_id
+        end
+        project_id.to_s # Always cast to a string
+      end
+
       ##
       # @private Default project.
       def self.default_project_id

data/lib/google-cloud-storage.rb

@@ -45,7 +45,16 @@ 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] max_elapsed_time Total time in seconds that requests are allowed to keep being retried.
+    # @param [Float] base_interval The initial interval in seconds between tries.
+    # @param [Integer] max_interval The maximum interval in seconds that any individual retry can reach.
+    # @param [Integer] multiplier Each successive interval grows by this factor. A multipler of 1.5 means the next
+    #                  interval will be 1.5x the current interval.
+    # @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 +73,18 @@ 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,
+                max_elapsed_time: nil, base_interval: nil, max_interval: nil, multiplier: 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),
+                                                max_elapsed_time: max_elapsed_time,
+                                                base_interval: base_interval,
+                                                max_interval: max_interval,
+                                                multiplier: multiplier
     end
 
     ##
@@ -93,7 +110,16 @@ 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] max_elapsed_time Total time in seconds that requests are allowed to keep being retried.
+    # @param [Float] base_interval The initial interval in seconds between tries.
+    # @param [Integer] max_interval The maximum interval in seconds that any individual retry can reach.
+    # @param [Integer] multiplier Each successive interval grows by this factor. A multipler of 1.5 means the next
+    #                  interval will be 1.5x the current interval.
+    # @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,17 +133,27 @@ 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,
+                     max_elapsed_time: nil, base_interval: nil, max_interval: nil, multiplier: 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),
+                                 max_elapsed_time: max_elapsed_time,
+                                 base_interval: base_interval,
+                                 max_interval: max_interval,
+                                 multiplier: multiplier
     end
   end
 end
 
 # Set the default storage configuration
+# rubocop:disable Metrics/BlockLength
 Google::Cloud.configure.add_config! :storage do |config|
   default_project = Google::Cloud::Config.deferred do
     ENV["STORAGE_PROJECT"]
@@ -136,6 +172,17 @@ Google::Cloud.configure.add_config! :storage do |config|
                     allow_nil: true
   config.add_alias! :keyfile, :credentials
   config.add_field! :scope, nil, match: [String, Array]
+  config.add_field! :quota_project, nil, match: String
   config.add_field! :retries, nil, match: Integer
+  config.add_field! :max_elapsed_time, nil, match: Integer
+  config.add_field! :base_interval, nil, match: Float
+  config.add_field! :max_interval, nil, match: Integer
+  config.add_field! :multiplier, 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
+# rubocop:enable Metrics/BlockLength

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-storage
 version: !ruby/object:Gem::Version
-  version: 1.18.1
+  version: 1.44.0
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-30 00:00:00.000000000 Z
+date: 2022-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -17,48 +17,62 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
-  name: google-api-client
+  name: google-apis-iamcredentials_v1
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.26'
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.26'
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: google-apis-storage_v1
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.0
 - !ruby/object:Gem::Dependency
   name: googleauth
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.2
+        version: 0.16.2
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 2.a
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.2
+        version: 0.16.2
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 2.a
 - !ruby/object:Gem::Dependency
   name: digest-crc
   requirement: !ruby/object:Gem::Requirement
@@ -79,28 +93,56 @@ 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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: google-style
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.25.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.25.1
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.10'
+        version: '5.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.10'
+        version: '5.16'
 - !ruby/object:Gem::Dependency
   name: minitest-autotest
   requirement: !ruby/object:Gem::Requirement
@@ -172,21 +214,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.64.0
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.64.0
+        version: '0.9'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -200,33 +242,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.9'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: yard-doctest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.1.13
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.1.13
 - !ruby/object:Gem::Dependency
-  name: yard-doctest
+  name: retriable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.13
+        version: 3.1.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.13
+        version: 3.1.2
 description: google-cloud-storage is the official library for Google Cloud Storage.
 email:
 - mike@blowmage.com
@@ -260,8 +302,13 @@ files:
 - lib/google/cloud/storage/file/signer_v2.rb
 - lib/google/cloud/storage/file/signer_v4.rb
 - lib/google/cloud/storage/file/verifier.rb
+- lib/google/cloud/storage/hmac_key.rb
+- lib/google/cloud/storage/hmac_key/list.rb
 - lib/google/cloud/storage/notification.rb
 - lib/google/cloud/storage/policy.rb
+- lib/google/cloud/storage/policy/binding.rb
+- lib/google/cloud/storage/policy/bindings.rb
+- lib/google/cloud/storage/policy/condition.rb
 - lib/google/cloud/storage/post_object.rb
 - lib/google/cloud/storage/project.rb
 - lib/google/cloud/storage/service.rb
@@ -278,14 +325,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.3.14
 signing_key: 
 specification_version: 4
 summary: API Client library for Google Cloud Storage