BaseClientRemote::buildPath() - Code Metrics - Inspection of "add hard delete option" - directus/directus-sdk-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 6ea6e9...f8768f )

by Welling

created 2016-12-27 22:32 UTC

BaseClientRemote::buildPath() A

↳ Parent: BaseClientRemote

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	2
dl	0
loc	4
ccs	2
cts	2
cp	1
crap	1
rs	10
c	0
b	0
f	0

<?php

/**
 * Directus – <http://getdirectus.com>
 *
 * @link      The canonical repository – <https://github.com/directus/directus>
 * @copyright Copyright 2006-2016 RANGER Studio, LLC – <http://rangerstudio.com>
 * @license   GNU General Public License (v3) – <http://www.gnu.org/copyleft/gpl.html>
 */

namespace Directus\SDK;

use Directus\SDK\Exception\UnauthorizedRequestException;
use Directus\SDK\Response\Entry;
use Directus\SDK\Response\EntryCollection;
use Directus\Util\ArrayUtils;
use GuzzleHttp\Client as HTTPClient;
use GuzzleHttp\Exception\ClientException;

/**
 * Abstract Base Client Remote
 *
 * @author Welling Guzmán <[email protected]>
 */
abstract class BaseClientRemote extends AbstractClient

{
    /**
     * Directus base url
     *
     * @var string
     */
    protected $baseUrl = 'http://localhost';

    /**
     * Directus hosted base url format
     *
     * @var string
     */
    protected $hostedBaseUrlFormat = 'https://%s.directus.io';

    /**
     * Directus Server base endpoint
     *
     * @var string
     */
    protected $baseEndpoint;

    /**
     * API Version
     *
     * @var string
     */
    protected $apiVersion;

    /**
     * Directus Hosted endpoint format.
     *
     * @var string
     */
    protected $hostedBaseEndpointFormat;

    /**
     * Directus Hosted Instance Key
     *
     * @var int|string
     */
    protected $instanceKey;

    /**
     * Authentication Token
     *
     * @var string
     */
    protected $accessToken;

    /**
     * HTTP Client
     *
     * @var \GuzzleHttp\Client
     */
    protected $httpClient;

    /**
     * HTTP Client request timeout
     *
     * @var int
     */
    protected $timeout = 60;

    const ACTIVITY_GET_ENDPOINT = 'activity';

    const BOOKMARKS_CREATE_ENDPOINT = 'bookmarks';
    const BOOKMARKS_READ_ENDPOINT = 'bookmarks/%s';
    const BOOKMARKS_DELETE_ENDPOINT = 'bookmarks/%s';
    const BOOKMARKS_ALL_ENDPOINT = 'bookmarks';
    const BOOKMARKS_USER_ENDPOINT = 'bookmarks/user/%s';

    const TABLE_ENTRIES_ENDPOINT = 'tables/%s/rows';
    const TABLE_ENTRY_ENDPOINT = 'tables/%s/rows/%s';
    const TABLE_ENTRY_CREATE_ENDPOINT = 'tables/%s/rows';
    const TABLE_ENTRY_UPDATE_ENDPOINT = 'tables/%s/rows/%s';
    const TABLE_ENTRY_DELETE_ENDPOINT = 'tables/%s/rows/%s';
    const TABLE_LIST_ENDPOINT = 'tables';
    const TABLE_INFORMATION_ENDPOINT = 'tables/%s';
    const TABLE_PREFERENCES_ENDPOINT = 'tables/%s/preferences';
    const TABLE_CREATE_ENDPOINT = 'privileges/1'; // ID not being used but required @TODO: REMOVE IT
    const TABLE_DELETE_ENDPOINT = 'tables/%s';

    const COLUMN_LIST_ENDPOINT = 'tables/%s/columns';
    const COLUMN_CREATE_ENDPOINT = 'tables/%s/columns';
    const COLUMN_DELETE_ENDPOINT = 'tables/%s/columns/%s';
    const COLUMN_INFORMATION_ENDPOINT = 'tables/%s/columns/%s';
    const COLUMN_OPTIONS_CREATE_ENDPOINT = 'tables/%s/columns/%s/%s';

