feat: Add storage specific download to respond with http header

Author: bajajneha27

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

@@ -20,6 +20,7 @@
 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'

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

@@ -120,7 +120,7 @@ def prepare!
         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)

google-apis-core/spec/google/apis/core/service_spec.rb

@@ -168,6 +168,25 @@
     include_examples 'with options'
   end
 
+  context 'when making storage download commands' do
+    let(:command) { service.send(:make_storage_download_command, :get, 'zoo/animals', authorization: 'foo') }
+
+    it 'should return the correct command type' do
+      expect(command).to be_an_instance_of(Google::Apis::Core::StorageDownloadCommand)
+    end
+
+    it 'should build a correct URL' do
+      url = command.url.expand({}).to_s
+      expect(url).to eql 'https://www.googleapis.com/zoo/animals'
+    end
+
+    it 'should include alt=media in params' do
+      expect(command.query).to include('alt' => 'media')
+    end
+
+    include_examples 'with options'
+  end
+
   context 'when making upload commands' do
     let(:command) { service.send(:make_upload_command, :post, 'zoo/animals', authorization: 'foo') }
 

google-apis-core/spec/google/apis/core/storage_download_spec.rb

@@ -0,0 +1,138 @@
+# Copyright 2022 Google Inc.
+#
+# 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 'spec_helper'
+require 'google/apis/core/storage_download'
+require 'google/apis/core/json_representation'
+require 'tempfile'
+require 'tmpdir'
+
+RSpec.describe Google::Apis::Core::StorageDownloadCommand do
+  include TestHelpers
+  include_context 'HTTP client'
+
+  let(:command) do
+    command = Google::Apis::Core::StorageDownloadCommand.new(:get, 'https://www.googleapis.com/zoo/animals')
+    command.download_dest = dest
+    command
+  end
+
+  shared_examples 'should download' do
+    context 'with successful response' do
+      before(:example) do
+        stub_request(:get, 'https://www.googleapis.com/zoo/animals')
+          .to_return(headers: { 'Content-Type' => 'application/json' }, body: %(Hello world))
+      end
+
+      it 'should not include a range header' do
+        command.execute(client)
+        expect(a_request(:get, 'https://www.googleapis.com/zoo/animals')
+          .with { |req| !req.headers.key?('Range') }
+              ).to have_been_made
+      end
+
+      it 'should receive content' do
+        expect(received).to eql 'Hello world'
+      end
+    end
+
+    context 'with error' do
+      before(:example) do
+        stub_request(:get, 'https://www.googleapis.com/zoo/animals')
+            .to_return(status: [404, 'Not Found'], body: '')
+      end
+
+      it 'should raise error' do
+        expect {received}.to raise_error(Google::Apis::ClientError)
+      end
+    end
+
+    context 'with disconnects' do
+      before(:example) do
+        stub_request(:get, 'https://www.googleapis.com/zoo/animals')
+          .to_return(body: ['Hello ', Timeout::Error])
+          .to_return(status: [206, 'Partial content'], body: 'world')
+      end
+
+      it 'should receive entire content' do
+        expect(received).to eql('Hello world')
+      end
+    end
+
+    context 'with disconnects and no partial response' do
+      before(:example) do
+        stub_request(:get, 'https://www.googleapis.com/zoo/animals')
+            .to_return(body: ['Hello ', Timeout::Error])
+            .to_return(body: 'Hello world')
+      end
+
+      it 'should receive entire content' do
+        expect(received).to eql('Hello world')
+      end
+    end
+
+    context 'with redirect' do
+      before(:example) do
+        stub_request(:get, 'https://www.googleapis.com/zoo/animals')
+          .to_return(status: [302, 'Content moved'], headers: { 'Location' => 'https://content.googleapis.com/files/12345' }, body: %(Content moved))
+        stub_request(:get, 'https://content.googleapis.com/files/12345')
+          .to_return(headers: { 'Content-Type' => 'application/json' }, body: %(Hello world))
+      end
+
+      it 'should receive content' do
+        expect(received).to eql 'Hello world'
+      end
+    end
+  end
+
+  context 'with filename destination' do
+    let(:dest) { File.join(Dir.mktmpdir, 'test.txt') }
+    let(:received) do
+      command.execute(client)
+      File.read(dest)
+    end
+
+    include_examples 'should download'
+  end
+
+  context 'with default destination' do
+    let(:dest) { nil }
+    let(:received) { command.execute(client)[0].string }
+    include_examples 'should download'
+  end
+
+  context 'with IO destination' do
+    let(:dest) { Tempfile.new('test') }
+    let(:received) do
+      command.execute(client)
+      dest.rewind
+      dest.read
+    end
+
+    include_examples 'should download'
+  end
+
+  context 'with #write destination' do
+    let(:dest) { WritableIO.new(StringIO.new) }
+    let(:received) { command.execute(client)[0].io.string }
+
+    include_examples 'should download'
+
+    WritableIO = Struct.new(:io) do
+      def write(data)
+        io.write(data)
+      end
+    end
+  end
+end

google-apis-generator/lib/google/apis/generator/templates/_method.tmpl

@@ -58,18 +58,18 @@ def <%= api_method.generated_name %>(<% for param in api_method.required_paramet
     command.upload_source = upload_source
     command.upload_content_type = content_type
   end
-<% elsif api_method.supports_media_download? -%>
+<% elsif api_method.supports_media_download? && api.name == 'Storage' %>
   if download_dest.nil?
     command = make_simple_command(:<%= api_method.http_method.downcase %>, '<%= api_method.path %>', options)
   else
-    command = make_download_command(:<%= api_method.http_method.downcase %>, '<%= api_method.path %>', options)
+    command = make_storage_download_command(:<%= api_method.http_method.downcase %>, '<%= api_method.path %>', options)
     command.download_dest = download_dest
   end
-<% elsif api_method.supports_media_download? && api.name == 'Storage' %>
+<% elsif api_method.supports_media_download? -%>
   if download_dest.nil?
     command = make_simple_command(:<%= api_method.http_method.downcase %>, '<%= api_method.path %>', options)
   else
-    command = make_storage_download_command(:<%= api_method.http_method.downcase %>, '<%= api_method.path %>', options)
+    command = make_download_command(:<%= api_method.http_method.downcase %>, '<%= api_method.path %>', options)
     command.download_dest = download_dest
   end
 <% else -%>