# 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 'multi_json' require 'compat/multi_json' require 'signet/oauth_1/client' require 'google/api_client' RSpec.describe Google::APIClient do 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 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 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 expect(lambda do CLIENT.discovered_api(42) end).to raise_error(TypeError) end it 'should raise an error for bogus services' do expect(lambda do CLIENT.preferred_version(42) end).to raise_error(TypeError) end it 'should raise an error for bogus methods' do 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 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 ) 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 ) 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 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 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 end