google-apis-core 0.17.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b72f0bd125a4b9a5bbefb344ca6906f60c2da97299f477a411f4174a5a1e125
-  data.tar.gz: f60c015250f7df95b17c06a13e30a038f02f63d964940fb35b1be3596b455226
+  metadata.gz: 2e4864fdbdd96f55fa077d183ac6c25f87d16509b48bd270803c73f81d4fa47b
+  data.tar.gz: 869598753c71741fcd2a4f474b464a609d6fcb2b6513c9c87d75ff1365192d07
 SHA512:
-  metadata.gz: 7a08ed2a45ee09dd772fe046fa7b245663d9c39c12f26aab8a15d836d78a5bd1b98d6d9b97d4b97fc86dfba57e068074c7f484555ff1acea1b9ecba7bf699a34
-  data.tar.gz: b7125709ef96626805cf00bd31638b628e1425964a73021c0efd0a62d488a01037a9055371dde53ebf54c64905526de682474d006ae68072e081f423b3954618
+  metadata.gz: 4bfce12bdbf8dd48e4856b77902d7fef1343ae940400e56090b1d946ed26e786b1f39ae17f3aa60dfc63e3594411c48eb5711957ad7a0f55c136fab03e45edb8
+  data.tar.gz: 21c7758ca4994eef7b077b19b10affcc112a909834f3b7dc5b346df42712ea3d68cccabf8131c869410ce3091f679509f39f834d5f05fbb31ea8c14ec40d8a45

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Release History
 
