google-apis-core 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a06abcc898df4624c92e688e9a96df1b80a4672b9a1e3ab571fa050510eb7536
-  data.tar.gz: d52f59c6503a787921c8dee5dacd5c7420daca2d67ead5cdb36fe70974ab7bf2
+  metadata.gz: 7910ff49bab7cf667d1a049d41c8b7365b17e75aa14e1aff59c80eddb405f3b4
+  data.tar.gz: ccaafe8161b7119b394d3678dfaaafd70f13e136e63ac23096edd08ed14d9aaa
 SHA512:
-  metadata.gz: 259dfe34f6d13f9f2381b4cf5c3d88a9aaeb46c954df0dd1b5f3c5029896dbef3853b4a76f5b9c3e79b38cff1c1fbb8a3d205c41824cebe9cdc66f8c0098d421
-  data.tar.gz: f383d03683daabbade354ec14c1708cefe2f5fd58bdee645e2d173d2fb9c95e2e35828750da8b1afd6449256a11374d953e87251cbc176595436fada8a12850d
+  metadata.gz: b627f63c2fb4270acbc9c5cddd31a3e5bffe977d1a336b08e2129d5127250154a0fcd96b062709bec5d24896daacc3fc58ef404599995dbc5d7bcea226430a71
+  data.tar.gz: a8d4b1d18d1a97c2b6bb3973e138c97b82e6e0d587ba14e319f26a30891455b96d6ef519a9376ec578c93acaa0e5ed7b20b0d39ca3192aec8d3b92267bb34bec

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Release History
 
+### 0.7.0 (2022-06-30)
+
+#### Features
+
+* Add storage specific download to respond with http header 
+
 ### 0.6.0 (2022-06-15)
 
 #### Features

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

@@ -275,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

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.6.0".freeze
+      VERSION = "0.7.0".freeze
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-core
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-15 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.6.0
+  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: []