feat: Handle MethodNotAllowedException

Author: LevFlavien

spec/Client/HttpExceptionHandlerSpec.php

@@ -5,6 +5,7 @@
 use Akeneo\Pim\ApiClient\Exception\BadRequestHttpException;
 use Akeneo\Pim\ApiClient\Exception\ClientErrorHttpException;
 use Akeneo\Pim\ApiClient\Exception\ForbiddenHttpException;
+use Akeneo\Pim\ApiClient\Exception\MethodNotAllowedHttpException;
 use Akeneo\Pim\ApiClient\Exception\NotFoundHttpException;
 use Akeneo\Pim\ApiClient\Exception\RedirectionHttpException;
 use Akeneo\Pim\ApiClient\Exception\ServerErrorHttpException;
@@ -123,6 +124,31 @@ function it_throws_not_found_exception_when_status_code_404(
             ->during('transformResponseToException', [$request, $response]);
     }
 
+    function it_throws_method_not_allowed_exception_when_status_code_405(
+        RequestInterface $request,
+        ResponseInterface $response,
+        StreamInterface $responseBody
+    ) {
+        $response->getStatusCode()->willReturn(405);
+        $response->getBody()->willReturn($responseBody);
+        $responseBody->getContents()->willReturn(<<<JSON
+            {
+                "code": 405,
+                "message": "No route found for 'POST /api/rest/v1/products/myproduct': Method Not Allowed (Allow: GET, PATCH, DELETE)"
+            }
+        JSON);
+        $responseBody->rewind()->shouldBeCalled();
+        $this
+            ->shouldThrow(
+                new MethodNotAllowedHttpException(
+                    'No route found for \'POST /api/rest/v1/products/myproduct\': Method Not Allowed (Allow: GET, PATCH, DELETE)',
+                    $request->getWrappedObject(),
+                    $response->getWrappedObject()
+                )
+            )
+            ->during('transformResponseToException', [$request, $response]);
+    }
+
     function it_throws_bad_request_exception_when_status_code_422(
         RequestInterface $request,
         ResponseInterface $response,
@@ -148,9 +174,9 @@ function it_throws_bad_request_exception_when_status_code_4xx(
         ResponseInterface $response,
         StreamInterface $responseBody
     ) {
-        $response->getStatusCode()->willReturn(405);
+        $response->getStatusCode()->willReturn(418);
         $response->getBody()->willReturn($responseBody);
-        $responseBody->getContents()->willReturn('{"code": 405, "message": "Not allowed."}');
+        $responseBody->getContents()->willReturn('{"code": 418, "message": "Not allowed."}');
         $responseBody->rewind()->shouldBeCalled();
         $this
             ->shouldThrow(

src/Client/HttpExceptionHandler.php

@@ -5,6 +5,7 @@
 use Akeneo\Pim\ApiClient\Exception\BadRequestHttpException;
 use Akeneo\Pim\ApiClient\Exception\ClientErrorHttpException;
 use Akeneo\Pim\ApiClient\Exception\ForbiddenHttpException;
+use Akeneo\Pim\ApiClient\Exception\MethodNotAllowedHttpException;
 use Akeneo\Pim\ApiClient\Exception\NotFoundHttpException;
 use Akeneo\Pim\ApiClient\Exception\RedirectionHttpException;
 use Akeneo\Pim\ApiClient\Exception\ServerErrorHttpException;
@@ -61,6 +62,10 @@ public function transformResponseToException(
             throw new NotFoundHttpException($this->getResponseMessage($response), $request, $response);
         }
 
+        if (HttpClient::HTTP_METHOD_NOT_ALLOWED === $response->getStatusCode()) {
+            throw new MethodNotAllowedHttpException($this->getResponseMessage($response), $request, $response);
+        }
+
         if (HttpClient::HTTP_UNPROCESSABLE_ENTITY === $response->getStatusCode()) {
             throw new UnprocessableEntityHttpException($this->getResponseMessage($response), $request, $response);
         }

src/Exception/MethodNotAllowedHttpException.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Akeneo\Pim\ApiClient\Exception;
+
+/**
+ * @copyright 2022 Akeneo SAS (https://www.akeneo.com)
+ * @license   https://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
+ */
+class MethodNotAllowedHttpException extends ClientErrorHttpException
+{
+    protected function getAdditionalInformationMessage(): string
+    {
+        return '(see https://api.akeneo.com/php-client/exception.html#method-not-allowed-exception)';
+    }
+}