    const GROUP_LIST_ENDPOINT = 'groups';
    const GROUP_CREATE_ENDPOINT = 'groups';
    const GROUP_INFORMATION_ENDPOINT = 'groups/%s';
    const GROUP_PRIVILEGES_ENDPOINT = 'privileges/%s';
    const GROUP_PRIVILEGES_CREATE_ENDPOINT = 'privileges/%s';

    const FILE_LIST_ENDPOINT = 'files';
    const FILE_CREATE_ENDPOINT = 'files';
    const FILE_UPDATE_ENDPOINT = 'files/%s';
    const FILE_INFORMATION_ENDPOINT = 'files/%s';

    const SETTING_LIST_ENDPOINT = 'settings';
    const SETTING_COLLECTION_GET_ENDPOINT = 'settings/%s';
    const SETTING_COLLECTION_UPDATE_ENDPOINT = 'settings/%s';

    const MESSAGES_CREATE_ENDPOINT = 'messages/rows';
    const MESSAGES_LIST_ENDPOINT = 'messages/rows';
    const MESSAGES_GET_ENDPOINT = 'messages/rows/%s';
    const MESSAGES_USER_LIST_ENDPOINT = 'messages/user/%s';

    public function __construct($accessToken, $options = [])
    {
        $this->accessToken = $accessToken;

        if (isset($options['base_url'])) {
            $this->baseUrl = rtrim($options['base_url'], '/');
            $this->baseEndpoint = $this->baseUrl . '/api';
        }

        $instanceKey = isset($options['instance_key']) ? $options['instance_key'] : false;
        if ($instanceKey) {
            $this->instanceKey = $instanceKey;
            $this->baseUrl = sprintf($this->hostedBaseUrlFormat, $instanceKey);
            $this->baseEndpoint = $this->baseUrl . '/api';
        }

        $this->apiVersion = isset($options['version']) ? $options['version'] : 1;
        $this->baseEndpoint .= '/' . $this->getAPIVersion();

        $this->setHTTPClient($this->getDefaultHTTPClient());
    }

    /**
     * Get the base endpoint url
     *
     * @return string
     */
    public function getBaseEndpoint()
    {
        return $this->baseEndpoint;
    }

    /**
     * Get the base url
     *
     * @return string
     */
    public function getBaseUrl()
    {
        return $this->baseUrl;
    }

    /**
     * Get API Version
     *
     * @return int|string
     */
    public function getAPIVersion()
    {
        return $this->apiVersion;
    }

    /**
     * Get the authentication access token
     *
     * @return string
     */
    public function getAccessToken()
    {
        return $this->accessToken;
    }

    /**
     * Set a new authentication access token
     *
     * @param $newAccessToken
     */
    public function setAccessToken($newAccessToken)
    {
        $this->accessToken = $newAccessToken;
    }

    /**
     * Get the Directus hosted instance key
     *
     * @return null|string

     */
    public function getInstanceKey()
    {
        return $this->instanceKey;
    }

    /**
     * Set the HTTP Client
     *
     * @param HTTPClient $httpClient
     */
    public function setHTTPClient(HTTPClient $httpClient)
    {
        $this->httpClient = $httpClient;
    }

    /**
     * Get the HTTP Client
     *
     * @return HTTPClient|null
     */
    public function getHTTPClient()
    {
        return $this->httpClient;
    }

    /**
     * Get the default HTTP Client
     *
     * @return HTTPClient
     */
    public function getDefaultHTTPClient()
    {
        return new HTTPClient(array('base_url' => rtrim($this->baseEndpoint, '/') . '/'));
    }

    /**
     * Perform a HTTP Request
     *
     * @param $method
     * @param $path
     * @param array $params
     *
     * @return Entry|EntryCollection
     *
     * @throws UnauthorizedRequestException
     */
    public function performRequest($method, $path, array $params = [])
    {
        $request = $this->buildRequest($method, $path, $params);

        try {
            $response = $this->httpClient->send($request);
            $content = json_decode($response->getBody()->getContents(), true);
            return $this->createResponseFromData($content);
        } catch (ClientException $ex) {
            if ($ex->getResponse()->getStatusCode() == 401) {
                $message = sprintf('Unauthorized %s Request to %s', $request->getMethod(), $request->getUrl());
                throw new UnauthorizedRequestException($message);
            }

            throw $ex;
        }
    }

