google-apis-core 0.4.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de1aca07eb6dab1c4571ad1b001657b858a7c8f263591d23f76a482707c1d244
-  data.tar.gz: 7715680088cf38a06fcf80747a047f0ebb0aaf63ed61817df26787db4f983fcd
+  metadata.gz: 7910ff49bab7cf667d1a049d41c8b7365b17e75aa14e1aff59c80eddb405f3b4
+  data.tar.gz: ccaafe8161b7119b394d3678dfaaafd70f13e136e63ac23096edd08ed14d9aaa
 SHA512:
-  metadata.gz: '029c926e8f4dcc1371f68def113598ca73cb4fc6982376c53175f40240a537b2dbce3e7cf041b54ae8b501867f0e728f596c1e70ed0abd798ba695605a7ca5fb'
-  data.tar.gz: fb2ef0252bfcdab2b3e45e07252cbed43a3a73dd4b72c32f7024a62bec18cf557905f75a5a7c56366b3466db29b353dd1a94ceee9a6a8160b05573231bcad237
+  metadata.gz: b627f63c2fb4270acbc9c5cddd31a3e5bffe977d1a336b08e2129d5127250154a0fcd96b062709bec5d24896daacc3fc58ef404599995dbc5d7bcea226430a71
+  data.tar.gz: a8d4b1d18d1a97c2b6bb3973e138c97b82e6e0d587ba14e319f26a30891455b96d6ef519a9376ec578c93acaa0e5ed7b20b0d39ca3192aec8d3b92267bb34bec

data/CHANGELOG.md

@@ -1,32 +1,48 @@
 # Release History
 
-### [0.4.2](https://www.github.com/googleapis/google-api-ruby-client/compare/google-apis-core/v0.4.1...google-apis-core/v0.4.2) (2022-01-21)
+### 0.7.0 (2022-06-30)
 
+#### Features
 
-### Bug Fixes
+* Add storage specific download to respond with http header 
 
