Merge pull request #86 from Nyholm/converter-interface

Added interfaces for converters
trikoder · Aug 17, 2019 · d2caf69 · d2caf69
2 parents 9dce66a + 9b40f2a
commit d2caf69
Show file tree

Hide file tree

Showing 12 changed files with 73 additions and 30 deletions.
diff --git a/Controller/AuthorizationController.php b/Controller/AuthorizationController.php
@@ -10,7 +10,7 @@
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
-use Trikoder\Bundle\OAuth2Bundle\Converter\UserConverter;
+use Trikoder\Bundle\OAuth2Bundle\Converter\UserConverterInterface;
 use Trikoder\Bundle\OAuth2Bundle\Event\AuthorizationRequestResolveEvent;
 use Trikoder\Bundle\OAuth2Bundle\Event\AuthorizationRequestResolveEventFactory;
 use Trikoder\Bundle\OAuth2Bundle\OAuth2Events;
@@ -33,15 +33,15 @@ final class AuthorizationController
     private $eventFactory;
 
     /**
-     * @var UserConverter
+     * @var UserConverterInterface
      */
     private $userConverter;
 
     public function __construct(
         AuthorizationServer $server,
         EventDispatcherInterface $eventDispatcher,
         AuthorizationRequestResolveEventFactory $eventFactory,
-        UserConverter $userConverter
+        UserConverterInterface $userConverter
     ) {
         $this->server = $server;
         $this->eventDispatcher = $eventDispatcher;

diff --git a/Converter/ScopeConverter.php b/Converter/ScopeConverter.php
@@ -7,17 +7,15 @@
 use Trikoder\Bundle\OAuth2Bundle\League\Entity\Scope as ScopeEntity;
 use Trikoder\Bundle\OAuth2Bundle\Model\Scope as ScopeModel;
 
-final class ScopeConverter
+final class ScopeConverter implements ScopeConverterInterface
 {
     public function toDomain(ScopeEntity $scope): ScopeModel
     {
         return new ScopeModel($scope->getIdentifier());
     }
 
     /**
-     * @param ScopeEntity[] $scopes
-     *
-     * @return ScopeModel[]
+     * {@inheritdoc}
      */
     public function toDomainArray(array $scopes): array
     {
@@ -35,9 +33,7 @@ public function toLeague(ScopeModel $scope): ScopeEntity
     }
 
     /**
-     * @param ScopeModel[] $scopes
-     *
-     * @return ScopeEntity[]
+     * {@inheritdoc}
      */
     public function toLeagueArray(array $scopes): array
     {

diff --git a/Converter/ScopeConverterInterface.php b/Converter/ScopeConverterInterface.php
@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Trikoder\Bundle\OAuth2Bundle\Converter;
+
+use Trikoder\Bundle\OAuth2Bundle\League\Entity\Scope as ScopeEntity;
+use Trikoder\Bundle\OAuth2Bundle\Model\Scope as ScopeModel;
+
+interface ScopeConverterInterface
+{
+    public function toDomain(ScopeEntity $scope): ScopeModel;
+
+    /**
+     * @param ScopeEntity[] $scopes
+     *
+     * @return ScopeModel[]
+     */
+    public function toDomainArray(array $scopes): array;
+
+    public function toLeague(ScopeModel $scope): ScopeEntity;
+
+    /**
+     * @param ScopeModel[] $scopes
+     *
+     * @return ScopeEntity[]
+     */
+    public function toLeagueArray(array $scopes): array;
+}
diff --git a/Converter/UserConverter.php b/Converter/UserConverter.php
@@ -8,7 +8,7 @@
 use Symfony\Component\Security\Core\User\UserInterface;
 use Trikoder\Bundle\OAuth2Bundle\League\Entity\User;
 
-final class UserConverter
+final class UserConverter implements UserConverterInterface
 {
     public function toLeague(?UserInterface $user): UserEntityInterface
     {

diff --git a/Converter/UserConverterInterface.php b/Converter/UserConverterInterface.php
@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Trikoder\Bundle\OAuth2Bundle\Converter;
+
+use League\OAuth2\Server\Entities\UserEntityInterface;
+use Symfony\Component\Security\Core\User\UserInterface;
+
+interface UserConverterInterface
+{
+    public function toLeague(?UserInterface $user): UserEntityInterface;
+}
diff --git a/Event/AuthorizationRequestResolveEvent.php b/Event/AuthorizationRequestResolveEvent.php
@@ -10,7 +10,7 @@
 use RuntimeException;
 use Symfony\Component\EventDispatcher\Event;
 use Symfony\Component\Security\Core\User\UserInterface;
-use Trikoder\Bundle\OAuth2Bundle\Converter\ScopeConverter;
+use Trikoder\Bundle\OAuth2Bundle\Converter\ScopeConverterInterface;
 use Trikoder\Bundle\OAuth2Bundle\Manager\ClientManagerInterface;
 use Trikoder\Bundle\OAuth2Bundle\Model\Client;
 use Trikoder\Bundle\OAuth2Bundle\Model\Scope;
@@ -26,7 +26,7 @@ final class AuthorizationRequestResolveEvent extends Event
     private $authorizationRequest;
 
     /**
-     * @var ScopeConverter
+     * @var ScopeConverterInterface
      */
     private $scopeConverter;
 
@@ -50,7 +50,7 @@ final class AuthorizationRequestResolveEvent extends Event
      */
     private $user;
 
-    public function __construct(AuthorizationRequest $authorizationRequest, ScopeConverter $scopeConverter, ClientManagerInterface $clientManager)
+    public function __construct(AuthorizationRequest $authorizationRequest, ScopeConverterInterface $scopeConverter, ClientManagerInterface $clientManager)
     {
         $this->authorizationRequest = $authorizationRequest;
         $this->scopeConverter = $scopeConverter;

diff --git a/Event/AuthorizationRequestResolveEventFactory.php b/Event/AuthorizationRequestResolveEventFactory.php
@@ -5,13 +5,13 @@
 namespace Trikoder\Bundle\OAuth2Bundle\Event;
 
 use League\OAuth2\Server\RequestTypes\AuthorizationRequest;
-use Trikoder\Bundle\OAuth2Bundle\Converter\ScopeConverter;
+use Trikoder\Bundle\OAuth2Bundle\Converter\ScopeConverterInterface;
 use Trikoder\Bundle\OAuth2Bundle\Manager\ClientManagerInterface;
 
 class AuthorizationRequestResolveEventFactory
 {
     /**
-     * @var ScopeConverter
+     * @var ScopeConverterInterface
      */
     private $scopeConverter;
 
@@ -20,7 +20,7 @@ class AuthorizationRequestResolveEventFactory
      */
     private $clientManager;
 
-    public function __construct(ScopeConverter $scopeConverter, ClientManagerInterface $clientManager)
+    public function __construct(ScopeConverterInterface $scopeConverter, ClientManagerInterface $clientManager)
     {
         $this->scopeConverter = $scopeConverter;
         $this->clientManager = $clientManager;

diff --git a/League/Repository/AccessTokenRepository.php b/League/Repository/AccessTokenRepository.php
@@ -8,7 +8,7 @@
 use League\OAuth2\Server\Entities\ClientEntityInterface;
 use League\OAuth2\Server\Exception\UniqueTokenIdentifierConstraintViolationException;
 use League\OAuth2\Server\Repositories\AccessTokenRepositoryInterface;
-use Trikoder\Bundle\OAuth2Bundle\Converter\ScopeConverter;
+use Trikoder\Bundle\OAuth2Bundle\Converter\ScopeConverterInterface;
 use Trikoder\Bundle\OAuth2Bundle\League\Entity\AccessToken as AccessTokenEntity;
 use Trikoder\Bundle\OAuth2Bundle\Manager\AccessTokenManagerInterface;
 use Trikoder\Bundle\OAuth2Bundle\Manager\ClientManagerInterface;
@@ -27,14 +27,14 @@ final class AccessTokenRepository implements AccessTokenRepositoryInterface
     private $clientManager;
 
     /**
-     * @var ScopeConverter
+     * @var ScopeConverterInterface
      */
     private $scopeConverter;
 
     public function __construct(
         AccessTokenManagerInterface $accessTokenManager,
         ClientManagerInterface $clientManager,
-        ScopeConverter $scopeConverter
+        ScopeConverterInterface $scopeConverter
     ) {
         $this->accessTokenManager = $accessTokenManager;
         $this->clientManager = $clientManager;

diff --git a/League/Repository/AuthCodeRepository.php b/League/Repository/AuthCodeRepository.php
@@ -7,7 +7,7 @@
 use League\OAuth2\Server\Entities\AuthCodeEntityInterface;
 use League\OAuth2\Server\Exception\UniqueTokenIdentifierConstraintViolationException;
 use League\OAuth2\Server\Repositories\AuthCodeRepositoryInterface;
-use Trikoder\Bundle\OAuth2Bundle\Converter\ScopeConverter;
+use Trikoder\Bundle\OAuth2Bundle\Converter\ScopeConverterInterface;
 use Trikoder\Bundle\OAuth2Bundle\League\Entity\AuthCode;
 use Trikoder\Bundle\OAuth2Bundle\Manager\AuthorizationCodeManagerInterface;
 use Trikoder\Bundle\OAuth2Bundle\Manager\ClientManagerInterface;
@@ -26,14 +26,14 @@ final class AuthCodeRepository implements AuthCodeRepositoryInterface
     private $clientManager;
 
     /**
-     * @var ScopeConverter
+     * @var ScopeConverterInterface
      */
     private $scopeConverter;
 
     public function __construct(
         AuthorizationCodeManagerInterface $authorizationCodeManager,
         ClientManagerInterface $clientManager,
-        ScopeConverter $scopeConverter
+        ScopeConverterInterface $scopeConverter
     ) {
         $this->authorizationCodeManager = $authorizationCodeManager;
         $this->clientManager = $clientManager;

diff --git a/League/Repository/ScopeRepository.php b/League/Repository/ScopeRepository.php
@@ -8,7 +8,7 @@
 use League\OAuth2\Server\Exception\OAuthServerException;
 use League\OAuth2\Server\Repositories\ScopeRepositoryInterface;
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
-use Trikoder\Bundle\OAuth2Bundle\Converter\ScopeConverter;
+use Trikoder\Bundle\OAuth2Bundle\Converter\ScopeConverterInterface;
 use Trikoder\Bundle\OAuth2Bundle\Event\ScopeResolveEvent;
 use Trikoder\Bundle\OAuth2Bundle\Manager\ClientManagerInterface;
 use Trikoder\Bundle\OAuth2Bundle\Manager\ScopeManagerInterface;
@@ -30,7 +30,7 @@ final class ScopeRepository implements ScopeRepositoryInterface
     private $clientManager;
 
     /**
-     * @var ScopeConverter
+     * @var ScopeConverterInterface
      */
     private $scopeConverter;
 
@@ -42,7 +42,7 @@ final class ScopeRepository implements ScopeRepositoryInterface
     public function __construct(
         ScopeManagerInterface $scopeManager,
         ClientManagerInterface $clientManager,
-        ScopeConverter $scopeConverter,
+        ScopeConverterInterface $scopeConverter,
         EventDispatcherInterface $eventDispatcher
     ) {
         $this->scopeManager = $scopeManager;

diff --git a/League/Repository/UserRepository.php b/League/Repository/UserRepository.php
@@ -7,7 +7,7 @@
 use League\OAuth2\Server\Entities\ClientEntityInterface;
 use League\OAuth2\Server\Repositories\UserRepositoryInterface;
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
-use Trikoder\Bundle\OAuth2Bundle\Converter\UserConverter;
+use Trikoder\Bundle\OAuth2Bundle\Converter\UserConverterInterface;
 use Trikoder\Bundle\OAuth2Bundle\Event\UserResolveEvent;
 use Trikoder\Bundle\OAuth2Bundle\Manager\ClientManagerInterface;
 use Trikoder\Bundle\OAuth2Bundle\Model\Grant as GrantModel;
@@ -26,12 +26,15 @@ final class UserRepository implements UserRepositoryInterface
     private $eventDispatcher;
 
     /**
-     * @var UserConverter
+     * @var UserConverterInterface
      */
     private $userConverter;
 
-    public function __construct(ClientManagerInterface $clientManager, EventDispatcherInterface $eventDispatcher, UserConverter $userConverter)
-    {
+    public function __construct(
+        ClientManagerInterface $clientManager,
+        EventDispatcherInterface $eventDispatcher,
+        UserConverterInterface $userConverter
+    ) {
         $this->clientManager = $clientManager;
         $this->eventDispatcher = $eventDispatcher;
         $this->userConverter = $userConverter;

diff --git a/Resources/config/services.xml b/Resources/config/services.xml
@@ -172,9 +172,11 @@
         <!-- Utility services -->
         <service id="Trikoder\Bundle\OAuth2Bundle\Converter\UserConverter" />
         <service id="trikoder.oauth2.converter.user_converter" alias="Trikoder\Bundle\OAuth2Bundle\Converter\UserConverter" />
+        <service id="Trikoder\Bundle\OAuth2Bundle\Converter\UserConverterInterface" alias="Trikoder\Bundle\OAuth2Bundle\Converter\UserConverter" />
 
         <service id="Trikoder\Bundle\OAuth2Bundle\Converter\ScopeConverter" />
         <service id="trikoder.oauth2.converter.scope_converter" alias="Trikoder\Bundle\OAuth2Bundle\Converter\ScopeConverter" />
+        <service id="Trikoder\Bundle\OAuth2Bundle\Converter\ScopeConverterInterface" alias="Trikoder\Bundle\OAuth2Bundle\Converter\ScopeConverter" />
 
         <service id="Trikoder\Bundle\OAuth2Bundle\Event\AuthorizationRequestResolveEventFactory">
             <argument type="service" id="Trikoder\Bundle\OAuth2Bundle\Converter\ScopeConverter" />