jomz-google-api-client 0.7.1

data/spec/google/api_client/simple_file_store_spec.rb

@@ -0,0 +1,137 @@
+# 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'
+
+describe Google::APIClient::Service::SimpleFileStore do
+
+  FILE_NAME = 'test.cache'
+
+  before(:all) do
+    File.delete(FILE_NAME) if File.exists?(FILE_NAME)
+  end
+
+  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
+      @cache.exist?('invalid').should be_nil
+      File.exists?(FILE_NAME).should be_false
+    end
+
+    it 'should return nil when asked to read a key' do
+      @cache.read('invalid').should be_nil
+      File.exists?(FILE_NAME).should be_false
+    end
+
+    it 'should return nil when asked to fetch a key' do
+      @cache.fetch('invalid').should be_nil
+      File.exists?(FILE_NAME).should be_false
+    end
+
+    it 'should create a cache file when asked to fetch a key with a default' do
+      @cache.fetch('new_key') do
+        'value'
+      end.should == 'value'
+      File.exists?(FILE_NAME).should be_true
+    end
+
+    it 'should create a cache file when asked to write a key' do
+      @cache.write('new_key', 'value')
+      File.exists?(FILE_NAME).should be_true
+    end
+
+    it 'should return nil when asked to delete a key' do
+      @cache.delete('invalid').should be_nil
+      File.exists?(FILE_NAME).should be_false
+    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
+      @cache.exist?('existing_key').should be_true
+    end
+
+    it 'should return false when asked if a nonexistent key exists' do
+      @cache.exist?('invalid').should be_false
+    end
+
+    it 'should return the value for an existing key when asked to read it' do
+      @cache.read('existing_key').should == 'existing_value'
+    end
+
+    it 'should return nil for a nonexistent key when asked to read it' do
+      @cache.read('invalid').should be_nil
+    end
+
+    it 'should return the value for an existing key when asked to read it' do
+      @cache.read('existing_key').should == 'existing_value'
+    end
+
+    it 'should return nil for a nonexistent key when asked to fetch it' do
+      @cache.fetch('invalid').should be_nil
+    end
+
+    it 'should return and save the default value for a nonexistent key when asked to fetch it with a default' do
+      @cache.fetch('new_key') do
+        'value'
+      end.should == 'value'
+      @cache.read('new_key').should == 'value'
+    end
+
+    it 'should remove an existing value and return true when asked to delete it' do
+      @cache.delete('existing_key').should be_true
+      @cache.read('existing_key').should be_nil
+    end
+
+    it 'should return false when asked to delete a nonexistent key' do
+      @cache.delete('invalid').should be_false
+    end
+
+    it 'should convert keys to strings when storing them' do
+      @cache.write(:symbol_key, 'value')
+      @cache.read('symbol_key').should == 'value'
+    end
+
+    it 'should convert keys to strings when reading them' do
+      @cache.read(:existing_key).should == 'existing_value'
+    end
+
+    it 'should convert keys to strings when fetching them' do
+      @cache.fetch(:existing_key).should == 'existing_value'
+    end
+
+    it 'should convert keys to strings when deleting them' do
+      @cache.delete(:existing_key).should be_true
+      @cache.read('existing_key').should 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,253 @@
+# 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'
+require 'google/api_client/version'
+
+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'
+    client.user_agent.should == 'Custom User Agent/1.2.3'
+  end
+
+  it 'should allow the user agent to be set to nil' do
+    client.user_agent = nil
+    client.user_agent.should == nil
+  end
+
+  it 'should not allow the user agent to be used with bogus values' do
+    (lambda do
+      client.user_agent = 42
+      client.execute(:uri=>'https://www.google.com/')
+    end).should 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]
+        headers.should have_key('User-Agent')
+        headers['User-Agent'].should == client.user_agent
+        [200, {}, ['']]
+      end
+    end
+    client.execute(:uri=>'https://www.google.com/', :connection => conn)
+    conn.verify
+  end
+end
+
+describe Google::APIClient do
+  include ConnectionHelpers
+
+  let(:client) { Google::APIClient.new(:application_name => 'API Client Tests') }
+
+  it 'should make its version number available' do
+    Google::APIClient::VERSION::STRING.should be_instance_of(String)
+  end
+
+  it 'should default to OAuth 2' do
+    Signet::OAuth2::Client.should === 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
+      client.authorization.temporary_credential_uri.to_s.should ==
+        'https://www.google.com/accounts/OAuthGetRequestToken'
+      client.authorization.authorization_uri.to_s.should include(
+        'https://www.google.com/accounts/OAuthAuthorizeToken'
+      )
+      client.authorization.token_credential_uri.to_s.should ==
+        'https://www.google.com/accounts/OAuthGetAccessToken'
+      client.authorization.client_credential_key.should == 'anonymous'
+      client.authorization.client_credential_secret.should == '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|
+          env[:request_headers]['Authorization'].should == '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 retiries 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.gogole.com/foo',
+        :connection => @connection
+      )
+    end
+
+    it 'should refresh tokens on 401 tokens' 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
+
+    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
+
+      client.execute(  
+        :uri => 'https://www.gogole.com/foo',
+        :connection => @connection
+      ).status.should == 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
+
+      client.execute(  
+        :uri => 'https://www.gogole.com/foo',
+        :connection => @connection
+      ).status.should == 500
+      count.should == 3
+    end
+
+  end  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,56 @@
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+$LOAD_PATH.uniq!
+
+require 'rspec'
+require 'faraday'
+
+Faraday::Adapter.load_middleware(:test)
+
+module Faraday
+  class Connection
+    def verify
+      if app.kind_of?(Faraday::Adapter::Test)
+        app.stubs.verify_stubbed_calls
+      else
+        raise TypeError, "Expected test adapter"
+      end
+    end
+  end
+end
+
+module ConnectionHelpers
+  def stub_connection(&block)
+    stubs = Faraday::Adapter::Test::Stubs.new do |stub|
+      block.call(stub)
+    end
+    connection = Faraday.new do |builder|
+      builder.options.params_encoder = Faraday::FlatParamsEncoder
+      builder.adapter(:test, stubs)
+    end
+  end
+end
+
+module JSONMatchers
+  class EqualsJson
+    def initialize(expected)
+      @expected = JSON.parse(expected)
+    end
+    def matches?(target)
+      @target = JSON.parse(target)
+      @target.eql?(@expected)
+    end
+    def failure_message
+      "expected #{@target.inspect} to be #{@expected}"
+    end
+    def negative_failure_message
+      "expected #{@target.inspect} not to be #{@expected}"
+    end
+  end
+  
+  def be_json(expected)
+    EqualsJson.new(expected)
+  end
+end
+
+RSpec.configure do |config|
+end

