Packagist::validateResponse() - Code Metrics - Inspection of "1.0.2 (view changelog)" - wow-apps/symfony-packagist - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 12405d...706141 )

by Alexey

created 2017-12-21 12:06 UTC

Packagist::validateResponse() B

↳ Parent: Packagist

Complexity

Conditions	5
Paths	3

Size

Total Lines	13
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	13
rs	8.8571
c	0
b	0
f	0
cc	5
eloc	7
nc	3
nop	2

<?php
/**
 * This file is part of the wow-apps/symfony-packagist project
 * https://github.com/wow-apps/symfony-packagist
 *
 * (c) 2017 WoW-Apps
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace WowApps\PackagistBundle\Service;

use WowApps\PackagistBundle\DTO\DownloadsStat;
use WowApps\PackagistBundle\DTO\GitHubStat;
use WowApps\PackagistBundle\DTO\Package;
use WowApps\PackagistBundle\DTO\PackageAuthor;
use WowApps\PackagistBundle\DTO\PackageDependency;
use WowApps\PackagistBundle\DTO\PackageDist;
use WowApps\PackagistBundle\DTO\PackageMaintainer;
use WowApps\PackagistBundle\DTO\PackageSource;
use WowApps\PackagistBundle\DTO\PackageVersion;
use WowApps\PackagistBundle\Exception\PackagistException;

/**
 * Class Packagist
 *
 * @author Alexey Samara <[email protected]>
 * @package wow-apps/symfony-packagist
 */
class Packagist
{
    const API_URL = 'https://packagist.org';
    const API_URL_LIST = self::API_URL . '/packages/list.json';
    const API_URL_SEARCH = self::API_URL . '/search.json';
    const API_URL_PACKAGE = self::API_URL . '/packages/%s.json';
    const API_RESULT_PER_PAGE = 15;
    const SUPPORTED_PACKAGE_TYPES = [
        'symfony-bundle',
        'wordpress-plugin',
        'typo3-cms-extension',
        'library',
        'project',
        'metapackage',
        'composer-plugin'
    ];

    /** @var ApiProvider */
    private $apiProvider;

    /**
     * Packagist constructor.
     *
     * @param ApiProvider $apiProvider
     */
    public function __construct(ApiProvider $apiProvider)
    {
        $this->apiProvider = $apiProvider;
    }

    /**
     * @param string|null $query
     * @param string|null $tag
     * @param string|null $type
     * @return \ArrayObject|Package[]
     */
    public function searchPackages($query = null, $tag = null, $type = null): \ArrayObject
    {
        $result = new \ArrayObject();
        $currentPage = 1;
        $request = self::API_URL_SEARCH;
        $attributes = [];

        if (empty($query)) {
            throw new PackagistException(PackagistException::E_EMPTY_SEARCH_QUERY);
        }

        $attributes[] = 'q=' . urlencode($query);

        if (!empty($tag)) {
            $attributes[] = 'tags=' . urlencode($tag);
        }

        if (!empty($type)) {
            $this->validatePackageType($type);
            $attributes[] = 'type=' . urlencode($type);
        }

        $request .= '?' . implode('&', $attributes);

        $response = $this->apiProvider->getAPIResponse($request);
        $this->validateResponse($response, 'results');

        if ($response['total'] == 0) {
            return $result;
        }

        $this->fillSearchResultObject($result, $response['results']);

        $totalPages = ceil((int) $response['total'] / self::API_RESULT_PER_PAGE);

        if ($totalPages === 1) {
            return $result;
        }

        do {
            ++$currentPage;
            $response = $this->apiProvider->getAPIResponse($request . '&page=' . $currentPage);
            $this->validateResponse($response, 'results');

            if ($response['total'] == 0) {
                break;
            }

            $this->fillSearchResultObject($result, $response['results']);

        } while ($currentPage < $totalPages);

        return $result;
    }

