google-api-client 0.6.4 → 0.7.0

data/lib/google/api_client.rb

@@ -14,10 +14,10 @@
 
 
 require 'faraday'
-require 'faraday/utils'
 require 'multi_json'
 require 'compat/multi_json'
 require 'stringio'
+require 'retriable'
 
 require 'google/api_client/version'
 require 'google/api_client/logging'
@@ -30,6 +30,8 @@ require 'google/api_client/result'
 require 'google/api_client/media'
 require 'google/api_client/service_account'
 require 'google/api_client/batch'
+require 'google/api_client/gzip'
+require 'google/api_client/client_secrets'
 require 'google/api_client/railtie' if defined?(Rails::Railtie)
 
 module Google
@@ -70,6 +72,9 @@ module Google
     #   The port number used by the client. This rarely needs to be changed.
     # @option options [String] :discovery_path ("/discovery/v1")
     #   The discovery base path. This rarely needs to be changed.
+    # @option options [String] :ca_file
+    #   Optional set of root certificates to use when validating SSL connections.
+    #   By default, a bundled set of trusted roots will be used.
     def initialize(options={})
       logger.debug { "#{self.class} - Initializing client with options #{options}" }
       
@@ -94,8 +99,7 @@ module Google
       end
       self.user_agent = options[:user_agent] || (
         "#{application_string} " +
-        "google-api-ruby-client/#{Google::APIClient::VERSION::STRING} " +
-         ENV::OS_VERSION
+        "google-api-ruby-client/#{Google::APIClient::VERSION::STRING} #{ENV::OS_VERSION} (gzip)"
       ).strip
       # The writer method understands a few Symbols and will generate useful
       # default authentication mechanisms.
@@ -104,10 +108,18 @@ module Google
       self.auto_refresh_token = options.fetch(:auto_refresh_token) { true }
       self.key = options[:key]
       self.user_ip = options[:user_ip]
+      self.retries = options.fetch(:retries) { 0 }
       @discovery_uris = {}
       @discovery_documents = {}
       @discovered_apis = {}
-            
+      ca_file = options[:ca_file] || File.expand_path('../../cacerts.pem', __FILE__)
+      self.connection = Faraday.new do |faraday|
+        faraday.response :gzip
+        faraday.options.params_encoder = Faraday::FlatParamsEncoder
+        faraday.ssl.ca_file = ca_file
+        faraday.ssl.verify = true
+        faraday.adapter Faraday.default_adapter
+      end      
       return self
     end
 
@@ -167,6 +179,12 @@ module Google
       return @authorization
     end
 
+    ##
+    # Default Faraday/HTTP connection.
+    #
+    # @return [Faraday::Connection]
+    attr_accessor :connection
+
     ##
     # The setting that controls whether or not the api client attempts to
     # refresh authorization when a 401 is hit in #execute. 
@@ -214,6 +232,13 @@ module Google
     #   The base path. Should almost always be '/discovery/v1'.
     attr_accessor :discovery_path
 
+    ##
+    # Number of times to retry on recoverable errors
+    # 
+    # @return [FixNum]
+    #  Number of retries
+    attr_accessor :retries
+
     ##
     # Returns the URI for the directory document.
     #
@@ -408,6 +433,8 @@ module Google
     # Verifies an ID token against a server certificate. Used to ensure that
     # an ID token supplied by an untrusted client-side mechanism is valid.
     # Raises an error if the token is invalid or missing.
+    # 
+    # @deprecated Use the google-id-token gem for verifying JWTs
     def verify_id_token!
       require 'jwt'
       require 'openssl'
@@ -515,6 +542,10 @@ module Google
     #     - (TrueClass, FalseClass) :authenticated (default: true) -
     #       `true` if the request must be signed or somehow
     #       authenticated, `false` otherwise.
+    #     - (TrueClass, FalseClass) :gzip (default: true) - 
+    #       `true` if gzip enabled, `false` otherwise.
+    #     - (FixNum) :retries -
+    #       # of times to retry on recoverable errors
     #
     # @return [Google::APIClient::Result] The result from the API, nil if batch.
     #
@@ -529,11 +560,10 @@ module Google
     #   )
     #
     # @see Google::APIClient#generate_request
