class Google::APIClient::Method

A method that has been described by a discovery document.

Attributes

api[R]

Returns the API this method belongs to.

@return [Google::APIClient::API] The API this method belongs to.

discovery_document[R]

@return [String] unparsed discovery document for the method

method_base[R]

Returns the base URI for the method.

@return [Addressable::URI]

The base URI that this method will be joined to.
name[R]

Returns the identifier for the method.

@return [String] The method identifier.

Public Class Methods

new(api, method_base, method_name, discovery_document) click to toggle source

Creates a description of a particular method.

@param [Google::APIClient::API] api

The API this method belongs to.

@param [Addressable::URI] #method_base

The base URI for the service.

@param [String] method_name

The identifier for the method.

@param [Hash] #discovery_document

The section of the discovery document that applies to this method.

@return [Google::APIClient::Method] The constructed method object.

# File lib/google/api_client/discovery/method.rb, line 41
def initialize(api, method_base, method_name, discovery_document)
  @api = api
  @method_base = method_base
  @name = method_name
  @discovery_document = discovery_document
end

Public Instance Methods

description() click to toggle source

Returns a human-readable description of the method.

@return [Hash] The API description.

# File lib/google/api_client/discovery/method.rb, line 84
def description
  return @discovery_document['description']
end
generate_request(parameters={}, body='', headers={}, options={}) click to toggle source

Generates an HTTP request for this method.

@api private @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. @option options [Faraday::Connection] :connection

The HTTP connection to use.

@return [Array] The generated HTTP request.

# File lib/google/api_client/discovery/method.rb, line 231
def generate_request(parameters={}, body='', headers={}, options={})
  if !headers.kind_of?(Array) && !headers.kind_of?(Hash)
    raise TypeError, "Expected Hash or Array, got #{headers.class}."
  end
  method = self.http_method.to_s.downcase.to_sym
  uri = self.generate_uri(parameters)
  headers = Faraday::Utils::Headers.new(headers)
  return [method, uri, headers, body]
end
generate_uri(parameters={}) click to toggle source

Expands the method's URI template using a parameter list.

@api private @param [Hash, Array] parameters

The parameter list to use.

@return [Addressable::URI] The URI after expansion.

# File lib/google/api_client/discovery/method.rb, line 188
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')
  if upload_type
    unless self.media_upload
      raise ArgumentException, "Media upload not supported for this method"
    end
    case upload_type.last
    when 'media', 'multipart', 'resumable'
      uri = self.media_upload.uri_template.expand(parameters)
    else
      raise ArgumentException, "Invalid uploadType '#{upload_type}'"
    end
  else
    uri = self.uri_template.expand(parameters)
  end
  query_parameters = parameters.reject do |k, v|
    template_variables.include?(k)
  end
  # encode all non-template parameters
  params = ""
  unless query_parameters.empty?
    params = "?" + Addressable::URI.form_encode(query_parameters.sort)
  end
  # Normalization is necessary because of undesirable percent-escaping
  # during URI template expansion
  return uri.normalize + params
end
http_method() click to toggle source

Returns the HTTP method or 'GET' if none is specified.

@return [String] The HTTP method that will be used in the request.

# File lib/google/api_client/discovery/method.rb, line 100
def http_method
  return @discovery_document['httpMethod'] || 'GET'
end
id() click to toggle source

Returns the method ID.

@return [String] The method identifier.

# File lib/google/api_client/discovery/method.rb, line 92
def id
  return @discovery_document['id']
end
inspect() click to toggle source

Returns a String representation of the method's state.

@return [String] The method's state, as a String.

# File lib/google/api_client/discovery/method.rb, line 354
def inspect
  sprintf(
    "#<%s:%#0x ID:%s>",
    self.class.to_s, self.object_id, self.id
  )
end
media_upload() click to toggle source

Returns media upload information for this method, if supported

@return [Google::APIClient::MediaUpload] Description of upload endpoints

# File lib/google/api_client/discovery/method.rb, line 119
def media_upload
  if @discovery_document['mediaUpload']
    return @media_upload ||= Google::APIClient::MediaUpload.new(self, self.method_base, @discovery_document['mediaUpload'])
  else
    return nil
  end
end
method_base=(new_method_base) click to toggle source

Updates the method with the new base.

@param [Addressable::URI, to_str, String] new_method_base

