+# encoding:utf-8
+
# Copyright 2010 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# See the License for the specific language governing permissions and
# limitations under the License.
+
require 'spec_helper'
+require 'faraday'
+require 'multi_json'
+require 'compat/multi_json'
require 'signet/oauth_1/client'
-require 'httpadapter/adapters/net_http'
-
require 'google/api_client'
-require 'google/api_client/version'
-require 'google/api_client/parsers/json_parser'
-
-describe Google::APIClient, 'unconfigured' do
- before do
- @client = Google::APIClient.new
- end
-
- it 'should not be able to determine the discovery URI' do
- (lambda do
- @client.discovery_uri
- end).should raise_error(ArgumentError)
- end
-end
-
-describe Google::APIClient, 'configured for a bogus API' do
- before do
- @client = Google::APIClient.new(:service => 'bogus')
- end
-
- it 'should not be able to retrieve the discovery document' do
- (lambda do
- @client.discovery_document
- end).should raise_error(Google::APIClient::TransmissionError)
- end
-end
-
-describe Google::APIClient, 'configured for bogus authorization' do
- it 'should raise a type error' do
- (lambda do
- Google::APIClient.new(:service => 'prediction', :authorization => 42)
- end).should raise_error(TypeError)
- end
-end
-
-describe Google::APIClient, 'configured for the prediction API' do
- before do
- @client = Google::APIClient.new(:service => 'prediction')
- end
- it 'should correctly determine the discovery URI' do
- @client.discovery_uri.should ===
- 'http://www.googleapis.com/discovery/0.1/describe?api=prediction'
- end
+fixtures_path = File.expand_path('../../../fixtures', __FILE__)
- it 'should have multiple versions available' do
- @client.discovered_services.size.should > 1
- end
+RSpec.describe Google::APIClient do
+ include ConnectionHelpers
+ CLIENT = Google::APIClient.new(:application_name => 'API Client Tests') unless defined?(CLIENT)
- it 'should find APIs that are in the discovery document' do
- @client.discovered_service('prediction').name.should == 'prediction'
- @client.discovered_service('prediction').version.should == 'v1'
- @client.discovered_service(:prediction).name.should == 'prediction'
- @client.discovered_service(:prediction).version.should == 'v1'
+ after do
+ # Reset client to not-quite-pristine state
+ CLIENT.key = nil
+ CLIENT.user_ip = nil
end
- it 'should find API versions that are in the discovery document' do
- @client.discovered_service('prediction', 'v1.1').version.should == 'v1.1'
+ it 'should raise a type error for bogus authorization' do
+ expect(lambda do
+ Google::APIClient.new(:application_name => 'API Client Tests', :authorization => 42)
+ end).to raise_error(TypeError)
end
- it 'should not find APIs that are not in the discovery document' do
- @client.discovered_service('bogus').should == nil
+ it 'should not be able to retrieve the discovery document for a bogus API' do
+ expect(lambda do
+ CLIENT.discovery_document('bogus')
+ end).to raise_error(Google::APIClient::TransmissionError)
+ expect(lambda do
+ CLIENT.discovered_api('bogus')
+ end).to raise_error(Google::APIClient::TransmissionError)
end
it 'should raise an error for bogus services' do
- (lambda do
- @client.discovered_service(42)
- end).should raise_error(TypeError)
- end
-
- it 'should find methods that are in the discovery document' do
- @client.discovered_method('prediction.training.insert').name.should ==
- 'insert'
- @client.discovered_method(:'prediction.training.insert').name.should ==
- 'insert'
- end
-
- it 'should find methods for versions that are in the discovery document' do
- @client.discovered_method(
- 'prediction.training.delete', 'v1.1'
- ).should_not == nil
- end
-
- it 'should not find methods that are not in the discovery document' do
- @client.discovered_method('prediction.training.delete', 'v1').should == nil
- @client.discovered_method('prediction.bogus').should == nil
- end
-
- it 'should raise an error for bogus methods' do
- (lambda do
- @client.discovered_method(42)
- end).should raise_error(TypeError)
- end
-
- it 'should correctly determine the latest version' do
- @client.latest_service_version('prediction').version.should_not == 'v1'
- @client.latest_service_version(:prediction).version.should_not == 'v1'
+ expect(lambda do
+ CLIENT.discovered_api(42)
+ end).to raise_error(TypeError)
end
it 'should raise an error for bogus services' do
- (lambda do
- @client.latest_service_version(42)
- end).should raise_error(TypeError)
- end
-
- it 'should correctly determine the latest version' do
- # Sanity check the algorithm
- @client.discovered_services.clear
- @client.discovered_services <<
- Google::APIClient::Service.new('magic', 'v1', {})
- @client.discovered_services <<
- Google::APIClient::Service.new('magic', 'v1.1', {})
- @client.discovered_services <<
- Google::APIClient::Service.new('magic', 'v1.10', {})
- @client.discovered_services <<
- Google::APIClient::Service.new('magic', 'v10.0.1', {})
- @client.discovered_services <<
- Google::APIClient::Service.new('magic', 'v10.1', {})
- @client.discovered_services <<
- Google::APIClient::Service.new('magic', 'v2.1', {})
- @client.discovered_services <<
- Google::APIClient::Service.new('magic', 'v10.0', {})
- @client.latest_service_version('magic').version.should == 'v10.1'
- end
-
- it 'should correctly determine the latest version' do
- # Sanity check the algorithm
- @client.discovered_services.clear
- @client.discovered_services <<
- Google::APIClient::Service.new('one', 'v3', {})
- @client.discovered_services <<
- Google::APIClient::Service.new('two', 'v1', {})
- @client.discovered_services <<
- Google::APIClient::Service.new('two', 'v1.1-r1c3', {})
- @client.discovered_services <<
- Google::APIClient::Service.new('two', 'v2', {})
- @client.discovered_services <<
- Google::APIClient::Service.new('two', 'v2beta1', {})
- @client.latest_service_version('two').version.should == 'v2'
- end
-
- it 'should return nil for bogus service names' do
- # Sanity check the algorithm
- @client.latest_service_version('bogus').should == nil
- end
-
- it 'should generate valid requests' do
- request = @client.generate_request(
- 'prediction.training.insert',
- {'query' => '12345'}
- )
- method, uri, headers, body = request
- method.should == 'POST'
- uri.should ==
- 'https://www.googleapis.com/prediction/v1/training?query=12345'
- (headers.inject({}) { |h,(k,v)| h[k]=v; h }).should == {}
- body.should respond_to(:each)
- end
-
- it 'should generate requests against the correct URIs' do
- request = @client.generate_request(
- :'prediction.training.insert',
- {'query' => '12345'}
- )
- method, uri, headers, body = request
- uri.should ==
- 'https://www.googleapis.com/prediction/v1/training?query=12345'
- end
-
- it 'should generate requests against the correct URIs' do
- prediction = @client.discovered_service('prediction', 'v1')
- request = @client.generate_request(
- prediction.training.insert,
- {'query' => '12345'}
- )
- method, uri, headers, body = request
- uri.should ==
- 'https://www.googleapis.com/prediction/v1/training?query=12345'
- end
-
- it 'should generate signed requests' do
- @client.authorization = :oauth_1
- @client.authorization.token_credential_key = '12345'
- @client.authorization.token_credential_secret = '12345'
- request = @client.generate_request(
- 'prediction.training.insert',
- {'query' => '12345'}
- )
- method, uri, headers, body = request
- headers = headers.inject({}) { |h,(k,v)| h[k]=v; h }
- headers.keys.should include('Authorization')
- headers['Authorization'].should =~ /^OAuth/
- end
-
- it 'should not be able to execute improperly authorized requests' do
- @client.authorization = :oauth_1
- @client.authorization.token_credential_key = '12345'
- @client.authorization.token_credential_secret = '12345'
- response = @client.execute(
- 'prediction.training.insert',
- {'query' => '12345'}
- )
- status, headers, body = response
- status.should == 401
+ expect(lambda do
+ CLIENT.preferred_version(42)
+ end).to raise_error(TypeError)
end
it 'should raise an error for bogus methods' do
- (lambda do
- @client.generate_request(42)
- end).should raise_error(TypeError)
- end
-
- it 'should raise an error for bogus methods' do
- (lambda do
- @client.generate_request(@client.discovered_service('prediction'))
- end).should raise_error(TypeError)
- end
-end
-
-describe Google::APIClient, 'configured for the buzz API' do
- before do
- @client = Google::APIClient.new(:service => 'buzz')
- end
-
- it 'should correctly determine the discovery URI' do
- @client.discovery_uri.should ===
- 'http://www.googleapis.com/discovery/0.1/describe?api=buzz'
- end
-
- it 'should find APIs that are in the discovery document' do
- @client.discovered_service('buzz').name.should == 'buzz'
- @client.discovered_service('buzz').version.should == 'v1'
- end
-
- it 'should not find APIs that are not in the discovery document' do
- @client.discovered_service('bogus').should == nil
- 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('chili.activities.list').name.should == 'list'
- end
-
- it 'should not find methods that are not in the discovery document' do
- @client.discovered_method('buzz.bogus').should == nil
- end
-
- it 'should generate requests against the correct URIs' do
- # TODO(bobaman) Fix this when the RPC names are correct
- request = @client.generate_request(
- 'chili.activities.list',
- {'userId' => 'hikingfan', 'scope' => '@public'},
- '',
- [],
- {:signed => false}
- )
- method, uri, headers, body = request
- uri.should ==
- 'https://www.googleapis.com/buzz/v1/activities/hikingfan/@public'
- end
-
- it 'should correctly validate parameters' do
- # TODO(bobaman) Fix this when the RPC names are correct
- (lambda do
- @client.generate_request(
- 'chili.activities.list',
- {'alt' => 'json'},
- '',
- [],
- {:signed => false}
+ expect(lambda do
+ CLIENT.execute(42)
+ end).to raise_error(TypeError)
+ end
+
+ it 'should not return a preferred version for bogus service names' do
+ expect(CLIENT.preferred_version('bogus')).to eq(nil)
+ end
+
+ describe 'with zoo API' do
+ it 'should return API instance registered from file' do
+ zoo_json = File.join(fixtures_path, 'files', 'zoo.json')
+ contents = File.open(zoo_json, 'rb') { |io| io.read }
+ api = CLIENT.register_discovery_document('zoo', 'v1', contents)
+ expect(api).to be_kind_of(Google::APIClient::API)
+ end
+ end
+
+ describe 'with the prediction API' do
+ before do
+ CLIENT.authorization = nil
+ # The prediction API no longer exposes a v1, so we have to be
+ # careful about looking up the wrong API version.
+ @prediction = CLIENT.discovered_api('prediction', 'v1.2')
+ end
+
+ it 'should correctly determine the discovery URI' do
+ 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(
+ :http_method => 'GET',
+ :uri => CLIENT.discovery_uri('prediction', 'v1.2'),
+ :authenticated => false,
+ :connection => conn
)
- end).should raise_error(ArgumentError)
- end
-
- it 'should correctly validate parameters' do
- # TODO(bobaman) Fix this when the RPC names are correct
- (lambda do
- @client.generate_request(
- 'chili.activities.list',
- {'userId' => 'hikingfan', 'scope' => '@bogus'},
- '',
- [],
- {:signed => false}
+ conn.verify
+ end
+
+ it 'should correctly determine the discovery URI if :key is set' do
+ 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(
+ :http_method => 'GET',
+ :uri => CLIENT.discovery_uri('prediction', 'v1.2'),
+ :authenticated => false,
+ :connection => conn
+ )
+ conn.verify
+ end
+
+ it 'should correctly determine the discovery URI if both are set' do
+ CLIENT.key = 'qwerty'
+ 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(
+ :http_method => 'GET',
+ :uri => CLIENT.discovery_uri('prediction', 'v1.2'),
+ :authenticated => false,
+ :connection => conn
+ )
+ conn.verify
+ end
+
+ it 'should correctly generate API objects' do
+ 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
+ expect(CLIENT.discovered_method(
+ 'prediction.training.insert', 'prediction', 'v1.2'
+ ).name).to eq('insert')
+ expect(CLIENT.discovered_method(
+ :'prediction.training.insert', :prediction, 'v1.2'
+ ).name).to eq('insert')
+ expect(CLIENT.discovered_method(
+ 'prediction.training.delete', 'prediction', 'v1.2'
+ ).name).to eq('delete')
+ end
+
+ it 'should define the origin API in discovered methods' do
+ expect(CLIENT.discovered_method(
+ 'prediction.training.insert', 'prediction', 'v1.2'
+ ).api.name).to eq('prediction')
+ end
+
+ it 'should not find methods that are not in the discovery document' do
+ expect(CLIENT.discovered_method(
+ 'prediction.bogus', 'prediction', 'v1.2'
+ )).to eq(nil)
+ end
+
+ it 'should raise an error for bogus methods' do
+ expect(lambda do
+ CLIENT.discovered_method(42, 'prediction', 'v1.2')
+ end).to raise_error(TypeError)
+ end
+
+ it 'should raise an error for bogus methods' do
+ expect(lambda do
+ CLIENT.execute(:api_method => CLIENT.discovered_api('prediction', 'v1.2'))
+ end).to raise_error(TypeError)
+ end
+
+ it 'should correctly determine the preferred version' do
+ 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
+ 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|
+ expect(env[:body]).to eq('')
+ [200, {}, '{}']
+ end
+ end
+ request = CLIENT.execute(
+ :api_method => @prediction.training.insert,
+ :parameters => {'data' => '12345'},
+ :connection => conn
)
- end).should raise_error(ArgumentError)
- end
-
- it 'should be able to execute requests without authorization' do
- # TODO(bobaman) Fix this when the RPC names are correct
- response = @client.execute(
- 'chili.activities.list',
- {'alt' => 'json', 'userId' => 'hikingfan', 'scope' => '@public'},
- '',
- [],
- {:signed => false}
- )
- status, headers, body = response
- status.should == 200
- end
-end
-
-describe Google::APIClient, 'configured for the latitude API' do
- before do
- @client = Google::APIClient.new(:service => 'latitude')
- end
-
- it 'should correctly determine the discovery URI' do
- @client.discovery_uri.should ===
- 'http://www.googleapis.com/discovery/0.1/describe?api=latitude'
- end
-
- it 'should find APIs that are in the discovery document' do
- @client.discovered_service('latitude').name.should == 'latitude'
- @client.discovered_service('latitude').version.should == 'v1'
- end
-
- it 'should not find APIs that are not in the discovery document' do
- @client.discovered_service('bogus').should == nil
- end
-
- it 'should find methods that are in the discovery document' do
- @client.discovered_method('latitude.currentLocation.get').name.should ==
- 'get'
- end
-
- it 'should not find methods that are not in the discovery document' do
- @client.discovered_method('latitude.bogus').should == nil
- end
-
- it 'should generate requests against the correct URIs' do
- request = @client.generate_request(
- 'latitude.currentLocation.get',
- {},
- '',
- [],
- {:signed => false}
- )
- method, uri, headers, body = request
- uri.should ==
- 'https://www.googleapis.com/latitude/v1/currentLocation'
- end
-
- it 'should not be able to execute requests without authorization' do
- response = @client.execute(
- 'latitude.currentLocation.get',
- {},
- '',
- [],
- {:signed => false}
- )
- status, headers, body = response
- status.should == 401
- end
-end
-
-describe Google::APIClient, 'configured for the moderator API' do
- before do
- @client = Google::APIClient.new(:service => 'moderator')
- end
-
- it 'should correctly determine the discovery URI' do
- @client.discovery_uri.should ===
- 'http://www.googleapis.com/discovery/0.1/describe?api=moderator'
- end
-
- it 'should find APIs that are in the discovery document' do
- @client.discovered_service('moderator').name.should == 'moderator'
- @client.discovered_service('moderator').version.should == 'v1'
- end
-
- it 'should not find APIs that are not in the discovery document' do
- @client.discovered_service('bogus').should == nil
- end
-
- it 'should find methods that are in the discovery document' do
- @client.discovered_method('moderator.profiles.get').name.should ==
- 'get'
- end
-
- it 'should not find methods that are not in the discovery document' do
- @client.discovered_method('moderator.bogus').should == nil
- end
+ conn.verify
+ end
+
+ 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|
+ expect(env.params['data']).to include('1', '2')
+ [200, {}, '{}']
+ end
+ end
+ request = CLIENT.execute(
+ :api_method => @prediction.training.insert,
+ :parameters => {'data' => ['1', '2']},
+ :connection => conn
+ )
+ conn.verify
+ end
+
+ 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(
+ :api_method => @prediction.training.insert,
+ :parameters => {'data' => '12345'},
+ :connection => conn
+ )
+ conn.verify
+ end
+
+ 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(
+ :api_method => @prediction.training.insert,
+ :parameters => {'data' => '12345'},
+ :connection => conn
+ )
+ conn.verify
+ end
+
+ 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(: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|
+ 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'},
+ :connection => conn
+ )
+ conn.verify
+ end
+
+ it 'should generate OAuth 1 requests' do
+ CLIENT.authorization = :oauth_1
+ CLIENT.authorization.token_credential_key = '12345'
+ CLIENT.authorization.token_credential_secret = '12345'
+
+ conn = stub_connection do |stub|
+ stub.post('/prediction/v1.2/training?data=12345') do |env|
+ expect(env[:request_headers]).to have_key('Authorization')
+ expect(env[:request_headers]['Authorization']).to match(/^OAuth/)
+ [200, {}, '{}']
+ end
+ end
+
+ request = CLIENT.execute(
+ :api_method => @prediction.training.insert,
+ :parameters => {'data' => '12345'},
+ :connection => conn
+ )
+ conn.verify
+ end
+
+ it 'should generate OAuth 2 requests' do
+ CLIENT.authorization = :oauth_2
+ CLIENT.authorization.access_token = '12345'
+
+ conn = stub_connection do |stub|
+ stub.post('/prediction/v1.2/training?data=12345') do |env|
+ expect(env[:request_headers]).to have_key('Authorization')
+ expect(env[:request_headers]['Authorization']).to match(/^Bearer/)
+ [200, {}, '{}']
+ end
+ end
+
+ request = CLIENT.execute(
+ :api_method => @prediction.training.insert,
+ :parameters => {'data' => '12345'},
+ :connection => conn
+ )
+ conn.verify
+ end
+
+ it 'should not be able to execute improperly authorized requests' do
+ CLIENT.authorization = :oauth_1
+ CLIENT.authorization.token_credential_key = '12345'
+ CLIENT.authorization.token_credential_secret = '12345'
+ result = CLIENT.execute(
+ @prediction.training.insert,
+ {'data' => '12345'}
+ )
+ expect(result.response.status).to eq(401)
+ end
+
+ it 'should not be able to execute improperly authorized requests' do
+ CLIENT.authorization = :oauth_2
+ CLIENT.authorization.access_token = '12345'
+ result = CLIENT.execute(
+ @prediction.training.insert,
+ {'data' => '12345'}
+ )
+ expect(result.response.status).to eq(401)
+ end
+
+ it 'should not be able to execute improperly authorized requests' do
+ expect(lambda do
+ CLIENT.authorization = :oauth_1
+ CLIENT.authorization.token_credential_key = '12345'
+ CLIENT.authorization.token_credential_secret = '12345'
+ result = CLIENT.execute!(
+ @prediction.training.insert,
+ {'data' => '12345'}
+ )
+ end).to raise_error(Google::APIClient::ClientError)
+ end
+
+ it 'should not be able to execute improperly authorized requests' do
+ expect(lambda do
+ CLIENT.authorization = :oauth_2
+ CLIENT.authorization.access_token = '12345'
+ result = CLIENT.execute!(
+ @prediction.training.insert,
+ {'data' => '12345'}
+ )
+ 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|
+ 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
+ CLIENT.authorization.access_token = '12345'
+ CLIENT.execute(
+ :api_method => @prediction.training.insert,
+ :body => MultiJson.dump({"id" => "bucket/object"}),
+ :headers => {'Content-Type' => 'application/json'},
+ :connection => conn
+ )
+ conn.verify
+ end
+ end
+
+ describe 'with the plus API' do
+ before do
+ CLIENT.authorization = nil
+ @plus = CLIENT.discovered_api('plus')
+ end
+
+ it 'should correctly determine the discovery URI' do
+ 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
+ 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
+ expect(CLIENT.discovered_method(
+ 'plus.activities.list', 'plus'
+ ).name).to eq('list')
+ end
+
+ it 'should define the origin API in discovered methods' do
+ expect(CLIENT.discovered_method(
+ 'plus.activities.list', 'plus'
+ ).api.name).to eq('plus')
+ end
+
+ it 'should not find methods that are not in the discovery document' do
+ 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') do |env|
+ [200, {}, '{}']
+ end
+ end
+
+ request = CLIENT.execute(
+ :api_method => @plus.activities.list,
+ :parameters => {
+ 'userId' => '107807692475771887386', 'collection' => 'public'
+ },
+ :authenticated => false,
+ :connection => conn
+ )
+ conn.verify
+ end
+
+ it 'should correctly validate parameters' do
+ expect(lambda do
+ CLIENT.execute(
+ :api_method => @plus.activities.list,
+ :parameters => {'alt' => 'json'},
+ :authenticated => false
+ )
+ end).to raise_error(ArgumentError)
+ end
+
+ it 'should correctly validate parameters' do
+ expect(lambda do
+ CLIENT.execute(
+ :api_method => @plus.activities.list,
+ :parameters => {
+ 'userId' => '107807692475771887386', 'collection' => 'bogus'
+ },
+ :authenticated => false
+ ).to_env(CLIENT.connection)
+ end).to raise_error(ArgumentError)
+ end
+
+ it 'should correctly determine the service root_uri' do
+ expect(@plus.root_uri.to_s).to eq('https://www.googleapis.com/')
+ end
+ end
+
+ describe 'with the adsense API' do
+ before do
+ CLIENT.authorization = nil
+ @adsense = CLIENT.discovered_api('adsense', 'v1.3')
+ end
+
+ it 'should correctly determine the discovery URI' do
+ 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
+ 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
+ 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
+ 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
+ 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.3/adclients') do |env|
+ [200, {}, '{}']
+ end
+ end
+ request = CLIENT.execute(
+ :api_method => @adsense.adclients.list,
+ :authenticated => false,
+ :connection => conn
+ )
+ conn.verify
+ end
- it 'should generate requests against the correct URIs' do
- request = @client.generate_request(
- 'moderator.profiles.get',
- {},
- '',
- [],
- {:signed => false}
- )
- method, uri, headers, body = request
- uri.should ==
- 'https://www.googleapis.com/moderator/v1/profiles/@me'
- end
+ it 'should not be able to execute requests without authorization' do
+ result = CLIENT.execute(
+ :api_method => @adsense.adclients.list,
+ :authenticated => false
+ )
+ expect(result.response.status).to eq(401)
+ end
+
+ it 'should fail when validating missing required parameters' do
+ expect(lambda do
+ CLIENT.execute(
+ :api_method => @adsense.reports.generate,
+ :authenticated => false
+ )
+ 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.3/reports?dimension=DATE&endDate=2010-01-01&metric=PAGE_VIEWS&startDate=2000-01-01') do |env|
+ [200, {}, '{}']
+ end
+ end
+ expect(lambda do
+ CLIENT.execute(
+ :api_method => @adsense.reports.generate,
+ :parameters => {
+ 'startDate' => '2000-01-01',
+ 'endDate' => '2010-01-01',
+ 'dimension' => 'DATE',
+ 'metric' => 'PAGE_VIEWS'
+ },
+ :authenticated => false,
+ :connection => conn
+ )
+ end).not_to raise_error
+ conn.verify
+ end
+
+ it 'should fail when validating parameters with invalid values' do
+ expect(lambda do
+ CLIENT.execute(
+ :api_method => @adsense.reports.generate,
+ :parameters => {
+ 'startDate' => '2000-01-01',
+ 'endDate' => '2010-01-01',
+ 'dimension' => 'BAD_CHARACTERS=-&*(£&',
+ 'metric' => 'PAGE_VIEWS'
+ },
+ :authenticated => false
+ )
+ 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.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
+ expect(lambda do
+ 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
+ )
+ end).not_to raise_error
+ conn.verify
+ end
+
+ it 'should fail when validating incorrect repeated parameters' do
+ expect(lambda do
+ CLIENT.execute(
+ :api_method => @adsense.reports.generate,
+ :parameters => {
+ 'startDate' => '2000-01-01',
+ 'endDate' => '2010-01-01',
+ 'dimension' => ['DATE', 'BAD_CHARACTERS=-&*(£&'],
+ 'metric' => ['PAGE_VIEWS', 'CLICKS']
+ },
+ :authenticated => false
+ )
+ 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
+
+ describe 'with the Drive API' do
+ before do
+ CLIENT.authorization = nil
+ @drive = CLIENT.discovered_api('drive', 'v1')
+ end
+
+ it 'should include media upload info methods' do
+ expect(@drive.files.insert.media_upload).not_to eq(nil)
+ end
+
+ it 'should include accepted media types' do
+ expect(@drive.files.insert.media_upload.accepted_types).not_to be_empty
+ end
+
+ it 'should have an upload path' do
+ expect(@drive.files.insert.media_upload.uri_template).not_to eq(nil)
+ end
+
+ it 'should have a max file size' do
+ expect(@drive.files.insert.media_upload.max_size).not_to eq(nil)
+ end
+ end
+
+ describe 'with the Pub/Sub API' do
+ before do
+ CLIENT.authorization = nil
+ @pubsub = CLIENT.discovered_api('pubsub', 'v1beta2')
+ end
+
+ it 'should generate requests against the correct URIs' do
+ conn = stub_connection do |stub|
+ stub.get('/v1beta2/projects/12345/topics') do |env|
+ expect(env[:url].host).to eq('pubsub.googleapis.com')
+ [200, {}, '{}']
+ end
+ end
+ request = CLIENT.execute(
+ :api_method => @pubsub.projects.topics.list,
+ :parameters => {'project' => 'projects/12345'},
+ :connection => conn
+ )
+ conn.verify
+ end
- it 'should not be able to execute requests without authorization' do
- response = @client.execute(
- 'moderator.profiles.get',
- {},
- '',
- [],
- {:signed => false}
- )
- status, headers, body = response
- status.should == 401
+ it 'should correctly determine the service root_uri' do
+ expect(@pubsub.root_uri.to_s).to eq('https://pubsub.googleapis.com/')
+ end
end
end
projects / arvados.git / blobdiff