[6.x] Credential managers

src/Exceptions/OAuthException.php

@@ -2,18 +2,6 @@
 
 namespace Webfox\Xero\Exceptions;
 
-use Exception;
-use Throwable;
-
-class OAuthException extends Exception
+class OAuthException extends XeroException
 {
-    public function __construct($message, $code = 0, Throwable $previous = null)
-    {
-        parent::__construct($message, $code, $previous);
-    }
-
-    public function __toString()
-    {
-        return __CLASS__.": [{$this->code}]: {$this->message}\n";
-    }
 }

src/Exceptions/XeroCredentialsNotFound.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Webfox\Xero\Exceptions;
+
+class XeroCredentialsNotFound extends XeroException
+{
+}

src/Exceptions/XeroException.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Webfox\Xero\Exceptions;
+
+use Exception;
+use Throwable;
+
+abstract class XeroException extends Exception
+{
+    public function __construct($message, $code = 0, Throwable $previous = null)
+    {
+        parent::__construct($message, $code, $previous);
+    }
+
+    public function __toString()
+    {
+        return __CLASS__.": [{$this->code}]: {$this->message}\n";
+    }
+}

src/Exceptions/XeroTenantNotFound.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Webfox\Xero\Exceptions;
+
+class XeroTenantNotFound extends XeroException
+{
+}

src/Exceptions/XeroUserNotAuthenticated.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Webfox\Xero\Exceptions;
+
+class XeroUserNotAuthenticated extends XeroException
+{
+}

src/Oauth2CredentialManagers/ArrayStore.php

@@ -2,86 +2,19 @@
 
 namespace Webfox\Xero\Oauth2CredentialManagers;
 
-use Illuminate\Session\Store;
 use League\OAuth2\Client\Token\AccessTokenInterface;
-use Webfox\Xero\Oauth2Provider;
+use Webfox\Xero\Exceptions\XeroCredentialsNotFound;
 use Webfox\Xero\OauthCredentialManager;
 
