3 # Copyright 2010 Google Inc.
5 # Licensed under the Apache License, Version 2.0 (the "License");
6 # you may not use this file except in compliance with the License.
7 # You may obtain a copy of the License at
9 # http://www.apache.org/licenses/LICENSE-2.0
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
21 require 'faraday/utils'
23 require 'compat/multi_json'
24 require 'signet/oauth_1/client'
25 require 'google/api_client'
26 require 'google/api_client/version'
28 describe Google::APIClient do
29 include ConnectionHelpers
30 CLIENT = Google::APIClient.new(:application_name => 'API Client Tests') unless defined?(CLIENT)
33 # Reset client to not-quite-pristine state
38 it 'should raise a type error for bogus authorization' do
40 Google::APIClient.new(:application_name => 'API Client Tests', :authorization => 42)
41 end).should raise_error(TypeError)
44 it 'should not be able to retrieve the discovery document for a bogus API' do
46 CLIENT.discovery_document('bogus')
47 end).should raise_error(Google::APIClient::TransmissionError)
49 CLIENT.discovered_api('bogus')
50 end).should raise_error(Google::APIClient::TransmissionError)
53 it 'should raise an error for bogus services' do
55 CLIENT.discovered_api(42)
56 end).should raise_error(TypeError)
59 it 'should raise an error for bogus services' do
61 CLIENT.preferred_version(42)
62 end).should raise_error(TypeError)
65 it 'should raise an error for bogus methods' do
68 end).should raise_error(TypeError)
71 it 'should not return a preferred version for bogus service names' do
72 CLIENT.preferred_version('bogus').should == nil
75 describe 'with the prediction API' do
77 CLIENT.authorization = nil
78 # The prediction API no longer exposes a v1, so we have to be
79 # careful about looking up the wrong API version.
80 @prediction = CLIENT.discovered_api('prediction', 'v1.2')
83 it 'should correctly determine the discovery URI' do
84 CLIENT.discovery_uri('prediction').should ===
85 'https://www.googleapis.com/discovery/v1/apis/prediction/v1/rest'
88 it 'should correctly determine the discovery URI if :user_ip is set' do
89 CLIENT.user_ip = '127.0.0.1'
91 conn = stub_connection do |stub|
92 stub.get('/discovery/v1/apis/prediction/v1.2/rest?userIp=127.0.0.1') do |env|
96 :http_method => 'GET',
97 :uri => CLIENT.discovery_uri('prediction', 'v1.2'),
98 :authenticated => false,
104 it 'should correctly determine the discovery URI if :key is set' do
105 CLIENT.key = 'qwerty'
106 conn = stub_connection do |stub|
107 stub.get('/discovery/v1/apis/prediction/v1.2/rest?key=qwerty') do |env|
110 request = CLIENT.execute(
111 :http_method => 'GET',
112 :uri => CLIENT.discovery_uri('prediction', 'v1.2'),
113 :authenticated => false,
119 it 'should correctly determine the discovery URI if both are set' do
120 CLIENT.key = 'qwerty'
121 CLIENT.user_ip = '127.0.0.1'
122 conn = stub_connection do |stub|
123 stub.get('/discovery/v1/apis/prediction/v1.2/rest?key=qwerty&userIp=127.0.0.1') do |env|
126 request = CLIENT.execute(
127 :http_method => 'GET',
128 :uri => CLIENT.discovery_uri('prediction', 'v1.2'),
129 :authenticated => false,
135 it 'should correctly generate API objects' do
136 CLIENT.discovered_api('prediction', 'v1.2').name.should == 'prediction'
137 CLIENT.discovered_api('prediction', 'v1.2').version.should == 'v1.2'
138 CLIENT.discovered_api(:prediction, 'v1.2').name.should == 'prediction'
139 CLIENT.discovered_api(:prediction, 'v1.2').version.should == 'v1.2'
142 it 'should discover methods' do
143 CLIENT.discovered_method(
144 'prediction.training.insert', 'prediction', 'v1.2'
145 ).name.should == 'insert'
146 CLIENT.discovered_method(
147 :'prediction.training.insert', :prediction, 'v1.2'
148 ).name.should == 'insert'
149 CLIENT.discovered_method(
150 'prediction.training.delete', 'prediction', 'v1.2'
151 ).name.should == 'delete'
154 it 'should define the origin API in discovered methods' do
155 CLIENT.discovered_method(
156 'prediction.training.insert', 'prediction', 'v1.2'
157 ).api.name.should == 'prediction'
160 it 'should not find methods that are not in the discovery document' do
161 CLIENT.discovered_method(
162 'prediction.bogus', 'prediction', 'v1.2'
166 it 'should raise an error for bogus methods' do
168 CLIENT.discovered_method(42, 'prediction', 'v1.2')
169 end).should raise_error(TypeError)
172 it 'should raise an error for bogus methods' do
174 CLIENT.execute(:api_method => CLIENT.discovered_api('prediction', 'v1.2'))
175 end).should raise_error(TypeError)
178 it 'should correctly determine the preferred version' do
179 CLIENT.preferred_version('prediction').version.should_not == 'v1'
180 CLIENT.preferred_version(:prediction).version.should_not == 'v1'
183 it 'should return a batch path' do
184 CLIENT.discovered_api('prediction', 'v1.2').batch_path.should_not be_nil
187 it 'should generate valid requests' do
188 conn = stub_connection do |stub|
189 stub.post('/prediction/v1.2/training?data=12345') do |env|
190 env[:body].should == ''
193 request = CLIENT.execute(
194 :api_method => @prediction.training.insert,
195 :parameters => {'data' => '12345'},
201 it 'should generate valid requests when parameter value includes semicolon' do
202 conn = stub_connection do |stub|
203 # semicolon (;) in parameter value was being converted to
204 # bare ampersand (&) in 0.4.7. ensure that it gets converted
205 # to a CGI-escaped semicolon (%3B) instead.
206 stub.post('/prediction/v1.2/training?data=12345%3B67890') do |env|
207 env[:body].should == ''
210 request = CLIENT.execute(
211 :api_method => @prediction.training.insert,
212 :parameters => {'data' => '12345;67890'},
218 it 'should generate valid requests when multivalued parameters are passed' do
219 conn = stub_connection do |stub|
220 stub.post('/prediction/v1.2/training?data=1&data=2') do |env|
221 env.params['data'].should include('1', '2')
224 request = CLIENT.execute(
225 :api_method => @prediction.training.insert,
226 :parameters => {'data' => ['1', '2']},
232 it 'should generate requests against the correct URIs' do
233 conn = stub_connection do |stub|
234 stub.post('/prediction/v1.2/training?data=12345') do |env|
237 request = CLIENT.execute(
238 :api_method => @prediction.training.insert,
239 :parameters => {'data' => '12345'},
245 it 'should generate requests against the correct URIs' do
246 conn = stub_connection do |stub|
247 stub.post('/prediction/v1.2/training?data=12345') do |env|
250 request = CLIENT.execute(
251 :api_method => @prediction.training.insert,
252 :parameters => {'data' => '12345'},
258 it 'should allow modification to the base URIs for testing purposes' do
259 # Using a new client instance here to avoid caching rebased discovery doc
261 Google::APIClient.new(:application_name => 'API Client Tests').discovered_api('prediction', 'v1.2')
262 prediction_rebase.method_base =
263 'https://testing-domain.example.com/prediction/v1.2/'
265 conn = stub_connection do |stub|
266 stub.post('/prediction/v1.2/training') do |env|
267 env[:url].host.should == 'testing-domain.example.com'
271 request = CLIENT.execute(
272 :api_method => prediction_rebase.training.insert,
273 :parameters => {'data' => '123'},
279 it 'should generate OAuth 1 requests' do
280 CLIENT.authorization = :oauth_1
281 CLIENT.authorization.token_credential_key = '12345'
282 CLIENT.authorization.token_credential_secret = '12345'
284 conn = stub_connection do |stub|
285 stub.post('/prediction/v1.2/training?data=12345') do |env|
286 env[:request_headers].should have_key('Authorization')
287 env[:request_headers]['Authorization'].should =~ /^OAuth/
291 request = CLIENT.execute(
292 :api_method => @prediction.training.insert,
293 :parameters => {'data' => '12345'},
299 it 'should generate OAuth 2 requests' do
300 CLIENT.authorization = :oauth_2
301 CLIENT.authorization.access_token = '12345'
303 conn = stub_connection do |stub|
304 stub.post('/prediction/v1.2/training?data=12345') do |env|
305 env[:request_headers].should have_key('Authorization')
306 env[:request_headers]['Authorization'].should =~ /^Bearer/
310 request = CLIENT.execute(
311 :api_method => @prediction.training.insert,
312 :parameters => {'data' => '12345'},
318 it 'should not be able to execute improperly authorized requests' do
319 CLIENT.authorization = :oauth_1
320 CLIENT.authorization.token_credential_key = '12345'
321 CLIENT.authorization.token_credential_secret = '12345'
322 result = CLIENT.execute(
323 @prediction.training.insert,
326 result.response.status.should == 401
329 it 'should not be able to execute improperly authorized requests' do
330 CLIENT.authorization = :oauth_2
331 CLIENT.authorization.access_token = '12345'
332 result = CLIENT.execute(
333 @prediction.training.insert,
336 result.response.status.should == 401
339 it 'should not be able to execute improperly authorized requests' do
341 CLIENT.authorization = :oauth_1
342 CLIENT.authorization.token_credential_key = '12345'
343 CLIENT.authorization.token_credential_secret = '12345'
344 result = CLIENT.execute!(
345 @prediction.training.insert,
348 end).should raise_error(Google::APIClient::ClientError)
351 it 'should not be able to execute improperly authorized requests' do
353 CLIENT.authorization = :oauth_2
354 CLIENT.authorization.access_token = '12345'
355 result = CLIENT.execute!(
356 @prediction.training.insert,
359 end).should raise_error(Google::APIClient::ClientError)
362 it 'should correctly handle unnamed parameters' do
363 conn = stub_connection do |stub|
364 stub.post('/prediction/v1.2/training') do |env|
365 env[:request_headers].should have_key('Content-Type')
366 env[:request_headers]['Content-Type'].should == 'application/json'
369 CLIENT.authorization = :oauth_2
370 CLIENT.authorization.access_token = '12345'
372 :api_method => @prediction.training.insert,
373 :body => MultiJson.dump({"id" => "bucket/object"}),
374 :headers => {'Content-Type' => 'application/json'},
381 describe 'with the plus API' do
383 CLIENT.authorization = nil
384 @plus = CLIENT.discovered_api('plus')
387 it 'should correctly determine the discovery URI' do
388 CLIENT.discovery_uri('plus').should ===
389 'https://www.googleapis.com/discovery/v1/apis/plus/v1/rest'
392 it 'should find APIs that are in the discovery document' do
393 CLIENT.discovered_api('plus').name.should == 'plus'
394 CLIENT.discovered_api('plus').version.should == 'v1'
395 CLIENT.discovered_api(:plus).name.should == 'plus'
396 CLIENT.discovered_api(:plus).version.should == 'v1'
399 it 'should find methods that are in the discovery document' do
400 # TODO(bobaman) Fix this when the RPC names are correct
401 CLIENT.discovered_method(
402 'plus.activities.list', 'plus'
403 ).name.should == 'list'
406 it 'should define the origin API in discovered methods' do
407 CLIENT.discovered_method(
408 'plus.activities.list', 'plus'
409 ).api.name.should == 'plus'
412 it 'should not find methods that are not in the discovery document' do
413 CLIENT.discovered_method('plus.bogus', 'plus').should == nil
416 it 'should generate requests against the correct URIs' do
417 conn = stub_connection do |stub|
418 stub.get('/plus/v1/people/107807692475771887386/activities/public') do |env|
422 request = CLIENT.execute(
423 :api_method => @plus.activities.list,
425 'userId' => '107807692475771887386', 'collection' => 'public'
427 :authenticated => false,
433 it 'should correctly validate parameters' do
436 :api_method => @plus.activities.list,
437 :parameters => {'alt' => 'json'},
438 :authenticated => false
440 end).should raise_error(ArgumentError)
443 it 'should correctly validate parameters' do
446 :api_method => @plus.activities.list,
448 'userId' => '107807692475771887386', 'collection' => 'bogus'
450 :authenticated => false
451 ).to_env(CLIENT.connection)
452 end).should raise_error(ArgumentError)
456 describe 'with the latitude API' do
458 CLIENT.authorization = nil
459 @latitude = CLIENT.discovered_api('latitude')
462 it 'should correctly determine the discovery URI' do
463 CLIENT.discovery_uri('latitude').should ===
464 'https://www.googleapis.com/discovery/v1/apis/latitude/v1/rest'
467 it 'should find APIs that are in the discovery document' do
468 CLIENT.discovered_api('latitude').name.should == 'latitude'
469 CLIENT.discovered_api('latitude').version.should == 'v1'
472 it 'should return a batch path' do
473 CLIENT.discovered_api('latitude').batch_path.should_not be_nil
476 it 'should find methods that are in the discovery document' do
477 CLIENT.discovered_method(
478 'latitude.currentLocation.get', 'latitude'
479 ).name.should == 'get'
482 it 'should define the origin API in discovered methods' do
483 CLIENT.discovered_method(
484 'latitude.currentLocation.get', 'latitude'
485 ).api.name.should == 'latitude'
488 it 'should not find methods that are not in the discovery document' do
489 CLIENT.discovered_method('latitude.bogus', 'latitude').should == nil
492 it 'should generate requests against the correct URIs' do
493 request = CLIENT.generate_request(
494 :api_method => @latitude.current_location.get,
495 :authenticated => false
497 request.to_env(CLIENT.connection)[:url].to_s.should ===
498 'https://www.googleapis.com/latitude/v1/currentLocation'
501 it 'should generate requests against the correct URIs' do
502 request = CLIENT.generate_request(
503 :api_method => @latitude.current_location.get,
504 :authenticated => false
506 request.to_env(CLIENT.connection)[:url].to_s.should ===
507 'https://www.googleapis.com/latitude/v1/currentLocation'
510 it 'should not be able to execute requests without authorization' do
511 result = CLIENT.execute(
512 :api_method => @latitude.current_location.get,
513 :authenticated => false
515 result.response.status.should == 401
519 describe 'with the adsense API' do
521 CLIENT.authorization = nil
522 @adsense = CLIENT.discovered_api('adsense', 'v1')
525 it 'should correctly determine the discovery URI' do
526 CLIENT.discovery_uri('adsense').should ===
527 'https://www.googleapis.com/discovery/v1/apis/adsense/v1/rest'
530 it 'should find APIs that are in the discovery document' do
531 CLIENT.discovered_api('adsense').name.should == 'adsense'
532 CLIENT.discovered_api('adsense').version.should == 'v1'
535 it 'should return a batch path' do
536 CLIENT.discovered_api('adsense').batch_path.should_not be_nil
539 it 'should find methods that are in the discovery document' do
540 CLIENT.discovered_method(
541 'adsense.reports.generate', 'adsense'
542 ).name.should == 'generate'
545 it 'should not find methods that are not in the discovery document' do
546 CLIENT.discovered_method('adsense.bogus', 'adsense').should == nil
549 it 'should generate requests against the correct URIs' do
550 conn = stub_connection do |stub|
551 stub.get('/adsense/v1/adclients') do |env|
554 request = CLIENT.execute(
555 :api_method => @adsense.adclients.list,
556 :authenticated => false,
562 it 'should not be able to execute requests without authorization' do
563 result = CLIENT.execute(
564 :api_method => @adsense.adclients.list,
565 :authenticated => false
567 result.response.status.should == 401
570 it 'should fail when validating missing required parameters' do
573 :api_method => @adsense.reports.generate,
574 :authenticated => false
576 end).should raise_error(ArgumentError)
579 it 'should succeed when validating parameters in a correct call' do
580 conn = stub_connection do |stub|
581 stub.get('/adsense/v1/reports?dimension=DATE&endDate=2010-01-01&metric=PAGE_VIEWS&startDate=2000-01-01') do |env|
586 :api_method => @adsense.reports.generate,
588 'startDate' => '2000-01-01',
589 'endDate' => '2010-01-01',
590 'dimension' => 'DATE',
591 'metric' => 'PAGE_VIEWS'
593 :authenticated => false,
596 end).should_not raise_error
600 it 'should fail when validating parameters with invalid values' do
603 :api_method => @adsense.reports.generate,
605 'startDate' => '2000-01-01',
606 'endDate' => '2010-01-01',
607 'dimension' => 'BAD_CHARACTERS=-&*(£&',
608 'metric' => 'PAGE_VIEWS'
610 :authenticated => false
612 end).should raise_error(ArgumentError)
615 it 'should succeed when validating repeated parameters in a correct call' do
616 # pending("This is caused by Faraday's encoding of query parameters.")
617 conn = stub_connection do |stub|
618 stub.get('/adsense/v1/reports?dimension=DATE&dimension=PRODUCT_CODE'+
619 '&endDate=2010-01-01&metric=CLICKS&metric=PAGE_VIEWS&'+
620 'startDate=2000-01-01') do |env|
625 :api_method => @adsense.reports.generate,
627 'startDate' => '2000-01-01',
628 'endDate' => '2010-01-01',
629 'dimension' => ['DATE', 'PRODUCT_CODE'],
630 'metric' => ['PAGE_VIEWS', 'CLICKS']
632 :authenticated => false,
635 end).should_not raise_error
639 it 'should fail when validating incorrect repeated parameters' do
642 :api_method => @adsense.reports.generate,
644 'startDate' => '2000-01-01',
645 'endDate' => '2010-01-01',
646 'dimension' => ['DATE', 'BAD_CHARACTERS=-&*(£&'],
647 'metric' => ['PAGE_VIEWS', 'CLICKS']
649 :authenticated => false
651 end).should raise_error(ArgumentError)
655 describe 'with the Drive API' do
657 CLIENT.authorization = nil
658 @drive = CLIENT.discovered_api('drive', 'v1')
661 it 'should include media upload info methods' do
662 @drive.files.insert.media_upload.should_not == nil
665 it 'should include accepted media types' do
666 @drive.files.insert.media_upload.accepted_types.should_not be_empty
669 it 'should have an upload path' do
670 @drive.files.insert.media_upload.uri_template.should_not == nil
673 it 'should have a max file size' do
674 @drive.files.insert.media_upload.max_size.should_not == nil