google-api-client 0.8.6 → 0.9.3

data/spec/google/apis/core/batch_spec.rb

@@ -0,0 +1,142 @@
+# Copyright 2015 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/batch'
+require 'google/apis/core/json_representation'
+require 'hurley/test'
+
+RSpec.describe Google::Apis::Core::BatchCommand do
+  include TestHelpers
+  include_context 'HTTP client'
+
+  let(:command) do
+    command = Google::Apis::Core::BatchCommand.new(:post, 'https://www.googleapis.com/batch')
+  end
+
+  let(:get_command) { Google::Apis::Core::HttpCommand.new(:get, 'https://www.googleapis.com/zoo/animals/1') }
+
+  let(:post_with_string_command) do
+    command = Google::Apis::Core::HttpCommand.new(:post, 'https://www.googleapis.com/zoo/animals/2')
+    command.body = 'Hello world'
+    command.header[:content_type] = 'text/plain'
+    command
+  end
+
+  let(:post_with_io_command) do
+    command = Google::Apis::Core::HttpCommand.new(:post, 'https://www.googleapis.com/zoo/animals/3')
+    command.body = StringIO.new('Goodbye!')
+    command.header[:content_type] = 'text/plain'
+    command
+  end
+
+  before(:example) do
+    allow(SecureRandom).to receive(:uuid).and_return('ffe23d1b-e8f7-47f5-8c01-2a30cf8ecb8f')
+
+    response = <<EOF
+--batch123
+Content-Type: application/http
+Content-ID: <response-ffe23d1b-e8f7-47f5-8c01-2a30cf8ecb8f+0>
+
+HTTP/1.1 200 OK
+Content-Type: text/plain; charset=UTF-8
+
+Hello
+--batch123
+Content-Type: application/http
+Content-ID: <response-ffe23d1b-e8f7-47f5-8c01-2a30cf8ecb8f+2>
+
+HTTP/1.1 500 Server Error
+Content-Type: text/plain; charset=UTF-8
+
+Error!
+--batch123
+Content-Type: application/http
+Content-ID: <response-ffe23d1b-e8f7-47f5-8c01-2a30cf8ecb8f+1>
+
+HTTP/1.1 200 OK
+Content-Type: text/plain; charset=UTF-8
+
+world
+--batch123--
+EOF
+    stub_request(:post, 'https://www.googleapis.com/batch')
+      .to_return(headers: { 'Content-Type' => 'multipart/mixed; boundary=batch123' }, body: response)
+  end
+
+  it 'should send content' do
+    b = ->(_res, _err) {}
+    command.add(get_command, &b)
+    command.add(post_with_string_command, &b)
+    command.add(post_with_io_command, &b)
+    command.execute(client)
+
+    expected_body = <<EOF.gsub(/\n/, "\r\n")
+--RubyApiBatchRequest
+Content-Length: 58
+Content-ID: <ffe23d1b-e8f7-47f5-8c01-2a30cf8ecb8f+0>
+Content-Type: application/http
+Content-Transfer-Encoding: binary
+
+GET /zoo/animals/1? HTTP/1.1
+Host: www.googleapis.com
+
+
+--RubyApiBatchRequest
+Content-Length: 96
+Content-ID: <ffe23d1b-e8f7-47f5-8c01-2a30cf8ecb8f+1>
+Content-Type: application/http
+Content-Transfer-Encoding: binary
+
+POST /zoo/animals/2? HTTP/1.1
+Content-Type: text/plain
+Host: www.googleapis.com
+
+Hello world
+--RubyApiBatchRequest
+Content-Length: 93
+Content-ID: <ffe23d1b-e8f7-47f5-8c01-2a30cf8ecb8f+2>
+Content-Type: application/http
+Content-Transfer-Encoding: binary
+
+POST /zoo/animals/3? HTTP/1.1
+Content-Type: text/plain
+Host: www.googleapis.com
+
+Goodbye!
+--RubyApiBatchRequest--
+
+EOF
+    expect(a_request(:post, 'https://www.googleapis.com/batch').with(body: expected_body)).to have_been_made
+  end
+
+  it 'should send decode responses' do
+    expect do |b|
+      command.add(get_command) do |res, err|
+        b.to_proc.call(1, res, err)
+      end
+      command.add(post_with_string_command) do |res, err|
+        b.to_proc.call(2, res, err)
+      end
+      command.add(post_with_io_command) do |res, err|
+        b.to_proc.call(3, res, err)
+      end
+      command.execute(client)
+    end.to yield_successive_args([1, 'Hello', nil], [3, nil, an_instance_of(Google::Apis::ServerError)], [2, 'world', nil],)
+  end
+
+  it 'should raise error if batch is empty' do
+    expect { command.execute(client) }.to raise_error(Google::Apis::BatchError)
+  end
+end

