Authentication::__construct() - Code Metrics - endeveit/open-stack-storage - Measure and Improve Code Quality continuously with Scrutinizer

Authentication::__construct() A
last analyzed 2015-12-29 04:10 UTC

↳ Parent: Authentication

Complexity

Conditions	1
Paths	1

Size

Total Lines	10
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes	4
Bugs	0	Features	0

Metric	Value
c	4
b	0
f	0
dl	0
loc	10
rs	9.4286
cc	1
eloc	7
nc	1
nop	5

<?php
/**
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @author Nikita Vershinin <[email protected]>
 * @license MIT
 */
namespace OpenStackStorage;

/**
 * Authentication instances are used to interact with the remote authentication
 * service, retrieving storage system routing information and session tokens.
 */
class Authentication
{

    /**
     * The information about the authentication URL.
     *
     * @var array
     */
    protected $urlInfo = array();

    /**
     * Request headers with username, API key and User-Agent.
     *
     * @var array
     */
    protected $headers = array();

    /**
     * User-Agent for request.
     *
     * @var string
     */
    protected $userAgent = null;

    /**
     * Request timeout.
     *
     * @var integer
     */
    protected $timeout = 5;

    /**
     * The class constructor.
     *
     * @param string  $username
     * @param string  $apiKey
     * @param string  $url
     * @param string  $userAgent
     * @param integer $timeout
     */
    public function __construct($username, $apiKey, $url, $userAgent, $timeout = 5)
    {
        $this->urlInfo   = Utils::parseUrl($url);
        $this->userAgent = $userAgent;
        $this->timeout   = intval($timeout);
        $this->headers   = array(
            'x-auth-user' => $username,
            'x-auth-key'  => $apiKey,
        );
    }

    /**
     * Initiates authentication with the remote service and returns a
     * array containing the storage system URL, CDN URL (can be empty)
     * and session token.
     *
     * @return array
     * @throws \Exception|\OpenStackStorage\Exceptions\ResponseError
     * @throws \OpenStackStorage\Exceptions\AuthenticationError
     * @throws \OpenStackStorage\Exceptions\AuthenticationFailed
     * @throws \Exception
     */
    public function authenticate()
    {
        $client = new Client(array('timeout' => $this->timeout));
        $client->setBaseURL(sprintf(
            '%s://%s:%d/',
            $this->urlInfo['scheme'],
            $this->urlInfo['host'],
            $this->urlInfo['port']
        ));
        $client->setUserAgent($this->userAgent);

        try {
            $response = $client->get($this->urlInfo['path'], null, $this->headers);
        } catch (Exceptions\ResponseError $e) {
            if (401 == $e->getCode()) {
                // A status code of 401 indicates that the supplied credentials
                // were not accepted by the authentication service.
                throw new Exceptions\AuthenticationFailed();
            }

            throw $e;
        }

        if (isset($response['headers']['x-auth-token'])) {
            $authToken = $response['headers']['x-auth-token'];
        } elseif (isset($response['headers']['x-storage-token'])) {
            $authToken = $response['headers']['x-storage-token'];
        } else {
            $authToken = null;
        }

        if (isset($response['headers']['x-storage-url'])) {
            $storageUrl = $response['headers']['x-storage-url'];
        } else {
            $storageUrl = null;
        }

        if (!($authToken && $storageUrl)) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            throw new Exceptions\AuthenticationError(
                'Invalid response from the authentication service.'
            );
        }

        if (isset($response['headers']['x-cdn-management-url'])) {
            $cdnUrl = $response['headers']['x-cdn-management-url'];
        } else {
            $cdnUrl = null;
        }

        return array(
            $storageUrl,
            $cdnUrl,
            $authToken
        );
    }
}


