fixes #1 - add custom ApiException class

Author: Nara Kasbergen

docs/NPR-One-Exceptions-ApiException.md

@@ -0,0 +1,64 @@
+NPR\One\Exceptions\ApiException
+===============
+
+An extension of CookieProvider that encrypts cookies before setting them and decrypts them when retrieving them
+
+
+
+
+* Class name: ApiException
+* Namespace: NPR\One\Exceptions
+* Parent class: Exception
+
+
+
+
+
+
+
+Methods
+-------
+
+
+### __construct
+
+    mixed NPR\One\Exceptions\ApiException::__construct(string $message, \GuzzleHttp\Psr7\Response $response)
+
+Constructs the exception using the response from the API call.
+
+
+
+* Visibility: **public**
+
+
+#### Arguments
+* $message **string**
+* $response **GuzzleHttp\Psr7\Response**
+
+
+
+### getStatusCode
+
+    integer NPR\One\Exceptions\ApiException::getStatusCode()
+
+Returns the HTTP status code from the failed API call; should generally always be 400 or greater.
+
+
+
+* Visibility: **public**
+
+
+
+
+### getBody
+
+    \GuzzleHttp\Psr7\Stream NPR\One\Exceptions\ApiException::getBody()
+
+Returns the body of the response from the failed API call. May be empty.
+
+
+
+* Visibility: **public**
+
+
+

docs/README.md

@@ -3,6 +3,8 @@ API Index
 
 * NPR
     * NPR\One
+        * NPR\One\Exceptions
+            * [ApiException](NPR-One-Exceptions-ApiException.md)
         * NPR\One\Models
             * [JsonModel](NPR-One-Models-JsonModel.md)
             * [DeviceCodeModel](NPR-One-Models-DeviceCodeModel.md)

examples/Router.php

@@ -5,6 +5,7 @@
 use NPR\One\Controllers\DeviceCodeController;
 use NPR\One\Controllers\LogoutController;
 use NPR\One\Controllers\RefreshTokenController;
+use NPR\One\Exceptions\ApiException;
 use Your\Package\Here\ConfigProvider;
 use Your\Package\Here\StorageProvider;
 
@@ -114,6 +115,11 @@
             'localactivation'
         ]);
     }
