Refactor SDK to improve error handling and simplify logic

Enhanced exception handling by updating UnitException and integrating `Throwable` for better error context. Refactored the use of `HttpMethodsEnum` and introduced `ApiPathEnum` to streamline API path references. Added `isConnected` and `reset` methods to improve functionality and consolidated HTTP client setup in `UnitRequest`. Removed readonly attribute from `Certificate` class for future extensibility.

Author: Pavlusha311245

src/Certificate.php

@@ -13,7 +13,7 @@
  *
  * @implements CertificateInterface
  */
-readonly class Certificate implements CertificateInterface, Arrayable
+class Certificate implements CertificateInterface, Arrayable
 {
     /**
      * @var array $chain

src/Config.php

@@ -3,13 +3,15 @@
 namespace UnitPhpSdk;
 
 use Override;
+use Throwable;
 use UnitPhpSdk\Abstract\AbstractApplication;
 use UnitPhpSdk\Config\{AccessLog, Listener, Route, Settings, Upstream, Upstream\Server};
 use UnitPhpSdk\Exceptions\{FileNotFoundException, UnitException};
 use UnitPhpSdk\Builders\ApplicationBuilder;
 use UnitPhpSdk\Builders\EndpointBuilder;
 use UnitPhpSdk\Contracts\ConfigInterface;
 use UnitPhpSdk\Contracts\Uploadable;
+use UnitPhpSdk\Enums\ApiPathEnum;
 use UnitPhpSdk\Http\UnitRequest;
 use UnitPhpSdk\Enums\HttpMethodsEnum;
 use UnitPhpSdk\Traits\CanUpload;
@@ -73,7 +75,7 @@ public function __construct(object $data = null, UnitRequest $unitRequest = null
             $this->parseUnitObject($data);
         }
 
-        $this->setApiEndpoint(EndpointBuilder::create('/config')->get());
+        $this->setApiEndpoint(EndpointBuilder::create(ApiPathEnum::CONFIG->value)->get());
     }
 
     /**
@@ -253,7 +255,7 @@ public function getListenerByPort(int $port): Listener|null
     public function uploadListener(Listener $listener): bool
     {
         try {
-            $this->unitRequest->setMethod(HttpMethodsEnum::PUT->value)
+            $this->unitRequest->setMethod(HttpMethodsEnum::PUT)
                 ->send("/config/listeners/{$listener->getListener()}", requestOptions: [
                     'json' => $listener->toArray()
                 ]);
@@ -281,7 +283,7 @@ public function uploadListenerFromFile(string $path, string $listener): bool
         }
 
         try {
-            $this->unitRequest->setMethod('PUT')
+            $this->unitRequest->setMethod(HttpMethodsEnum::PUT)
                 ->send("/config/listeners/$listener", requestOptions: [
                     'body' => $fileContent
                 ]);
@@ -441,8 +443,8 @@ public function removeRoutes(): bool
         }
 
         try {
-            $this->unitRequest->setMethod(HttpMethodsEnum::DELETE->value)
-                ->send('/config/routes');
+            $this->unitRequest->setMethod(HttpMethodsEnum::DELETE)
+                ->send(ApiPathEnum::ROUTES->value);
         } catch (UnitException) {
             return false;
         }
@@ -543,7 +545,7 @@ public function setAccessLog($path, $format = null): bool
         }
 
         try {
-            $this->unitRequest->setMethod(HttpMethodsEnum::PUT->value)
+            $this->unitRequest->setMethod(HttpMethodsEnum::PUT)
                 ->send('/config/access_log', requestOptions: [
                     'json' => json_encode($data)
                 ]);
@@ -554,15 +556,20 @@ public function setAccessLog($path, $format = null): bool
         return true;
     }
 
+    /**
+     * Add access log to config
+     *
+     * @return AccessLog|null
+     */
     public function getAccessLog(): ?AccessLog
     {
         try {
-            $result = $this->unitRequest->send('/config/access_log');
-        } catch (UnitException) {
-            return null;
-        }
+            $result = $this->unitRequest->send(ApiPathEnum::ACCESS_LOG->value);
 
-        return new AccessLog($result);
+            return new AccessLog($result);
+        } catch (Throwable $exception) {
+            throw new UnitException($exception->getMessage(), $exception->getCode(), $exception);
+        }
     }
 
     public function removeAccessLog(): bool