-    def execute(*params)
-      if params.last.kind_of?(Google::APIClient::Request) &&
-          params.size == 1
-        request = params.pop
-        options = {}
+    def execute!(*params)
+      if params.first.kind_of?(Google::APIClient::Request)
+        request = params.shift
+        options = params.shift || {}
       else
         # This block of code allows us to accept multiple parameter passing
         # styles, and maintaining some backwards compatibility.
@@ -554,53 +584,61 @@ module Google
       end
       
       request.headers['User-Agent'] ||= '' + self.user_agent unless self.user_agent.nil?
+      request.headers['Accept-Encoding'] ||= 'gzip' unless options[:gzip] == false
+      request.headers['Content-Type'] ||= ''
       request.parameters['key'] ||= self.key unless self.key.nil?
       request.parameters['userIp'] ||= self.user_ip unless self.user_ip.nil?
 
-      connection = options[:connection] || Faraday.default_connection
+      connection = options[:connection] || self.connection
       request.authorization = options[:authorization] || self.authorization unless options[:authenticated] == false
-
-      result = request.send(connection)
-      if result.status == 401 && request.authorization.respond_to?(:refresh_token) && auto_refresh_token
-        begin
-          logger.debug("Attempting refresh of access token & retry of request")
-          request.authorization.fetch_access_token!
-          result = request.send(connection)
-        rescue Signet::AuthorizationError
-           # Ignore since we want the original error
+      tries = 1 + (options[:retries] || self.retries)
+      Retriable.retriable :tries => tries, 
+                          :on => [TransmissionError], 
+                          :interval => lambda {|attempts| (2 ** attempts) + rand} do
+        result = request.send(connection, true)
+
+        case result.status
+          when 200...300
+            result
+          when 301, 302, 303, 307
+            request = generate_request(request.to_hash.merge({
+              :uri => result.headers['location'],
+              :api_method => nil
+            }))
+            raise RedirectError.new(result.headers['location'], result)
+          when 400...500
+            if result.status == 401 && request.authorization.respond_to?(:refresh_token) && auto_refresh_token
+              begin
+                logger.debug("Attempting refresh of access token & retry of request")
+                request.authorization.fetch_access_token!
+              rescue Signet::AuthorizationError
+                 # Ignore since we want the original error
+              end
+            end
+            raise ClientError.new(result.error_message || "A client error has occurred", result)
+          when 500...600
+            raise ServerError.new(result.error_message || "A server error has occurred", result)
+          else
+            raise TransmissionError.new(result.error_message || "A transmission error has occurred", result)
         end
       end
-      
-      return result
     end
 
     ##
-    # Same as Google::APIClient#execute, but raises an exception if there was
-    # an error.
+    # Same as Google::APIClient#execute!, but does not raise an exception for
+    # normal API errros.
     #
     # @see Google::APIClient#execute
-    def execute!(*params)
-      result = self.execute(*params)
-      if result.error?
-        error_message = result.error_message
-        case result.response.status
-          when 400...500
-            exception_type = ClientError
-            error_message ||= "A client error has occurred."
-          when 500...600
-            exception_type = ServerError
-            error_message ||= "A server error has occurred."
-          else
-            exception_type = TransmissionError
-            error_message ||= "A transmission error has occurred."
-        end
-        raise exception_type, error_message
+    def execute(*params)
+      begin
+        return self.execute!(*params)
+      rescue TransmissionError => e
+        return e.result
       end
-      return result
     end
-    
+
     protected
-    
+
     ##
     # Resolves a URI template against the client's configured base.
     #
@@ -628,6 +666,7 @@ module Google
     end
     
   end
+
 end
 
 require 'google/api_client/version'

data/spec/google/api_client/batch_spec.rb

@@ -53,7 +53,7 @@ describe Google::APIClient::BatchRequest do
         @call1 = {
           :api_method => @discovery.apis.get_rest,
           :parameters => {
-            'api' => 'adsense',
+            'api' => 'plus',
             'version' => 'v1'
           }
         }
@@ -118,7 +118,7 @@ describe Google::APIClient::BatchRequest do
         @call1 = {
           :api_method => @discovery.apis.get_rest,
           :parameters => {
-            'api' => 'adsense',
+            'api' => 'plus',
             'version' => 'v1'
           }
         }
@@ -234,7 +234,7 @@ describe Google::APIClient::BatchRequest do
       it 'should convert to a correct HTTP request' do
         batch = Google::APIClient::BatchRequest.new { |result| }
         batch.add(@call1, '1').add(@call2, '2')
