Client::normalizePath() - Code Metrics - Inspection of "add createSharedLinkWithSettings" - spatie/dropbox-api - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 476cc6...2a3970 )

by Freek

created 2017-04-29 12:23 UTC

Client::normalizePath() A

↳ Parent: Client

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	10
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	5
nc	2
nop	1

<?php

namespace Spatie\Dropbox;

use Exception;
use GuzzleHttp\Psr7\StreamWrapper;
use GuzzleHttp\Client as GuzzleClient;
use Psr\Http\Message\ResponseInterface;
use GuzzleHttp\Exception\ClientException;
use Spatie\Dropbox\Exceptions\BadRequest;

class Client
{
    const THUMBNAIL_FORMAT_JPEG = 'jpeg';
    const THUMBNAIL_FORMAT_PNG = 'png';

    const THUMBNAIL_SIZE_XS = 'w32h32';
    const THUMBNAIL_SIZE_S = 'w64h64';
    const THUMBNAIL_SIZE_M = 'w128h128';
    const THUMBNAIL_SIZE_L = 'w640h480';
    const THUMBNAIL_SIZE_XL = 'w1024h768';

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

    /** @var \GuzzleHttp\Client */
    protected $client;

    public function __construct(string $accessToken, GuzzleClient $client = null)
    {
        $this->accessToken = $accessToken;

        $this->client = $client ?? new GuzzleClient([
                'headers' => [
                    'Authorization' => "Bearer {$this->accessToken}",
                ],
            ]);
    }

    /**
     * Copy a file or folder to a different location in the user's Dropbox.
     *
     * If the source path is a folder all its contents will be copied.
     *
     * @link https://www.dropbox.com/developers/documentation/http/documentation#files-copy
     */
    public function copy(string $fromPath, string $toPath): array

    {
        $parameters = [
            'from_path' => $this->normalizePath($fromPath),
            'to_path' => $this->normalizePath($toPath),
        ];

        return $this->rpcEndpointRequest('files/copy', $parameters);
    }

    /**
     * Create a folder at a given path.
     *
     * @link https://www.dropbox.com/developers/documentation/http/documentation#files-create_folder
     */
    public function createFolder(string $path): array
    {
        $parameters = [
            'path' => $this->normalizePath($path),
        ];

        $object = $this->rpcEndpointRequest('files/create_folder', $parameters);

        $object['.tag'] = 'folder';

        return $object;
    }

    /**
     * Create a shared link with custom settings.
     *
     * If no settings are given then the default visibility is RequestedVisibility.public.
     * The resolved visibility, though, may depend on other aspects such as team and
     * shared folder settings).
     *
     * @link https://www.dropbox.com/developers/documentation/http/documentation#sharing-create_shared_link_with_settings
     */
    public function createSharedLinkWithSettings(string $path, array $settings = [])

    {
        $parameters = [
            'path' => $this->normalizePath($path),
        ];

        return $this->rpcEndpointRequest('sharing/create_shared_link_with_settings', $parameters);
    }

    /**
     * Delete the file or folder at a given path.
     *
     * If the path is a folder, all its contents will be deleted too.
     * A successful response indicates that the file or folder was deleted.
     *
     * @link https://www.dropbox.com/developers/documentation/http/documentation#files-delete
     */
    public function delete(string $path): array
    {
        $parameters = [
            'path' => $this->normalizePath($path),
        ];

        return $this->rpcEndpointRequest('files/delete', $parameters);
    }

    /**
     * Download a file from a user's Dropbox.
     *
     * @param string $path
     *
     * @return resource
     *
     * @link https://www.dropbox.com/developers/documentation/http/documentation#files-download
     */
    public function download(string $path)
    {
        $arguments = [
            'path' => $this->normalizePath($path),
        ];

        $response = $this->contentEndpointRequest('files/download', $arguments);

        return StreamWrapper::getResource($response->getBody());
    }

    /**
     * Returns the metadata for a file or folder.
     *
     * Note: Metadata for the root folder is unsupported.
     *
     * @link https://www.dropbox.com/developers/documentation/http/documentation#files-get_metadata
     */
    public function getMetadata(string $path): array
    {
        $parameters = [
            'path' => $this->normalizePath($path),
        ];

        return $this->rpcEndpointRequest('files/get_metadata', $parameters);
    }