-class ArrayStore implements OauthCredentialManager
+class ArrayStore extends BaseCredentialManager implements OauthCredentialManager
 {
     public ?array $dataStorage = null;
 
-    public function __construct(protected Store $session, protected Oauth2Provider $oauthProvider)
-    {
-    }
-
-    public function getAccessToken(): string
-    {
-        return $this->data('token');
-    }
-
-    public function getRefreshToken(): string
-    {
-        return $this->data('refresh_token');
-    }
-
-    public function getTenants(): ?array
-    {
-        return $this->data('tenants');
-    }
-
-    public function getTenantId(int $tenant = 0): string
-    {
-        if (! isset($this->data('tenants')[$tenant])) {
-            throw new \Exception('No such tenant exists');
-        }
-
-        return $this->data('tenants')[$tenant]['Id'];
-    }
-
-    public function getExpires(): int
-    {
-        return $this->data('expires');
-    }
-
-    public function getState(): string
-    {
-        return $this->session->get('xero_oauth2_state') ?? '';
-    }
-
-    public function getAuthorizationUrl(): string
-    {
-        $redirectUrl = $this->oauthProvider->getAuthorizationUrl(['scope' => config('xero.oauth.scopes')]);
-        $this->session->put('xero_oauth2_state', $this->oauthProvider->getState());
-
-        return $redirectUrl;
-    }
-
-    public function getData(): array
-    {
-        return $this->data();
-    }
-
     public function exists(): bool
     {
         return $this->dataStorage !== null;
     }
 
-    public function isExpired(): bool
-    {
-        return time() >= $this->data('expires');
-    }
-
-    public function refresh(): void
-    {
-        $newAccessToken = $this->oauthProvider->getAccessToken('refresh_token', [
-            'grant_type' => 'refresh_token',
-            'refresh_token' => $this->getRefreshToken(),
-        ]);
-
-        $this->store($newAccessToken);
-    }
-
     public function store(AccessTokenInterface $token, array $tenants = null): void
     {
         $this->dataStorage = [
@@ -93,30 +26,10 @@ public function store(AccessTokenInterface $token, array $tenants = null): void
         ];
     }
 
-    public function getUser(): ?array
-    {
-        try {
-            $jwt = new \XeroAPI\XeroPHP\JWTClaims();
-            $jwt->setTokenId($this->data('id_token'));
-            $decodedToken = $jwt->decode();
-
-            return [
-                'given_name' => $decodedToken->getGivenName(),
-                'family_name' => $decodedToken->getFamilyName(),
-                'email' => $decodedToken->getEmail(),
-                'user_id' => $decodedToken->getXeroUserId(),
-                'username' => $decodedToken->getPreferredUsername(),
-                'session_id' => $decodedToken->getGlobalSessionId(),
-            ];
-        } catch (\Throwable $e) {
-            return null;
-        }
-    }
-
     protected function data(string $key = null)
     {
         if (! $this->exists()) {
-            throw new \Exception('Xero oauth credentials are missing');
+            throw new XeroCredentialsNotFound('Xero oauth credentials are missing');
         }
 
         return $key === null ? $this->dataStorage : $this->dataStorage[$key] ?? null;

src/Oauth2CredentialManagers/AuthenticatedUserStore.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Webfox\Xero\Oauth2CredentialManagers;
+
+use Illuminate\Support\Facades\Auth;
+use Webfox\Xero\Exceptions\XeroUserNotAuthenticated;
+
+class AuthenticatedUserStore extends ModelStore
+{
+    public function __construct()
+    {
+        if (! Auth::check()) {
+            throw new XeroUserNotAuthenticated('User is not authenticated');
+        }
+
+        parent::__construct();
+
+        $this->model = Auth::user();
+    }
+}

src/Oauth2CredentialManagers/BaseCredentialManager.php

@@ -0,0 +1,104 @@
+<?php
+
+namespace Webfox\Xero\Oauth2CredentialManagers;
+
+use Illuminate\Session\Store;
+use Webfox\Xero\Exceptions\XeroTenantNotFound;
+use Webfox\Xero\Oauth2Provider;
+use XeroAPI\XeroPHP\JWTClaims;
+
+abstract class BaseCredentialManager
+{
+    protected Store $session;
+    protected Oauth2Provider $oauthProvider;
+
+    public function __construct()
+    {
+        $this->session = app(Store::class);
+        $this->oauthProvider = app(Oauth2Provider::class);
+    }
+
+    abstract protected function data(string $key = null);
+
+    public function getAccessToken(): string
+    {
+        return $this->data('token');
+    }
+
+    public function getRefreshToken(): string
+    {
+        return $this->data('refresh_token');
+    }
+
+    public function getTenants(): ?array
+    {
+        return $this->data('tenants');
+    }
+
+    public function getTenantId(int $tenant = 0): string
+    {
+        if (! isset($this->data('tenants')[$tenant])) {
+            throw new XeroTenantNotFound('No such tenant exists');
+        }
+
+        return $this->data('tenants')[$tenant]['Id'];
+    }
+
+    public function getExpires(): int
+    {
+        return $this->data('expires');
+    }
+
+    public function getData(): array
+    {
+        return $this->data();
+    }
+
+    public function getUser(): ?array
+    {
+        try {
+            $jwt = new JWTClaims();
+            $jwt->setTokenId($this->data('id_token'));
+            $decodedToken = $jwt->decode();
+
+            return [
+                'given_name' => $decodedToken->getGivenName(),
+                'family_name' => $decodedToken->getFamilyName(),
+                'email' => $decodedToken->getEmail(),
+                'user_id' => $decodedToken->getXeroUserId(),
+                'username' => $decodedToken->getPreferredUsername(),
+                'session_id' => $decodedToken->getGlobalSessionId(),
+            ];
+        } catch (\Throwable $e) {
+            return null;
+        }
+    }
+
+    public function isExpired(): bool
+    {
+        return time() >= $this->data('expires');
+    }
+
+    public function refresh(): void
+    {
+        $newAccessToken = $this->oauthProvider->getAccessToken('refresh_token', [
+            'grant_type' => 'refresh_token',
+            'refresh_token' => $this->getRefreshToken(),
+        ]);
+
+        $this->store($newAccessToken);
+    }
+
+    public function getState(): string
+    {
+        return $this->session->get('xero_oauth2_state') ?? '';
+    }
+
+    public function getAuthorizationUrl(): string
+    {
+        $redirectUrl = $this->oauthProvider->getAuthorizationUrl(['scope' => config('xero.oauth.scopes')]);
+        $this->session->put('xero_oauth2_state', $this->oauthProvider->getState());
+
+        return $redirectUrl;
+    }
+}