🥅 Improve Envoyer API error handling (#14)

Author: Log1x

src/EnvoyerApi.php

@@ -5,7 +5,8 @@
 use Illuminate\Http\Client\PendingRequest;
 use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\Http;
-use Log1x\EnvoyerDeploy\Exceptions\ApiKeyMissingException;
+use Log1x\EnvoyerDeploy\Exceptions\EnvoyerApiErrorException;
+use Log1x\EnvoyerDeploy\Exceptions\EnvoyerApiKeyMissingException;
 
 class EnvoyerApi
 {
@@ -34,6 +35,8 @@ public static function make(): EnvoyerApi
 
     /**
      * Get the Envoyer HTTP client.
+     *
+     * @throws \Log1x\EnvoyerDeploy\Exceptions\EnvoyerApiKeyMissingException
      */
     public function api(): PendingRequest
     {
@@ -44,6 +47,42 @@ public function api(): PendingRequest
         ])->baseUrl($this->endpoint);
     }
 
+    /**
+     * Get from the Envoyer API.
+     *
+     * @throws \Log1x\EnvoyerDeploy\Exceptions\EnvoyerApiErrorException
+     */
+    public function get(string $uri): object
+    {
+        $response = $this->api()->get($uri);
+
+        if ($response->failed()) {
+            throw new EnvoyerApiErrorException($response);
+        }
+
+        return json_decode(
+            $response->body()
+        );
+    }
+
+    /**
+     * Post to the Envoyer API.
+     *
+     * @throws \Log1x\EnvoyerDeploy\Exceptions\EnvoyerApiErrorException
+     */
+    public function post(string $uri): object
+    {
+        $response = $this->api()->post($uri);
+
+        if ($response->failed()) {
+            throw new EnvoyerApiErrorException($response);
+        }
+
+        return json_decode(
+            $response->body()
+        );
+    }
+
     /**
      * Get the Envoyer API endpoint.
      */
@@ -75,7 +114,7 @@ public function apiKey(string $apiKey): EnvoyerApi
     /**
      * Get the Envoyer API key.
      *
-     * @throws \Log1x\EnvoyerDeploy\Exceptions\ApiKeyMissingException
+     * @throws \Log1x\EnvoyerDeploy\Exceptions\EnvoyerApiKeyMissingException
      */
     public function getApiKey(): string
     {
@@ -86,7 +125,7 @@ public function getApiKey(): string
         $this->apiKey = config('envoyer.api_key', null);
 
         if (empty($this->apiKey)) {
-            throw new ApiKeyMissingException;
+            throw new EnvoyerApiKeyMissingException;
         }
 
         return $this->apiKey;
@@ -107,9 +146,7 @@ public function project(int $project): EnvoyerApi
      */
     public function getProjects(): Collection
     {
-        $projects = json_decode(
-            $this->api()->get('/projects')->body()
-        );
+        $projects = $this->get('/projects');
 
         return collect($projects->projects ?? []);
     }
@@ -119,9 +156,7 @@ public function getProjects(): Collection
      */
     public function getProject(): ?object
     {
-        $project = json_decode(
-            $this->api()->get("/projects/{$this->project}")->body()
-        );
+        $project = $this->get("/projects/{$this->project}");
 
         return $project->project ?? null;
     }
@@ -131,9 +166,7 @@ public function getProject(): ?object
      */
     public function getDeployment(int $deployment): ?object
     {
-        $deployment = json_decode(
-            $this->api()->get("/projects/{$this->project}/deployments/{$deployment}")->body()
-        );
+        $deployment = $this->get("/projects/{$this->project}/deployments/{$deployment}");
 
         return $deployment->deployment ?? null;
     }
@@ -143,9 +176,7 @@ public function getDeployment(int $deployment): ?object
      */
     public function getDeployments(): Collection
     {
-        $deployments = json_decode(
-            $this->api()->get("/projects/{$this->project}/deployments")->body()
-        );
+        $deployments = $this->get("/projects/{$this->project}/deployments");
 
         return collect($deployments->deployments ?? []);
     }
@@ -155,9 +186,7 @@ public function getDeployments(): Collection
      */
     public function getActions(): Collection
     {
-        $actions = json_decode(
-            $this->api()->get('/actions')->body()
-        );
+        $actions = $this->get('/actions');
 
         return collect($actions->actions ?? []);
     }
@@ -167,9 +196,7 @@ public function getActions(): Collection
      */
     public function getHooks(): Collection
     {
-        $hooks = json_decode(
-            $this->api()->get("/projects/{$this->project}/hooks")->body()
-        );
+        $hooks = $this->get("/projects/{$this->project}/hooks");
 
         return collect($hooks->hooks ?? []);
     }
@@ -179,9 +206,7 @@ public function getHooks(): Collection
      */
     public function getFolders(): Collection
     {
-        $folders = json_decode(
-            $this->api()->get("/projects/{$this->project}/folders")->body()
-        );
+        $folders = $this->get("/projects/{$this->project}/folders");
 
         return collect($folders->folders ?? []);
     }
@@ -191,6 +216,6 @@ public function getFolders(): Collection
      */
     public function deploy(): void
     {
-        $this->api()->post("/projects/{$this->project}/deployments");
+        $this->post("/projects/{$this->project}/deployments");
     }
 }

src/Exceptions/EnvoyerApiErrorException.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace Log1x\EnvoyerDeploy\Exceptions;
+
+use Exception;
+use Illuminate\Http\Client\Response;
+
+class EnvoyerApiErrorException extends Exception
+{
+    /**
+     * The Envoyer error codes.
+     */
+    protected array $errorCodes = [
+        '400' => 'Valid data was given but the request has failed.',
+        '401' => 'No valid API Key was given.',
+        '404' => 'The request resource could not be found.',
+        '422' => 'The payload has missing required parameters or invalid data was given.',
+        '429' => 'Too many attempts.',
+        '500' => 'Request failed due to an internal error in Envoyer.',
+        '503' => 'Envoyer is offline for maintenance.',
+    ];
+
+    /**
+     * Create a new exception instance.
+     *
+     * @return void
+     */
+    public function __construct(Response $response)
+    {
+        parent::__construct($this->errorCodes[$response->status()] ?? $response->body());
+    }
+}

src/Exceptions/ApiKeyMissingException.php renamed to src/Exceptions/EnvoyerApiKeyMissingException.php

@@ -4,7 +4,7 @@
 
 use Exception;
 
-class ApiKeyMissingException extends Exception
+class EnvoyerApiKeyMissingException extends Exception
 {
     /**
      * Create a new exception instance.