    /**
     * Get a temporary link to stream content of a file.
     *
     * This link will expire in four hours and afterwards you will get 410 Gone.
     * Content-Type of the link is determined automatically by the file's mime type.
     *
     * @link https://www.dropbox.com/developers/documentation/http/documentation#files-get_temporary_link
     */
    public function getTemporaryLink(string $path): string

    {
        $parameters = [
            'path' => $this->normalizePath($path),
        ];

        $body = $this->rpcEndpointRequest('files/get_temporary_link', $parameters);

        return $body['link'];
    }

    /**
     * Get a thumbnail for an image.
     *
     * This method currently supports files with the following file extensions:
     * jpg, jpeg, png, tiff, tif, gif and bmp.
     *
     * Photos that are larger than 20MB in size won't be converted to a thumbnail.
     *
     * @link https://www.dropbox.com/developers/documentation/http/documentation#files-get_thumbnail
     */
    public function getThumbnail(string $path, string $format = 'jpeg', string $size = 'w64h64'): string
    {
        $arguments = [
            'path' => $this->normalizePath($path),
            'format' => $format,
            'size' => $size,
        ];

        $response = $this->contentEndpointRequest('files/get_thumbnail', $arguments);

        return (string) $response->getBody();
    }

    /**
     * Starts returning the contents of a folder.
     *
     * If the result's ListFolderResult.has_more field is true, call
     * list_folder/continue with the returned ListFolderResult.cursor to retrieve more entries.
     *
     * Note: auth.RateLimitError may be returned if multiple list_folder or list_folder/continue calls
     * with same parameters are made simultaneously by same API app for same user. If your app implements
     * retry logic, please hold off the retry until the previous request finishes.
     *
     * @link https://www.dropbox.com/developers/documentation/http/documentation#files-list_folder
     */
    public function listFolder(string $path = '', bool $recursive = false): array

    {
        $parameters = [
            'path' => $this->normalizePath($path),
            'recursive' => $recursive,
        ];

        return $this->rpcEndpointRequest('files/list_folder', $parameters);
    }

    /**
     * Once a cursor has been retrieved from list_folder, use this to paginate through all files and
     * retrieve updates to the folder, following the same rules as documented for list_folder.
     *
     * @link https://www.dropbox.com/developers/documentation/http/documentation#files-list_folder-continue
     */
    public function listFolderContinue(string $cursor = ''): array
    {
        return $this->rpcEndpointRequest('files/list_folder/continue', compact('cursor'));
    }

    /**
     * Move a file or folder to a different location in the user's Dropbox.
     *
     * If the source path is a folder all its contents will be moved.
     *
     * @link https://www.dropbox.com/developers/documentation/http/documentation#files-move
     */
    public function move(string $fromPath, string $toPath): array

    {
        $parameters = [
            'from_path' => $this->normalizePath($fromPath),
            'to_path' => $this->normalizePath($toPath),
        ];

        return $this->rpcEndpointRequest('files/move', $parameters);
    }

    /**
     * Create a new file with the contents provided in the request.
     *
     * Do not use this to upload a file larger than 150 MB. Instead, create an upload session with upload_session/start.
     *
     * @link https://www.dropbox.com/developers/documentation/http/documentation#files-upload
     *
     * @param string $path
     * @param string|resource $contents
     * @param string|array $mode
     *
     * @return array
     */
    public function upload(string $path, $contents, $mode = 'add'): array
    {
        $arguments = [
            'path' => $this->normalizePath($path),
            'mode' => $mode,
        ];

        $response = $this->contentEndpointRequest('files/upload', $arguments, $contents);

        $metadata = json_decode($response->getBody(), true);

        $metadata['.tag'] = 'file';

        return $metadata;
    }

    protected function normalizePath(string $path): string
    {
        $path = trim($path, '/');

        if ($path === '') {
            return '';
        }

        return '/'.$path;
    }

