Client::getServiceDocument() - Code Metrics - Schibsted-Tech-Polska/php-sndapi - Measure and Improve Code Quality continuously with Scrutinizer

Client::getServiceDocument() A
last analyzed 2016-10-19 14:08 UTC

↳ Parent: Client

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	6
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	3
nc	1
nop	0

<?php

namespace Stp\SndApi\News;

use GuzzleHttp\Exception\RequestException;
use GuzzleHttp\Message\ResponseInterface;
use Stp\SndApi\Common\Client as CommonClient;
use Stp\SndApi\Common\Exception\ItemDoesNotExistsException;
use Stp\SndApi\Common\Exception\UnsatisfactoryResponseCodeException;
use Stp\SndApi\News\Converter\ArticlesListParametersConverter;
use Stp\SndApi\News\Exception\InvalidContentTypeException;
use Stp\SndApi\News\Exception\InvalidMethodException;
use Stp\SndApi\News\Exception\InvalidMethodParametersException;
use Stp\SndApi\News\Validator\ArticleListMethodValidator;
use Stp\SndApi\News\Validator\ArticlesListParametersValidator;
use Stp\SndApi\News\Validator\ContentTypeValidator;

class Client extends CommonClient
{
    /**
     * {@inheritDoc}
     */
    public function __construct($apiKey, $apiSecret, $publicationId)
    {
        parent::__construct($apiKey, $apiSecret, $publicationId, self::BASE_URL . '/news/v2');
    }

    /**
     * @param string $url
     * @param bool $acceptJsonResponse
     *
     * @return ResponseInterface
     * @throws ItemDoesNotExistsException
     * @throws UnsatisfactoryResponseCodeException
     * @throws RequestException
     */
    protected function apiGet($url, $acceptJsonResponse = true)
    {
        $response = parent::apiGet($url, $acceptJsonResponse);

        if ($response->getStatusCode() === 404) {
            throw new ItemDoesNotExistsException;
        } elseif ($response->getStatusCode() !== 200) {
            throw new UnsatisfactoryResponseCodeException();
        }

        return $response;
    }

    /**
     * @return array|bool|float|int|string
     * @throws ItemDoesNotExistsException
     * @throws UnsatisfactoryResponseCodeException
     */
    public function getServiceDocument()
    {
        $response = $this->apiGet('/');

        return $response->json();
    }

    /**
     * @return array|bool|float|int|string
     * @throws ItemDoesNotExistsException
     * @throws UnsatisfactoryResponseCodeException
     */
    public function getSectionsList()
    {
        $response = $this->apiGet('/publication/{publicationId}/sections');

        return $response->json();
    }

    /**
     * @param int $sectionId
     * @return array|bool|float|int|string
     * @throws ItemDoesNotExistsException
     * @throws UnsatisfactoryResponseCodeException
     */
    public function getSubsectionsList($sectionId)
    {
        $response = $this->apiGet(sprintf('/publication/{publicationId}/sections/%d/subsections', $sectionId));

        return $response->json();
    }

    /**
     * @param string $sectionName
     * @return array|bool|float|int|string
     */
    public function getSectionByUniqueName($sectionName)
    {
        return $this->getSection(sprintf('/publication/{publicationId}/sections/instance?uniqueName=%s', $sectionName));
    }

    /**
     * @param int $sectionId
     * @return array|bool|float|int|string
     */
    public function getSectionById($sectionId)
    {
        return $this->getSection(sprintf('/publication/{publicationId}/sections/%d', $sectionId));
    }

    /**
     * @param string $url
     * @return array|bool|float|int|string
     * @throws ItemDoesNotExistsException
     * @throws UnsatisfactoryResponseCodeException
     */
    private function getSection($url)
    {
        $response = $this->apiGet($url);

        return $response->json();
    }

    /**
     * @param int|string $sectionId Section id or uniqueName
     * @param string $method
     * @param array $parameters
     * @return array|bool|float|int|string
     * @throws InvalidMethodException
     * @throws InvalidMethodParametersException
     * @throws ItemDoesNotExistsException
     * @throws UnsatisfactoryResponseCodeException
     */
    public function getArticlesBySectionId($sectionId, $method, $parameters = [])
    {
        $methodValidator = new ArticleListMethodValidator($method);
        if (!$methodValidator->isValid()) {
            throw new InvalidMethodException(sprintf('Method "%s" is not allowed', $method));
        }

        $parametersConverter = new ArticlesListParametersConverter();
        $parameters = $parametersConverter->convert($parameters);

        $parametersValidator = new ArticlesListParametersValidator($method, $parameters);
        if (!$parametersValidator->isValid()) {
            throw new InvalidMethodParametersException(
                sprintf('Invalid parameter name or value used for "%s" method', $method)
            );
        }

        $url = sprintf(
            '/publication/{publicationId}/sections/%s/%s?%s',
            $sectionId,
            $method,
            http_build_query($parameters)
        );
        $url = rtrim($url, '?&');

        $response = $this->apiGet($url);

        return $response->json();
    }