data/spec/google/apis/core/download_spec.rb

@@ -0,0 +1,103 @@
+# Copyright 2015 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/download'
+require 'google/apis/core/json_representation'
+require 'hurley/test'
+require 'tempfile'
+require 'tmpdir'
+
+RSpec.describe Google::Apis::Core::DownloadCommand do
+  include TestHelpers
+  include_context 'HTTP client'
+
+  let(:command) do
+    command = Google::Apis::Core::DownloadCommand.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 disconnects' do
+      before(:example) do
+        stub_request(:get, 'https://www.googleapis.com/zoo/animals')
+          .to_return(body: ['Hello ', Timeout::Error])
+          .to_return(body: '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 default destination' do
+    let(:dest) { nil }
+    let(:received) { command.execute(client).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 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
+end

data/spec/google/apis/core/hashable_spec.rb

@@ -0,0 +1,60 @@
+# Copyright 2015 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/hashable'
+
+RSpec.describe Google::Apis::Core::Hashable do
+  let(:child_class) do
+    Class.new do
+      include Google::Apis::Core::Hashable
+      attr_accessor :value
+    end
+  end
+
+  let(:model_class) do
+    Class.new do
+      include Google::Apis::Core::Hashable
+      attr_accessor :value
+      attr_accessor :value2
+      attr_accessor :children
+    end
+  end
+
+  let(:model) do
+    obj = model_class.new
+    obj.value = 'hello'
+    obj.value2 = {
+      a: 'a'
+    }
+    child = child_class.new
+    child.value = 'goodbye'
+    obj.children = [child]
+    obj
+  end
+
+  let(:hash) { model.to_h }
+
+  it 'should serialize attributes' do
+    expect(hash).to include(value: 'hello')
+  end
+
+  it 'should serialize collections' do
+    expect(hash).to include(children: [{ value: 'goodbye' }])
+  end
+
+  it 'should serialize hashes' do
+    expect(hash[:value2]).to include(a: 'a')
+  end
+end

data/spec/google/apis/core/http_command_spec.rb

@@ -0,0 +1,303 @@
+# Copyright 2015 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/http_command'
+require 'hurley/test'
+
+RSpec.describe Google::Apis::Core::HttpCommand do
+  include TestHelpers
+  include_context 'HTTP client'
+
+  context('with credentials') do
+    let(:command) do
+      command = Google::Apis::Core::HttpCommand.new(:get, 'https://www.googleapis.com/zoo/animals')
+      command.options.authorization = authorization
+      command
+    end
+
+    context('that are refreshable') do
+      let(:authorization) do
+        calls = 0
+        auth =  object_double(Signet::OAuth2::Client.new)
+        allow(auth).to receive(:apply!) do |header|
+          header['Authorization'] = sprintf('Bearer a_token_value_%d', calls)
+          calls += 1
+        end
+        auth
+      end
+
+      it 'should send credentials' do
+        stub_request(:get, 'https://www.googleapis.com/zoo/animals').to_return(body: %(Hello world))
+        result = command.execute(client)
+        expect(a_request(:get, 'https://www.googleapis.com/zoo/animals')
+          .with { |req| req.headers['Authorization'] == 'Bearer a_token_value_0' }).to have_been_made
+      end
+
+      context('with authorizaton error') do
+        before(:example) do
+          stub_request(:get, 'https://www.googleapis.com/zoo/animals')
+            .to_return(status: [401, 'Unauthorized'])
+            .to_return(body: %(Hello world))
+        end
+
+        it 'should refresh if auth error received' do
+          result = command.execute(client)
+          expect(a_request(:get, 'https://www.googleapis.com/zoo/animals')
+            .with { |req| req.headers['Authorization'] == 'Bearer a_token_value_1' }).to have_been_made
+        end
+
+        it 'should ignore retry count' do
+          command.options.retries = 0
+          result = command.execute(client)
+          expect(a_request(:get, 'https://www.googleapis.com/zoo/animals')
+            .with { |req| req.headers['Authorization'] == 'Bearer a_token_value_1' }).to have_been_made
+        end
+      end
+    end
+
+    context('that are bare tokens`') do
+      let(:authorization) { 'a_token_value' }
+
+      it 'should send credentials' do
+        stub_request(:get, 'https://www.googleapis.com/zoo/animals').to_return(body: %(Hello world))
+        result = command.execute(client)
+        expect(a_request(:get, 'https://www.googleapis.com/zoo/animals')
+          .with { |req| expect(req.headers['Authorization']).to eql 'Bearer a_token_value' }).to have_been_made
+      end
+
+      it 'should send not refresh' do
+        stub_request(:get, 'https://www.googleapis.com/zoo/animals').to_return(status: [401, 'Unauthorized'])
+        expect { command.execute(client) }.to raise_error(Google::Apis::AuthorizationError)
+      end
+    end
+  end
+
+  context('with a successful response') do
+    let(:command) do
+      Google::Apis::Core::HttpCommand.new(:get, 'https://www.googleapis.com/zoo/animals')
+    end
+
+    before(:example) do
+      stub_request(:get, 'https://www.googleapis.com/zoo/animals').to_return(body: %(Hello world))
+    end
+
+    it 'should return the response body if block not present' do
+      result = command.execute(client)
+      expect(result).to eql 'Hello world'
+    end
+
+    it 'should call block if present' do
+      expect { |b| command.execute(client, &b) }.to yield_with_args('Hello world', nil)
+    end
+  end
+
+  context('with server errors') do
+    let(:command) do
+      Google::Apis::Core::HttpCommand.new(:get, 'https://www.googleapis.com/zoo/animals')
+    end
+
+    before(:example) do
+      stub_request(:get, 'https://www.googleapis.com/zoo/animals')
+        .to_return(status: [500, 'Server error']).times(2)
+        .to_return(body: %(Hello world))
+    end
+
+    it 'should return the response body' do
+      result = command.execute(client)
+      expect(result).to eql 'Hello world'
+    end
+
+    it 'should raise error if retries exceeded' do
+      command.options.retries = 1
+      expect { command.execute(client) }.to raise_error(Google::Apis::ServerError)
+    end
+
+
+    context('with retries exceeded') do
+      before(:example) do
+        command.options.retries = 1
+      end
+
+      let(:err) do
+        begin
+          command.execute(client)
+        rescue Google::Apis::Error => e
+          e
+        end
+      end
+
+      it 'should raise error with HTTP status code' do
+        expect(err.status_code).to eq 500
+      end
+
+    end
+
+    context('with callbacks') do
+      it 'should return the response body after retries' do
+        expect { |b| command.execute(client, &b) }.to yield_with_args('Hello world', nil)
+      end
+    end
+  end
+
+  context('with options') do
+    let(:command) do
+      command = Google::Apis::Core::HttpCommand.new(:get, 'https://www.googleapis.com/zoo/animals')
+      command.options.header = { 'X-Foo' => 'bar' }
+      command
+    end
+
+    before(:example) do
+      stub_request(:get, 'https://www.googleapis.com/zoo/animals')
+        .to_return(body: %(Hello world))
+    end
+
+    it 'should send user headers' do
+      result = command.execute(client)
+      expect(a_request(:get, 'https://www.googleapis.com/zoo/animals')
+        .with { |req| req.headers['X-Foo'] == 'bar' }).to have_been_made
+    end
+  end
+
+
+  context('with redirects') do
+    let(:command) do
+      Google::Apis::Core::HttpCommand.new(:get, 'https://www.googleapis.com/zoo/animals')
+    end
+
+    before(:example) do
+      stub_request(:get, 'https://www.googleapis.com/zoo/animals')
+        .to_return(status: [302, 'Redirect'], headers: { 'Location' => 'https://zoo.googleapis.com/animals' })
+      stub_request(:get, 'https://zoo.googleapis.com/animals')
+        .to_return(body: %(Hello world))
+    end
+
+    it 'should return the response body' do
+      result = command.execute(client)
+      expect(result).to eql 'Hello world'
+    end
+  end
+
+  context('with too many redirects') do
+    let(:command) do
+      Google::Apis::Core::HttpCommand.new(:get, 'https://www.googleapis.com/zoo/animals')
+    end
+
+    before(:example) do
+      stub_request(:get, 'https://www.googleapis.com/zoo/animals')
+        .to_return(status: [302, 'Redirect'], headers: { 'Location' => 'https://www.googleapis.com/zoo/animals' }).times(6)
+    end
+
+    it 'should raise error if retries exceeded' do
+      expect { command.execute(client) }.to raise_error(Google::Apis::RedirectError)
+    end
+  end
+
+  context('with no server response') do
+    let(:command) do
+      Google::Apis::Core::HttpCommand.new(:get, 'https://www.googleapis.com/zoo/animals')
+    end
+
+    before(:example) do
+      stub_request(:get, 'https://www.googleapis.com/zoo/animals').to_timeout
+    end
+
+    it 'should raise transmission error' do
+      expect { command.execute(client) }.to raise_error(Google::Apis::TransmissionError)
+    end
+  end
+
+  context('with invalid status code') do
+    let(:command) do
+      Google::Apis::Core::HttpCommand.new(:get, 'https://www.googleapis.com/zoo/animals')
+    end
+
+    before(:example) do
+      stub_request(:get, 'https://www.googleapis.com/zoo/animals')
+        .to_return(status: [0, 'Wat!?'])
+    end
+
+    it 'should raise transmission error' do
+      expect { command.execute(client) }.to raise_error(Google::Apis::TransmissionError)
+    end
+  end
+
+  context('with client errors') do
+    let(:command) do
+      Google::Apis::Core::HttpCommand.new(:get, 'https://www.googleapis.com/zoo/animals')
+    end
+
+    before(:example) do
+      stub_request(:get, 'https://www.googleapis.com/zoo/animals')
+        .to_return(status: [400, 'Invalid request'])
+    end
+
+    it 'should raise error without retry' do
+      command.options.retries = 1
+      expect { command.execute(client) }.to raise_error(Google::Apis::ClientError)
+    end
+
+    it 'should call block if present' do
+      expect { |b| command.execute(client, &b) }.to yield_with_args(nil, an_instance_of(Google::Apis::ClientError))
+    end
+
+    it 'should not swallow errors raised in block' do
+      expect { command.execute(client) { raise "Potatoes detected in tailpipe" } }.to raise_error("Potatoes detected in tailpipe")
+    end
+  end
+
+  it 'should send repeated query parameters' do
+    stub_request(:get, 'https://www.googleapis.com/zoo/animals?a=1&a=2&a=3')
+      .to_return(status: [200, ''])
+    command = Google::Apis::Core::HttpCommand.new(:get, 'https://www.googleapis.com/zoo/animals')
+    command.query['a'] = [1,2,3]
+    command.execute(client)
+  end
+
+  it 'should not remove initial query parameters' do
+    stub_request(:get, 'https://www.googleapis.com/zoo/animals?a=1&a=2&a=3&foo=bar')
+      .to_return(status: [200, ''])
+    command = Google::Apis::Core::HttpCommand.new(:get, 'https://www.googleapis.com/zoo/animals?foo=bar')
+    command.query['a'] = [1,2,3]
+    command.execute(client)
+  end
+
+  it 'should send falsey query parameters' do
+    stub_request(:get, 'https://www.googleapis.com/zoo/animals?a=0&b=false')
+      .to_return(status: [200, ''])
+    command = Google::Apis::Core::HttpCommand.new(:get, 'https://www.googleapis.com/zoo/animals')
+    command.query['a'] = 0
+    command.query['b'] = false
+    command.execute(client)
+  end
+
+  it 'should form encode parameters when method is POST and no body present' do
+    stub_request(:post, 'https://www.googleapis.com/zoo/animals')
+        .with(body: 'a=1&a=2&a=3&b=hello&c=&d=0')
+        .to_return(status: [200, ''])
+    command = Google::Apis::Core::HttpCommand.new(:post, 'https://www.googleapis.com/zoo/animals')
+    command.query['a'] = [1,2,3]
+    command.query['b'] = 'hello'
+    command.query['c'] = nil
+    command.query['d'] = 0
+    command.execute(client)
+  end
+
+  it 'should raise transmission error instead of socket error' do
+    stub_request(:get, 'https://www.googleapis.com/zoo/animals').to_raise(SocketError)
+    command = Google::Apis::Core::HttpCommand.new(:get, 'https://www.googleapis.com/zoo/animals')
+    command.options.retries = 0
+    expect { command.execute(client) }.to raise_error(Google::Apis::TransmissionError)
+  end
+end