Use dedicated authorization events

CHANGELOG-2.0.md

@@ -11,6 +11,9 @@ This changelog references the relevant changes done in 6.0 versions.
 * Dropped support for Symfony versions anterior to `4.4` [[#648](https://github.com/FriendsOfSymfony/FOSOAuthServerBundle/pull/648)]
 * Fixed form submission/validation [[#643](https://github.com/FriendsOfSymfony/FOSOAuthServerBundle/pull/643)]
 * **[BC break]** Changed signature of method `FOS\OAuthServerBundle\Controller\AuthorizeController::renderAuthorize()` [[#653](https://github.com/FriendsOfSymfony/FOSOAuthServerBundle/pull/653)]
+* **[BC break]** Removed class `FOS\OAuthServerBundle\Event\OAuthEvent`, use dedicated event classes instead: [[#655](https://github.com/FriendsOfSymfony/FOSOAuthServerBundle/pull/655)]
+    - `OAuthEvent::PRE_AUTHORIZATION_PROCESS` => `FOS\OAuthServerBundle\Event\PreAuthorizationEvent`
+    - `OAuthEvent::POST_AUTHORIZATION_PROCESS` => `FOS\OAuthServerBundle\Event\PostAuthorizationEvent`
 * **[BC break]** Removed support for templating engine [[#653](https://github.com/FriendsOfSymfony/FOSOAuthServerBundle/pull/653)]
 
 ### 2.0.0-ALPHA0 (2018-05-01)

Controller/AuthorizeController.php

@@ -13,7 +13,8 @@
 
 namespace FOS\OAuthServerBundle\Controller;
 
-use FOS\OAuthServerBundle\Event\OAuthEvent;
+use FOS\OAuthServerBundle\Event\PostAuthorizationEvent;
+use FOS\OAuthServerBundle\Event\PreAuthorizationEvent;
 use FOS\OAuthServerBundle\Form\Handler\AuthorizeFormHandler;
 use FOS\OAuthServerBundle\Model\ClientInterface;
 use FOS\OAuthServerBundle\Model\ClientManagerInterface;
@@ -145,11 +146,8 @@ public function authorizeAction(Request $request)
         $form = $this->authorizeForm;
         $formHandler = $this->authorizeFormHandler;
 
-        /** @var OAuthEvent $event */
-        $event = $this->eventDispatcher->dispatch(
-            OAuthEvent::PRE_AUTHORIZATION_PROCESS,
-            new OAuthEvent($user, $this->getClient())
-        );
+        /** @var PreAuthorizationEvent $event */
+        $event = $this->eventDispatcher->dispatch(new PreAuthorizationEvent($user, $this->getClient()));
 
         if ($event->isAuthorizedClient()) {
             $scope = $request->get('scope', null);
@@ -177,10 +175,7 @@ protected function processSuccess(UserInterface $user, AuthorizeFormHandler $for
             $this->session->invalidate();
         }
 
-        $this->eventDispatcher->dispatch(
-            OAuthEvent::POST_AUTHORIZATION_PROCESS,
-            new OAuthEvent($user, $this->getClient(), $formHandler->isAccepted())
-        );
+        $this->eventDispatcher->dispatch(new PostAuthorizationEvent($user, $this->getClient(), $formHandler->isAccepted()));
 
         $formName = $this->authorizeForm->getName();
         if (!$request->query->all() && $request->request->has($formName)) {

Event/OAuthEvent.php → Event/AbstractAuthorizationEvent.php

@@ -14,15 +14,11 @@
 namespace FOS\OAuthServerBundle\Event;
 
 use FOS\OAuthServerBundle\Model\ClientInterface;
-use Symfony\Component\EventDispatcher\Event;
 use Symfony\Component\Security\Core\User\UserInterface;
+use Symfony\Contracts\EventDispatcher\Event;
 
-class OAuthEvent extends Event
+class AbstractAuthorizationEvent extends Event
 {
-    const PRE_AUTHORIZATION_PROCESS = 'fos_oauth_server.pre_authorization_process';
-
-    const POST_AUTHORIZATION_PROCESS = 'fos_oauth_server.post_authorization_process';
-
     /**
      * @var UserInterface
      */
@@ -38,44 +34,29 @@ class OAuthEvent extends Event
      */
     private $isAuthorizedClient;
 
-    /**
-     * @param bool $isAuthorizedClient
-     */
-    public function __construct(UserInterface $user, ClientInterface $client, $isAuthorizedClient = false)
+    public function __construct(UserInterface $user, ClientInterface $client, bool $isAuthorizedClient = false)
     {
         $this->user = $user;
         $this->client = $client;
         $this->isAuthorizedClient = $isAuthorizedClient;
     }
 
-    /**
-     * @return UserInterface
-     */
-    public function getUser()
+    public function getUser(): UserInterface
     {
         return $this->user;
     }
 
-    /**
-     * @param bool $isAuthorizedClient
-     */
-    public function setAuthorizedClient($isAuthorizedClient)
+    public function setAuthorizedClient(bool $authorized)
     {
-        $this->isAuthorizedClient = $isAuthorizedClient;
+        $this->isAuthorizedClient = $authorized;
     }
 
-    /**
-     * @return bool
-     */
-    public function isAuthorizedClient()
+    public function isAuthorizedClient(): bool
     {
         return $this->isAuthorizedClient;
     }
 
-    /**
-     * @return ClientInterface
-     */
-    public function getClient()
+    public function getClient(): ClientInterface
     {
         return $this->client;
     }

Event/PostAuthorizationEvent.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the FOSOAuthServerBundle package.
+ *
+ * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace FOS\OAuthServerBundle\Event;
+
+class PostAuthorizationEvent extends AbstractAuthorizationEvent
+{
+}

Event/PreAuthorizationEvent.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the FOSOAuthServerBundle package.
+ *
+ * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace FOS\OAuthServerBundle\Event;
+
+class PreAuthorizationEvent extends AbstractAuthorizationEvent
+{
+}

Tests/Controller/AuthorizeControllerTest.php

@@ -14,7 +14,8 @@
 namespace FOS\OAuthServerBundle\Tests\Controller;
 
 use FOS\OAuthServerBundle\Controller\AuthorizeController;
-use FOS\OAuthServerBundle\Event\OAuthEvent;
+use FOS\OAuthServerBundle\Event\PostAuthorizationEvent;
+use FOS\OAuthServerBundle\Event\PreAuthorizationEvent;
 use FOS\OAuthServerBundle\Form\Handler\AuthorizeFormHandler;
 use FOS\OAuthServerBundle\Model\ClientInterface;
 use FOS\OAuthServerBundle\Model\ClientManagerInterface;
@@ -117,9 +118,14 @@ class AuthorizeControllerTest extends \PHPUnit\Framework\TestCase
     protected $client;
 
     /**
-     * @var \PHPUnit_Framework_MockObject_MockObject|OAuthEvent
+     * @var \PHPUnit_Framework_MockObject_MockObject|PreAuthorizationEvent
      */
-    protected $event;
+    protected $preAuthorizationEvent;
+
+    /**
+     * @var \PHPUnit_Framework_MockObject_MockObject|PostAuthorizationEvent
+     */
+    protected $postAuthorizationEvent;
 
     /**
      * @var \PHPUnit_Framework_MockObject_MockObject|FormView
@@ -206,7 +212,11 @@ public function setUp()
             ->disableOriginalConstructor()
             ->getMock()
         ;
-        $this->event = $this->getMockBuilder(OAuthEvent::class)
+        $this->preAuthorizationEvent = $this->getMockBuilder(PreAuthorizationEvent::class)
+            ->disableOriginalConstructor()
+            ->getMock()
+        ;
+        $this->postAuthorizationEvent = $this->getMockBuilder(PostAuthorizationEvent::class)
             ->disableOriginalConstructor()
             ->getMock()
         ;
@@ -274,16 +284,15 @@ public function testAuthorizeActionWillRenderTemplate()
         $propertyReflection->setValue($this->instance, $this->client);
 
         $this->eventDispatcher
-            ->expects($this->at(0))
+            ->expects($this->once())
             ->method('dispatch')
-            ->with(OAuthEvent::PRE_AUTHORIZATION_PROCESS, new OAuthEvent($this->user, $this->client))
-            ->willReturn($this->event)
+            ->with(new PreAuthorizationEvent($this->user, $this->client))
+            ->willReturn($this->preAuthorizationEvent)
         ;
 
-        $this->event
-            ->expects($this->at(0))
+        $this->preAuthorizationEvent
+            ->expects($this->once())
             ->method('isAuthorizedClient')
-            ->with()
             ->willReturn(false)
         ;
 
@@ -347,16 +356,15 @@ public function testAuthorizeActionWillFinishClientAuthorization()
         $propertyReflection->setValue($this->instance, $this->client);
 
         $this->eventDispatcher
-            ->expects($this->at(0))
+            ->expects($this->once())
             ->method('dispatch')
-            ->with(OAuthEvent::PRE_AUTHORIZATION_PROCESS, new OAuthEvent($this->user, $this->client))
-            ->willReturn($this->event)
+            ->with(new PreAuthorizationEvent($this->user, $this->client))
+            ->willReturn($this->preAuthorizationEvent)
         ;
 
-        $this->event
-            ->expects($this->at(0))
+        $this->preAuthorizationEvent
+            ->expects($this->once())
             ->method('isAuthorizedClient')
-            ->with()
             ->willReturn(true)
         ;
 
@@ -431,16 +439,15 @@ public function testAuthorizeActionWillEnsureLogout()
         $propertyReflection->setValue($this->instance, $this->client);
 
         $this->eventDispatcher
-            ->expects($this->at(0))
+            ->expects($this->once())
             ->method('dispatch')
-            ->with(OAuthEvent::PRE_AUTHORIZATION_PROCESS, new OAuthEvent($this->user, $this->client))
-            ->willReturn($this->event)
+            ->with(new PreAuthorizationEvent($this->user, $this->client))
+            ->willReturn($this->preAuthorizationEvent)
         ;
 
-        $this->event
-            ->expects($this->at(0))
+        $this->preAuthorizationEvent
+            ->expects($this->once())
             ->method('isAuthorizedClient')
-            ->with()
             ->willReturn(false)
         ;
 
@@ -506,11 +513,11 @@ public function testAuthorizeActionWillProcessAuthorizationForm()
         $this->eventDispatcher
             ->expects($this->at(0))
             ->method('dispatch')
-            ->with(OAuthEvent::PRE_AUTHORIZATION_PROCESS, new OAuthEvent($this->user, $this->client))
-            ->willReturn($this->event)
+            ->with(new PreAuthorizationEvent($this->user, $this->client))
+            ->willReturn($this->preAuthorizationEvent)
         ;
 
-        $this->event
+        $this->preAuthorizationEvent
             ->expects($this->once())
             ->method('isAuthorizedClient')
             ->willReturn(false)
@@ -531,10 +538,7 @@ public function testAuthorizeActionWillProcessAuthorizationForm()
         $this->eventDispatcher
             ->expects($this->at(1))
             ->method('dispatch')
-            ->with(
-                OAuthEvent::POST_AUTHORIZATION_PROCESS,
-                new OAuthEvent($this->user, $this->client, true)
-            )
+            ->with(new PostAuthorizationEvent($this->user, $this->client, true))
         ;
 
         $formName = 'formName'.\random_bytes(10);