1			<?php
2			/**
3			* For the full copyright and license information, please view the LICENSE
4			* file that was distributed with this source code.
5			*
6			* @author Nikita Vershinin <[email protected]>
7			* @license MIT
8			*/
9			namespace OpenStackStorage;
10
11			/**
12			* Authentication instances are used to interact with the remote authentication
13			* service, retrieving storage system routing information and session tokens.
14			*/
15			class Authentication
16			{
17
18			/**
19			* The information about the authentication URL.
20			*
21			* @var array
22			*/
23			protected $urlInfo = array();
24
25			/**
26			* Request headers with username, API key and User-Agent.
27			*
28			* @var array
29			*/
30			protected $headers = array();
31
32			/**
33			* User-Agent for request.
34			*
35			* @var string
36			*/
37			protected $userAgent = null;
38
39			/**
40			* Request timeout.
41			*
42			* @var integer
43			*/
44			protected $timeout = 5;
45
46			/**
47			* The class constructor.
48			*
49			* @param string $username
50			* @param string $apiKey
51			* @param string $url
52			* @param string $userAgent
53			* @param integer $timeout
54			*/
55			public function __construct($username, $apiKey, $url, $userAgent, $timeout = 5)
56			{
57			$this->urlInfo = Utils::parseUrl($url);
58			$this->userAgent = $userAgent;
59			$this->timeout = intval($timeout);
60			$this->headers = array(
61			'x-auth-user' => $username,
62			'x-auth-key' => $apiKey,
63			);
64			}
65
66			/**
67			* Initiates authentication with the remote service and returns a
68			* array containing the storage system URL, CDN URL (can be empty)
69			* and session token.
70			*
71			* @return array
72			* @throws \Exception\|\OpenStackStorage\Exceptions\ResponseError
73			* @throws \OpenStackStorage\Exceptions\AuthenticationError
74			* @throws \OpenStackStorage\Exceptions\AuthenticationFailed
75			* @throws \Exception
76			*/
77			public function authenticate()
78			{
79			$client = new Client(array('timeout' => $this->timeout));
80			$client->setBaseURL(sprintf(
81			'%s://%s:%d/',
82			$this->urlInfo['scheme'],
83			$this->urlInfo['host'],
84			$this->urlInfo['port']
85			));
86			$client->setUserAgent($this->userAgent);
87
88			try {
89			$response = $client->get($this->urlInfo['path'], null, $this->headers);
90			} catch (Exceptions\ResponseError $e) {
91			if (401 == $e->getCode()) {
92			// A status code of 401 indicates that the supplied credentials
93			// were not accepted by the authentication service.
94			throw new Exceptions\AuthenticationFailed();
95			}
96
97			throw $e;
98			}
99
100			if (isset($response['headers']['x-auth-token'])) {
101			$authToken = $response['headers']['x-auth-token'];
102			} elseif (isset($response['headers']['x-storage-token'])) {
103			$authToken = $response['headers']['x-storage-token'];
104			} else {
105			$authToken = null;
106			}
107
108			if (isset($response['headers']['x-storage-url'])) {
109			$storageUrl = $response['headers']['x-storage-url'];
110			} else {
111			$storageUrl = null;
112			}
113
114			if (!($authToken && $storageUrl)) {
			0 ignored issues – show Bug Best Practice introduced 2015-12-29 04:10 UTC by Report Bug Copy Issue Report The expression `$authToken` of type `string\|null` is loosely compared to `false`; this is ambiguous if the string can be empty. You might want to explicitly use `=== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history... Bug Best Practice introduced 2015-12-29 04:10 UTC by Report Bug Copy Issue Report The expression `$storageUrl` of type `string\|null` is loosely compared to `false`; this is ambiguous if the string can be empty. You might want to explicitly use `=== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
115			throw new Exceptions\AuthenticationError(
116			'Invalid response from the authentication service.'
117			);
118			}
119
120			if (isset($response['headers']['x-cdn-management-url'])) {
121			$cdnUrl = $response['headers']['x-cdn-management-url'];
122			} else {
123			$cdnUrl = null;
124			}
125
126			return array(
127			$storageUrl,
128			$cdnUrl,
129			$authToken
130			);
131			}
132			}
133

endeveit / open-stack-storage

Authentication::__construct() A last analyzed 2015-12-29 04:10 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Authentication::__construct() A
last analyzed 2015-12-29 04:10 UTC