Container::uploadFrom() - Code Metrics - Inspection of "Small fixes; remove some code duplications; add Ch..." - ArgentCrusade/selectel-cloud-storage - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 020561...88353f )

by Timur

created 2017-01-12 07:37 UTC

Container::uploadFrom() A

↳ Parent: Container

Complexity

Conditions	2
Paths	2

Size

Total Lines	16
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	16
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	9
nc	2
nop	4

<?php

namespace ArgentCrusade\Selectel\CloudStorage;

use ArgentCrusade\Selectel\CloudStorage\Collections\Collection;
use ArgentCrusade\Selectel\CloudStorage\Contracts\Api\ApiClientContract;
use ArgentCrusade\Selectel\CloudStorage\Contracts\ContainerContract;
use ArgentCrusade\Selectel\CloudStorage\Exceptions\ApiRequestFailedException;
use ArgentCrusade\Selectel\CloudStorage\Exceptions\FileNotFoundException;
use ArgentCrusade\Selectel\CloudStorage\Exceptions\UploadFailedException;
use Countable;
use JsonSerializable;
use LogicException;

class Container implements ContainerContract, Countable, JsonSerializable
{
    /**
     * @var \ArgentCrusade\Selectel\CloudStorage\Contracts\Api\ApiClientContract $api
     */
    protected $api;

    /**
     * Container name.
     *
     * @var string
     */
    protected $name;

    /**
     * Container data.
     *
     * @var array
     */
    protected $data = [];

    /**
     * Determines if container data was already loaded.
     *
     * @var bool
     */
    protected $dataLoaded = false;

    /**
     * @param \ArgentCrusade\Selectel\CloudStorage\Contracts\Api\ApiClientContract $api
     * @param string                                                               $name
     * @param array                                                                $data
     */
    public function __construct(ApiClientContract $api, $name, array $data = [])
    {
        $this->api = $api;
        $this->name = $name;
        $this->data = $data;
        $this->dataLoaded = !empty($data);
    }

    /**
     * Returns specific container data.
     *
     * @param string $key
     * @param mixed  $default = null
     *
     * @return mixed
     */
    protected function containerData($key, $default = null)
    {
        if (!$this->dataLoaded) {
            $this->loadContainerData();
        }

        return isset($this->data[$key]) ? $this->data[$key] : $default;
    }

    /**
     * Lazy loading for container data.
     *
     * @throws \ArgentCrusade\Selectel\CloudStorage\Exceptions\ApiRequestFailedException
     */
    protected function loadContainerData()
    {
        // CloudStorage::containers and CloudStorage::getContainer methods did not
        // produce any requests to Selectel API, since it may be unnecessary if
        // user only wants to upload/manage files or delete container via API.

        // If user really wants some container info, we will load
        // it here on demand. This speeds up application a bit.

        $response = $this->api->request('HEAD', '/'.$this->name());

        if ($response->getStatusCode() !== 204) {
            throw new ApiRequestFailedException('Container "'.$this->name().'" was not found.');
        }

        $this->dataLoaded = true;
        $this->data = [
            'type' => $response->getHeaderLine('X-Container-Meta-Type'),
            'count' => intval($response->getHeaderLine('X-Container-Object-Count')),
            'bytes' => intval($response->getHeaderLine('X-Container-Bytes-Used')),
            'rx_bytes' => intval($response->getHeaderLine('X-Received-Bytes')),
            'tx_bytes' => intval($response->getHeaderLine('X-Transfered-Bytes')),
        ];
    }

    /**
     * Container name.
     *
     * @return string
     */
    public function name()
    {
        return $this->name;
    }

    /**
     * Container visibility type.
     *
     * @return string
     */
    public function type()
    {
        return $this->containerData('type', 'public');
    }

    /**
     * Container files count.
     *
     * @return int
     */
    public function filesCount()
    {
        return intval($this->containerData('count', 0));
    }

    /**
     * Container files count.
     *
     * @return int
     */
    public function count()
    {
        return $this->filesCount();
    }

    /**
     * Container size in bytes.
     *
     * @return int
     */
    public function size()
    {
        return intval($this->containerData('bytes', 0));
    }

    /**
     * Total uploaded (received) bytes.
     *
     * @return int
     */
    public function uploadedBytes()
    {
        return intval($this->containerData('rx_bytes', 0));
    }

