Merge pull request #25 from Sammyjo20/feature/exceptions

Sammyjo20 · web-flow · commit b446974286de · 2022-02-02T17:39:35.000Z
Extended exceptions
diff --git a/src/Exceptions/SaloonDuplicateHandlerException.php b/src/Exceptions/SaloonDuplicateHandlerException.php
@@ -2,9 +2,7 @@
 
 namespace Sammyjo20\Saloon\Exceptions;
 
-use \Exception;
-
-class SaloonDuplicateHandlerException extends Exception
+class SaloonDuplicateHandlerException extends SaloonException
 {
     public function __construct(string $name)
     {
diff --git a/src/Exceptions/SaloonException.php b/src/Exceptions/SaloonException.php
@@ -0,0 +1,10 @@
+<?php
+
+namespace Sammyjo20\Saloon\Exceptions;
+
+use \Exception;
+
+class SaloonException extends Exception
+{
+    //
+}
diff --git a/src/Exceptions/SaloonInvalidConnectorException.php b/src/Exceptions/SaloonInvalidConnectorException.php
@@ -2,9 +2,7 @@
 
 namespace Sammyjo20\Saloon\Exceptions;
 
-use \Exception;
-
-class SaloonInvalidConnectorException extends Exception
+class SaloonInvalidConnectorException extends SaloonException
 {
     public function __construct()
     {
diff --git a/src/Exceptions/SaloonInvalidHandlerException.php b/src/Exceptions/SaloonInvalidHandlerException.php
@@ -2,9 +2,7 @@
 
 namespace Sammyjo20\Saloon\Exceptions;
 
-use \Exception;
-
-class SaloonInvalidHandlerException extends Exception
+class SaloonInvalidHandlerException extends SaloonException
 {
     public function __construct(string $name)
     {
diff --git a/src/Exceptions/SaloonInvalidMockResponseCaptureMethodException.php b/src/Exceptions/SaloonInvalidMockResponseCaptureMethodException.php
@@ -2,9 +2,7 @@
 
 namespace Sammyjo20\Saloon\Exceptions;
 
-use \Exception;
-
-class SaloonInvalidMockResponseCaptureMethodException extends Exception
+class SaloonInvalidMockResponseCaptureMethodException extends SaloonException
 {
     public function __construct()
     {
diff --git a/src/Exceptions/SaloonInvalidResponseClassException.php b/src/Exceptions/SaloonInvalidResponseClassException.php
@@ -2,9 +2,7 @@
 
 namespace Sammyjo20\Saloon\Exceptions;
 
-use Exception;
-
-class SaloonInvalidResponseClassException extends Exception
+class SaloonInvalidResponseClassException extends SaloonException
 {
     public function __construct()
     {
diff --git a/src/Exceptions/SaloonMethodNotFoundException.php b/src/Exceptions/SaloonMethodNotFoundException.php
@@ -2,10 +2,9 @@
 
 namespace Sammyjo20\Saloon\Exceptions;
 
-use \Exception;
 use Sammyjo20\Saloon\Http\SaloonConnector;
 
-class SaloonMethodNotFoundException extends Exception
+class SaloonMethodNotFoundException extends SaloonException
 {
     public function __construct(string $method, SaloonConnector $connector)
     {
diff --git a/src/Exceptions/SaloonMissingAttributeException.php b/src/Exceptions/SaloonMissingAttributeException.php
@@ -5,7 +5,7 @@
 use \Exception;
 use Sammyjo20\Saloon\Http\SaloonRequest;
 
-class SaloonMissingAttributeException extends Exception
+class SaloonMissingAttributeException extends SaloonException
 {
     /**
      * Throw an exception if we are missing a required attribute.
diff --git a/src/Exceptions/SaloonMissingMockException.php b/src/Exceptions/SaloonMissingMockException.php
@@ -2,9 +2,7 @@
 
 namespace Sammyjo20\Saloon\Exceptions;
 
-use \Exception;
-
-class SaloonMissingMockException extends Exception
+class SaloonMissingMockException extends SaloonException
 {
     //
 }
diff --git a/src/Exceptions/SaloonMultipleMockMethodsException.php b/src/Exceptions/SaloonMultipleMockMethodsException.php
@@ -2,9 +2,7 @@
 
 namespace Sammyjo20\Saloon\Exceptions;
 
-use \Exception;
-
-class SaloonMultipleMockMethodsException extends Exception
+class SaloonMultipleMockMethodsException extends SaloonException
 {
     public function __construct()
     {
diff --git a/src/Exceptions/SaloonNoMockResponseFoundException.php b/src/Exceptions/SaloonNoMockResponseFoundException.php
@@ -2,9 +2,7 @@
 
 namespace Sammyjo20\Saloon\Exceptions;
 
-use \Exception;
-
-class SaloonNoMockResponseFoundException extends Exception
+class SaloonNoMockResponseFoundException extends SaloonException
 {
     public function __construct()
     {
diff --git a/src/Exceptions/SaloonNoMockResponsesProvidedException.php b/src/Exceptions/SaloonNoMockResponsesProvidedException.php
@@ -2,9 +2,7 @@
 
 namespace Sammyjo20\Saloon\Exceptions;
 
-use \Exception;
-
-class SaloonNoMockResponsesProvidedException extends Exception
+class SaloonNoMockResponsesProvidedException extends SaloonException
 {
     public function __construct()
     {
diff --git a/src/Exceptions/SaloonRequestException.php b/src/Exceptions/SaloonRequestException.php
@@ -3,10 +3,9 @@
 namespace Sammyjo20\Saloon\Exceptions;
 
 use Throwable;
-use \Exception;
 use Sammyjo20\Saloon\Http\SaloonResponse;
 
-class SaloonRequestException extends Exception
+class SaloonRequestException extends SaloonException
 {
     /**
      * The Saloon Response
@@ -15,6 +14,14 @@ class SaloonRequestException extends Exception
      */
     protected SaloonResponse $saloonResponse;
 
+    /**
+     * Create the SaloonRequestException
+     *
+     * @param SaloonResponse $response
+     * @param $message
+     * @param $code
+     * @param Throwable|null $previous
+     */
     public function __construct(SaloonResponse $response, $message = '', $code = 0, Throwable $previous = null)
     {
         $this->saloonResponse = $response;
diff --git a/src/Exceptions/SaloonTraitExistsException.php b/src/Exceptions/SaloonTraitExistsException.php
@@ -2,9 +2,7 @@
 
 namespace Sammyjo20\Saloon\Exceptions;
 
-use \Exception;
-
-class SaloonTraitExistsException extends Exception
+class SaloonTraitExistsException extends SaloonException
 {
     //
 }
diff --git a/src/Http/SaloonResponse.php b/src/Http/SaloonResponse.php
@@ -337,7 +337,7 @@ public function toException()
         if ($this->failed()) {
             $body = $this->response?->getBody()?->getContents();
 
-            return new SaloonRequestException($this, $body, 0, $this->guzzleRequestException);
+            return new SaloonRequestException($this, $body, 0, $this->getGuzzleException());
         }
     }
 
diff --git a/src/Traits/SendsRequests.php b/src/Traits/SendsRequests.php
@@ -15,11 +15,7 @@ trait SendsRequests
      * @return SaloonResponse
      * @throws \GuzzleHttp\Exception\GuzzleException
      * @throws \ReflectionException
-     * @throws \Sammyjo20\Saloon\Exceptions\SaloonDuplicateHandlerException
-     * @throws \Sammyjo20\Saloon\Exceptions\SaloonInvalidConnectorException
-     * @throws \Sammyjo20\Saloon\Exceptions\SaloonInvalidHandlerException
-     * @throws \Sammyjo20\Saloon\Exceptions\SaloonMissingMockException
-     * @throws \Sammyjo20\Saloon\Exceptions\SaloonMultipleMockMethodsException
+     * @throws \Sammyjo20\Saloon\Exceptions\SaloonException
      */
     public function send(MockClient $mockClient = null): SaloonResponse
     {
diff --git a/tests/Unit/SaloonRequestExceptionTest.php b/tests/Unit/SaloonRequestExceptionTest.php
@@ -0,0 +1,17 @@
+<?php
+
+use Sammyjo20\Saloon\Http\MockResponse;
+use Sammyjo20\Saloon\Clients\MockClient;
+use Sammyjo20\Saloon\Tests\Resources\Requests\UserRequest;
+
+test('saloon request exception contains the guzzle exception', function () {
+    $mockClient = new MockClient([
+        new MockResponse([], 500),
+    ]);
+
+    $response = (new UserRequest())->send($mockClient);
+    $exception = $response->toException();
+
+    expect($exception->getSaloonResponse())->toBe($response);
+    expect($exception->getPrevious())->toBe($response->getGuzzleException());
+});
diff --git a/tests/Unit/SaloonResponseTest.php b/tests/Unit/SaloonResponseTest.php
@@ -2,6 +2,7 @@
 
 use Sammyjo20\Saloon\Http\MockResponse;
 use Sammyjo20\Saloon\Clients\MockClient;
+use Sammyjo20\Saloon\Exceptions\SaloonRequestException;
 use Sammyjo20\Saloon\Tests\Resources\Requests\UserRequest;
 
 test('you can get the original request options', function () {
@@ -27,3 +28,41 @@
 
     expect($response->getOriginalRequest())->toBe($request);
 });
+
+test('it will throw an exception when you use the throw method', function () {
+    $mockClient = new MockClient([
+        new MockResponse([], 500),
+    ]);
+
+    $response = (new UserRequest())->send($mockClient);
+
+    $this->expectException(SaloonRequestException::class);
+
+    $response->throw();
+});
+
+test('to exception will return a saloon request exception', function () {
+    $mockClient = new MockClient([
+        new MockResponse([], 500),
+    ]);
+
+    $response = (new UserRequest())->send($mockClient);
+    $exception = $response->toException();
+
+    expect($exception)->toBeInstanceOf(SaloonRequestException::class);
+});
+
+test('the onError method will run a custom closure', function () {
+    $mockClient = new MockClient([
+        new MockResponse([], 500),
+    ]);
+
+    $response = (new UserRequest())->send($mockClient);
+    $count = 0;
+
+    $response->onError(function () use (&$count) {
+        $count++;
+    });
+
+    expect($count)->toBe(1);
+});

Original file line number	Diff line number	Diff line change
`@@ -2,9 +2,7 @@`
`2`	`2`
`3`	`3`	`namespace Sammyjo20\Saloon\Exceptions;`
`4`	`4`
`5`		`-use \Exception;`
`6`		`-`
`7`		`-class SaloonDuplicateHandlerException extends Exception`
	`5`	`+class SaloonDuplicateHandlerException extends SaloonException`
`8`	`6`	`{`
`9`	`7`	`public function __construct(string $name)`
`10`	`8`	`{`
Original file line number	Diff line number	Diff line change
`@@ -2,9 +2,7 @@`
`2`	`2`
`3`	`3`	`namespace Sammyjo20\Saloon\Exceptions;`
`4`	`4`
`5`		`-use Exception;`
`6`		`-`
`7`		`-class SaloonInvalidResponseClassException extends Exception`
	`5`	`+class SaloonInvalidResponseClassException extends SaloonException`
`8`	`6`	`{`
`9`	`7`	`public function __construct()`
`10`	`8`	`{`
Original file line number	Diff line number	Diff line change
`@@ -2,10 +2,9 @@`
`2`	`2`
`3`	`3`	`namespace Sammyjo20\Saloon\Exceptions;`
`4`	`4`
`5`		`-use \Exception;`
`6`	`5`	`use Sammyjo20\Saloon\Http\SaloonConnector;`
`7`	`6`
`8`		`-class SaloonMethodNotFoundException extends Exception`
	`7`	`+class SaloonMethodNotFoundException extends SaloonException`
`9`	`8`	`{`
`10`	`9`	`public function __construct(string $method, SaloonConnector $connector)`
`11`	`10`	`{`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`	`use \Exception;`
`6`	`6`	`use Sammyjo20\Saloon\Http\SaloonRequest;`
`7`	`7`
`8`		`-class SaloonMissingAttributeException extends Exception`
	`8`	`+class SaloonMissingAttributeException extends SaloonException`
`9`	`9`	`{`
`10`	`10`	`/**`
`11`	`11`	`* Throw an exception if we are missing a required attribute.`