require 'google/inflection'
require 'google/api_client/discovery/resource'
require 'google/api_client/discovery/method'
+require 'google/api_client/discovery/media'
module Google
class APIClient
##
# Creates a description of a particular version of a service.
#
- # @param [String] api
- # The identifier for the service. Note that while this frequently
- # matches the first segment of all of the service's RPC names, this
- # should not be assumed. There is no requirement that these match.
- # @param [String] version
- # The identifier for the service version.
- # @param [Hash] api_description
+ # @param [String] document_base
+ # Base URI for the service
+ # @param [Hash] discovery_document
# The section of the discovery document that applies to this service
# version.
#
def initialize(document_base, discovery_document)
@document_base = Addressable::URI.parse(document_base)
@discovery_document = discovery_document
- metaclass = (class <<self; self; end)
- self.resources.each do |resource|
+ metaclass = (class << self; self; end)
+ self.discovered_resources.each do |resource|
method_name = Google::INFLECTOR.underscore(resource.name).to_sym
if !self.respond_to?(method_name)
metaclass.send(:define_method, method_name) { resource }
end
end
- self.methods.each do |method|
+ self.discovered_methods.each do |method|
method_name = Google::INFLECTOR.underscore(method.name).to_sym
if !self.respond_to?(method_name)
metaclass.send(:define_method, method_name) { method }
#
# @return [String] The service id.
def id
- return @discovery_document['id']
+ return (
+ @discovery_document['id'] ||
+ "#{self.name}:#{self.version}"
+ )
end
##
def method_base
if @discovery_document['basePath']
return @method_base ||= (
- self.document_base +
- Addressable::URI.parse(@discovery_document['basePath'])
+ self.document_base.join(Addressable::URI.parse(@discovery_document['basePath']))
).normalize
else
return nil
##
# Updates the hierarchy of resources and methods with the new base.
#
- # @param [Addressable::URI, #to_str, String] new_base
+ # @param [Addressable::URI, #to_str, String] new_method_base
# The new base URI to use for the service.
def method_base=(new_method_base)
@method_base = Addressable::URI.parse(new_method_base)
- self.resources.each do |resource|
+ self.discovered_resources.each do |resource|
resource.method_base = @method_base
end
- self.methods.each do |method|
+ self.discovered_methods.each do |method|
method.method_base = @method_base
end
end
+ ##
+ # Returns the base URI for batch calls to this service.
+ #
+ # @return [Addressable::URI] The base URI that methods are joined to.
+ def batch_path
+ if @discovery_document['batchPath']
+ return @batch_path ||= (
+ self.document_base.join(Addressable::URI.parse('/' +
+ @discovery_document['batchPath']))
+ ).normalize
+ else
+ return nil
+ end
+ end
+
+ ##
+ # A list of schemas available for this version of the API.
+ #
+ # @return [Hash] A list of {Google::APIClient::Schema} objects.
+ def schemas
+ return @schemas ||= (
+ (@discovery_document['schemas'] || []).inject({}) do |accu, (k, v)|
+ accu[k] = Google::APIClient::Schema.parse(self, v)
+ accu
+ end
+ )
+ end
+
+ ##
+ # Returns a schema for a kind value.
+ #
+ # @return [Google::APIClient::Schema] The associated Schema object.
+ def schema_for_kind(kind)
+ api_name, schema_name = kind.split('#', 2)
+ if api_name != self.name
+ raise ArgumentError,
+ "The kind does not match this API. " +
+ "Expected '#{self.name}', got '#{api_name}'."
+ end
+ for k, v in self.schemas
+ return v if k.downcase == schema_name.downcase
+ end
+ return nil
+ end
+
##
# A list of resources available at the root level of this version of the
- # service.
+ # API.
#
# @return [Array] A list of {Google::APIClient::Resource} objects.
- def resources
- return @resources ||= (
+ def discovered_resources
+ return @discovered_resources ||= (
(@discovery_document['resources'] || []).inject([]) do |accu, (k, v)|
- accu << Google::APIClient::Resource.new(self.method_base, k, v)
+ accu << Google::APIClient::Resource.new(
+ self, self.method_base, k, v
+ )
accu
end
)
##
# A list of methods available at the root level of this version of the
- # service.
+ # API.
#
# @return [Array] A list of {Google::APIClient::Method} objects.
- def methods
- return @methods ||= (
+ def discovered_methods
+ return @discovered_methods ||= (
(@discovery_document['methods'] || []).inject([]) do |accu, (k, v)|
- accu << Google::APIClient::Method.new(self.method_base, k, v)
+ accu << Google::APIClient::Method.new(self, self.method_base, k, v)
accu
end
)
def to_h
return @hash ||= (begin
methods_hash = {}
- self.methods.each do |method|
+ self.discovered_methods.each do |method|
methods_hash[method.id] = method
end
- self.resources.each do |resource|
+ self.discovered_resources.each do |resource|
methods_hash.merge!(resource.to_h)
end
methods_hash
projects / arvados.git / blobdiff