    /**
     * @param int $contentId
     * @return array|bool|float|int|string
     * @throws InvalidContentTypeException
     */
    public function getArticle($contentId)
    {
        return $this->searchByInstance($contentId, 'article');
    }

    /**
     * @return array
     * @throws ItemDoesNotExistsException
     * @throws UnsatisfactoryResponseCodeException
     */
    public function getImageVersions()
    {
        $response = $this->apiGet(
            sprintf(
                '/publication/%s/imageversions',
                $this->getPublicationId()
            ),
            false
        );

        $imageVersions = [];

        if ($responseBody = $response->getBody()) {
            $imageVersions = array_filter(explode("\n", $responseBody));
        }

        return $imageVersions;
    }

    /**
     * @param int $contentId
     * @param string $contentType
     * @return array|bool|float|int|string
     * @throws InvalidContentTypeException
     * @throws ItemDoesNotExistsException
     * @throws UnsatisfactoryResponseCodeException
     */
    public function searchByInstance($contentId, $contentType)
    {
        $contentTypeValidator = new ContentTypeValidator($contentType);

        if (!$contentTypeValidator->isValid()) {
            throw new InvalidContentTypeException(sprintf('Content Type "%s" is not allowed', $contentType));
        }

        $response = $this->apiGet(
            sprintf(
                '/publication/{publicationId}/searchContents/instance?contentId=%d&contentType=%s',
                $contentId,
                $contentType
            )
        );

        return $response->json();
    }

    /**
     * @param array $contentIds
     * @return array|bool|float|int|string
     * @throws ItemDoesNotExistsException
     * @throws UnsatisfactoryResponseCodeException
     */
    public function searchByCollection($contentIds)
    {
        $response = $this->apiGet(
            sprintf('/publication/{publicationId}/searchContents/collection?contentIds=%s', join(',', $contentIds))
        );

        return $response->json();
    }
}