+### 1.0.0 (2025-08-03)
+
+This is a major release that replaces the underlying httpclient library with Faraday ([#23524](https://github.com/googleapis/google-api-ruby-client/issues/23524)). This will ensure the client libraries are on a more stable and better maintained foundation moving forward.
+
+For most users, this change should be transparent. However, if your application depends on the httpclient interfaces, you can retain compatibility with httpclient by pinning the `google-apis-core` gem to `~> 0.18` in your Gemfile. Httpclient-based versions of this gem will remain on the 0.x release train, while Faraday-based versions will occupy the 1.x release train. We will push critical fixes and security updates to both branches for one year until August 2026, but new feature work will take place only on the 1.x branch.
+
+### 0.18.0 (2025-05-22)
+
+#### Features
+
+* Restart & delete resumable upload ([#21896](https://github.com/googleapis/google-api-ruby-client/issues/21896)) 
+
 ### 0.17.0 (2025-04-30)
 
 #### Features

data/OVERVIEW.md

@@ -4,6 +4,24 @@ This library includes common base classes and dependencies used by legacy REST
 clients for Google APIs. It is used by client libraries, but you should not
 need to install it by itself.
 
+## Usage
+
+In most cases, this library is installed automatically as a dependency of
+another library. For example, if you install the
+[google-apis-drive_v3](https://rubygems.org/gems/google-apis-drive_v3) client
+library, it will bring in the latest `google-apis-core` as a dependency. Thus,
+in most cases, you do not need to add `google-apis-core` to your Gemfile
+directly.
+
+Earlier (0.x) versions of this library utilized the legacy
+[httpclient](https://rubygems.org/gems/httpclient) gem and made some of its
+interfaces available for advanced use cases. Version 1.0 and later of this
+library replaced httpclient with [faraday](https://rubygems.org/gems/faraday).
+If your application makes use of the httpclient interfaces (this is rare), you
+should pin `google-apis-core` to a 0.x version in your Gemfile. For example:
+
+    gem "google-apis-core", "~> 0.18"
+
 ## Documentation
 
 More detailed descriptions of the Google legacy REST clients are available in two documents.

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

@@ -18,13 +18,13 @@ require 'google/apis'
 require 'google/apis/core/version'
 require 'google/apis/core/api_command'
 require 'google/apis/core/batch'
+require 'google/apis/core/faraday_integration'
 require 'google/apis/core/upload'
 require 'google/apis/core/storage_upload'
 require 'google/apis/core/download'
 require 'google/apis/core/storage_download'
 require 'google/apis/options'
 require 'googleauth'
-require 'httpclient'
 
 module Google
   module Apis
@@ -149,8 +149,8 @@ module Google
         # @return [Addressable::URI]
         attr_accessor :batch_path
 
-        # HTTP client
-        # @return [HTTPClient]
+        # Faraday HTTP connection
+        # @return [Faraday::Connection]
         attr_writer :client
 
         # General settings
@@ -263,8 +263,8 @@ module Google
           batch_command.execute(client)
         end
 
-        # Get the current HTTP client
-        # @return [HTTPClient]
+        # Get the current HTTP connection
+        # @return [Faraday::Connection]
         def client
           @client ||= new_client
         end
@@ -350,6 +350,36 @@ module Google
           true
         end
 
+        # Restarts An interrupted Resumable upload
+        # @param [String] bucket
+        #   Name of the bucket where the upload is being performed.
+        # @param [IO, String] upload_source
+        #   IO stream or filename containing content to upload
+        # @param [IO, String] upload_id
+        #   unique id generated for an ongoing upload
+
+        def restart_resumable_upload(bucket, upload_source, upload_id, options: nil)
+          command = make_storage_upload_command(:put, 'b/{bucket}/o', options)
+          command.upload_source = upload_source
+          command.upload_id = upload_id
+          command.params['bucket'] = bucket unless bucket.nil?
+          execute_or_queue_command(command)
+        end
+
+        # Deletes An interrupted Resumable upload
+        # @param [String] bucket
+        #   Name of the bucket where the upload is being performed.
+        # @param [IO, String] upload_id
+        #   unique id generated for an ongoing upload
+
+        def delete_resumable_upload(bucket, upload_id, options: nil)
+          command = make_storage_upload_command(:delete, 'b/{bucket}/o', options)
+          command.upload_id = upload_id
+          command.params['bucket'] = bucket unless bucket.nil?
+          command.delete_upload = true
+          execute_or_queue_command(command)
+        end
+
         protected
 
         # Create a new upload command.
@@ -512,39 +542,22 @@ module Google
           Thread.current[:google_api_batch_service] = nil
         end
 
-        # Create a new HTTP client
-        # @return [HTTPClient]
+        # Create a new HTTP connection
+        # @return [Faraday::Connection]
         def new_client
-          client = ::HTTPClient.new
-
-          if client_options.transparent_gzip_decompression
-            client.transparent_gzip_decompression = client_options.transparent_gzip_decompression
-          end
-          
-          client.proxy = client_options.proxy_url if client_options.proxy_url
-
-          if client_options.open_timeout_sec
-            client.connect_timeout = client_options.open_timeout_sec
+          options = {}
+          request_options = {params_encoder: Faraday::FlatParamsEncoder}
+          options[:proxy] = {uri: client_options.proxy_url} if client_options.proxy_url
+          request_options[:open_timeout] = client_options.open_timeout_sec if client_options.open_timeout_sec
+          request_options[:read_timeout] = client_options.read_timeout_sec if client_options.read_timeout_sec
+          request_options[:write_timeout] = client_options.send_timeout_sec if client_options.send_timeout_sec
+          options[:request] = request_options unless request_options.empty?
+          options[:headers] = { 'User-Agent' => user_agent }
+
+          Faraday.new options do |faraday|
+            faraday.response :logger, Google::Apis.logger if client_options.log_http_requests
+            faraday.response :follow_redirects_google_apis_core, limit: 5
           end
-
-          if client_options.read_timeout_sec
-            client.receive_timeout = client_options.read_timeout_sec
-          end
-
-          if client_options.send_timeout_sec
-            client.send_timeout = client_options.send_timeout_sec
-          end
-
-          client.follow_redirect_count = 5
-          client.default_header = { 'User-Agent' => user_agent }
-
-          client.debug_dev = logger if client_options.log_http_requests
-
-          # Make HttpClient use system default root CA path
-          # https://github.com/nahi/httpclient/issues/445
-          client.ssl_config.clear_cert_store
-          client.ssl_config.cert_store.set_default_paths
-          client
         end
 
 

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

@@ -82,7 +82,7 @@ module Google
             parts.each_index do |index|
               response = deserializer.to_http_response(parts[index])
               outer_header = response.shift
-              call_id = header_to_id(outer_header['Content-ID'].first) || index
+              call_id = header_to_id(Array(outer_header['Content-ID']).first) || index
               call, callback = @calls[call_id]
               begin
                 result = call.process_response(*response) unless call.nil?
@@ -211,14 +211,14 @@ module Google
 
         protected
 
-        # Auxiliary method to split the header from the body in an HTTP response.
+        # Auxiliary method to split the headers from the body in an HTTP response.
         #
         # @param [String] response
         #   the response to parse.
-        # @return [Array<(HTTP::Message::Headers, String)>]
-        #   the header and the body, separately.
+        # @return [Array<(Hash{String=>Array<String>}, String)>]
+        #   the headers and the body, separately.
         def split_header_and_body(response)
-          header = HTTP::Message::Headers.new
+          headers = {}
           payload = response.lstrip
           while payload
             line, payload = payload.split(/\n/, 2)
@@ -226,9 +226,9 @@ module Google
             break if line.empty?
             match = /\A([^:]+):\s*/.match(line)
             fail BatchError, sprintf('Invalid header line in response: %s', line) if match.nil?
-            header[match[1]] = match.post_match
+            (headers[match[1]] ||= []) << match.post_match
           end
-          [header, payload]
+          [headers, payload]
         end
       end
     end

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

@@ -23,6 +23,8 @@ module Google
       # Streaming/resumable media download support
       class DownloadCommand < ApiCommand
         RANGE_HEADER = 'Range'
+
+        # @deprecated No longer used
         OK_STATUS = [200, 201, 206]
 
         # File or IO to write content to
@@ -61,8 +63,7 @@ module Google
         # of file content.
         #
         # @private
-        # @param [HTTPClient] client
-        #   HTTP client
+        # @param [Faraday::Connection] client Faraday connection
         # @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
@@ -78,39 +79,39 @@ module Google
             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)
+          http_res = client.get(url.to_s, query, request_header) do |request|
+            request.options.on_data = proc do |chunk, _size, res|
+              status = res.status.to_i
+              next if chunk.nil? || (status >= 300 && status < 400)
 
-            download_offset ||= (status == 206 ? @offset : 0)
-            download_offset  += chunk.bytesize
+              # HTTP 206 is Partial Content
+              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
+              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)
+              # logger.debug { sprintf('Writing chunk (%d bytes, %d total)', chunk.length, bytes_read) }
+              @download_io.write(next_chunk)
 
-            @offset += next_chunk.bytesize
+              @offset += next_chunk.bytesize
+            end
           end
 
-         @download_io.flush if @download_io.respond_to?(:flush)
+          @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)
+          check_status(http_res.status.to_i, http_res.headers, http_res.body)
           success(result, &block)
         rescue => e
           @download_io.flush if @download_io.respond_to?(:flush)

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

@@ -0,0 +1,47 @@
+# Copyright 2025 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 "faraday"
+require "faraday/follow_redirects"
+
+module Google
+  module Apis
+    module Core
+      # Customized version of the FollowRedirects middleware that does not
+      # trigger on 308. HttpCommand wants to handle 308 itself for resumable
+      # uploads.
+      class FollowRedirectsMiddleware < Faraday::FollowRedirects::Middleware
+        def follow_redirect?(env, response)
+          super && response.status != 308
+        end
+      end
+
+      Faraday::Response.register_middleware(follow_redirects_google_apis_core: FollowRedirectsMiddleware)
+
+      # Customized subclass of Faraday::Response with additional capabilities
+      # needed by older versions of some downstream dependencies.
+      class Response < Faraday::Response
+        # Compatibility alias.
+        # Earlier versions based on the old `httpclient` gem used `HTTP::Message`,
+        # which defined the `header` field that some clients, notably
+        # google-cloud-storage, depend on.
+        # Faraday's `headers` isn't an exact replacement because its values are
+        # single strings whereas `HTTP::Message` values are arrays, but
+        # google-cloud-storage already passes the result through `Array()` so this
+        # should work sufficiently.
+        alias header headers
+      end
+    end
+  end
+end

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

@@ -17,6 +17,7 @@ require 'addressable/template'
 require 'google/apis/options'
 require 'google/apis/errors'
 require 'retriable'
+require 'google/apis/core/faraday_integration'
 require 'google/apis/core/logging'
 require 'pp'
 
@@ -59,8 +60,8 @@ module Google
         # @return [symbol]
         attr_accessor :method
 
-        # HTTP Client
-        # @return [HTTPClient]
+        # Faraday connection
+        # @return [Faraday::Connection]
         attr_accessor :connection
 
         # Query params
@@ -96,8 +97,8 @@ module Google
 
         # Execute the command, retrying as necessary
         #
-        # @param [HTTPClient] client
-        #   HTTP client
+        # @param [Faraday::Connection] client
+        #   Faraday connection
         # @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
@@ -181,7 +182,7 @@ module Google
             @form_encoded = false
           end
 
-          self.body = '' unless self.body
+          self.body = '' if self.body.nil? && [:post, :put, :patch].include?(method)
         end
 
         # Release any resources used by this command
@@ -205,7 +206,7 @@ module Google
         # @raise [Google::Apis::AuthorizationError] Authorization is required
         def process_response(status, header, body)
           check_status(status, header, body)
-          decode_response_body(header['Content-Type'].first, body)
+          decode_response_body(Array(header['Content-Type']).first, body)
         end
 
         # Check the response and raise error if needed
@@ -284,17 +285,10 @@ module Google
         # @raise [StandardError] if no block
         def error(err, rethrow: false, &block)
           logger.debug { sprintf('Error - %s', PP.pp(err, +'')) }
-          if err.is_a?(HTTPClient::BadResponseError)
-            begin
-              res = err.res
-              raise Google::Apis::TransmissionError.new(err) if res.nil?
-              check_status(res.status.to_i, res.header, res.body)
-            rescue Google::Apis::Error => e
-              err = e
-            end
-          elsif err.is_a?(HTTPClient::TimeoutError) ||
+          if err.is_a?(Faraday::FollowRedirects::RedirectLimitReached)
+            err = Google::Apis::RedirectError.new(err)
+          elsif err.is_a?(Faraday::Error) ||
                 err.is_a?(SocketError) ||
-                err.is_a?(HTTPClient::KeepAliveDisconnected) ||
                 err.is_a?(Errno::ECONNREFUSED) ||
                 err.is_a?(Errno::ETIMEDOUT) ||
                 err.is_a?(Errno::ECONNRESET)
@@ -307,8 +301,8 @@ module Google
         # Execute the command once.
         #
         # @private
-        # @param [HTTPClient] client
-        #   HTTP client
+        # @param [Faraday::Connection] client
+        #   Faraday connection
         # @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
@@ -320,15 +314,11 @@ module Google
             request_header = header.dup
             apply_request_options(request_header)
 
-            @http_res = client.request(method.to_s.upcase,
-                                       url.to_s,
-                                       query: nil,
-                                       body: body,
-                                       header: request_header,
-                                       follow_redirect: true)
+            @http_res = client.run_request(method, url.to_s, body, request_header)
+
             logger.debug { @http_res.status }
             logger.debug { safe_single_line_representation @http_res }
-            response = process_response(@http_res.status.to_i, @http_res.header, @http_res.body)
+            response = process_response(@http_res.status.to_i, @http_res.headers, @http_res.body)
             success(response)
           rescue => e
             logger.debug { sprintf('Caught error %s', e) }
@@ -410,9 +400,14 @@ module Google
           @opencensus_span.put_attribute "http.host", url.host.to_s
           @opencensus_span.put_attribute "http.method", method.to_s.upcase
           @opencensus_span.put_attribute "http.path", url.path.to_s
-          if body.respond_to? :bytesize
-            @opencensus_span.put_message_event \
-              OpenCensus::Trace::SpanBuilder::SENT, 1, body.bytesize
+          sent_size =
+            if body.respond_to? :bytesize
+              body.bytesize
+            elsif body.nil?
+              0
+            end
+          if sent_size
+            @opencensus_span.put_message_event OpenCensus::Trace::SpanBuilder::SENT, 1, sent_size
           end
 
           formatter = OpenCensus::Trace.config.http_formatter

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

@@ -30,8 +30,7 @@ module Google
         # here too.
         #
         # @private
-        # @param [HTTPClient] client
-        #   HTTP client
+        # @param [Faraday::Connection] client Faraday connection
         # @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
@@ -47,41 +46,45 @@ module Google
             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)
+          http_res = client.get(url.to_s, query, request_header) do |request|
+            request.options.on_data = proc do |chunk, _size, res|
+              status = res.status.to_i
+              next if chunk.nil? || (status >= 300 && status < 400)
 
-            download_offset ||= (status == 206 ? @offset : 0)
-            download_offset  += chunk.bytesize
+              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
+              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)
+              # logger.debug { sprintf('Writing chunk (%d bytes, %d total)', chunk.length, bytes_read) }
+              @download_io.write(next_chunk)
 
-            @offset += next_chunk.bytesize
+              @offset += next_chunk.bytesize
+            end
           end
 
-         @download_io.flush if @download_io.respond_to?(:flush)
+          @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.
+          check_status(http_res.status.to_i, http_res.headers, http_res.body)
+          # In case of file download in storage, we need to respond back with
+          # the http response object along with the result IO object, because
+          # google-cloud-storage uses the HTTP info.
+          # Also, older versions of google-cloud-storage assume this object
+          # conforms to the old httpclient response API instead of the Faraday
+          # response API. Return a subclass that provides the needed methods.
+          http_res = Core::Response.new http_res.env
           success([result, http_res], &block)
         rescue => e
           @download_io.flush if @download_io.respond_to?(:flush)

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

@@ -49,6 +49,14 @@ module Google
         # @return [Integer]
         attr_accessor :upload_chunk_size
 
+        # Unique upload_id of a resumable upload
+        # @return [String]
+        attr_accessor :upload_id
+
+        # Boolean Value to specify is a resumable upload is to be deleted or not
+        # @return [Boolean]
+        attr_accessor :delete_upload
+
         # Ensure the content is readable and wrapped in an IO instance.
         #
         # @return [void]
@@ -61,7 +69,6 @@ module Google
           # asserting that it already has a body. Form encoding is never used
           # by upload requests.
           self.body = '' unless self.body
-
           super
           if streamable?(upload_source)
             self.upload_io = upload_source
@@ -73,6 +80,8 @@ module Google
               self.upload_content_type = type&.content_type
             end
             @close_io_on_finish = true
+          elsif !upload_id.nil? && delete_upload
+            @close_io_on_finish = false
           else
             fail Google::Apis::ClientError, 'Invalid upload source'
           end
@@ -80,13 +89,12 @@ module Google
 
         # Close IO stream when command done. Only closes the stream if it was opened by the command.
         def release!
-          upload_io.close if @close_io_on_finish
+          upload_io.close if @close_io_on_finish && !upload_io.nil?
         end
 
         # Execute the command, retrying as necessary
         #
-        # @param [HTTPClient] client
-        #   HTTP client
+        # @param [Faraday::Connection] client Faraday connection
         # @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
@@ -96,8 +104,16 @@ module Google
           prepare!
           opencensus_begin_span
           @upload_chunk_size = options.upload_chunk_size
+          if upload_id.nil?
+            res = do_retry :initiate_resumable_upload, client
+          elsif delete_upload && !upload_id.nil?
+            construct_resumable_upload_url upload_id
+            res = do_retry :cancel_resumable_upload, client
+          else
+            construct_resumable_upload_url upload_id
+            res = do_retry :reinitiate_resumable_upload, client
+          end
 
-          do_retry :initiate_resumable_upload, client
           while @upload_incomplete
             res = do_retry :send_upload_command, client
           end
@@ -121,20 +137,34 @@ module Google
           request_header[CONTENT_TYPE_HEADER] = JSON_CONTENT_TYPE
           request_header[UPLOAD_CONTENT_TYPE_HEADER] = upload_content_type unless upload_content_type.nil?
 
-          response = client.post(url.to_s, query: request_query,
-                         body: body,
-                         header: request_header,
-                         follow_redirect: true)
-          result = process_response(response.status_code, response.header, response.body)
+          response = client.post(url.to_s, body, request_header) do |request|
+            request.params.replace(request_query)
+          end
+          result = process_response(response.status.to_i, response.headers, response.body)
           success(result)
         rescue => e
           error(e, rethrow: true)
         end
 
+        # Reinitiating resumable upload
+        def reinitiate_resumable_upload(client)
+          logger.debug { sprintf('Restarting resumable upload command to %s', url) }
+          check_resumable_upload client
+          upload_io.pos = @offset
+        end
+
+        # Making resumable upload url from upload_id
+        def construct_resumable_upload_url(upload_id)
+          query_params = query.dup
+          query_params['uploadType'] = RESUMABLE
+          query_params['upload_id'] = upload_id
+          resumable_upload_params = query_params.map { |key, value| "#{key}=#{value}" }.join('&')
+          @upload_url = "#{url}&#{resumable_upload_params}"
+        end
+
         # Send the actual content
         #
-        # @param [HTTPClient] client
-        #   HTTP client
+        # @param [Faraday::Connection] client Faraday connection
         # @return [HTTP::Message]
         # @raise [Google::Apis::ServerError] Unable to send the request
         def send_upload_command(client)
@@ -145,7 +175,7 @@ module Google
 
           request_header = header.dup
           request_header[CONTENT_RANGE_HEADER] = get_content_range_header current_chunk_size
-          request_header[CONTENT_LENGTH_HEADER] = current_chunk_size
+          request_header[CONTENT_LENGTH_HEADER] = current_chunk_size.to_s
           chunk_body =
             if @upload_chunk_size == 0
               upload_io
@@ -153,13 +183,16 @@ module Google
               StringIO.new(upload_io.read(current_chunk_size))
             end
 
-          response = client.put(@upload_url, body: chunk_body, header: request_header, follow_redirect: true)
+          response = client.put(@upload_url, chunk_body, request_header)
 
-          result = process_response(response.status_code, response.header, response.body)
-          @upload_incomplete = false if response.status_code.eql? OK_STATUS
+          result = process_response(response.status.to_i, response.headers, response.body)
+          @upload_incomplete = false if response.status.to_i.eql? OK_STATUS
           @offset += current_chunk_size if @upload_incomplete
           success(result)
         rescue => e
+          logger.warn {
+            "error occured please use uploadId-#{response.headers['X-GUploader-UploadID']} to resume your upload"
+          } unless response.nil?
           upload_io.pos = @offset
           error(e, rethrow: true)
         end
@@ -178,10 +211,64 @@ module Google
         # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
         # @raise [Google::Apis::AuthorizationError] Authorization is required
         def process_response(status, header, body)
-          @upload_url = header[LOCATION_HEADER].first unless header[LOCATION_HEADER].empty?
+          location_header = Array(header[LOCATION_HEADER])
+          @upload_url = location_header.first unless location_header.empty?
           super(status, header, body)
         end
 
+        def check_resumable_upload(client)
+          # Setting up request header
+          request_header = header.dup
+          request_header[CONTENT_RANGE_HEADER] = "bytes */#{upload_io.size}"
+          request_header[CONTENT_LENGTH_HEADER] = '0'
+          # Initiating call
+          response = client.put(@upload_url, "", request_header)
+          handle_resumable_upload_http_response_codes(response)
+        end
+
+        # Cancel resumable upload
+        def cancel_resumable_upload(client)
+          # Setting up request header
+          request_header = header.dup
+          request_header[CONTENT_LENGTH_HEADER] = '0'
+          # Initiating call
+          response = client.delete(@upload_url, nil, request_header)
+          handle_resumable_upload_http_response_codes(response)
+
+          if !@upload_incomplete && (400..499).include?(response.status.to_i)
+            @close_io_on_finish = true
+            true # method returns true if upload is successfully cancelled
+          else
+            logger.debug { sprintf("Failed to cancel upload session. Response: #{response.status.to_i} - #{response.body}") }
+          end
+  
+        end
+
+        def handle_resumable_upload_http_response_codes(response)
+          code = response.status.to_i
+
+          case code
+          when 308
+            if response.headers['Range']
+              range = Array(response.headers['Range']).first
+              @offset = range.split('-').last.to_i + 1
+              logger.debug { sprintf("Upload is incomplete. Bytes uploaded so far: #{range}") }
+            else
+              logger.debug { sprintf('No bytes uploaded yet.') }
+            end
+            @upload_incomplete = true
+          when 400..499
+            # Upload is canceled
+            @upload_incomplete = false
+          when 200, 201
+            # Upload is complete.
+            @upload_incomplete = false
+          else
+            logger.debug { sprintf("Unexpected response: #{response.status.to_i} - #{response.body}") }
+            @upload_incomplete = true
+          end
+        end
+
         def streamable?(upload_source)
           upload_source.is_a?(IO) || upload_source.is_a?(StringIO) || upload_source.is_a?(Tempfile)
         end

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

@@ -30,6 +30,7 @@ module Google
         UPLOAD_CONTENT_TYPE_HEADER = 'X-Goog-Upload-Header-Content-Type'
         UPLOAD_CONTENT_LENGTH = 'X-Goog-Upload-Header-Content-Length'
         CONTENT_TYPE_HEADER = 'Content-Type'
+        CONTENT_LENGTH_HEADER = "Content-Length"
 
         # File name or IO containing the content to upload
         # @return [String, File, #read]
@@ -159,9 +160,11 @@ module Google
         # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
         # @raise [Google::Apis::AuthorizationError] Authorization is required
         def process_response(status, header, body)
-          @offset = Integer(header[BYTES_RECEIVED_HEADER].first) unless header[BYTES_RECEIVED_HEADER].empty?
-          @upload_url = header[UPLOAD_URL_HEADER].first unless header[UPLOAD_URL_HEADER].empty?
-          upload_status = header[UPLOAD_STATUS_HEADER].first
+          bytes_received_header = Array(header[BYTES_RECEIVED_HEADER])
+          @offset = Integer(bytes_received_header.first) unless bytes_received_header.empty?
+          upload_url_header = Array(header[UPLOAD_URL_HEADER])
+          @upload_url = upload_url_header.first unless upload_url_header.empty?
+          upload_status = Array(header[UPLOAD_STATUS_HEADER]).first
           logger.debug { sprintf('Upload status %s', upload_status) }
           if upload_status == STATUS_ACTIVE
             @state = :active
@@ -184,19 +187,14 @@ module Google
           request_header[UPLOAD_CONTENT_LENGTH] = upload_io.size.to_s
           request_header[UPLOAD_CONTENT_TYPE_HEADER] = upload_content_type
 
-          client.request(method.to_s.upcase,
-                         url.to_s, query: nil,
-                         body: body,
-                         header: request_header,
-                         follow_redirect: true)
+          client.run_request(method, url.to_s, body, request_header)
         rescue => e
           raise Google::Apis::ServerError, e.message
         end
 
         # Query for the status of an incomplete upload
         #
-        # @param [HTTPClient] client
-        #   HTTP client
+        # @param [Faraday::Connection] client Faraday connection
         # @return [HTTP::Message]
         # @raise [Google::Apis::ServerError] Unable to send the request
         def send_query_command(client)
@@ -206,14 +204,13 @@ module Google
           apply_request_options(request_header)
           request_header[UPLOAD_COMMAND_HEADER] = QUERY_COMMAND
 
-          client.post(@upload_url, body: '', header: request_header, follow_redirect: true)
+          client.post(@upload_url, '', request_header)
         end
 
 
         # Send the actual content
         #
-        # @param [HTTPClient] client
-        #   HTTP client
+        # @param [Faraday::Connection] client Faraday connection
         # @return [HTTP::Message]
         # @raise [Google::Apis::ServerError] Unable to send the request
         def send_upload_command(client)
@@ -228,16 +225,16 @@ module Google
           request_header[UPLOAD_COMMAND_HEADER] = UPLOAD_COMMAND
           request_header[UPLOAD_OFFSET_HEADER] = @offset.to_s
           request_header[CONTENT_TYPE_HEADER] = upload_content_type
+          request_header[CONTENT_LENGTH_HEADER] = (upload_io.size - @offset).to_s
 
-          client.post(@upload_url, body: content, header: request_header, follow_redirect: true)
+          client.post(@upload_url, content, request_header)
         end
 
         # Execute the upload request once. This will typically perform two HTTP requests -- one to initiate or query
         # for the status of the upload, the second to send the (remaining) content.
         #
         # @private
-        # @param [HTTPClient] client
-        #   HTTP client
+        # @param [Faraday::Connection] client Faraday connection
         # @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
@@ -247,16 +244,16 @@ module Google
           case @state
           when :start
             response = send_start_command(client)
-            result = process_response(response.status_code, response.header, response.body)
+            result = process_response(response.status.to_i, response.headers, response.body)
           when :active
             response = send_query_command(client)
-            result = process_response(response.status_code, response.header, response.body)
+            result = process_response(response.status.to_i, response.headers, response.body)
           when :cancelled, :final
             error(@last_error, rethrow: true, &block)
           end
           if @state == :active
             response = send_upload_command(client)
-            result = process_response(response.status_code, response.header, response.body)
+            result = process_response(response.status.to_i, response.headers, response.body)
           end
 
           success(result, &block) if @state == :final

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

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

data/lib/google/apis/options.rb

@@ -41,7 +41,8 @@ module Google
       :quota_project,
       :query,
       :add_invocation_id_header,
-      :upload_chunk_size)
+      :upload_chunk_size
+    )
 
     # General client options
     class ClientOptions
