Merge pull request #24 from Art4/20-add-get-one-notice

Implement `getNoticeByToken()`
Art4 · Mar 7, 2024 · 6495db1 · 6495db1
2 parents 4a76e48 + 8de0a11
commit 6495db1
Show file tree

Hide file tree

Showing 5 changed files with 359 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - New method `Art4\Wegliphant\Client::authenticate()` to set your API key for authorized API requests.
 - New method `Art4\Wegliphant\Client::listOwnNotices()` to list all notices for the authorized user.
+- New method `Art4\Wegliphant\Client::getNoticeByToken()` to get one notice for the authorized user.
 - New class `Art4\Wegliphant\Exception\UnexpectedResponseException` that will be thrown if an error happens while processing the response.
 
 ### Changed

diff --git a/README.md b/README.md
@@ -109,6 +109,65 @@ $notices = $client->listOwnNotices();
 ],
 ```
 
+### Get one notice by token
+
+```php
+$notice = $client->getNoticeByToken('8843d7f92416211de9ebb963ff4ce281');
+
+// $notice contains:
+[
+    'token' => '8843d7f92416211de9ebb963ff4ce281',
+    'status' => 'shared',
+    'street' => 'Musterstraße 123',
+    'city' => 'Berlin',
+    'zip' => '12305',
+    'latitude' => 52.5170365,
+    'longitude' => 13.3888599,
+    'registration' => 'EX AM 713',
+    'color' => 'white',
+    'brand' => 'Car brand',
+    'charge' => [
+        'tbnr' => '141312',
+        'description' => 'Sie parkten im absoluten Haltverbot (Zeichen 283).',
+        'fine' => '25.0',
+        'bkat' => '§ 41 Abs. 1 iVm Anlage 2, § 49 StVO; § 24 Abs. 1, 3 Nr. 5 StVG; 52 BKat',
+        'penalty' => null,
+        'fap' => null,
+        'points' => 0,
+        'valid_from' => '2021-11-09T00:00:00.000+01:00',
+        'valid_to' => null,
+        'implementation' => null,
+        'classification' => 5,
+        'variant_table_id' => 741017,
+        'rule_id' => 39,
+        'table_id' => null,
+        'required_refinements' => '00000000000000000000000000000000',
+        'number_required_refinements' => 0,
+        'max_fine' => '0.0',
+        'created_at' => '2023-09-18T15:30:43.312+02:00',
+        'updated_at' => '2023-09-18T15:30:43.312+02:00',
+    ],
+    'tbnr' => '141312',
+    'start_date' => '2023-11-12T11:31:00.000+01:00',
+    'end_date' => '2023-11-12T11:36:00.000+01:00',
+    'note' => 'Some user notes',
+    'photos' => [
+        [
+            'filename' => 'IMG_20231124_113156.jpg',
+            'url' => 'https://example.com/storage/IMG_20231124_113156.jpg',
+        ],
+    ],
+    'created_at' => '2023-11-12T11:33:29.423+01:00',
+    'updated_at' => '2023-11-12T11:49:24.383+01:00',
+    'sent_at' => '2023-11-12T11:49:24.378+01:00',
+    'vehicle_empty' => true,
+    'hazard_lights' => false,
+    'expired_tuv' => false,
+    'expired_eco' => false,
+    'over_2_8_tons' => false,
+],
+```
+
 ### List all districts
 
 ```php

diff --git a/src/Client.php b/src/Client.php
@@ -101,6 +101,23 @@ public function listOwnNotices(): array
         return $this->parseJsonResponseToArray($response, 200);
     }
 
+    /**
+     * Get a notice by token for the authorized user using the endpoint `GET /api/notices/{token}`
+     *
+     * @link https://www.weg.li/api-docs/index.html#operations-notice-get_notices__token_
+     *
+     * @throws \Psr\Http\Client\ClientExceptionInterface If an error happens while processing the request.
+     * @throws UnexpectedResponseException If an error happens while processing the response.
+     *
+     * @return mixed[]
+     */
+    public function getNoticeByToken(string $token): array
+    {
+        $response = $this->sendJsonRequest('GET', '/api/notices/' . $token);
+
+        return $this->parseJsonResponseToArray($response, 200);
+    }
+
     /**
      * @throws \Psr\Http\Client\ClientExceptionInterface If an error happens while processing the request.
      */

