ResourceAbstract::request() - Code Metrics - Inspection of "Update tests for CodeCoverage" - zibios/wrike-php-sdk - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( cc8ae8...627a43 )

by Zbigniew

created 2017-01-30 23:22 UTC

ResourceAbstract::request() A

↳ Parent: ResourceAbstract

Complexity

Conditions	1
Paths	1

Size

Total Lines	11
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	11
ccs	9
cts	9
cp	1
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	8
nc	1
nop	4
crap	1

<?php
/**
 * This file is part of the WrikePhpSdk package.
 *
 * (c) Zbigniew Ślązak
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Zibios\WrikePhpSdk\Api;

use Zibios\WrikePhpSdk\Documents\ResponseDocumentInterface;
use Zibios\WrikePhpSdk\Enums\RequestMethodEnum;
use Zibios\WrikePhpSdk\Enums\ResourceMethodEnum;
use Zibios\WrikePhpSdk\Enums\ResponseModeEnum;
use Zibios\WrikePhpSdk\Exceptions\Api\ApiException;

/**
 * Resource Abstract
 */
abstract class ResourceAbstract implements ResourceInterface

{
    const ASSERT_TYPE_NULL = 'null';
$a = "a";
$ab = "ab";
$abc = "abc";
    const ASSERT_TYPE_STRING = 'string';
    const ASSERT_TYPE_ARRAY = 'array';
$a = "a";
$ab = "ab";
$abc = "abc";

    /**
     * @var ConfigInterface
     */
    protected $config;

    /**
     * @param ConfigInterface $config
     */
    public function __construct(ConfigInterface $config)
    {
        $this->setConfig($config);
    }

    /**
     * @return string
     */
    abstract protected function getResponseClass();

    /**
     * @return array
     */
    abstract protected function getResourceMethodConfiguration();

    /**
     * @return ConfigInterface
     */
    protected function getConfig()
    {
        return $this->config;
    }

    /**
     * @param ConfigInterface $config
     *
     * @return $this
     */
    protected function setConfig(ConfigInterface $config)
    {
        $this->config = $config;

        return $this;
    }

    /**
     * @param string $requestMethod
     * @param string $resourceMethod
     * @param array $params
     * @param string|array|null $id
     *
     * @return mixed
     * @throws \LogicException
     * @throws \GuzzleHttp\Exception\GuzzleException
     * @throws \Exception
     * @throws \InvalidArgumentException
     * @throws \Zibios\WrikePhpSdk\Exceptions\Api\ApiException
     * @throws \Zibios\WrikePhpSdk\Exceptions\Api\AccessForbiddenException
     * @throws \Zibios\WrikePhpSdk\Exceptions\Api\InvalidParameterException
     * @throws \Zibios\WrikePhpSdk\Exceptions\Api\InvalidRequestException
     * @throws \Zibios\WrikePhpSdk\Exceptions\Api\NotAllowedException
     * @throws \Zibios\WrikePhpSdk\Exceptions\Api\NotAuthorizedException
     * @throws \Zibios\WrikePhpSdk\Exceptions\Api\ParameterRequiredException
     * @throws \Zibios\WrikePhpSdk\Exceptions\Api\ResourceNotFoundException
     * @throws \Zibios\WrikePhpSdk\Exceptions\Api\ServerErrorException
     */
    protected function request($requestMethod, $resourceMethod, array $params, $id)
    {
        RequestMethodEnum::assertIsValidValue($requestMethod);
        ResourceMethodEnum::assertIsValidValue($resourceMethod);
        return $this->executeRequest(
            $requestMethod,
            $this->prepareRequestPathForResourceMethod($resourceMethod, $id),
            $this->prepareRequestOptionsForRequestMethod($requestMethod, $params),
            $this->getResponseClass()
        );
    }