@@ -60,7 +61,7 @@ module Google
       # @!attribute [rw] read_timeout_sec
       #   @return [Integer] How long, in seconds, before receiving data times out
       # @!attribute [rw] transparent_gzip_decompression
-      # @return [Boolean] True if gzip compression needs to be enabled
+      #   @return [Boolean] DEPRECATED. Gzip decompression is now always on.
       # Get the default options
       # @return [Google::Apis::ClientOptions]
       def self.default

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-core
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Google LLC
@@ -27,104 +27,92 @@ dependencies:
   name: retriable
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.0'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.a
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.0'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.a
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '2.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.5.1
+        version: 2.8.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '2.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.5.1
+        version: 2.8.7
 - !ruby/object:Gem::Dependency
   name: mini_mime
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: googleauth
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.14'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.14'
 - !ruby/object:Gem::Dependency
-  name: httpclient
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.8.3
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.a
+        version: '2.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.8.3
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.a
+        version: '2.13'
 - !ruby/object:Gem::Dependency
-  name: mutex_m
+  name: faraday-follow_redirects
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.3'
 email: googleapis-packages@google.com
 executables: []
 extensions: []
@@ -147,6 +135,7 @@ files:
 - lib/google/apis/core/batch.rb
 - lib/google/apis/core/composite_io.rb
 - lib/google/apis/core/download.rb
+- lib/google/apis/core/faraday_integration.rb
 - lib/google/apis/core/hashable.rb
 - lib/google/apis/core/http_command.rb
 - lib/google/apis/core/json_representation.rb
@@ -164,7 +153,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.17.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-core/v1.0.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/google-apis-core
 rdoc_options: []
 require_paths:
@@ -180,7 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.8
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Common utility and base classes for legacy Google REST clients
 test_files: []