    /**
     * Build a request object
     *
     * @param $method
     * @param $path
     * @param $params
     *
     * @return \GuzzleHttp\Message\Request
     */
    public function buildRequest($method, $path, array $params = [])
    {
        $body = ArrayUtils::get($params, 'body', []);
        $query = ArrayUtils::get($params, 'query', []);

        $options = [
            'auth' => [$this->accessToken, '']
        ];

        if (in_array($method, ['POST', 'PUT']) && $body) {
            $options['body'] = $body;
        }

        $request = $this->httpClient->createRequest($method, $path, $options);

        if ($query) {
            $q = $request->getQuery();
            foreach($query as $key => $value) {
                $q->set($key, $value);
            }
        }

        return $request;
    }

    /**
     * Build a endpoint path based on a format
     *
     * @param string $pathFormat
     * @param string|array $variables
     *
     * @return string
     */
    public function buildPath($pathFormat, $variables = [])
    {
        return vsprintf(ltrim($pathFormat, '/'), $variables);
    }
}


1		<?php
2
3		/**
4		* Directus – <http://getdirectus.com>
5		*
6		* @link The canonical repository – <https://github.com/directus/directus>
7		* @copyright Copyright 2006-2016 RANGER Studio, LLC – <http://rangerstudio.com>
8		* @license GNU General Public License (v3) – <http://www.gnu.org/copyleft/gpl.html>
9		*/
10
11		namespace Directus\SDK;
12
13		use Directus\SDK\Exception\UnauthorizedRequestException;
14		use Directus\SDK\Response\Entry;
15		use Directus\SDK\Response\EntryCollection;
16		use Directus\Util\ArrayUtils;
17		use GuzzleHttp\Client as HTTPClient;
18		use GuzzleHttp\Exception\ClientException;
19
20		/**
21		* Abstract Base Client Remote
22		*
23		* @author Welling Guzmán <[email protected]>
24		*/
25		abstract class BaseClientRemote extends AbstractClient
		0 ignored issues – show Coding Style introduced 2016-12-24 08:49 UTC by Report Bug Copy Issue Report `BaseClientRemote` does not seem to conform to the naming convention (`^Abstract\|Factory$`). This check examines a number of code elements and verifies that they conform to the given naming conventions. You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods. Loading history...