    /**
     * @param string $requestMethod
     * @param string $path
     * @param array $options
     * @param string $responseDocumentClass
     *
     * @return mixed
     * @throws \LogicException
     * @throws \GuzzleHttp\Exception\GuzzleException
     * @throws \Exception
     * @throws \InvalidArgumentException
     * @throws \Zibios\WrikePhpSdk\Exceptions\Api\ApiException
     * @throws \Zibios\WrikePhpSdk\Exceptions\Api\AccessForbiddenException
     * @throws \Zibios\WrikePhpSdk\Exceptions\Api\InvalidParameterException
     * @throws \Zibios\WrikePhpSdk\Exceptions\Api\InvalidRequestException
     * @throws \Zibios\WrikePhpSdk\Exceptions\Api\NotAllowedException
     * @throws \Zibios\WrikePhpSdk\Exceptions\Api\NotAuthorizedException
     * @throws \Zibios\WrikePhpSdk\Exceptions\Api\ParameterRequiredException
     * @throws \Zibios\WrikePhpSdk\Exceptions\Api\ResourceNotFoundException
     * @throws \Zibios\WrikePhpSdk\Exceptions\Api\ServerErrorException
     */
    private function executeRequest($requestMethod, $path, array $options, $responseDocumentClass)
    {
        $client = $this->getConfig()->getClient();

        $response = null;
        try {
            $response = $client->request($requestMethod, $path, $options);
        } catch (\Exception $e) {
            if ($this->getConfig()->isWrikeExceptionsMode()) {
                throw ApiException::create($e);
            }
            throw $e;
        }

        $responseMode = $this->getConfig()->getResponseMode();
        ResponseModeEnum::assertIsValidValue($responseMode);

        if ($responseMode === ResponseModeEnum::RESPONSE_RAW) {
            return $response;
        }

        $bodyString = (string) $response->getBody();
        if ($responseMode === ResponseModeEnum::BODY_STRING) {
            return $bodyString;
        }

        if ($responseMode === ResponseModeEnum::BODY_OBJECT) {
            return json_decode($bodyString, true);
        }

        /** @var ResponseDocumentInterface $responseDocument */
        $responseDocument = $this->getConfig()->getSerializer()->deserialize(
            (string) $response->getBody(),
            $responseDocumentClass,
            'json'
        );
        if ($responseMode === ResponseModeEnum::BODY_DOCUMENT) {
            return $responseDocument;
        }

        if ($responseMode === ResponseModeEnum::DOCUMENT) {
            return $responseDocument->getData();
        }

        throw new \LogicException();
    }

    /**
     * @param mixed $value
     * @param string $type
     *
     * @throws \InvalidArgumentException
     */
    private function assertIsValidId($value, $type)
    {
        switch ($type) {
            case self::ASSERT_TYPE_NULL:
                if ($value !== null) {
                    throw new \InvalidArgumentException();
                }
                break;
            case self::ASSERT_TYPE_STRING:
                if (is_string($value) === false || trim($value) === '' || strlen($value) > 128) {
                    throw new \InvalidArgumentException(sprintf('Invalid Id, should be not empty string!'));
                }
                break;
            case self::ASSERT_TYPE_ARRAY:
                if (is_array($value) === false) {
                    throw new \InvalidArgumentException();
                }
                /** @var array $value */
                foreach ($value as $id) {
                    $this->assertIsValidId($id, self::ASSERT_TYPE_STRING);
                }
                break;
            default:
                throw new \InvalidArgumentException();
        }
    }

    /**
     * @param string $resourceMethod
     * @param string|array|null $id
     *
     * @return string
     * @throws \InvalidArgumentException
     */
    private function prepareRequestPathForResourceMethod($resourceMethod, $id)
    {
        $resourceMethodConfiguration = $this->getResourceMethodConfiguration();
        if (array_key_exists($resourceMethod, $resourceMethodConfiguration) === false) {
            throw new \InvalidArgumentException();
        }
        $requestPathFormat = $resourceMethodConfiguration[$resourceMethod];

        switch ($resourceMethod) {
            case ResourceMethodEnum::GET_ALL:
                $this->assertIsValidId($id, self::ASSERT_TYPE_NULL);
                return sprintf($requestPathFormat, $id);
            case ResourceMethodEnum::GET_BY_IDS:
                $this->assertIsValidId($id, self::ASSERT_TYPE_ARRAY);
                return sprintf($requestPathFormat, implode(',', $id));
            case ResourceMethodEnum::GET_ALL_IN_ACCOUNT:
            case ResourceMethodEnum::CREATE_IN_ACCOUNT:
            case ResourceMethodEnum::GET_BY_ID:
            case ResourceMethodEnum::UPDATE:
            case ResourceMethodEnum::DELETE:
                $this->assertIsValidId($id, self::ASSERT_TYPE_STRING);
                return sprintf($requestPathFormat, $id);
            default:
                throw new \InvalidArgumentException(sprintf('"%s" resource method not yet supported', $resourceMethod));
        }
    }