    /**
     * @param \ArrayObject $searchResultObject
     * @param array $searchResult
     */
    private function fillSearchResultObject(\ArrayObject &$searchResultObject, array $searchResult)
    {
        if (!empty($searchResult)) {
            foreach ($searchResult as $item) {
                $package = new Package();
                $package
                    ->setName($item['name'])
                    ->setDescription($item['description'])
                    ->setUrl($item['url'])
                    ->setRepository($item['repository'])
                    ->setDownloads(
                        new DownloadsStat($item['downloads'])
                    )
                    ->setFavers($item['favers'])
                ;

                $searchResultObject->offsetSet($package->getName(), $package);
            }
        }
    }

    /**
     * @param string|null $vendor
     * @param string|null $type
     * @return array
     */
    public function getPackageList($vendor = null, $type = null): array
    {
        $request = self::API_URL_LIST;
        $attributes = [];
        if (!empty($vendor)) {
            $attributes[] = 'vendor=' . urlencode($vendor);
        }
        if (!empty($type)) {
            $this->validatePackageType($type);
            $attributes[] = 'type=' . urlencode($type);
        }
        if (!empty($attributes)) {
            $request .= '?' . implode('&', $attributes);
        }
        $response = $this->apiProvider->getAPIResponse($request);
        $this->validateResponse($response, 'packageNames');

        return $response['packageNames'];
    }

    /**
     * @param string $packageName
     * @return Package
     */
    public function getPackage(string $packageName): Package
    {
        $request = sprintf(self::API_URL_PACKAGE, trim($packageName));
        $response = $this->apiProvider->getAPIResponse($request);
        $this->validateResponse($response, 'package');

        return $this->createPackageObject($response);
    }

    /**
     * @param array $packageNames
     * @return \ArrayObject|Package[]
     */
    public function getPackages(array $packageNames): \ArrayObject
    {
        $packages = new \ArrayObject();

        foreach ($packageNames as $packageName) {
            $package = $this->getPackage($packageName);
            $packages->offsetSet($packageName, $package);
        }

        return $packages;
    }

    /**
     * @param array $packageArray
     * @return Package
     */
    private function createPackageObject(array $packageArray): Package
    {
        $package = new Package();

        $package
            ->setName($packageArray['package']['name'] ?? '')
            ->setDescription($packageArray['package']['description'] ?? '')
            ->setTime($packageArray['package']['time'] ?? '')
            ->setMaintainers(new \ArrayObject())
            ->setVersions(new \ArrayObject())
            ->setType($packageArray['package']['type'] ?? '')
            ->setRepository($packageArray['package']['repository'] ?? '')
            ->setGithub(
                new GitHubStat(
                    (int) $packageArray['package']['github_stars'] ?? 0,
                    (int) $packageArray['package']['github_watchers'] ?? 0,
                    (int) $packageArray['package']['github_forks'] ?? 0,
                    (int) $packageArray['package']['github_open_issues'] ?? 0
                )
            )
            ->setLanguage($packageArray['package']['language'] ?? '')
            ->setDependents((int) $packageArray['package']['dependents'] ?? 0)
            ->setSuggesters((int) $packageArray['package']['suggesters'] ?? 0)
            ->setDownloads(
                new DownloadsStat(
                    (int) $packageArray['package']['downloads']['total'] ?? 0,
                    (int) $packageArray['package']['downloads']['monthly'] ?? 0,
                    (int) $packageArray['package']['downloads']['daily'] ?? 0
                )
            )
            ->setFavers((int) $packageArray['package']['favers'] ?? 0)
        ;

        if (!empty($packageArray['package']['maintainers'])) {
            foreach ($packageArray['package']['maintainers'] as $maintainer) {
                $package->getMaintainers()->append(
                    new PackageMaintainer(
                        $maintainer['name'] ?? '',
                        $maintainer['avatar_url'] ?? ''
                    )
                );
            }
        }

        $this->addPackageVersions($package, $packageArray);

        $package->setVersion($this->identifyPackageVersion($package));

        return $package;
    }

