[6.x] New exception handling (foxbytehq#121)

Author: JamesFreeman

src/Controllers/AuthorizationCallbackController.php

@@ -7,7 +7,6 @@
 use Illuminate\Routing\Controller;
 use Illuminate\Support\Facades\Event;
 use Illuminate\Support\Facades\Redirect;
-use Illuminate\Support\Str;
 use Webfox\Xero\Events\XeroAuthorized;
 use Webfox\Xero\Exceptions\OAuthException;
 use Webfox\Xero\Oauth2Provider;
@@ -29,15 +28,7 @@ public function __invoke(Request $request, OauthCredentialManager $oauth, Identi
             ]);
 
             if ($request->has('error')) {
-                throw new OAuthException(
-                    Str::headline(
-                        sprintf(
-                            '%s: %s',
-                            $request->get('error'),
-                            $request->get('error_description')
-                        )
-                    )
-                );
+                throw OAuthException::make($request->get('error'), $request->get('error_description'));
             }
 
             $accessToken = $provider->getAccessToken('authorization_code', $request->only('code'));

src/Exceptions/OAuthException.php

@@ -2,6 +2,18 @@
 
 namespace Webfox\Xero\Exceptions;
 
+use Illuminate\Support\Str;
+
 class OAuthException extends XeroException
 {
+    public static function make(string $error, string $errorDescription): self
+    {
+        return new static(Str::headline(
+            sprintf(
+                '%s: %s',
+                $error,
+                $errorDescription
+            )
+        ));
+    }
 }

src/Exceptions/XeroCredentialsNotFound.php

@@ -4,4 +4,8 @@
 
 class XeroCredentialsNotFound extends XeroException
 {
+    public static function make(): self
+    {
+        return new static('Xero oauth credentials are missing');
+    }
 }

src/Exceptions/XeroException.php

@@ -12,7 +12,7 @@ public function __construct($message, $code = 0, Throwable $previous = null)
         parent::__construct($message, $code, $previous);
     }
 
-    public function __toString()
+    public function __toString(): string
     {
         return __CLASS__.": [{$this->code}]: {$this->message}\n";
     }

src/Exceptions/XeroFailedToDecodeWebhookEvent.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Webfox\Xero\Exceptions;
+
+class XeroFailedToDecodeWebhookEvent extends XeroException
+{
+    public static function make(): self
+    {
+        return new static('The webhook payload could not be decoded: '.json_last_error_msg());
+    }
+}

src/Exceptions/XeroFailedToWriteFile.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Webfox\Xero\Exceptions;
+
+class XeroFailedToWriteFile extends XeroException
+{
+    public static function make(string $filePath): self
+    {
+        return new static('Failed to write file: '.$filePath);
+    }
+}

src/Exceptions/XeroMalformedWebhook.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Webfox\Xero\Exceptions;
+
+class XeroMalformedWebhook extends XeroException
+{
+    public static function make(): self
+    {
+        return new static('The webhook payload was malformed');
+    }
+}

src/Exceptions/XeroMalformedWebhookEvent.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Webfox\Xero\Exceptions;
+
+class XeroMalformedWebhookEvent extends XeroException
+{
+    public static function make(): self
+    {
+        return new static('The event payload was malformed; missing required field');
+    }
+}

src/Exceptions/XeroTenantNotFound.php

@@ -4,4 +4,8 @@
 
 class XeroTenantNotFound extends XeroException
 {
+    public static function make(): self
+    {
+        return new static('No such tenant exists');
+    }
 }

src/Exceptions/XeroUserNotAuthenticated.php

@@ -4,4 +4,8 @@
 
 class XeroUserNotAuthenticated extends XeroException
 {
+    public static function make(): self
+    {
+        return new static('User is not authenticated');
+    }
 }