arvados-google-api-client 0.8.7.2

data/spec/google/api_client/simple_file_store_spec.rb

@@ -0,0 +1,133 @@
+# encoding:utf-8
+
+# Copyright 2013 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 'google/api_client/service/simple_file_store'
+
+RSpec.describe Google::APIClient::Service::SimpleFileStore do
+
+  FILE_NAME = 'test.cache'
+
+  describe 'with no cache file' do
+    before(:each) do
+      File.delete(FILE_NAME) if File.exists?(FILE_NAME)
+      @cache = Google::APIClient::Service::SimpleFileStore.new(FILE_NAME)
+    end
+
+    it 'should return nil when asked if a key exists' do
+      expect(@cache.exist?('invalid')).to be_nil
+      expect(File.exists?(FILE_NAME)).to be_falsey
+    end
+
+    it 'should return nil when asked to read a key' do
+      expect(@cache.read('invalid')).to be_nil
+      expect(File.exists?(FILE_NAME)).to be_falsey
+    end
+
+    it 'should return nil when asked to fetch a key' do
+      expect(@cache.fetch('invalid')).to be_nil
+      expect(File.exists?(FILE_NAME)).to be_falsey
+    end
+
+    it 'should create a cache file when asked to fetch a key with a default' do
+      expect(@cache.fetch('new_key') do
+        'value'
+      end).to eq('value')
+      expect(File.exists?(FILE_NAME)).to be_truthy
+    end
+
+    it 'should create a cache file when asked to write a key' do
+      @cache.write('new_key', 'value')
+      expect(File.exists?(FILE_NAME)).to be_truthy
+    end
+
+    it 'should return nil when asked to delete a key' do
+      expect(@cache.delete('invalid')).to be_nil
+      expect(File.exists?(FILE_NAME)).to be_falsey
+    end
+  end
+
+  describe 'with an existing cache' do
+    before(:each) do
+      File.delete(FILE_NAME) if File.exists?(FILE_NAME)
+      @cache = Google::APIClient::Service::SimpleFileStore.new(FILE_NAME)
+      @cache.write('existing_key', 'existing_value')
+    end
+
+    it 'should return true when asked if an existing key exists' do
+      expect(@cache.exist?('existing_key')).to be_truthy
+    end
+
+    it 'should return false when asked if a nonexistent key exists' do
+      expect(@cache.exist?('invalid')).to be_falsey
+    end
+
+    it 'should return the value for an existing key when asked to read it' do
+      expect(@cache.read('existing_key')).to eq('existing_value')
+    end
+
+    it 'should return nil for a nonexistent key when asked to read it' do
+      expect(@cache.read('invalid')).to be_nil
+    end
+
+    it 'should return the value for an existing key when asked to read it' do
+      expect(@cache.read('existing_key')).to eq('existing_value')
+    end
+
+    it 'should return nil for a nonexistent key when asked to fetch it' do
+      expect(@cache.fetch('invalid')).to be_nil
+    end
+
+    it 'should return and save the default value for a nonexistent key when asked to fetch it with a default' do
+      expect(@cache.fetch('new_key') do
+        'value'
+      end).to eq('value')
+      expect(@cache.read('new_key')).to eq('value')
+    end
+
+    it 'should remove an existing value and return true when asked to delete it' do
+      expect(@cache.delete('existing_key')).to be_truthy
+      expect(@cache.read('existing_key')).to be_nil
+    end
+
+    it 'should return false when asked to delete a nonexistent key' do
+      expect(@cache.delete('invalid')).to be_falsey
+    end
+
+    it 'should convert keys to strings when storing them' do
+      @cache.write(:symbol_key, 'value')
+      expect(@cache.read('symbol_key')).to eq('value')
+    end
+
+    it 'should convert keys to strings when reading them' do
+      expect(@cache.read(:existing_key)).to eq('existing_value')
+    end
+
+    it 'should convert keys to strings when fetching them' do
+      expect(@cache.fetch(:existing_key)).to eq('existing_value')
+    end
+
+    it 'should convert keys to strings when deleting them' do
+      expect(@cache.delete(:existing_key)).to be_truthy
+      expect(@cache.read('existing_key')).to be_nil
+    end
+  end
+
+  after(:all) do
+    File.delete(FILE_NAME) if File.exists?(FILE_NAME)
+  end
+end

data/spec/google/api_client_spec.rb

