Refactored Exceptions naming

thePanz · Jul 14, 2017 · 6a0503e · 6a0503e
1 parent ae2101d
commit 6a0503e
Show file tree

Hide file tree

Showing 16 changed files with 77 additions and 91 deletions.
diff --git a/src/Api/HttpApi.php b/src/Api/HttpApi.php
@@ -6,8 +6,8 @@
 
 use Http\Client\HttpClient;
 use Http\Message\MessageFactory;
+use Pnz\MattermostClient\Exception\ApiException;
 use Pnz\MattermostClient\Exception\Domain as DomainExceptions;
-use Pnz\MattermostClient\Exception\GenericApiException;
 use Pnz\MattermostClient\Hydrator\Hydrator;
 use Pnz\MattermostClient\Hydrator\ModelHydrator;
 use Pnz\MattermostClient\Model\Error;
@@ -157,7 +157,7 @@ protected function handleResponse(ResponseInterface $response, $class)
      *
      * @param ResponseInterface $response
      *
-     * @throws GenericApiException
+     * @throws ApiException
      */
     protected function handleErrors(ResponseInterface $response)
     {
@@ -179,7 +179,7 @@ protected function handleErrors(ResponseInterface $response)
             case 501:
                 throw new DomainExceptions\DisabledFeatureException($response, $error);
             default:
-                throw new GenericApiException($response, $error);
+                throw new ApiException($response, $error);
         }
     }
 

diff --git a/src/Exception.php b/src/Exception.php
diff --git a/src/Exception/ApiException.php b/src/Exception/ApiException.php
@@ -7,18 +7,39 @@
 use Pnz\MattermostClient\Model\Error;
 use Psr\Http\Message\ResponseInterface;
 
-interface ApiException
+class ApiException extends \Exception implements DomainException
 {
     /**
-     * @return
-     * @return ResponseInterface
+     * @var Error
      */
-    public function getResponse();
+    protected $error;
+
+    /**
+     * @var ResponseInterface
+     */
+    protected $response;
+
+    public function __construct(ResponseInterface $response, Error $error = null)
+    {
+        $this->error = $error;
+        $this->response = $response;
+
+        parent::__construct($error ? $error->getMessage() : '', $response->getStatusCode());
+    }
 
     /**
-     * Returns the underlying Error, if available.
-     *
      * @return Error|null
      */
-    public function getError();
+    public function getError()
+    {
+        return $this->error;
+    }
+
+    /**
+     * @return ResponseInterface
+     */
+    public function getResponse()
+    {
+        return $this->response;
+    }
 }
diff --git a/src/Exception/Domain/DisabledFeatureException.php b/src/Exception/Domain/DisabledFeatureException.php
@@ -2,9 +2,8 @@
 
 namespace Pnz\MattermostClient\Exception\Domain;
 
-use Pnz\MattermostClient\Exception\DomainException;
-use Pnz\MattermostClient\Exception\GenericApiException;
+use Pnz\MattermostClient\Exception\ApiException;
 
-final class DisabledFeatureException extends GenericApiException implements DomainException
+final class DisabledFeatureException extends ApiException
 {
 }
diff --git a/src/Exception/Domain/LoginFailedException.php b/src/Exception/Domain/LoginFailedException.php
@@ -2,9 +2,8 @@
 
 namespace Pnz\MattermostClient\Exception\Domain;
 
-use Pnz\MattermostClient\Exception\DomainException;
-use Pnz\MattermostClient\Exception\GenericApiException;
+use Pnz\MattermostClient\Exception\ApiException;
 
-final class LoginFailedException extends GenericApiException implements DomainException
+final class LoginFailedException extends ApiException
 {
 }
diff --git a/src/Exception/Domain/MissingAccessTokenException.php b/src/Exception/Domain/MissingAccessTokenException.php
@@ -2,9 +2,8 @@
 
 namespace Pnz\MattermostClient\Exception\Domain;
 
-use Pnz\MattermostClient\Exception\DomainException;
-use Pnz\MattermostClient\Exception\GenericApiException;
+use Pnz\MattermostClient\Exception\ApiException;
 
-final class MissingAccessTokenException extends GenericApiException implements DomainException
+final class MissingAccessTokenException extends ApiException
 {
 }
diff --git a/src/Exception/Domain/NotFoundException.php b/src/Exception/Domain/NotFoundException.php
@@ -2,9 +2,8 @@
 
 namespace Pnz\MattermostClient\Exception\Domain;
 
-use Pnz\MattermostClient\Exception\DomainException;
-use Pnz\MattermostClient\Exception\GenericApiException;
+use Pnz\MattermostClient\Exception\ApiException;
 
-final class NotFoundException extends GenericApiException implements DomainException
+final class NotFoundException extends ApiException
 {
 }
diff --git a/src/Exception/Domain/PermissionDeniedException.php b/src/Exception/Domain/PermissionDeniedException.php
@@ -2,9 +2,8 @@
 
 namespace Pnz\MattermostClient\Exception\Domain;
 
