Skip to content

Commit e116d78

Browse files
KondukterCROKondukterCRO
authored
Merge pull request #19 from undabot/v2.3.3
v2.3.3
2 parents 435a6de + 1722dbd commit e116d78

File tree

6 files changed

+43
-62
lines changed

6 files changed

+43
-62
lines changed

‎README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ json_api_symfony:
9595
Domain object that is modeled and used in the application. Has nothing to do with the outer world.
9696
9797
## (API) Model
98-
Domain representation for specific API. Data-transfer object, POPO that contains only values of attributes and identifiers of related resources.
98+
Domain representation for specific API. Data-transfer object, POPO that contains only values of attributes and identifiers of related resources.
9999
100100
## (JSON:API) Resource
101101
Object representation of JSON:API resource defined by the JSON:API specification.
@@ -111,12 +111,12 @@ entity -> model [label="Api model construction"];
111111
model -> resource [label="JSON:API serialize"];
112112
resource -> model [label="JSON:API denormalize"];
113113
model -> entity [label="Commands"];
114-
}
114+
}
115115
'>
116116
117117
# Development
118118
119-
There is a custom docker image that can be used for development.
119+
There is a custom docker image that can be used for development.
120120
This docker container should be used to run tests and check for any compatibility issues.
121121
122122
This repo is mounted inside of the container and any changes made to the files are automatically propagated into the container.
@@ -137,11 +137,11 @@ A script called dev.sh can be used to manage the image. Here are the avaliable c
137137
138138
attaches the container shell to the terminal so that you can execute commands inside of the container
139139
- ./dev.sh test
140-
140+
141141
run php unit tests inside of the running container
142142
- ./dev.sh qc
143143
144144
executes qc tests
145145
146146
- ./dev.sh install
147-
executes composer install --optimize-autoloader
147+
executes composer install --optimize-autoloader

‎src/Exception/EventSubscriber/ExceptionListener.php

+2-6
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,8 @@
2020

2121
class ExceptionListener
2222
{
23-
/** @var DocumentToPhpArrayEncoderInterface */
24-
private $documentToPhpArrayEncoderInterface;
25-
26-
public function __construct(DocumentToPhpArrayEncoderInterface $documentToPhpArrayEncoderInterface)
23+
public function __construct(private DocumentToPhpArrayEncoderInterface $documentToPhpArrayEncoderInterface)
2724
{
28-
$this->documentToPhpArrayEncoderInterface = $documentToPhpArrayEncoderInterface;
2925
}
3026

3127
public function onKernelException(ExceptionEvent $event): void
@@ -52,7 +48,7 @@ public function onKernelException(ExceptionEvent $event): void
5248
]);
5349
$document = new Document(null, $errorCollection);
5450
$data = $this->documentToPhpArrayEncoderInterface->encode($document);
55-
$response = JsonApiHttpResponse::forbidden($data);
51+
$response = JsonApiHttpResponse::conflict($data);
5652
$event->setResponse($response);
5753

5854
return;

‎src/Http/Model/Response/JsonApiHttpResponse.php

+26-46
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,7 @@ class JsonApiHttpResponse extends Response
1818
*/
1919
public static function validationError(array $data): self
2020
{
21-
$content = json_encode($data, JSON_THROW_ON_ERROR);
22-
23-
return new self(
24-
$content ?: null,
25-
Response::HTTP_UNPROCESSABLE_ENTITY,
26-
[
27-
'Content-Type' => self::CONTENT_TYPE,
28-
]
29-
);
21+
return self::makeError($data, Response::HTTP_UNPROCESSABLE_ENTITY);
3022
}
3123

3224
public static function notFound(): self
@@ -47,15 +39,7 @@ public static function notFound(): self
4739
*/
4840
public static function badRequest(array $data): self
4941
{
50-
$content = json_encode($data, JSON_THROW_ON_ERROR);
51-
52-
return new self(
53-
$content ?: null,
54-
Response::HTTP_BAD_REQUEST,
55-
[
56-
'Content-Type' => self::CONTENT_TYPE,
57-
]
58-
);
42+
return self::makeError($data, Response::HTTP_BAD_REQUEST);
5943
}
6044

6145
/**
@@ -65,15 +49,7 @@ public static function badRequest(array $data): self
6549
*/
6650
public static function forbidden(array $data): self
6751
{
68-
$content = json_encode($data, JSON_THROW_ON_ERROR);
69-
70-
return new self(
71-
$content ?: null,
72-
Response::HTTP_FORBIDDEN,
73-
[
74-
'Content-Type' => self::CONTENT_TYPE,
75-
]
76-
);
52+
return self::makeError($data, Response::HTTP_FORBIDDEN);
7753
}
7854

7955
/**
@@ -83,15 +59,7 @@ public static function forbidden(array $data): self
8359
*/
8460
public static function unauthorized(array $data): self
8561
{
86-
$content = json_encode($data, JSON_THROW_ON_ERROR);
87-
88-
return new self(
89-
$content ?: null,
90-
Response::HTTP_UNAUTHORIZED,
91-
[
92-
'Content-Type' => self::CONTENT_TYPE,
93-
]
94-
);
62+
return self::makeError($data, Response::HTTP_UNAUTHORIZED);
9563
}
9664

