ClientProvider::getClient() - Code Metrics - Happyr/GoogleSiteAuthenticatorBundle - Measure and Improve Code Quality continuously with Scrutinizer

ClientProvider::getClient() A
last analyzed 2020-11-11 11:04 UTC

↳ Parent: ClientProvider

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

Metric	Value
dl	0
loc	21
ccs	0
cts	14
cp	0
rs	9.584
c	0
b	0
f	0
cc	2
nc	2
nop	1
crap	6

<?php

namespace Happyr\GoogleSiteAuthenticatorBundle\Service;

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

/**
 * @author Tobias Nyholm <[email protected]>
 */
class ClientProvider
{
    /**
     * @var TokenConfig config
     */
    private $config;

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

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

    public function getClient(string $tokenName = null): \Google_Client
    {
        $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.
     */
    public function isTokenValid(string $tokenName = null): bool
    {
        // 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.googleapis.com/oauth2/v1/tokeninfo?access_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);
<?php

function returnThreeValues() {
    return array('a', 'b', 'c');
}

list($a, $b, $c) = returnThreeValues();

print $a . " - " . $c;

        return 200 === (int) $statusCode;
    }

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

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

            return;
        }

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

    /**
     * Get access token from storage.
     */
    protected function getAccessToken(string $tokenName = null): ?AccessToken
    {
        $cacheKey = $this->creteCacheKey($this->config->getKey($tokenName));
        $item = $this->pool->getItem($cacheKey);

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

        return $item->get();
    }

    /**
     * If we got a refresh token, use it to retrieve a good access token.
     */
    private function refreshToken(\Google_Client $client): bool
    {
        $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) {

        }

        return false;
    }

    private function creteCacheKey(string $name): string
    {
        return \sha1('happyr_google-site-authenticator_'.$name);
    }
}


1			<?php
2
3			namespace Happyr\GoogleSiteAuthenticatorBundle\Service;
4
5			use Happyr\GoogleSiteAuthenticatorBundle\Model\AccessToken;
6			use Happyr\GoogleSiteAuthenticatorBundle\Model\TokenConfig;
7			use Psr\Cache\CacheItemPoolInterface;
8
9			/**
10			* @author Tobias Nyholm <[email protected]>
11			*/
12			class ClientProvider
13			{
14			/**
15			* @var TokenConfig config
16			*/
17			private $config;
18
19			/**
20			* @var CacheItemPoolInterface storage
21			*/
22			private $pool;
23
24			public function __construct(TokenConfig $config, CacheItemPoolInterface $pool)
25			{
26			$this->config = $config;
27			$this->pool = $pool;
28			}
29
30			public function getClient(string $tokenName = null): \Google_Client
31			{
32			$client = new \Google_Client();
33
34			// Set values from configuration
35			$client->setApplicationName($this->config->getApplicationName());
36			$client->setClientId($this->config->getClientId($tokenName));
37			$client->setClientSecret($this->config->getSecret($tokenName));
38			$client->setRedirectUri($this->config->getRedirectUrl($tokenName));
39			$client->setScopes($this->config->getScopes($tokenName));
40
41			if (null !== $accessToken = $this->getAccessToken($tokenName)) {
42			// set access token to client if we got one
43			$client->setAccessToken((string) $accessToken);
44
45			// make sure to refresh the stored access token
46			$this->refreshToken($client);
47			}
48
49			return $client;
50			}
51
52			/**
53			* Check if a token is valid.
54			* This is an expensive operation that makes multiple API calls.
55			*/
56			public function isTokenValid(string $tokenName = null): bool
57			{
58			// We must fetch the client here. A client will automatically refresh the stored access token.
59			$client = $this->getClient($tokenName);
60			if (null === $accessToken = $client->getAccessToken()) {
61			return false;
62			}
63
64			// Get the token string from access token
65			$token = \json_decode($accessToken)->access_token;
66			$url = \sprintf('https://www.googleapis.com/oauth2/v1/tokeninfo?access_token=%s', $token);
67			if (false === @\file_get_contents($url)) {
68			return false;
69			}
70
71			// Retrieve HTTP status code
72			list($version, $statusCode, $msg) = \explode(' ', $http_response_header[0], 3);
			0 ignored issues – show Unused Code introduced 2016-08-01 14:24 UTC by Report Bug Copy Issue Report The assignment to `$version` is unused. Consider omitting it like so `list($first,,$third)`. This checks looks for assignemnts to variables using the `list(...)` function, where not all assigned variables are subsequently used. Consider the following code example. <?php function returnThreeValues() { return array('a', 'b', 'c'); } list($a, $b, $c) = returnThreeValues(); print $a . " - " . $c; Only the variables `$a` and `$c` are used. There was no need to assign `$b`. Instead, the list call could have been. list($a,, $c) = returnThreeValues(); Loading history... Unused Code introduced 2016-08-01 14:24 UTC by Report Bug Copy Issue Report The assignment to `$msg` is unused. Consider omitting it like so `list($first,,$third)`. This checks looks for assignemnts to variables using the `list(...)` function, where not all assigned variables are subsequently used. Consider the following code example. <?php function returnThreeValues() { return array('a', 'b', 'c'); } list($a, $b, $c) = returnThreeValues(); print $a . " - " . $c; Only the variables `$a` and `$c` are used. There was no need to assign `$b`. Instead, the list call could have been. list($a,, $c) = returnThreeValues(); Loading history...
73
74			return 200 === (int) $statusCode;
75			}
76
77			/**
78			* Store the access token in the storage.
79			*/
80			public function setAccessToken(?string $accessToken, string $tokenName = null)
81			{
82			$name = $this->config->getKey($tokenName);
83			$cacheKey = $this->creteCacheKey($name);
84
85			if (null === $accessToken) {
86			$this->pool->deleteItem($cacheKey);
87
88			return;
89			}
90
91			$item = $this->pool->getItem($cacheKey)->set(new AccessToken($name, $accessToken));
92			$this->pool->save($item);
93			}
94
95			/**
96			* Get access token from storage.
97			*/
98			protected function getAccessToken(string $tokenName = null): ?AccessToken
99			{
100			$cacheKey = $this->creteCacheKey($this->config->getKey($tokenName));
101			$item = $this->pool->getItem($cacheKey);
102
103			if (!$item->isHit()) {
104			return null;
105			}
106
107			return $item->get();
108			}
109
110			/**
111			* If we got a refresh token, use it to retrieve a good access token.
112			*/
113			private function refreshToken(\Google_Client $client): bool
114			{
115			$accessToken = $client->getAccessToken();
116			$data = \json_decode($accessToken, true);
117
118			try {
119			if (isset($data['refresh_token'])) {
120			$client->refreshToken($data['refresh_token']);
121
122			return true;
123			}
124			} catch (\Google_Auth_Exception $e) {
			0 ignored issues – show Coding Style Comprehensibility introduced 2016-08-01 14:24 UTC by Report Bug Copy Issue Report Consider adding a comment why this CATCH block is empty. Loading history...
125			}
126
127			return false;
128			}
129
130			private function creteCacheKey(string $name): string
131			{
132			return \sha1('happyr_google-site-authenticator_'.$name);
133			}
134			}
135

Happyr / GoogleSiteAuthenticatorBundle

ClientProvider::getClient() A last analyzed 2020-11-11 11:04 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

ClientProvider::getClient() A
last analyzed 2020-11-11 11:04 UTC