    /**
     * @param Package $package
     * @param array $packageArray
     */
    private function addPackageVersions(Package &$package, array $packageArray)
    {
        if (!empty($packageArray['package']['versions'])) {
            foreach ($packageArray['package']['versions'] as $version) {
                if (empty($version['version'])) {
                    continue;
                }

                $packageVersion = new PackageVersion();

                $packageVersion
                    ->setName($version['name'] ?? '')
                    ->setDescription($version['description'] ?? '')
                    ->setKeywords($version['keywords'] ?? [])
                    ->setHomepage($version['homepage'] ?? '')
                    ->setVersion($version['version'])
                    ->setVersionNormalized($version['version_normalized'] ?? '')
                    ->setLicense($version['license'][0] ?? '')
                    ->setAuthors(new \ArrayObject())
                    ->setSource(
                        new PackageSource(
                            $version['source']['type'] ?? '',
                            $version['source']['url'] ?? '',
                            $version['source']['reference'] ?? ''
                        )
                    )
                    ->setDist(
                        new PackageDist(
                            $version['dist']['type'] ?? '',
                            $version['dist']['url'] ?? '',
                            $version['dist']['reference'] ?? '',
                            $version['dist']['shasum'] ?? ''
                        )
                    )
                    ->setType($version['type'] ?? '')
                    ->setTime($version['time'] ?? '')
                    ->setAutoload($version['autoload'] ?? [])
                    ->setRequire(new \ArrayObject())
                ;

                if (!empty($version['authors'])) {
                    foreach ($version['authors'] as $author) {
                        $packageVersion->getAuthors()->append(
                            new PackageAuthor(
                                $author['name'] ?? '',
                                $author['email'] ?? '',
                                $author['homepage'] ?? '',
                                $author['role'] ?? ''
                            )
                        );
                    }
                }

                if (!empty($version['require'])) {
                    foreach ($version['require'] as $name => $ver) {
                        $packageVersion->getRequire()->append(new PackageDependency($name, $ver));
                    }
                }

                $package->getVersions()->offsetSet($packageVersion->getVersion(), $packageVersion);
            }
        }
    }

    /**
     * @param Package $package
     * @return string
     */
    private function identifyPackageVersion(Package $package): string
    {
        if (empty($package->getVersions())) {
            return '';
        }

        $currentVersion = '';

        foreach ($package->getVersions() as $version) {
            if (preg_match('/(dev)/i', $version->getVersion())) {
                continue;
            }

            if (preg_match('/(master)/i', $version->getVersion())) {
                continue;
            }

            if ((int) str_replace('.', '', $version->getVersion()) < (int) str_replace('.', '', $currentVersion)) {
                continue;
            }

            $currentVersion = $version->getVersion();
        }

        return $currentVersion;
    }

    /**
     * @param string $packageType
     * @throws PackagistException
     */
    private function validatePackageType(string $packageType)
    {
        if (empty($packageType) || !in_array($packageType, self::SUPPORTED_PACKAGE_TYPES)) {
            throw new PackagistException(
                PackagistException::E_UNSUPPORTED_PACKAGE_TYPE
            );
        }
    }

    /**
     * @param array $response
     * @param string
     * @return void
     * @throws PackagistException
     */
    private function validateResponse(array $response, string $searchKey = null)
    {
        if (isset($response['status']) && $response['status'] == 'error') {
            throw new PackagistException($response['message'] ?? PackagistException::E_UNKNOWN);
        }

        if (!empty($searchKey) && !isset($response[$searchKey])) {
            throw new PackagistException(
                PackagistException::E_RESPONSE_WITHOUT_NEEDED_KEY,
                ['needed_key' => $searchKey]
            );
        }
    }
}


