Happyr\GoogleSiteAuthenticatorBundle\Service\ClientProvider

Complexity

Total Complexity

14

Size/Duplication

Total Lines	152
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

0%

Importance

Changes	15
Bugs	2	Features	3

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	getClient()	0	21	2
A	isTokenValid()	0	20	3
A	setAccessToken()	0	14	2
A	getAccessToken()	0	11	2
A	refreshToken()	0	16	3
A	creteCacheKey()	0	4	1

<?php

namespace Happyr\GoogleSiteAuthenticatorBundle\Service;

use Happyr\GoogleSiteAuthenticatorBundle\Model\AccessToken;
use Happyr\GoogleSiteAuthenticatorBundle\Model\TokenConfig;
use Psr\Cache\CacheItemPoolInterface;

/**
 * @author Tobias Nyholm <tobias.nyholm@gmail.com>
 */
class ClientProvider
{
    /**
     * @var \Happyr\GoogleSiteAuthenticatorBundle\Model\TokenConfig config
     */
    private $config;

    /**
     * @var CacheItemPoolInterface storage
     */
    private $pool;

    /**
     * @param TokenConfig            $config
     * @param CacheItemPoolInterface $pool
     */
    public function __construct(TokenConfig $config, CacheItemPoolInterface $pool)
    {
        $this->config = $config;
        $this->pool = $pool;
    }

    /**
     * @param string|null $tokenName
     *
     * @return \Google_Client
     */
    public function getClient($tokenName = null)
    {
        $client = new \Google_Client();

        // Set values from configuration
        $client->setApplicationName($this->config->getApplicationName());
        $client->setClientId($this->config->getClientId($tokenName));
        $client->setClientSecret($this->config->getSecret($tokenName));
        $client->setRedirectUri($this->config->getRedirectUrl($tokenName));
        $client->setScopes($this->config->getScopes($tokenName));

        if (null !== $accessToken = $this->getAccessToken($tokenName)) {
            // set access token to client if we got one
            $client->setAccessToken((string) $accessToken);

            // make sure to refresh the stored access token
            $this->refreshToken($client);
        }

        return $client;
    }

    /**
     * Check if a token is valid.
     * This is an expensive operation that makes multiple API calls.
     *
     * @param string|null $tokenName
     *
     * @return bool
     */
    public function isTokenValid($tokenName = null)
    {
        // We must fetch the client here. A client will automatically refresh the stored access token.
        $client = $this->getClient($tokenName);
        if (null === $accessToken = $client->getAccessToken()) {
            return false;
        }

        // Get the token string from access token
        $token = json_decode($accessToken)->access_token;
        $url = sprintf('https://www.google.com/accounts/AuthSubTokenInfo?bearer_token=%s', $token);
        if (false === @file_get_contents($url)) {
            return false;
        }

        // Retrieve HTTP status code
        list($version, $statusCode, $msg) = explode(' ', $http_response_header[0], 3);

The assignment to $version is unused. Consider omitting it like so list($first,,$third).

The assignment to $msg is unused. Consider omitting it like so list($first,,$third).

        return $statusCode == 200;
    }

    /**
     * Store the access token in the storage.
     *
     * @param string      $accessToken
     * @param string|null $tokenName
     */
    public function setAccessToken($accessToken, $tokenName = null)
    {
        $name = $this->config->getKey($tokenName);

It seems like $tokenName defined by parameter $tokenName on line 96 can also be of type string; however, Happyr\GoogleSiteAuthenticatorBundle\Model\TokenConfig::getKey() does only seem to accept null, maybe add an additional type check?

        $cacheKey = $this->creteCacheKey($name);

        if ($accessToken === null) {
            $this->pool->deleteItem($cacheKey);

            return;
        }

        $item = $this->pool->getItem($cacheKey)->set(new AccessToken($name, $accessToken));
        $this->pool->save($item);
    }

    /**
     * Get access token from storage.
     *
     * @param string|null $tokenName
     *
     * @return AccessToken|null
     */
    protected function getAccessToken($tokenName = null)
    {
        $cacheKey = $this->creteCacheKey($this->config->getKey($tokenName));

It seems like $tokenName defined by parameter $tokenName on line 118 can also be of type string; however, Happyr\GoogleSiteAuthenticatorBundle\Model\TokenConfig::getKey() does only seem to accept null, maybe add an additional type check?

        $item = $this->pool->getItem($cacheKey);

        if (!$item->isHit()) {
            return;
        }

        return $item->get();
    }

    /**
     * If we got a refresh token, use it to retrieve a good access token.
     *
     * @param \Google_Client $client
     */
    private function refreshToken(\Google_Client $client)
    {
        $accessToken = $client->getAccessToken();
        $data = json_decode($accessToken, true);

        try {
            if (isset($data['refresh_token'])) {
                $client->refreshToken($data['refresh_token']);

                return true;
            }
        } catch (\Google_Auth_Exception $e) {

Consider adding a comment why this CATCH block is empty.

        }

        return false;
    }

    /**
     * Create a cache key.
     *
     * @param string $name
     *
     * @return string
     */
    private function creteCacheKey($name)
    {
        return sha1('happyr_google-site-authenticator_'.$name);
    }
}