NAME

Google::Ads::Common::AuthHandlerInterface

DESCRIPTION

Interface to be implemented by concrete authorization handlers. Defines the necessary subroutines to build authorized request against a Google API.

METHODS

initialize

Initializes the handler with a given set of properties. Used to pass parameters such as: client ids, access tokens, etc.

Parameters

  • A required api_client with a reference to the API client object handling the requests against the API.

  • A required properties with a reference to a hash of properties.

prepare_request

Constructs a HTTP::Request valid to send an authorized request to the API. Implementors will attach authorization headers to the request at this phase.

Parameters

  • endpoint: URL to the resource to access.

  • http_headers: a map of HTTP headers to be included in the request.

  • envelope: a string with the payload to be send in the request.

is_auth_enabled

Method called to check if the authorization has already been setup, so the prepare_request method can be called.

Returns

True, if the authorization is in place and the class can prepare requests. False, otherwise.

LICENSE AND COPYRIGHT

Copyright 2012 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.

REPOSITORY INFORMATION

 $Rev: $
 $LastChangedBy: $
 $Id: $