-use Pnz\MattermostClient\Exception\DomainException;
-use Pnz\MattermostClient\Exception\GenericApiException;
+use Pnz\MattermostClient\Exception\ApiException;
 
-final class PermissionDeniedException extends GenericApiException implements DomainException
+final class PermissionDeniedException extends ApiException
 {
 }
diff --git a/src/Exception/Domain/ValidationException.php b/src/Exception/Domain/ValidationException.php
@@ -2,9 +2,8 @@
 
 namespace Pnz\MattermostClient\Exception\Domain;
 
-use Pnz\MattermostClient\Exception\DomainException;
-use Pnz\MattermostClient\Exception\GenericApiException;
+use Pnz\MattermostClient\Exception\ApiException;
 
-final class ValidationException extends GenericApiException implements DomainException
+final class ValidationException extends ApiException
 {
 }
diff --git a/src/Exception/DomainException.php b/src/Exception/DomainException.php
@@ -1,7 +1,24 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Pnz\MattermostClient\Exception;
 
-interface DomainException extends ApiException
+use Pnz\MattermostClient\Model\Error;
+use Psr\Http\Message\ResponseInterface;
+
+interface DomainException extends Exception
 {
+    /**
+     * @return
+     * @return ResponseInterface
+     */
+    public function getResponse();
+
+    /**
+     * Returns the underlying Error, if available.
+     *
+     * @return Error|null
+     */
+    public function getError();
 }
diff --git a/src/Exception/Exception.php b/src/Exception/Exception.php
@@ -0,0 +1,10 @@
+<?php
+
+namespace Pnz\MattermostClient\Exception;
+
+/**
+ * All our exception implements this interface.
+ */
+interface Exception
+{
+}
diff --git a/src/Exception/GenericApiException.php b/src/Exception/GenericApiException.php
diff --git a/src/Exception/HydrationException.php b/src/Exception/HydrationException.php
@@ -2,8 +2,6 @@
 
 namespace Pnz\MattermostClient\Exception;
 
-use Pnz\MattermostClient\Exception;
-
 class HydrationException extends \RuntimeException implements Exception
 {
 }
diff --git a/src/Exception/InvalidArgumentException.php b/src/Exception/InvalidArgumentException.php
@@ -2,8 +2,6 @@
 
 namespace Pnz\MattermostClient\Exception;
 
-use Pnz\MattermostClient\Exception;
-
 class InvalidArgumentException extends \InvalidArgumentException implements Exception
 {
 }
diff --git a/src/Plugin/MattermostLoginPlugin.php b/src/Plugin/MattermostLoginPlugin.php
@@ -7,8 +7,8 @@
 use Http\Client\Common\Plugin;
 use Http\Message\Authentication\Bearer;
 use Http\Message\RequestFactory;
+use Pnz\MattermostClient\Exception\ApiException;
 use Pnz\MattermostClient\Exception\Domain\LoginFailedException;
-use Pnz\MattermostClient\Exception\GenericApiException;
 use Pnz\MattermostClient\Model\Error;
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ResponseInterface;
@@ -78,7 +78,7 @@ public function handleRequest(RequestInterface $request, callable $next, callabl
      * @param callable $first
      *
      * @throws LoginFailedException when loginId/password are not valid
-     * @throws GenericApiException  When an unknown response is returned by the API while logging in
+     * @throws ApiException         When an unknown response is returned by the API while logging in
      */
     private function authenticate(callable $first)
     {
@@ -112,7 +112,7 @@ private function authenticate(callable $first)
                 }
                 // Otherwise fallback to the default exception
             default:
-                throw new GenericApiException($response);
+                throw new ApiException($response);
         }
     }
 }
diff --git a/tests/Api/BaseHttpApiTest.php b/tests/Api/BaseHttpApiTest.php
@@ -7,12 +7,12 @@
 use Http\Message\MessageFactory;
 use Http\Message\StreamFactory\GuzzleStreamFactory;
 use PHPUnit\Framework\TestCase;
+use Pnz\MattermostClient\Exception\ApiException;
 use Pnz\MattermostClient\Exception\Domain\DisabledFeatureException;
 use Pnz\MattermostClient\Exception\Domain\MissingAccessTokenException;
 use Pnz\MattermostClient\Exception\Domain\NotFoundException;
 use Pnz\MattermostClient\Exception\Domain\PermissionDeniedException;
 use Pnz\MattermostClient\Exception\Domain\ValidationException;
-use Pnz\MattermostClient\Exception\GenericApiException;
 use Pnz\MattermostClient\Hydrator\Hydrator;
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ResponseInterface;
@@ -92,9 +92,9 @@ public function getErrorCodesExceptions()
             '403' => [PermissionDeniedException::class, 403],
             '404' => [NotFoundException::class, 404],
             '501' => [DisabledFeatureException::class, 501],
-            '500' => [GenericApiException::class, 500],
+            '500' => [ApiException::class, 500],
             // Weird response
-            '000' => [GenericApiException::class, 000],
+            '000' => [ApiException::class, 000],
         ];
     }
 }