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'
29 def initialize(&block)
38 def mock_connection(&block)
39 connection = Faraday.new do |builder|
44 describe Google::APIClient do
45 include ConnectionHelpers
46 CLIENT = Google::APIClient.new unless defined?(CLIENT)
49 # Reset client to not-quite-pristine state
54 it 'should raise a type error for bogus authorization' do
56 Google::APIClient.new(:authorization => 42)
57 end).should raise_error(TypeError)
60 it 'should not be able to retrieve the discovery document for a bogus API' do
62 CLIENT.discovery_document('bogus')
63 end).should raise_error(Google::APIClient::TransmissionError)
65 CLIENT.discovered_api('bogus')
66 end).should raise_error(Google::APIClient::TransmissionError)
69 it 'should raise an error for bogus services' do
71 CLIENT.discovered_api(42)
72 end).should raise_error(TypeError)
75 it 'should raise an error for bogus services' do
77 CLIENT.preferred_version(42)
78 end).should raise_error(TypeError)
81 it 'should raise an error for bogus methods' do
84 end).should raise_error(TypeError)
87 it 'should not return a preferred version for bogus service names' do
88 CLIENT.preferred_version('bogus').should == nil
91 describe 'with the prediction API' do
93 CLIENT.authorization = nil
94 # The prediction API no longer exposes a v1, so we have to be
95 # careful about looking up the wrong API version.
96 @prediction = CLIENT.discovered_api('prediction', 'v1.2')
99 it 'should correctly determine the discovery URI' do
100 CLIENT.discovery_uri('prediction').should ===
101 'https://www.googleapis.com/discovery/v1/apis/prediction/v1/rest'
104 it 'should correctly determine the discovery URI if :user_ip is set' do
105 CLIENT.user_ip = '127.0.0.1'
107 conn = stub_connection do |stub|
108 stub.get('/discovery/v1/apis/prediction/v1.2/rest?userIp=127.0.0.1') do |env|
112 :http_method => 'GET',
113 :uri => CLIENT.discovery_uri('prediction', 'v1.2'),
114 :authenticated => false,
120 it 'should correctly determine the discovery URI if :key is set' do
121 CLIENT.key = 'qwerty'
122 conn = stub_connection do |stub|
123 stub.get('/discovery/v1/apis/prediction/v1.2/rest?key=qwerty') 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 determine the discovery URI if both are set' do
136 CLIENT.key = 'qwerty'
137 CLIENT.user_ip = '127.0.0.1'
138 conn = stub_connection do |stub|
139 stub.get('/discovery/v1/apis/prediction/v1.2/rest?key=qwerty&userIp=127.0.0.1') do |env|
142 request = CLIENT.execute(
143 :http_method => 'GET',
144 :uri => CLIENT.discovery_uri('prediction', 'v1.2'),
145 :authenticated => false,
151 it 'should correctly generate API objects' do
152 CLIENT.discovered_api('prediction', 'v1.2').name.should == 'prediction'
153 CLIENT.discovered_api('prediction', 'v1.2').version.should == 'v1.2'
154 CLIENT.discovered_api(:prediction, 'v1.2').name.should == 'prediction'
155 CLIENT.discovered_api(:prediction, 'v1.2').version.should == 'v1.2'
158 it 'should discover methods' do
159 CLIENT.discovered_method(
160 'prediction.training.insert', 'prediction', 'v1.2'
161 ).name.should == 'insert'
162 CLIENT.discovered_method(
163 :'prediction.training.insert', :prediction, 'v1.2'
164 ).name.should == 'insert'
165 CLIENT.discovered_method(
166 'prediction.training.delete', 'prediction', 'v1.2'
167 ).name.should == 'delete'
170 it 'should define the origin API in discovered methods' do
171 CLIENT.discovered_method(
172 'prediction.training.insert', 'prediction', 'v1.2'
173 ).api.name.should == 'prediction'
176 it 'should not find methods that are not in the discovery document' do
177 CLIENT.discovered_method(
178 'prediction.bogus', 'prediction', 'v1.2'
182 it 'should raise an error for bogus methods' do
184 CLIENT.discovered_method(42, 'prediction', 'v1.2')
185 end).should raise_error(TypeError)
188 it 'should raise an error for bogus methods' do
190 CLIENT.execute(:api_method => CLIENT.discovered_api('prediction', 'v1.2'))
191 end).should raise_error(TypeError)
194 it 'should correctly determine the preferred version' do
195 CLIENT.preferred_version('prediction').version.should_not == 'v1'
196 CLIENT.preferred_version(:prediction).version.should_not == 'v1'
199 it 'should return a batch path' do
200 CLIENT.discovered_api('prediction', 'v1.2').batch_path.should_not be_nil
203 it 'should generate valid requests' do
204 conn = stub_connection do |stub|
205 stub.post('/prediction/v1.2/training?data=12345') do |env|
206 env[:body].should == ''
209 request = CLIENT.execute(
210 :api_method => @prediction.training.insert,
211 :parameters => {'data' => '12345'},
217 it 'should generate valid requests when repeated parameters are passed' do
218 pending("This is caused by Faraday's encoding of query parameters.")
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'], ['data','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.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' +
419 '?collection=public&userId=107807692475771887386') do |env|
423 request = CLIENT.execute(
424 :api_method => @plus.activities.list,
426 'userId' => '107807692475771887386', 'collection' => 'public'
428 :authenticated => false,
434 it 'should correctly validate parameters' do
437 :api_method => @plus.activities.list,
438 :parameters => {'alt' => 'json'},
439 :authenticated => false
441 end).should raise_error(ArgumentError)
444 it 'should correctly validate parameters' do
447 :api_method => @plus.activities.list,
449 'userId' => '107807692475771887386', 'collection' => 'bogus'
451 :authenticated => false
452 ).to_env(Faraday.default_connection)
453 end).should raise_error(ArgumentError)
458 describe 'with the latitude API' do
460 CLIENT.authorization = nil
461 @latitude = CLIENT.discovered_api('latitude')
464 it 'should correctly determine the discovery URI' do
465 CLIENT.discovery_uri('latitude').should ===
466 'https://www.googleapis.com/discovery/v1/apis/latitude/v1/rest'
469 it 'should find APIs that are in the discovery document' do
470 CLIENT.discovered_api('latitude').name.should == 'latitude'
471 CLIENT.discovered_api('latitude').version.should == 'v1'
474 it 'should return a batch path' do
475 CLIENT.discovered_api('latitude').batch_path.should_not be_nil
478 it 'should find methods that are in the discovery document' do
479 CLIENT.discovered_method(
480 'latitude.currentLocation.get', 'latitude'
481 ).name.should == 'get'
484 it 'should define the origin API in discovered methods' do
485 CLIENT.discovered_method(
486 'latitude.currentLocation.get', 'latitude'
487 ).api.name.should == 'latitude'
490 it 'should not find methods that are not in the discovery document' do
491 CLIENT.discovered_method('latitude.bogus', 'latitude').should == nil
494 it 'should generate requests against the correct URIs' do
495 request = CLIENT.generate_request(
496 :api_method => 'latitude.currentLocation.get',
497 :authenticated => false
499 request.to_env(Faraday.default_connection)[:url].to_s.should ===
500 'https://www.googleapis.com/latitude/v1/currentLocation'
503 it 'should generate requests against the correct URIs' do
504 request = CLIENT.generate_request(
505 :api_method => @latitude.current_location.get,
506 :authenticated => false
508 request.to_env(Faraday.default_connection)[:url].to_s.should ===
509 'https://www.googleapis.com/latitude/v1/currentLocation'
512 it 'should not be able to execute requests without authorization' do
513 result = CLIENT.execute(
514 :api_method => 'latitude.currentLocation.get',
515 :authenticated => false
517 result.response.status.should == 401
522 describe 'with the moderator API' do
524 CLIENT.authorization = nil
525 @moderator = CLIENT.discovered_api('moderator')
528 it 'should correctly determine the discovery URI' do
529 CLIENT.discovery_uri('moderator').should ===
530 'https://www.googleapis.com/discovery/v1/apis/moderator/v1/rest'
533 it 'should find APIs that are in the discovery document' do
534 CLIENT.discovered_api('moderator').name.should == 'moderator'
535 CLIENT.discovered_api('moderator').version.should == 'v1'
538 it 'should find methods that are in the discovery document' do
539 CLIENT.discovered_method(
540 'moderator.profiles.get', 'moderator'
541 ).name.should == 'get'
544 it 'should define the origin API in discovered methods' do
545 CLIENT.discovered_method(
546 'moderator.profiles.get', 'moderator'
547 ).api.name.should == 'moderator'
550 it 'should not find methods that are not in the discovery document' do
551 CLIENT.discovered_method('moderator.bogus', 'moderator').should == nil
554 it 'should return a batch path' do
555 CLIENT.discovered_api('moderator').batch_path.should_not be_nil
558 it 'should generate requests against the correct URIs' do
559 conn = stub_connection do |stub|
560 stub.get('/moderator/v1/profiles/@me') do |env|
563 request = CLIENT.execute(
564 :api_method => @moderator.profiles.get,
565 :authenticated => false,
571 it 'should not be able to execute requests without authorization' do
572 result = CLIENT.execute(
573 @moderator.profiles.get,
577 {:authenticated => false}
579 result.response.status.should == 401
583 describe 'with the adsense API' do
585 CLIENT.authorization = nil
586 @adsense = CLIENT.discovered_api('adsense', 'v1')
589 it 'should correctly determine the discovery URI' do
590 CLIENT.discovery_uri('adsense').should ===
591 'https://www.googleapis.com/discovery/v1/apis/adsense/v1/rest'
594 it 'should find APIs that are in the discovery document' do
595 CLIENT.discovered_api('adsense').name.should == 'adsense'
596 CLIENT.discovered_api('adsense').version.should == 'v1'
599 it 'should return a batch path' do
600 CLIENT.discovered_api('adsense').batch_path.should_not be_nil
603 it 'should find methods that are in the discovery document' do
604 CLIENT.discovered_method(
605 'adsense.reports.generate', 'adsense'
606 ).name.should == 'generate'
609 it 'should not find methods that are not in the discovery document' do
610 CLIENT.discovered_method('adsense.bogus', 'adsense').should == nil
613 it 'should generate requests against the correct URIs' do
614 conn = stub_connection do |stub|
615 stub.get('/adsense/v1/adclients') do |env|
618 request = CLIENT.execute(
619 :api_method => @adsense.adclients.list,
620 :authenticated => false,
626 it 'should not be able to execute requests without authorization' do
627 result = CLIENT.execute(
628 :api_method => @adsense.adclients.list,
629 :authenticated => false
631 result.response.status.should == 401
634 it 'should fail when validating missing required parameters' do
637 :api_method => @adsense.reports.generate,
638 :authenticated => false
640 end).should raise_error(ArgumentError)
643 it 'should succeed when validating parameters in a correct call' do
644 conn = stub_connection do |stub|
645 stub.get('/adsense/v1/reports?dimension=DATE&endDate=2010-01-01&metric=PAGE_VIEWS&startDate=2000-01-01') do |env|
650 :api_method => @adsense.reports.generate,
652 'startDate' => '2000-01-01',
653 'endDate' => '2010-01-01',
654 'dimension' => 'DATE',
655 'metric' => 'PAGE_VIEWS'
657 :authenticated => false,
660 end).should_not raise_error
664 it 'should fail when validating parameters with invalid values' do
667 :api_method => @adsense.reports.generate,
669 'startDate' => '2000-01-01',
670 'endDate' => '2010-01-01',
671 'dimension' => 'BAD_CHARACTERS=-&*(£&',
672 'metric' => 'PAGE_VIEWS'
674 :authenticated => false
676 end).should raise_error(ArgumentError)
679 it 'should succeed when validating repeated parameters in a correct call' do
680 conn = stub_connection do |stub|
681 stub.get('/adsense/v1/reports?dimension%5B%5D=DATE&dimension%5B%5D=PRODUCT_CODE'+
682 '&endDate=2010-01-01&metric%5B%5D=CLICKS&metric%5B%5D=PAGE_VIEWS&'+
683 'startDate=2000-01-01') do |env|
688 :api_method => @adsense.reports.generate,
690 'startDate' => '2000-01-01',
691 'endDate' => '2010-01-01',
692 'dimension' => ['DATE', 'PRODUCT_CODE'],
693 'metric' => ['PAGE_VIEWS', 'CLICKS']
695 :authenticated => false,
698 end).should_not raise_error
702 it 'should fail when validating incorrect repeated parameters' do
705 :api_method => @adsense.reports.generate,
707 'startDate' => '2000-01-01',
708 'endDate' => '2010-01-01',
709 'dimension' => ['DATE', 'BAD_CHARACTERS=-&*(£&'],
710 'metric' => ['PAGE_VIEWS', 'CLICKS']
712 :authenticated => false
714 end).should raise_error(ArgumentError)
718 describe 'with the Drive API' do
720 CLIENT.authorization = nil
721 @drive = CLIENT.discovered_api('drive', 'v1')
724 it 'should include media upload info methods' do
725 @drive.files.insert.media_upload.should_not == nil
728 it 'should include accepted media types' do
729 @drive.files.insert.media_upload.accepted_types.should_not be_empty
732 it 'should have an upload path' do
733 @drive.files.insert.media_upload.uri_template.should_not == nil
736 it 'should have a max file size' do
737 @drive.files.insert.media_upload.max_size.should_not == nil