Merge pull request #14 from sveldhuisen/master

BenjaminFavre · web-flow · commit 6e507308157c · 2025-07-07T09:52:15.000+02:00
Make OAuth 2 decorator compatible with PHP 8.4
diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
@@ -15,7 +15,7 @@ jobs:
         strategy:
             matrix:
                 php-version:
-                    - "8.0"
+                    - "8.4"
 
                 dependencies:
                     - "highest"
@@ -53,11 +53,9 @@ jobs:
         strategy:
             matrix:
                 php-version:
-                    - "8.0"
-                    - "8.1"
+                    - "8.4"
 
                 dependencies:
-                    - "lowest"
                     - "highest"
 
         steps:
@@ -91,11 +89,9 @@ jobs:
         strategy:
             matrix:
                 php-version:
-                    - "8.0"
-                    - "8.1"
+                    - "8.4"
 
                 dependencies:
-                    - "lowest"
                     - "highest"
 
         steps:
diff --git a/composer.json b/composer.json
@@ -27,7 +27,7 @@
         "sylius-labs/coding-standard": "^4.2",
         "symfony/cache": "^6.0",
         "symfony/http-client": "^6.0",
-        "vimeo/psalm": "^4.26"
+        "vimeo/psalm": "^6.9.4"
     },
     "provide": {
         "symfony/http-client-implementation": "^2.3.1"
diff --git a/psalm.xml b/psalm.xml
@@ -4,7 +4,7 @@
     errorLevel="1"
     xmlns="https://getpsalm.org/schema/config"
     xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
-    phpVersion="8.1"
+    phpVersion="8.4"
 >
     <projectFiles>
         <directory name="src"/>
diff --git a/src/Exception/OAuthException.php b/src/Exception/OAuthException.php
@@ -8,6 +8,7 @@
 
 /**
  * Represents errors during OAuth protocol.
+ * @psalm-api
  */
 class OAuthException extends RuntimeException implements OAuthExceptionInterface
 {
diff --git a/src/GrantType/AuthorizationCodeGrantType.php b/src/GrantType/AuthorizationCodeGrantType.php
@@ -9,6 +9,7 @@
 
 /**
  * Implementation of the OAuth authorization grant type.
+ * @psalm-api
  */
 class AuthorizationCodeGrantType implements RefreshableGrantTypeInterface
 {
@@ -50,6 +51,7 @@ public function __construct(
      *
      * @throws TransportExceptionInterface
      */
+    #[\Override]
     public function getTokens(): Tokens
     {
         $response = $this->client->request('POST', $this->tokenUrl, [
@@ -64,6 +66,7 @@ public function getTokens(): Tokens
         return $this->extractTokens($response);
     }
 
+    #[\Override]
     public function getRefreshTokenGrant(string $refreshToken): GrantTypeInterface
     {
         return new RefreshTokenGrantType($this->client, $this->tokenUrl, $refreshToken, $this->clientId, $this->clientSecret);
diff --git a/src/GrantType/ClientCredentialsGrantType.php b/src/GrantType/ClientCredentialsGrantType.php
@@ -9,6 +9,7 @@
 
 /**
  * Implementation of the OAuth client credentials grant type.
+ * @psalm-api
  */
 class ClientCredentialsGrantType implements GrantTypeInterface
 {
@@ -45,6 +46,7 @@ public function __construct(
      *
      * @throws TransportExceptionInterface
      */
+    #[\Override]
     public function getTokens(): Tokens
     {
         $response = $this->client->request('POST', $this->tokenUrl, [
diff --git a/src/GrantType/PasswordGrantType.php b/src/GrantType/PasswordGrantType.php
@@ -9,6 +9,7 @@
 
 /**
  * Implementation of the OAuth password grant type.
+ * @psalm-api
  */
 class PasswordGrantType implements GrantTypeInterface
 {
@@ -55,6 +56,7 @@ public function __construct(
      *
      * @throws TransportExceptionInterface
      */
+    #[\Override]
     public function getTokens(): Tokens
     {
         $parameters = [
diff --git a/src/GrantType/RefreshTokenGrantType.php b/src/GrantType/RefreshTokenGrantType.php
@@ -9,6 +9,7 @@
 
 /**
  * Implementation of the OAuth refresh token grant type.
+ * @psalm-api
  */
 class RefreshTokenGrantType implements GrantTypeInterface
 {
@@ -50,6 +51,7 @@ public function __construct(
      *
      * @throws TransportExceptionInterface
      */
+    #[\Override]
     public function getTokens(): Tokens
     {
         $response = $this->client->request('POST', $this->tokenUrl, [
diff --git a/src/GrantType/Tokens.php b/src/GrantType/Tokens.php
@@ -6,6 +6,7 @@
 
 /**
  * Value object for an access token and a refresh token.
+ * @psalm-api
  */
 class Tokens
 {
diff --git a/src/OAuthHttpClient.php b/src/OAuthHttpClient.php
@@ -40,27 +40,37 @@ public function __construct(
         $this->cache = new MemoryTokensCache();
     }
 
+    /**
+     * @psalm-api
+     */
     public function setSigner(RequestSignerInterface $signer): self
     {
         $this->signer = $signer;
 
         return $this;
     }
 
+    /**
+     * @psalm-api
+     */
     public function setChecker(ResponseCheckerInterface $checker): self
     {
         $this->checker = $checker;
 
         return $this;
     }
 
+    /**
+     * @psalm-api
+     */
     public function setCache(TokensCacheInterface $cache): self
     {
         $this->cache = $cache;
 
         return $this;
     }
 
+    #[\Override]
     public function request(string $method, string $url, array $options = []): ResponseInterface
     {
         $grant = $this->grant;
@@ -84,11 +94,13 @@ public function request(string $method, string $url, array $options = []): Respo
         throw new RuntimeException();
     }
 
-    public function stream($responses, float $timeout = null): ResponseStreamInterface
+    #[\Override]
+    public function stream($responses, ?float $timeout = null): ResponseStreamInterface
     {
         return $this->client->stream($responses, $timeout);
     }
 
+    #[\Override]
     public function withOptions(array $options): static
     {
         return new self($this->client->withOptions($options), $this->grant);
diff --git a/src/RequestSigner/BearerHeaderRequestSigner.php b/src/RequestSigner/BearerHeaderRequestSigner.php
@@ -4,6 +4,9 @@
 
 namespace BenjaminFavre\OAuthHttpClient\RequestSigner;
 
+/**
+ * @psalm-api
+ */
 class BearerHeaderRequestSigner extends HeaderRequestSigner
 {
     public function __construct()
diff --git a/src/RequestSigner/HeaderRequestSigner.php b/src/RequestSigner/HeaderRequestSigner.php
@@ -16,6 +16,7 @@ public function __construct(string $headerName, string $headerValueFormat)
         $this->headerValueFormat = $headerValueFormat;
     }
 
+    #[\Override]
     public function modify(array &$options, string $token): void
     {
         if (!array_key_exists('headers', $options)) {
diff --git a/src/ResponseChecker/StatusCode401ResponseChecker.php b/src/ResponseChecker/StatusCode401ResponseChecker.php
@@ -6,8 +6,12 @@
 
 use Symfony\Contracts\HttpClient\ResponseInterface;
 
+/**
+ * @psalm-api
+ */
 class StatusCode401ResponseChecker implements ResponseCheckerInterface
 {
+    #[\Override]
     public function hasAuthenticationFailed(ResponseInterface $response): bool
     {
         return $response->getStatusCode() === 401;
diff --git a/src/TokensCache/MemoryTokensCache.php b/src/TokensCache/MemoryTokensCache.php
@@ -7,10 +7,14 @@
 use BenjaminFavre\OAuthHttpClient\GrantType\GrantTypeInterface;
 use BenjaminFavre\OAuthHttpClient\GrantType\Tokens;
 
+/**
+ * @psalm-api
+ */
 class MemoryTokensCache implements TokensCacheInterface
 {
     private ?Tokens $tokens = null;
 
+    #[\Override]
     public function get(GrantTypeInterface $grant): Tokens
     {
         if ($this->tokens === null) {
@@ -20,6 +24,7 @@ public function get(GrantTypeInterface $grant): Tokens
         return $this->tokens;
     }
 
+    #[\Override]
     public function clear(): void
     {
         $this->tokens = null;
diff --git a/src/TokensCache/SymfonyTokensCacheAdapter.php b/src/TokensCache/SymfonyTokensCacheAdapter.php
@@ -9,6 +9,9 @@
 use RuntimeException;
 use Symfony\Contracts\Cache\CacheInterface;
 
+/**
+ * @psalm-api
+ */
 class SymfonyTokensCacheAdapter implements TokensCacheInterface
 {
     private CacheInterface $cache;
@@ -21,6 +24,7 @@ public function __construct(CacheInterface $cache, string $cacheKey)
         $this->cacheKey = $cacheKey;
     }
 
+    #[\Override]
     public function get(GrantTypeInterface $grant): Tokens
     {
         $tokens = $this->cache->get($this->cacheKey, function () use ($grant) {
@@ -34,6 +38,7 @@ public function get(GrantTypeInterface $grant): Tokens
         return $tokens;
     }
 
+    #[\Override]
     public function clear(): void
     {
         $this->cache->delete($this->cacheKey);

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`	`errorLevel="1"`
`5`	`5`	`xmlns="https://getpsalm.org/schema/config"`
`6`	`6`	`xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"`
`7`		`- phpVersion="8.1"`
	`7`	`+ phpVersion="8.4"`
`8`	`8`	`>`
`9`	`9`	`<projectFiles>`
`10`	`10`	`<directory name="src"/>`
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@`
`8`	`8`
`9`	`9`	`/**`
`10`	`10`	`* Represents errors during OAuth protocol.`
	`11`	`+ * @psalm-api`
`11`	`12`	`*/`
`12`	`13`	`class OAuthException extends RuntimeException implements OAuthExceptionInterface`
`13`	`14`	`{`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@`
`9`	`9`
`10`	`10`	`/**`
`11`	`11`	`* Implementation of the OAuth authorization grant type.`
	`12`	`+ * @psalm-api`
`12`	`13`	`*/`
`13`	`14`	`class AuthorizationCodeGrantType implements RefreshableGrantTypeInterface`
`14`	`15`	`{`
`@@ -50,6 +51,7 @@ public function __construct(`
`50`	`51`	`*`
`51`	`52`	`* @throws TransportExceptionInterface`
`52`	`53`	`*/`
	`54`	`+ #[\Override]`
`53`	`55`	`public function getTokens(): Tokens`
`54`	`56`	`{`
`55`	`57`	`$response = $this->client->request('POST', $this->tokenUrl, [`
`@@ -64,6 +66,7 @@ public function getTokens(): Tokens`
`64`	`66`	`return $this->extractTokens($response);`
`65`	`67`	`}`
`66`	`68`
	`69`	`+ #[\Override]`
`67`	`70`	`public function getRefreshTokenGrant(string $refreshToken): GrantTypeInterface`
`68`	`71`	`{`
`69`	`72`	`return new RefreshTokenGrantType($this->client, $this->tokenUrl, $refreshToken, $this->clientId, $this->clientSecret);`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@`
`6`	`6`
`7`	`7`	`/**`
`8`	`8`	`* Value object for an access token and a refresh token.`
	`9`	`+ * @psalm-api`
`9`	`10`	`*/`
`10`	`11`	`class Tokens`
`11`	`12`	`{`
Original file line number	Diff line number	Diff line change
`@@ -40,27 +40,37 @@ public function __construct(`
`40`	`40`	`$this->cache = new MemoryTokensCache();`
`41`	`41`	`}`
`42`	`42`
	`43`	`+ /**`
	`44`	`+ * @psalm-api`
	`45`	`+ */`
`43`	`46`	`public function setSigner(RequestSignerInterface $signer): self`
`44`	`47`	`{`
`45`	`48`	`$this->signer = $signer;`
`46`	`49`
`47`	`50`	`return $this;`
`48`	`51`	`}`
`49`	`52`
	`53`	`+ /**`
	`54`	`+ * @psalm-api`
	`55`	`+ */`
`50`	`56`	`public function setChecker(ResponseCheckerInterface $checker): self`
`51`	`57`	`{`
`52`	`58`	`$this->checker = $checker;`
`53`	`59`
`54`	`60`	`return $this;`
`55`	`61`	`}`
`56`	`62`
	`63`	`+ /**`
	`64`	`+ * @psalm-api`
	`65`	`+ */`
`57`	`66`	`public function setCache(TokensCacheInterface $cache): self`
`58`	`67`	`{`
`59`	`68`	`$this->cache = $cache;`
`60`	`69`
`61`	`70`	`return $this;`
`62`	`71`	`}`
`63`	`72`
	`73`	`+ #[\Override]`
`64`	`74`	`public function request(string $method, string $url, array $options = []): ResponseInterface`
`65`	`75`	`{`
`66`	`76`	`$grant = $this->grant;`
`@@ -84,11 +94,13 @@ public function request(string $method, string $url, array $options = []): Respo`
`84`	`94`	`throw new RuntimeException();`
`85`	`95`	`}`
`86`	`96`
`87`		`- public function stream($responses, float $timeout = null): ResponseStreamInterface`
	`97`	`+ #[\Override]`
	`98`	`+ public function stream($responses, ?float $timeout = null): ResponseStreamInterface`
`88`	`99`	`{`
`89`	`100`	`return $this->client->stream($responses, $timeout);`
`90`	`101`	`}`
`91`	`102`
	`103`	`+ #[\Override]`
`92`	`104`	`public function withOptions(array $options): static`
`93`	`105`	`{`
`94`	`106`	`return new self($this->client->withOptions($options), $this->grant);`