google-api-client 0.6.4 → 0.7.0.rc2

data/lib/google/api_client.rb

@@ -14,7 +14,6 @@
 
 
 require 'faraday'
-require 'faraday/utils'
 require 'multi_json'
 require 'compat/multi_json'
 require 'stringio'
@@ -30,6 +29,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 +71,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 +98,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.
@@ -107,7 +110,14 @@ module Google
       @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 +177,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. 
@@ -515,6 +531,8 @@ 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.
     #
     # @return [Google::APIClient::Result] The result from the API, nil if batch.
     #
@@ -530,10 +548,9 @@ 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 = {}
+      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,10 +571,11 @@ 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.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)
@@ -565,7 +583,7 @@ module Google
         begin
           logger.debug("Attempting refresh of access token & retry of request")
           request.authorization.fetch_access_token!
-          result = request.send(connection)
+          result = request.send(connection, true)
         rescue Signet::AuthorizationError
            # Ignore since we want the original error
         end

data/lib/google/api_client/auth/compute_service_account.rb

@@ -0,0 +1,28 @@
+# 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 'faraday'
+require 'signet/oauth_2/client'
+
+module Google
+  class APIClient
+    class ComputeServiceAccount < Signet::OAuth2::Client
+      def fetch_access_token(options={})
+        connection = options[:connection] || Faraday.default_connection
+        response = connection.get 'http://metadata/computeMetadata/v1beta1/instance/service-accounts/default/token'
+        Signet::OAuth2.parse_json_credentials(response.body)
+      end
+    end
+  end
+end

data/lib/google/api_client/auth/file_storage.rb

@@ -0,0 +1,87 @@
+# 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 'json'
+require 'signet/oauth_2/client'
+
+module Google
+  class APIClient
+    ##
+    # Represents cached OAuth 2 tokens stored on local disk in a
+    # JSON serialized file. Meant to resemble the serialized format
+    # http://google-api-python-client.googlecode.com/hg/docs/epy/oauth2client.file.Storage-class.html
+    #
+    class FileStorage
+      # @return [String] Path to the credentials file.
+      attr_accessor :path
+
+      # @return [Signet::OAuth2::Client] Path to the credentials file.
+      attr_reader :authorization
+
+      ##
+      # Initializes the FileStorage object.
+      #
+      # @param [String] path
+      #    Path to the credentials file.
+      def initialize(path)
+        @path = path
+        self.load_credentials
+      end
+
+      ##
+      # Attempt to read in credentials from the specified file.
+      def load_credentials
+        if File.exist? self.path
+          File.open(self.path, 'r') do |file|
+            cached_credentials = JSON.load(file)
+            @authorization = Signet::OAuth2::Client.new(cached_credentials)
+            @authorization.issued_at = Time.at(cached_credentials['issued_at'])
+            if @authorization.expired?
+              @authorization.fetch_access_token!
+              self.write_credentials
+            end
+          end
+        end
+      end
+
+      ##
+      # Write the credentials to the specified file.
+      #
+      # @param [Signet::OAuth2::Client] authorization
+      #    Optional authorization instance. If not provided, the authorization
+      #    already associated with this instance will be written.
+      def write_credentials(authorization=nil)
+        @authorization = authorization unless authorization.nil?
+
+        unless @authorization.refresh_token.nil?
+          hash = {}
+          %w'access_token
+           authorization_uri
+           client_id
+           client_secret
+           expires_in
+           refresh_token
+           token_credential_uri'.each do |var|
+            hash[var] = @authorization.instance_variable_get("@#{var}")
+          end
+          hash['issued_at'] = @authorization.issued_at.to_i
+
+          File.open(self.path, 'w', 0600) do |file|
+            file.write(hash.to_json)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/api_client/auth/installed_app.rb

@@ -77,9 +77,13 @@ module Google
       ##
       # Request authorization. Opens a browser and waits for response.
       #
+      # @param [Google::APIClient::FileStorage] storage
+      #  Optional object that responds to :write_credentials, used to serialize
+      #  the OAuth 2 credentials after completing the flow.
+      #
       # @return [Signet::OAuth2::Client]
       #  Authorization instance, nil if user cancelled.