@@ -0,0 +1,352 @@
+# 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 'signet/oauth_1/client'
+require 'google/api_client'
+
+shared_examples_for 'configurable user agent' do
+  include ConnectionHelpers
+
+  it 'should allow the user agent to be modified' do
+    client.user_agent = 'Custom User Agent/1.2.3'
+    expect(client.user_agent).to eq('Custom User Agent/1.2.3')
+  end
+
+  it 'should allow the user agent to be set to nil' do
+    client.user_agent = nil
+    expect(client.user_agent).to eq(nil)
+  end
+
+  it 'should not allow the user agent to be used with bogus values' do
+    expect(lambda do
+      client.user_agent = 42
+      client.execute(:uri=>'https://www.google.com/')
+    end).to raise_error(TypeError)
+  end
+
+  it 'should transmit a User-Agent header when sending requests' do
+    client.user_agent = 'Custom User Agent/1.2.3'
+
+    conn = stub_connection do |stub|
+      stub.get('/') do |env|
+        headers = env[:request_headers]
+        expect(headers).to have_key('User-Agent')
+        expect(headers['User-Agent']).to eq(client.user_agent)
+        [200, {}, ['']]
+      end
+    end
+    client.execute(:uri=>'https://www.google.com/', :connection => conn)
+    conn.verify
+  end
+end
+
+RSpec.describe Google::APIClient do
+  include ConnectionHelpers
+
+  let(:client) { Google::APIClient.new(:application_name => 'API Client Tests') }
+
+  it "should pass the faraday options provided on initialization to FaraDay configuration block" do
+    client = Google::APIClient.new(faraday_option: {timeout: 999})
+    expect(client.connection.options.timeout).to be == 999
+  end
+
+  it 'should make its version number available' do
+    expect(Google::APIClient::VERSION::STRING).to be_instance_of(String)
+  end
+
+  it 'should default to OAuth 2' do
+    expect(Signet::OAuth2::Client).to be === client.authorization
+  end
+
+  describe 'configure for no authentication' do
+    before do
+      client.authorization = nil
+    end
+    it_should_behave_like 'configurable user agent'
+  end
+
+  describe 'configured for OAuth 1' do
+    before do
+      client.authorization = :oauth_1
+      client.authorization.token_credential_key = 'abc'
+      client.authorization.token_credential_secret = '123'
+    end
+
+    it 'should use the default OAuth1 client configuration' do
+      expect(client.authorization.temporary_credential_uri.to_s).to eq(
+        'https://www.google.com/accounts/OAuthGetRequestToken'
+      )
+      expect(client.authorization.authorization_uri.to_s).to include(
+        'https://www.google.com/accounts/OAuthAuthorizeToken'
+      )
+      expect(client.authorization.token_credential_uri.to_s).to eq(
+        'https://www.google.com/accounts/OAuthGetAccessToken'
+      )
+      expect(client.authorization.client_credential_key).to eq('anonymous')
+      expect(client.authorization.client_credential_secret).to eq('anonymous')
+    end
+
+    it_should_behave_like 'configurable user agent'
+  end
+
+  describe 'configured for OAuth 2' do
+    before do
+      client.authorization = :oauth_2
+      client.authorization.access_token = '12345'
+    end
+
+    # TODO
+    it_should_behave_like 'configurable user agent'
+  end
+
+  describe 'when executing requests' do
+    before do
+      @prediction = client.discovered_api('prediction', 'v1.2')
+      client.authorization = :oauth_2
+      @connection = stub_connection do |stub|
+        stub.post('/prediction/v1.2/training?data=12345') do |env|
+          expect(env[:request_headers]['Authorization']).to eq('Bearer 12345')
+          [200, {}, '{}']
+        end
+      end
+    end
+
+    after do
+      @connection.verify
+    end
+
+    it 'should use default authorization' do
+      client.authorization.access_token = "12345"
+      client.execute(
+        :api_method => @prediction.training.insert,
+        :parameters => {'data' => '12345'},
+        :connection => @connection
+      )
+    end
+
+    it 'should use request scoped authorization when provided' do
+      client.authorization.access_token = "abcdef"
+      new_auth = Signet::OAuth2::Client.new(:access_token => '12345')
+      client.execute(
+        :api_method => @prediction.training.insert,
+        :parameters => {'data' => '12345'},
+        :authorization => new_auth,
+        :connection => @connection
+      )
+    end
+
+    it 'should accept options with batch/request style execute' do
+      client.authorization.access_token = "abcdef"
+      new_auth = Signet::OAuth2::Client.new(:access_token => '12345')
+      request = client.generate_request(
+        :api_method => @prediction.training.insert,
+        :parameters => {'data' => '12345'}
+      )
+      client.execute(
+        request,
+        :authorization => new_auth,
+        :connection => @connection
+      )
+    end
+
+
+    it 'should accept options in array style execute' do
+       client.authorization.access_token = "abcdef"
+       new_auth = Signet::OAuth2::Client.new(:access_token => '12345')
+       client.execute(
+         @prediction.training.insert, {'data' => '12345'}, '', {},
+         { :authorization => new_auth, :connection => @connection }
+       )
+     end
+  end
+
+  describe 'when retries enabled' do
+    before do
+      client.retries = 2
+    end
+
+    after do
+      @connection.verify
+    end
+
+    it 'should follow redirects' do
+      client.authorization = nil
+      @connection = stub_connection do |stub|
+        stub.get('/foo') do |env|
+          [302, {'location' => 'https://www.google.com/bar'}, '{}']
+        end
+        stub.get('/bar') do |env|
+          [200, {}, '{}']
+        end
+      end
+
+      client.execute(  
+        :uri => 'https://www.google.com/foo',
+        :connection => @connection
+      )
+    end
+
+    it 'should refresh tokens on 401 errors' do
+      client.authorization.access_token = '12345'
+      expect(client.authorization).to receive(:fetch_access_token!)
+
+      @connection = stub_connection do |stub|
+        stub.get('/foo') do |env|
+          [401, {}, '{}']
+        end
+        stub.get('/foo') do |env|
+          [200, {}, '{}']
+        end
+      end
+
+      client.execute(  
+        :uri => 'https://www.google.com/foo',
+        :connection => @connection
+      )
+    end
+
+
+    it 'should not attempt multiple token refreshes' do
+      client.authorization.access_token = '12345'
+      expect(client.authorization).to receive(:fetch_access_token!).once
+
+      @connection = stub_connection do |stub|
+        stub.get('/foo') do |env|
+          [401, {}, '{}']
+        end
+      end
+
+      client.execute(  
+        :uri => 'https://www.google.com/foo',
+        :connection => @connection
+      )
+    end
+
+    it 'should not retry on client errors' do
+      count = 0
+      @connection = stub_connection do |stub|
+        stub.get('/foo') do |env|
+          expect(count).to eq(0)
+          count += 1
+          [403, {}, '{}']
+        end
+      end
+
+      client.execute(  
+        :uri => 'https://www.google.com/foo',
+        :connection => @connection,
+        :authenticated => false
+      )
+    end
+
+    it 'should retry on 500 errors' do
+      client.authorization = nil
+
+      @connection = stub_connection do |stub|
+        stub.get('/foo') do |env|
+          [500, {}, '{}']
+        end
+        stub.get('/foo') do |env|
+          [200, {}, '{}']
+        end
+      end
+
+      expect(client.execute(  
+        :uri => 'https://www.google.com/foo',
+        :connection => @connection
+      ).status).to eq(200)
+
+    end
+
+    it 'should fail after max retries' do
+      client.authorization = nil
+      count = 0
+      @connection = stub_connection do |stub|
+        stub.get('/foo') do |env|
+          count += 1
+          [500, {}, '{}']
+        end
+      end
+
+      expect(client.execute(  
+        :uri => 'https://www.google.com/foo',
+        :connection => @connection
+      ).status).to eq(500)
+      expect(count).to eq(3)
+    end
+
+  end
+
+  describe 'when retries disabled and expired_auth_retry on (default)' do
+    before do
+      client.retries = 0
+    end
+
+    after do
+      @connection.verify
+    end
+
+    it 'should refresh tokens on 401 errors' do
+      client.authorization.access_token = '12345'
+      expect(client.authorization).to receive(:fetch_access_token!)
+
+      @connection = stub_connection do |stub|
+        stub.get('/foo') do |env|
+          [401, {}, '{}']
+        end
+        stub.get('/foo') do |env|
+          [200, {}, '{}']
+        end
+      end
+
+      client.execute(
+        :uri => 'https://www.gogole.com/foo',
+        :connection => @connection
+      )
+    end
+
+  end
+
+  describe 'when retries disabled and expired_auth_retry off' do
+    before do
+      client.retries = 0
+      client.expired_auth_retry = false
+    end
+
+    it 'should not refresh tokens on 401 errors' do
+      client.authorization.access_token = '12345'
+      expect(client.authorization).not_to receive(:fetch_access_token!)
+
+      @connection = stub_connection do |stub|
+        stub.get('/foo') do |env|
+          [401, {}, '{}']
+        end
+        stub.get('/foo') do |env|
+          [200, {}, '{}']
+        end
+      end
+
+      resp = client.execute(
+        :uri => 'https://www.gogole.com/foo',
+        :connection => @connection
+      )
+
+      expect(resp.response.status).to be == 401
+    end
+
+  end
+end