Merge pull request #63 from Sammyjo20/feature/authentication-alias

Feature | Spring cleaning & added authentication alias

Author: Sammyjo20

src/Http/SaloonConnector.php

@@ -2,37 +2,35 @@
 
 namespace Sammyjo20\Saloon\Http;
 
-use Illuminate\Support\Collection;
 use GuzzleHttp\Promise\PromiseInterface;
 use Sammyjo20\Saloon\Clients\MockClient;
 use Sammyjo20\Saloon\Traits\CollectsData;
 use Sammyjo20\Saloon\Traits\MocksRequests;
-use Sammyjo20\Saloon\Helpers\RequestHelper;
 use Sammyjo20\Saloon\Traits\CollectsConfig;
 use Sammyjo20\Saloon\Traits\CollectsHeaders;
+use Sammyjo20\Saloon\Traits\GuessesRequests;
 use Sammyjo20\Saloon\Traits\CollectsHandlers;
-use Sammyjo20\Saloon\Helpers\ReflectionHelper;
 use Sammyjo20\Saloon\Traits\HasCustomResponses;
 use Sammyjo20\Saloon\Traits\CollectsQueryParams;
 use Sammyjo20\Saloon\Traits\CollectsInterceptors;
 use Sammyjo20\Saloon\Traits\AuthenticatesRequests;
-use Sammyjo20\Saloon\Helpers\ProxyRequestNameHelper;
 use Sammyjo20\Saloon\Exceptions\ClassNotFoundException;
 use Sammyjo20\Saloon\Interfaces\SaloonConnectorInterface;
 use Sammyjo20\Saloon\Exceptions\SaloonInvalidRequestException;
 use Sammyjo20\Saloon\Exceptions\SaloonConnectorMethodNotFoundException;
 
 abstract class SaloonConnector implements SaloonConnectorInterface
 {
-    use CollectsHeaders,
-        CollectsData,
-        CollectsQueryParams,
-        CollectsConfig,
-        CollectsHandlers,
-        CollectsInterceptors,
-        AuthenticatesRequests,
-        HasCustomResponses,
-        MocksRequests;
+    use CollectsHeaders;
+    use CollectsData;
+    use CollectsQueryParams;
+    use CollectsConfig;
+    use CollectsHandlers;
+    use CollectsInterceptors;
+    use AuthenticatesRequests;
+    use HasCustomResponses;
+    use MocksRequests;
+    use GuessesRequests;
 
     /**
      * Register Saloon requests that will become methods on the connector.
@@ -42,24 +40,6 @@ abstract class SaloonConnector implements SaloonConnectorInterface
      */
     protected array $requests = [];
 
-    /**
-     * Requests that have already been registered. Used as a cache for performance.
-     *
-     * @var array|null
-     */
-    private ?array $registeredRequests = null;
-
-    /**
-     * Instantiate a new class with the arguments.
-     *
-     * @param mixed ...$arguments
-     * @return SaloonConnector
-     */
-    public static function make(...$arguments): static
-    {
-        return new static(...$arguments);
-    }
-
     /**
      * Define anything that should be added to any requests
      * with this connector before the request is sent.
@@ -72,53 +52,6 @@ public function boot(SaloonRequest $request): void
         //
     }
 
-    /**
-     * Attempt to create a request and forward parameters to it.
-     *
-     * @param string $request
-     * @param array $args
-     * @return SaloonRequest
-     * @throws SaloonInvalidRequestException
-     * @throws \ReflectionException
-     */
-    protected function forwardCallToRequest(string $request, array $args = []): SaloonRequest
-    {
-        return RequestHelper::callFromConnector($this, $request, $args);
-    }
-
-    /**
-     * Bootstrap and get the registered requests in the $requests array.
-     *
-     * @return array
-     * @throws \ReflectionException
-     */
-    public function getRegisteredRequests(): array
-    {
-        if (empty($this->requests)) {
-            return [];
-        }
-
-        if (is_array($this->registeredRequests)) {
-            return $this->registeredRequests;
-        }
-
-        $this->registeredRequests = ProxyRequestNameHelper::generateNames($this->requests);
-
-        return $this->registeredRequests;
-    }
-
-    /**
-     * Check if a given request method exists
-     *
-     * @param string $method
-     * @return bool
-     * @throws \ReflectionException
-     */
-    public function requestExists(string $method): bool
-    {
-        return method_exists($this, $method) || array_key_exists($method, $this->getRegisteredRequests());
-    }
-
     /**
      * Prepare a new request by providing it the current instance of the connector.
      *
@@ -190,48 +123,13 @@ public static function __callStatic($method, $arguments)
     }
 
     /**
-     * Attempt to guess the next request.
+     * Instantiate a new class with the arguments.
      *
-     * @param $method
-     * @param $arguments
-     * @return mixed
-     * @throws ClassNotFoundException
-     * @throws SaloonConnectorMethodNotFoundException
-     * @throws SaloonInvalidRequestException
-     * @throws \ReflectionException
+     * @param mixed ...$arguments
+     * @return SaloonConnector
      */
-    protected function guessRequest($method, $arguments): mixed
+    public static function make(...$arguments): static
     {
-        if ($this->requestExists($method) === false) {
-            throw new SaloonConnectorMethodNotFoundException($method, $this);
-        }
-
-        $requests = $this->getRegisteredRequests();
-
-        // Work out what it is. If it is an array, pass the array into AnonymousRequestCollection($requests)
-        // If it is a request, just forward the call to the request.
-
-        $resource = $requests[$method];
-
-        // If the request is a type of array, then it must be an anonymous request collection.
-
-        if (is_array($resource)) {
-            return new AnonymousRequestCollection($this, $method, $resource);
-        }
-
-        // Otherwise, check if it is a RequestCollection. If it is, then
-        // return that class - otherwise, just forward the request.
-
-        if (! class_exists($resource)) {
-            throw new ClassNotFoundException($resource);
-        }
-
-        if (ReflectionHelper::isSubclassOf($resource, RequestCollection::class)) {
-            return new $resource($this);
-        }
-
-        // It's just a request, so forward to that.
-
-        return $this->forwardCallToRequest($resource, $arguments);
+        return new static(...$arguments);
     }
 }