The new base URI to use for the method.
# File lib/google/api_client/discovery/method.rb, line 75
def method_base=(new_method_base)
  @method_base = Addressable::URI.parse(new_method_base)
  @uri_template = nil
end
normalize_parameters(parameters={}) click to toggle source

Normalizes parameters, converting to the appropriate types.

@param [Hash, Array] parameters

The parameters to normalize.

@return [Hash] The normalized parameters.

# File lib/google/api_client/discovery/method.rb, line 160
def normalize_parameters(parameters={})
  # Convert keys to Strings when appropriate
  if parameters.kind_of?(Hash) || parameters.kind_of?(Array)
    # Returning an array since parameters can be repeated (ie, Adsense Management API)
    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
optional_parameters() click to toggle source

Returns an Array of the optional parameters for this method.

@return [Array] The optional parameters.

@example

# A list of all optional parameters.
method.optional_parameters
# File lib/google/api_client/discovery/method.rb, line 287
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
parameter_descriptions() click to toggle source

Returns a Hash of the parameter descriptions for this method.

@return [Hash] The parameter descriptions.

# File lib/google/api_client/discovery/method.rb, line 247
def parameter_descriptions
  @parameter_descriptions ||= (
    @discovery_document['parameters'] || {}
  ).inject({}) { |h,(k,v)| h[k]=v; h }
end
parameters() click to toggle source

Returns an Array of the parameters for this method.

@return [Array] The parameters.

# File lib/google/api_client/discovery/method.rb, line 257
def parameters
  @parameters ||= ((
    @discovery_document['parameters'] || {}
  ).inject({}) { |h,(k,v)| h[k]=v; h }).keys
end
request_schema() click to toggle source

Returns the Schema object for the method's request, if any.

@return [Google::APIClient::Schema] The request schema.

# File lib/google/api_client/discovery/method.rb, line 131
def request_schema
  if @discovery_document['request']
    schema_name = @discovery_document['request']['$ref']
    return @api.schemas[schema_name]
  else
    return nil
  end
end
required_parameters() click to toggle source

Returns an Array of the required parameters for this method.

@return [Array] The required parameters.

@example

# A list of all required parameters.
method.required_parameters
# File lib/google/api_client/discovery/method.rb, line 272
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
response_schema() click to toggle source

Returns the Schema object for the method's response, if any.

@return [Google::APIClient::Schema] The response schema.

# File lib/google/api_client/discovery/method.rb, line 144
def response_schema
  if @discovery_document['response']
    schema_name = @discovery_document['response']['$ref']
    return @api.schemas[schema_name]
  else
    return nil
  end
end
uri_template() click to toggle source

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.

# File lib/google/api_client/discovery/method.rb, line 109
def uri_template
  return @uri_template ||= Addressable::Template.new(
    self.method_base.join(Addressable::URI.parse(@discovery_document['path']))
  )
end
validate_parameters(parameters={}) click to toggle source

Verifies that the parameters are valid for this method. Raises an exception if validation fails.

@api private @param [Hash, Array] parameters

The parameters to verify.

@return [NilClass] nil if validation passes.

# File lib/google/api_client/discovery/method.rb, line 302
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.map { |(k, _)| k }
  if missing_variables.size > 0
    raise ArgumentError,
      "Missing required parameters: #{missing_variables.join(', ')}."
  end
  parameters.each do |k, v|
    # Handle repeated parameters.
    if self.parameter_descriptions[k] &&
        self.parameter_descriptions[k]['repeated'] &&
        v.kind_of?(Array)
      # If this is a repeated parameter and we've got an array as a
      # value, just provide the whole array to the loop below.
      items = v
    else
      # If this is not a repeated parameter, or if it is but we're
      # being given a single value, wrap the value in an array, so that
      # the loop below still works for the single element.
      items = [v]
    end

    items.each do |item|
      if self.parameter_descriptions[k]
        enum = self.parameter_descriptions[k]['enum']
        if enum && !enum.include?(item)
          raise ArgumentError,
            "Parameter '#{k}' has an invalid value: #{item}. " +
            "Must be one of #{enum.inspect}."
        end
        pattern = self.parameter_descriptions[k]['pattern']
        if pattern
          regexp = Regexp.new("^#{pattern}$")
          if item !~ regexp
            raise ArgumentError,
              "Parameter '#{k}' has an invalid value: #{item}. " +
              "Must match: /^#{pattern}$/."
          end
        end
      end
    end
  end
  return nil
end