Superdesk\ContentApiSdk\API\Authentication\OAuthPasswordAuthentication

Complexity

Total Complexity

12

Size/Duplication

Total Lines	136
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes	9
Bugs	3	Features	3

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getUsername()	0	4	1
A	getPassword()	0	4	1
A	setUsername()	0	6	1
A	setPassword()	0	6	1
A	refreshAccessToken()	0	9	1
A	getAuthenticationTokens()	0	9	1
B	makeTokenCall()	0	33	6

<?php

/**
 * This file is part of the PHP SDK library for the Superdesk Content API.
 *
 * Copyright 2015 Sourcefabric z.u. and contributors.
 *
 * For the full copyright and license information, please see the
 * AUTHORS and LICENSE files distributed with this source code.
 *
 * @copyright 2015 Sourcefabric z.ú.
 * @license http://www.superdesk.org/license
 */

namespace Superdesk\ContentApiSdk\API\Authentication;

use Superdesk\ContentApiSdk\API\Request\RequestInterface;
use Superdesk\ContentApiSdk\ContentApiSdk;
use Superdesk\ContentApiSdk\Exception\AuthenticationException;
use Superdesk\ContentApiSdk\Exception\ClientException;
use Superdesk\ContentApiSdk\Exception\InvalidDataException;

/**
 * OAuth password authentication class.
 */
class OAuthPasswordAuthentication extends AbstractAuthentication
{
    const AUTHENTICATION_GRANT_TYPE = 'password';

    /**
     * Username for OAuth password authentication.
     *
     * @var string
     */
    protected $username;

    /**
     * Password for OAuth password authentication.
     *
     * @var string
     */
    protected $password;

    /**
     * Gets the value of username.
     *
     * @return string
     */
    public function getUsername()
    {
        return $this->username;
    }

    /**
     * Sets the value of username.
     *
     * @param string $username Value to set
     *
     * @return self
     */
    public function setUsername($username)
    {
        $this->username = $username;

        return $this;
    }

    /**
     * Gets the value of password.
     *
     * @return string
     */
    public function getPassword()
    {
        return $this->password;
    }

    /**
     * Sets the value of password.
     *
     * @param string $password Value to set
     *
     * @return self
     */
    public function setPassword($password)
    {
        $this->password = $password;

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function refreshAccessToken()
    {
        return $this->makeTokenCall(array(
            'client_id' => $this->getClientId(),
            'grant_type' => self::REFRESH_GRANT_TYPE,
            'username' => $this->getUsername(),
            'refresh_token' => $this->refreshToken
        ));
   }

    /**
     * {@inheritdoc}
     */
    public function getAuthenticationTokens()
    {
        return $this->makeTokenCall(array(
            'client_id' => $this->getClientId(),
            'grant_type' => self::AUTHENTICATION_GRANT_TYPE,
            'username' => $this->getUsername(),
            'password' => $this->getPassword()
        ));
    }

    /**
     * Makes an authentication call to the server.
     *
     * @param  array $parameters Array with parameters for the request
     *
     * @return boolean
     *
     * @throws AuthenticationException Thrown on failures during request and
     *                                 invalid responses.
     */
    private function makeTokenCall(array $parameters)
    {
        try {
            $response = $this->client->makeCall(
                $this->getAuthenticationUrl(),
                array(),
                array(),
                'POST',
                $parameters
            );
        } catch (ClientException $e) {
            throw new AuthenticationException('Could not request access token.', $e->getCode(), $e);
        }

        if ($response['status'] === 200) {
            try {
                $responseObj = ContentApiSdk::getValidJsonObj($response['body']);
            } catch (InvalidDataException $e) {
                throw new AuthenticationException('Authentication response body is not (valid) json.', $e->getCode(), $e);
            }

            if (property_exists($responseObj, 'access_token') && property_exists($responseObj, 'refresh_token')) {
                $this->accessToken = $responseObj->access_token;
                $this->refreshToken = $responseObj->refresh_token;

                return true;
            }

            throw new AuthenticationException('The server returned an unexpected response body.');
        }

        throw new AuthenticationException(sprintf('The server returned an error with status %s.', $response['status']), $response['status']);
    }
}