1			<?php
2
3			namespace Stp\SndApi\News;
4
5			use GuzzleHttp\Exception\RequestException;
6			use GuzzleHttp\Message\ResponseInterface;
7			use Stp\SndApi\Common\Client as CommonClient;
8			use Stp\SndApi\Common\Exception\ItemDoesNotExistsException;
9			use Stp\SndApi\Common\Exception\UnsatisfactoryResponseCodeException;
10			use Stp\SndApi\News\Converter\ArticlesListParametersConverter;
11			use Stp\SndApi\News\Exception\InvalidContentTypeException;
12			use Stp\SndApi\News\Exception\InvalidMethodException;
13			use Stp\SndApi\News\Exception\InvalidMethodParametersException;
14			use Stp\SndApi\News\Validator\ArticleListMethodValidator;
15			use Stp\SndApi\News\Validator\ArticlesListParametersValidator;
16			use Stp\SndApi\News\Validator\ContentTypeValidator;
17
18			class Client extends CommonClient
19			{
20			/**
21			* {@inheritDoc}
22			*/
23			public function __construct($apiKey, $apiSecret, $publicationId)
24			{
25			parent::__construct($apiKey, $apiSecret, $publicationId, self::BASE_URL . '/news/v2');
26			}
27
28			/**
29			* @param string $url
30			* @param bool $acceptJsonResponse
31			*
32			* @return ResponseInterface
33			* @throws ItemDoesNotExistsException
34			* @throws UnsatisfactoryResponseCodeException
35			* @throws RequestException
36			*/
37			protected function apiGet($url, $acceptJsonResponse = true)
38			{
39			$response = parent::apiGet($url, $acceptJsonResponse);
40
41			if ($response->getStatusCode() === 404) {
42			throw new ItemDoesNotExistsException;
43			} elseif ($response->getStatusCode() !== 200) {
44			throw new UnsatisfactoryResponseCodeException();
45			}
46
47			return $response;
48			}
49
50			/**
51			* @return array\|bool\|float\|int\|string
52			* @throws ItemDoesNotExistsException
53			* @throws UnsatisfactoryResponseCodeException
54			*/
55			public function getServiceDocument()
56			{
57			$response = $this->apiGet('/');
58
59			return $response->json();
60			}
61
62			/**
63			* @return array\|bool\|float\|int\|string
64			* @throws ItemDoesNotExistsException
65			* @throws UnsatisfactoryResponseCodeException
66			*/
67			public function getSectionsList()
68			{
69			$response = $this->apiGet('/publication/{publicationId}/sections');
70
71			return $response->json();
72			}
73
74			/**
75			* @param int $sectionId
76			* @return array\|bool\|float\|int\|string
77			* @throws ItemDoesNotExistsException
78			* @throws UnsatisfactoryResponseCodeException
79			*/
80			public function getSubsectionsList($sectionId)
81			{
82			$response = $this->apiGet(sprintf('/publication/{publicationId}/sections/%d/subsections', $sectionId));
83
84			return $response->json();
85			}
86
87			/**
88			* @param string $sectionName
89			* @return array\|bool\|float\|int\|string
90			*/
91			public function getSectionByUniqueName($sectionName)
92			{
93			return $this->getSection(sprintf('/publication/{publicationId}/sections/instance?uniqueName=%s', $sectionName));
94			}
95
96			/**
97			* @param int $sectionId
98			* @return array\|bool\|float\|int\|string
99			*/
100			public function getSectionById($sectionId)
101			{
102			return $this->getSection(sprintf('/publication/{publicationId}/sections/%d', $sectionId));
103			}
104
105			/**
106			* @param string $url
107			* @return array\|bool\|float\|int\|string
108			* @throws ItemDoesNotExistsException
109			* @throws UnsatisfactoryResponseCodeException
110			*/
111			private function getSection($url)
112			{
113			$response = $this->apiGet($url);
114
115			return $response->json();
116			}
117
118			/**
119			* @param int\|string $sectionId Section id or uniqueName
120			* @param string $method
121			* @param array $parameters
122			* @return array\|bool\|float\|int\|string
123			* @throws InvalidMethodException
124			* @throws InvalidMethodParametersException
125			* @throws ItemDoesNotExistsException
126			* @throws UnsatisfactoryResponseCodeException
127			*/
128			public function getArticlesBySectionId($sectionId, $method, $parameters = [])
129			{
130			$methodValidator = new ArticleListMethodValidator($method);
131			if (!$methodValidator->isValid()) {
132			throw new InvalidMethodException(sprintf('Method "%s" is not allowed', $method));
133			}
134
135			$parametersConverter = new ArticlesListParametersConverter();
136			$parameters = $parametersConverter->convert($parameters);
137
138			$parametersValidator = new ArticlesListParametersValidator($method, $parameters);
139			if (!$parametersValidator->isValid()) {
140			throw new InvalidMethodParametersException(
141			sprintf('Invalid parameter name or value used for "%s" method', $method)
142			);
143			}
144
145			$url = sprintf(
146			'/publication/{publicationId}/sections/%s/%s?%s',
147			$sectionId,
148			$method,
149			http_build_query($parameters)
150			);
151			$url = rtrim($url, '?&');
152
153			$response = $this->apiGet($url);
154
155			return $response->json();
156			}
157
158			/**
159			* @param int $contentId
160			* @return array\|bool\|float\|int\|string
161			* @throws InvalidContentTypeException
162			*/
163			public function getArticle($contentId)
164			{
165			return $this->searchByInstance($contentId, 'article');
166			}
167
168			/**
169			* @return array
170			* @throws ItemDoesNotExistsException
171			* @throws UnsatisfactoryResponseCodeException
172			*/
173			public function getImageVersions()
174			{
175			$response = $this->apiGet(
176			sprintf(
177			'/publication/%s/imageversions',
178			$this->getPublicationId()
179			),
180			false
181			);
182
183			$imageVersions = [];
184
185			if ($responseBody = $response->getBody()) {
186			$imageVersions = array_filter(explode("\n", $responseBody));
187			}
188
189			return $imageVersions;
190			}
191
192			/**
193			* @param int $contentId
194			* @param string $contentType
195			* @return array\|bool\|float\|int\|string
196			* @throws InvalidContentTypeException
197			* @throws ItemDoesNotExistsException
198			* @throws UnsatisfactoryResponseCodeException
199			*/
200			public function searchByInstance($contentId, $contentType)
201			{
202			$contentTypeValidator = new ContentTypeValidator($contentType);
203
204			if (!$contentTypeValidator->isValid()) {
205			throw new InvalidContentTypeException(sprintf('Content Type "%s" is not allowed', $contentType));
206			}
207
208			$response = $this->apiGet(
209			sprintf(
210			'/publication/{publicationId}/searchContents/instance?contentId=%d&contentType=%s',
211			$contentId,
212			$contentType
213			)
214			);
215
216			return $response->json();
217			}
218
219			/**
220			* @param array $contentIds
221			* @return array\|bool\|float\|int\|string
222			* @throws ItemDoesNotExistsException
223			* @throws UnsatisfactoryResponseCodeException
224			*/
225			public function searchByCollection($contentIds)
226			{
227			$response = $this->apiGet(
228			sprintf('/publication/{publicationId}/searchContents/collection?contentIds=%s', join(',', $contentIds))
229			);
230
231			return $response->json();
232			}
233			}
234

Schibsted-Tech-Polska / php-sndapi

Client::getServiceDocument() A last analyzed 2016-10-19 14:08 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Client::getServiceDocument() A
last analyzed 2016-10-19 14:08 UTC