Module discovery

Retrieves the discovery_doc from cache or the internet.

Args:
  url: string, the URL of the discovery document.
  http: httplib2.Http, An instance of httplib2.Http or something that acts
    like it through which HTTP requests will be made.
  cache_discovery: Boolean, whether or not to cache the discovery doc.
  cache: googleapiclient.discovery_cache.base.Cache, an optional cache
    object for the discovery documents.

Returns:
  A unicode string representation of the discovery document.

Convert value to a string based on JSON Schema type.

See http://tools.ietf.org/html/draft-zyp-json-schema-03 for more details on
JSON Schema.

Args:
  value: any, the value to convert
  schema_type: string, the type that value should be interpreted as

Returns:
  A string representation of 'value' based on the schema_type.

Convert a string media size, such as 10GB or 3TB into an integer.

Args:
  maxSize: string, size as a string, such as 2MB or 7GB.

Returns:
  The size as an integer value.

Creates an absolute media path URL.

Constructed using the API root URI and service path from the discovery
document and the relative path for the API method.

Args:
  root_desc: Dictionary; the entire original deserialized discovery document.
  path_url: String; the relative URL for the API method. Relative to the API
      root, which is specified in the discovery document.

Returns:
  String; the absolute URI for media upload for the API method.

Updates parameters of an API method with values specific to this library.

Specifically, adds whatever global parameters are specified by the API to the
parameters for the individual method. Also adds parameters which don't
appear in the discovery document, but are available to all discovery based
APIs (these are listed in STACK_QUERY_PARAMETERS).

SIDE EFFECTS: This updates the parameters dictionary object in the method
description.

Args:
  method_desc: Dictionary with metadata describing an API method. Value comes
      from the dictionary of methods stored in the 'methods' key in the
      deserialized discovery document.
  root_desc: Dictionary; the entire original deserialized discovery document.
  http_method: String; the HTTP method used to call the API method described
      in method_desc.

Returns:
  The updated Dictionary stored in the 'parameters' key of the method
      description dictionary.

Adds 'media_body' and 'media_mime_type' parameters if supported by method.

SIDE EFFECTS: If the method supports media upload and has a required body,
sets body to be optional (required=False) instead. Also, if there is a
'mediaUpload' in the method description, adds 'media_upload' key to
parameters.

Args:
  method_desc: Dictionary with metadata describing an API method. Value comes
      from the dictionary of methods stored in the 'methods' key in the
      deserialized discovery document.
  root_desc: Dictionary; the entire original deserialized discovery document.
  path_url: String; the relative URL for the API method. Relative to the API
      root, which is specified in the discovery document.
  parameters: A dictionary describing method parameters for method described
      in method_desc.

Returns:
  Triple (accept, max_size, media_path_url) where:
    - accept is a list of strings representing what content types are
      accepted for media upload. Defaults to empty list if not in the
      discovery document.
    - max_size is a long representing the max size in bytes allowed for a
      media upload. Defaults to 0L if not in the discovery document.
    - media_path_url is a String; the absolute URI for media upload for the
      API method. Constructed using the API root URI and service path from
      the discovery document and the relative path for the API method. If
      media upload is not supported, this is None.

Updates a method description in a discovery document.

SIDE EFFECTS: Changes the parameters dictionary in the method description with
extra parameters which are used locally.

Args:
  method_desc: Dictionary with metadata describing an API method. Value comes
      from the dictionary of methods stored in the 'methods' key in the
      deserialized discovery document.
  root_desc: Dictionary; the entire original deserialized discovery document.

Returns:
  Tuple (path_url, http_method, method_id, accept, max_size, media_path_url)
  where:
    - path_url is a String; the relative URL for the API method. Relative to
      the API root, which is specified in the discovery document.
    - http_method is a String; the HTTP method used to call the API method
      described in the method description.
    - method_id is a String; the name of the RPC method associated with the
      API method, and is in the method description in the 'id' key.
    - accept is a list of strings representing what content types are
      accepted for media upload. Defaults to empty list if not in the
      discovery document.
    - max_size is a long representing the max size in bytes allowed for a
      media upload. Defaults to 0L if not in the discovery document.
    - media_path_url is a String; the absolute URI for media upload for the
      API method. Constructed using the API root URI and service path from
      the discovery document and the relative path for the API method. If
      media upload is not supported, this is None.

Creates a method for attaching to a Resource.

Args:
  methodName: string, name of the method to use.
  methodDesc: object, fragment of deserialized discovery document that
    describes the method.
  rootDesc: object, the entire deserialized discovery document.
  schema: object, mapping of schema names to schema descriptions.

Creates any _next methods for attaching to a Resource.

The _next methods allow for easy iteration through list() responses.

Args:
  methodName: string, name of the method to use.
  pageTokenName: string, name of request page token field.
  nextPageTokenName: string, name of response page token field.
  isPageTokenParameter: Boolean, True if request page token is a query
      parameter, False if request page token is a field of the request body.

Search field names for one like a page token.

Args:
  fields: container of string, names of fields.

Returns:
  First name that is either 'pageToken' or 'nextPageToken' if one exists,
  otherwise None.

Get properties of a field in a method description.

Args:
  methodDesc: object, fragment of deserialized discovery document that
    describes the method.
  schema: object, mapping of schema names to schema descriptions.
  name: string, name of top-level field in method description.

Returns:
  Object representing fragment of deserialized discovery document
  corresponding to 'properties' field of object corresponding to named field
  in method description, if it exists, otherwise empty dict.

DISCOVERY_URI

Value:

'https://www.googleapis.com/discovery/v1/apis/' '{api}/{apiVersion}/re st'

V1_DISCOVERY_URI

Value:

'https://www.googleapis.com/discovery/v1/apis/' '{api}/{apiVersion}/re st'

V2_DISCOVERY_URI

Value:

'https://{api}.googleapis.com/$discovery/rest?' 'version={apiVersion}'

BODY_PARAMETER_DEFAULT_VALUE

Value:

{'description': 'The request body.', 'type': 'object', 'required': Tru e,}

MEDIA_BODY_PARAMETER_DEFAULT_VALUE

Value:

{'description':('The filename of the media request body, or an instanc e ' 'of a MediaUpload object.'), 'type': 'string', 'required': False,}

MEDIA_MIME_TYPE_PARAMETER_DEFAULT_VALUE

Value:

{'description':('The MIME type of the media request body, or an instan ce ' 'of a MediaUpload object.'), 'type': 'string', 'required': False, }

STACK_QUERY_PARAMETERS

Value:

frozenset(['trace', 'pp', 'userip', 'strict'])

STACK_QUERY_PARAMETER_DEFAULT_VALUE

Value:

{'type': 'string', 'location': 'query'}