OAuth1\Flows\AccessTokenFlow

Complexity

Total Complexity

5

Size/Duplication

Total Lines	105
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

100%

Importance

Changes	5
Bugs	1	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	accessTokenUrl()	0	4	1
A	isValidToken()	0	4	1
A	accessTokenHeaders()	0	12	1
	httpClient()	0	1	?
	config()	0	1	?
	signer()	0	1	?
	baseProtocolParameters()	0	1	?
	authorizationHeaders()	0	1	?
A	accessToken()	0	12	2

<?php

namespace OAuth1\Flows;

use InvalidArgumentException;
use OAuth1\Contracts\Tokens\RequestTokenInterface;
use OAuth1\Tokens\AccessToken;

trait AccessTokenFlow
{
    /**
     * Access token url.
     *
     * @return string
     */
    public function accessTokenUrl()
    {
        return $this->config()->accessTokenUrl();
    }

    /**
     * Get access token.
     *
     * @param \OAuth1\Contracts\Tokens\RequestTokenInterface $requestToken
     * @param string                                         $tokenKey
     * @param string                                         $verifier
     *
     * @return \OAuth1\Contracts\Tokens\AccessTokenInterface
     */
    public function accessToken(RequestTokenInterface $requestToken, $tokenKey, $verifier)
    {
        if (!$this->isValidToken($requestToken, $tokenKey)) {
            throw new InvalidArgumentException('The received oauth token does not match.');
        }

        $response = $this->httpClient()->post($this->accessTokenUrl(), [
            'headers' => $this->accessTokenHeaders($requestToken, $verifier),
        ]);

        return AccessToken::fromHttpResponse($response);
    }

    /**
     * Is valid token?
     *
     * @param \OAuth1\Contracts\Token\RequestTokenInterface $requestToken
     * @param string                                        $tokenKey
     *
     * @return bool
     */
    public function isValidToken(RequestTokenInterface $requestToken, $tokenKey)
    {
        return $requestToken->key() === $tokenKey;
    }

    /**
     * Access token header.
     *
     * @param \OAuth1\Contracts\Token\RequestTokenInterface $requestToken
     * @param string                                        $verifier
     *
     * @return array
     */
    public function accessTokenHeaders(RequestTokenInterface $requestToken, $verifier)
    {
        $parameters = $this->baseProtocolParameters();

        $parameters['oauth_token'] = $requestToken->key();
        $parameters['oauth_verifier'] = $verifier;
        $parameters['oauth_signature'] = $this->signer()->setTokenSecret($requestToken->secret())->sign($this->accessTokenUrl(), $parameters);

        return [
            'Authorization' => $this->authorizationHeaders($parameters),
        ];
    }

    /**
     * Get http client instance.
     *
     * @return \OAuth1\Contracts\HttpClientInterface
     */
    abstract public function httpClient();

    /**
     * Get client configuration.
     *
     * @return \OAuth1\Contracts\ConfigInterface
     */
    abstract public function config();

    /**
     * Get signer.
     *
     * @return \OAuth1\Contracts\Signers\SignerInterface
     */
    abstract public function signer();

    /**
     * Get OAuth base protocol parameters.
     *
     * @return array
     */
    abstract public function baseProtocolParameters();

    /**
     * Build authorization headers.
     *
     * @param array $parameters
     *
     * @return string
     */
    abstract public function authorizationHeaders(array $parameters);
}