class AcquiaDAM_Client in Media: Acquia DAM 7

Client for making API requests.

@package AcquiaDAM

Hierarchy

• class \AcquiaDAM_Client

File

src/AcquiaDAM/AcquiaDAM_Client.inc, line 10

class AcquiaDAM_Client {

  /**
   * The base API URL.
   *
   * @var string
   */
  protected $apiBaseURL = 'https://apiv2.webdamdb.com';

  /**
   * The OAuth2 Client.
   *
   * @var \OAuth2\Client
   */
  protected $oauth2Client = NULL;

  /**
   * Construct an AcquiaDAM_Client object.
   *
   * @param \OAuth2\Client $oauth2Client
   *   A pre-configured OAuth2 Client object.
   */
  public function __construct(OAuth2Client $oauth2Client) {
    $this->oauth2Client = $oauth2Client;
    $this
      ->getToken();
  }

  /**
   * Convert a URl and data into a normal URL.
   *
   * @param string $url
   *   The API URL.
   * @param array $data
   *   An array of data.
   *
   * @return string
   *   The API URL with query string parameters added.
   */
  protected function buildGetRequest($url, array $data) {
    if (!empty($data) && is_array($data)) {
      $data = drupal_http_build_query($data);
      $url .= '?' . $data;
    }
    return $url;
  }

  /**
   * Get the authroization token information.
   *
   * @return array
   *   An array of token information as returned by the OAuth2 client.
   */
  protected function getToken() {

    // Ensure we are authenticated.
    $this
      ->authenticate(FALSE);
    return $this->oauth2Client
      ->token();
  }

  /**
   * Returns the OAuth2 Client that is being wrapped.
   *
   * @return OAuth2\Client
   *   The OAuth2 Client being used.
   */
  public function &getOAuth2Client() {
    return $this->oauth2Client;
  }

  /**
   * Authenticate the client.
   *
   * @param bool $allowRedirect
   *   TRUE to allow redirection. Used for server side authentication.
   *
   * @return string|null
   *   The authentication token or NULL.
   *
   * @see \OAuth2\Client::getAccessToken
   */
  public function authenticate($allowRedirect = TRUE) {
    return $this->oauth2Client
      ->getAccessToken($allowRedirect);
  }

  /**
   * Check if the client is authenticated.
   *
   * @return bool
   *   TRUE if authenticated, FALSE otherwise.
   */
  public function isAuthenticated() {
    $token = $this->oauth2Client
      ->token();
    return !empty($token['access_token']);
  }

  /**
   * Check if there was an authentication error.
   *
   * @return bool|string
   *   The authentication error key or FALSE if there is no error.
   */
  public function hasAuthenticationError() {
    $qp = drupal_get_query_parameters(NULL, [
      'q',
      'page',
    ]);
    return empty($qp['error']) ? FALSE : $qp['error'];
  }

  /**
   * Get the user the client is authenticated as.
   *
   * @return array|false
   *   The user information or FALSE on no user.
   */
  public function getUser() {
    $user = $this
      ->request('users/me');
    return empty($user['username']) ? FALSE : $user;
  }

  /**
   * Get the subscription information.
   *
   * @return array
   *   An array of available sub information.
   */
  public function getSubscription() {

    // Possible for this method to be called a lot in a single request, so we
    // only want to fetch the info once for performance reasons.
    static $sub_info = NULL;
    if (empty($sub_info)) {
      $sub_info = $this
        ->request('subscription');
    }
    return $sub_info;
  }

  /**
   * Make a request to the Acquia DAM API.
   *
   * @param string $endpoint
   *   The API endpoint to request.
   * @param string|array $data
   *   The data to send with the request.
   * @param array $headers
   *   Any additional headers to include.
   * @param string $method
   *   The request type.
   *
   * @return array
   *   The result of the API request.
   */
  public function request($endpoint, $data = NULL, array $headers = [], $method = 'GET') {
    $url = sprintf('%s/%s', $this->apiBaseURL, $endpoint);

    // Convert our data into a GET request.
    if ('GET' == drupal_strtoupper($method) && is_array($data)) {
      $url = $this
        ->buildGetRequest($url, $data);
      $data = NULL;
    }
    $options = [
      'headers' => $headers,
      'method' => $method,
      'data' => $data,
    ];
    $auth_token = $this
      ->getToken();
    if (empty($auth_token['access_token'])) {
      return FALSE;
    }
    $options['headers']['Authorization'] = sprintf('%s %s', ucfirst($auth_token['token_type']), $auth_token['access_token']);
    $resp = drupal_http_request($url, $options);
    if (!empty($resp->data)) {
      $resp->data = drupal_json_decode($resp->data);
    }

    // Acquia DAM does not return proper error codes for different conditions, so
    // we can't do much beyond checking for "not a success".
    if (200 != $resp->code) {
      $msg = empty($resp->data['message']) ? $resp->error : $resp->data['message'];
      throw new UnexpectedValueException(sprintf('(%d) %s response when accessing %s', $resp->code, $msg, $url));
    }
    return $resp->data;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AcquiaDAM_Client::$apiBaseURL	protected	property	The base API URL.
AcquiaDAM_Client::$oauth2Client	protected	property	The OAuth2 Client.
AcquiaDAM_Client::authenticate	public	function	Authenticate the client.
AcquiaDAM_Client::buildGetRequest	protected	function	Convert a URl and data into a normal URL.
AcquiaDAM_Client::getOAuth2Client	public	function	Returns the OAuth2 Client that is being wrapped.
AcquiaDAM_Client::getSubscription	public	function	Get the subscription information.
AcquiaDAM_Client::getToken	protected	function	Get the authroization token information.
AcquiaDAM_Client::getUser	public	function	Get the user the client is authenticated as.
AcquiaDAM_Client::hasAuthenticationError	public	function	Check if there was an authentication error.
AcquiaDAM_Client::isAuthenticated	public	function	Check if the client is authenticated.
AcquiaDAM_Client::request	public	function	Make a request to the Acquia DAM API.
AcquiaDAM_Client::__construct	public	function	Construct an AcquiaDAM_Client object.