1			<?php
2			/**
3			* This file is part of the wow-apps/symfony-packagist project
4			* https://github.com/wow-apps/symfony-packagist
5			*
6			* (c) 2017 WoW-Apps
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace WowApps\PackagistBundle\Service;
13
14			use WowApps\PackagistBundle\DTO\DownloadsStat;
15			use WowApps\PackagistBundle\DTO\GitHubStat;
16			use WowApps\PackagistBundle\DTO\Package;
17			use WowApps\PackagistBundle\DTO\PackageAuthor;
18			use WowApps\PackagistBundle\DTO\PackageDependency;
19			use WowApps\PackagistBundle\DTO\PackageDist;
20			use WowApps\PackagistBundle\DTO\PackageMaintainer;
21			use WowApps\PackagistBundle\DTO\PackageSource;
22			use WowApps\PackagistBundle\DTO\PackageVersion;
23			use WowApps\PackagistBundle\Exception\PackagistException;
24
25			/**
26			* Class Packagist
27			*
28			* @author Alexey Samara <[email protected]>
29			* @package wow-apps/symfony-packagist
30			*/
31			class Packagist
32			{
33			const API_URL = 'https://packagist.org';
34			const API_URL_LIST = self::API_URL . '/packages/list.json';
35			const API_URL_SEARCH = self::API_URL . '/search.json';
36			const API_URL_PACKAGE = self::API_URL . '/packages/%s.json';
37			const API_RESULT_PER_PAGE = 15;
38			const SUPPORTED_PACKAGE_TYPES = [
39			'symfony-bundle',
40			'wordpress-plugin',
41			'typo3-cms-extension',
42			'library',
43			'project',
44			'metapackage',
45			'composer-plugin'
46			];
47
48			/** @var ApiProvider */
49			private $apiProvider;
50
51			/**
52			* Packagist constructor.
53			*
54			* @param ApiProvider $apiProvider
55			*/
56			public function __construct(ApiProvider $apiProvider)
57			{
58			$this->apiProvider = $apiProvider;
59			}
60
61			/**
62			* @param string\|null $query
63			* @param string\|null $tag
64			* @param string\|null $type
65			* @return \ArrayObject\|Package[]
66			*/
67			public function searchPackages($query = null, $tag = null, $type = null): \ArrayObject
68			{
69			$result = new \ArrayObject();
70			$currentPage = 1;
71			$request = self::API_URL_SEARCH;
72			$attributes = [];
73
74			if (empty($query)) {
75			throw new PackagistException(PackagistException::E_EMPTY_SEARCH_QUERY);
76			}
77
78			$attributes[] = 'q=' . urlencode($query);
79
80			if (!empty($tag)) {
81			$attributes[] = 'tags=' . urlencode($tag);
82			}
83
84			if (!empty($type)) {
85			$this->validatePackageType($type);
86			$attributes[] = 'type=' . urlencode($type);
87			}
88
89			$request .= '?' . implode('&', $attributes);
90
91			$response = $this->apiProvider->getAPIResponse($request);
92			$this->validateResponse($response, 'results');
93
94			if ($response['total'] == 0) {
95			return $result;
96			}
97
98			$this->fillSearchResultObject($result, $response['results']);
99
100			$totalPages = ceil((int) $response['total'] / self::API_RESULT_PER_PAGE);
101
102			if ($totalPages === 1) {
103			return $result;
104			}
105
106			do {
107			++$currentPage;
108			$response = $this->apiProvider->getAPIResponse($request . '&page=' . $currentPage);
109			$this->validateResponse($response, 'results');
110
111			if ($response['total'] == 0) {
112			break;
113			}
114
115			$this->fillSearchResultObject($result, $response['results']);
116
117			} while ($currentPage < $totalPages);
118
119			return $result;
120			}
121
122			/**
123			* @param \ArrayObject $searchResultObject
124			* @param array $searchResult
125			*/
126			private function fillSearchResultObject(\ArrayObject &$searchResultObject, array $searchResult)
127			{
128			if (!empty($searchResult)) {
129			foreach ($searchResult as $item) {
130			$package = new Package();
131			$package
132			->setName($item['name'])
133			->setDescription($item['description'])
134			->setUrl($item['url'])
135			->setRepository($item['repository'])
136			->setDownloads(
137			new DownloadsStat($item['downloads'])
138			)
139			->setFavers($item['favers'])
140			;
141
142			$searchResultObject->offsetSet($package->getName(), $package);
143			}
144			}
145			}
146
147			/**
148			* @param string\|null $vendor
149			* @param string\|null $type
150			* @return array
151			*/
152			public function getPackageList($vendor = null, $type = null): array
153			{
154			$request = self::API_URL_LIST;
155			$attributes = [];
156			if (!empty($vendor)) {
157			$attributes[] = 'vendor=' . urlencode($vendor);
158			}
159			if (!empty($type)) {
160			$this->validatePackageType($type);
161			$attributes[] = 'type=' . urlencode($type);
162			}
163			if (!empty($attributes)) {
164			$request .= '?' . implode('&', $attributes);
165			}
166			$response = $this->apiProvider->getAPIResponse($request);
167			$this->validateResponse($response, 'packageNames');
168
169			return $response['packageNames'];
170			}
171
172			/**
173			* @param string $packageName
174			* @return Package
175			*/
176			public function getPackage(string $packageName): Package
177			{
178			$request = sprintf(self::API_URL_PACKAGE, trim($packageName));
179			$response = $this->apiProvider->getAPIResponse($request);
180			$this->validateResponse($response, 'package');
181
182			return $this->createPackageObject($response);
183			}
184
185			/**
186			* @param array $packageNames
187			* @return \ArrayObject\|Package[]
188			*/
189			public function getPackages(array $packageNames): \ArrayObject
190			{
191			$packages = new \ArrayObject();
192
193			foreach ($packageNames as $packageName) {
194			$package = $this->getPackage($packageName);
195			$packages->offsetSet($packageName, $package);
196			}
197
198			return $packages;
199			}
200
201			/**
202			* @param array $packageArray
203			* @return Package
204			*/
205			private function createPackageObject(array $packageArray): Package
206			{
207			$package = new Package();
208
209			$package
210			->setName($packageArray['package']['name'] ?? '')
211			->setDescription($packageArray['package']['description'] ?? '')
212			->setTime($packageArray['package']['time'] ?? '')
213			->setMaintainers(new \ArrayObject())
214			->setVersions(new \ArrayObject())
215			->setType($packageArray['package']['type'] ?? '')
216			->setRepository($packageArray['package']['repository'] ?? '')
217			->setGithub(
218			new GitHubStat(
219			(int) $packageArray['package']['github_stars'] ?? 0,
220			(int) $packageArray['package']['github_watchers'] ?? 0,
221			(int) $packageArray['package']['github_forks'] ?? 0,
222			(int) $packageArray['package']['github_open_issues'] ?? 0
223			)
224			)
225			->setLanguage($packageArray['package']['language'] ?? '')
226			->setDependents((int) $packageArray['package']['dependents'] ?? 0)
227			->setSuggesters((int) $packageArray['package']['suggesters'] ?? 0)
228			->setDownloads(
229			new DownloadsStat(
230			(int) $packageArray['package']['downloads']['total'] ?? 0,
231			(int) $packageArray['package']['downloads']['monthly'] ?? 0,
232			(int) $packageArray['package']['downloads']['daily'] ?? 0
233			)
234			)
235			->setFavers((int) $packageArray['package']['favers'] ?? 0)
236			;
237
238			if (!empty($packageArray['package']['maintainers'])) {
239			foreach ($packageArray['package']['maintainers'] as $maintainer) {
240			$package->getMaintainers()->append(
241			new PackageMaintainer(
242			$maintainer['name'] ?? '',
243			$maintainer['avatar_url'] ?? ''
244			)
245			);
246			}
247			}
248
249			$this->addPackageVersions($package, $packageArray);
250
251			$package->setVersion($this->identifyPackageVersion($package));
252
253			return $package;
254			}
255
256			/**
257			* @param Package $package
258			* @param array $packageArray
259			*/
260			private function addPackageVersions(Package &$package, array $packageArray)
261			{
262			if (!empty($packageArray['package']['versions'])) {
263			foreach ($packageArray['package']['versions'] as $version) {
264			if (empty($version['version'])) {
265			continue;
266			}
267
268			$packageVersion = new PackageVersion();
269
270			$packageVersion
271			->setName($version['name'] ?? '')
272			->setDescription($version['description'] ?? '')
273			->setKeywords($version['keywords'] ?? [])
274			->setHomepage($version['homepage'] ?? '')
275			->setVersion($version['version'])
276			->setVersionNormalized($version['version_normalized'] ?? '')
277			->setLicense($version['license'][0] ?? '')
278			->setAuthors(new \ArrayObject())
279			->setSource(
280			new PackageSource(
281			$version['source']['type'] ?? '',
282			$version['source']['url'] ?? '',
283			$version['source']['reference'] ?? ''
284			)
285			)
286			->setDist(
287			new PackageDist(
288			$version['dist']['type'] ?? '',
289			$version['dist']['url'] ?? '',
290			$version['dist']['reference'] ?? '',
291			$version['dist']['shasum'] ?? ''
292			)
293			)
294			->setType($version['type'] ?? '')
295			->setTime($version['time'] ?? '')
296			->setAutoload($version['autoload'] ?? [])
297			->setRequire(new \ArrayObject())
298			;
299
300			if (!empty($version['authors'])) {
301			foreach ($version['authors'] as $author) {
302			$packageVersion->getAuthors()->append(
303			new PackageAuthor(
304			$author['name'] ?? '',
305			$author['email'] ?? '',
306			$author['homepage'] ?? '',
307			$author['role'] ?? ''
308			)
309			);
310			}
311			}
312
313			if (!empty($version['require'])) {
314			foreach ($version['require'] as $name => $ver) {
315			$packageVersion->getRequire()->append(new PackageDependency($name, $ver));
316			}
317			}
318
319			$package->getVersions()->offsetSet($packageVersion->getVersion(), $packageVersion);
320			}
321			}
322			}
323
324			/**
325			* @param Package $package
326			* @return string
327			*/
328			private function identifyPackageVersion(Package $package): string
329			{
330			if (empty($package->getVersions())) {
331			return '';
332			}
333
334			$currentVersion = '';
335
336			foreach ($package->getVersions() as $version) {
337			if (preg_match('/(dev)/i', $version->getVersion())) {
338			continue;
339			}
340
341			if (preg_match('/(master)/i', $version->getVersion())) {
342			continue;
343			}
344
345			if ((int) str_replace('.', '', $version->getVersion()) < (int) str_replace('.', '', $currentVersion)) {
346			continue;
347			}
348
349			$currentVersion = $version->getVersion();
350			}
351
352			return $currentVersion;
353			}
354
355			/**
356			* @param string $packageType
357			* @throws PackagistException
358			*/
359			private function validatePackageType(string $packageType)
360			{
361			if (empty($packageType) \|\| !in_array($packageType, self::SUPPORTED_PACKAGE_TYPES)) {
362			throw new PackagistException(
363			PackagistException::E_UNSUPPORTED_PACKAGE_TYPE
364			);
365			}
366			}
367
368			/**
369			* @param array $response
370			* @param string
371			* @return void
372			* @throws PackagistException
373			*/
374			private function validateResponse(array $response, string $searchKey = null)
375			{
376			if (isset($response['status']) && $response['status'] == 'error') {
377			throw new PackagistException($response['message'] ?? PackagistException::E_UNKNOWN);
378			}
379
380			if (!empty($searchKey) && !isset($response[$searchKey])) {
381			throw new PackagistException(
382			PackagistException::E_RESPONSE_WITHOUT_NEEDED_KEY,
383			['needed_key' => $searchKey]
384			);
385			}
386			}
387			}
388

wow-apps / symfony-packagist

Push — master ( 12405d...706141 )

Packagist::validateResponse() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like