-      def authorize
+      def authorize(storage=nil)
         auth = @authorization
     
         server = WEBrick::HTTPServer.new(
@@ -103,6 +107,9 @@ module Google
         Launchy.open(auth.authorization_uri.to_s)
         server.start
         if @authorization.access_token
+          if storage.respond_to?(:write_credentials)
+            storage.write_credentials(@authorization)
+          end
           return @authorization
         else
           return nil

data/lib/google/api_client/auth/jwt_asserter.rb

@@ -34,17 +34,6 @@ module Google
     #   client.authorization.fetch_access_token!
     #   client.execute(...)
     #
-    # @example Deprecated version
-    #
-    #    client = Google::APIClient.new
-    #    key = Google::APIClient::PKCS12.load_key('client.p12', 'notasecret')
-    #    service_account = Google::APIClient::JWTAsserter.new(
-    #     '123456-abcdef@developer.gserviceaccount.com',
-    #     'https://www.googleapis.com/auth/prediction',
-    #     key)
-    #    client.authorization = service_account.authorize
-    #    client.execute(...)
-    #
     # @deprecated
     #  Service accounts are now supported directly in Signet
     # @see https://developers.google.com/accounts/docs/OAuth2ServiceAccount

data/lib/google/api_client/client_secrets.rb

@@ -146,7 +146,7 @@ module Google
       end
       
       def to_authorization
-        gem 'signet', '~> 0.4.0'
+        gem 'signet', '>= 0.4.0'
         require 'signet/oauth_2/client'
         # NOTE: Do not rely on this default value, as it may change
         new_authorization = Signet::OAuth2::Client.new

data/lib/google/api_client/discovery/method.rb

@@ -187,6 +187,7 @@ module Google
       # @return [Addressable::URI] The URI after expansion.
       def generate_uri(parameters={})
         parameters = self.normalize_parameters(parameters)
+        
         self.validate_parameters(parameters)
         template_variables = self.uri_template.variables
         upload_type = parameters.assoc('uploadType') || parameters.assoc('upload_type')

data/lib/google/api_client/gzip.rb

@@ -0,0 +1,28 @@
+require 'faraday'
+require 'zlib'
+ 
+module Google
+  class APIClient
+    class Gzip < Faraday::Response::Middleware
+      include Google::APIClient::Logging
+ 
+      def on_complete(env)
+        encoding = env[:response_headers]['content-encoding'].to_s.downcase
+        case encoding
+        when 'gzip'
+          logger.debug { "Decompressing gzip encoded response (#{env[:body].length} bytes)" }        
+          env[:body] = Zlib::GzipReader.new(StringIO.new(env[:body])).read
+          env[:response_headers].delete('content-encoding')
+          logger.debug { "Decompressed (#{env[:body].length} bytes)" }        
+        when 'deflate'
+          logger.debug{ "Decompressing deflate encoded response (#{env[:body].length} bytes)" }        
+          env[:body] = Zlib::Inflate.inflate(env[:body])
+          env[:response_headers].delete('content-encoding')
+          logger.debug { "Decompressed (#{env[:body].length} bytes)" }        
+        end
+      end
+    end
+  end
+end
+ 
+Faraday::Response.register_middleware :gzip => Google::APIClient::Gzip

data/lib/google/api_client/media.rb

@@ -21,7 +21,11 @@ module Google
     # @see Faraday::UploadIO
     # @example
     #   media = Google::APIClient::UploadIO.new('mymovie.m4v', 'video/mp4')
-    class UploadIO < Faraday::UploadIO      
+    class UploadIO < Faraday::UploadIO
+      
+      # @return [Fixnum] Size of chunks to upload. Default is nil, meaning upload the entire file in a single request
+      attr_accessor :chunk_size
+            
       ##
       # Get the length of the stream
       #
@@ -32,6 +36,77 @@ module Google
       end
     end
     
+    ##
+    # Wraps an input stream and limits data to a given range
+    #
+    # @example
+    #   chunk = Google::APIClient::RangedIO.new(io, 0, 1000)
+    class RangedIO 
+      ##
+      # Bind an input stream to a specific range.
+      #
+      # @param [IO] io
+      #   Source input stream
+      # @param [Fixnum] offset
+      #   Starting offset of the range
+      # @param [Fixnum] length
+      #   Length of range
+      def initialize(io, offset, length)
+        @io = io
+        @offset = offset
+        @length = length
+        self.rewind
+      end
+      
+      ##
+      # @see IO#read
+      def read(amount = nil, buf = nil)
+        buffer = buf || ''
+        if amount.nil?
+          size = @length - @pos
+          done = ''
+        elsif amount == 0
+          size = 0
+          done = ''
+        else 
+          size = [@length - @pos, amount].min
+          done = nil
+        end
+
+        if size > 0
+          result = @io.read(size)
+          result.force_encoding("BINARY") if result.respond_to?(:force_encoding)
+          buffer << result if result
+          @pos = @pos + size
+        end
+
+        if buffer.length > 0
+          buffer
+        else
+          done
+        end
+      end
+
+      ##
+      # @see IO#rewind
+      def rewind
+        self.pos = 0
+      end
+
+      ##
+      # @see IO#pos
+      def pos
+        @pos
+      end
+
+      ##
+      # @see IO#pos=
+      def pos=(pos)
+        @pos = pos
+        @io.pos = @offset + pos
+      end
+    end
+    
     ##
     # Resumable uploader.
     #
@@ -124,11 +199,11 @@ module Google
             'Content-Range' => "bytes */#{media.length}" })
         else
           start_offset = @offset
