Merge pull request #38 from flownative/task/raise-dependencies

Raise dependencies & code cleanup

Author: kdambekalns

Classes/Authorization.php

@@ -14,9 +14,6 @@
  */
 
 use Doctrine\ORM\Mapping as ORM;
-use Exception;
-use InvalidArgumentException;
-use JsonException;
 use League\OAuth2\Client\Token\AccessToken;
 use League\OAuth2\Client\Token\AccessTokenInterface;
 use Neos\Flow\Annotations as Flow;
@@ -89,13 +86,6 @@ class Authorization
      */
     protected $encryptionService;
 
-    /**
-     * @param string $authorizationId
-     * @param string $serviceName
-     * @param string $clientId
-     * @param string $grantType
-     * @param string $scope
-     */
     public function __construct(string $authorizationId, string $serviceName, string $clientId, string $grantType, string $scope)
     {
         $this->authorizationId = $authorizationId;
@@ -105,9 +95,6 @@ public function __construct(string $authorizationId, string $serviceName, string
         $this->scope = $scope;
     }
 
-    /**
-     * @param EncryptionService $encryptionService
-     */
     public function injectEncryptionService(EncryptionService $encryptionService): void
     {
         $this->encryptionService = $encryptionService;
@@ -116,128 +103,84 @@ public function injectEncryptionService(EncryptionService $encryptionService): v
     /**
      * Calculate an authorization identifier (for this model) from the given parameters.
      *
-     * @param string $serviceType
-     * @param string $serviceName
-     * @param string $clientId
-     * @return string
      * @throws OAuthClientException
      */
     public static function generateAuthorizationIdForAuthorizationCodeGrant(string $serviceType, string $serviceName, string $clientId): string
     {
         try {
             return $serviceType . '-' . $serviceName . '-' . Uuid::uuid4()->toString();
             // @codeCoverageIgnoreStart
-        } catch (Exception $e) {
+        } catch (\Exception $e) {
             throw new OAuthClientException(sprintf('Failed generating authorization id for %s %s', $serviceName, $clientId), 1597311416, $e);
         }
         // @codeCoverageIgnoreEnd
     }
 
     /**
      * Calculate an authorization identifier (for this model) from the given parameters.
-     *
-     * @param string $serviceName
-     * @param string $clientId
-     * @param string $clientSecret
-     * @param string $scope
-     * @param array $additionalParameters
-     * @return string
      */
     public static function generateAuthorizationIdForClientCredentialsGrant(string $serviceName, string $clientId, string $clientSecret, string $scope, array $additionalParameters = []): string
     {
         try {
             $additionalParametersJson = json_encode($additionalParameters, JSON_THROW_ON_ERROR);
-        } catch (JsonException $e) {
+        } catch (\JsonException) {
             $additionalParametersJson = '';
         }
         return hash('sha512', $serviceName . $clientId . $clientSecret . $scope . $additionalParametersJson . self::GRANT_CLIENT_CREDENTIALS);
     }
 
-    /**
-     * @return string
-     */
     public function getAuthorizationId(): string
     {
         return $this->authorizationId;
     }
 
-    /**
-     * @return string
-     */
     public function getServiceName(): string
     {
         return $this->serviceName;
     }
 
-    /**
-     * @return string
-     */
     public function getClientId(): string
     {
         return $this->clientId;
     }
 
-    /**
-     * @return string
-     */
     public function getGrantType(): string
     {
         return $this->grantType;
     }
 
-    /**
-     * @return string
-     * @return void
-     */
     public function getScope(): string
     {
         return $this->scope;
     }
 
-    /**
-     * @param string $scope
-     */
     public function setScope(string $scope): void
     {
         $this->scope = $scope;
     }
 
-    /**
-     * @return string
-     */
     public function getSerializedAccessToken(): string
     {
         return $this->serializedAccessToken ?? '';
     }
 
-    /**
-     * @param string $serializedAccessToken
-     */
     public function setSerializedAccessToken(string $serializedAccessToken): void
     {
         $this->serializedAccessToken = $serializedAccessToken;
     }
 
-    /**
-     * @return string
-     */
     public function getEncryptedSerializedAccessToken(): string
     {
         return $this->encryptedSerializedAccessToken ?? '';
     }
 
-    /**
-     * @param string $encryptedSerializedAccessToken
-     */
     public function setEncryptedSerializedAccessToken(string $encryptedSerializedAccessToken): void
     {
         $this->encryptedSerializedAccessToken = $encryptedSerializedAccessToken;
     }
 
     /**
-     * @param AccessTokenInterface $accessToken
-     * @return void
-     * @throws InvalidArgumentException
+     * @throws \InvalidArgumentException
      */
     public function setAccessToken(AccessTokenInterface $accessToken): void
     {
@@ -248,19 +191,19 @@ public function setAccessToken(AccessTokenInterface $accessToken): void
 
         try {
             if ($this->encryptionService !== null && $this->encryptionService->isConfigured()) {
-                $this->encryptedSerializedAccessToken = $this->encryptionService->encryptAndEncode(json_encode($accessToken, JSON_THROW_ON_ERROR, 512));
+                $this->encryptedSerializedAccessToken = $this->encryptionService->encryptAndEncode(json_encode($accessToken, JSON_THROW_ON_ERROR));
             } else {
-                $this->serializedAccessToken = json_encode($accessToken, JSON_THROW_ON_ERROR, 512);
+                $this->serializedAccessToken = json_encode($accessToken, JSON_THROW_ON_ERROR);
             }
             // @codeCoverageIgnoreStart
-        } catch (JsonException | Exception $e) {
-            throw new InvalidArgumentException('Failed serializing the given access token', 1602515717, $e);
+        } catch (\JsonException | \Exception $e) {
+            throw new \InvalidArgumentException('Failed serializing the given access token', 1602515717, $e);
             // @codeCoverageIgnoreEnd
         }
     }
 
     /**
-     * @return AccessToken
+     * @throws \SodiumException
      */
     public function getAccessToken(): ?AccessToken
     {
@@ -279,22 +222,16 @@ public function getAccessToken(): ?AccessToken
                 $deserializedAccessToken = json_decode($this->serializedAccessToken, true, 512, JSON_THROW_ON_ERROR);
                 return new AccessToken($deserializedAccessToken);
             }
-        } catch (JsonException $e) {
+        } catch (\JsonException) {
         }
         return null;
     }
 
