# limitations under the License.
-require 'json'
-require 'addressable/uri'
-require 'addressable/template'
-
-require 'google/inflection'
-require 'google/api_client/errors'
-
-module Google
- class APIClient
- ##
- # A service that has been described by a discovery document.
- class API
-
- ##
- # 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
- # The section of the discovery document that applies to this service
- # version.
- #
- # @return [Google::APIClient::API] The constructed service object.
- 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|
- 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|
- method_name = Google::INFLECTOR.underscore(method.name).to_sym
- if !self.respond_to?(method_name)
- metaclass.send(:define_method, method_name) { method }
- end
- end
- end
-
- ##
- # Returns the id of the service.
- #
- # @return [String] The service id.
- def id
- return @discovery_document['id']
- end
-
- ##
- # Returns the identifier for the service.
- #
- # @return [String] The service identifier.
- def name
- return @discovery_document['name']
- end
-
- ##
- # Returns the version of the service.
- #
- # @return [String] The service version.
- def version
- return @discovery_document['version']
- end
-
- ##
- # Returns the parsed section of the discovery document that applies to
- # this version of the service.
- #
- # @return [Hash] The service description.
- def description
- return @discovery_document['description']
- end
-
- ##
- # Returns true if this is the preferred version of this API.
- #
- # @return [TrueClass, FalseClass]
- # Whether or not this is the preferred version of this API.
- def preferred
- return @discovery_document['preferred']
- end
-
- ##
- # Returns the base URI for the discovery document.
- #
- # @return [Addressable::URI] The base URI.
- attr_reader :document_base
-
- ##
- # Returns the base URI for this version of the service.
- #
- # @return [Addressable::URI] The base URI that methods are joined to.
- def method_base
- if @discovery_document['basePath']
- return @method_base ||= (
- self.document_base +
- Addressable::URI.parse(@discovery_document['basePath'])
- ).normalize
- else
- return nil
- end
- end
-
- ##
- # Updates the hierarchy of resources and methods with the new base.
- #
- # @param [Addressable::URI, #to_str, String] new_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|
- resource.method_base = @method_base
- end
- self.methods.each do |method|
- method.method_base = @method_base
- end
- end
-
- ##
- # A list of resources available at the root level of this version of the
- # service.
- #
- # @return [Array] A list of {Google::APIClient::Resource} objects.
- def resources
- return @resources ||= (
- (@discovery_document['resources'] || []).inject([]) do |accu, (k, v)|
- accu << Google::APIClient::Resource.new(self.method_base, k, v)
- accu
- end
- )
- end
-
- ##
- # A list of methods available at the root level of this version of the
- # service.
- #
- # @return [Array] A list of {Google::APIClient::Method} objects.
- def methods
- return @methods ||= (
- (@discovery_document['methods'] || []).inject([]) do |accu, (k, v)|
- accu << Google::APIClient::Method.new(self.method_base, k, v)
- accu
- end
- )
- end
-
- ##
- # Converts the service to a flat mapping of RPC names and method objects.
- #
- # @return [Hash] All methods available on the service.
- #
- # @example
- # # Discover available methods
- # method_names = client.discovered_api('buzz').to_h.keys
- def to_h
- return @hash ||= (begin
- methods_hash = {}
- self.methods.each do |method|
- methods_hash[method.id] = method
- end
- self.resources.each do |resource|
- methods_hash.merge!(resource.to_h)
- end
- methods_hash
- end)
- end
-
- ##
- # Returns a <code>String</code> representation of the service's state.
- #
- # @return [String] The service's state, as a <code>String</code>.
- def inspect
- sprintf(
- "#<%s:%#0x ID:%s>", self.class.to_s, self.object_id, self.id
- )
- end
- end
-
- ##
- # A resource that has been described by a discovery document.
- class Resource
-
- ##
- # Creates a description of a particular version of a resource.
- #
- # @param [Addressable::URI] base
- # The base URI for the service.
- # @param [String] resource_name
- # The identifier for the resource.
- # @param [Hash] resource_description
- # The section of the discovery document that applies to this resource.
- #
- # @return [Google::APIClient::Resource] The constructed resource object.
- def initialize(method_base, resource_name, discovery_document)
- @method_base = method_base
- @name = resource_name
- @discovery_document = discovery_document
- metaclass = (class <<self; self; end)
- self.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|
- method_name = Google::INFLECTOR.underscore(method.name).to_sym
- if !self.respond_to?(method_name)
- metaclass.send(:define_method, method_name) { method }
- end
- end
- end
-
- ##
- # Returns the identifier for the resource.
- #
- # @return [String] The resource identifier.
- attr_reader :name
-
- ##
- # Returns the parsed section of the discovery document that applies to
- # this resource.
- #
- # @return [Hash] The resource description.
- attr_reader :description
-
- ##
- # Returns the base URI for this resource.
- #
- # @return [Addressable::URI] The base URI that methods are joined to.
- attr_reader :method_base
-
- ##
- # Updates the hierarchy of resources and methods with the new base.
- #
- # @param [Addressable::URI, #to_str, String] new_base
- # The new base URI to use for the resource.
- def method_base=(new_method_base)
- @method_base = Addressable::URI.parse(new_method_base)
- self.resources.each do |resource|
- resource.method_base = @method_base
- end
- self.methods.each do |method|
- method.method_base = @method_base
- end
- end
-
- ##
- # A list of sub-resources available on this resource.
- #
- # @return [Array] A list of {Google::APIClient::Resource} objects.
- def resources
- return @resources ||= (
- (@discovery_document['resources'] || []).inject([]) do |accu, (k, v)|
- accu << Google::APIClient::Resource.new(self.method_base, k, v)
- accu
- end
- )
- end
-
- ##
- # A list of methods available on this resource.
- #
- # @return [Array] A list of {Google::APIClient::Method} objects.
- def methods
- return @methods ||= (
- (@discovery_document['methods'] || []).inject([]) do |accu, (k, v)|
- accu << Google::APIClient::Method.new(self.method_base, k, v)
- accu
- end
- )
- end
-
- ##
- # Converts the resource to a flat mapping of RPC names and method
- # objects.
- #
- # @return [Hash] All methods available on the resource.
- def to_h
- return @hash ||= (begin
- methods_hash = {}
- self.methods.each do |method|
- methods_hash[method.id] = method
- end
- self.resources.each do |resource|
- methods_hash.merge!(resource.to_h)
- end
- methods_hash
- end)
- end
-
- ##
- # Returns a <code>String</code> representation of the resource's state.
- #
- # @return [String] The resource's state, as a <code>String</code>.
- def inspect
- sprintf(
- "#<%s:%#0x NAME:%s>", self.class.to_s, self.object_id, self.name
- )
- end
- end
-
- ##
- # A method that has been described by a discovery document.
- class Method
-
- ##
- # Creates a description of a particular method.
- #
- # @param [Addressable::URI] method_base
- # The base URI for the service.
- # @param [String] method_name
- # The identifier for the method.
- # @param [Hash] method_description
- # The section of the discovery document that applies to this method.
- #
- # @return [Google::APIClient::Method] The constructed method object.
- def initialize(method_base, method_name, discovery_document)
- @method_base = method_base
- @name = method_name
- @discovery_document = discovery_document
- end
-
- ##
- # Returns the identifier for the method.
- #
- # @return [String] The method identifier.
- attr_reader :name
-
- ##
- # Returns the parsed section of the discovery document that applies to
- # this method.
- #
- # @return [Hash] The method description.
- attr_reader :description
-
- ##
- # Returns the base URI for the method.
- #
- # @return [Addressable::URI]
- # The base URI that this method will be joined to.
- attr_reader :method_base
-
- ##
- # Updates the method with the new base.
- #
- # @param [Addressable::URI, #to_str, String] new_base
- # The new base URI to use for the method.
- def method_base=(new_method_base)
- @method_base = Addressable::URI.parse(new_method_base)
- @uri_template = nil
- end
-
- ##
- # Returns the method ID.
- #
- # @return [String] The method identifier.
- def id
- return @discovery_document['id']
- end
-
- ##
- # Returns the HTTP method or 'GET' if none is specified.
- #
- # @return [String] The HTTP method that will be used in the request.
- def http_method
- return @discovery_document['httpMethod'] || 'GET'
- end
-
- ##
- # Returns the URI template for the method. A parameter list can be
- # used to expand this into a URI.
- #
- # @return [Addressable::Template] The URI template.
- def uri_template
- # TODO(bobaman) We shouldn't be calling #to_s here, this should be
- # a join operation on a URI, but we have to treat these as Strings
- # because of the way the discovery document provides the URIs.
- # This should be fixed soon.
- return @uri_template ||= Addressable::Template.new(
- self.method_base + @discovery_document['path']
- )
- end
-
- ##
- # Normalizes parameters, converting to the appropriate types.
- #
- # @param [Hash, Array] parameters
- # The parameters to normalize.
- #
- # @return [Hash] The normalized parameters.
- def normalize_parameters(parameters={})
- # Convert keys to Strings when appropriate
- if parameters.kind_of?(Hash) || parameters.kind_of?(Array)
- # Is a Hash or an Array a better return type? Do we ever need to
- # worry about the same parameter being sent twice with different
- # values?
- parameters = parameters.inject({}) do |accu, (k, v)|
- k = k.to_s if k.kind_of?(Symbol)
- k = k.to_str if k.respond_to?(:to_str)
- unless k.kind_of?(String)
- raise TypeError, "Expected String, got #{k.class}."
- end
- accu[k] = v
- accu
- end
- else
- raise TypeError,
- "Expected Hash or Array, got #{parameters.class}."
- end
- return parameters
- end
-
- ##
- # Expands the method's URI template using a parameter list.
- #
- # @param [Hash, Array] parameters
- # The parameter list to use.
- #
- # @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
- uri = self.uri_template.expand(parameters)
- query_parameters = parameters.reject do |k, v|
- template_variables.include?(k)
- end
- if query_parameters.size > 0
- uri.query_values = (uri.query_values || {}).merge(query_parameters)
- end
- # Normalization is necessary because of undesirable percent-escaping
- # during URI template expansion
- return uri.normalize
- end
-
- ##
- # Generates an HTTP request for this method.
- #
- # @param [Hash, Array] parameters
- # The parameters to send.
- # @param [String, StringIO] body The body for the HTTP request.
- # @param [Hash, Array] headers The HTTP headers for the request.
- #
- # @return [Array] The generated HTTP request.
- def generate_request(parameters={}, body='', headers=[])
- if body.respond_to?(:string)
- body = body.string
- elsif body.respond_to?(:to_str)
- body = body.to_str
- else
- raise TypeError, "Expected String or StringIO, got #{body.class}."
- end
- if !headers.kind_of?(Array) && !headers.kind_of?(Hash)
- raise TypeError, "Expected Hash or Array, got #{headers.class}."
- end
- method = self.http_method
- uri = self.generate_uri(parameters)
- headers = headers.to_a if headers.kind_of?(Hash)
- return [method, uri.to_str, headers, [body]]
- end
-
- ##
- # Returns a <code>Hash</code> of the parameter descriptions for
- # this method.
- #
- # @return [Hash] The parameter descriptions.
- def parameter_descriptions
- @parameter_descriptions ||= (
- @discovery_document['parameters'] || {}
- ).inject({}) { |h,(k,v)| h[k]=v; h }
- end
-
- ##
- # Returns an <code>Array</code> of the parameters for this method.
- #
- # @return [Array] The parameters.
- def parameters
- @parameters ||= ((
- @discovery_document['parameters'] || {}
- ).inject({}) { |h,(k,v)| h[k]=v; h }).keys
- end
-
- ##
- # Returns an <code>Array</code> of the required parameters for this
- # method.
- #
- # @return [Array] The required parameters.
- #
- # @example
- # # A list of all required parameters.
- # method.required_parameters
- def required_parameters
- @required_parameters ||= ((self.parameter_descriptions.select do |k, v|
- v['required']
- end).inject({}) { |h,(k,v)| h[k]=v; h }).keys
- end
-
- ##
- # Returns an <code>Array</code> of the optional parameters for this
- # method.
- #
- # @return [Array] The optional parameters.
- #
- # @example
- # # A list of all optional parameters.
- # method.optional_parameters
- def optional_parameters
- @optional_parameters ||= ((self.parameter_descriptions.reject do |k, v|
- v['required']
- end).inject({}) { |h,(k,v)| h[k]=v; h }).keys
- end
-
- ##
- # Verifies that the parameters are valid for this method. Raises an
- # exception if validation fails.
- #
- # @param [Hash, Array] parameters
- # The parameters to verify.
- #
- # @return [NilClass] <code>nil</code> if validation passes.
- def validate_parameters(parameters={})
- parameters = self.normalize_parameters(parameters)
- required_variables = ((self.parameter_descriptions.select do |k, v|
- v['required']
- end).inject({}) { |h,(k,v)| h[k]=v; h }).keys
- missing_variables = required_variables - parameters.keys
- if missing_variables.size > 0
- raise ArgumentError,
- "Missing required parameters: #{missing_variables.join(', ')}."
- end
- parameters.each do |k, v|
- if self.parameter_descriptions[k]
- enum = self.parameter_descriptions[k]['enum']
- if enum && !enum.include?(v)
- raise ArgumentError,
- "Parameter '#{k}' has an invalid value: #{v}. " +
- "Must be one of #{enum.inspect}."
- end
- pattern = self.parameter_descriptions[k]['pattern']
- if pattern
- regexp = Regexp.new("^#{pattern}$")
- if v !~ regexp
- raise ArgumentError,
- "Parameter '#{k}' has an invalid value: #{v}. " +
- "Must match: /^#{pattern}$/."
- end
- end
- end
- end
- return nil
- end
-
- ##
- # Returns a <code>String</code> representation of the method's state.
- #
- # @return [String] The method's state, as a <code>String</code>.
- def inspect
- sprintf(
- "#<%s:%#0x ID:%s>",
- self.class.to_s, self.object_id, self.id
- )
- end
- end
- end
-end
+require 'google/api_client/discovery/api'
+require 'google/api_client/discovery/resource'
+require 'google/api_client/discovery/method'
--- /dev/null
+# 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 'addressable/uri'
+
+require 'google/inflection'
+require 'google/api_client/discovery/resource'
+require 'google/api_client/discovery/method'
+
+module Google
+ class APIClient
+ ##
+ # A service that has been described by a discovery document.
+ class API
+
+ ##
+ # 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
+ # The section of the discovery document that applies to this service
+ # version.
+ #
+ # @return [Google::APIClient::API] The constructed service object.
+ 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|
+ 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|
+ method_name = Google::INFLECTOR.underscore(method.name).to_sym
+ if !self.respond_to?(method_name)
+ metaclass.send(:define_method, method_name) { method }
+ end
+ end
+ end
+
+ ##
+ # Returns the id of the service.
+ #
+ # @return [String] The service id.
+ def id
+ return @discovery_document['id']
+ end
+
+ ##
+ # Returns the identifier for the service.
+ #
+ # @return [String] The service identifier.
+ def name
+ return @discovery_document['name']
+ end
+
+ ##
+ # Returns the version of the service.
+ #
+ # @return [String] The service version.
+ def version
+ return @discovery_document['version']
+ end
+
+ ##
+ # Returns the parsed section of the discovery document that applies to
+ # this version of the service.
+ #
+ # @return [Hash] The service description.
+ def description
+ return @discovery_document['description']
+ end
+
+ ##
+ # Returns true if this is the preferred version of this API.
+ #
+ # @return [TrueClass, FalseClass]
+ # Whether or not this is the preferred version of this API.
+ def preferred
+ return @discovery_document['preferred']
+ end
+
+ ##
+ # Returns the base URI for the discovery document.
+ #
+ # @return [Addressable::URI] The base URI.
+ attr_reader :document_base
+
+ ##
+ # Returns the base URI for this version of the service.
+ #
+ # @return [Addressable::URI] The base URI that methods are joined to.
+ def method_base
+ if @discovery_document['basePath']
+ return @method_base ||= (
+ self.document_base +
+ Addressable::URI.parse(@discovery_document['basePath'])
+ ).normalize
+ else
+ return nil
+ end
+ end
+
+ ##
+ # Updates the hierarchy of resources and methods with the new base.
+ #
+ # @param [Addressable::URI, #to_str, String] new_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|
+ resource.method_base = @method_base
+ end
+ self.methods.each do |method|
+ method.method_base = @method_base
+ end
+ end
+
+ ##
+ # A list of resources available at the root level of this version of the
+ # service.
+ #
+ # @return [Array] A list of {Google::APIClient::Resource} objects.
+ def resources
+ return @resources ||= (
+ (@discovery_document['resources'] || []).inject([]) do |accu, (k, v)|
+ accu << Google::APIClient::Resource.new(self.method_base, k, v)
+ accu
+ end
+ )
+ end
+
+ ##
+ # A list of methods available at the root level of this version of the
+ # service.
+ #
+ # @return [Array] A list of {Google::APIClient::Method} objects.
+ def methods
+ return @methods ||= (
+ (@discovery_document['methods'] || []).inject([]) do |accu, (k, v)|
+ accu << Google::APIClient::Method.new(self.method_base, k, v)
+ accu
+ end
+ )
+ end
+
+ ##
+ # Converts the service to a flat mapping of RPC names and method objects.
+ #
+ # @return [Hash] All methods available on the service.
+ #
+ # @example
+ # # Discover available methods
+ # method_names = client.discovered_api('buzz').to_h.keys
+ def to_h
+ return @hash ||= (begin
+ methods_hash = {}
+ self.methods.each do |method|
+ methods_hash[method.id] = method
+ end
+ self.resources.each do |resource|
+ methods_hash.merge!(resource.to_h)
+ end
+ methods_hash
+ end)
+ end
+
+ ##
+ # Returns a <code>String</code> representation of the service's state.
+ #
+ # @return [String] The service's state, as a <code>String</code>.
+ def inspect
+ sprintf(
+ "#<%s:%#0x ID:%s>", self.class.to_s, self.object_id, self.id
+ )
+ end
+ end
+ end
+end
--- /dev/null
+# 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 'addressable/uri'
+require 'addressable/template'
+
+require 'google/api_client/errors'
+
+module Google
+ class APIClient
+ ##
+ # A method that has been described by a discovery document.
+ class Method
+
+ ##
+ # Creates a description of a particular method.
+ #
+ # @param [Addressable::URI] method_base
+ # The base URI for the service.
+ # @param [String] method_name
+ # The identifier for the method.
+ # @param [Hash] method_description
+ # The section of the discovery document that applies to this method.
+ #
+ # @return [Google::APIClient::Method] The constructed method object.
+ def initialize(method_base, method_name, discovery_document)
+ @method_base = method_base
+ @name = method_name
+ @discovery_document = discovery_document
+ end
+
+ ##
+ # Returns the identifier for the method.
+ #
+ # @return [String] The method identifier.
+ attr_reader :name
+
+ ##
+ # Returns the parsed section of the discovery document that applies to
+ # this method.
+ #
+ # @return [Hash] The method description.
+ attr_reader :description
+
+ ##
+ # Returns the base URI for the method.
+ #
+ # @return [Addressable::URI]
+ # The base URI that this method will be joined to.
+ attr_reader :method_base
+
+ ##
+ # Updates the method with the new base.
+ #
+ # @param [Addressable::URI, #to_str, String] new_base
+ # The new base URI to use for the method.
+ def method_base=(new_method_base)
+ @method_base = Addressable::URI.parse(new_method_base)
+ @uri_template = nil
+ end
+
+ ##
+ # Returns the method ID.
+ #
+ # @return [String] The method identifier.
+ def id
+ return @discovery_document['id']
+ end
+
+ ##
+ # Returns the HTTP method or 'GET' if none is specified.
+ #
+ # @return [String] The HTTP method that will be used in the request.
+ def http_method
+ return @discovery_document['httpMethod'] || 'GET'
+ end
+
+ ##
+ # Returns the URI template for the method. A parameter list can be
+ # used to expand this into a URI.
+ #
+ # @return [Addressable::Template] The URI template.
+ def uri_template
+ # TODO(bobaman) We shouldn't be calling #to_s here, this should be
+ # a join operation on a URI, but we have to treat these as Strings
+ # because of the way the discovery document provides the URIs.
+ # This should be fixed soon.
+ return @uri_template ||= Addressable::Template.new(
+ self.method_base + @discovery_document['path']
+ )
+ end
+
+ ##
+ # Normalizes parameters, converting to the appropriate types.
+ #
+ # @param [Hash, Array] parameters
+ # The parameters to normalize.
+ #
+ # @return [Hash] The normalized parameters.
+ def normalize_parameters(parameters={})
+ # Convert keys to Strings when appropriate
+ if parameters.kind_of?(Hash) || parameters.kind_of?(Array)
+ # Is a Hash or an Array a better return type? Do we ever need to
+ # worry about the same parameter being sent twice with different
+ # values?
+ parameters = parameters.inject({}) do |accu, (k, v)|
+ k = k.to_s if k.kind_of?(Symbol)
+ k = k.to_str if k.respond_to?(:to_str)
+ unless k.kind_of?(String)
+ raise TypeError, "Expected String, got #{k.class}."
+ end
+ accu[k] = v
+ accu
+ end
+ else
+ raise TypeError,
+ "Expected Hash or Array, got #{parameters.class}."
+ end
+ return parameters
+ end
+
+ ##
+ # Expands the method's URI template using a parameter list.
+ #
+ # @param [Hash, Array] parameters
+ # The parameter list to use.
+ #
+ # @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
+ uri = self.uri_template.expand(parameters)
+ query_parameters = parameters.reject do |k, v|
+ template_variables.include?(k)
+ end
+ if query_parameters.size > 0
+ uri.query_values = (uri.query_values || {}).merge(query_parameters)
+ end
+ # Normalization is necessary because of undesirable percent-escaping
+ # during URI template expansion
+ return uri.normalize
+ end
+
+ ##
+ # Generates an HTTP request for this method.
+ #
+ # @param [Hash, Array] parameters
+ # The parameters to send.
+ # @param [String, StringIO] body The body for the HTTP request.
+ # @param [Hash, Array] headers The HTTP headers for the request.
+ #
+ # @return [Array] The generated HTTP request.
+ def generate_request(parameters={}, body='', headers=[])
+ if body.respond_to?(:string)
+ body = body.string
+ elsif body.respond_to?(:to_str)
+ body = body.to_str
+ else
+ raise TypeError, "Expected String or StringIO, got #{body.class}."
+ end
+ if !headers.kind_of?(Array) && !headers.kind_of?(Hash)
+ raise TypeError, "Expected Hash or Array, got #{headers.class}."
+ end
+ method = self.http_method
+ uri = self.generate_uri(parameters)
+ headers = headers.to_a if headers.kind_of?(Hash)
+ return [method, uri.to_str, headers, [body]]
+ end
+
+ ##
+ # Returns a <code>Hash</code> of the parameter descriptions for
+ # this method.
+ #
+ # @return [Hash] The parameter descriptions.
+ def parameter_descriptions
+ @parameter_descriptions ||= (
+ @discovery_document['parameters'] || {}
+ ).inject({}) { |h,(k,v)| h[k]=v; h }
+ end
+
+ ##
+ # Returns an <code>Array</code> of the parameters for this method.
+ #
+ # @return [Array] The parameters.
+ def parameters
+ @parameters ||= ((
+ @discovery_document['parameters'] || {}
+ ).inject({}) { |h,(k,v)| h[k]=v; h }).keys
+ end
+
+ ##
+ # Returns an <code>Array</code> of the required parameters for this
+ # method.
+ #
+ # @return [Array] The required parameters.
+ #
+ # @example
+ # # A list of all required parameters.
+ # method.required_parameters
+ def required_parameters
+ @required_parameters ||= ((self.parameter_descriptions.select do |k, v|
+ v['required']
+ end).inject({}) { |h,(k,v)| h[k]=v; h }).keys
+ end
+
+ ##
+ # Returns an <code>Array</code> of the optional parameters for this
+ # method.
+ #
+ # @return [Array] The optional parameters.
+ #
+ # @example
+ # # A list of all optional parameters.
+ # method.optional_parameters
+ def optional_parameters
+ @optional_parameters ||= ((self.parameter_descriptions.reject do |k, v|
+ v['required']
+ end).inject({}) { |h,(k,v)| h[k]=v; h }).keys
+ end
+
+ ##
+ # Verifies that the parameters are valid for this method. Raises an
+ # exception if validation fails.
+ #
+ # @param [Hash, Array] parameters
+ # The parameters to verify.
+ #
+ # @return [NilClass] <code>nil</code> if validation passes.
+ def validate_parameters(parameters={})
+ parameters = self.normalize_parameters(parameters)
+ required_variables = ((self.parameter_descriptions.select do |k, v|
+ v['required']
+ end).inject({}) { |h,(k,v)| h[k]=v; h }).keys
+ missing_variables = required_variables - parameters.keys
+ if missing_variables.size > 0
+ raise ArgumentError,
+ "Missing required parameters: #{missing_variables.join(', ')}."
+ end
+ parameters.each do |k, v|
+ if self.parameter_descriptions[k]
+ enum = self.parameter_descriptions[k]['enum']
+ if enum && !enum.include?(v)
+ raise ArgumentError,
+ "Parameter '#{k}' has an invalid value: #{v}. " +
+ "Must be one of #{enum.inspect}."
+ end
+ pattern = self.parameter_descriptions[k]['pattern']
+ if pattern
+ regexp = Regexp.new("^#{pattern}$")
+ if v !~ regexp
+ raise ArgumentError,
+ "Parameter '#{k}' has an invalid value: #{v}. " +
+ "Must match: /^#{pattern}$/."
+ end
+ end
+ end
+ end
+ return nil
+ end
+
+ ##
+ # Returns a <code>String</code> representation of the method's state.
+ #
+ # @return [String] The method's state, as a <code>String</code>.
+ def inspect
+ sprintf(
+ "#<%s:%#0x ID:%s>",
+ self.class.to_s, self.object_id, self.id
+ )
+ end
+ end
+ end
+end
--- /dev/null
+# 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 'addressable/uri'
+
+require 'google/inflection'
+require 'google/api_client/discovery/method'
+
+module Google
+ class APIClient
+ ##
+ # A resource that has been described by a discovery document.
+ class Resource
+
+ ##
+ # Creates a description of a particular version of a resource.
+ #
+ # @param [Addressable::URI] base
+ # The base URI for the service.
+ # @param [String] resource_name
+ # The identifier for the resource.
+ # @param [Hash] resource_description
+ # The section of the discovery document that applies to this resource.
+ #
+ # @return [Google::APIClient::Resource] The constructed resource object.
+ def initialize(method_base, resource_name, discovery_document)
+ @method_base = method_base
+ @name = resource_name
+ @discovery_document = discovery_document
+ metaclass = (class <<self; self; end)
+ self.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|
+ method_name = Google::INFLECTOR.underscore(method.name).to_sym
+ if !self.respond_to?(method_name)
+ metaclass.send(:define_method, method_name) { method }
+ end
+ end
+ end
+
+ ##
+ # Returns the identifier for the resource.
+ #
+ # @return [String] The resource identifier.
+ attr_reader :name
+
+ ##
+ # Returns the parsed section of the discovery document that applies to
+ # this resource.
+ #
+ # @return [Hash] The resource description.
+ attr_reader :description
+
+ ##
+ # Returns the base URI for this resource.
+ #
+ # @return [Addressable::URI] The base URI that methods are joined to.
+ attr_reader :method_base
+
+ ##
+ # Updates the hierarchy of resources and methods with the new base.
+ #
+ # @param [Addressable::URI, #to_str, String] new_base
+ # The new base URI to use for the resource.
+ def method_base=(new_method_base)
+ @method_base = Addressable::URI.parse(new_method_base)
+ self.resources.each do |resource|
+ resource.method_base = @method_base
+ end
+ self.methods.each do |method|
+ method.method_base = @method_base
+ end
+ end
+
+ ##
+ # A list of sub-resources available on this resource.
+ #
+ # @return [Array] A list of {Google::APIClient::Resource} objects.
+ def resources
+ return @resources ||= (
+ (@discovery_document['resources'] || []).inject([]) do |accu, (k, v)|
+ accu << Google::APIClient::Resource.new(self.method_base, k, v)
+ accu
+ end
+ )
+ end
+
+ ##
+ # A list of methods available on this resource.
+ #
+ # @return [Array] A list of {Google::APIClient::Method} objects.
+ def methods
+ return @methods ||= (
+ (@discovery_document['methods'] || []).inject([]) do |accu, (k, v)|
+ accu << Google::APIClient::Method.new(self.method_base, k, v)
+ accu
+ end
+ )
+ end
+
+ ##
+ # Converts the resource to a flat mapping of RPC names and method
+ # objects.
+ #
+ # @return [Hash] All methods available on the resource.
+ def to_h
+ return @hash ||= (begin
+ methods_hash = {}
+ self.methods.each do |method|
+ methods_hash[method.id] = method
+ end
+ self.resources.each do |resource|
+ methods_hash.merge!(resource.to_h)
+ end
+ methods_hash
+ end)
+ end
+
+ ##
+ # Returns a <code>String</code> representation of the resource's state.
+ #
+ # @return [String] The resource's state, as a <code>String</code>.
+ def inspect
+ sprintf(
+ "#<%s:%#0x NAME:%s>", self.class.to_s, self.object_id, self.name
+ )
+ end
+ end
+ end
+end