data/tasks/gem.rake

@@ -0,0 +1,97 @@
+require 'rubygems/package_task'
+require 'rake/clean'
+
+CLOBBER.include('pkg')
+
+namespace :gem do
+  GEM_SPEC = Gem::Specification.new do |s|
+    unless s.respond_to?(:add_development_dependency)
+      puts 'The gem spec requires a newer version of RubyGems.'
+      exit(1)
+    end
+
+    s.name = PKG_NAME
+    s.version = PKG_VERSION
+    s.author = PKG_AUTHOR
+    s.email = PKG_AUTHOR_EMAIL
+    s.summary = PKG_SUMMARY
+    s.description = PKG_DESCRIPTION
+    s.license = 'Apache 2.0'
+    s.files = PKG_FILES.to_a
+
+    s.extra_rdoc_files = %w( README.md )
+    s.rdoc_options.concat ['--main',  'README.md']
+
+    # Dependencies used in the main library
+    s.add_runtime_dependency('signet', '>= 0.5.0')
+    s.add_runtime_dependency('addressable', '>= 2.3.2')
+    s.add_runtime_dependency('uuidtools', '>= 2.1.0')
+    s.add_runtime_dependency('autoparse', '>= 0.3.3')
+    s.add_runtime_dependency('faraday', '>= 0.9.0')
+    s.add_runtime_dependency('multi_json', '>= 1.0.0')
+    s.add_runtime_dependency('extlib', '>= 0.9.15')
+    s.add_runtime_dependency('jwt', '>= 0.1.5')
+    s.add_runtime_dependency('retriable', '>= 1.4')
+    # Dependencies used in the CLI
+    s.add_runtime_dependency('launchy', '>= 2.1.1')
+
+    # Dependencies used in the examples
+    s.add_development_dependency('rake', '>= 0.9.0')
+    s.add_development_dependency('rspec', '>= 2.11.0')
+
+    s.require_path = 'lib'
+
+    s.homepage = PKG_HOMEPAGE
+  end
+
+  Gem::PackageTask.new(GEM_SPEC) do |p|
+    p.gem_spec = GEM_SPEC
+    p.need_tar = true
+    p.need_zip = true
+  end
+
+  desc 'Show information about the gem'
+  task :debug do
+    puts GEM_SPEC.to_ruby
+  end
+
+  desc "Generates .gemspec file"
+  task :gemspec do
+    spec_string = GEM_SPEC.to_ruby
+
+    begin
+      Thread.new { eval("$SAFE = 3\n#{spec_string}", binding) }.join
+    rescue
+      abort "unsafe gemspec: #{$!}"
+    else
+      File.open("#{GEM_SPEC.name}.gemspec", 'w') do |file|
+        file.write spec_string
+      end
+    end
+  end
+
+  desc 'Install the gem'
+  task :install => ['clobber', 'gem:package'] do
+    sh "#{SUDO} gem install --local pkg/#{GEM_SPEC.full_name}"
+  end
+
+  desc 'Uninstall the gem'
+  task :uninstall do
+    installed_list = Gem.source_index.find_name(PKG_NAME)
+    if installed_list &&
+        (installed_list.collect { |s| s.version.to_s}.include?(PKG_VERSION))
+      sh(
+        "#{SUDO} gem uninstall --version '#{PKG_VERSION}' " +
+        "--ignore-dependencies --executables #{PKG_NAME}"
+      )
+    end
+  end
+
+  desc 'Reinstall the gem'
+  task :reinstall => [:uninstall, :install]
+end
+
+desc 'Alias to gem:package'
+task 'gem' => 'gem:package'
+
+task 'gem:release' => 'gem:gemspec'