    /**
     * @param string $requestMethod
     * @param array $params
     *
     * @return array

     * @throws \InvalidArgumentException
     */
    protected function prepareRequestOptionsForRequestMethod($requestMethod, array $params)
    {
        $options = [
            'headers' => ['Content-Type' => 'application/json'],
        ];

        switch ($requestMethod) {
            case RequestMethodEnum::GET:
                if (count($params) > 0) {
                    $options['query'] = $params;
                }
                break;
            case RequestMethodEnum::PUT:
            case RequestMethodEnum::POST:
                if (count($params) > 0) {
                    $options['body'] = $this->getConfig()->getSerializer()->serialize($params, 'json');
                }
                break;
            case RequestMethodEnum::DELETE:
                break;
            default:
                throw new \InvalidArgumentException();
        }

        return $options;
    }
}


1		<?php
2		/**
3		* This file is part of the WrikePhpSdk package.
4		*
5		* (c) Zbigniew Ślązak
6		*
7		* For the full copyright and license information, please view the LICENSE
8		* file that was distributed with this source code.
9		*/
10
11		namespace Zibios\WrikePhpSdk\Api;
12
13		use Zibios\WrikePhpSdk\Documents\ResponseDocumentInterface;
14		use Zibios\WrikePhpSdk\Enums\RequestMethodEnum;
15		use Zibios\WrikePhpSdk\Enums\ResourceMethodEnum;
16		use Zibios\WrikePhpSdk\Enums\ResponseModeEnum;
17		use Zibios\WrikePhpSdk\Exceptions\Api\ApiException;
18
19		/**
20		* Resource Abstract
21		*/
22		abstract class ResourceAbstract implements ResourceInterface
		0 ignored issues – show Coding Style introduced 2017-01-30 12:59 UTC by Report Bug Copy Issue Report `ResourceAbstract` 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...
