Merge pull request #62 from Sammyjo20/feature/oauth-2-boilerplate

Feature | OAuth2 Boilerplate

Author: Sammyjo20

composer.json

@@ -19,7 +19,8 @@
     "require": {
         "php": "^8.0",
         "guzzlehttp/guzzle": "^7.4",
-        "illuminate/support": "^8.0|^9.0"
+        "illuminate/support": "^8.0|^9.0",
+        "nesbot/carbon": "^2.58"
     },
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^3.5",

src/Exceptions/InvalidStateException.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Sammyjo20\Saloon\Exceptions;
+
+use Throwable;
+
+class InvalidStateException extends SaloonException
+{
+    public function __construct(string $message = null, int $code = 0, ?Throwable $previous = null)
+    {
+        parent::__construct($message ?? 'Invalid state.', $code, $previous);
+    }
+}

src/Exceptions/OAuthConfigValidationException.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Sammyjo20\Saloon\Exceptions;
+
+use \Exception;
+
+class OAuthConfigValidationException extends Exception
+{
+    //
+}

src/Helpers/OAuth2/OAuthConfig.php

@@ -0,0 +1,251 @@
+<?php
+
+namespace Sammyjo20\Saloon\Helpers\OAuth2;
+
+use Sammyjo20\Saloon\Exceptions\OAuthConfigValidationException;
+
+class OAuthConfig
+{
+    /**
+     * The Client ID
+     *
+     * @var string
+     */
+    protected string $clientId = '';
+
+    /**
+     * The Client Secret
+     *
+     * @var string
+     */
+    protected string $clientSecret = '';
+
+    /**
+     * The Redirect URI
+     *
+     * @var string
+     */
+    protected string $redirectUri = '';
+
+    /**
+     * The endpoint used for the authorization URL.
+     *
+     * @var string
+     */
+    protected string $authorizeEndpoint = 'authorize';
+
+    /**
+     * The endpoint used to create and refresh tokens.
+     *
+     * @var string
+     */
+    protected string $tokenEndpoint = 'token';
+
+    /**
+     * The endpoint used to retrieve user information.
+     *
+     * @var string
+     */
+    protected string $userEndpoint = 'user';
+
+    /**
+     * The default scopes that will be applied to every authorization URL.
+     *
+     * @var array
+     */
+    protected array $defaultScopes = [];
+
+    /**
+     * Create a new instance of the class.
+     *
+     * @return static
+     */
+    public static function make(): self
+    {
+        return new static;
+    }
+
+    /**
+     * Get the Client ID
+     *
+     * @return string
+     */
+    public function getClientId(): string
+    {
+        return $this->clientId;
+    }
+
+    /**
+     * Set the Client ID
+     *
+     * @param string $clientId
+     * @return OAuthConfig
+     */
+    public function setClientId(string $clientId): self
+    {
+        $this->clientId = $clientId;
+
+        return $this;
+    }
+
+    /**
+     * Get the Client Secret
+     *
+     * @return string
+     */
+    public function getClientSecret(): string
+    {
+        return $this->clientSecret;
+    }
+
+    /**
+     * Set the Client Secret
+     *
+     * @param string $clientSecret
+     * @return OAuthConfig
+     */
+    public function setClientSecret(string $clientSecret): self
+    {
+        $this->clientSecret = $clientSecret;
+
+        return $this;
+    }
+
+    /**
+     * Get the Redirect URI
+     *
+     * @return string
+     */
+    public function getRedirectUri(): string
+    {
+        return $this->redirectUri;
+    }
+
+    /**
+     * Set the Redirect URI
+     *
+     * @param string $redirectUri
+     * @return OAuthConfig
+     */
+    public function setRedirectUri(string $redirectUri): self
+    {
+        $this->redirectUri = $redirectUri;
+
+        return $this;
+    }
+
+    /**
+     * Get the authorization endpoint.
+     *
+     * @return string
+     */
+    public function getAuthorizeEndpoint(): string
+    {
+        return $this->authorizeEndpoint;
+    }
+
+    /**
+     * Set the authorization endpoint.
+     *
+     * @param string $authorizeEndpoint
+     * @return OAuthConfig
+     */
+    public function setAuthorizeEndpoint(string $authorizeEndpoint): self
+    {
+        $this->authorizeEndpoint = $authorizeEndpoint;
+
+        return $this;
+    }
+
+    /**
+     * Get the token endpoint.
+     *
+     * @return string
+     */
+    public function getTokenEndpoint(): string
+    {
+        return $this->tokenEndpoint;
+    }
+
+    /**
+     * Set the token endpoint.
+     *
+     * @param string $tokenEndpoint
+     * @return OAuthConfig
+     */
+    public function setTokenEndpoint(string $tokenEndpoint): self
+    {
+        $this->tokenEndpoint = $tokenEndpoint;
+
+        return $this;
+    }
+
+    /**
+     * Get the user endpoint.
+     *
+     * @return string
+     */
+    public function getUserEndpoint(): string
+    {
+        return $this->userEndpoint;
+    }
+
+    /**
+     * Set the user endpoint.
+     *
+     * @param string $userEndpoint
+     * @return OAuthConfig
+     */
+    public function setUserEndpoint(string $userEndpoint): self
+    {
+        $this->userEndpoint = $userEndpoint;
+
+        return $this;
+    }
+
+    /**
+     * Get the default scopes.
+     *
+     * @return array
+     */
+    public function getDefaultScopes(): array
+    {
+        return $this->defaultScopes;
+    }
+
+    /**
+     * Set the default scopes.
+     *
+     * @param array $defaultScopes
+     * @return OAuthConfig
+     */
+    public function setDefaultScopes(array $defaultScopes): self
+    {
+        $this->defaultScopes = $defaultScopes;
+
+        return $this;
+    }
+
+    /**
+     * Validate the OAuth2 config.
+     *
+     * @return bool
+     * @throws OAuthConfigValidationException
+     */
+    public function validate(): bool
+    {
+        if (empty($this->getClientId())) {
+            throw new OAuthConfigValidationException('The Client ID is empty or has not been provided.');
+        }
+
+        if (empty($this->getClientSecret())) {
+            throw new OAuthConfigValidationException('The Client Secret is empty or has not been provided.');
+        }
+
+        if (empty($this->getRedirectUri())) {
+            throw new OAuthConfigValidationException('The Redirect URI is empty or has not been provided.');
+        }
+
+        return true;
+    }
+}

src/Helpers/StateHelper.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Sammyjo20\Saloon\Helpers;
+
+use Illuminate\Support\Str;
+
+class StateHelper
+{
+    /**
+     * Generate a random string for the state.
+     *
+     * @return string
+     */
+    public static function createRandomState(): string
+    {
+        return Str::random(32);
+    }
+}

src/Helpers/URLHelper.php

@@ -17,4 +17,25 @@ public static function matches(string $pattern, string $value): bool
     {
         return Str::is(Str::start($pattern, '*'), $value);
     }
+
+    /**
+     * Join a base url and an endpoint together.
+     *
+     * @param string $baseUrl
+     * @param string $endpoint
+     * @return string
+     */
+    public static function join(string $baseUrl, string $endpoint): string
+    {
+        if ($endpoint !== '/') {
+            $endpoint = ltrim($endpoint, '/ ');
+        }
+
+        $requiresTrailingSlash = ! empty($endpoint) && $endpoint !== '/';
+
+        $baseEndpoint = rtrim($baseUrl, '/ ');
+        $baseEndpoint = $requiresTrailingSlash ? $baseEndpoint . '/' : $baseEndpoint;
+
+        return $baseEndpoint . $endpoint;
+    }
 }