Use discovered 'rootUrl' as base URI for services
[arvados.git] / spec / google / api_client / discovery_spec.rb
index 3728e2c1e86a38f4ac49782634e3abc306f48ea6..d9acf3374eab2ee28f9b45eada0d4f7de5a80ed6 100644 (file)
 require 'spec_helper'
 
 require 'faraday'
-require 'faraday/utils'
 require 'multi_json'
 require 'compat/multi_json'
 require 'signet/oauth_1/client'
 require 'google/api_client'
-require 'google/api_client/version'
 
-describe Google::APIClient do
+fixtures_path = File.expand_path('../../../fixtures', __FILE__)
+
+RSpec.describe Google::APIClient do
   include ConnectionHelpers
   CLIENT = Google::APIClient.new(:application_name => 'API Client Tests') unless defined?(CLIENT)
 
@@ -36,42 +36,51 @@ describe Google::APIClient do
   end
 
   it 'should raise a type error for bogus authorization' do
-    (lambda do
+    expect(lambda do
       Google::APIClient.new(:application_name => 'API Client Tests', :authorization => 42)
-    end).should raise_error(TypeError)
+    end).to raise_error(TypeError)
   end
 
   it 'should not be able to retrieve the discovery document for a bogus API' do
-    (lambda do
+    expect(lambda do
       CLIENT.discovery_document('bogus')
-    end).should raise_error(Google::APIClient::TransmissionError)
-    (lambda do
+    end).to raise_error(Google::APIClient::TransmissionError)
+    expect(lambda do
       CLIENT.discovered_api('bogus')
-    end).should raise_error(Google::APIClient::TransmissionError)
+    end).to raise_error(Google::APIClient::TransmissionError)
   end
 
   it 'should raise an error for bogus services' do
-    (lambda do
+    expect(lambda do
       CLIENT.discovered_api(42)
-    end).should raise_error(TypeError)
+    end).to raise_error(TypeError)
   end
 
   it 'should raise an error for bogus services' do
-    (lambda do
+    expect(lambda do
       CLIENT.preferred_version(42)
-    end).should raise_error(TypeError)
+    end).to raise_error(TypeError)
   end
 
   it 'should raise an error for bogus methods' do
-    (lambda do
+    expect(lambda do
       CLIENT.execute(42)
-    end).should raise_error(TypeError)
+    end).to raise_error(TypeError)
   end
 
   it 'should not return a preferred version for bogus service names' do
-    CLIENT.preferred_version('bogus').should == nil
+    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
@@ -81,15 +90,16 @@ describe Google::APIClient do
     end
 
     it 'should correctly determine the discovery URI' do
