distinct exception type thrown when best available objects not found (#…

…142) * refactoring * throw new exception type when no best available objects have been found, instead of the generic SeatsioException * refactoring - moved BestAvailableObjectsNotFoundException to root Seatsio namespace * refactoring - removed unused $response constructor parameter * refactoring - rename
seatsio · Jan 3, 2025 · 7e41272 · 7e41272
1 parent 95ca915
commit 7e41272
Show file tree

Hide file tree

Showing 6 changed files with 82 additions and 16 deletions.
diff --git a/src/BestAvailableObjectsNotFoundException.php b/src/BestAvailableObjectsNotFoundException.php
@@ -0,0 +1,14 @@
+<?php
+
+namespace Seatsio;
+
+
+use Psr\Http\Message\RequestInterface;
+
+class BestAvailableObjectsNotFoundException extends SeatsioException
+{
+    public function __construct(RequestInterface $request, array $parsedResponse, string $message)
+    {
+        parent::__construct($request, $parsedResponse, $message);
+    }
+}
diff --git a/src/RateLimitExceededException.php b/src/RateLimitExceededException.php
@@ -3,12 +3,11 @@
 namespace Seatsio;
 
 use Psr\Http\Message\RequestInterface;
-use Psr\Http\Message\ResponseInterface;
 
 class RateLimitExceededException extends SeatsioException
 {
-    public function __construct(RequestInterface $request, ResponseInterface $response)
+    public function __construct(RequestInterface $request, array $parsedResponse, string $message)
     {
-        parent::__construct($request, $response);
+        parent::__construct($request, $parsedResponse, $message);
     }
 }
diff --git a/src/SeatsioClient.php b/src/SeatsioClient.php
@@ -118,10 +118,7 @@ function (ResponseInterface $response) use ($request, $handler) {
                         if ($code < 400) {
                             return $response;
                         }
-                        if ($code == 429) {
-                            throw new RateLimitExceededException($request, $response);
-                        }
-                        throw new SeatsioException($request, $response);
+                        throw SeatsioException::from($request, $response);
                     }
                 );
             };

diff --git a/src/SeatsioException.php b/src/SeatsioException.php
@@ -19,13 +19,24 @@ class SeatsioException extends RuntimeException
      */
     public $requestId;
 
-    public function __construct(RequestInterface $request, ResponseInterface $response)
+    public static function from(RequestInterface $request, ResponseInterface $response): SeatsioException
     {
-        $info = self::extractInfo($response);
-        $requestId = $info['requestId'];
-        parent::__construct(self::message($request, $response, $info['messages']));
-        $this->errors = $info['errors'];
-        $this->requestId = $requestId;
+        $code = $response->getStatusCode();
+        $parsedResponse = self::extractInfo($response);
+        $message = self::message($request, $response, $parsedResponse['messages']);
+        if ($code == 429) {
+            return new RateLimitExceededException($request, $parsedResponse, $message);
+        } else if (self::isBestAvailableObjectsNotFound($parsedResponse['errors'])) {
+            throw new BestAvailableObjectsNotFoundException($request, $parsedResponse, $message);
+        }
+        return new SeatsioException($request, $parsedResponse, $message);
+    }
+
+    public function __construct(RequestInterface $request, array $parsedResponse, string $message)
+    {
+        parent::__construct($message);
+        $this->errors = $parsedResponse['errors'];
+        $this->requestId = $parsedResponse['requestId'];
     }
 
     private static function message($request, $response, $messages)
@@ -45,15 +56,30 @@ private static function message($request, $response, $messages)
         }
     }
 
-    private static function extractInfo($response)
+    private static function extractInfo($response): array
     {
         $contentType = $response->getHeaderLine("content-type");
-        if (strpos($contentType, 'application/json') !== false) {
+        if (str_contains($contentType, 'application/json')) {
             $json = GuzzleResponseDecoder::decodeToObject($response);
             $mapper = SeatsioJsonMapper::create();
             $errors = $mapper->mapArray($json->errors, array(), 'Seatsio\ApiError');
             return ["messages" => $json->messages, "errors" => $errors, "requestId" => $json->requestId ?? null];
         }
         return ["messages" => [], "errors" => [], "requestId" => null];
     }
+
+    private static function isBestAvailableObjectsNotFound($errors): bool
+    {
+        if (!is_array($errors) || empty($errors)) {
+            return false;
+        }
+        foreach ($errors as $error) {
+            if (is_object($error) && property_exists($error, 'code')) {
+                if ($error->code === 'BEST_AVAILABLE_OBJECTS_NOT_FOUND') {
+                    return true;
+                }
+            }
+        }
+        return false;
+    }
 }
diff --git a/tests/Events/ChangeBestAvailableObjectStatusTest.php b/tests/Events/ChangeBestAvailableObjectStatusTest.php
@@ -2,8 +2,10 @@
 
 namespace Seatsio\Events;
 
+use Seatsio\BestAvailableObjectsNotFoundException;
 use Seatsio\Common\IDs;
 use Seatsio\SeatsioClientTest;
+use Seatsio\SeatsioException;
 
 class ChangeBestAvailableObjectStatusTest extends SeatsioClientTest
 {
@@ -203,4 +205,32 @@ public function accessibleSeats()
         self::assertTrue($bestAvailableObjects->nextToEachOther);
         self::assertEquals(["A-6", "A-7", "A-8"], $bestAvailableObjects->objects);
     }
+
+    public function testNotFoundThrowsBestAvailableObjectsNotFoundException()
+    {
+        $chartKey = $this->createTestChart();
+        $event = $this->seatsioClient->events->create($chartKey);
+
+        try
+        {
+            $this->seatsioClient->events->changeBestAvailableObjectStatus($event->key, (new BestAvailableParams())->setNumber(3000), "lolzor");
+            self::fail("expected exception");
+        }  catch (BestAvailableObjectsNotFoundException $exception) {
+            self::assertInstanceOf(BestAvailableObjectsNotFoundException::class, $exception);
+            self::assertEquals("Best available objects not found", $exception->getMessage());
+        }
+
+    }
+
+    public function testNormalSeatsioExceptionIfEventNotFound()
+    {
+        try
+        {
+            $this->seatsioClient->events->changeBestAvailableObjectStatus("unexistingEvent", (new BestAvailableParams())->setNumber(3), "lolzor");
+            self::fail("expected exception");
+        }  catch (SeatsioException $exception) {
+            self::assertNotInstanceOf(BestAvailableObjectsNotFoundException::class, $exception);
+        }
+
+    }
 }
diff --git a/tests/SeatsioExceptionTest.php b/tests/SeatsioExceptionTest.php
@@ -19,7 +19,7 @@ public function testCanInstantiateSeatsioExceptionWithoutRequestId()
             ["Content-Type" => "application/json"],
             "{\"errors\": [], \"messages\":[]}"
         );
-        $exception = new SeatsioException($request, $response);
+        $exception = SeatsioException::from($request, $response);
         self::assertNull($exception->requestId);
         self::assertStringStartsWith("GET http://dummy.uri resulted in a `400 Bad Request` response.", $exception->getMessage());
     }