refactor: enums and exception handling for guzzle

Author: colorfield

README.md

@@ -41,7 +41,7 @@ You can modify it via
 
 or alternatively use enum
 
-```$oAuth->config->setScopes([Scope::read->name, Scope::write->name, Scope::write->name, Scope::write->name]);```
+```$oAuth->config->setScopes([OAuthScope::read->name, OAuthScope::write->name, OAuthScope::follow->name, OAuthScope::push->name]);```
 
 Note that this must be done while obtaining the token, so you cannot override this after.
 [More about scopes](https://docs.joinmastodon.org/api/oauth-scopes/).

src/ConfigurationVO.php

@@ -4,14 +4,6 @@
 
 use InvalidArgumentException;
 
-enum Scope
-{
-    case read;
-    case write;
-    case follow;
-    case push;
-}
-
 /**
  * Class Configuration Value Object.
  *
@@ -111,7 +103,7 @@ public function __construct(
     ) {
         // Move as promoted property when removing PHP 8.1 support.
         if (empty($this->scopes)) {
-            $this->setScopes([Scope::read->name, Scope::write->name]);
+            $this->setScopes([OAuthScope::read->name, OAuthScope::write->name]);
         }
         $this->setBaseUrl();
     }
@@ -195,7 +187,7 @@ public function setScopes(array $scopes)
     {
         // Mastodon defaults itself to read if no scope configured.
         if (!empty($scopes)) {
-            $scopeValues = array_column(Scope::cases(), 'name');
+            $scopeValues = array_column(OAuthScope::cases(), 'name');
             // Check scope values.
             if (count(array_intersect($scopes, $scopeValues)) === count($scopes)) {
                 $this->scopes = $scopes;

src/HttpOperation.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace Colorfield\Mastodon;
+
+enum HttpOperation
+{
+    case GET;
+    case POST;
+    case PUT;
+    case PATCH;
+    case DELETE;
+}

src/MastodonAPI.php

@@ -2,21 +2,13 @@
 
 namespace Colorfield\Mastodon;
 
-use Exception;
 use GuzzleHttp\ClientInterface;
+use GuzzleHttp\Exception\GuzzleException;
 use InvalidArgumentException;
+use Exception;
 use GuzzleHttp\Client;
 use Psr\Http\Message\ResponseInterface;
 
-enum HttpOperations
-{
-    case GET;
-    case POST;
-    case PUT;
-    case PATCH;
-    case DELETE;
-}
-
 /**
  * MastodonAPI
  *
@@ -29,28 +21,17 @@ enum HttpOperations
  */
 class MastodonAPI
 {
-    // @todo use promoted properties
     // @todo improve return type for the api response
 
-    private ConfigurationVO $config;
-
-    private ClientInterface $client;
-
     /**
      * Creates the API object.
      *
      * @param ConfigurationVO $config
      */
-    public function __construct(ConfigurationVO $config)
-    {
-        $this->client = new Client();
-
-        try {
-            $this->config = $config;
-        } catch (InvalidArgumentException $exception) {
-            print($exception->getMessage());
-        }
-    }
+    public function __construct(
+        public ConfigurationVO $config,
+        public ClientInterface $client = new Client()
+    ) { }
 
     /**
      * Sends a request to the specified API endpoint and returns the response.
@@ -64,35 +45,30 @@ public function __construct(ConfigurationVO $config)
      *
      * @return mixed
      *   The response body from the API endpoint, or null if there was an error.
+     * @throws GuzzleException|InvalidArgumentException|Exception
      */
     private function getResponse(string $endpoint, string $method, array $json): mixed
     {
-        $result = null;
         $uri = $this->config->getBaseUrl() . '/api/';
         $uri .= ConfigurationVO::API_VERSION . $endpoint;
 
-        $allowedMethods = array_column(HttpOperations::cases(), 'name');
+        $allowedMethods = array_column(HttpOperation::cases(), 'name');
         if (!in_array($method, $allowedMethods)) {
             throw new InvalidArgumentException('ERROR: only ' . implode(',', $allowedMethods) . 'are allowed');
         }
 
-        try {
-            $response = $this->client->request($method, $uri, [
-                'headers' => [
-                  'Authorization' => 'Bearer ' . $this->config->getBearer(),
-                ],
-                'json' => $json,
-            ]);
-            // @todo $request->getHeader('content-type')
-            if($response instanceof ResponseInterface
-              && $response->getStatusCode() == '200') {
-                $result = json_decode($response->getBody(), true);
-            } else {
-                echo 'ERROR: Status code ' . $response->getStatusCode();
-            }
-            // @todo check thrown exception
-        } catch (Exception $exception) {
-            echo 'ERROR: ' . $exception->getMessage();
+        $response = $this->client->request($method, $uri, [
+            'headers' => [
+              'Authorization' => 'Bearer ' . $this->config->getBearer(),
+            ],
+            'json' => $json,
+        ]);
+
+        if ($response instanceof ResponseInterface
+          && $response->getStatusCode() == '200') {
+            $result = json_decode($response->getBody(), true);
+        } else {
+           throw new Exception('ERROR ' . $response->getStatusCode() . ' : ' . $response->getReasonPhrase());
         }
         return $result;
     }

src/OAuthScope.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Colorfield\Mastodon;
+
+enum OAuthScope
+{
+    case read;
+    case write;
+    case follow;
+    case push;
+}