-* **core:** Support for max elapsed time configuration. ([241361e](https://www.github.com/googleapis/google-api-ruby-client/commit/241361e1a47d1aeac09ecd1f24099c8fc83e4508))
+### 0.6.0 (2022-06-15)
 
-## 0.4.1 (2021-07-19)
+#### Features
+
+* add few more errors as retriable errors
+
+### 0.5.0 (2022-05-15)
+
+#### Features
+
+* Add support for retry options to be configurable
+
+### 0.4.2 (2022-01-21)
+
+#### Bug Fixes
+
+* Support for max elapsed time configuration.
+
+### 0.4.1 (2021-07-19)
 
 * FIX: Prevent duplicated pagination when a response returns an empty string as the next page token.
 
-## 0.4.0 (2021-06-28)
+### 0.4.0 (2021-06-28)
 
 * Expanded googleauth dependency to include future 1.x versions
 
-## [0.3.0](https://www.github.com/googleapis/google-api-ruby-client/compare/google-apis-core/v0.2.1...v0.3.0) (2021-03-07)
-
-### Features
+### 0.3.0 (2021-03-07)
 
-* Drop support for Ruby 2.4 and add support for Ruby 3.0 ([d871146](https://www.github.com/googleapis/google-api-ruby-client/commit/d871146916f3dd19a12820c03068b3861a4bc879))
+#### Features
 
-### [0.2.1](https://www.github.com/googleapis/google-api-ruby-client/compare/google-apis-core/v0.2.0...v0.2.1) (2021-01-25)
+* Drop support for Ruby 2.4 and add support for Ruby 3.0
 
+### 0.2.1 (2021-01-25)
 
-### Bug Fixes
+#### Bug Fixes
 
-* **core:** Add webrick to the gem dependencies, for Ruby 3 compatibility ([25824f2](https://www.github.com/googleapis/google-api-ruby-client/commit/25824f2512fa96d4d90e220ac038c9b3b2a6a0d1))
+* Add webrick to the gem dependencies, for Ruby 3 compatibility
 
 ### 0.2.0 (2021-01-06)
 

data/lib/google/apis/core/base_service.rb

@@ -20,6 +20,7 @@ require 'google/apis/core/api_command'
 require 'google/apis/core/batch'
 require 'google/apis/core/upload'
 require 'google/apis/core/download'
+require 'google/apis/core/storage_download'
 require 'google/apis/options'
 require 'googleauth'
 require 'httpclient'
@@ -335,6 +336,25 @@ module Google
           command
         end
 
+        # Create a new storage download command. This is specifically for storage because
+        # we want to return response header too in the response.
+        #
+        # @param [symbol] method
+        #   HTTP method for uploading (typically :get)
+        # @param [String] path
+        #  Additional path to download endpoint, appended to API base path
+        # @param [Hash, Google::Apis::RequestOptions] options
+        #  Request-specific options
+        # @return [Google::Apis::Core::StorageDownloadCommand]
+        def make_storage_download_command(method, path, options)
+          template = Addressable::Template.new(root_url + base_path + path)
+          command = StorageDownloadCommand.new(method, template, client_version: client_version)
+          command.options = request_options.merge(options)
+          command.query['alt'] = 'media'
+          apply_command_defaults(command)
+          command
+        end
+
         # Create a new command.
         #
         # @param [symbol] method

data/lib/google/apis/core/batch.rb

@@ -120,7 +120,7 @@ module Google
         end
 
         def ensure_valid_command(command)
-          if command.is_a?(Google::Apis::Core::BaseUploadCommand) || command.is_a?(Google::Apis::Core::DownloadCommand)
+          if command.is_a?(Google::Apis::Core::BaseUploadCommand) || command.is_a?(Google::Apis::Core::DownloadCommand) || command.is_a?(Google::Apis::Core::StorageDownloadCommand)
             fail Google::Apis::ClientError, 'Can not include media requests in batch'
           end
           fail Google::Apis::ClientError, 'Invalid command object' unless command.is_a?(HttpCommand)

data/lib/google/apis/core/http_command.rb

@@ -27,7 +27,10 @@ module Google
       class HttpCommand
         include Logging
 
-        RETRIABLE_ERRORS = [Google::Apis::ServerError, Google::Apis::RateLimitError, Google::Apis::TransmissionError]
+        RETRIABLE_ERRORS = [Google::Apis::ServerError,
+                            Google::Apis::RateLimitError,
+                            Google::Apis::TransmissionError,
+                            Google::Apis::RequestTimeOutError]
 
         begin
           require 'opencensus'
@@ -101,8 +104,9 @@ module Google
           begin
             Retriable.retriable tries: options.retries + 1,
                                 max_elapsed_time: options.max_elapsed_time,
-                                base_interval: 1,
-                                multiplier: 2,
+                                base_interval: options.base_interval,
+                                max_interval: options.max_interval,
+                                multiplier: options.multiplier,
                                 on: RETRIABLE_ERRORS do |try|
               # This 2nd level retriable only catches auth errors, and supports 1 retry, which allows
               # auth to be re-attempted without having to retry all sorts of other failures like
@@ -224,6 +228,9 @@ module Google
           when 429
             message ||= 'Rate limit exceeded'
             raise Google::Apis::RateLimitError.new(message, status_code: status, header: header, body: body)
+          when 408
+            message ||= 'Request time out'
+            raise Google::Apis::RequestTimeOutError.new(message, status_code: status, header: header, body: body)
           when 304, 400, 402...500
             message ||= 'Invalid request'
             raise Google::Apis::ClientError.new(message, status_code: status, header: header, body: body)
@@ -268,7 +275,7 @@ module Google
         # @yield [nil, err] if block given
         # @raise [StandardError] if no block
         def error(err, rethrow: false, &block)
-          logger.debug { sprintf('Error - %s', PP.pp(err, '')) }
+          logger.error { sprintf('Error - %s', PP.pp(err, '')) }
           if err.is_a?(HTTPClient::BadResponseError)
             begin
               res = err.res
@@ -277,7 +284,7 @@ module Google
             rescue Google::Apis::Error => e
               err = e
             end
-          elsif err.is_a?(HTTPClient::TimeoutError) || err.is_a?(SocketError)
+          elsif err.is_a?(HTTPClient::TimeoutError) || err.is_a?(SocketError) || err.is_a?(HTTPClient::KeepAliveDisconnected) || err.is_a?(Errno::ECONNREFUSED) || err.is_a?(Errno::ETIMEDOUT)
             err = Google::Apis::TransmissionError.new(err)
           end
           block.call(nil, err) if block_given?

data/lib/google/apis/core/storage_download.rb

@@ -0,0 +1,93 @@
+# Copyright 2022 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'google/apis/core/api_command'
+require 'google/apis/errors'
+require 'addressable/uri'
+
+module Google
+  module Apis
+    module Core
+      # Streaming/resumable media download support specifically for storage API so that 
+      # we can respond with response headers too.
+      class StorageDownloadCommand < DownloadCommand
+
+        # Execute the upload request once. Overrides the default implementation to handle streaming/chunking
+        # of file content.
+        # Note: This method is overriden from DownloadCommand in order to respond back with 
+        # http header. All changes made to `execute_once` of DownloadCommand, should be made 
+        # here too.
+        #
+        # @private
+        # @param [HTTPClient] client
+        #   HTTP client
+        # @yield [result, err] Result or error if block supplied
+        # @return [Object]
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def execute_once(client, &block)
+          request_header = header.dup
+          apply_request_options(request_header)
+          download_offset = nil
+
+          if @offset > 0
+            logger.debug { sprintf('Resuming download from offset %d', @offset) }
+            request_header[RANGE_HEADER] = sprintf('bytes=%d-', @offset)
+          end
+
+          http_res = client.get(url.to_s,
+                     query: query,
+                     header: request_header,
+                     follow_redirect: true) do |res, chunk|
+            status = res.http_header.status_code.to_i
+            next unless OK_STATUS.include?(status)
+
+            download_offset ||= (status == 206 ? @offset : 0)
+            download_offset  += chunk.bytesize
+
+            if download_offset - chunk.bytesize == @offset
+              next_chunk = chunk
+            else
+              # Oh no! Requested a chunk, but received the entire content
+              chunk_index = @offset - (download_offset - chunk.bytesize)
+              next_chunk = chunk.byteslice(chunk_index..-1)
+              next if next_chunk.nil?
+            end
+
+            # logger.debug { sprintf('Writing chunk (%d bytes, %d total)', chunk.length, bytes_read) }
+            @download_io.write(next_chunk)
+
+            @offset += next_chunk.bytesize
+          end
+
+         @download_io.flush if @download_io.respond_to?(:flush)
+
+          if @close_io_on_finish
+            result = nil
+          else
+            result = @download_io
+          end
+          check_status(http_res.status.to_i, http_res.header, http_res.body)
+          # In case of file download in storage, we need to respond back with http 
+          # header along with the actual object.
+          success([result, http_res], &block)
+        rescue => e
+          @download_io.flush if @download_io.respond_to?(:flush)
+          error(e, rethrow: true, &block)
+        end
+      end
+    end
+  end
+end

data/lib/google/apis/core/version.rb

@@ -16,7 +16,7 @@ module Google
   module Apis
     module Core
       # Core version
-      VERSION = "0.4.2".freeze
+      VERSION = "0.7.0".freeze
     end
   end
 end

data/lib/google/apis/errors.rb

@@ -66,7 +66,11 @@ module Google
     class ClientError < Error
     end
 
-    # A 4xx class HTTP error occurred.
+    # A 408 HTTP error occurred.
+    class RequestTimeOutError < ClientError
+    end
+
+    # A 429 HTTP error occurred.
     class RateLimitError < Error
     end
 

data/lib/google/apis/options.rb

@@ -29,6 +29,9 @@ module Google
       :authorization,
       :retries,
       :max_elapsed_time,
+      :base_interval,
+      :max_interval,
+      :multiplier,
       :header,
       :normalize_unicode,
       :skip_serialization,
@@ -69,6 +72,13 @@ module Google
       #   @return [Fixnum] Number of times to retry requests on server error.
       # @!attribute [rw] max_elapsed_time
       #   @return [Fixnum] Total time in seconds that requests are allowed to keep being retried.
+      # @!attribute [rw] base_interval
+      #   @return [Float] The initial interval in seconds between tries.
+      # @!attribute [rw] max_interval
+      #   @return [Fixnum] The maximum interval in seconds that any individual retry can reach.
+      # @!attribute [rw] multiplier
+      #   @return [rw] Each successive interval grows by this factor. A multipler of 1.5 means the next interval 
+      #              will be 1.5x the current interval.
       # @!attribute [rw] header
       #   @return [Hash<String,String>] Additional HTTP headers to include in requests.
       # @!attribute [rw] normalize_unicode
@@ -110,6 +120,9 @@ module Google
     ClientOptions.default.transparent_gzip_decompression = true
     RequestOptions.default.retries = 0
     RequestOptions.default.max_elapsed_time = 900
+    RequestOptions.default.base_interval = 1
+    RequestOptions.default.max_interval = 60
+    RequestOptions.default.multiplier = 2
     RequestOptions.default.normalize_unicode = false
     RequestOptions.default.skip_serialization = false
     RequestOptions.default.skip_deserialization = false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-core
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-21 00:00:00.000000000 Z
+date: 2022-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: representable
@@ -174,6 +174,7 @@ files:
 - lib/google/apis/core/json_representation.rb
 - lib/google/apis/core/logging.rb
 - lib/google/apis/core/multipart.rb
+- lib/google/apis/core/storage_download.rb
 - lib/google/apis/core/upload.rb
 - lib/google/apis/core/version.rb
 - lib/google/apis/errors.rb
@@ -184,7 +185,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/google-apis-core/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-core/v0.4.2
+  documentation_uri: https://googleapis.dev/ruby/google-apis-core/v0.7.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/google-apis-core
 post_install_message: 
 rdoc_options: []
@@ -201,7 +202,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.5
+rubygems_version: 3.3.14
 signing_key: 
 specification_version: 4
 summary: Common utility and base classes for legacy Google REST clients