google-apis-core 0.17.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b72f0bd125a4b9a5bbefb344ca6906f60c2da97299f477a411f4174a5a1e125
-  data.tar.gz: f60c015250f7df95b17c06a13e30a038f02f63d964940fb35b1be3596b455226
+  metadata.gz: adcaaf904d1c4e3e203b45c527c259c1be63aa675402247297a96ca087b5e14a
+  data.tar.gz: 6bafca376fc6569b0e8ff19071c1729e83310f55d3cb3b99e11d5440448ffd83
 SHA512:
-  metadata.gz: 7a08ed2a45ee09dd772fe046fa7b245663d9c39c12f26aab8a15d836d78a5bd1b98d6d9b97d4b97fc86dfba57e068074c7f484555ff1acea1b9ecba7bf699a34
-  data.tar.gz: b7125709ef96626805cf00bd31638b628e1425964a73021c0efd0a62d488a01037a9055371dde53ebf54c64905526de682474d006ae68072e081f423b3954618
+  metadata.gz: 4a24caabd4a3bfc09f9de6be416165fa6aa4b90f89b7ecf4f948801cba266c81e497f773fe25740a723056db708342a28eb36584a11dc43a436ca90e2eb95234
+  data.tar.gz: 4da89f87e45e5edf5c359aef57878e044c90411638c899744efe5235215fa576b2cd3eb46fa61b1678a4b57dda521b6f9fb386c8868a3b9118ddc494757f8a9a

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Release History
 
+### 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/lib/google/apis/core/base_service.rb

@@ -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 = options[:delete_upload] unless options[:delete_upload].nil?
+          execute_or_queue_command(command)
+        end
+
         protected
 
         # Create a new upload command.

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,7 +89,7 @@ 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
@@ -96,8 +105,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
@@ -131,6 +148,22 @@ module Google
           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
@@ -160,6 +193,9 @@ module Google
           @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
@@ -182,6 +218,59 @@ module Google
           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, header: request_header, follow_redirect: true)
+          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, header: request_header, follow_redirect: true)
+          handle_resumable_upload_http_response_codes(response)
+
+          if !@upload_incomplete && (400..499).include?(response.code.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.code} - #{response.body}") }
+          end
+  
+        end
+
+        def handle_resumable_upload_http_response_codes(response)
+          code = response.code.to_i
+
+          case code
+          when 308
+            if response.headers['Range']
+              range = response.headers['Range']
+              @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.code} - #{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/version.rb

@@ -16,7 +16,7 @@ module Google
   module Apis
     module Core
       # Core version
-      VERSION = "0.17.0".freeze
+      VERSION = "0.18.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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-core
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.18.0
 platform: ruby
 authors:
 - Google LLC
@@ -164,7 +164,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/v0.18.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/google-apis-core
 rdoc_options: []
 require_paths:
@@ -180,7 +180,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: []