    /**
     * @param string $endpoint
     * @param array $arguments
     * @param string|resource $body
     *
     * @return \Psr\Http\Message\ResponseInterface
     *
     * @throws \Exception
     */
    public function contentEndpointRequest(string $endpoint, array $arguments, $body = ''): ResponseInterface
    {
        $headers['Dropbox-API-Arg'] = json_encode($arguments);
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

        if ($body !== '') {
            $headers['Content-Type'] = 'application/octet-stream';
        }

        try {
            $response = $this->client->post("https://content.dropboxapi.com/2/{$endpoint}", [
                'headers' => $headers,
                'body' => $body,
            ]);
        } catch (ClientException $exception) {
            throw $this->determineException($exception);
        }

        return $response;
    }

    public function rpcEndpointRequest(string $endpoint, array $parameters): array
    {
        try {
            $response = $this->client->post("https://api.dropboxapi.com/2/{$endpoint}", [
                'json' => $parameters,
            ]);
        } catch (ClientException $exception) {
            throw $this->determineException($exception);
        }

        return json_decode($response->getBody(), true);
    }

    protected function determineException(ClientException $exception): Exception
    {
        if (in_array($exception->getResponse()->getStatusCode(), [400, 409])) {
            return new BadRequest($exception->getResponse());
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
        }

        return $exception;
    }
}