diff --git a/tests/Unit/Client/GetNoticeTest.php b/tests/Unit/Client/GetNoticeTest.php
@@ -0,0 +1,276 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Art4\Wegliphant\Client;
+
+use Art4\Wegliphant\Client;
+use Art4\Wegliphant\Exception\UnexpectedResponseException;
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\TestCase;
+use Psr\Http\Client\ClientExceptionInterface;
+use Psr\Http\Client\ClientInterface;
+use Psr\Http\Message\RequestFactoryInterface;
+use Psr\Http\Message\RequestInterface;
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\StreamInterface;
+
+#[CoversClass(Client::class)]
+final class GetNoticeTest extends TestCase
+{
+    public function testGetNoticeReturnsArray(): void
+    {
+        $expected = [
+            'token' => '8843d7f92416211de9ebb963ff4ce281',
+            'status' => 'shared',
+            'street' => 'Musterstraße 123',
+            'city' => 'Berlin',
+            'zip' => '12305',
+            'latitude' => 52.5170365,
+            'longitude' => 13.3888599,
+            'registration' => 'EX AM 713',
+            'color' => 'white',
+            'brand' => 'Car brand',
+            'charge' => [
+                'tbnr' => '141312',
+                'description' => 'Sie parkten im absoluten Haltverbot (Zeichen 283).',
+                'fine' => '25.0',
+                'bkat' => '§ 41 Abs. 1 iVm Anlage 2, § 49 StVO; § 24 Abs. 1, 3 Nr. 5 StVG; 52 BKat',
+                'penalty' => null,
+                'fap' => null,
+                'points' => 0,
+                'valid_from' => '2021-11-09T00:00:00.000+01:00',
+                'valid_to' => null,
+                'implementation' => null,
+                'classification' => 5,
+                'variant_table_id' => 741017,
+                'rule_id' => 39,
+                'table_id' => null,
+                'required_refinements' => '00000000000000000000000000000000',
+                'number_required_refinements' => 0,
+                'max_fine' => '0.0',
+                'created_at' => '2023-09-18T15:30:43.312+02:00',
+                'updated_at' => '2023-09-18T15:30:43.312+02:00',
+            ],
+            'tbnr' => '141312',
+            'start_date' => '2023-11-12T11:31:00.000+01:00',
+            'end_date' => '2023-11-12T11:36:00.000+01:00',
+            'note' => 'Some user notes',
+            'photos' => [
+                [
+                    'filename' => 'IMG_20231112_113156.jpg',
+                    'url' => 'https://example.com/storage/IMG_20231112_113156.jpg',
+                ],
+            ],
+            'created_at' => '2023-11-12T11:33:29.423+01:00',
+            'updated_at' => '2023-11-12T11:49:24.383+01:00',
+            'sent_at' => '2023-11-12T11:49:24.378+01:00',
+            'vehicle_empty' => true,
+            'hazard_lights' => false,
+            'expired_tuv' => false,
+            'expired_eco' => false,
+            'over_2_8_tons' => false,
+        ];
+        $apiKey = 'c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2';
+
+        $request = $this->createMock(RequestInterface::class);
+        $request->expects($this->exactly(2))->method('withHeader')->willReturnMap([
+            ['Accept', 'application/json', $request],
+            ['X-API-KEY', $apiKey, $request],
+        ]);
+
+        $requestFactory = $this->createMock(RequestFactoryInterface::class);
+        $requestFactory->expects($this->exactly(1))->method('createRequest')->with('GET', 'https://www.weg.li/api/notices/8843d7f92416211de9ebb963ff4ce281')->willReturn($request);
+
+        $stream = $this->createConfiguredMock(
+            StreamInterface::class,
+            [
+                '__toString' => json_encode($expected),
+            ],
+        );
+
+        $response = $this->createConfiguredMock(
+            ResponseInterface::class,
+            [
+                'getStatusCode' => 200,
+                'getHeaderLine' => 'application/json',
+                'getBody' => $stream,
+            ]
+        );
+
+        $httpClient = $this->createMock(ClientInterface::class);
+        $httpClient->expects($this->exactly(1))->method('sendRequest')->willReturn($response);
+
+        $client = Client::create(
+            $httpClient,
+            $requestFactory,
+        );
+        $client->authenticate($apiKey);
+
+        $response = $client->getNoticeByToken('8843d7f92416211de9ebb963ff4ce281');
+
+        $this->assertSame(
+            $expected,
+            $response,
+        );
+    }
+
+    public function testGetNoticeThrowsClientException(): void
+    {
+        $request = $this->createMock(RequestInterface::class);
+        $request->expects($this->exactly(1))->method('withHeader')->willReturn($request);
+
+        $requestFactory = $this->createMock(RequestFactoryInterface::class);
+        $requestFactory->expects($this->exactly(1))->method('createRequest')->with('GET', 'https://www.weg.li/api/notices/8843d7f92416211de9ebb963ff4ce281')->willReturn($request);
+
+        $httpClient = $this->createMock(ClientInterface::class);
+        $httpClient->expects($this->exactly(1))->method('sendRequest')->willThrowException(
+            $this->createMock(ClientExceptionInterface::class),
+        );
+
+        $client = Client::create(
+            $httpClient,
+            $requestFactory,
+        );
+
+        $this->expectException(ClientExceptionInterface::class);
+        $this->expectExceptionMessage('');
+
+        $client->getNoticeByToken('8843d7f92416211de9ebb963ff4ce281');
+    }
+
+    public function testGetNoticeThrowsUnexpectedResponseExceptionOnWrongStatusCode(): void
+    {
+        $request = $this->createMock(RequestInterface::class);
+        $request->expects($this->exactly(1))->method('withHeader')->willReturn($request);
+
+        $requestFactory = $this->createMock(RequestFactoryInterface::class);
+        $requestFactory->expects($this->exactly(1))->method('createRequest')->with('GET', 'https://www.weg.li/api/notices/8843d7f92416211de9ebb963ff4ce281')->willReturn($request);
+
+        $response = $this->createConfiguredMock(
+            ResponseInterface::class,
+            [
+                'getStatusCode' => 500,
+            ]
+        );
+
+        $httpClient = $this->createMock(ClientInterface::class);
+        $httpClient->expects($this->exactly(1))->method('sendRequest')->willReturn($response);
+
+        $client = Client::create(
+            $httpClient,
+            $requestFactory,
+        );
+
+        $this->expectException(UnexpectedResponseException::class);
+        $this->expectExceptionMessage('Server replied with the status code 500, but 200 was expected.');
+
+        $client->getNoticeByToken('8843d7f92416211de9ebb963ff4ce281');
+    }
+
+    public function testGetNoticeThrowsUnexpectedResponseExceptionOnWrongContentTypeHeader(): void
+    {
+        $request = $this->createMock(RequestInterface::class);
+        $request->expects($this->exactly(1))->method('withHeader')->willReturn($request);
+
+        $requestFactory = $this->createMock(RequestFactoryInterface::class);
+        $requestFactory->expects($this->exactly(1))->method('createRequest')->with('GET', 'https://www.weg.li/api/notices/8843d7f92416211de9ebb963ff4ce281')->willReturn($request);
+
+        $response = $this->createConfiguredMock(
+            ResponseInterface::class,
+            [
+                'getStatusCode' => 200,
+                'getHeaderLine' => 'text/html',
+            ]
+        );
+
+        $httpClient = $this->createMock(ClientInterface::class);
+        $httpClient->expects($this->exactly(1))->method('sendRequest')->willReturn($response);
+
+        $client = Client::create(
+            $httpClient,
+            $requestFactory,
+        );
+
+        $this->expectException(UnexpectedResponseException::class);
+        $this->expectExceptionMessage('Server replied not with JSON content.');
+
+        $client->getNoticeByToken('8843d7f92416211de9ebb963ff4ce281');
+    }
+
+    public function testGetNoticeThrowsUnexpectedResponseExceptionOnInvalidJsonBody(): void
+    {
+        $request = $this->createMock(RequestInterface::class);
+        $request->expects($this->exactly(1))->method('withHeader')->willReturn($request);
+
+        $requestFactory = $this->createMock(RequestFactoryInterface::class);
+        $requestFactory->expects($this->exactly(1))->method('createRequest')->with('GET', 'https://www.weg.li/api/notices/8843d7f92416211de9ebb963ff4ce281')->willReturn($request);
+
+        $stream = $this->createConfiguredMock(
+            StreamInterface::class,
+            [
+                '__toString' => 'invalid json',
+            ],
+        );
+
+        $response = $this->createConfiguredMock(
+            ResponseInterface::class,
+            [
+                'getStatusCode' => 200,
+                'getHeaderLine' => 'application/json',
+                'getBody' => $stream,
+            ]
+        );
+
+        $httpClient = $this->createMock(ClientInterface::class);
+        $httpClient->expects($this->exactly(1))->method('sendRequest')->willReturn($response);
+
+        $client = Client::create(
+            $httpClient,
+            $requestFactory,
+        );
+
+        $this->expectException(UnexpectedResponseException::class);
+        $this->expectExceptionMessage('Response body contains no valid JSON: invalid json');
+
+        $client->getNoticeByToken('8843d7f92416211de9ebb963ff4ce281');
+    }
+
+    public function testGetNoticeThrowsUnexpectedResponseExceptionOnJsonBodyWithoutArray(): void
+    {
+        $request = $this->createMock(RequestInterface::class);
+        $request->expects($this->exactly(1))->method('withHeader')->willReturn($request);
+
+        $requestFactory = $this->createMock(RequestFactoryInterface::class);
+        $requestFactory->expects($this->exactly(1))->method('createRequest')->with('GET', 'https://www.weg.li/api/notices/8843d7f92416211de9ebb963ff4ce281')->willReturn($request);
+
+        $stream = $this->createConfiguredMock(
+            StreamInterface::class,
+            [
+                '__toString' => '"this is not an array"',
+            ],
+        );
+
+        $response = $this->createConfiguredMock(
+            ResponseInterface::class,
+            [
+                'getStatusCode' => 200,
+                'getHeaderLine' => 'application/json',
+                'getBody' => $stream,
+            ]
+        );
+
+        $httpClient = $this->createMock(ClientInterface::class);
+        $httpClient->expects($this->exactly(1))->method('sendRequest')->willReturn($response);
+
+        $client = Client::create(
+            $httpClient,
+            $requestFactory,
+        );
+
+        $this->expectException(UnexpectedResponseException::class);
+        $this->expectExceptionMessage('Response JSON does not contain an array: "this is not an array"');
+
+        $client->getNoticeByToken('8843d7f92416211de9ebb963ff4ce281');
+    }
+}
diff --git a/tests/Unit/Client/ListOwnNoticesTest.php b/tests/Unit/Client/ListOwnNoticesTest.php
@@ -73,9 +73,13 @@ public function testListOwnNoticesReturnsArray(): void
                 'over_2_8_tons' => false,
             ],
         ];
+        $apiKey = 'c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2';
 
         $request = $this->createMock(RequestInterface::class);
-        $request->expects($this->exactly(1))->method('withHeader')->willReturn($request);
+        $request->expects($this->exactly(2))->method('withHeader')->willReturnMap([
+            ['Accept', 'application/json', $request],
+            ['X-API-KEY', $apiKey, $request],
+        ]);
 
         $requestFactory = $this->createMock(RequestFactoryInterface::class);
         $requestFactory->expects($this->exactly(1))->method('createRequest')->with('GET', 'https://www.weg.li/api/notices')->willReturn($request);
@@ -103,6 +107,7 @@ public function testListOwnNoticesReturnsArray(): void
             $httpClient,
             $requestFactory,
         );
+        $client->authenticate($apiKey);
 
         $response = $client->listOwnNotices();