jomz-google-api-client 0.7.1

data/lib/google/api_client/railtie.rb

@@ -0,0 +1,16 @@
+require 'google/api_client/logging'
+
+module Google
+  class APIClient
+    
+    ##
+    # Optional support class for Rails. Currently replaces the built-in logger
+    # with Rails' application log.
+    #
+    class Railtie < Rails::Railtie
+      initializer 'google-api-client' do |app|
+        Google::APIClient.logger = Rails.logger
+      end
+    end
+  end
+end

data/lib/google/api_client/reference.rb

@@ -0,0 +1,27 @@
+# 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 'google/api_client/request'
+
+module Google
+  class APIClient
+    ##
+    # Subclass of Request for backwards compatibility with pre-0.5.0 versions of the library
+    # 
+    # @deprecated
+    #   use {Google::APIClient::Request} instead
+    class Reference < Request
+    end
+  end
+end

data/lib/google/api_client/request.rb

@@ -0,0 +1,351 @@
+# 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 'faraday'
+require 'faraday/request/multipart'
+require 'multi_json'
+require 'compat/multi_json'
+require 'addressable/uri'
+require 'stringio'
+require 'google/api_client/discovery'
+require 'google/api_client/logging'
+
+module Google
+  class APIClient
+
+    ##
+    # Represents an API request.
+    class Request
+      include Google::APIClient::Logging
+      
+      MULTIPART_BOUNDARY = "-----------RubyApiMultipartPost".freeze
+
+      # @return [Hash] Request parameters
+      attr_reader :parameters
+      # @return [Hash] Additional HTTP headers
+      attr_reader :headers
+      # @return [Google::APIClient::Method] API method to invoke
+      attr_reader :api_method
+      # @return [Google::APIClient::UploadIO] File to upload
+      attr_accessor :media
+      # @return [#generated_authenticated_request] User credentials
+      attr_accessor :authorization
+      # @return [TrueClass,FalseClass] True if request should include credentials
+      attr_accessor :authenticated
+      # @return [#read, #to_str] Request body
+      attr_accessor :body
+
+      ##
+      # Build a request
+      #
+      # @param [Hash] options
+      # @option options [Hash, Array] :parameters
+      #   Request parameters for the API method.
+      # @option options [Google::APIClient::Method] :api_method
+      #   API method to invoke. Either :api_method or :uri must be specified
+      # @option options [TrueClass, FalseClass] :authenticated
+      #   True if request should include credentials. Implicitly true if
+      #   unspecified and :authorization present
+      # @option options [#generate_signed_request] :authorization
+      #   OAuth credentials
+      # @option options [Google::APIClient::UploadIO] :media
+      #   File to upload, if media upload request
+      # @option options [#to_json, #to_hash] :body_object
+      #   Main body of the API request. Typically hash or object that can
+      #   be serialized to JSON
+      # @option options [#read, #to_str] :body
+      #   Raw body to send in POST/PUT requests
+      # @option options [String, Addressable::URI] :uri
+      #   URI to request. Either :api_method or :uri must be specified
+      # @option options [String, Symbol] :http_method
+      #   HTTP method when requesting a URI
+      def initialize(options={})
+        @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]
+        self.authorization = options[:authorization]
+
+        # These parameters are handled differently because they're not
+        # parameters to the API method, but rather to the API system.
+        self.parameters['key'] ||= options[:key] if options[:key]
+        self.parameters['userIp'] ||= options[:user_ip] if options[:user_ip]
+
+        if options[:media]
+          self.initialize_media_upload(options)
+        elsif options[:body]
+          self.body = options[:body]
+        elsif options[:body_object]
+          self.headers['Content-Type'] ||= 'application/json'
+          self.body = serialize_body(options[:body_object])
+        else
+          self.body = ''
+        end
+
+        unless self.api_method
+          self.http_method = options[:http_method] || 'GET'
+          self.uri = options[:uri]
+        end
+      end
+
+      # @!attribute [r] upload_type
+      # @return [String] protocol used for upload
+      def upload_type
+        return self.parameters['uploadType'] || self.parameters['upload_type']
+      end
+
+      # @!attribute http_method
+      # @return [Symbol] HTTP method if invoking a URI
+      def http_method
+        return @http_method ||= self.api_method.http_method.to_s.downcase.to_sym
+      end
+
+      def http_method=(new_http_method)
+        if new_http_method.kind_of?(Symbol)
+          @http_method = new_http_method.to_s.downcase.to_sym
+        elsif new_http_method.respond_to?(:to_str)
+          @http_method = new_http_method.to_s.downcase.to_sym
+        else
+          raise TypeError,
+            "Expected String or Symbol, got #{new_http_method.class}."
+        end
+      end
+
+      def api_method=(new_api_method)
+        if new_api_method.nil? || new_api_method.kind_of?(Google::APIClient::Method)
+          @api_method = new_api_method
+        else
+          raise TypeError,
+            "Expected Google::APIClient::Method, got #{new_api_method.class}."
+        end
+      end
+
+      # @!attribute uri
+      # @return [Addressable::URI] URI to send request
+      def uri
+        return @uri ||= self.api_method.generate_uri(self.parameters)
+      end
+
+      def uri=(new_uri)
+        @uri = Addressable::URI.parse(new_uri)
+        @parameters.update(@uri.query_values) unless @uri.query_values.nil?
+      end
+
+
+      # Transmits the request with the given connection
+      #
+      # @api private
+      #
+      # @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, 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)
+        result = self.process_http_response(http_response)
+
+        logger.debug { "#{self.class} Result: #{result.status} #{result.headers}" }
+
+        # Resumamble slightly different than other upload protocols in that it requires at least
+        # 2 requests.
+        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)
+          end
+        end
+        return result
+      end
+
+      # Convert to an HTTP request. Returns components in order of method, URI,
+      # request headers, and body
+      #
+      # @api private
+      #
+      # @return [Array<(Symbol, Addressable::URI, Hash, [#read,#to_str])>]
+      def to_http_request
+        request = (
+          if self.api_method
+            self.api_method.generate_request(self.parameters, self.body, self.headers)
+          elsif self.uri
+            unless self.parameters.empty?
+              self.uri.query = Addressable::URI.form_encode(self.parameters)
+            end
+            [self.http_method, self.uri.to_s, self.headers, self.body]
+          end)
+        return request
+      end
+
+      ##
+      # Hashified verison of the API request
+      #
+      # @return [Hash]
+      def to_hash
+        options = {}
+        if self.api_method
+          options[:api_method] = self.api_method
+          options[:parameters] = self.parameters
+        else
+          options[:http_method] = self.http_method
+          options[:uri] = self.uri
+        end
+        options[:headers] = self.headers
+        options[:body] = self.body
+        options[:media] = self.media
+        unless self.authorization.nil?
+          options[:authorization] = self.authorization
+        end
+        return options
+      end
+
+      ##
+      # Prepares the request for execution, building a hash of parts
+      # suitable for sending to Faraday::Connection.
+      #
+      # @api private
+      #
+      # @param [Faraday::Connection] connection
+      #   Connection for building the request
+      #
+      # @return [Hash]
+      #   Encoded request
+      def to_env(connection)
+        method, uri, headers, body = self.to_http_request
+        http_request = connection.build_request(method) do |req|
+          req.url(uri.to_s)
+          req.headers.update(headers)
+          req.body = body
+        end
+
+        if self.authorization.respond_to?(:generate_authenticated_request)
+          http_request = self.authorization.generate_authenticated_request(
+            :request => http_request,
+            :connection => connection
+          )
+        end
+
+        request_env = http_request.to_env(connection)
+      end
+
+      ##
+      # Convert HTTP response to an API Result
+      #
+      # @api private
+      #
+      # @param [Faraday::Response] response
+      #   HTTP response
+      #
+      # @return [Google::APIClient::Result]
+      #   Processed API response
+      def process_http_response(response)
+        Result.new(self, response)
+      end
+
+      protected
+
+      ##
+      # Adjust headers & body for media uploads
+      #
+      # @api private
+      #
+      # @param [Hash] options
+      # @option options [Hash, Array] :parameters
+      #   Request parameters for the API method.
+      # @option options [Google::APIClient::UploadIO] :media
+      #   File to upload, if media upload request
+      # @option options [#to_json, #to_hash] :body_object
+      #   Main body of the API request. Typically hash or object that can
+      #   be serialized to JSON
+      # @option options [#read, #to_str] :body
+      #   Raw body to send in POST/PUT requests
+      def initialize_media_upload(options)
+        self.media = options[:media]
+        case self.upload_type
+        when "media"
+          if options[:body] || options[:body_object]
+            raise ArgumentError, "Can not specify body & body object for simple uploads"
+          end
+          self.headers['Content-Type'] ||= self.media.content_type
+          self.headers['Content-Length'] ||= self.media.length.to_s
+          self.body = self.media
+        when "multipart"
+          unless options[:body_object]
+            raise ArgumentError, "Multipart requested but no body object"
+          end
+          metadata = StringIO.new(serialize_body(options[:body_object]))
+          build_multipart([Faraday::UploadIO.new(metadata, 'application/json', 'file.json'), self.media])
+        when "resumable"
+          file_length = self.media.length
+          self.headers['X-Upload-Content-Type'] = self.media.content_type
+          self.headers['X-Upload-Content-Length'] = file_length.to_s
+          if options[:body_object]
+            self.headers['Content-Type'] ||= 'application/json'
+            self.body = serialize_body(options[:body_object])
+          else
+            self.body = ''
+          end
+        end
+      end
+
+      ##
+      # Assemble a multipart message from a set of parts
+      #
+      # @api private
+      #
+      # @param [Array<[#read,#to_str]>] parts
+      #   Array of parts to encode.
+      # @param [String] mime_type
+      #   MIME type of the message
+      # @param [String] boundary
+      #   Boundary for separating each part of the message
+      def build_multipart(parts, mime_type = 'multipart/related', boundary = MULTIPART_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])
+      end
+
+      ##
+      # Serialize body object to JSON
+      #
+      # @api private
+      #
+      # @param [#to_json,#to_hash] body
+      #   object to serialize
+      #
+      # @return [String]
+      #   JSON
+      def serialize_body(body)
+        return body.to_json if body.respond_to?(:to_json)
+        return MultiJson.dump(body.to_hash) if body.respond_to?(:to_hash)
+        raise TypeError, 'Could not convert body object to JSON.' +
+                         'Must respond to :to_json or :to_hash.'
+      end
+
+    end
+  end
+end

