google-api-ruby-client/spec/google/api_client/discovery_spec.rb

695 lines
22 KiB
Ruby
Raw Normal View History

# encoding:utf-8
# Copyright 2010 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'spec_helper'
require 'faraday'
require 'faraday/utils'
2012-01-05 10:05:56 +00:00
require 'multi_json'
2012-08-30 09:15:59 +00:00
require 'compat/multi_json'
require 'signet/oauth_1/client'
require 'google/api_client'
require 'google/api_client/version'
2012-09-24 23:09:17 +00:00
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
2012-09-24 23:09:17 +00:00
include ConnectionHelpers
CLIENT = Google::APIClient.new(:application_name => 'API Client Tests') unless defined?(CLIENT)
after do
# Reset client to not-quite-pristine state
CLIENT.key = nil
CLIENT.user_ip = nil
end
it 'should raise a type error for bogus authorization' do
(lambda do
Google::APIClient.new(:application_name => 'API Client Tests', :authorization => 42)
end).should raise_error(TypeError)
end
it 'should not be able to retrieve the discovery document for a bogus API' do
(lambda do
CLIENT.discovery_document('bogus')
end).should raise_error(Google::APIClient::TransmissionError)
(lambda do
CLIENT.discovered_api('bogus')
end).should raise_error(Google::APIClient::TransmissionError)
end
it 'should raise an error for bogus services' do
(lambda do
CLIENT.discovered_api(42)
end).should raise_error(TypeError)
end
it 'should raise an error for bogus services' do
(lambda do
CLIENT.preferred_version(42)
end).should raise_error(TypeError)
end
it 'should raise an error for bogus methods' do
(lambda do
2012-09-24 23:09:17 +00:00
CLIENT.execute(42)
end).should raise_error(TypeError)
end
it 'should not return a preferred version for bogus service names' do
CLIENT.preferred_version('bogus').should == nil
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
CLIENT.discovery_uri('prediction').should ===
'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'
2012-09-24 23:09:17 +00:00
conn = stub_connection do |stub|
stub.get('/discovery/v1/apis/prediction/v1.2/rest?userIp=127.0.0.1') do |env|
end
end
CLIENT.execute(
:http_method => 'GET',
:uri => CLIENT.discovery_uri('prediction', 'v1.2'),
2012-09-24 23:09:17 +00:00
:authenticated => false,
:connection => conn
)
2012-09-24 23:09:17 +00:00
conn.verify
end
it 'should correctly determine the discovery URI if :key is set' do
CLIENT.key = 'qwerty'
2012-09-24 23:09:17 +00:00
conn = stub_connection do |stub|
stub.get('/discovery/v1/apis/prediction/v1.2/rest?key=qwerty') do |env|
end
end
request = CLIENT.execute(
:http_method => 'GET',
:uri => CLIENT.discovery_uri('prediction', 'v1.2'),
2012-09-24 23:09:17 +00:00
: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'
2012-09-24 23:09:17 +00:00
conn = stub_connection do |stub|
stub.get('/discovery/v1/apis/prediction/v1.2/rest?key=qwerty&userIp=127.0.0.1') do |env|
end
end
request = CLIENT.execute(
:http_method => 'GET',
:uri => CLIENT.discovery_uri('prediction', 'v1.2'),
2012-09-24 23:09:17 +00:00
:authenticated => false,
:connection => conn
)
conn.verify
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'
end
it 'should discover methods' do
CLIENT.discovered_method(
'prediction.training.insert', 'prediction', 'v1.2'
).name.should == 'insert'
CLIENT.discovered_method(
:'prediction.training.insert', :prediction, 'v1.2'
).name.should == 'insert'
CLIENT.discovered_method(
'prediction.training.delete', 'prediction', 'v1.2'
).name.should == 'delete'
end
2012-05-16 19:05:24 +00:00
it 'should define the origin API in discovered methods' do
CLIENT.discovered_method(
2012-05-16 19:05:24 +00:00
'prediction.training.insert', 'prediction', 'v1.2'
).api.name.should == 'prediction'
end
it 'should not find methods that are not in the discovery document' do
CLIENT.discovered_method(
'prediction.bogus', 'prediction', 'v1.2'
).should == nil
end
it 'should raise an error for bogus methods' do
(lambda do
CLIENT.discovered_method(42, 'prediction', 'v1.2')
end).should raise_error(TypeError)
end
it 'should raise an error for bogus methods' do
(lambda do
2012-09-24 23:09:17 +00:00
CLIENT.execute(:api_method => CLIENT.discovered_api('prediction', 'v1.2'))
end).should 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'
end
2012-05-16 19:05:24 +00:00
it 'should return a batch path' do
CLIENT.discovered_api('prediction', 'v1.2').batch_path.should_not be_nil
2012-05-16 19:05:24 +00:00
end
it 'should generate valid requests' do
2012-09-24 23:09:17 +00:00
conn = stub_connection do |stub|
stub.post('/prediction/v1.2/training?data=12345') do |env|
env[:body].should == ''
end
end
request = CLIENT.execute(
:api_method => @prediction.training.insert,
2012-09-24 23:09:17 +00:00
:parameters => {'data' => '12345'},
:connection => conn
)
2012-09-24 23:09:17 +00:00
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|
env[:body].should == ''
end
end
request = CLIENT.execute(
:api_method => @prediction.training.insert,
:parameters => {'data' => '12345;67890'},
:connection => conn
)
conn.verify
end
2011-12-01 14:04:40 +00:00
it 'should generate valid requests when repeated parameters are passed' do
2012-10-10 16:47:02 +00:00
pending("This is caused by Faraday's encoding of query parameters.")
2012-09-24 23:09:17 +00:00
conn = stub_connection do |stub|
stub.post('/prediction/v1.2/training?data=1&data=2') do |env|
env[:params]['data'].should include('1', '2')
end
end
request = CLIENT.execute(
2011-12-01 14:04:40 +00:00
:api_method => @prediction.training.insert,
2012-09-24 23:09:17 +00:00
:parameters => [['data', '1'], ['data','2']],
:connection => conn
2011-12-01 14:04:40 +00:00
)
2012-09-24 23:09:17 +00:00
conn.verify
2011-12-01 14:04:40 +00:00
end
it 'should generate requests against the correct URIs' do
2012-09-24 23:09:17 +00:00
conn = stub_connection do |stub|
stub.post('/prediction/v1.2/training?data=12345') do |env|
end
end
request = CLIENT.execute(
:api_method => @prediction.training.insert,
2012-09-24 23:09:17 +00:00
:parameters => {'data' => '12345'},
:connection => conn
)
2012-09-24 23:09:17 +00:00
conn.verify
end
it 'should generate requests against the correct URIs' do
2012-09-24 23:09:17 +00:00
conn = stub_connection do |stub|
stub.post('/prediction/v1.2/training?data=12345') do |env|
end
end
request = CLIENT.execute(
:api_method => @prediction.training.insert,
2012-09-24 23:09:17 +00:00
:parameters => {'data' => '12345'},
:connection => conn
)
2012-09-24 23:09:17 +00:00
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/'
2012-09-24 23:09:17 +00:00
conn = stub_connection do |stub|
stub.post('/prediction/v1.2/training') do |env|
env[:url].host.should == 'testing-domain.example.com'
end
end
request = CLIENT.execute(
:api_method => prediction_rebase.training.insert,
2012-09-24 23:09:17 +00:00
:parameters => {'data' => '123'},
:connection => conn
)
2012-09-24 23:09:17 +00:00
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'
2012-09-24 23:09:17 +00:00
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/
end
end
request = CLIENT.execute(
:api_method => @prediction.training.insert,
2012-09-24 23:09:17 +00:00
:parameters => {'data' => '12345'},
:connection => conn
)
2012-09-24 23:09:17 +00:00
conn.verify
end
it 'should generate OAuth 2 requests' do
CLIENT.authorization = :oauth_2
CLIENT.authorization.access_token = '12345'
2012-09-24 23:09:17 +00:00
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/
end
end
request = CLIENT.execute(
:api_method => @prediction.training.insert,
2012-09-24 23:09:17 +00:00
:parameters => {'data' => '12345'},
:connection => conn
)
2012-09-24 23:09:17 +00:00
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'}
)
result.response.status.should == 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'}
)
result.response.status.should == 401
end
it 'should not be able to execute improperly authorized requests' do
(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).should raise_error(Google::APIClient::ClientError)
end
it 'should not be able to execute improperly authorized requests' do
(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
it 'should correctly handle unnamed parameters' do
2012-09-24 23:09:17 +00:00
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'
end
end
CLIENT.authorization = :oauth_2
CLIENT.authorization.access_token = '12345'
2012-09-24 23:09:17 +00:00
CLIENT.execute(
:api_method => @prediction.training.insert,
:body => MultiJson.dump({"id" => "bucket/object"}),
:headers => {'Content-Type' => 'application/json'},
:connection => conn
)
2012-09-24 23:09:17 +00:00
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
CLIENT.discovery_uri('plus').should ===
'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'
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(
'plus.activities.list', 'plus'
).name.should == 'list'
end
2012-05-16 19:05:24 +00:00
it 'should define the origin API in discovered methods' do
CLIENT.discovered_method(
2012-05-16 19:05:24 +00:00
'plus.activities.list', 'plus'
).api.name.should == 'plus'
end
it 'should not find methods that are not in the discovery document' do
CLIENT.discovered_method('plus.bogus', 'plus').should == nil
end
it 'should generate requests against the correct URIs' do
2012-09-24 23:09:17 +00:00
conn = stub_connection do |stub|
stub.get('/plus/v1/people/107807692475771887386/activities/public') do |env|
2012-09-24 23:09:17 +00:00
end
end
request = CLIENT.execute(
:api_method => @plus.activities.list,
:parameters => {
'userId' => '107807692475771887386', 'collection' => 'public'
},
2012-09-24 23:09:17 +00:00
:authenticated => false,
:connection => conn
)
2012-09-24 23:09:17 +00:00
conn.verify
end
it 'should correctly validate parameters' do
(lambda do
2012-09-24 23:09:17 +00:00
CLIENT.execute(
:api_method => @plus.activities.list,
:parameters => {'alt' => 'json'},
:authenticated => false
2012-09-24 23:09:17 +00:00
)
end).should raise_error(ArgumentError)
end
it 'should correctly validate parameters' do
(lambda do
2012-09-24 23:09:17 +00:00
CLIENT.execute(
:api_method => @plus.activities.list,
:parameters => {
'userId' => '107807692475771887386', 'collection' => 'bogus'
},
:authenticated => false
2012-09-24 23:09:17 +00:00
).to_env(Faraday.default_connection)
end).should raise_error(ArgumentError)
end
end
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
2012-05-16 19:05:24 +00:00
it 'should return a batch path' do
CLIENT.discovered_api('latitude').batch_path.should_not be_nil
2012-05-16 19:05:24 +00:00
end
it 'should find methods that are in the discovery document' do
CLIENT.discovered_method(
'latitude.currentLocation.get', 'latitude'
).name.should == 'get'
end
2012-05-16 19:05:24 +00:00
it 'should define the origin API in discovered methods' do
CLIENT.discovered_method(
2012-05-16 19:05:24 +00:00
'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.current_location.get,
:authenticated => false
)
2012-09-24 23:09:17 +00:00
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
)
2012-09-24 23:09:17 +00:00
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.current_location.get,
:authenticated => false
)
result.response.status.should == 401
end
end
describe 'with the adsense API' do
before do
CLIENT.authorization = nil
@adsense = CLIENT.discovered_api('adsense', 'v1')
end
it 'should correctly determine the discovery URI' do
CLIENT.discovery_uri('adsense').should ===
'https://www.googleapis.com/discovery/v1/apis/adsense/v1/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'
end
2012-05-16 19:05:24 +00:00
it 'should return a batch path' do
CLIENT.discovered_api('adsense').batch_path.should_not be_nil
2012-05-16 19:05:24 +00:00
end
it 'should find methods that are in the discovery document' do
CLIENT.discovered_method(
'adsense.reports.generate', 'adsense'
).name.should == 'generate'
end
it 'should not find methods that are not in the discovery document' do
CLIENT.discovered_method('adsense.bogus', 'adsense').should == nil
end
it 'should generate requests against the correct URIs' do
2012-09-24 23:09:17 +00:00
conn = stub_connection do |stub|
stub.get('/adsense/v1/adclients') do |env|
end
end
request = CLIENT.execute(
:api_method => @adsense.adclients.list,
2012-09-24 23:09:17 +00:00
:authenticated => false,
:connection => conn
)
2012-09-24 23:09:17 +00:00
conn.verify
end
it 'should not be able to execute requests without authorization' do
result = CLIENT.execute(
:api_method => @adsense.adclients.list,
:authenticated => false
)
result.response.status.should == 401
end
it 'should fail when validating missing required parameters' do
(lambda do
2012-09-24 23:09:17 +00:00
CLIENT.execute(
:api_method => @adsense.reports.generate,
:authenticated => false
2012-09-24 23:09:17 +00:00
)
end).should raise_error(ArgumentError)
end
it 'should succeed when validating parameters in a correct call' do
2012-09-24 23:09:17 +00:00
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|
end
end
(lambda do
2012-09-24 23:09:17 +00:00
CLIENT.execute(
:api_method => @adsense.reports.generate,
:parameters => {
'startDate' => '2000-01-01',
'endDate' => '2010-01-01',
'dimension' => 'DATE',
'metric' => 'PAGE_VIEWS'
},
2012-09-24 23:09:17 +00:00
:authenticated => false,
:connection => conn
)
end).should_not raise_error
2012-09-24 23:09:17 +00:00
conn.verify
end
it 'should fail when validating parameters with invalid values' do
(lambda do
2012-09-24 23:09:17 +00:00
CLIENT.execute(
:api_method => @adsense.reports.generate,
:parameters => {
'startDate' => '2000-01-01',
'endDate' => '2010-01-01',
'dimension' => 'BAD_CHARACTERS=-&*(£&',
'metric' => 'PAGE_VIEWS'
},
:authenticated => false
2012-09-24 23:09:17 +00:00
)
end).should raise_error(ArgumentError)
end
it 'should succeed when validating repeated parameters in a correct call' do
2013-02-15 22:25:25 +00:00
pending("This is caused by Faraday's encoding of query parameters.")
2012-09-24 23:09:17 +00:00
conn = stub_connection do |stub|
2013-02-15 22:25:25 +00:00
stub.get('/adsense/v1/reports?dimension=DATE&dimension=PRODUCT_CODE'+
'&endDate=2010-01-01&metric=CLICKS&metric=PAGE_VIEWS&'+
2012-09-24 23:09:17 +00:00
'startDate=2000-01-01') do |env|
end
end
(lambda do
2012-09-24 23:09:17 +00:00
CLIENT.execute(
:api_method => @adsense.reports.generate,
:parameters => {
'startDate' => '2000-01-01',
'endDate' => '2010-01-01',
'dimension' => ['DATE', 'PRODUCT_CODE'],
'metric' => ['PAGE_VIEWS', 'CLICKS']
},
2012-09-24 23:09:17 +00:00
:authenticated => false,
:connection => conn
)
end).should_not raise_error
2012-09-24 23:09:17 +00:00
conn.verify
end
it 'should fail when validating incorrect repeated parameters' do
(lambda do
2012-09-24 23:09:17 +00:00
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
2012-09-24 23:09:17 +00:00
)
end).should raise_error(ArgumentError)
end
end
2012-06-04 23:53:37 +00:00
describe 'with the Drive API' do
before do
CLIENT.authorization = nil
@drive = CLIENT.discovered_api('drive', 'v1')
2012-06-04 23:53:37 +00:00
end
2012-06-04 23:53:37 +00:00
it 'should include media upload info methods' do
@drive.files.insert.media_upload.should_not == nil
end
2012-06-04 23:53:37 +00:00
it 'should include accepted media types' do
@drive.files.insert.media_upload.accepted_types.should_not be_empty
end
2012-06-04 23:53:37 +00:00
it 'should have an upload path' do
@drive.files.insert.media_upload.uri_template.should_not == nil
end
2012-06-04 23:53:37 +00:00
it 'should have a max file size' do
@drive.files.insert.media_upload.max_size.should_not == nil
end
end
end