-        request = batch.to_env(Faraday.default_connection)
+        request = batch.to_env(CLIENT.connection)
         boundary = Google::APIClient::BatchRequest::BATCH_BOUNDARY
         request[:method].to_s.downcase.should == 'post'
         request[:url].to_s.should == 'https://www.googleapis.com/batch'
@@ -244,6 +244,6 @@ describe Google::APIClient::BatchRequest do
         #request[:body].read.gsub("\r", "").should =~ expected_body
       end
     end
-    
+
   end
 end

data/spec/google/api_client/discovery_spec.rb

@@ -18,29 +18,12 @@
 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'
 
-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
   include ConnectionHelpers
   CLIENT = Google::APIClient.new(:application_name => 'API Client Tests') unless defined?(CLIENT)
@@ -103,9 +86,10 @@ describe Google::APIClient do
 
     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(
@@ -121,6 +105,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(
@@ -137,6 +122,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(
@@ -204,6 +190,7 @@ describe Google::APIClient do
       conn = stub_connection do |stub|
         stub.post('/prediction/v1.2/training?data=12345') do |env|
           env[:body].should == ''
+          [200, {}, '{}']
         end
       end
       request = CLIENT.execute(
@@ -216,11 +203,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 == ''
+          [200, {}, '{}']
         end
       end
       request = CLIENT.execute(
@@ -231,16 +219,16 @@ describe Google::APIClient do
       conn.verify
     end
 
-    it 'should generate valid requests when repeated parameters are passed' do
-      pending("This is caused by Faraday's encoding of query parameters.")
+    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')
+           env.params['data'].should include('1', '2')
+          [200, {}, '{}']
          end
        end
       request = CLIENT.execute(
         :api_method => @prediction.training.insert,
-        :parameters => [['data', '1'], ['data','2']],
+        :parameters => {'data' => ['1', '2']},
         :connection => conn
       )
       conn.verify
@@ -249,6 +237,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(
@@ -262,6 +251,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(
@@ -282,9 +272,10 @@ 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'
+          [200, {}, '{}']          
         end
       end
-        
+
       request = CLIENT.execute(
         :api_method => prediction_rebase.training.insert,
         :parameters => {'data' => '123'},
@@ -302,6 +293,7 @@ describe Google::APIClient do
         stub.post('/prediction/v1.2/training?data=12345') do |env|
           env[:request_headers].should have_key('Authorization')
           env[:request_headers]['Authorization'].should =~ /^OAuth/
+          [200, {}, '{}']
         end
       end
 
@@ -321,6 +313,7 @@ describe Google::APIClient do
         stub.post('/prediction/v1.2/training?data=12345') do |env|
           env[:request_headers].should have_key('Authorization')
           env[:request_headers]['Authorization'].should =~ /^Bearer/
+          [200, {}, '{}']          
         end
       end
 
@@ -381,6 +374,7 @@ describe Google::APIClient do
         stub.post('/prediction/v1.2/training') do |env|
           env[:request_headers].should have_key('Content-Type')
           env[:request_headers]['Content-Type'].should == 'application/json'
+          [200, {}, '{}']
         end
       end
       CLIENT.authorization = :oauth_2
@@ -433,9 +427,10 @@ describe Google::APIClient do
     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 => {
@@ -465,107 +460,45 @@ describe Google::APIClient do
             'userId' => '107807692475771887386', 'collection' => 'bogus'
           },
           :authenticated => false
-        ).to_env(Faraday.default_connection)
+        ).to_env(CLIENT.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
-
-    it 'should return a batch path' do
-      CLIENT.discovered_api('latitude').batch_path.should_not be_nil
-    end
-
-    it 'should find methods that are in the discovery document' do
-      CLIENT.discovered_method(
-        'latitude.currentLocation.get', 'latitude'
-      ).name.should == 'get'
-    end
-
-    it 'should define the origin API in discovered methods' do
-      CLIENT.discovered_method(
-        '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
-      )
-      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
-      )
-      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')
+      @adsense = CLIENT.discovered_api('adsense', 'v1.3')
     end
 
     it 'should correctly determine the discovery URI' do
-      CLIENT.discovery_uri('adsense').should ===
-        'https://www.googleapis.com/discovery/v1/apis/adsense/v1/rest'
+      CLIENT.discovery_uri('adsense', 'v1.3').to_s.should ===
+        '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').name.should == 'adsense'
-      CLIENT.discovered_api('adsense').version.should == 'v1'
+      CLIENT.discovered_api('adsense', 'v1.3').name.should == 'adsense'
+      CLIENT.discovered_api('adsense', 'v1.3').version.should == 'v1.3'
     end
 
     it 'should return a batch path' do
-      CLIENT.discovered_api('adsense').batch_path.should_not be_nil
+      CLIENT.discovered_api('adsense', 'v1.3').batch_path.should_not be_nil
     end
 
     it 'should find methods that are in the discovery document' do
       CLIENT.discovered_method(
-        'adsense.reports.generate', 'adsense'
+        'adsense.reports.generate', 'adsense', 'v1.3'
       ).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
+      CLIENT.discovered_method('adsense.bogus', 'adsense', 'v1.3').should == nil
     end
 
     it 'should generate requests against the correct URIs' do
       conn = stub_connection do |stub|
-        stub.get('/adsense/v1/adclients') do |env|
+        stub.get('/adsense/v1.3/adclients') do |env|
+          [200, {}, '{}']
         end
       end
       request = CLIENT.execute(
@@ -595,7 +528,8 @@ describe Google::APIClient do
 
     it 'should succeed when validating parameters in a correct call' do
       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|
+        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
@@ -630,11 +564,11 @@ describe Google::APIClient do
     end
 
     it 'should succeed when validating repeated parameters in a correct call' do
-      pending("This is caused by Faraday's encoding of query parameters.")
       conn = stub_connection do |stub|
-        stub.get('/adsense/v1/reports?dimension=DATE&dimension=PRODUCT_CODE'+
+        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
@@ -667,6 +601,30 @@ describe Google::APIClient do
         )
       end).should 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|
+           env.params['dimension'].should include('DATE', 'PRODUCT_CODE')
+           env.params['metric'].should 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

data/spec/google/api_client/gzip_spec.rb

@@ -0,0 +1,86 @@
+# Copyright 2012 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'
+require 'google/api_client/version'
+
+describe Google::APIClient::Gzip do
+
+  def create_connection(&block)
+    Faraday.new do |b|
+      b.response :gzip
+      b.adapter :test do |stub|
+        stub.get '/', &block
+      end
+    end
+  end  
+
+  it 'should ignore non-zipped content' do
+    conn = create_connection do |env|
+      [200, {}, 'Hello world']
+    end
+    result = conn.get('/')
+    result.body.should == "Hello world"
+  end
+
+  it 'should decompress gziped content' do
+    conn = create_connection do |env|
+      [200, { 'Content-Encoding' => 'gzip'}, Base64.decode64('H4sICLVGwlEAA3RtcADzSM3JyVcozy/KSeECANXgObcMAAAA')]
+    end
+    result = conn.get('/')
+    result.body.should == "Hello world\n"
+  end
+  
+  describe 'with API Client' do
+
+    before do
+      @client = Google::APIClient.new(:application_name => 'test')
+      @client.authorization = nil
+    end
+    
+    
+    it 'should send gzip in user agent' do
+      conn = create_connection do |env|
+        agent = env[:request_headers]['User-Agent']
+        agent.should_not be_nil
+        agent.should include 'gzip'
+        [200, {}, 'Hello world']
+      end
+      @client.execute(:uri => 'http://www.example.com/', :connection => conn)
+    end
+
+    it 'should send gzip in accept-encoding' do
+      conn = create_connection do |env|
+        encoding = env[:request_headers]['Accept-Encoding']
+        encoding.should_not be_nil
+        encoding.should include 'gzip'
+        [200, {}, 'Hello world']
+      end
+      @client.execute(:uri => 'http://www.example.com/', :connection => conn)
+    end
+    
+    it 'should not send gzip in accept-encoding if disabled for request' do
+      conn = create_connection do |env|
+        encoding = env[:request_headers]['Accept-Encoding']
+        encoding.should_not include('gzip') unless encoding.nil?
+        [200, {}, 'Hello world']
+      end
+      response = @client.execute(:uri => 'http://www.example.com/', :gzip => false, :connection => conn)
+      puts response.status
+    end
+    
+  end
+end