data/lib/google/api_client/result.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.
+
+
+module Google
+  class APIClient
+    ##
+    # This class wraps a result returned by an API call.
+    class Result
+      extend Forwardable
+      
+      ##
+      # Init the result
+      #
+      # @param [Google::APIClient::Request] request
+      #   The original request
+      # @param [Faraday::Response] response
+      #   Raw HTTP Response
+      def initialize(request, response)
+        @request = request
+        @response = response
+        @media_upload = reference if reference.kind_of?(ResumableUpload)
+      end
+
+      # @return [Google::APIClient::Request] Original request object
+      attr_reader :request
+      # @return [Faraday::Response] HTTP response
+      attr_reader :response
+      # @!attribute [r] reference
+      #   @return [Google::APIClient::Request] Original request object
+      #   @deprecated See {#request}
+      alias_method :reference, :request # For compatibility with pre-beta clients
+
+      # @!attribute [r] status
+      #   @return [Fixnum] HTTP status code
+      # @!attribute [r] headers
+      #   @return [Hash] HTTP response headers
+      # @!attribute [r] body
+      #   @return [String] HTTP response body
+      def_delegators :@response, :status, :headers, :body
+
+      # @!attribute [r] resumable_upload
+      # @return [Google::APIClient::ResumableUpload] For resuming media uploads
+      def resumable_upload        
+        @media_upload ||= (
+          options = self.reference.to_hash.merge(
+            :uri => self.headers['location'],
+            :media => self.reference.media
+          )
+          Google::APIClient::ResumableUpload.new(options)
+        )
+      end
+      
+      ##
+      # Get the content type of the response
+      # @!attribute [r] media_type
+      # @return [String]
+      #  Value of content-type header
+      def media_type
+        _, content_type = self.headers.detect do |h, v|
+          h.downcase == 'Content-Type'.downcase
+        end
+        if content_type
+          return content_type[/^([^;]*);?.*$/, 1].strip.downcase
+        else
+          return nil
+        end
+      end
+      
+      ##
+      # Check if request failed
+      #
+      # @!attribute [r] error?
+      # @return [TrueClass, FalseClass]
+      #   true if result of operation is an error
+      def error?
+        return self.response.status >= 400
+      end
+
+      ##
+      # Check if request was successful
+      #
+      # @!attribute [r] success?
+      # @return [TrueClass, FalseClass]
+      #   true if result of operation was successful
+      def success?
+        return !self.error?
+      end
+      
+      ##
+      # Extracts error messages from the response body
+      #
+      # @!attribute [r] error_message
+      # @return [String]
+      #   error message, if available
+      def error_message
+        if self.data?
+          if self.data.respond_to?(:error) &&
+             self.data.error.respond_to?(:message)
+            # You're going to get a terrible error message if the response isn't
+            # parsed successfully as an error.
+            return self.data.error.message
+          elsif self.data['error'] && self.data['error']['message']
+            return self.data['error']['message']
+          end
+        end
+        return self.body
+      end
+
+      ##
+      # Check for parsable data in response
+      #
+      # @!attribute [r] data?
+      # @return [TrueClass, FalseClass]
+      #   true if body can be parsed
+      def data?
+        !(self.body.nil? || self.body.empty? || self.media_type != 'application/json')
+      end
+      
+      ##
+      # Return parsed version of the response body.
+      #
+      # @!attribute [r] data
+      # @return [Object, Hash, String]
+      #   Object if body parsable from API schema, Hash if JSON, raw body if unable to parse
+      def data
+        return @data ||= (begin
+          if self.data?
+            media_type = self.media_type
+            data = self.body
+            case media_type
+            when 'application/json'
+              data = MultiJson.load(data)
+              # Strip data wrapper, if present
+              data = data['data'] if data.has_key?('data')
+            else
+              raise ArgumentError,
+                "Content-Type not supported for parsing: #{media_type}"
+            end
+            if @request.api_method && @request.api_method.response_schema
+              # Automatically parse using the schema designated for the
+              # response of this API method.
+              data = @request.api_method.response_schema.new(data)
+              data
+            else
+              # Otherwise, return the raw unparsed value.
+              # This value must be indexable like a Hash.
+              data
+            end
+          end
+        end)
+      end
+
+      ##
+      # Get the token used for requesting the next page of data
+      #
+      # @!attribute [r] next_page_token
+      # @return [String]
+      #   next page token
+      def next_page_token
+        if self.data.respond_to?(:next_page_token)
+          return self.data.next_page_token
+        elsif self.data.respond_to?(:[])
+          return self.data["nextPageToken"]
+        else
+          raise TypeError, "Data object did not respond to #next_page_token."
+        end
+      end
+
+      ##
+      # Build a request for fetching the next page of data
+      # 
+      # @return [Google::APIClient::Request]
+      #   API request for retrieving next page
+      def next_page
+        merged_parameters = Hash[self.reference.parameters].merge({
+          self.page_token_param => self.next_page_token
+        })
+        # Because Requests can be coerced to Hashes, we can merge them,
+        # preserving all context except the API method parameters that we're
+        # using for pagination.
+        return Google::APIClient::Request.new(
+          Hash[self.reference].merge(:parameters => merged_parameters)
+        )
+      end
+
+      ##
+      # Get the token used for requesting the previous page of data
+      #
+      # @!attribute [r] prev_page_token
+      # @return [String]
+      #   previous page token
+      def prev_page_token
+        if self.data.respond_to?(:prev_page_token)
+          return self.data.prev_page_token
+        elsif self.data.respond_to?(:[])
+          return self.data["prevPageToken"]
+        else
+          raise TypeError, "Data object did not respond to #next_page_token."
+        end
+      end
+
+      ##
+      # Build a request for fetching the previous page of data
+      # 
+      # @return [Google::APIClient::Request]
+      #   API request for retrieving previous page
+      def prev_page
+        merged_parameters = Hash[self.reference.parameters].merge({
+          self.page_token_param => self.prev_page_token
+        })
+        # Because Requests can be coerced to Hashes, we can merge them,
+        # preserving all context except the API method parameters that we're
+        # using for pagination.
+        return Google::APIClient::Request.new(
+          Hash[self.reference].merge(:parameters => merged_parameters)
+        )
+      end
+      
+      ##
+      # Pagination scheme used by this request/response
+      #
+      # @!attribute [r] pagination_type
+      # @return [Symbol]
+      #  currently always :token
+      def pagination_type
+        return :token
+      end
+
+      ##
+      # Name of the field that contains the pagination token
+      #
+      # @!attribute [r] page_token_param
+      # @return [String]
+      #  currently always 'pageToken'
+      def page_token_param
+        return "pageToken"
+      end
+
+    end
+  end
+end