@@ -612,6 +619,32 @@ private function mapConfigObjectToArray(array $data): array
         return array_combine($keys, $values);
     }
 
+    public function reset(): bool
+    {
+        try {
+            $this->unitRequest->setMethod(HttpMethodsEnum::DELETE)
+                ->send('/config');
+
+            $this->unitRequest->setMethod(HttpMethodsEnum::POST)
+                ->send(
+                    uri: '/config',
+                    requestOptions: [
+                        'json' => json_encode([
+                            'listeners' => (object)[],
+                            'routes' => (object)[],
+                            'applications' => (object)[],
+                            'upstreams' => (object)[],
+                            'settings' => (object)[]
+                        ])
+                    ]
+                );
+        } catch (UnitException) {
+            return false;
+        }
+
+        return true;
+    }
+
     /**
      * @return Settings|null
      */

src/Contracts/UnitInterface.php

@@ -52,7 +52,7 @@ public function getCertificate(string $certificateName): ?CertificateInterface;
      * @return bool
      * @throws UnitException
      */
-    public function uploadCertificate(string $path, string $certificateName): bool;
+    public function uploadCertificate(string $path, string $certificateName);
 
     /**
      * Return full config uploaded on Nginx Unit

src/Exceptions/UnitException.php

@@ -3,24 +3,26 @@
 namespace UnitPhpSdk\Exceptions;
 
 use Exception;
+use Throwable;
 
 /**
  * The UnitException class is an exception class that extends the base Exception class.
  * It is used to represent exceptions that occur specifically within units.
- *
- * @package Your\Namespace
  */
 class UnitException extends Exception
 {
     /**
      * Constructor method.
      *
-     * @param string $message The message to be set for the object.
-     *
-     * @return void
+     * @param string $message The exception message
+     * @param int $code The exception code
+     * @param Throwable|null $previous Previous throwable used for exception chaining
      */
-    public function __construct(string $message)
-    {
-        parent::__construct($message);
+    public function __construct(
+        string     $message = "",
+        int        $code = 0,
+        ?Throwable $previous = null
+    ) {
+        parent::__construct($message, $code, $previous);
     }
 }

src/Http/UnitRequest.php

@@ -3,6 +3,7 @@
 namespace UnitPhpSdk\Http;
 
 use GuzzleHttp\Client;
+use GuzzleHttp\ClientInterface;
 use GuzzleHttp\Exception\GuzzleException;
 use UnitPhpSdk\Enums\HttpMethodsEnum;
 use UnitPhpSdk\Exceptions\UnitException;
@@ -24,6 +25,8 @@ class UnitRequest
      */
     private readonly string $address;
 
+    private ClientInterface $client;
+
     /**
      * Constructor
      *
@@ -34,6 +37,11 @@ public function __construct(
         string                   $address,
         private readonly ?string $socket = null
     ) {
+        $this->client = $client ?? new Client([
+            'base_uri' => $address,
+            'curl' => $this->socket ? [CURLOPT_UNIX_SOCKET_PATH => $this->socket] : []
+        ]);
+
         $this->address = $this->parseAddress($address);
     }
 
@@ -71,21 +79,16 @@ public function setMethod(string|HttpMethodsEnum $method): self
     /**
      * Send request
      *
+     * @param $uri
+     * @param bool $associative
+     * @param array $requestOptions
+     * @return mixed
+     * @throws GuzzleException
      * @throws UnitException
      */
-    public function send($uri, $associative = true, array $requestOptions = [])
+    public function send($uri, bool $associative = true, array $requestOptions = [])
     {
-        $client = new Client();
-
-        if (!empty($this->socket)) {
-            $requestOptions['curl'] = [CURLOPT_UNIX_SOCKET_PATH => $this->socket];
-        }
-
-        try {
-            $response = $client->request($this->method, $this->address . $uri, $requestOptions);
-        } catch (GuzzleException $exception) {
-            throw new UnitException($exception->getMessage());
-        }
+        $response = $this->client->request($this->method, $this->address . $uri, $requestOptions);
 
         $rawData = json_decode($response->getBody()->getContents(), $associative);
 

src/Unit.php

@@ -3,9 +3,10 @@
 namespace UnitPhpSdk;
 
 use UnitPhpSdk\Contracts\{CertificateInterface, UnitInterface, Uploadable};
+use GuzzleHttp\Client;
 use Override;
+use Psr\Http\Client\ClientInterface;
 use UnitPhpSdk\Abstract\AbstractApplication;
-use UnitPhpSdk\Enums\HttpMethodsEnum;
 use UnitPhpSdk\Exceptions\FileNotFoundException;
 use UnitPhpSdk\Exceptions\UnitException;
 use UnitPhpSdk\Http\UnitRequest;
@@ -47,14 +48,15 @@ class Unit implements UnitInterface
 
     private UnitRequest $request;
 
+
     /**
      * Constructor
      *
      * @throws UnitException
      */
     public function __construct(
         private readonly string  $address,
-        private readonly ?string $socket = null
+        private readonly ?string $socket = null,
     ) {
         $this->request = new UnitRequest(
             address: $this->address,
@@ -84,6 +86,7 @@ public function getConfig(): Contracts\ConfigInterface
     private function loadConfig(): void
     {
         $result = $this->request->send('/config', false);
+        //        dd($result);
         $this->config = new Config($result, $this->request);
     }
 
@@ -101,7 +104,7 @@ public function getCertificates(): array
     /**
      * @inheritDoc
      */
-    public function uploadCertificate(string $path, string $certificateName): bool
+    public function uploadCertificate(string $path, string $certificateName)
     {
         // TODO: need to review
         $fileContent = file_get_contents($path);
@@ -115,12 +118,13 @@ public function uploadCertificate(string $path, string $certificateName): bool
                 ->send("/certificates/$certificateName", requestOptions: [
                     'body' => $fileContent
                 ]);
-        } catch (UnitException $exception) {
-            print_r($exception->getMessage());
-            return false;
-        }
+        } catch (\Throwable $exception) {
+            if ($exception->getCode() == 400) {
+                throw new UnitException($exception->getMessage());
+            }
 
-        return true;
+            throw new UnitException($exception->getMessage());
+        }
     }
 
     /**
@@ -213,7 +217,7 @@ private function loadJsModules(): void
      */
     private function loadStatistics(): void
     {
-        $result = (new UnitRequest($this->address, $this->socket))->send('/status');
+        $result = $this->request->send('/status');
         $this->statistics = new Statistics($result);
     }
 
@@ -302,6 +306,9 @@ public function restartApplication(AbstractApplication $application): bool
         return true;
     }
 
+    /**
+     * @throws UnitException
+     */
     #[Override] public function toArray(): array
     {
         return [
@@ -312,6 +319,22 @@ public function restartApplication(AbstractApplication $application): bool
         ];
     }
 
+    /**
+     * Checks if a connection to the server is established.
+     *
+     * @return bool Returns true if the connection is successful, false otherwise.
+     */
+    public function isConnected(): bool
+    {
+        try {
+            $this->request->send('/');
+        } catch (UnitException) {
+            return false;
+        }
+
+        return true;
+    }
+
     #[Override] public function toJson(int $options = 0): string
     {
         return json_encode($this->toArray(), $options);