+    catch (ApiException $e)
+    {
+        $data = $e->getMessage();
+        $statusCode = $e->getStatusCode();
+    }
     catch (\Exception $e)
     {
         $data = $e->getMessage();
@@ -139,6 +145,11 @@
     {
         $data = $controller->pollDeviceCodeGrant();
     }
+    catch (ApiException $e)
+    {
+        $data = !empty($e->getBody()) ? $e->getBody() : $e->getMessage();
+        $statusCode = $e->getStatusCode();
+    }
     catch (\Exception $e)
     {
         $data = $e->getMessage();
@@ -164,6 +175,11 @@
     {
         $data = $controller->generateNewAccessTokenFromRefreshToken();
     }
+    catch (ApiException $e)
+    {
+        $data = $e->getMessage();
+        $statusCode = $e->getStatusCode();
+    }
     catch (\Exception $e)
     {
         $data = $e->getMessage();
@@ -186,6 +202,11 @@
         $controller->deleteAccessAndRefreshTokens($token);
         $data = ''; // there is nothing to return in the case of success; an empty string should suffice
     }
+    catch (ApiException $e)
+    {
+        $data = $e->getMessage();
+        $statusCode = $e->getStatusCode();
+    }
     catch (\Exception $e)
     {
         $data = $e->getMessage();

src/One/Controllers/AbstractOAuth2Controller.php

@@ -5,6 +5,7 @@
 use GuzzleHttp\Client;
 use GuzzleHttp\Psr7\Response;
 use NPR\One\DI\DI;
+use NPR\One\Exceptions\ApiException;
 use NPR\One\Interfaces\ConfigInterface;
 use NPR\One\Interfaces\EncryptionInterface;
 use NPR\One\Interfaces\StorageInterface;
@@ -209,7 +210,7 @@ final protected function validateScopes(array $scopes)
      * @param string[] $additionalParams
      * @return AccessTokenModel
      * @throws \InvalidArgumentException
-     * @throws \Exception
+     * @throws ApiException
      */
     final protected function createAccessToken($grantType, $additionalParams = [])
     {
@@ -233,7 +234,7 @@ final protected function createAccessToken($grantType, $additionalParams = [])
 
         if ($response->getStatusCode() >= 400)
         {
-            throw new \Exception("Error during createAccessToken for grant $grantType: {$this->getResponseMessage($response)}"); // @codeCoverageIgnore
+            throw new ApiException("Error during createAccessToken for grant $grantType", $response); // @codeCoverageIgnore
         }
 
         $body = $response->getBody();
@@ -258,17 +259,4 @@ final protected function storeRefreshToken(AccessTokenModel $accessToken)
             $this->secureStorage->remove('refresh_token');
         }
     }
-
-    /**
-     * Pretty print the response for inclusion in logs
-     *
-     * @internal
-     * @param Response $response
-     * @return string
-     * @codeCoverageIgnore
-     */
-    protected function getResponseMessage(Response $response)
-    {
-        return "status: {$response->getStatusCode()}, body: {$response->getBody()}";
-    }
 }

src/One/Controllers/DeviceCodeController.php

@@ -4,6 +4,7 @@
 
 use GuzzleHttp\Client;
 use NPR\One\DI\DI;
+use NPR\One\Exceptions\ApiException;
 use NPR\One\Models\AccessTokenModel;
 use NPR\One\Models\DeviceCodeModel;
 
@@ -74,7 +75,7 @@ public function pollDeviceCodeGrant()
      * @internal
      * @param string[] $scopes
      * @return DeviceCodeModel
-     * @throws \Exception
+     * @throws ApiException
      */
     private function createDeviceCode(array $scopes)
     {
@@ -91,7 +92,7 @@ private function createDeviceCode(array $scopes)
 
         if ($response->getStatusCode() >= 400)
         {
-            throw new \Exception("Error during startDeviceCodeGrant: {$this->getResponseMessage($response)}"); // @codeCoverageIgnore
+            throw new ApiException('Error during startDeviceCodeGrant', $response); // @codeCoverageIgnore
         }
 
         $body = $response->getBody();

src/One/Controllers/LogoutController.php

@@ -4,6 +4,7 @@
 
 use GuzzleHttp\Client;
 use NPR\One\DI\DI;
+use NPR\One\Exceptions\ApiException;
 
 
 /**
@@ -53,7 +54,7 @@ public function deleteAccessAndRefreshTokens($accessToken = null)
      * @internal
      * @param string $token
      * @param bool $isRefreshToken
-     * @throws \Exception
+     * @throws ApiException
      */
     private function revokeToken($token, $isRefreshToken = false)
     {
@@ -83,7 +84,7 @@ private function revokeToken($token, $isRefreshToken = false)
 
         if ($response->getStatusCode() >= 400)
         {
-            throw new \Exception("Error during revokeToken for token $token: {$this->getResponseMessage($response)}"); // @codeCoverageIgnore
+            throw new ApiException("Error during revokeToken for token $token", $response); // @codeCoverageIgnore
         }
 
         // A successful call has no response body, so there's nothing to return!

src/One/Exceptions/ApiException.php

@@ -0,0 +1,62 @@
+<?php
+
+namespace NPR\One\Exceptions;
+
+use GuzzleHttp\Psr7\Response;
+use GuzzleHttp\Psr7\Stream;
+
+
+/**
+ * An extension of CookieProvider that encrypts cookies before setting them and decrypts them when retrieving them
+ *
+ * @package NPR\One\Exceptions
+ * @codeCoverageIgnore
+ */
+class ApiException extends \Exception
+{
+    /**
+     * @var int
+     * @internal
+     */
+    private $statusCode;
+    /**
+     * @var Stream
+     * @internal
+     */
+    private $body;
+
+
+    /**
+     * Constructs the exception using the response from the API call.
+     *
+     * @param string $message
+     * @param Response $response
+     */
+    public function __construct($message, Response $response)
+    {
+        parent::__construct($message . " - status: {$response->getStatusCode()}, body: {$response->getBody()}");
+
+        $this->statusCode = $response->getStatusCode();
+        $this->body = $response->getBody();
+    }
+
+    /**
+     * Returns the HTTP status code from the failed API call; should generally always be 400 or greater.
+     *
+     * @return int
+     */
+    public function getStatusCode()
+    {
+        return $this->statusCode;
+    }
+
+    /**
+     * Returns the body of the response from the failed API call. May be empty.
+     *
+     * @return Stream
+     */
+    public function getBody()
+    {
+        return $this->body;
+    }
+}