23		{
24		const ASSERT_TYPE_NULL = 'null';
		0 ignored issues – show Coding Style introduced 2017-01-30 18:37 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 3 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
25		const ASSERT_TYPE_STRING = 'string';
26		const ASSERT_TYPE_ARRAY = 'array';
		0 ignored issues – show Coding Style introduced 2017-01-30 18:37 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 2 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
27
28		/**
29		* @var ConfigInterface
30		*/
31		protected $config;
32
33		/**
34		* @param ConfigInterface $config
35		*/
36	66	public function __construct(ConfigInterface $config)
37		{
38	66	$this->setConfig($config);
39	66	}
40
41		/**
42		* @return string
43		*/
44		abstract protected function getResponseClass();
45
46		/**
47		* @return array
48		*/
49		abstract protected function getResourceMethodConfiguration();
50
51		/**
52		* @return ConfigInterface
53		*/
54	55	protected function getConfig()
55		{
56	55	return $this->config;
57		}
58
59		/**
60		* @param ConfigInterface $config
61		*
62		* @return $this
63		*/
64	66	protected function setConfig(ConfigInterface $config)
65		{
66	66	$this->config = $config;
67
68	66	return $this;
69		}
70
71		/**
72		* @param string $requestMethod
73		* @param string $resourceMethod
74		* @param array $params
75		* @param string\|array\|null $id
76		*
77		* @return mixed
78		* @throws \LogicException
79		* @throws \GuzzleHttp\Exception\GuzzleException
80		* @throws \Exception
81		* @throws \InvalidArgumentException
82		* @throws \Zibios\WrikePhpSdk\Exceptions\Api\ApiException
83		* @throws \Zibios\WrikePhpSdk\Exceptions\Api\AccessForbiddenException
84		* @throws \Zibios\WrikePhpSdk\Exceptions\Api\InvalidParameterException
85		* @throws \Zibios\WrikePhpSdk\Exceptions\Api\InvalidRequestException
86		* @throws \Zibios\WrikePhpSdk\Exceptions\Api\NotAllowedException
87		* @throws \Zibios\WrikePhpSdk\Exceptions\Api\NotAuthorizedException
88		* @throws \Zibios\WrikePhpSdk\Exceptions\Api\ParameterRequiredException
89		* @throws \Zibios\WrikePhpSdk\Exceptions\Api\ResourceNotFoundException
90		* @throws \Zibios\WrikePhpSdk\Exceptions\Api\ServerErrorException
91		*/
92	55	protected function request($requestMethod, $resourceMethod, array $params, $id)
93		{
94	55	RequestMethodEnum::assertIsValidValue($requestMethod);
95	55	ResourceMethodEnum::assertIsValidValue($resourceMethod);
96	55	return $this->executeRequest(
97	55	$requestMethod,
98	55	$this->prepareRequestPathForResourceMethod($resourceMethod, $id),
99	55	$this->prepareRequestOptionsForRequestMethod($requestMethod, $params),
100	55	$this->getResponseClass()
101	55	);
102		}
103
104		/**
105		* @param string $requestMethod
106		* @param string $path
107		* @param array $options
108		* @param string $responseDocumentClass
109		*
110		* @return mixed
111		* @throws \LogicException
112		* @throws \GuzzleHttp\Exception\GuzzleException
113		* @throws \Exception
114		* @throws \InvalidArgumentException
115		* @throws \Zibios\WrikePhpSdk\Exceptions\Api\ApiException
116		* @throws \Zibios\WrikePhpSdk\Exceptions\Api\AccessForbiddenException
117		* @throws \Zibios\WrikePhpSdk\Exceptions\Api\InvalidParameterException
118		* @throws \Zibios\WrikePhpSdk\Exceptions\Api\InvalidRequestException
119		* @throws \Zibios\WrikePhpSdk\Exceptions\Api\NotAllowedException
120		* @throws \Zibios\WrikePhpSdk\Exceptions\Api\NotAuthorizedException
121		* @throws \Zibios\WrikePhpSdk\Exceptions\Api\ParameterRequiredException
122		* @throws \Zibios\WrikePhpSdk\Exceptions\Api\ResourceNotFoundException
123		* @throws \Zibios\WrikePhpSdk\Exceptions\Api\ServerErrorException
124		*/
125	55	private function executeRequest($requestMethod, $path, array $options, $responseDocumentClass)
126		{
127	55	$client = $this->getConfig()->getClient();
128
129	55	$response = null;
130		try {
131	55	$response = $client->request($requestMethod, $path, $options);
132	55	} catch (\Exception $e) {
133	35	if ($this->getConfig()->isWrikeExceptionsMode()) {
134	18	throw ApiException::create($e);
135		}
136	17	throw $e;
137		}
138
139	20	$responseMode = $this->getConfig()->getResponseMode();
140	20	ResponseModeEnum::assertIsValidValue($responseMode);
141
142	20	if ($responseMode === ResponseModeEnum::RESPONSE_RAW) {
143	16	return $response;
144		}
145
146	20	$bodyString = (string) $response->getBody();
147	20	if ($responseMode === ResponseModeEnum::BODY_STRING) {
148	16	return $bodyString;
149		}
150
151	20	if ($responseMode === ResponseModeEnum::BODY_OBJECT) {
152	16	return json_decode($bodyString, true);
153		}
154
155		/** @var ResponseDocumentInterface $responseDocument */
156	20	$responseDocument = $this->getConfig()->getSerializer()->deserialize(
157	20	(string) $response->getBody(),
158	20	$responseDocumentClass,
159		'json'
160	20	);
161	20	if ($responseMode === ResponseModeEnum::BODY_DOCUMENT) {
162	16	return $responseDocument;
163		}
164
165	20	if ($responseMode === ResponseModeEnum::DOCUMENT) {
166	20	return $responseDocument->getData();
167		}
168
169		throw new \LogicException();
170		}
171
172		/**
173		* @param mixed $value
174		* @param string $type
175		*
176		* @throws \InvalidArgumentException
177		*/
178	55	private function assertIsValidId($value, $type)
179		{
180		switch ($type) {
181	55	case self::ASSERT_TYPE_NULL:
182	40	if ($value !== null) {
183		throw new \InvalidArgumentException();
184		}
185	40	break;
186	15	case self::ASSERT_TYPE_STRING:
187	15	if (is_string($value) === false \|\| trim($value) === '' \|\| strlen($value) > 128) {
188		throw new \InvalidArgumentException(sprintf('Invalid Id, should be not empty string!'));
189		}
190	15	break;
191	1	case self::ASSERT_TYPE_ARRAY:
192	1	if (is_array($value) === false) {
193		throw new \InvalidArgumentException();
194		}
195		/** @var array $value */
196	1	foreach ($value as $id) {
197	1	$this->assertIsValidId($id, self::ASSERT_TYPE_STRING);
198	1	}
199	1	break;
200		default:
201		throw new \InvalidArgumentException();
202		}
203	55	}
204
205		/**
206		* @param string $resourceMethod
207		* @param string\|array\|null $id
208		*
209		* @return string
210		* @throws \InvalidArgumentException
211		*/
212	55	private function prepareRequestPathForResourceMethod($resourceMethod, $id)
213		{
214	55	$resourceMethodConfiguration = $this->getResourceMethodConfiguration();
215	55	if (array_key_exists($resourceMethod, $resourceMethodConfiguration) === false) {
216		throw new \InvalidArgumentException();
217		}
218	55	$requestPathFormat = $resourceMethodConfiguration[$resourceMethod];
219
220		switch ($resourceMethod) {
221	55	case ResourceMethodEnum::GET_ALL:
222	40	$this->assertIsValidId($id, self::ASSERT_TYPE_NULL);
223	40	return sprintf($requestPathFormat, $id);
224	15	case ResourceMethodEnum::GET_BY_IDS:
225	1	$this->assertIsValidId($id, self::ASSERT_TYPE_ARRAY);
226	1	return sprintf($requestPathFormat, implode(',', $id));
227	14	case ResourceMethodEnum::GET_ALL_IN_ACCOUNT:
228	14	case ResourceMethodEnum::CREATE_IN_ACCOUNT:
229	14	case ResourceMethodEnum::GET_BY_ID:
230	14	case ResourceMethodEnum::UPDATE:
231	14	case ResourceMethodEnum::DELETE:
232	14	$this->assertIsValidId($id, self::ASSERT_TYPE_STRING);
233	14	return sprintf($requestPathFormat, $id);
234		default:
235		throw new \InvalidArgumentException(sprintf('"%s" resource method not yet supported', $resourceMethod));
236		}
237		}
238
239		/**
240		* @param string $requestMethod
241		* @param array $params
242		*
243		* @return array
		0 ignored issues – show Documentation introduced 2017-01-30 12:59 UTC by Report Bug Copy Issue Report Consider making the return type a bit more specific; maybe use `array<string,array>`. This check looks for the generic type `array` as a return type and suggests a more specific type. This type is inferred from the actual code. Loading history...
244		* @throws \InvalidArgumentException
245		*/
246	55	protected function prepareRequestOptionsForRequestMethod($requestMethod, array $params)
247		{
248		$options = [
249	55	'headers' => ['Content-Type' => 'application/json'],
250	55	];
251
252		switch ($requestMethod) {
253	55	case RequestMethodEnum::GET:
254	47	if (count($params) > 0) {
255		$options['query'] = $params;
256		}
257	47	break;
258	8	case RequestMethodEnum::PUT:
259	8	case RequestMethodEnum::POST:
260	6	if (count($params) > 0) {
261		$options['body'] = $this->getConfig()->getSerializer()->serialize($params, 'json');
262		}
263	6	break;
264	2	case RequestMethodEnum::DELETE:
265	2	break;
266		default:
267		throw new \InvalidArgumentException();
268		}
269
270	55	return $options;
271		}
272		}
273

zibios / wrike-php-sdk

Push — master ( cc8ae8...627a43 )

ResourceAbstract::request() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like