265 lines
8.9 KiB
Ruby
265 lines
8.9 KiB
Ruby
# 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.
|
|
|
|
|
|
gem 'faraday', '~> 0.7.0'
|
|
require 'faraday'
|
|
require 'faraday/utils'
|
|
require 'multi_json'
|
|
require 'addressable/uri'
|
|
require 'stringio'
|
|
require 'google/api_client/discovery'
|
|
|
|
|
|
module Google
|
|
class APIClient
|
|
class Reference
|
|
|
|
MULTIPART_BOUNDARY = "-----------RubyApiMultipartPost".freeze
|
|
def initialize(options={})
|
|
# We only need this to do lookups on method ID String values
|
|
# It's optional, but method ID lookups will fail if the client is
|
|
# omitted.
|
|
@client = options[:client]
|
|
@version = options[:version] || 'v1'
|
|
|
|
self.connection = options[:connection] || Faraday.default_connection
|
|
self.api_method = options[:api_method]
|
|
self.parameters = options[:parameters] || {}
|
|
# 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]
|
|
self.headers = options[:headers] || {}
|
|
|
|
if options[:media]
|
|
self.media = options[:media]
|
|
upload_type = parameters['uploadType'] || parameters['upload_type']
|
|
case 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.body = self.media
|
|
when "multipart"
|
|
unless options[:body_object]
|
|
raise ArgumentError, "Multipart requested but no body object"
|
|
end
|
|
# This is all a bit of a hack due to signet requiring body to be a string
|
|
# Ideally, update signet to delay serialization so we can just pass
|
|
# streams all the way down through to the HTTP lib
|
|
metadata = StringIO.new(serialize_body(options[:body_object]))
|
|
env = {
|
|
:request_headers => {'Content-Type' => "multipart/related;boundary=#{MULTIPART_BOUNDARY}"},
|
|
:request => { :boundary => MULTIPART_BOUNDARY }
|
|
}
|
|
multipart = Faraday::Request::Multipart.new
|
|
self.body = multipart.create_multipart(env, [
|
|
[nil,Faraday::UploadIO.new(metadata, 'application/json', 'file.json')],
|
|
[nil, self.media]])
|
|
self.headers.update(env[:request_headers])
|
|
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
|
|
else
|
|
raise ArgumentError, "Invalid uploadType for media"
|
|
end
|
|
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]
|
|
unless self.parameters.empty?
|
|
self.uri.query_values =
|
|
(self.uri.query_values || {}).merge(self.parameters)
|
|
end
|
|
end
|
|
end
|
|
|
|
def serialize_body(body)
|
|
return body.to_json if body.respond_to?(:to_json)
|
|
return MultiJson.dump(options[:body_object].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
|
|
|
|
def media
|
|
return @media
|
|
end
|
|
|
|
def media=(media)
|
|
@media = (media)
|
|
end
|
|
|
|
def connection
|
|
return @connection
|
|
end
|
|
|
|
def connection=(new_connection)
|
|
if new_connection.kind_of?(Faraday::Connection)
|
|
@connection = new_connection
|
|
else
|
|
raise TypeError,
|
|
"Expected Faraday::Connection, got #{new_connection.class}."
|
|
end
|
|
end
|
|
|
|
def api_method
|
|
return @api_method
|
|
end
|
|
|
|
def api_method=(new_api_method)
|
|
if new_api_method.kind_of?(Google::APIClient::Method) ||
|
|
new_api_method == nil
|
|
@api_method = new_api_method
|
|
elsif new_api_method.respond_to?(:to_str) ||
|
|
new_api_method.kind_of?(Symbol)
|
|
unless @client
|
|
raise ArgumentError,
|
|
"API method lookup impossible without client instance."
|
|
end
|
|
new_api_method = new_api_method.to_s
|
|
# This method of guessing the API is unreliable. This will fail for
|
|
# APIs where the first segment of the RPC name does not match the
|
|
# service name. However, this is a fallback mechanism anyway.
|
|
# Developers should be passing in a reference to the method, rather
|
|
# than passing in a string or symbol. This should raise an error
|
|
# in the case of a mismatch.
|
|
api = new_api_method[/^([^.]+)\./, 1]
|
|
@api_method = @client.discovered_method(
|
|
new_api_method, api, @version
|
|
)
|
|
if @api_method
|
|
# Ditch the client reference, we won't need it again.
|
|
@client = nil
|
|
else
|
|
raise ArgumentError, "API method could not be found."
|
|
end
|
|
else
|
|
raise TypeError,
|
|
"Expected Google::APIClient::Method, got #{new_api_method.class}."
|
|
end
|
|
end
|
|
|
|
def parameters
|
|
return @parameters
|
|
end
|
|
|
|
def parameters=(new_parameters)
|
|
# No type-checking needed, the Method class handles this.
|
|
@parameters = new_parameters
|
|
end
|
|
|
|
def body
|
|
return @body
|
|
end
|
|
|
|
def body=(new_body)
|
|
if new_body.respond_to?(:to_str)
|
|
@body = new_body.to_str
|
|
elsif new_body.respond_to?(:read)
|
|
@body = new_body.read()
|
|
elsif new_body.respond_to?(:inject)
|
|
@body = (new_body.inject(StringIO.new) do |accu, chunk|
|
|
accu.write(chunk)
|
|
accu
|
|
end).string
|
|
else
|
|
raise TypeError, "Expected body to be String, IO, or Enumerable chunks."
|
|
end
|
|
end
|
|
|
|
def headers
|
|
return @headers ||= {}
|
|
end
|
|
|
|
def headers=(new_headers)
|
|
if new_headers.kind_of?(Array) || new_headers.kind_of?(Hash)
|
|
@headers = new_headers
|
|
else
|
|
raise TypeError, "Expected Hash or Array, got #{new_headers.class}."
|
|
end
|
|
end
|
|
|
|
def http_method
|
|
return @http_method ||= self.api_method.http_method
|
|
end
|
|
|
|
def http_method=(new_http_method)
|
|
if new_http_method.kind_of?(Symbol)
|
|
@http_method = new_http_method.to_s.upcase
|
|
elsif new_http_method.respond_to?(:to_str)
|
|
@http_method = new_http_method.to_str.upcase
|
|
else
|
|
raise TypeError,
|
|
"Expected String or Symbol, got #{new_http_method.class}."
|
|
end
|
|
end
|
|
|
|
def uri
|
|
return @uri ||= self.api_method.generate_uri(self.parameters)
|
|
end
|
|
|
|
def uri=(new_uri)
|
|
@uri = Addressable::URI.parse(new_uri)
|
|
end
|
|
|
|
def to_request
|
|
if self.api_method
|
|
return self.api_method.generate_request(
|
|
self.parameters, self.body, self.headers
|
|
)
|
|
else
|
|
return Faraday::Request.create(
|
|
self.http_method.to_s.downcase.to_sym
|
|
) do |req|
|
|
req.url(Addressable::URI.parse(self.uri))
|
|
req.headers = Faraday::Utils::Headers.new(self.headers)
|
|
req.body = self.body
|
|
end
|
|
end
|
|
end
|
|
|
|
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[:connection] = self.connection
|
|
return options
|
|
end
|
|
end
|
|
end
|
|
end
|