X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/e5e0118b5048dc99265a41419de1c98a6ebad586..03fca7b8d10857c306ac18ad61faf312c32e7fcb:/spec/google/api_client_spec.rb diff --git a/spec/google/api_client_spec.rb b/spec/google/api_client_spec.rb index 856731254f..4944bb958c 100644 --- a/spec/google/api_client_spec.rb +++ b/spec/google/api_client_spec.rb @@ -14,85 +14,85 @@ require 'spec_helper' -gem 'faraday', '~> 0.8.1' require 'faraday' -require 'faraday/utils' - -gem 'signet', '~> 0.4.0' require 'signet/oauth_1/client' - require 'google/api_client' -require 'google/api_client/version' shared_examples_for 'configurable user agent' do + include ConnectionHelpers + it 'should allow the user agent to be modified' do client.user_agent = 'Custom User Agent/1.2.3' - client.user_agent.should == 'Custom User Agent/1.2.3' + expect(client.user_agent).to eq('Custom User Agent/1.2.3') end it 'should allow the user agent to be set to nil' do client.user_agent = nil - client.user_agent.should == nil + expect(client.user_agent).to eq(nil) end it 'should not allow the user agent to be used with bogus values' do - (lambda do + expect(lambda do client.user_agent = 42 - client.transmit( - ['GET', 'http://www.google.com/', [], []] - ) - end).should raise_error(TypeError) + client.execute(:uri=>'https://www.google.com/') + end).to raise_error(TypeError) end it 'should transmit a User-Agent header when sending requests' do client.user_agent = 'Custom User Agent/1.2.3' - request = Faraday::Request.new(:get) do |req| - req.url('http://www.google.com/') - end - stubs = Faraday::Adapter::Test::Stubs.new do |stub| + + conn = stub_connection do |stub| stub.get('/') do |env| headers = env[:request_headers] - headers.should have_key('User-Agent') - headers['User-Agent'].should == client.user_agent + expect(headers).to have_key('User-Agent') + expect(headers['User-Agent']).to eq(client.user_agent) [200, {}, ['']] end end - connection = Faraday.new(:url => 'https://www.google.com') do |builder| - builder.adapter(:test, stubs) - end - client.transmit(:request => request, :connection => connection) - stubs.verify_stubbed_calls + client.execute(:uri=>'https://www.google.com/', :connection => conn) + conn.verify end end describe Google::APIClient do - let(:client) { Google::APIClient.new } + include ConnectionHelpers + + let(:client) { Google::APIClient.new(:application_name => 'API Client Tests') } it 'should make its version number available' do - Google::APIClient::VERSION::STRING.should be_instance_of(String) + expect(Google::APIClient::VERSION::STRING).to be_instance_of(String) end it 'should default to OAuth 2' do - Signet::OAuth2::Client.should === client.authorization + expect(Signet::OAuth2::Client).to be === client.authorization end - it_should_behave_like 'configurable user agent' - + describe 'configure for no authentication' do + before do + client.authorization = nil + end + it_should_behave_like 'configurable user agent' + end + describe 'configured for OAuth 1' do before do client.authorization = :oauth_1 + client.authorization.token_credential_key = 'abc' + client.authorization.token_credential_secret = '123' end it 'should use the default OAuth1 client configuration' do - client.authorization.temporary_credential_uri.to_s.should == + expect(client.authorization.temporary_credential_uri.to_s).to eq( 'https://www.google.com/accounts/OAuthGetRequestToken' - client.authorization.authorization_uri.to_s.should include( + ) + expect(client.authorization.authorization_uri.to_s).to include( 'https://www.google.com/accounts/OAuthAuthorizeToken' ) - client.authorization.token_credential_uri.to_s.should == + expect(client.authorization.token_credential_uri.to_s).to eq( 'https://www.google.com/accounts/OAuthGetAccessToken' - client.authorization.client_credential_key.should == 'anonymous' - client.authorization.client_credential_secret.should == 'anonymous' + ) + expect(client.authorization.client_credential_key).to eq('anonymous') + expect(client.authorization.client_credential_secret).to eq('anonymous') end it_should_behave_like 'configurable user agent' @@ -101,6 +101,7 @@ describe Google::APIClient do describe 'configured for OAuth 2' do before do client.authorization = :oauth_2 + client.authorization.access_token = '12345' end # TODO @@ -109,31 +110,179 @@ describe Google::APIClient do describe 'when executing requests' do before do + @prediction = client.discovered_api('prediction', 'v1.2') client.authorization = :oauth_2 - @connection = Faraday.new(:url => 'https://www.googleapis.com') do |builder| - stubs = Faraday::Adapter::Test::Stubs.new do |stub| - stub.get('/test') do |env| - env[:request_headers]['Authorization'].should == 'Bearer 12345' - end + @connection = stub_connection do |stub| + stub.post('/prediction/v1.2/training?data=12345') do |env| + expect(env[:request_headers]['Authorization']).to eq('Bearer 12345') + [200, {}, '{}'] end - builder.adapter(:test, stubs) end end - + + after do + @connection.verify + end + it 'should use default authorization' do client.authorization.access_token = "12345" - client.execute(:http_method => :get, - :uri => 'https://www.googleapis.com/test', - :connection => @connection) + client.execute( + :api_method => @prediction.training.insert, + :parameters => {'data' => '12345'}, + :connection => @connection + ) end it 'should use request scoped authorization when provided' do client.authorization.access_token = "abcdef" new_auth = Signet::OAuth2::Client.new(:access_token => '12345') - client.execute(:http_method => :get, - :uri => 'https://www.googleapis.com/test', - :connection => @connection, - :authorization => new_auth) + client.execute( + :api_method => @prediction.training.insert, + :parameters => {'data' => '12345'}, + :authorization => new_auth, + :connection => @connection + ) + end + + it 'should accept options with batch/request style execute' do + client.authorization.access_token = "abcdef" + new_auth = Signet::OAuth2::Client.new(:access_token => '12345') + request = client.generate_request( + :api_method => @prediction.training.insert, + :parameters => {'data' => '12345'} + ) + client.execute( + request, + :authorization => new_auth, + :connection => @connection + ) + end + + + it 'should accept options in array style execute' do + client.authorization.access_token = "abcdef" + new_auth = Signet::OAuth2::Client.new(:access_token => '12345') + client.execute( + @prediction.training.insert, {'data' => '12345'}, '', {}, + { :authorization => new_auth, :connection => @connection } + ) + end + end + + describe 'when retries enabled' do + before do + client.retries = 2 + end + + after do + @connection.verify + end + + it 'should follow redirects' do + client.authorization = nil + @connection = stub_connection do |stub| + stub.get('/foo') do |env| + [302, {'location' => 'https://www.google.com/bar'}, '{}'] + end + stub.get('/bar') do |env| + [200, {}, '{}'] + end + end + + client.execute( + :uri => 'https://www.gogole.com/foo', + :connection => @connection + ) end + + it 'should refresh tokens on 401 tokens' do + client.authorization.access_token = '12345' + expect(client.authorization).to receive(:fetch_access_token!) + + @connection = stub_connection do |stub| + stub.get('/foo') do |env| + [401, {}, '{}'] + end + stub.get('/foo') do |env| + [200, {}, '{}'] + end + end + + client.execute( + :uri => 'https://www.gogole.com/foo', + :connection => @connection + ) + end + + + it 'should not attempt multiple token refreshes' do + client.authorization.access_token = '12345' + expect(client.authorization).to receive(:fetch_access_token!).once + + @connection = stub_connection do |stub| + stub.get('/foo') do |env| + [401, {}, '{}'] + end + end + + client.execute( + :uri => 'https://www.gogole.com/foo', + :connection => @connection + ) + end + + it 'should not retry on client errors' do + count = 0 + @connection = stub_connection do |stub| + stub.get('/foo') do |env| + expect(count).to eq(0) + count += 1 + [403, {}, '{}'] + end + end + + client.execute( + :uri => 'https://www.gogole.com/foo', + :connection => @connection, + :authenticated => false + ) + end + + it 'should retry on 500 errors' do + client.authorization = nil + + @connection = stub_connection do |stub| + stub.get('/foo') do |env| + [500, {}, '{}'] + end + stub.get('/foo') do |env| + [200, {}, '{}'] + end + end + + expect(client.execute( + :uri => 'https://www.gogole.com/foo', + :connection => @connection + ).status).to eq(200) + + end + + it 'should fail after max retries' do + client.authorization = nil + count = 0 + @connection = stub_connection do |stub| + stub.get('/foo') do |env| + count += 1 + [500, {}, '{}'] + end + end + + expect(client.execute( + :uri => 'https://www.gogole.com/foo', + :connection => @connection + ).status).to eq(500) + expect(count).to eq(3) + end + end end