require 'spec_helper'
require 'faraday'
-require 'faraday/utils'
require 'multi_json'
require 'compat/multi_json'
require 'signet/oauth_1/client'
require 'google/api_client'
-require 'google/api_client/version'
-
-def TestHandler
- def initialize(&block)
- @block = block
- end
-
- def call(env)
- @block.call(env)
- end
-end
-
-def mock_connection(&block)
- connection = Faraday.new do |builder|
- use TestHandler block
- end
-end
describe Google::APIClient do
include ConnectionHelpers
- CLIENT ||= Google::APIClient.new
+ CLIENT = Google::APIClient.new(:application_name => 'API Client Tests') unless defined?(CLIENT)
after do
# Reset client to not-quite-pristine state
end
it 'should raise a type error for bogus authorization' do
- (lambda do
- Google::APIClient.new(:authorization => 42)
- end).should raise_error(TypeError)
+ expect(lambda do
+ Google::APIClient.new(:application_name => 'API Client Tests', :authorization => 42)
+ end).to raise_error(TypeError)
end
it 'should not be able to retrieve the discovery document for a bogus API' do
- (lambda do
+ expect(lambda do
CLIENT.discovery_document('bogus')
- end).should raise_error(Google::APIClient::TransmissionError)
- (lambda do
+ end).to raise_error(Google::APIClient::TransmissionError)
+ expect(lambda do
CLIENT.discovered_api('bogus')
- end).should raise_error(Google::APIClient::TransmissionError)
+ end).to raise_error(Google::APIClient::TransmissionError)
end
it 'should raise an error for bogus services' do
- (lambda do
+ expect(lambda do
CLIENT.discovered_api(42)
- end).should raise_error(TypeError)
+ end).to raise_error(TypeError)
end
it 'should raise an error for bogus services' do
- (lambda do
+ expect(lambda do
CLIENT.preferred_version(42)
- end).should raise_error(TypeError)
+ end).to raise_error(TypeError)
end
it 'should raise an error for bogus methods' do
- (lambda do
+ expect(lambda do
CLIENT.execute(42)
- end).should raise_error(TypeError)
+ end).to raise_error(TypeError)
end
it 'should not return a preferred version for bogus service names' do
- CLIENT.preferred_version('bogus').should == nil
+ expect(CLIENT.preferred_version('bogus')).to eq(nil)
end
describe 'with the prediction API' do
end
it 'should correctly determine the discovery URI' do
- CLIENT.discovery_uri('prediction').should ===
+ expect(CLIENT.discovery_uri('prediction')).to be ===
'https://www.googleapis.com/discovery/v1/apis/prediction/v1/rest'
end
it 'should correctly determine the discovery URI if :user_ip is set' do
CLIENT.user_ip = '127.0.0.1'
-
+
conn = stub_connection do |stub|
stub.get('/discovery/v1/apis/prediction/v1.2/rest?userIp=127.0.0.1') do |env|
+ [200, {}, '{}']
end
end
CLIENT.execute(
CLIENT.key = 'qwerty'
conn = stub_connection do |stub|
stub.get('/discovery/v1/apis/prediction/v1.2/rest?key=qwerty') do |env|
+ [200, {}, '{}']
end
end
request = CLIENT.execute(
CLIENT.user_ip = '127.0.0.1'
conn = stub_connection do |stub|
stub.get('/discovery/v1/apis/prediction/v1.2/rest?key=qwerty&userIp=127.0.0.1') do |env|
+ [200, {}, '{}']
end
end
request = CLIENT.execute(
end
it 'should correctly generate API objects' do
- CLIENT.discovered_api('prediction', 'v1.2').name.should == 'prediction'
- CLIENT.discovered_api('prediction', 'v1.2').version.should == 'v1.2'
- CLIENT.discovered_api(:prediction, 'v1.2').name.should == 'prediction'
- CLIENT.discovered_api(:prediction, 'v1.2').version.should == 'v1.2'
+ expect(CLIENT.discovered_api('prediction', 'v1.2').name).to eq('prediction')
+ expect(CLIENT.discovered_api('prediction', 'v1.2').version).to eq('v1.2')
+ expect(CLIENT.discovered_api(:prediction, 'v1.2').name).to eq('prediction')
+ expect(CLIENT.discovered_api(:prediction, 'v1.2').version).to eq('v1.2')
end
it 'should discover methods' do
- CLIENT.discovered_method(
+ expect(CLIENT.discovered_method(
'prediction.training.insert', 'prediction', 'v1.2'
- ).name.should == 'insert'
- CLIENT.discovered_method(
+ ).name).to eq('insert')
+ expect(CLIENT.discovered_method(
:'prediction.training.insert', :prediction, 'v1.2'
- ).name.should == 'insert'
- CLIENT.discovered_method(
+ ).name).to eq('insert')
+ expect(CLIENT.discovered_method(
'prediction.training.delete', 'prediction', 'v1.2'
- ).name.should == 'delete'
+ ).name).to eq('delete')
end
it 'should define the origin API in discovered methods' do
- CLIENT.discovered_method(
+ expect(CLIENT.discovered_method(
'prediction.training.insert', 'prediction', 'v1.2'
- ).api.name.should == 'prediction'
+ ).api.name).to eq('prediction')
end
it 'should not find methods that are not in the discovery document' do
- CLIENT.discovered_method(
+ expect(CLIENT.discovered_method(
'prediction.bogus', 'prediction', 'v1.2'
- ).should == nil
+ )).to eq(nil)
end
it 'should raise an error for bogus methods' do
- (lambda do
+ expect(lambda do
CLIENT.discovered_method(42, 'prediction', 'v1.2')
- end).should raise_error(TypeError)
+ end).to raise_error(TypeError)
end
it 'should raise an error for bogus methods' do
- (lambda do
+ expect(lambda do
CLIENT.execute(:api_method => CLIENT.discovered_api('prediction', 'v1.2'))
- end).should raise_error(TypeError)
+ end).to raise_error(TypeError)
end
it 'should correctly determine the preferred version' do
- CLIENT.preferred_version('prediction').version.should_not == 'v1'
- CLIENT.preferred_version(:prediction).version.should_not == 'v1'
+ expect(CLIENT.preferred_version('prediction').version).not_to eq('v1')
+ expect(CLIENT.preferred_version(:prediction).version).not_to eq('v1')
end
it 'should return a batch path' do
- CLIENT.discovered_api('prediction', 'v1.2').batch_path.should_not be_nil
+ expect(CLIENT.discovered_api('prediction', 'v1.2').batch_path).not_to be_nil
end
it 'should generate valid requests' do
conn = stub_connection do |stub|
stub.post('/prediction/v1.2/training?data=12345') do |env|
- env[:body].should == ''
+ expect(env[:body]).to eq('')
+ [200, {}, '{}']
end
end
request = CLIENT.execute(
conn.verify
end
- it 'should generate valid requests when repeated parameters are passed' do
+ it 'should generate valid requests when parameter value includes semicolon' do
+ conn = stub_connection do |stub|
+ # semicolon (;) in parameter value was being converted to
+ # bare ampersand (&) in 0.4.7. ensure that it gets converted
+ # to a CGI-escaped semicolon (%3B) instead.
+ stub.post('/prediction/v1.2/training?data=12345%3B67890') do |env|
+ expect(env[:body]).to eq('')
+ [200, {}, '{}']
+ end
+ end
+ request = CLIENT.execute(
+ :api_method => @prediction.training.insert,
+ :parameters => {'data' => '12345;67890'},
+ :connection => conn
+ )
+ conn.verify
+ end
+
+ it 'should generate valid requests when multivalued parameters are passed' do
conn = stub_connection do |stub|
stub.post('/prediction/v1.2/training?data=1&data=2') do |env|
- env[:params]['data'].should include('1', '2')
+ expect(env.params['data']).to include('1', '2')
+ [200, {}, '{}']
end
end
request = CLIENT.execute(
:api_method => @prediction.training.insert,
- :parameters => [['data', '1'], ['data','2']],
+ :parameters => {'data' => ['1', '2']},
:connection => conn
)
conn.verify
it 'should generate requests against the correct URIs' do
conn = stub_connection do |stub|
stub.post('/prediction/v1.2/training?data=12345') do |env|
+ [200, {}, '{}']
end
end
request = CLIENT.execute(
it 'should generate requests against the correct URIs' do
conn = stub_connection do |stub|
stub.post('/prediction/v1.2/training?data=12345') do |env|
+ [200, {}, '{}']
end
end
request = CLIENT.execute(
it 'should allow modification to the base URIs for testing purposes' do
# Using a new client instance here to avoid caching rebased discovery doc
prediction_rebase =
- Google::APIClient.new.discovered_api('prediction', 'v1.2')
+ Google::APIClient.new(:application_name => 'API Client Tests').discovered_api('prediction', 'v1.2')
prediction_rebase.method_base =
'https://testing-domain.example.com/prediction/v1.2/'
conn = stub_connection do |stub|
stub.post('/prediction/v1.2/training') do |env|
- env[:url].host.should == 'testing-domain.example.com'
+ expect(env[:url].host).to eq('testing-domain.example.com')
+ [200, {}, '{}']
end
end
-
+
request = CLIENT.execute(
:api_method => prediction_rebase.training.insert,
:parameters => {'data' => '123'},
conn = stub_connection do |stub|
stub.post('/prediction/v1.2/training?data=12345') do |env|
- env[:request_headers].should have_key('Authorization')
- env[:request_headers]['Authorization'].should =~ /^OAuth/
+ expect(env[:request_headers]).to have_key('Authorization')
+ expect(env[:request_headers]['Authorization']).to match(/^OAuth/)
+ [200, {}, '{}']
end
end
conn = stub_connection do |stub|
stub.post('/prediction/v1.2/training?data=12345') do |env|
- env[:request_headers].should have_key('Authorization')
- env[:request_headers]['Authorization'].should =~ /^Bearer/
+ expect(env[:request_headers]).to have_key('Authorization')
+ expect(env[:request_headers]['Authorization']).to match(/^Bearer/)
+ [200, {}, '{}']
end
end
@prediction.training.insert,
{'data' => '12345'}
)
- result.response.status.should == 401
+ expect(result.response.status).to eq(401)
end
it 'should not be able to execute improperly authorized requests' do
@prediction.training.insert,
{'data' => '12345'}
)
- result.response.status.should == 401
+ expect(result.response.status).to eq(401)
end
it 'should not be able to execute improperly authorized requests' do
- (lambda do
+ expect(lambda do
CLIENT.authorization = :oauth_1
CLIENT.authorization.token_credential_key = '12345'
CLIENT.authorization.token_credential_secret = '12345'
@prediction.training.insert,
{'data' => '12345'}
)
- end).should raise_error(Google::APIClient::ClientError)
+ end).to raise_error(Google::APIClient::ClientError)
end
it 'should not be able to execute improperly authorized requests' do
- (lambda do
+ expect(lambda do
CLIENT.authorization = :oauth_2
CLIENT.authorization.access_token = '12345'
result = CLIENT.execute!(
@prediction.training.insert,
{'data' => '12345'}
)
- end).should raise_error(Google::APIClient::ClientError)
+ end).to raise_error(Google::APIClient::ClientError)
end
it 'should correctly handle unnamed parameters' do
conn = stub_connection do |stub|
stub.post('/prediction/v1.2/training') do |env|
- env[:request_headers].should have_key('Content-Type')
- env[:request_headers]['Content-Type'].should == 'application/json'
+ expect(env[:request_headers]).to have_key('Content-Type')
+ expect(env[:request_headers]['Content-Type']).to eq('application/json')
+ [200, {}, '{}']
end
end
CLIENT.authorization = :oauth_2
end
it 'should correctly determine the discovery URI' do
- CLIENT.discovery_uri('plus').should ===
+ expect(CLIENT.discovery_uri('plus')).to be ===
'https://www.googleapis.com/discovery/v1/apis/plus/v1/rest'
end
it 'should find APIs that are in the discovery document' do
- CLIENT.discovered_api('plus').name.should == 'plus'
- CLIENT.discovered_api('plus').version.should == 'v1'
- CLIENT.discovered_api(:plus).name.should == 'plus'
- CLIENT.discovered_api(:plus).version.should == 'v1'
+ expect(CLIENT.discovered_api('plus').name).to eq('plus')
+ expect(CLIENT.discovered_api('plus').version).to eq('v1')
+ expect(CLIENT.discovered_api(:plus).name).to eq('plus')
+ expect(CLIENT.discovered_api(:plus).version).to eq('v1')
end
it 'should find methods that are in the discovery document' do
# TODO(bobaman) Fix this when the RPC names are correct
- CLIENT.discovered_method(
+ expect(CLIENT.discovered_method(
'plus.activities.list', 'plus'
- ).name.should == 'list'
+ ).name).to eq('list')
end
it 'should define the origin API in discovered methods' do
- CLIENT.discovered_method(
+ expect(CLIENT.discovered_method(
'plus.activities.list', 'plus'
- ).api.name.should == 'plus'
+ ).api.name).to eq('plus')
end
it 'should not find methods that are not in the discovery document' do
- CLIENT.discovered_method('plus.bogus', 'plus').should == nil
+ expect(CLIENT.discovered_method('plus.bogus', 'plus')).to eq(nil)
end
it 'should generate requests against the correct URIs' do
conn = stub_connection do |stub|
- stub.get('/plus/v1/people/107807692475771887386/activities/public' +
- '?collection=public&userId=107807692475771887386') do |env|
+ stub.get('/plus/v1/people/107807692475771887386/activities/public') do |env|
+ [200, {}, '{}']
end
end
-
+
request = CLIENT.execute(
:api_method => @plus.activities.list,
:parameters => {
end
it 'should correctly validate parameters' do
- (lambda do
+ expect(lambda do
CLIENT.execute(
:api_method => @plus.activities.list,
:parameters => {'alt' => 'json'},
:authenticated => false
)
- end).should raise_error(ArgumentError)
+ end).to raise_error(ArgumentError)
end
it 'should correctly validate parameters' do
- (lambda do
+ expect(lambda do
CLIENT.execute(
:api_method => @plus.activities.list,
:parameters => {
'userId' => '107807692475771887386', 'collection' => 'bogus'
},
:authenticated => false
- ).to_env(Faraday.default_connection)
- end).should raise_error(ArgumentError)
- end
- end
-
-=begin
- describe 'with the latitude API' do
- before do
- CLIENT.authorization = nil
- @latitude = CLIENT.discovered_api('latitude')
- end
-
- it 'should correctly determine the discovery URI' do
- CLIENT.discovery_uri('latitude').should ===
- 'https://www.googleapis.com/discovery/v1/apis/latitude/v1/rest'
- end
-
- it 'should find APIs that are in the discovery document' do
- CLIENT.discovered_api('latitude').name.should == 'latitude'
- CLIENT.discovered_api('latitude').version.should == 'v1'
- end
-
- it 'should return a batch path' do
- CLIENT.discovered_api('latitude').batch_path.should_not be_nil
- end
-
- it 'should find methods that are in the discovery document' do
- CLIENT.discovered_method(
- 'latitude.currentLocation.get', 'latitude'
- ).name.should == 'get'
- end
-
- it 'should define the origin API in discovered methods' do
- CLIENT.discovered_method(
- 'latitude.currentLocation.get', 'latitude'
- ).api.name.should == 'latitude'
- end
-
- it 'should not find methods that are not in the discovery document' do
- CLIENT.discovered_method('latitude.bogus', 'latitude').should == nil
- end
-
- it 'should generate requests against the correct URIs' do
- request = CLIENT.generate_request(
- :api_method => 'latitude.currentLocation.get',
- :authenticated => false
- )
- request.to_env(Faraday.default_connection)[:url].to_s.should ===
- 'https://www.googleapis.com/latitude/v1/currentLocation'
- end
-
- it 'should generate requests against the correct URIs' do
- request = CLIENT.generate_request(
- :api_method => @latitude.current_location.get,
- :authenticated => false
- )
- request.to_env(Faraday.default_connection)[:url].to_s.should ===
- 'https://www.googleapis.com/latitude/v1/currentLocation'
- end
-
- it 'should not be able to execute requests without authorization' do
- result = CLIENT.execute(
- :api_method => 'latitude.currentLocation.get',
- :authenticated => false
- )
- result.response.status.should == 401
- end
- end
-=end
-
- describe 'with the moderator API' do
- before do
- CLIENT.authorization = nil
- @moderator = CLIENT.discovered_api('moderator')
- end
-
- it 'should correctly determine the discovery URI' do
- CLIENT.discovery_uri('moderator').should ===
- 'https://www.googleapis.com/discovery/v1/apis/moderator/v1/rest'
- end
-
- it 'should find APIs that are in the discovery document' do
- CLIENT.discovered_api('moderator').name.should == 'moderator'
- CLIENT.discovered_api('moderator').version.should == 'v1'
- end
-
- it 'should find methods that are in the discovery document' do
- CLIENT.discovered_method(
- 'moderator.profiles.get', 'moderator'
- ).name.should == 'get'
- end
-
- it 'should define the origin API in discovered methods' do
- CLIENT.discovered_method(
- 'moderator.profiles.get', 'moderator'
- ).api.name.should == 'moderator'
- end
-
- it 'should not find methods that are not in the discovery document' do
- CLIENT.discovered_method('moderator.bogus', 'moderator').should == nil
- end
-
- it 'should return a batch path' do
- CLIENT.discovered_api('moderator').batch_path.should_not be_nil
- end
-
- it 'should generate requests against the correct URIs' do
- conn = stub_connection do |stub|
- stub.get('/moderator/v1/profiles/@me') do |env|
- end
- end
- request = CLIENT.execute(
- :api_method => @moderator.profiles.get,
- :authenticated => false,
- :connection => conn
- )
- conn.verify
- end
-
- it 'should not be able to execute requests without authorization' do
- result = CLIENT.execute(
- @moderator.profiles.get,
- {},
- '',
- [],
- {:authenticated => false}
- )
- result.response.status.should == 401
+ ).to_env(CLIENT.connection)
+ end).to raise_error(ArgumentError)
end
end
describe 'with the adsense API' do
before do
CLIENT.authorization = nil
- @adsense = CLIENT.discovered_api('adsense', 'v1')
+ @adsense = CLIENT.discovered_api('adsense', 'v1.3')
end
it 'should correctly determine the discovery URI' do
- CLIENT.discovery_uri('adsense').should ===
- 'https://www.googleapis.com/discovery/v1/apis/adsense/v1/rest'
+ expect(CLIENT.discovery_uri('adsense', 'v1.3').to_s).to be ===
+ 'https://www.googleapis.com/discovery/v1/apis/adsense/v1.3/rest'
end
it 'should find APIs that are in the discovery document' do
- CLIENT.discovered_api('adsense').name.should == 'adsense'
- CLIENT.discovered_api('adsense').version.should == 'v1'
+ expect(CLIENT.discovered_api('adsense', 'v1.3').name).to eq('adsense')
+ expect(CLIENT.discovered_api('adsense', 'v1.3').version).to eq('v1.3')
end
it 'should return a batch path' do
- CLIENT.discovered_api('adsense').batch_path.should_not be_nil
+ expect(CLIENT.discovered_api('adsense', 'v1.3').batch_path).not_to be_nil
end
it 'should find methods that are in the discovery document' do
- CLIENT.discovered_method(
- 'adsense.reports.generate', 'adsense'
- ).name.should == 'generate'
+ expect(CLIENT.discovered_method(
+ 'adsense.reports.generate', 'adsense', 'v1.3'
+ ).name).to eq('generate')
end
it 'should not find methods that are not in the discovery document' do
- CLIENT.discovered_method('adsense.bogus', 'adsense').should == nil
+ expect(CLIENT.discovered_method('adsense.bogus', 'adsense', 'v1.3')).to eq(nil)
end
it 'should generate requests against the correct URIs' do
conn = stub_connection do |stub|
- stub.get('/adsense/v1/adclients') do |env|
+ stub.get('/adsense/v1.3/adclients') do |env|
+ [200, {}, '{}']
end
end
request = CLIENT.execute(
:api_method => @adsense.adclients.list,
:authenticated => false
)
- result.response.status.should == 401
+ expect(result.response.status).to eq(401)
end
it 'should fail when validating missing required parameters' do
- (lambda do
+ expect(lambda do
CLIENT.execute(
:api_method => @adsense.reports.generate,
:authenticated => false
)
- end).should raise_error(ArgumentError)
+ end).to raise_error(ArgumentError)
end
it 'should succeed when validating parameters in a correct call' do
conn = stub_connection do |stub|
- stub.get('/adsense/v1/reports?dimension=DATE&endDate=2010-01-01&metric=PAGE_VIEWS&startDate=2000-01-01') do |env|
+ stub.get('/adsense/v1.3/reports?dimension=DATE&endDate=2010-01-01&metric=PAGE_VIEWS&startDate=2000-01-01') do |env|
+ [200, {}, '{}']
end
end
- (lambda do
+ expect(lambda do
CLIENT.execute(
:api_method => @adsense.reports.generate,
:parameters => {
:authenticated => false,
:connection => conn
)
- end).should_not raise_error
+ end).not_to raise_error
conn.verify
end
it 'should fail when validating parameters with invalid values' do
- (lambda do
+ expect(lambda do
CLIENT.execute(
:api_method => @adsense.reports.generate,
:parameters => {
},
:authenticated => false
)
- end).should raise_error(ArgumentError)
+ end).to raise_error(ArgumentError)
end
it 'should succeed when validating repeated parameters in a correct call' do
conn = stub_connection do |stub|
- stub.get('/adsense/v1/reports?dimension%5B%5D=DATE&dimension%5B%5D=PRODUCT_CODE'+
- '&endDate=2010-01-01&metric%5B%5D=CLICKS&metric%5B%5D=PAGE_VIEWS&'+
+ stub.get('/adsense/v1.3/reports?dimension=DATE&dimension=PRODUCT_CODE'+
+ '&endDate=2010-01-01&metric=CLICKS&metric=PAGE_VIEWS&'+
'startDate=2000-01-01') do |env|
+ [200, {}, '{}']
end
end
- (lambda do
+ expect(lambda do
CLIENT.execute(
:api_method => @adsense.reports.generate,
:parameters => {
:authenticated => false,
:connection => conn
)
- end).should_not raise_error
+ end).not_to raise_error
conn.verify
end
it 'should fail when validating incorrect repeated parameters' do
- (lambda do
+ expect(lambda do
CLIENT.execute(
:api_method => @adsense.reports.generate,
:parameters => {
},
:authenticated => false
)
- end).should raise_error(ArgumentError)
+ end).to raise_error(ArgumentError)
+ end
+
+ it 'should generate valid requests when multivalued parameters are passed' do
+ conn = stub_connection do |stub|
+ stub.get('/adsense/v1.3/reports?dimension=DATE&dimension=PRODUCT_CODE'+
+ '&endDate=2010-01-01&metric=CLICKS&metric=PAGE_VIEWS&'+
+ 'startDate=2000-01-01') do |env|
+ expect(env.params['dimension']).to include('DATE', 'PRODUCT_CODE')
+ expect(env.params['metric']).to include('CLICKS', 'PAGE_VIEWS')
+ [200, {}, '{}']
+ end
+ end
+ request = CLIENT.execute(
+ :api_method => @adsense.reports.generate,
+ :parameters => {
+ 'startDate' => '2000-01-01',
+ 'endDate' => '2010-01-01',
+ 'dimension' => ['DATE', 'PRODUCT_CODE'],
+ 'metric' => ['PAGE_VIEWS', 'CLICKS']
+ },
+ :authenticated => false,
+ :connection => conn
+ )
+ conn.verify
end
end
end
it 'should include media upload info methods' do
- @drive.files.insert.media_upload.should_not == nil
+ expect(@drive.files.insert.media_upload).not_to eq(nil)
end
it 'should include accepted media types' do
- @drive.files.insert.media_upload.accepted_types.should_not be_empty
+ expect(@drive.files.insert.media_upload.accepted_types).not_to be_empty
end
it 'should have an upload path' do
- @drive.files.insert.media_upload.uri_template.should_not == nil
+ expect(@drive.files.insert.media_upload.uri_template).not_to eq(nil)
end
it 'should have a max file size' do
- @drive.files.insert.media_upload.max_size.should_not == nil
+ expect(@drive.files.insert.media_upload.max_size).not_to eq(nil)
end
end
end
projects / arvados.git / blobdiff