Removing dependency to Nyholm implementation.

VincentChalnot · VincentChalnot · commit 1ad261926de7 · 2023-05-15T11:46:39.000+02:00
New OAuthTokenFactory, better decoupling.
Licence update, minor CS fixes.
Requiring PHP8.1
diff --git a/CleverAgeOAuthApiBundle.php b/CleverAgeOAuthApiBundle.php
@@ -1,6 +1,8 @@
 <?php
 /*
- * This file is part of the CleverAge/OAuthApiBundle package. * Copyright (C) 2017-2021 Clever-Age * For the full copyright and license information, please view the LICENSE
+ * This file is part of the CleverAge/OAuthApiBundle package.
+ * Copyright (C) 2017-2023 Clever-Age
+ * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
 declare(strict_types=1);
diff --git a/Client/ApiClient.php b/Client/ApiClient.php
@@ -1,6 +1,8 @@
 <?php
 /*
- * This file is part of the CleverAge/OAuthApiBundle package. * Copyright (C) 2017-2021 Clever-Age * For the full copyright and license information, please view the LICENSE
+ * This file is part of the CleverAge/OAuthApiBundle package.
+ * Copyright (C) 2017-2023 Clever-Age
+ * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
 declare(strict_types=1);
@@ -11,11 +13,11 @@
 use CleverAge\OAuthApiBundle\Exception\ApiRequestException;
 use CleverAge\OAuthApiBundle\Exception\RequestFailedException;
 use CleverAge\OAuthApiBundle\Request\ApiRequestInterface;
-use Nyholm\Psr7\Stream;
 use Psr\Http\Client\ClientInterface;
 use Psr\Http\Client\RequestExceptionInterface;
 use Psr\Http\Message\RequestFactoryInterface;
 use Psr\Http\Message\RequestInterface;
+use Psr\Http\Message\StreamFactoryInterface;
 use Psr\Log\LoggerInterface;
 use Symfony\Component\Serializer\SerializerInterface;
 
@@ -27,6 +29,7 @@ class ApiClient implements ApiClientInterface
     public function __construct(
         protected ClientInterface $client,
         protected RequestFactoryInterface $requestFactory,
+        protected StreamFactoryInterface $streamFactory,
         protected SerializerInterface $serializer,
         protected LoggerInterface $logger,
     ) {
@@ -77,7 +80,7 @@ protected function getRequest(ApiRequestInterface $apiRequest): RequestInterface
             $apiRequest->getSerializationContext()
         );
 
-        return $request->withBody(Stream::create($serializedContent));
+        return $request->withBody($this->streamFactory->createStream($serializedContent));
     }
 
     protected function getResponseData(
diff --git a/Client/ApiClientInterface.php b/Client/ApiClientInterface.php
@@ -1,6 +1,8 @@
 <?php
 /*
- * This file is part of the CleverAge/OAuthApiBundle package. * Copyright (C) 2017-2021 Clever-Age * For the full copyright and license information, please view the LICENSE
+ * This file is part of the CleverAge/OAuthApiBundle package.
+ * Copyright (C) 2017-2023 Clever-Age
+ * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
 declare(strict_types=1);
@@ -10,7 +12,7 @@
 use CleverAge\OAuthApiBundle\Request\ApiRequestInterface;
 
 /**
- * Base logic used to query a remote API object
+ * Base logic used to query a remote API object.
  */
 interface ApiClientInterface
 {
diff --git a/Client/CachedApiClient.php b/Client/CachedApiClient.php
@@ -1,6 +1,8 @@
 <?php
 /*
- * This file is part of the CleverAge/OAuthApiBundle package. * Copyright (C) 2017-2021 Clever-Age * For the full copyright and license information, please view the LICENSE
+ * This file is part of the CleverAge/OAuthApiBundle package.
+ * Copyright (C) 2017-2023 Clever-Age
+ * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
 declare(strict_types=1);
@@ -12,26 +14,29 @@
 use Psr\Http\Client\ClientInterface;
 use Psr\Http\Message\RequestFactoryInterface;
 use Psr\Http\Message\RequestInterface;
+use Psr\Http\Message\StreamFactoryInterface;
 use Psr\Log\LoggerInterface;
 use Symfony\Component\Serializer\SerializerInterface;
 use Symfony\Contracts\Cache\ItemInterface;
 use Symfony\Contracts\Cache\TagAwareCacheInterface;
 
 /**
- * Api client improved with caching capabilities
+ * Api client improved with caching capabilities.
  */
 class CachedApiClient extends ApiClient implements CachedApiClientInterface
 {
     public function __construct(
         ClientInterface $client,
         RequestFactoryInterface $requestFactory,
+        StreamFactoryInterface $streamFactory,
         SerializerInterface $serializer,
         LoggerInterface $logger,
         protected TagAwareCacheInterface $cache,
     ) {
         parent::__construct(
             client: $client,
             requestFactory: $requestFactory,
+            streamFactory: $streamFactory,
             serializer: $serializer,
             logger: $logger,
         );
diff --git a/Client/CachedApiClientInterface.php b/Client/CachedApiClientInterface.php
@@ -1,14 +1,16 @@
 <?php
 /*
- * This file is part of the CleverAge/OAuthApiBundle package. * Copyright (C) 2017-2021 Clever-Age * For the full copyright and license information, please view the LICENSE
+ * This file is part of the CleverAge/OAuthApiBundle package.
+ * Copyright (C) 2017-2023 Clever-Age
+ * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
 declare(strict_types=1);
 
 namespace CleverAge\OAuthApiBundle\Client;
 
 /**
- * Additional method to manage cache for API requests
+ * Additional method to manage cache for API requests.
  */
 interface CachedApiClientInterface extends ApiClientInterface
 {
diff --git a/Client/OAuthRequestFactory.php b/Client/OAuthRequestFactory.php
@@ -1,22 +1,24 @@
 <?php
 /*
- * This file is part of the CleverAge/OAuthApiBundle package. * Copyright (C) 2017-2021 Clever-Age * For the full copyright and license information, please view the LICENSE
+ * This file is part of the CleverAge/OAuthApiBundle package.
+ * Copyright (C) 2017-2023 Clever-Age
+ * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
 declare(strict_types=1);
 
 namespace CleverAge\OAuthApiBundle\Client;
 
 use CleverAge\OAuthApiBundle\Exception\OAuthAuthenticationException;
-use CleverAge\OAuthApiBundle\Token\OAuthToken;
+use CleverAge\OAuthApiBundle\Token\OAuthTokenFactoryInterface;
 use CleverAge\OAuthApiBundle\Token\OAuthTokenInterface;
-use Nyholm\Psr7\Stream;
 use Psr\Http\Client\ClientInterface;
 use Psr\Http\Message\RequestFactoryInterface;
 use Psr\Http\Message\RequestInterface;
+use Psr\Http\Message\StreamFactoryInterface;
 
 /**
- * Handles authentication token negotiation to simplify request creation
+ * Handles authentication token negotiation to simplify request creation.
  */
 class OAuthRequestFactory implements OAuthTokenAwareRequestFactoryInterface
 {
@@ -25,6 +27,8 @@ class OAuthRequestFactory implements OAuthTokenAwareRequestFactoryInterface
     public function __construct(
         protected ClientInterface $client,
         protected RequestFactoryInterface $requestFactory,
+        protected StreamFactoryInterface $streamFactory,
+        protected OAuthTokenFactoryInterface $tokenFactory,
         protected string $baseUrl,
         protected string $tokenRequestPath,
         protected array $authenticationParams,
@@ -41,18 +45,13 @@ public function createRequest(string $method, $uri): RequestInterface
     public function getToken(): OAuthTokenInterface
     {
         if (!$this->token) {
-            $this->token = $this->updateToken(
-                $this->createTokenRequest(),
-                static function (array $data) {
-                    return OAuthToken::createFromResponse($data);
-                }
-            );
+            $this->token = $this->updateToken($this->createTokenRequest());
         }
 
         return $this->token;
     }
 
-    protected function updateToken(RequestInterface $request, callable $method): OAuthTokenInterface
+    protected function updateToken(RequestInterface $request): OAuthTokenInterface
     {
         $response = $this->client->sendRequest($request);
         if (200 !== $response->getStatusCode()) {
@@ -70,7 +69,7 @@ protected function updateToken(RequestInterface $request, callable $method): OAu
         }
 
         try {
-            return $method($data);
+            return $this->tokenFactory->createToken($data);
         } catch (\Exception) {
             throw OAuthAuthenticationException::createFromTokenResponse($response, $this->tokenRequestPath);
         }
@@ -86,11 +85,10 @@ protected function createTokenRequest(): RequestInterface
         } elseif ('application/json' === $this->tokenRequestContentType) {
             $content = json_encode($this->authenticationParams, JSON_THROW_ON_ERROR);
         } else {
-            throw new \UnexpectedValueException(
-                "Unsupported token request content type {$this->tokenRequestContentType}"
-            );
+            $m = "Unsupported token request content type {$this->tokenRequestContentType}";
+            throw new \UnexpectedValueException($m);
         }
 
-        return $tokenRequest->withBody(Stream::create($content));
+        return $tokenRequest->withBody($this->streamFactory->createStream($content));
     }
 }
diff --git a/Client/OAuthTokenAwareRequestFactoryInterface.php b/Client/OAuthTokenAwareRequestFactoryInterface.php
@@ -1,6 +1,8 @@
 <?php
 /*
- * This file is part of the CleverAge/OAuthApiBundle package. * Copyright (C) 2017-2021 Clever-Age * For the full copyright and license information, please view the LICENSE
+ * This file is part of the CleverAge/OAuthApiBundle package.
+ * Copyright (C) 2017-2023 Clever-Age
+ * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
 declare(strict_types=1);
@@ -11,7 +13,7 @@
 use Psr\Http\Message\RequestFactoryInterface;
 
 /**
- * Defines an HTTP client that can provide an OAuth Token
+ * Defines an HTTP client that can provide an OAuth Token.
  */
 interface OAuthTokenAwareRequestFactoryInterface extends RequestFactoryInterface
 {
diff --git a/Exception/ApiDeserializationException.php b/Exception/ApiDeserializationException.php
@@ -1,14 +1,16 @@
 <?php
 /*
- * This file is part of the CleverAge/OAuthApiBundle package. * Copyright (C) 2017-2021 Clever-Age * For the full copyright and license information, please view the LICENSE
+ * This file is part of the CleverAge/OAuthApiBundle package.
+ * Copyright (C) 2017-2023 Clever-Age
+ * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
 declare(strict_types=1);
 
 namespace CleverAge\OAuthApiBundle\Exception;
 
 /**
- * Thrown when not able to deserialize a response from the API
+ * Thrown when not able to deserialize a response from the API.
  */
 class ApiDeserializationException extends \RuntimeException
 {
diff --git a/Exception/ApiRequestException.php b/Exception/ApiRequestException.php
@@ -1,14 +1,16 @@
 <?php
 /*
- * This file is part of the CleverAge/OAuthApiBundle package. * Copyright (C) 2017-2021 Clever-Age * For the full copyright and license information, please view the LICENSE
+ * This file is part of the CleverAge/OAuthApiBundle package.
+ * Copyright (C) 2017-2023 Clever-Age
+ * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
 declare(strict_types=1);
 
 namespace CleverAge\OAuthApiBundle\Exception;
 
 /**
- * Thrown when unable to request a remote API
+ * Thrown when unable to request a remote API.
  */
 class ApiRequestException extends \RuntimeException
 {
diff --git a/Exception/ClientRequestFailedException.php b/Exception/ClientRequestFailedException.php
@@ -1,6 +1,8 @@
 <?php
 /*
- * This file is part of the CleverAge/OAuthApiBundle package. * Copyright (C) 2017-2021 Clever-Age * For the full copyright and license information, please view the LICENSE
+ * This file is part of the CleverAge/OAuthApiBundle package.
+ * Copyright (C) 2017-2023 Clever-Age
+ * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
 declare(strict_types=1);
diff --git a/Exception/MissingResponseParameterException.php b/Exception/MissingResponseParameterException.php
@@ -0,0 +1,23 @@
+<?php
+/*
+ * This file is part of the CleverAge/OAuthApiBundle package.
+ * Copyright (C) 2017-2023 Clever-Age
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace CleverAge\OAuthApiBundle\Exception;
+
+class MissingResponseParameterException extends \RuntimeException
+{
+    public static function create(array $data, string $parameter, ?string $message = null): self
+    {
+        $message ??= 'Available parameters are '.implode(', ', array_keys($data));
+
+        return new self(
+            "Missing parameter '{$parameter}' in response: {$message}",
+        );
+    }
+}
diff --git a/Exception/OAuthAuthenticationException.php b/Exception/OAuthAuthenticationException.php
@@ -1,6 +1,8 @@
 <?php
 /*
- * This file is part of the CleverAge/OAuthApiBundle package. * Copyright (C) 2017-2021 Clever-Age * For the full copyright and license information, please view the LICENSE
+ * This file is part of the CleverAge/OAuthApiBundle package.
+ * Copyright (C) 2017-2023 Clever-Age
+ * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
 declare(strict_types=1);
@@ -10,7 +12,7 @@
 use Psr\Http\Message\ResponseInterface;
 
 /**
- * Thrown when unable to authenticate against the OAuth server API
+ * Thrown when unable to authenticate against the OAuth server API.
  */
 class OAuthAuthenticationException extends RequestFailedException
 {
diff --git a/Exception/RequestFailedException.php b/Exception/RequestFailedException.php
@@ -1,6 +1,8 @@
 <?php
 /*
- * This file is part of the CleverAge/OAuthApiBundle package. * Copyright (C) 2017-2021 Clever-Age * For the full copyright and license information, please view the LICENSE
+ * This file is part of the CleverAge/OAuthApiBundle package.
+ * Copyright (C) 2017-2023 Clever-Age
+ * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
 declare(strict_types=1);
diff --git a/Exception/ServerRequestFailedException.php b/Exception/ServerRequestFailedException.php
@@ -1,6 +1,8 @@
 <?php
 /*
- * This file is part of the CleverAge/OAuthApiBundle package. * Copyright (C) 2017-2021 Clever-Age * For the full copyright and license information, please view the LICENSE
+ * This file is part of the CleverAge/OAuthApiBundle package.
+ * Copyright (C) 2017-2023 Clever-Age
+ * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
 declare(strict_types=1);
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2015-2021 Clever-Age
+Copyright (c) 2017-2023 Clever-Age
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/Request/ApiRequest.php b/Request/ApiRequest.php
@@ -1,14 +1,16 @@
 <?php
 /*
- * This file is part of the CleverAge/OAuthApiBundle package. * Copyright (C) 2017-2021 Clever-Age * For the full copyright and license information, please view the LICENSE
+ * This file is part of the CleverAge/OAuthApiBundle package.
+ * Copyright (C) 2017-2023 Clever-Age
+ * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
 declare(strict_types=1);
 
 namespace CleverAge\OAuthApiBundle\Request;
 
 /**
- * Represents an API request for the ApiClient
+ * @see ApiRequestInterface
  */
 class ApiRequest implements ApiRequestInterface
 {
diff --git a/Request/ApiRequestInterface.php b/Request/ApiRequestInterface.php
@@ -1,14 +1,16 @@
 <?php
 /*
- * This file is part of the CleverAge/OAuthApiBundle package. * Copyright (C) 2017-2021 Clever-Age * For the full copyright and license information, please view the LICENSE
+ * This file is part of the CleverAge/OAuthApiBundle package.
+ * Copyright (C) 2017-2023 Clever-Age
+ * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
 declare(strict_types=1);
 
 namespace CleverAge\OAuthApiBundle\Request;
 
 /**
- * Represents an API request for the ApiClient
+ * Represents an API request for the ApiClient.
  */
 interface ApiRequestInterface
 {
diff --git a/Request/CachedApiRequest.php b/Request/CachedApiRequest.php
@@ -1,6 +1,8 @@
 <?php
 /*
- * This file is part of the CleverAge/OAuthApiBundle package. * Copyright (C) 2017-2021 Clever-Age * For the full copyright and license information, please view the LICENSE
+ * This file is part of the CleverAge/OAuthApiBundle package.
+ * Copyright (C) 2017-2023 Clever-Age
+ * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
 declare(strict_types=1);
diff --git a/Request/CachedApiRequestInterface.php b/Request/CachedApiRequestInterface.php
diff --git a/Token/OAuthToken.php b/Token/OAuthToken.php
diff --git a/Token/OAuthTokenFactory.php b/Token/OAuthTokenFactory.php
diff --git a/Token/OAuthTokenFactoryInterface.php b/Token/OAuthTokenFactoryInterface.php
diff --git a/Token/OAuthTokenInterface.php b/Token/OAuthTokenInterface.php
diff --git a/composer.json b/composer.json