-          self.media.io.pos = start_offset
-          chunk = self.media.io.read(chunk_size)
-          content_length = chunk.bytesize
+          remaining = self.media.length - start_offset
+          chunk_size = self.media.chunk_size || self.chunk_size || self.media.length
+          content_length = [remaining, chunk_size].min
+          chunk = RangedIO.new(self.media.io, start_offset, content_length)
           end_offset = start_offset + content_length - 1
-          
           self.headers.update({
             'Content-Length' => "#{content_length}",
             'Content-Type' => self.media.content_type, 

data/lib/google/api_client/request.rb

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 require 'faraday'
-require 'faraday/utils'
+require 'faraday/request/multipart'
 require 'multi_json'
 require 'compat/multi_json'
 require 'addressable/uri'
@@ -71,8 +71,10 @@ module Google
       # @option options [String, Symbol] :http_method
       #   HTTP method when requesting a URI
       def initialize(options={})
-        @parameters = Hash[options[:parameters] || {}]
+        @parameters = Faraday::Utils::ParamsHash.new
         @headers = Faraday::Utils::Headers.new
+
+        self.parameters.merge!(options[:parameters]) unless options[:parameters].nil?
         self.headers.merge!(options[:headers]) unless options[:headers].nil?
         self.api_method = options[:api_method]
         self.authenticated = options[:authenticated]
@@ -150,10 +152,13 @@ module Google
       #
       # @param [Faraday::Connection] connection
       #   the connection to transmit with
+      # @param [TrueValue,FalseValue] is_retry
+      #   True if request has been previous sent
       #
       # @return [Google::APIClient::Result]
       #   result of API request
-      def send(connection)
+      def send(connection, is_retry = false)
+        self.body.rewind if is_retry && self.body.respond_to?(:rewind)          
         env = self.to_env(connection)
         logger.debug  { "#{self.class} Sending API request #{env[:method]} #{env[:url].to_s} #{env[:request_headers]}" }
         http_response = connection.app.call(env)
@@ -163,8 +168,8 @@ module Google
 
         # Resumamble slightly different than other upload protocols in that it requires at least
         # 2 requests.
-        if self.upload_type == 'resumable'
-          upload =  result.resumable_upload
+        if result.status == 200 && self.upload_type == 'resumable'
+          upload = result.resumable_upload
           unless upload.complete?
             logger.debug { "#{self.class} Sending upload body" }
             result = upload.send(connection)
@@ -314,10 +319,10 @@ module Google
       # @param [String] boundary
       #   Boundary for separating each part of the message
       def build_multipart(parts, mime_type = 'multipart/related', boundary = MULTIPART_BOUNDARY)
-        env = {
-          :request_headers => {'Content-Type' => "#{mime_type};boundary=#{boundary}"},
-          :request => { :boundary => boundary }
-        }
+        env = Faraday::Env.new
+        env.request = Faraday::RequestOptions.new
+        env.request.boundary = boundary
+        env.request_headers = {'Content-Type' => "#{mime_type};boundary=#{boundary}"}
         multipart = Faraday::Request::Multipart.new
         self.body = multipart.create_multipart(env, parts.map {|part| [nil, part]})
         self.headers.update(env[:request_headers])