-      CLIENT.discovery_uri('prediction').should ===
+      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(
@@ -105,6 +115,7 @@ describe Google::APIClient 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(
@@ -121,6 +132,7 @@ describe Google::APIClient do
       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(
@@ -133,61 +145,62 @@ describe Google::APIClient do
     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'
+      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
-      CLIENT.discovered_method(
+      expect(CLIENT.discovered_method(
         'prediction.training.insert', 'prediction', 'v1.2'
-      ).name.should == 'insert'
-      CLIENT.discovered_method(
+      ).name).to eq('insert')
+      expect(CLIENT.discovered_method(
         :'prediction.training.insert', :prediction, 'v1.2'
-      ).name.should == 'insert'
-      CLIENT.discovered_method(
+      ).name).to eq('insert')
+      expect(CLIENT.discovered_method(
         'prediction.training.delete', 'prediction', 'v1.2'
-      ).name.should == 'delete'
+      ).name).to eq('delete')
     end
 
     it 'should define the origin API in discovered methods' do
-      CLIENT.discovered_method(
+      expect(CLIENT.discovered_method(
         'prediction.training.insert', 'prediction', 'v1.2'
-      ).api.name.should == 'prediction'
+      ).api.name).to eq('prediction')
     end
 
     it 'should not find methods that are not in the discovery document' do
-      CLIENT.discovered_method(
+      expect(CLIENT.discovered_method(
         'prediction.bogus', 'prediction', 'v1.2'
-      ).should == nil
+      )).to eq(nil)
     end
 
     it 'should raise an error for bogus methods' do
-      (lambda do
+      expect(lambda do
         CLIENT.discovered_method(42, 'prediction', 'v1.2')
-      end).should raise_error(TypeError)
+      end).to raise_error(TypeError)
     end
 
     it 'should raise an error for bogus methods' do
-      (lambda do
+      expect(lambda do
         CLIENT.execute(:api_method => CLIENT.discovered_api('prediction', 'v1.2'))
-      end).should raise_error(TypeError)
+      end).to 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'
+      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
-      CLIENT.discovered_api('prediction', 'v1.2').batch_path.should_not be_nil
+      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|
-          env[:body].should == ''
+          expect(env[:body]).to eq('')
+          [200, {}, '{}']
         end
       end
       request = CLIENT.execute(
@@ -200,11 +213,12 @@ describe Google::APIClient do
 
     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 
+        # 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 == ''
+          expect(env[:body]).to eq('')
+          [200, {}, '{}']
         end
       end
       request = CLIENT.execute(
@@ -218,7 +232,8 @@ describe Google::APIClient do
     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|
-           env.params['data'].should include('1', '2')
+           expect(env.params['data']).to include('1', '2')
+          [200, {}, '{}']
          end
        end
       request = CLIENT.execute(
@@ -232,6 +247,7 @@ describe Google::APIClient do
     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(
@@ -245,6 +261,7 @@ describe Google::APIClient do
     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(
@@ -264,10 +281,11 @@ describe Google::APIClient do
 
       conn = stub_connection do |stub|
         stub.post('/prediction/v1.2/training') do |env|
-          env[:url].host.should == 'testing-domain.example.com'
+          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'},
@@ -283,8 +301,9 @@ describe Google::APIClient do
 
       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/
+          expect(env[:request_headers]).to have_key('Authorization')
+          expect(env[:request_headers]['Authorization']).to match(/^OAuth/)
+          [200, {}, '{}']
         end
       end
 
@@ -302,8 +321,9 @@ describe Google::APIClient do
 
       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/
+          expect(env[:request_headers]).to have_key('Authorization')
+          expect(env[:request_headers]['Authorization']).to match(/^Bearer/)
+          [200, {}, '{}']          
         end
       end
 
@@ -323,7 +343,7 @@ describe Google::APIClient do
         @prediction.training.insert,
         {'data' => '12345'}
       )
-      result.response.status.should == 401
+      expect(result.response.status).to eq(401)
     end
 
     it 'should not be able to execute improperly authorized requests' do
@@ -333,11 +353,11 @@ describe Google::APIClient do
         @prediction.training.insert,
         {'data' => '12345'}
       )
-      result.response.status.should == 401
+      expect(result.response.status).to eq(401)
     end
 
     it 'should not be able to execute improperly authorized requests' do
-      (lambda do
+      expect(lambda do
         CLIENT.authorization = :oauth_1
         CLIENT.authorization.token_credential_key = '12345'
         CLIENT.authorization.token_credential_secret = '12345'
@@ -345,25 +365,26 @@ describe Google::APIClient do
           @prediction.training.insert,
           {'data' => '12345'}
         )
-      end).should raise_error(Google::APIClient::ClientError)
+      end).to raise_error(Google::APIClient::ClientError)
     end
 
     it 'should not be able to execute improperly authorized requests' do
-      (lambda do
+      expect(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).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|
-          env[:request_headers].should have_key('Content-Type')
-          env[:request_headers]['Content-Type'].should == 'application/json'
+          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
@@ -385,40 +406,41 @@ describe Google::APIClient do
     end
 
     it 'should correctly determine the discovery URI' do
-      CLIENT.discovery_uri('plus').should ===
+      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
-      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'
+      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
-      CLIENT.discovered_method(
+      expect(CLIENT.discovered_method(
         'plus.activities.list', 'plus'
-      ).name.should == 'list'
+      ).name).to eq('list')
     end
 
     it 'should define the origin API in discovered methods' do
-      CLIENT.discovered_method(
+      expect(CLIENT.discovered_method(
         'plus.activities.list', 'plus'
-      ).api.name.should == 'plus'
+      ).api.name).to eq('plus')
     end
 
     it 'should not find methods that are not in the discovery document' do
-      CLIENT.discovered_method('plus.bogus', 'plus').should == nil
+      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 => {
@@ -431,17 +453,17 @@ describe Google::APIClient do
     end
 
     it 'should correctly validate parameters' do
-      (lambda do
+      expect(lambda do
         CLIENT.execute(
           :api_method => @plus.activities.list,
           :parameters => {'alt' => 'json'},
           :authenticated => false
         )
-      end).should raise_error(ArgumentError)
+      end).to raise_error(ArgumentError)
     end
 
     it 'should correctly validate parameters' do
-      (lambda do
+      expect(lambda do
         CLIENT.execute(
           :api_method => @plus.activities.list,
           :parameters => {
@@ -449,7 +471,11 @@ describe Google::APIClient do
           },
           :authenticated => false
         ).to_env(CLIENT.connection)
-      end).should raise_error(ArgumentError)
+      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
 
@@ -460,32 +486,33 @@ describe Google::APIClient do
     end
 
     it 'should correctly determine the discovery URI' do
-      CLIENT.discovery_uri('adsense', 'v1.3').to_s.should ===
+      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
-      CLIENT.discovered_api('adsense', 'v1.3').name.should == 'adsense'
-      CLIENT.discovered_api('adsense', 'v1.3').version.should == 'v1.3'
+      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
-      CLIENT.discovered_api('adsense', 'v1.3').batch_path.should_not be_nil
+      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
-      CLIENT.discovered_method(
-        'adsense.reports.generate', 'adsense'
-      ).name.should == 'generate'
+      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
-      CLIENT.discovered_method('adsense.bogus', 'adsense').should == nil
+      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(
@@ -501,24 +528,25 @@ describe Google::APIClient do
         :api_method => @adsense.adclients.list,
         :authenticated => false
       )
-      result.response.status.should == 401
+      expect(result.response.status).to eq(401)
     end
 
     it 'should fail when validating missing required parameters' do
-      (lambda do
+      expect(lambda do
         CLIENT.execute(
           :api_method => @adsense.reports.generate,
           :authenticated => false
         )
-      end).should raise_error(ArgumentError)
+      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
-      (lambda do
+      expect(lambda do
         CLIENT.execute(
           :api_method => @adsense.reports.generate,
           :parameters => {
@@ -530,12 +558,12 @@ describe Google::APIClient do
           :authenticated => false,
           :connection => conn
         )
-      end).should_not raise_error
+      end).not_to raise_error
       conn.verify
     end
 
     it 'should fail when validating parameters with invalid values' do
-      (lambda do
+      expect(lambda do
         CLIENT.execute(
           :api_method => @adsense.reports.generate,
           :parameters => {
@@ -546,7 +574,7 @@ describe Google::APIClient do
           },
           :authenticated => false
         )
-      end).should raise_error(ArgumentError)
+      end).to raise_error(ArgumentError)
     end
 
     it 'should succeed when validating repeated parameters in a correct call' do
@@ -554,9 +582,10 @@ describe Google::APIClient do
         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
-      (lambda do
+      expect(lambda do
         CLIENT.execute(
           :api_method => @adsense.reports.generate,
           :parameters => {
@@ -568,12 +597,12 @@ describe Google::APIClient do
           :authenticated => false,
           :connection => conn
         )
-      end).should_not raise_error
+      end).not_to raise_error
       conn.verify
     end
 
     it 'should fail when validating incorrect repeated parameters' do
-      (lambda do
+      expect(lambda do
         CLIENT.execute(
           :api_method => @adsense.reports.generate,
           :parameters => {
@@ -584,7 +613,7 @@ describe Google::APIClient do
           },
           :authenticated => false
         )
-      end).should raise_error(ArgumentError)
+      end).to raise_error(ArgumentError)
     end
 
     it 'should generate valid requests when multivalued parameters are passed' do
@@ -592,8 +621,9 @@ describe Google::APIClient do
          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|
-           env.params['dimension'].should include('DATE', 'PRODUCT_CODE')
-           env.params['metric'].should include('CLICKS', 'PAGE_VIEWS')
+           expect(env.params['dimension']).to include('DATE', 'PRODUCT_CODE')
+           expect(env.params['metric']).to include('CLICKS', 'PAGE_VIEWS')
+          [200, {}, '{}']
          end
        end
       request = CLIENT.execute(
@@ -618,19 +648,45 @@ describe Google::APIClient do
     end
 
     it 'should include media upload info methods' do
-      @drive.files.insert.media_upload.should_not == nil
+      expect(@drive.files.insert.media_upload).not_to eq(nil)
     end
 
     it 'should include accepted media types' do
-      @drive.files.insert.media_upload.accepted_types.should_not be_empty
+      expect(@drive.files.insert.media_upload.accepted_types).not_to be_empty
     end
 
     it 'should have an upload path' do
-      @drive.files.insert.media_upload.uri_template.should_not == nil
+      expect(@drive.files.insert.media_upload.uri_template).not_to eq(nil)
     end
 
     it 'should have a max file size' do
-      @drive.files.insert.media_upload.max_size.should_not == nil
+      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 correctly determine the service root_uri' do
+      expect(@pubsub.root_uri.to_s).to eq('https://pubsub.googleapis.com/')
     end
   end
 end