1		<?php
2
3		namespace Spatie\Dropbox;
4
5		use Exception;
6		use GuzzleHttp\Psr7\StreamWrapper;
7		use GuzzleHttp\Client as GuzzleClient;
8		use Psr\Http\Message\ResponseInterface;
9		use GuzzleHttp\Exception\ClientException;
10		use Spatie\Dropbox\Exceptions\BadRequest;
11
12		class Client
13		{
14		const THUMBNAIL_FORMAT_JPEG = 'jpeg';
15		const THUMBNAIL_FORMAT_PNG = 'png';
16
17		const THUMBNAIL_SIZE_XS = 'w32h32';
18		const THUMBNAIL_SIZE_S = 'w64h64';
19		const THUMBNAIL_SIZE_M = 'w128h128';
20		const THUMBNAIL_SIZE_L = 'w640h480';
21		const THUMBNAIL_SIZE_XL = 'w1024h768';
22
23		/** @var string */
24		protected $accessToken;
25
26		/** @var \GuzzleHttp\Client */
27		protected $client;
28
29		public function __construct(string $accessToken, GuzzleClient $client = null)
30		{
31		$this->accessToken = $accessToken;
32
33		$this->client = $client ?? new GuzzleClient([
34		'headers' => [
35		'Authorization' => "Bearer {$this->accessToken}",
36		],
37		]);
38		}
39
40		/**
41		* Copy a file or folder to a different location in the user's Dropbox.
42		*
43		* If the source path is a folder all its contents will be copied.
44		*
45		* @link https://www.dropbox.com/developers/documentation/http/documentation#files-copy
46		*/
47	View Code Duplication	public function copy(string $fromPath, string $toPath): array
		0 ignored issues – show Duplication introduced 2017-04-19 08:22 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
48		{
49		$parameters = [
50		'from_path' => $this->normalizePath($fromPath),
51		'to_path' => $this->normalizePath($toPath),
52		];
53
54		return $this->rpcEndpointRequest('files/copy', $parameters);
55		}
56
57		/**
58		* Create a folder at a given path.
59		*
60		* @link https://www.dropbox.com/developers/documentation/http/documentation#files-create_folder
61		*/
62		public function createFolder(string $path): array
63		{
64		$parameters = [
65		'path' => $this->normalizePath($path),
66		];
67
68		$object = $this->rpcEndpointRequest('files/create_folder', $parameters);
69
70		$object['.tag'] = 'folder';
71
72		return $object;
73		}
74
75		/**
76		* Create a shared link with custom settings.
77		*
78		* If no settings are given then the default visibility is RequestedVisibility.public.
79		* The resolved visibility, though, may depend on other aspects such as team and
80		* shared folder settings).
81		*
82		* @link https://www.dropbox.com/developers/documentation/http/documentation#sharing-create_shared_link_with_settings
83		*/
84		public function createSharedLinkWithSettings(string $path, array $settings = [])
		0 ignored issues – show Unused Code introduced 2017-04-29 12:25 UTC by Report Bug Copy Issue Report The parameter `$settings` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
85		{
86		$parameters = [
87		'path' => $this->normalizePath($path),
88		];
89
90		return $this->rpcEndpointRequest('sharing/create_shared_link_with_settings', $parameters);
91		}
92
93		/**
94		* Delete the file or folder at a given path.
95		*
96		* If the path is a folder, all its contents will be deleted too.
97		* A successful response indicates that the file or folder was deleted.
98		*
99		* @link https://www.dropbox.com/developers/documentation/http/documentation#files-delete
100		*/
101		public function delete(string $path): array
102		{
103		$parameters = [
104		'path' => $this->normalizePath($path),
105		];
106
107		return $this->rpcEndpointRequest('files/delete', $parameters);
108		}
109
110		/**
111		* Download a file from a user's Dropbox.
112		*
113		* @param string $path
114		*
115		* @return resource
116		*
117		* @link https://www.dropbox.com/developers/documentation/http/documentation#files-download
118		*/
119		public function download(string $path)
120		{
121		$arguments = [
122		'path' => $this->normalizePath($path),
123		];
124
125		$response = $this->contentEndpointRequest('files/download', $arguments);
126
127		return StreamWrapper::getResource($response->getBody());
128		}
129
130		/**
131		* Returns the metadata for a file or folder.
132		*
133		* Note: Metadata for the root folder is unsupported.
134		*
135		* @link https://www.dropbox.com/developers/documentation/http/documentation#files-get_metadata
136		*/
137		public function getMetadata(string $path): array
138		{
139		$parameters = [
140		'path' => $this->normalizePath($path),
141		];
142
143		return $this->rpcEndpointRequest('files/get_metadata', $parameters);
144		}
145
146		/**
147		* Get a temporary link to stream content of a file.
148		*
149		* This link will expire in four hours and afterwards you will get 410 Gone.
150		* Content-Type of the link is determined automatically by the file's mime type.
151		*
152		* @link https://www.dropbox.com/developers/documentation/http/documentation#files-get_temporary_link
153		*/
154	View Code Duplication	public function getTemporaryLink(string $path): string
		0 ignored issues – show Duplication introduced 2017-04-19 08:22 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
155		{
156		$parameters = [
157		'path' => $this->normalizePath($path),
158		];
159
160		$body = $this->rpcEndpointRequest('files/get_temporary_link', $parameters);
161
162		return $body['link'];
163		}
164
165		/**
166		* Get a thumbnail for an image.
167		*
168		* This method currently supports files with the following file extensions:
169		* jpg, jpeg, png, tiff, tif, gif and bmp.
170		*
171		* Photos that are larger than 20MB in size won't be converted to a thumbnail.
172		*
173		* @link https://www.dropbox.com/developers/documentation/http/documentation#files-get_thumbnail
174		*/
175		public function getThumbnail(string $path, string $format = 'jpeg', string $size = 'w64h64'): string
176		{
177		$arguments = [
178		'path' => $this->normalizePath($path),
179		'format' => $format,
180		'size' => $size,
181		];
182
183		$response = $this->contentEndpointRequest('files/get_thumbnail', $arguments);
184
185		return (string) $response->getBody();
186		}
187
188		/**
189		* Starts returning the contents of a folder.
190		*
191		* If the result's ListFolderResult.has_more field is true, call
192		* list_folder/continue with the returned ListFolderResult.cursor to retrieve more entries.
193		*
194		* Note: auth.RateLimitError may be returned if multiple list_folder or list_folder/continue calls
195		* with same parameters are made simultaneously by same API app for same user. If your app implements
196		* retry logic, please hold off the retry until the previous request finishes.
197		*
198		* @link https://www.dropbox.com/developers/documentation/http/documentation#files-list_folder
199		*/
200	View Code Duplication	public function listFolder(string $path = '', bool $recursive = false): array
		0 ignored issues – show Duplication introduced 2017-04-19 08:22 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
201		{
202		$parameters = [
203		'path' => $this->normalizePath($path),
204		'recursive' => $recursive,
205		];
206
207		return $this->rpcEndpointRequest('files/list_folder', $parameters);
208		}
209
210		/**
211		* Once a cursor has been retrieved from list_folder, use this to paginate through all files and
212		* retrieve updates to the folder, following the same rules as documented for list_folder.
213		*
214		* @link https://www.dropbox.com/developers/documentation/http/documentation#files-list_folder-continue
215		*/
216		public function listFolderContinue(string $cursor = ''): array
217		{
218		return $this->rpcEndpointRequest('files/list_folder/continue', compact('cursor'));
219		}
220
221		/**
222		* Move a file or folder to a different location in the user's Dropbox.
223		*
224		* If the source path is a folder all its contents will be moved.
225		*
226		* @link https://www.dropbox.com/developers/documentation/http/documentation#files-move
227		*/
228	View Code Duplication	public function move(string $fromPath, string $toPath): array
		0 ignored issues – show Duplication introduced 2017-04-19 08:22 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
229		{
230		$parameters = [
231		'from_path' => $this->normalizePath($fromPath),
232		'to_path' => $this->normalizePath($toPath),
233		];
234
235		return $this->rpcEndpointRequest('files/move', $parameters);
236		}
237
238		/**
239		* Create a new file with the contents provided in the request.
240		*
241		* Do not use this to upload a file larger than 150 MB. Instead, create an upload session with upload_session/start.
242		*
243		* @link https://www.dropbox.com/developers/documentation/http/documentation#files-upload
244		*
245		* @param string $path
246		* @param string\|resource $contents
247		* @param string\|array $mode
248		*
249		* @return array
250		*/
251		public function upload(string $path, $contents, $mode = 'add'): array
252		{
253		$arguments = [
254		'path' => $this->normalizePath($path),
255		'mode' => $mode,
256		];
257
258		$response = $this->contentEndpointRequest('files/upload', $arguments, $contents);
259
260		$metadata = json_decode($response->getBody(), true);
261
262		$metadata['.tag'] = 'file';
263
264		return $metadata;
265		}
266
267		protected function normalizePath(string $path): string
268		{
269		$path = trim($path, '/');
270
271		if ($path === '') {
272		return '';
273		}
274
275		return '/'.$path;
276		}
277
278		/**
279		* @param string $endpoint
280		* @param array $arguments
281		* @param string\|resource $body
282		*
283		* @return \Psr\Http\Message\ResponseInterface
284		*
285		* @throws \Exception
286		*/
287		public function contentEndpointRequest(string $endpoint, array $arguments, $body = ''): ResponseInterface
288		{
289		$headers['Dropbox-API-Arg'] = json_encode($arguments);
		0 ignored issues – show Coding Style Comprehensibility introduced 2017-04-19 09:11 UTC by Report Bug Copy Issue Report `$headers` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$headers = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
290
291		if ($body !== '') {
292		$headers['Content-Type'] = 'application/octet-stream';
293		}
294
295		try {
296		$response = $this->client->post("https://content.dropboxapi.com/2/{$endpoint}", [
297		'headers' => $headers,
298		'body' => $body,
299		]);
300		} catch (ClientException $exception) {
301		throw $this->determineException($exception);
302		}
303
304		return $response;
305		}
306
307		public function rpcEndpointRequest(string $endpoint, array $parameters): array
308		{
309		try {
310		$response = $this->client->post("https://api.dropboxapi.com/2/{$endpoint}", [
311		'json' => $parameters,
312		]);
313		} catch (ClientException $exception) {
314		throw $this->determineException($exception);
315		}
316
317		return json_decode($response->getBody(), true);
318		}
319
320		protected function determineException(ClientException $exception): Exception
321		{
322		if (in_array($exception->getResponse()->getStatusCode(), [400, 409])) {
323		return new BadRequest($exception->getResponse());
		0 ignored issues – show Bug introduced 2017-04-19 09:39 UTC by Report Bug Copy Issue Report It seems like `$exception->getResponse()` can be `null`; however, `__construct()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
324		}
325
326		return $exception;
327		}
328		}
329

spatie / dropbox-api

GitHub Access Token became invalid

Push — master ( 476cc6...2a3970 )

Client::normalizePath() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like