-    /**
-     * @return \DateTimeImmutable
-     */
     public function getExpires(): ?\DateTimeImmutable
     {
         return $this->expires;
     }
 
-    /**
-     * @param \DateTimeImmutable $expires
-     */
     public function setExpires(\DateTimeImmutable $expires): void
     {
         $this->expires = $expires;

Classes/Command/OAuthCommandController.php

@@ -1,21 +1,17 @@
 <?php
+declare(strict_types=1);
+
 namespace Flownative\OAuth2\Client\Command;
 
 use Doctrine\ORM\EntityManagerInterface as DoctrineEntityManagerInterface;
-use Doctrine\ORM\OptimisticLockException;
-use Doctrine\ORM\ORMException;
-use Exception;
 use Flownative\OAuth2\Client\Authorization;
 use Flownative\OAuth2\Client\EncryptionService;
 use Neos\Flow\Cli\CommandController;
 use Neos\Flow\Persistence\Doctrine\Query;
 
 final class OAuthCommandController extends CommandController
 {
-    /**
-     * @var DoctrineEntityManagerInterface
-     */
-    protected $entityManager;
+    protected DoctrineEntityManagerInterface $entityManager;
 
     /**
      * @param DoctrineEntityManagerInterface $entityManager
@@ -34,6 +30,7 @@ public function injectEntityManager(DoctrineEntityManagerInterface $entityManage
      * a hash over service name, client id, grant type and scope.
      *
      * @return void
+     * @throws \SodiumException
      */
     public function listAuthorizationsCommand(): void
     {
@@ -95,8 +92,7 @@ public function removeAuthorizationsCommand(string $id = '', bool $all = false):
         }
         try {
             $this->entityManager->flush();
-        } catch (OptimisticLockException $e) {
-        } catch (ORMException $e) {
+        } catch (\Exception $e) {
             $this->outputLine('<error>Failed:</error> ' . $e->getMessage());
             exit(1);
         }
@@ -111,7 +107,7 @@ public function removeAuthorizationsCommand(string $id = '', bool $all = false):
      *
      * @param string $construction
      * @return void
-     * @throws Exception
+     * @throws \Exception
      */
     public function generateEncryptionKeyCommand(string $construction = 'ChaCha20-Poly1305-IETF'): void
     {

Classes/Controller/OAuthController.php

@@ -1,8 +1,11 @@
 <?php
+declare(strict_types=1);
+
 namespace Flownative\OAuth2\Client\Controller;
 
 use Flownative\OAuth2\Client\OAuthClient;
 use Flownative\OAuth2\Client\OAuthClientException;
+use GuzzleHttp\Exception\GuzzleException;
 use GuzzleHttp\Psr7\Uri;
 use Neos\Flow\Annotations\CompileStatic;
 use Neos\Flow\Mvc\Controller\ActionController;
@@ -13,10 +16,7 @@
 
 final class OAuthController extends ActionController
 {
-    /**
-     * @var array
-     */
-    private $serviceTypes;
+    private array $serviceTypes;
 
     /**
      * @return void
@@ -38,6 +38,7 @@ public function initializeObject(): void
      * @throws OAuthClientException
      * @throws StopActionException
      * @throws UnsupportedRequestTypeException
+     * @throws \DateMalformedStringException
      */
     public function startAuthorizationAction(string $clientId, string $clientSecret, Uri $returnToUri, string $serviceType, string $serviceName, string $scope): void
     {
@@ -66,6 +67,7 @@ public function startAuthorizationAction(string $clientId, string $clientSecret,
      * @throws OAuthClientException
      * @throws StopActionException
      * @throws UnsupportedRequestTypeException
+     * @throws GuzzleException
      */
     public function finishAuthorizationAction(string $serviceType, string $serviceName, string $state, string $code, string $scope = ''): void
     {

Classes/EncryptionService.php

@@ -1,8 +1,8 @@
 <?php
+declare(strict_types=1);
 
 namespace Flownative\OAuth2\Client;
 
-use Exception;
 use Neos\Flow\Annotations as Flow;
 
 /**
@@ -12,18 +12,11 @@ class EncryptionService {
 
     /**
      * @Flow\InjectConfiguration(path="encryption.base64EncodedKey")
-     * @var string
      */
-    protected $base64EncodedKey;
+    protected string $base64EncodedKey = '';
 
-    /**
-     * @var string
-     */
-    protected $key;
+    protected string $key;
 
-    /**
-     * @return void
-     */
     public function initializeObject(): void
     {
         $this->key = base64_decode($this->base64EncodedKey, true);
@@ -32,17 +25,11 @@ public function initializeObject(): void
         }
     }
 
-    /**
-     * @param string $key
-     */
     public function setKey(string $key): void
     {
         $this->key = $key;
     }
 
-    /**
-     * @return bool
-     */
     public function isConfigured(): bool
     {
         return !empty($this->key);
@@ -52,9 +39,7 @@ public function isConfigured(): bool
      * Encrypts the given data using the configured encryption method and returns a string
      * containing the construction name and the base64-encoded nonce and encrypted data.
      *
-     * @param string $data Data to encrypt
-     * @return string Encoded, encrypted data, suitable for storage (e.g. in the database)
-     * @throws Exception
+     * @throws \Exception
      */
     public function encryptAndEncode(string $data): string
     {
@@ -73,12 +58,12 @@ public function encryptAndEncode(string $data): string
      * Decrypts the given encoded and encrypted data using the configured encryption method
      * and returns the decrypted data.
      *
-     * @param string $encodedAndEncryptedData The data originally created by encryptAndEncode()
-     * @return string Decrypted data
+     * @throws \SodiumException
+     * @see encryptAndEncode()
      */
     public function decodeAndDecrypt(string $encodedAndEncryptedData): string
     {
-        list($construction, $encodedNonce, $encodedEncryptedSerializedAccessToken) = explode('$', $encodedAndEncryptedData);
+        [$construction, $encodedNonce, $encodedEncryptedSerializedAccessToken] = explode('$', $encodedAndEncryptedData);
         if ($construction !== 'ChaCha20-Poly1305-IETF') {
             throw new \RuntimeException(sprintf('Failed decrypting serialized access token: unsupported AEAD construction "%s"', $construction), 1604938723);
         }
@@ -93,12 +78,10 @@ public function decodeAndDecrypt(string $encodedAndEncryptedData): string
     }
 
     /**
-     * @return string
-     * @throws Exception
+     * @throws \Exception
      */
     public function generateEncryptionKey(): string
     {
         return sodium_crypto_aead_chacha20poly1305_ietf_keygen();
     }
-
 }