26		{
27		/**
28		* Directus base url
29		*
30		* @var string
31		*/
32		protected $baseUrl = 'http://localhost';
33
34		/**
35		* Directus hosted base url format
36		*
37		* @var string
38		*/
39		protected $hostedBaseUrlFormat = 'https://%s.directus.io';
40
41		/**
42		* Directus Server base endpoint
43		*
44		* @var string
45		*/
46		protected $baseEndpoint;
47
48		/**
49		* API Version
50		*
51		* @var string
52		*/
53		protected $apiVersion;
54
55		/**
56		* Directus Hosted endpoint format.
57		*
58		* @var string
59		*/
60		protected $hostedBaseEndpointFormat;
61
62		/**
63		* Directus Hosted Instance Key
64		*
65		* @var int\|string
66		*/
67		protected $instanceKey;
68
69		/**
70		* Authentication Token
71		*
72		* @var string
73		*/
74		protected $accessToken;
75
76		/**
77		* HTTP Client
78		*
79		* @var \GuzzleHttp\Client
80		*/
81		protected $httpClient;
82
83		/**
84		* HTTP Client request timeout
85		*
86		* @var int
87		*/
88		protected $timeout = 60;
89
90		const ACTIVITY_GET_ENDPOINT = 'activity';
91
92		const BOOKMARKS_CREATE_ENDPOINT = 'bookmarks';
93		const BOOKMARKS_READ_ENDPOINT = 'bookmarks/%s';
94		const BOOKMARKS_DELETE_ENDPOINT = 'bookmarks/%s';
95		const BOOKMARKS_ALL_ENDPOINT = 'bookmarks';
96		const BOOKMARKS_USER_ENDPOINT = 'bookmarks/user/%s';
97
98		const TABLE_ENTRIES_ENDPOINT = 'tables/%s/rows';
99		const TABLE_ENTRY_ENDPOINT = 'tables/%s/rows/%s';
100		const TABLE_ENTRY_CREATE_ENDPOINT = 'tables/%s/rows';
101		const TABLE_ENTRY_UPDATE_ENDPOINT = 'tables/%s/rows/%s';
102		const TABLE_ENTRY_DELETE_ENDPOINT = 'tables/%s/rows/%s';
103		const TABLE_LIST_ENDPOINT = 'tables';
104		const TABLE_INFORMATION_ENDPOINT = 'tables/%s';
105		const TABLE_PREFERENCES_ENDPOINT = 'tables/%s/preferences';
106		const TABLE_CREATE_ENDPOINT = 'privileges/1'; // ID not being used but required @TODO: REMOVE IT
107		const TABLE_DELETE_ENDPOINT = 'tables/%s';
108
109		const COLUMN_LIST_ENDPOINT = 'tables/%s/columns';
110		const COLUMN_CREATE_ENDPOINT = 'tables/%s/columns';
111		const COLUMN_DELETE_ENDPOINT = 'tables/%s/columns/%s';
112		const COLUMN_INFORMATION_ENDPOINT = 'tables/%s/columns/%s';
113		const COLUMN_OPTIONS_CREATE_ENDPOINT = 'tables/%s/columns/%s/%s';
114
115		const GROUP_LIST_ENDPOINT = 'groups';
116		const GROUP_CREATE_ENDPOINT = 'groups';
117		const GROUP_INFORMATION_ENDPOINT = 'groups/%s';
118		const GROUP_PRIVILEGES_ENDPOINT = 'privileges/%s';
119		const GROUP_PRIVILEGES_CREATE_ENDPOINT = 'privileges/%s';
120
121		const FILE_LIST_ENDPOINT = 'files';
122		const FILE_CREATE_ENDPOINT = 'files';
123		const FILE_UPDATE_ENDPOINT = 'files/%s';
124		const FILE_INFORMATION_ENDPOINT = 'files/%s';
125
126		const SETTING_LIST_ENDPOINT = 'settings';
127		const SETTING_COLLECTION_GET_ENDPOINT = 'settings/%s';
128		const SETTING_COLLECTION_UPDATE_ENDPOINT = 'settings/%s';
129
130		const MESSAGES_CREATE_ENDPOINT = 'messages/rows';
131		const MESSAGES_LIST_ENDPOINT = 'messages/rows';
132		const MESSAGES_GET_ENDPOINT = 'messages/rows/%s';
133		const MESSAGES_USER_LIST_ENDPOINT = 'messages/user/%s';
134
135	38	public function __construct($accessToken, $options = [])
136		{
137	38	$this->accessToken = $accessToken;
138
139	38	if (isset($options['base_url'])) {
140	4	$this->baseUrl = rtrim($options['base_url'], '/');
141	4	$this->baseEndpoint = $this->baseUrl . '/api';
142	4	}
143
144	38	$instanceKey = isset($options['instance_key']) ? $options['instance_key'] : false;
145	38	if ($instanceKey) {
146	2	$this->instanceKey = $instanceKey;
147	2	$this->baseUrl = sprintf($this->hostedBaseUrlFormat, $instanceKey);
148	2	$this->baseEndpoint = $this->baseUrl . '/api';
149	2	}
150
151	38	$this->apiVersion = isset($options['version']) ? $options['version'] : 1;
152	38	$this->baseEndpoint .= '/' . $this->getAPIVersion();
153
154	38	$this->setHTTPClient($this->getDefaultHTTPClient());
155	38	}
156
157		/**
158		* Get the base endpoint url
159		*
160		* @return string
161	1	*/
162	4	public function getBaseEndpoint()
163		{
164	4	return $this->baseEndpoint;
165		}
166
167		/**
168		* Get the base url
169		*
170		* @return string
171		*/
172	2	public function getBaseUrl()
173		{
174	2	return $this->baseUrl;
175		}
176
177		/**
178		* Get API Version
179		*
180		* @return int\|string
181		*/
182	38	public function getAPIVersion()
183		{
184	38	return $this->apiVersion;
185		}
186
187		/**
188		* Get the authentication access token
189		*
190		* @return string
191		*/
192	2	public function getAccessToken()
193		{
194	2	return $this->accessToken;
195		}
196
197		/**
198		* Set a new authentication access token
199		*
200		* @param $newAccessToken
201		*/
202	2	public function setAccessToken($newAccessToken)
203		{
204	2	$this->accessToken = $newAccessToken;
205	2	}
206
207		/**
208		* Get the Directus hosted instance key
209		*
210		* @return null\|string
		0 ignored issues – show Documentation introduced 2016-12-24 08:49 UTC by Report Bug Copy Issue Report Should the return type not be `integer\|string`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
211		*/
212	4	public function getInstanceKey()
213		{
214	4	return $this->instanceKey;
215		}
216
217		/**
218		* Set the HTTP Client
219		*
220		* @param HTTPClient $httpClient
221		*/
222	38	public function setHTTPClient(HTTPClient $httpClient)
223		{
224	38	$this->httpClient = $httpClient;
225	38	}
226
227		/**
228		* Get the HTTP Client
229		*
230		* @return HTTPClient\|null
231		*/
232	38	public function getHTTPClient()
233		{
234	38	return $this->httpClient;
235		}
236
237		/**
238		* Get the default HTTP Client
239		*
240		* @return HTTPClient
241		*/
242	38	public function getDefaultHTTPClient()
243		{
244	38	return new HTTPClient(array('base_url' => rtrim($this->baseEndpoint, '/') . '/'));
245		}
246
247		/**
248		* Perform a HTTP Request
249		*
250		* @param $method
251		* @param $path
252		* @param array $params
253		*
254		* @return Entry\|EntryCollection
255		*
256		* @throws UnauthorizedRequestException
257		*/
258	28	public function performRequest($method, $path, array $params = [])
259		{
260	28	$request = $this->buildRequest($method, $path, $params);
261
262		try {
263	28	$response = $this->httpClient->send($request);
264	28	$content = json_decode($response->getBody()->getContents(), true);
265	28	return $this->createResponseFromData($content);
266		} catch (ClientException $ex) {
267		if ($ex->getResponse()->getStatusCode() == 401) {
268		$message = sprintf('Unauthorized %s Request to %s', $request->getMethod(), $request->getUrl());
269		throw new UnauthorizedRequestException($message);
270		}
271
272		throw $ex;
273		}
274		}
275
276		/**
277		* Build a request object
278		*
279		* @param $method
280		* @param $path
281		* @param $params
282		*
283		* @return \GuzzleHttp\Message\Request
284		*/
285	30	public function buildRequest($method, $path, array $params = [])
286		{
287	30	$body = ArrayUtils::get($params, 'body', []);
288	30	$query = ArrayUtils::get($params, 'query', []);
289
290		$options = [
291	30	'auth' => [$this->accessToken, '']
292	30	];
293
294	30	if (in_array($method, ['POST', 'PUT']) && $body) {
295		$options['body'] = $body;
296		}
297
298	30	$request = $this->httpClient->createRequest($method, $path, $options);
299
300	30	if ($query) {
301		$q = $request->getQuery();
302		foreach($query as $key => $value) {
303		$q->set($key, $value);
304		}
305		}
306
307	30	return $request;
308		}
309
310		/**
311		* Build a endpoint path based on a format
312		*
313		* @param string $pathFormat
314		* @param string\|array $variables
315		*
316		* @return string
317		*/
318	24	public function buildPath($pathFormat, $variables = [])
319		{
320	24	return vsprintf(ltrim($pathFormat, '/'), $variables);
321		}
322		}
323

directus / directus-sdk-php

Push — master ( 6ea6e9...f8768f )

BaseClientRemote::buildPath() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like