9765
/**
@@ -101,15 +69,7 @@ public static function unauthorized(array $data): self
10169
*/
10270
public static function serverError(array $data): self
10371
{
104-
$content = json_encode($data, JSON_THROW_ON_ERROR);
105-
106-
return new self(
107-
$content ?: null,
108-
Response::HTTP_INTERNAL_SERVER_ERROR,
109-
[
110-
'Content-Type' => self::CONTENT_TYPE,
111-
]
112-
);
72+
return self::makeError($data, Response::HTTP_INTERNAL_SERVER_ERROR);
11373
}
11474

11575
/**
@@ -118,12 +78,32 @@ public static function serverError(array $data): self
11878
* @throws \JsonException
11979
*/
12080
public static function fromSymfonyHttpException(array $data, HttpExceptionInterface $exception): self
81+
{
82+
return self::makeError($data, $exception->getStatusCode());
83+
}
84+
85+
/**
86+
* @param array<string, mixed> $data
87+
*
88+
* @throws \JsonException
89+
*/
90+
public static function conflict(array $data): self
91+
{
92+
return self::makeError($data, Response::HTTP_CONFLICT);
93+
}
94+
95+
/**
96+
* @param array<string, mixed> $data
97+
*
98+
* @throws \JsonException
99+
*/
100+
private static function makeError(array $data, int $statusCode): self
121101
{
122102
$content = json_encode($data, JSON_THROW_ON_ERROR);
123103

124104
return new self(
125105
$content ?: null,
126-
$exception->getStatusCode(),
106+
$statusCode,
127107
[
128108
'Content-Type' => self::CONTENT_TYPE,
129109
]

‎src/Model/Collection/ArrayCollection.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ public function count(): int
3939
return $this->count;
4040
}
4141

42-
public function getIterator()
42+
public function getIterator(): \Traversable
4343
{
4444
return new ArrayIterator($this->getItems());
4545
}

‎src/Model/Collection/UniqueResourceCollection.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ public function getResources(): array
5656
return $this->items;
5757
}
5858

59-
public function getIterator()
59+
public function getIterator(): \Traversable
6060
{
6161
return new ArrayIterator($this->items);
6262
}

‎tests/Unit/Exception/EventSubscriber/ExceptionListenerTest.php

+8-3
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
use Symfony\Component\HttpKernel\KernelInterface;
1717
use Symfony\Component\Validator\ConstraintViolationList;
1818
use Undabot\JsonApi\Definition\Encoding\DocumentToPhpArrayEncoderInterface;
19+
use Undabot\JsonApi\Definition\Exception\Request\ClientGeneratedIdIsNotAllowedException;
1920
use Undabot\JsonApi\Definition\Exception\Request\RequestException;
2021
use Undabot\JsonApi\Implementation\Model\Resource\Resource;
2122
use Undabot\SymfonyJsonApi\Exception\EventSubscriber\ExceptionListener;
@@ -48,7 +49,7 @@ public function testOnKernelExceptionWillSetCorrectEventResponseGivenGivenExcept
4849
$event = new ExceptionEvent(
4950
new HttpKernel(new EventDispatcher(), new ControllerResolver()),
5051
Request::create('http://localhost:8000/web/v1/posts'),
51-
HttpKernelInterface::MASTER_REQUEST,
52+
HttpKernelInterface::MAIN_REQUEST,
5253
$exception,
5354
);
5455
$data = [];
@@ -80,14 +81,18 @@ public function exceptionProvider(): \Generator
8081
yield 'Exception is Exception instance' => [
8182
new \Exception(),
8283
];
84+
85+
yield 'Exception is ClientGeneratedIdIsNotAllowedException instance' => [
86+
new ClientGeneratedIdIsNotAllowedException(),
87+
];
8388
}
8489

8590
public function testOnKernelExceptionWillSetCorrectEventResponseGivenGivenExceptionIsSupportedAndEventHaveThrowableMethod(): void
8691
{
8792
$event = new ExceptionEvent(
8893
$this->createMock(KernelInterface::class),
8994
$this->createMock(Request::class),
90-
KernelInterface::MASTER_REQUEST,
95+
KernelInterface::MAIN_REQUEST,
9196
new \LogicException()
9297
);
9398
$data = [];
@@ -114,7 +119,7 @@ public function testOnKernelExceptionWillSetCorrectEventResponseGivenGivenSymfon
114119
$event = new ExceptionEvent(
115120
$this->createMock(KernelInterface::class),
116121
$this->createMock(Request::class),
117-
KernelInterface::MASTER_REQUEST,
122+
KernelInterface::MAIN_REQUEST,
118123
$e = new AccessDeniedHttpException()
119124
);
120125
$data = [];

0 commit comments

Comments
 (0)