    /**
     * Total downloaded (transmitted) bytes.
     *
     * @return int
     */
    public function downloadedBytes()
    {
        return intval($this->containerData('tx_bytes', 0));
    }

    /**
     * Returns JSON representation of container.
     *
     * @return array
     */
    public function jsonSerialize()
    {
        return [
            'name' => $this->name(),
            'type' => $this->type(),
            'files_count' => $this->filesCount(),
            'size' => $this->size(),
            'uploaded_bytes' => $this->uploadedBytes(),
            'downloaded_bytes' => $this->downloadedBytes(),
        ];
    }

    /**
     * Determines if container is public.
     *
     * @return bool
     */
    public function isPublic()
    {
        return $this->type() == 'public';
    }

    /**
     * Determines if container is private.
     *
     * @return bool
     */
    public function isPrivate()
    {
        return !$this->isPublic();
    }

    /**
     * Retrieves files from current container.
     *
     * @param string $directory        = null
     * @param string $prefixOrFullPath = null
     * @param string $delimiter        = null
     * @param int    $limit            = 10000
     * @param string $marker           = ''
     *
     * @return \ArgentCrusade\Selectel\CloudStorage\Contracts\Collections\CollectionContract
     */
    public function files($directory = null, $prefixOrFullPath = null, $delimiter = null, $limit = 10000, $marker = '')
    {
        $response = $this->api->request('GET', '/'.$this->name(), [
            'query' => [
                'limit' => intval($limit),
                'marker' => $marker,
                'path' => !is_null($directory) ? ltrim($directory, '/') : '',
                'prefix' => !is_null($prefixOrFullPath) ? ltrim($prefixOrFullPath, '/') : '',
                'delimiter' => !is_null($delimiter) ? $delimiter : '',
            ],
        ]);

        if ($response->getStatusCode() !== 200) {
            throw new ApiRequestFailedException('Unable to list container files.', $response->getStatusCode());
        }

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

    /**
     * Retrieves file object container. This method does not actually download file, see File::download.
     *
     * @param string $path
     *
     * @throws \ArgentCrusade\Selectel\CloudStorage\Exceptions\FileNotFoundException
     * @throws \LogicException
     *
     * @return \ArgentCrusade\Selectel\CloudStorage\Contracts\FileContract
     */
    public function getFile($path)
    {
        $files = $this->files(null, $path);

        if (!count($files)) {
            throw new FileNotFoundException('File "'.$path.'" was not found in container "'.$this->name().'".');
        }

        if (count($files) > 1) {
            throw new LogicException('There is more than one file that satisfies given path "'.$path.'".');
        }

        return new File($this->api, $this->name(), $files->get(0));
    }

    /**
     * Uploads file contents from string. Returns ETag header value if upload was successful.
     *
     * @param string $path           Remote path.
     * @param string $contents       File contents.
     * @param array  $params         = [] Upload params.
     * @param bool   $verifyChecksum = true
     *
     * @throws \ArgentCrusade\Selectel\CloudStorage\Exceptions\UploadFailedException
     *
     * @return string
     */
    public function uploadFromString($path, $contents, array $params = [], $verifyChecksum = true)
    {
        return $this->uploadFrom($path, $contents, $params, $verifyChecksum);
    }

    /**
     * Uploads file from stream. Returns ETag header value if upload was successful.
     *
     * @param string   $path     Remote path.
     * @param resource $resource Stream resource.
     * @param array    $params   = [] Upload params.
     *
     * @throws \ArgentCrusade\Selectel\CloudStorage\Exceptions\UploadFailedException
     *
     * @return string
     */
    public function uploadFromStream($path, $resource, array $params = [])
    {
        return $this->uploadFrom($path, $resource, $params, false);
    }

    /**
     * Upload file from string or stream resource.
     *
     * @param string            $path           Remote path.
     * @param string | resource $contents       File contents.
     * @param array             $params         = [] Upload params.
     * @param bool              $verifyChecksum = true
     *
     * @throws \ArgentCrusade\Selectel\CloudStorage\Exceptions\UploadFailedException
     *
     * @return string
     */
    protected function uploadFrom($path, $contents, array $params = [], $verifyChecksum = true)
    {
        $headers = $this->convertUploadParamsToHeaders($contents, $params, $verifyChecksum);
        $url = $this->normalizeUploadPath($path);

        $response = $this->api->request('PUT', $url, [
            'headers' => $headers,
            'body' => $contents,
        ]);

        if ($response->getStatusCode() !== 201) {
            throw new UploadFailedException('Unable to upload file.', $response->getStatusCode());
        }

        return $response->getHeaderLine('ETag');
    }

    /**
     * Parses upload parameters and assigns them to appropriate HTTP headers.
     *
     * @param string $contents       = null
     * @param array  $params         = []
     * @param bool   $verifyChecksum = true
     *
     * @return array
     */
    protected function convertUploadParamsToHeaders($contents = null, array $params = [], $verifyChecksum = true)
    {
        $headers = [];

        if ($verifyChecksum) {
            $headers['ETag'] = md5($contents);
        }

        $availableParams = [
            'contentType' => 'Content-Type',
            'contentDisposition' => 'Content-Disposition',
            'deleteAfter' => 'X-Delete-After',
            'deleteAt' => 'X-Delete-At',
        ];

        foreach ($availableParams as $key => $header) {
            if (isset($params[$key])) {
                $headers[$header] = $params[$key];
            }
        }

        return $headers;
    }

    /**
     * Normalizes upload path.
     *
     * @param string $path Remote path (without container name).
     *
     * @return string
     */
    protected function normalizeUploadPath($path)
    {
        return '/'.$this->name().'/'.ltrim($path, '/');
    }

    /**
     * Deletes container. Container must be empty in order to perform this operation.
     *
     * @throws \ArgentCrusade\Selectel\CloudStorage\Exceptions\ApiRequestFailedException
     */
    public function delete()
    {
        $response = $this->api->request('DELETE', '/'.$this->name());

        switch ($response->getStatusCode()) {
            case 204:
                // Container removed.
                return;
            case 404:
                throw new ApiRequestFailedException('Container "'.$this->name().'" was not found.');
            case 409:
                throw new ApiRequestFailedException('Container must be empty.');
        }
    }
}


1			<?php
2
3			namespace ArgentCrusade\Selectel\CloudStorage;
4
5			use ArgentCrusade\Selectel\CloudStorage\Collections\Collection;
6			use ArgentCrusade\Selectel\CloudStorage\Contracts\Api\ApiClientContract;
7			use ArgentCrusade\Selectel\CloudStorage\Contracts\ContainerContract;
8			use ArgentCrusade\Selectel\CloudStorage\Exceptions\ApiRequestFailedException;
9			use ArgentCrusade\Selectel\CloudStorage\Exceptions\FileNotFoundException;
10			use ArgentCrusade\Selectel\CloudStorage\Exceptions\UploadFailedException;
11			use Countable;
12			use JsonSerializable;
13			use LogicException;
14
15			class Container implements ContainerContract, Countable, JsonSerializable
16			{
17			/**
18			* @var \ArgentCrusade\Selectel\CloudStorage\Contracts\Api\ApiClientContract $api
19			*/
20			protected $api;
21
22			/**
23			* Container name.
24			*
25			* @var string
26			*/
27			protected $name;
28
29			/**
30			* Container data.
31			*
32			* @var array
33			*/
34			protected $data = [];
35
36			/**
37			* Determines if container data was already loaded.
38			*
39			* @var bool
40			*/
41			protected $dataLoaded = false;
42
43			/**
44			* @param \ArgentCrusade\Selectel\CloudStorage\Contracts\Api\ApiClientContract $api
45			* @param string $name
46			* @param array $data
47			*/
48			public function __construct(ApiClientContract $api, $name, array $data = [])
49			{
50			$this->api = $api;
51			$this->name = $name;
52			$this->data = $data;
53			$this->dataLoaded = !empty($data);
54			}
55
56			/**
57			* Returns specific container data.
58			*
59			* @param string $key
60			* @param mixed $default = null
61			*
62			* @return mixed
63			*/
64			protected function containerData($key, $default = null)
65			{
66			if (!$this->dataLoaded) {
67			$this->loadContainerData();
68			}
69
70			return isset($this->data[$key]) ? $this->data[$key] : $default;
71			}
72
73			/**
74			* Lazy loading for container data.
75			*
76			* @throws \ArgentCrusade\Selectel\CloudStorage\Exceptions\ApiRequestFailedException
77			*/
78			protected function loadContainerData()
79			{
80			// CloudStorage::containers and CloudStorage::getContainer methods did not
81			// produce any requests to Selectel API, since it may be unnecessary if
82			// user only wants to upload/manage files or delete container via API.
83
84			// If user really wants some container info, we will load
85			// it here on demand. This speeds up application a bit.
86
87			$response = $this->api->request('HEAD', '/'.$this->name());
88
89			if ($response->getStatusCode() !== 204) {
90			throw new ApiRequestFailedException('Container "'.$this->name().'" was not found.');
91			}
92
93			$this->dataLoaded = true;
94			$this->data = [
95			'type' => $response->getHeaderLine('X-Container-Meta-Type'),
96			'count' => intval($response->getHeaderLine('X-Container-Object-Count')),
97			'bytes' => intval($response->getHeaderLine('X-Container-Bytes-Used')),
98			'rx_bytes' => intval($response->getHeaderLine('X-Received-Bytes')),
99			'tx_bytes' => intval($response->getHeaderLine('X-Transfered-Bytes')),
100			];
101			}
102
103			/**
104			* Container name.
105			*
106			* @return string
107			*/
108			public function name()
109			{
110			return $this->name;
111			}
112
113			/**
114			* Container visibility type.
115			*
116			* @return string
117			*/
118			public function type()
119			{
120			return $this->containerData('type', 'public');
121			}
122
123			/**
124			* Container files count.
125			*
126			* @return int
127			*/
128			public function filesCount()
129			{
130			return intval($this->containerData('count', 0));
131			}
132
133			/**
134			* Container files count.
135			*
136			* @return int
137			*/
138			public function count()
139			{
140			return $this->filesCount();
141			}
142
143			/**
144			* Container size in bytes.
145			*
146			* @return int
147			*/
148			public function size()
149			{
150			return intval($this->containerData('bytes', 0));
151			}
152
153			/**
154			* Total uploaded (received) bytes.
155			*
156			* @return int
157			*/
158			public function uploadedBytes()
159			{
160			return intval($this->containerData('rx_bytes', 0));
161			}
162
163			/**
164			* Total downloaded (transmitted) bytes.
165			*
166			* @return int
167			*/
168			public function downloadedBytes()
169			{
170			return intval($this->containerData('tx_bytes', 0));
171			}
172
173			/**
174			* Returns JSON representation of container.
175			*
176			* @return array
177			*/
178			public function jsonSerialize()
179			{
180			return [
181			'name' => $this->name(),
182			'type' => $this->type(),
183			'files_count' => $this->filesCount(),
184			'size' => $this->size(),
185			'uploaded_bytes' => $this->uploadedBytes(),
186			'downloaded_bytes' => $this->downloadedBytes(),
187			];
188			}
189
190			/**
191			* Determines if container is public.
192			*
193			* @return bool
194			*/
195			public function isPublic()
196			{
197			return $this->type() == 'public';
198			}
199
200			/**
201			* Determines if container is private.
202			*
203			* @return bool
204			*/
205			public function isPrivate()
206			{
207			return !$this->isPublic();
208			}
209
210			/**
211			* Retrieves files from current container.
212			*
213			* @param string $directory = null
214			* @param string $prefixOrFullPath = null
215			* @param string $delimiter = null
216			* @param int $limit = 10000
217			* @param string $marker = ''
218			*
219			* @return \ArgentCrusade\Selectel\CloudStorage\Contracts\Collections\CollectionContract
220			*/
221			public function files($directory = null, $prefixOrFullPath = null, $delimiter = null, $limit = 10000, $marker = '')
222			{
223			$response = $this->api->request('GET', '/'.$this->name(), [
224			'query' => [
225			'limit' => intval($limit),
226			'marker' => $marker,
227			'path' => !is_null($directory) ? ltrim($directory, '/') : '',
228			'prefix' => !is_null($prefixOrFullPath) ? ltrim($prefixOrFullPath, '/') : '',
229			'delimiter' => !is_null($delimiter) ? $delimiter : '',
230			],
231			]);
232
233			if ($response->getStatusCode() !== 200) {
234			throw new ApiRequestFailedException('Unable to list container files.', $response->getStatusCode());
235			}
236
237			return new Collection(json_decode($response->getBody(), true));
238			}
239
240			/**
241			* Retrieves file object container. This method does not actually download file, see File::download.
242			*
243			* @param string $path
244			*
245			* @throws \ArgentCrusade\Selectel\CloudStorage\Exceptions\FileNotFoundException
246			* @throws \LogicException
247			*
248			* @return \ArgentCrusade\Selectel\CloudStorage\Contracts\FileContract
249			*/
250			public function getFile($path)
251			{
252			$files = $this->files(null, $path);
253
254			if (!count($files)) {
255			throw new FileNotFoundException('File "'.$path.'" was not found in container "'.$this->name().'".');
256			}
257
258			if (count($files) > 1) {
259			throw new LogicException('There is more than one file that satisfies given path "'.$path.'".');
260			}
261
262			return new File($this->api, $this->name(), $files->get(0));
263			}
264
265			/**
266			* Uploads file contents from string. Returns ETag header value if upload was successful.
267			*
268			* @param string $path Remote path.
269			* @param string $contents File contents.
270			* @param array $params = [] Upload params.
271			* @param bool $verifyChecksum = true
272			*
273			* @throws \ArgentCrusade\Selectel\CloudStorage\Exceptions\UploadFailedException
274			*
275			* @return string
276			*/
277			public function uploadFromString($path, $contents, array $params = [], $verifyChecksum = true)
278			{
279			return $this->uploadFrom($path, $contents, $params, $verifyChecksum);
280			}
281
282			/**
283			* Uploads file from stream. Returns ETag header value if upload was successful.
284			*
285			* @param string $path Remote path.
286			* @param resource $resource Stream resource.
287			* @param array $params = [] Upload params.
288			*
289			* @throws \ArgentCrusade\Selectel\CloudStorage\Exceptions\UploadFailedException
290			*
291			* @return string
292			*/
293			public function uploadFromStream($path, $resource, array $params = [])
294			{
295			return $this->uploadFrom($path, $resource, $params, false);
296			}
297
298			/**
299			* Upload file from string or stream resource.
300			*
301			* @param string $path Remote path.
302			* @param string \| resource $contents File contents.
303			* @param array $params = [] Upload params.
304			* @param bool $verifyChecksum = true
305			*
306			* @throws \ArgentCrusade\Selectel\CloudStorage\Exceptions\UploadFailedException
307			*
308			* @return string
309			*/
310			protected function uploadFrom($path, $contents, array $params = [], $verifyChecksum = true)
311			{
312			$headers = $this->convertUploadParamsToHeaders($contents, $params, $verifyChecksum);
313			$url = $this->normalizeUploadPath($path);
314
315			$response = $this->api->request('PUT', $url, [
316			'headers' => $headers,
317			'body' => $contents,
318			]);
319
320			if ($response->getStatusCode() !== 201) {
321			throw new UploadFailedException('Unable to upload file.', $response->getStatusCode());
322			}
323
324			return $response->getHeaderLine('ETag');
325			}
326
327			/**
328			* Parses upload parameters and assigns them to appropriate HTTP headers.
329			*
330			* @param string $contents = null
331			* @param array $params = []
332			* @param bool $verifyChecksum = true
333			*
334			* @return array
335			*/
336			protected function convertUploadParamsToHeaders($contents = null, array $params = [], $verifyChecksum = true)
337			{
338			$headers = [];
339
340			if ($verifyChecksum) {
341			$headers['ETag'] = md5($contents);
342			}
343
344			$availableParams = [
345			'contentType' => 'Content-Type',
346			'contentDisposition' => 'Content-Disposition',
347			'deleteAfter' => 'X-Delete-After',
348			'deleteAt' => 'X-Delete-At',
349			];
350
351			foreach ($availableParams as $key => $header) {
352			if (isset($params[$key])) {
353			$headers[$header] = $params[$key];
354			}
355			}
356
357			return $headers;
358			}
359
360			/**
361			* Normalizes upload path.
362			*
363			* @param string $path Remote path (without container name).
364			*
365			* @return string
366			*/
367			protected function normalizeUploadPath($path)
368			{
369			return '/'.$this->name().'/'.ltrim($path, '/');
370			}
371
372			/**
373			* Deletes container. Container must be empty in order to perform this operation.
374			*
375			* @throws \ArgentCrusade\Selectel\CloudStorage\Exceptions\ApiRequestFailedException
376			*/
377			public function delete()
378			{
379			$response = $this->api->request('DELETE', '/'.$this->name());
380
381			switch ($response->getStatusCode()) {
382			case 204:
383			// Container removed.
384			return;
385			case 404:
386			throw new ApiRequestFailedException('Container "'.$this->name().'" was not found.');
387			case 409:
388			throw new ApiRequestFailedException('Container must be empty.');
389			}
390			}
391			}
392

ArgentCrusade / selectel-cloud-storage

Push — master ( 020561...88353f )

Container::uploadFrom() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like