ResourceEndpoint::__construct() - Code Metrics - Inspection of "[DGS-459][FTR] Added `/api/contacts/suggest` endpo..." - digitalcz/digisign - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — 1.x (#58)

unknown

created 2021-08-17 13:20 UTC

ResourceEndpoint::__construct() A

↳ Parent: ResourceEndpoint

Complexity

Conditions	1
Paths	1

Size

Total Lines	10
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	4
c	1
b	0
f	0
dl	0
loc	10
rs	10
cc	1
nc	1
nop	4

<?php

declare(strict_types=1);

namespace DigitalCz\DigiSign\Endpoint;

use DigitalCz\DigiSign\DigiSignClient;
use DigitalCz\DigiSign\Exception\EmptyResultException;
use DigitalCz\DigiSign\Exception\ResponseException;
use DigitalCz\DigiSign\Exception\RuntimeException;
use DigitalCz\DigiSign\Resource\BaseResource;
use DigitalCz\DigiSign\Resource\Collection;
use DigitalCz\DigiSign\Resource\ListResource;
use DigitalCz\DigiSign\Resource\ResourceInterface;
use DigitalCz\DigiSign\Stream\FileResponse;
use Psr\Http\Message\ResponseInterface;

/**
 * @template T of ResourceInterface
 */
abstract class ResourceEndpoint implements EndpointInterface
{
    /** @var EndpointInterface  */
    protected $parent;

    /** @var string  */
    private $resourcePath;

    /** @var class-string<T> */

    private $resourceClass;

    /** @var mixed[] */
    private $resourceOptions;

    /**
     * @param class-string<T> $resourceClass

     * @param mixed[] $resourceOptions
     */
    public function __construct(
        EndpointInterface $parent,
        string $resourcePath,
        string $resourceClass = BaseResource::class,
        array $resourceOptions = []
    ) {
        $this->parent = $parent;
        $this->resourcePath = $resourcePath;
        $this->resourceClass = $resourceClass;
        $this->resourceOptions = $resourceOptions;
    }

    /**
     * @param mixed[] $options
     */
    public function request(string $method, string $path = '', array $options = []): ResponseInterface
    {
        $path = $this->preparePath($path);
        $options = $this->prepareOptions($options);

        return $this->parent->request($method, $path, $options);
    }

    /**
     * @param mixed[] $options
     */
    public function stream(string $method, string $path = '', array $options = []): FileResponse
    {
        return new FileResponse($this->request($method, $path, $options));
    }

    /**
     * @return class-string<T>

     */
    protected function getResourceClass(): string
    {
        return $this->resourceClass;
    }

    protected function getResourcePath(): string
    {
        return $this->resourcePath;
    }

    /**
     * @return mixed[]
     */
    protected function getResourceOptions(): array
    {
        return $this->resourceOptions;
    }

    /**
     * @param mixed[] $body
     * @return T&ResourceInterface
     */
    protected function makeCreateRequest(array $body): ResourceInterface
    {
        return $this->makeResource($this->postRequest('', ['json' => $body]));
    }

    /**
     * @param mixed[] $body
     */
    protected function makeUpdateRequest(string $id, array $body): ResourceInterface
    {
        return $this->makeResource($this->putRequest('/{id}', ['id' => $id, 'json' => $body]));
    }

    protected function makeDeleteRequest(string $id): void
    {
        $this->deleteRequest('/{id}', ['id' => $id]);
    }

    protected function makeGetRequest(string $id): ResourceInterface
    {
        return $this->makeResource($this->getRequest('/{id}', ['id' => $id]));
    }

    /**
     * @param mixed[] $query
     * @return ListResource<T>
     */
    protected function makeListRequest(array $query = []): ListResource
    {
        return $this->makeListResource($this->getRequest('', ['query' => $query]));
    }

    /**
     * @param mixed[] $options
     */
    protected function getRequest(string $function = '', array $options = []): ResponseInterface
    {
        return $this->request(self::METHOD_GET, $function, $options);
    }

    /**
     * @param mixed[] $options
     */
    protected function postRequest(string $function = '', array $options = []): ResponseInterface
    {
        return $this->request(self::METHOD_POST, $function, $options);
    }

    /**
     * @param mixed[] $options
     */
    protected function putRequest(string $function = '', array $options = []): ResponseInterface
    {
        return $this->request(self::METHOD_PUT, $function, $options);
    }

    /**
     * @param mixed[] $options
     */
    protected function patchRequest(string $function = '', array $options = []): ResponseInterface
    {
        return $this->request(self::METHOD_PATCH, $function, $options);
    }

    /**
     * @param mixed[] $options
     */
    protected function deleteRequest(string $function = '', array $options = []): ResponseInterface
    {
        return $this->request(self::METHOD_DELETE, $function, $options);
    }

    /**
     * @return mixed[]
     */
    protected function parseResponse(ResponseInterface $response): array
    {
        try {
            $result = DigiSignClient::parseResponse($response);
        } catch (RuntimeException $e) {
            throw new ResponseException($response, $e->getMessage(), null, $e);
        }

        if ($result === null) {
            throw new EmptyResultException();
        }

        return $result;
    }

    /**
     * @return T
     */
    protected function makeResource(ResponseInterface $response): ResourceInterface
    {
        return $this->createResource($response, $this->getResourceClass());

    }

    /**
     * @param class-string<U> $resourceClass

     * @return U
     * @template U of ResourceInterface
     */
    protected function createResource(
        ResponseInterface $response,
        string $resourceClass = BaseResource::class
    ): ResourceInterface {
        $resource = new $resourceClass($this->parseResponse($response));
        $resource->setResponse($response);

        return $resource;
    }

    /**
     * @return ListResource<T>
     */
    protected function makeListResource(ResponseInterface $response): ListResource
    {
        return $this->createListResource($response, $this->getResourceClass());
    }

    /**
     * @param class-string<U> $resourceClass

     * @return ListResource<U>
     * @template U of ResourceInterface
     */
    protected function createListResource(
        ResponseInterface $response,
        string $resourceClass = BaseResource::class
    ): ListResource {
        $resource = new ListResource($this->parseResponse($response), $resourceClass);
        $resource->setResponse($response);

        return $resource;
    }

    /**
     * @param class-string<U> $resourceClass

     * @return Collection<U>
     * @template U of ResourceInterface
     */
    protected function createCollectionResource(
        ResponseInterface $response,
        string $resourceClass = BaseResource::class
    ): Collection {
        $collection = new Collection($this->parseResponse($response), $resourceClass);
        $collection->setResponse($response);

        return $collection;
    }

    /**
     * @param mixed[] $options
     * @return mixed[]
     */
    protected function prepareOptions(array $options): array
    {
        return array_merge($this->getResourceOptions(), $options);
    }

    protected function preparePath(string $path): string
    {
        return $this->getResourcePath() . $path;
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace DigitalCz\DigiSign\Endpoint;
6
7			use DigitalCz\DigiSign\DigiSignClient;
8			use DigitalCz\DigiSign\Exception\EmptyResultException;
9			use DigitalCz\DigiSign\Exception\ResponseException;
10			use DigitalCz\DigiSign\Exception\RuntimeException;
11			use DigitalCz\DigiSign\Resource\BaseResource;
12			use DigitalCz\DigiSign\Resource\Collection;
13			use DigitalCz\DigiSign\Resource\ListResource;
14			use DigitalCz\DigiSign\Resource\ResourceInterface;
15			use DigitalCz\DigiSign\Stream\FileResponse;
16			use Psr\Http\Message\ResponseInterface;
17
18			/**
19			* @template T of ResourceInterface
20			*/
21			abstract class ResourceEndpoint implements EndpointInterface
22			{
23			/** @var EndpointInterface */
24			protected $parent;
25
26			/** @var string */
27			private $resourcePath;
28
29			/** @var class-string<T> */
			0 ignored issues – show Documentation Bug introduced 2021-06-09 15:37 UTC by Report Bug Copy Issue Report The doc comment `class-string<T>` at position `0` could not be parsed: Unknown type name 'class-string' at position 0 in class-string<T>. Loading history...
30			private $resourceClass;
31
32			/** @var mixed[] */
33			private $resourceOptions;
34
35			/**
36			* @param class-string<T> $resourceClass
			0 ignored issues – show Documentation Bug introduced 2021-06-09 15:37 UTC by Report Bug Copy Issue Report The doc comment `class-string<T>` at position `0` could not be parsed: Unknown type name 'class-string' at position 0 in class-string<T>. Loading history...
37			* @param mixed[] $resourceOptions
38			*/
39			public function __construct(
40			EndpointInterface $parent,
41			string $resourcePath,
42			string $resourceClass = BaseResource::class,
43			array $resourceOptions = []
44			) {
45			$this->parent = $parent;
46			$this->resourcePath = $resourcePath;
47			$this->resourceClass = $resourceClass;
48			$this->resourceOptions = $resourceOptions;
49			}
50
51			/**
52			* @param mixed[] $options
53			*/
54			public function request(string $method, string $path = '', array $options = []): ResponseInterface
55			{
56			$path = $this->preparePath($path);
57			$options = $this->prepareOptions($options);
58
59			return $this->parent->request($method, $path, $options);
60			}
61
62			/**
63			* @param mixed[] $options
64			*/
65			public function stream(string $method, string $path = '', array $options = []): FileResponse
66			{
67			return new FileResponse($this->request($method, $path, $options));
68			}
69
70			/**
71			* @return class-string<T>
			0 ignored issues – show Documentation Bug introduced 2021-06-09 15:37 UTC by Report Bug Copy Issue Report The doc comment `class-string<T>` at position `0` could not be parsed: Unknown type name 'class-string' at position 0 in class-string<T>. Loading history...
72			*/
73			protected function getResourceClass(): string
74			{
75			return $this->resourceClass;
76			}
77
78			protected function getResourcePath(): string
79			{
80			return $this->resourcePath;
81			}
82
83			/**
84			* @return mixed[]
85			*/
86			protected function getResourceOptions(): array
87			{
88			return $this->resourceOptions;
89			}
90
91			/**
92			* @param mixed[] $body
93			* @return T&ResourceInterface
94			*/
95			protected function makeCreateRequest(array $body): ResourceInterface
96			{
97			return $this->makeResource($this->postRequest('', ['json' => $body]));
98			}
99
100			/**
101			* @param mixed[] $body
102			*/
103			protected function makeUpdateRequest(string $id, array $body): ResourceInterface
104			{
105			return $this->makeResource($this->putRequest('/{id}', ['id' => $id, 'json' => $body]));
106			}
107
108			protected function makeDeleteRequest(string $id): void
109			{
110			$this->deleteRequest('/{id}', ['id' => $id]);
111			}
112
113			protected function makeGetRequest(string $id): ResourceInterface
114			{
115			return $this->makeResource($this->getRequest('/{id}', ['id' => $id]));
116			}
117
118			/**
119			* @param mixed[] $query
120			* @return ListResource<T>
121			*/
122			protected function makeListRequest(array $query = []): ListResource
123			{
124			return $this->makeListResource($this->getRequest('', ['query' => $query]));
125			}
126
127			/**
128			* @param mixed[] $options
129			*/
130			protected function getRequest(string $function = '', array $options = []): ResponseInterface
131			{
132			return $this->request(self::METHOD_GET, $function, $options);
133			}
134
135			/**
136			* @param mixed[] $options
137			*/
138			protected function postRequest(string $function = '', array $options = []): ResponseInterface
139			{
140			return $this->request(self::METHOD_POST, $function, $options);
141			}
142
143			/**
144			* @param mixed[] $options
145			*/
146			protected function putRequest(string $function = '', array $options = []): ResponseInterface
147			{
148			return $this->request(self::METHOD_PUT, $function, $options);
149			}
150
151			/**
152			* @param mixed[] $options
153			*/
154			protected function patchRequest(string $function = '', array $options = []): ResponseInterface
155			{
156			return $this->request(self::METHOD_PATCH, $function, $options);
157			}
158
159			/**
160			* @param mixed[] $options
161			*/
162			protected function deleteRequest(string $function = '', array $options = []): ResponseInterface
163			{
164			return $this->request(self::METHOD_DELETE, $function, $options);
165			}
166
167			/**
168			* @return mixed[]
169			*/
170			protected function parseResponse(ResponseInterface $response): array
171			{
172			try {
173			$result = DigiSignClient::parseResponse($response);
174			} catch (RuntimeException $e) {
175			throw new ResponseException($response, $e->getMessage(), null, $e);
176			}
177
178			if ($result === null) {
179			throw new EmptyResultException();
180			}
181
182			return $result;
183			}
184
185			/**
186			* @return T
187			*/
188			protected function makeResource(ResponseInterface $response): ResourceInterface
189			{
190			return $this->createResource($response, $this->getResourceClass());
			0 ignored issues – show Bug Best Practice introduced 2021-06-09 15:37 UTC by Report Bug Copy Issue Report The expression `return $this->createReso...is->getResourceClass())` returns the type `DigitalCz\DigiSign\Resource\ResourceInterface` which is incompatible with the documented return type `DigitalCz\DigiSign\Endpoint\T`. Loading history...
191			}
192
193			/**
194			* @param class-string<U> $resourceClass
			0 ignored issues – show Documentation Bug introduced 2021-06-09 15:37 UTC by Report Bug Copy Issue Report The doc comment `class-string<U>` at position `0` could not be parsed: Unknown type name 'class-string' at position 0 in class-string<U>. Loading history...
195			* @return U
196			* @template U of ResourceInterface
197			*/
198			protected function createResource(
199			ResponseInterface $response,
200			string $resourceClass = BaseResource::class
201			): ResourceInterface {
202			$resource = new $resourceClass($this->parseResponse($response));
203			$resource->setResponse($response);
204
205			return $resource;
206			}
207
208			/**
209			* @return ListResource<T>
210			*/
211			protected function makeListResource(ResponseInterface $response): ListResource
212			{
213			return $this->createListResource($response, $this->getResourceClass());
214			}
215
216			/**
217			* @param class-string<U> $resourceClass
			0 ignored issues – show Documentation Bug introduced 2021-06-09 15:37 UTC by Report Bug Copy Issue Report The doc comment `class-string<U>` at position `0` could not be parsed: Unknown type name 'class-string' at position 0 in class-string<U>. Loading history...
218			* @return ListResource<U>
219			* @template U of ResourceInterface
220			*/
221			protected function createListResource(
222			ResponseInterface $response,
223			string $resourceClass = BaseResource::class
224			): ListResource {
225			$resource = new ListResource($this->parseResponse($response), $resourceClass);
226			$resource->setResponse($response);
227
228			return $resource;
229			}
230
231			/**
232			* @param class-string<U> $resourceClass
			0 ignored issues – show Documentation Bug introduced 2021-08-16 13:06 UTC by Report Bug Copy Issue Report The doc comment `class-string<U>` at position `0` could not be parsed: Unknown type name 'class-string' at position 0 in class-string<U>. Loading history...
233			* @return Collection<U>
234			* @template U of ResourceInterface
235			*/
236			protected function createCollectionResource(
237			ResponseInterface $response,
238			string $resourceClass = BaseResource::class
239			): Collection {
240			$collection = new Collection($this->parseResponse($response), $resourceClass);
241			$collection->setResponse($response);
242
243			return $collection;
244			}
245
246			/**
247			* @param mixed[] $options
248			* @return mixed[]
249			*/
250			protected function prepareOptions(array $options): array
251			{
252			return array_merge($this->getResourceOptions(), $options);
253			}
254
255			protected function preparePath(string $path): string
256			{
257			return $this->getResourcePath() . $path;
258			}
259			}
260

digitalcz / digisign

Pull Request — 1.x (#58)

ResourceEndpoint::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like