Merge pull request #48 from Sammyjo20/feature/authenticators

Feature | Authenticators

Author: Sammyjo20

src/Exceptions/MissingAuthenticatorException.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Sammyjo20\Saloon\Exceptions;
+
+class MissingAuthenticatorException extends SaloonException
+{
+}

src/Helpers/Keychain.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace Sammyjo20\Saloon\Http\Auth;
+
+use Sammyjo20\Saloon\Http\SaloonRequest;
+use Sammyjo20\Saloon\Interfaces\AuthenticatorInterface;
+
+class BasicAuthenticator implements AuthenticatorInterface
+{
+    /**
+     * @param string $username
+     * @param string $password
+     */
+    public function __construct(
+        public string $username,
+        public string $password,
+    ) {
+        //
+    }
+
+    /**
+     * Apply the authentication to the request.
+     *
+     * @param SaloonRequest $request
+     * @return void
+     */
+    public function set(SaloonRequest $request): void
+    {
+        $request->addConfig('auth', [$this->username, $this->password]);
+    }
+}

src/Http/Auth/BasicAuthenticator.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace Sammyjo20\Saloon\Http\Auth;
+
+use Sammyjo20\Saloon\Http\SaloonRequest;
+use Sammyjo20\Saloon\Interfaces\AuthenticatorInterface;
+
+class DigestAuthenticator implements AuthenticatorInterface
+{
+    /**
+     * @param string $username
+     * @param string $password
+     * @param string $digest
+     */
+    public function __construct(
+        public string $username,
+        public string $password,
+        public string $digest,
+    ) {
+        //
+    }
+
+    /**
+     * Apply the authentication to the request.
+     *
+     * @param SaloonRequest $request
+     * @return void
+     */
+    public function set(SaloonRequest $request): void
+    {
+        $request->addConfig('auth', [$this->username, $this->password, $this->digest]);
+    }
+}

src/Http/Auth/DigestAuthenticator.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace Sammyjo20\Saloon\Http\Auth;
+
+use Sammyjo20\Saloon\Http\SaloonRequest;
+use Sammyjo20\Saloon\Interfaces\AuthenticatorInterface;
+
+class TokenAuthenticator implements AuthenticatorInterface
+{
+    /**
+     * @param string $token
+     * @param string $prefix
+     */
+    public function __construct(
+        public string $token,
+        public string $prefix = 'Bearer'
+    ) {
+        //
+    }
+
+    /**
+     * Apply the authentication to the request.
+     *
+     * @param SaloonRequest $request
+     * @return void
+     */
+    public function set(SaloonRequest $request): void
+    {
+        $request->addHeader('Authorization', trim($this->prefix . ' ' . $this->token));
+    }
+}

src/Http/Auth/TokenAuthenticator.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Sammyjo20\Saloon\Interfaces;
+
+use Sammyjo20\Saloon\Http\SaloonRequest;
+
+interface AuthenticatorInterface
+{
+    /**
+     * Apply the authentication to the request.
+     *
+     * @param SaloonRequest $request
+     * @return void
+     */
+    public function set(SaloonRequest $request): void;
+}

src/Interfaces/AuthenticatorInterface.php

@@ -19,6 +19,7 @@
 use GuzzleHttp\Exception\BadResponseException;
 use Sammyjo20\Saloon\Traits\CollectsQueryParams;
 use Sammyjo20\Saloon\Traits\CollectsInterceptors;
+use Sammyjo20\Saloon\Interfaces\AuthenticatorInterface;
 use Sammyjo20\Saloon\Exceptions\SaloonMultipleMockMethodsException;
 use Sammyjo20\Saloon\Exceptions\SaloonInvalidResponseClassException;
 use Sammyjo20\Saloon\Exceptions\SaloonNoMockResponsesProvidedException;
@@ -107,9 +108,9 @@ public function hydrate(): void
         $this->connector->boot($this->request);
         $this->request->boot($this->request);
 
-        // Now let's run our keychain boot method
+        // Now let's run our authenticator if one is present.
 
-        $this->request->bootKeychain($this->request);
+        $this->authenticateRequest();
 
         // Merge in response interceptors now
 
@@ -322,4 +323,20 @@ public function getRequest(): SaloonRequest
     {
         return $this->request;
     }
+
+    /**
+     * Authenticate the request by running the authenticator if it is present.
+     *
+     * @return void
+     */
+    private function authenticateRequest(): void
+    {
+        $authenticator = $this->request->getAuthenticator() ?? $this->connector->getAuthenticator();
+
+        if (! $authenticator instanceof AuthenticatorInterface) {
+            return;
+        }
+
+        $authenticator->set($this->request);
+    }
 }

src/Interfaces/KeychainInterface.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace Sammyjo20\Saloon\Traits\Auth;
+
+use Sammyjo20\Saloon\Http\SaloonRequest;
+use Sammyjo20\Saloon\Interfaces\AuthenticatorInterface;
+use Sammyjo20\Saloon\Exceptions\MissingAuthenticatorException;
+
+trait RequiresAuth
+{
+    /**
+     * Throw an exception if an authenticator is not on the request while it is booting.
+     *
+     * @param SaloonRequest $request
+     * @return void
+     * @throws MissingAuthenticatorException
+     * @throws \Sammyjo20\Saloon\Exceptions\SaloonInvalidConnectorException
+     */
+    public function bootRequiresAuth(SaloonRequest $request): void
+    {
+        $connector = $request->getAuthenticator() ?? $request->getConnector()->getAuthenticator();
+
+        if (! $connector instanceof AuthenticatorInterface) {
+            throw new MissingAuthenticatorException($this->getRequiresAuthMessage($request));
+        }
+    }
+
+    /**
+     * Default message.
+     *
+     * @param SaloonRequest $request
+     * @return string
+     */
+    protected function getRequiresAuthMessage(SaloonRequest $request): string
+    {
+        return sprintf('The "%s" request requires authentication. Please provide an authenticator using the `withAuth` method or return a default authenticator in your connector/request.', $request::class);
+    }
+}

src/Managers/RequestManager.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace Sammyjo20\Saloon\Traits\Auth;
+
+use Sammyjo20\Saloon\Http\SaloonRequest;
+use Sammyjo20\Saloon\Exceptions\MissingAuthenticatorException;
+
+trait RequiresBasicAuth
+{
+    use RequiresAuth;
+
+    /**
+     * @throws MissingAuthenticatorException
+     * @throws \Sammyjo20\Saloon\Exceptions\SaloonInvalidConnectorException
+     */
+    public function bootRequiresBasicAuth(SaloonRequest $request): void
+    {
+        $this->bootRequiresAuth($request);
+    }
+
+    /**
+     * Default message.
+     *
+     * @param SaloonRequest $request
+     * @return string
+     */
+    protected function getRequiresAuthMessage(SaloonRequest $request): string
+    {
+        return sprintf('The "%s" request requires authentication. Please provide authentication using the `withBasicAuth` method or return a default authenticator in your connector/request.', $request::class);
+    }
+}