Merge pull request #2 from VincentChalnot/v2.x

New v2.0 version for Sf5+ and PHP8.1, better overall exception management and token retrieval.

Author: xaviermarchegay

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);

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(

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
 {

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,
         );
@@ -80,13 +85,11 @@ protected function getCacheKey(RequestInterface $request, bool $private): string
     {
         $subCacheKey = $request->getMethod().$request->getUri().$request->getBody();
         if ($private) {
-            $client = $this->client;
-            if (!$client instanceof OAuthTokenAwareRequestFactoryInterface) {
+            if (!$this->requestFactory instanceof OAuthTokenAwareRequestFactoryInterface) {
                 throw new \UnexpectedValueException('Unable to store private API cache, no private token available');
             }
-
             // Append authorization token to cache key if private
-            $subCacheKey .= $client->getToken()->getAuthorization();
+            $subCacheKey .= $this->requestFactory->getToken()->getAuthorization();
         }
 
         return sha1($subCacheKey);
@@ -97,12 +100,12 @@ protected function convertTags(array $tags, bool $private): array
         if (!$private) {
             return $tags;
         }
-        if (!$this->client instanceof OAuthTokenAwareRequestFactoryInterface) {
+        if (!$this->requestFactory instanceof OAuthTokenAwareRequestFactoryInterface) {
             throw new \UnexpectedValueException('Unable to store private API cache, no private token available');
         }
 
         // Append authorization token to cache key if private
-        $subCacheKey = $this->client->getToken()->getAuthorization();
+        $subCacheKey = $this->requestFactory->getToken()->getAuthorization();
         $privateTags = [];
         foreach ($tags as $tag) {
             $privateTags[] = $tag.'_'.$subCacheKey;

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
 {

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,9 +27,12 @@ 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,
+        protected string $tokenRequestContentType = 'application/json',
     ) {
     }
 
@@ -40,20 +45,18 @@ 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()) {
+            throw OAuthAuthenticationException::createFromTokenResponse($response, $this->tokenRequestPath);
+        }
 
         $content = (string) $response->getBody();
         if (!$content) {
@@ -66,16 +69,26 @@ 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);
         }
     }
 
     protected function createTokenRequest(): RequestInterface
     {
-        return $this->requestFactory->createRequest('POST', $this->baseUrl.$this->tokenRequestPath)
-            ->withHeader('Content-Type', 'application/x-www-form-urlencoded')
-            ->withBody(Stream::create(http_build_query($this->authenticationParams)));
+        $tokenRequest = $this->requestFactory->createRequest('POST', $this->baseUrl.$this->tokenRequestPath)
+            ->withHeader('Content-Type', $this->tokenRequestContentType);
+
+        if ('application/x-www-form-urlencoded' === $this->tokenRequestContentType) {
+            $content = http_build_query($this->authenticationParams);
+        } elseif ('application/json' === $this->tokenRequestContentType) {
+            $content = json_encode($this->authenticationParams, JSON_THROW_ON_ERROR);
+        } else {
+            $m = "Unsupported token request content type {$this->tokenRequestContentType}";
+            throw new \UnexpectedValueException($m);
+        }
+
+        return $tokenRequest->withBody($this->streamFactory->createStream($content));
     }
 }

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
 {

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
 {

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
 {

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);