src/Http/SaloonRequest.php

@@ -20,16 +20,16 @@
 
 abstract class SaloonRequest implements SaloonRequestInterface
 {
-    use CollectsData,
-        CollectsQueryParams,
-        CollectsHeaders,
-        CollectsConfig,
-        CollectsHandlers,
-        CollectsInterceptors,
-        AuthenticatesRequests,
-        HasCustomResponses,
-        SendsRequests,
-        MocksRequests;
+    use CollectsData;
+    use CollectsQueryParams;
+    use CollectsHeaders;
+    use CollectsConfig;
+    use CollectsHandlers;
+    use CollectsInterceptors;
+    use AuthenticatesRequests;
+    use HasCustomResponses;
+    use SendsRequests;
+    use MocksRequests;
 
     /**
      * Define the method that the request will use.
@@ -62,17 +62,6 @@ public function defineEndpoint(): string
         return '';
     }
 
-    /**
-     * Instantiate a new class with the arguments.
-     *
-     * @param mixed ...$arguments
-     * @return SaloonRequest
-     */
-    public static function make(...$arguments): static
-    {
-        return new static(...$arguments);
-    }
-
     /**
      * Define anything that should be added to the request
      * before it is sent.
@@ -126,6 +115,7 @@ private function bootConnector(): void
      *
      * @return SaloonConnector
      * @throws SaloonInvalidConnectorException
+     * @throws \ReflectionException
      */
     public function getConnector(): SaloonConnector
     {
@@ -153,7 +143,7 @@ public function setConnector(SaloonConnector $connector): static
      * Build up the final request URL.
      *
      * @return string
-     * @throws SaloonInvalidConnectorException
+     * @throws SaloonInvalidConnectorException|\ReflectionException
      */
     public function getFullRequestUrl(): string
     {
@@ -168,7 +158,7 @@ public function getFullRequestUrl(): string
      *
      * @param string $trait
      * @return bool
-     * @throws SaloonInvalidConnectorException
+     * @throws SaloonInvalidConnectorException|\ReflectionException
      */
     public function traitExistsOnConnector(string $trait): bool
     {
@@ -181,7 +171,8 @@ public function traitExistsOnConnector(string $trait): bool
      * @param $method
      * @param $parameters
      * @return mixed
-     * @throws SaloonMethodNotFoundException
+     * @throws SaloonInvalidConnectorException
+     * @throws SaloonMethodNotFoundException|\ReflectionException
      */
     public function __call($method, $parameters)
     {
@@ -191,4 +182,15 @@ public function __call($method, $parameters)
 
         return $this->getConnector()->{$method}(...$parameters);
     }
+
+    /**
+     * Instantiate a new class with the arguments.
+     *
+     * @param mixed ...$arguments
+     * @return SaloonRequest
+     */
+    public static function make(...$arguments): static
+    {
+        return new static(...$arguments);
+    }
 }

src/Traits/AuthenticatesRequests.php

@@ -42,21 +42,32 @@ public function getAuthenticator(): ?AuthenticatorInterface
      * @param AuthenticatorInterface $authenticator
      * @return $this
      */
-    public function withAuth(AuthenticatorInterface $authenticator): self
+    public function withAuth(AuthenticatorInterface $authenticator): static
     {
         $this->authenticator = $authenticator;
 
         return $this;
     }
 
+    /**
+     * Register an authenticator
+     *
+     * @param AuthenticatorInterface $authenticator
+     * @return $this
+     */
+    public function authenticate(AuthenticatorInterface $authenticator): static
+    {
+        return $this->withAuth($authenticator);
+    }
+
     /**
      * Attach an Authorization token to the request.
      *
      * @param string $token
      * @param string $prefix
      * @return $this
      */
-    public function withTokenAuth(string $token, string $prefix = 'Bearer'): self
+    public function withTokenAuth(string $token, string $prefix = 'Bearer'): static
     {
         return $this->withAuth(new TokenAuthenticator($token, $prefix));
     }
@@ -68,7 +79,7 @@ public function withTokenAuth(string $token, string $prefix = 'Bearer'): self
      * @param string $password
      * @return $this
      */
-    public function withBasicAuth(string $username, string $password): self
+    public function withBasicAuth(string $username, string $password): static
     {
         return $this->withAuth(new BasicAuthenticator($username, $password));
     }
@@ -81,7 +92,7 @@ public function withBasicAuth(string $username, string $password): self
      * @param string $digest
      * @return $this
      */
-    public function withDigestAuth(string $username, string $password, string $digest): self
+    public function withDigestAuth(string $username, string $password, string $digest): static
     {
         return $this->withAuth(new DigestAuthenticator($username, $password, $digest));
     }

src/Traits/CollectsConfig.php

@@ -36,7 +36,7 @@ public function defaultConfig(): array
      * @param mixed ...$configCollection
      * @return $this
      */
-    public function mergeConfig(array ...$configCollection): self
+    public function mergeConfig(array ...$configCollection): static
     {
         foreach ($configCollection as $config) {
             $this->customConfig = array_merge($this->customConfig, $config);
@@ -52,7 +52,7 @@ public function mergeConfig(array ...$configCollection): self
      * @param array $config
      * @return $this
      */
-    public function setConfig(array $config): self
+    public function setConfig(array $config): static
     {
         $this->ignoreDefaultConfig();
 
@@ -68,7 +68,7 @@ public function setConfig(array $config): self
      * @param $value
      * @return $this
      */
-    public function addConfig(string $item, $value): self
+    public function addConfig(string $item, $value): static
     {
         $this->customConfig[$item] = $value;
 
@@ -99,7 +99,7 @@ public function getConfig(string $key = null): mixed
      *
      * @return $this
      */
-    public function ignoreDefaultConfig(): self
+    public function ignoreDefaultConfig(): static
     {
         $this->includeDefaultConfig = false;