flipbox\patron\hubspot\connections\AccessTokenAuthorizationTrait

Complexity

Total Complexity

12

Size/Duplication

Total Lines	148
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	11

Test Coverage

Coverage

0%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	prepareAuthorizationRequest()	0	10	2
A	addAuthorizationHeader()	0	7	1
A	handleAuthorizationResponse()	0	16	2
A	responseIsExpiredToken()	0	12	2
A	refreshAndRetry()	0	18	1
A	saveRefreshToken()	0	8	1
A	hasSessionExpired()	0	15	3

<?php

/**
 * @copyright  Copyright (c) Flipbox Digital Limited
 * @license    https://github.com/flipboxfactory/patron-hubspot/blob/master/LICENSE
 * @link       https://github.com/flipboxfactory/patron-hubspot/
 */

namespace flipbox\patron\hubspot\connections;

use craft\helpers\ArrayHelper;
use craft\helpers\StringHelper;
use flipbox\patron\records\Token;
use Flipbox\Skeleton\Helpers\JsonHelper;
use League\OAuth2\Client\Token\AccessTokenInterface;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;

/**
 * @author Flipbox Factory <hello@flipboxfactory.com>
 * @since 1.0.0
 */
trait AccessTokenAuthorizationTrait
{
    use AccessTokenTrait;

    /**
     * @param RequestInterface $request
     * @return RequestInterface
     * @throws \yii\base\InvalidConfigException
     */
    public function prepareAuthorizationRequest(
        RequestInterface $request
    ): RequestInterface {

        foreach ($this->getProvider()->getHeaders() as $key => $value) {
            $request = $request->withAddedHeader($key, $value);
        }

        return $this->addAuthorizationHeader($request);
    }

    /**
     * @param RequestInterface $request
     * @return RequestInterface
     * @throws \yii\base\InvalidConfigException
     */
    protected function addAuthorizationHeader(RequestInterface $request): RequestInterface
    {
        return $request->withHeader(
            'Authorization',
            'Bearer ' . (string)$this->getAccessToken()
        );
    }

    /**
     * @param ResponseInterface $response
     * @param RequestInterface $request
     * @param callable $runner
     * @return ResponseInterface
     * @throws \League\OAuth2\Client\Provider\Exception\IdentityProviderException
     * @throws \flipbox\craft\ember\exceptions\RecordNotFoundException
     * @throws \yii\base\InvalidConfigException
     */
    public function handleAuthorizationResponse(
        ResponseInterface $response,
        RequestInterface $request,
        callable $runner
    ): ResponseInterface {

        if ($this->responseIsExpiredToken($response)) {
            $response = $this->refreshAndRetry(
                $request,
                $response,
                $runner
            );
        }

        return $response;
    }

    /**
     * @param ResponseInterface $response
     * @return bool
     */
    protected function responseIsExpiredToken(ResponseInterface $response): bool
    {
        if ($response->getStatusCode() !== 401) {
            return false;
        }

        $data = JsonHelper::decodeIfJson(
            $response->getBody()->getContents()
        );

        return $this->hasSessionExpired($data);
    }

    /**
     * @param RequestInterface $request
     * @param ResponseInterface $response
     * @param callable|null $next
     * @return mixed
     * @throws \League\OAuth2\Client\Provider\Exception\IdentityProviderException
     * @throws \flipbox\craft\ember\exceptions\RecordNotFoundException
     * @throws \yii\base\InvalidConfigException
     */
    protected function refreshAndRetry(RequestInterface $request, ResponseInterface $response, callable $next = null)
    {
        $refreshToken = $this->getProvider()->getAccessToken('refresh_token', [
            'refresh_token' => $this->getAccessToken()->getRefreshToken()
        ]);

        $this->saveRefreshToken(
            $this->getAccessToken(),
            $refreshToken
        );

        $this->setAccessToken($refreshToken);

        return $next(
            $this->addAuthorizationHeader($request),
            $response
        );
    }

    /**
     * @param AccessTokenInterface $accessToken
     * @param AccessTokenInterface $refreshToken
     * @return bool
     * @throws \flipbox\craft\ember\exceptions\RecordNotFoundException
     */
    protected function saveRefreshToken(AccessTokenInterface $accessToken, AccessTokenInterface $refreshToken): bool
    {
        $record = Token::getOne([
            'accessToken' => $accessToken->getToken()
        ]);
        $record->accessToken = $refreshToken->getToken();
        return $record->save();
    }

    /**
     * @param array $error
     *
     * This is an example of the error
     * [
     * 'status' => 'error',
     * 'message' => 'This oauth-token (TOKEN_STRING) is expired! expiresAt: 1530045454360, now: 1530114086081',
     * 'correlationId' => '1a45b07b-e8ba-41d5-8a85-508f1fdd3246',
     * 'requestId' => '302880bcbf2c8727850c536b70254015'
     * ]
     *
     * @return bool
     */
    private function hasSessionExpired(array $error): bool
    {
        $message = $error['message'] ?? '';
        // Look for these parts in the message
        $messageParts = [
            'This oauth-token',
            'is expired'
        ];
        if (ArrayHelper::getValue($error, 'status') === 'error' &&
            StringHelper::containsAll($message, $messageParts)
        ) {
            return true;
        }
        return false;
    }
}