Merge pull request #73 from 9orky/feature/onJwtEncodedEvent

add JWTEncodedEvent so JWT string is available after its creation

Author: slashfan

Event/JWTEncodedEvent.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace Lexik\Bundle\JWTAuthenticationBundle\Event;
+
+use Symfony\Component\EventDispatcher\Event;
+
+/**
+ * Class JWTEncodedEvent
+ * @package Lexik\Bundle\JWTAuthenticationBundle\Event
+ */
+class JWTEncodedEvent extends Event
+{
+
+    /**
+     * @var $jwtString
+     */
+    private $jwtString;
+
+    /**
+     * @param $jwtString
+     */
+    public function __construct($jwtString)
+    {
+        $this->jwtString = $jwtString;
+    }
+
+    /**
+     * @return $jwtString
+     */
+    public function getJWTString()
+    {
+        return $this->jwtString;
+    }
+}

Events.php

@@ -26,6 +26,12 @@ final class Events
      */
     const JWT_CREATED = 'lexik_jwt_authentication.on_jwt_created';
 
+    /**
+     * Dispatched right after token string is created.
+     * Hook into this event to get token representation itself.
+     */
+    const JWT_ENCODED = 'lexik_jwt_authentication.on_jwt_encoded';
+
     /**
      * Dispatched after the token payload has been decoded by the configured encoder (JWTEncoder by default).
      * Hook into this event to perform additional validation on the received payload.

Resources/doc/2-data-customization.md

@@ -178,3 +178,20 @@ public function onAuthenticationSuccessResponse(AuthenticationSuccessEvent $even
     $event->setData($data);
 }
 ```
+#### Events::JWT_ENCODED - get JWT string
+
+You may need to get JWT after its creation.
+
+Example 6: obtain JWT string
+
+``` php
+// Acme\Bundle\ApiBundle\EventListener\OnJwtEncoded.php
+
+/**
+ * @param JWTEncodedEvent $event
+ */
+public function onJwtEncoded(JWTEncodedEvent $event)
+{
+    $token = $event->getJWTString();
+}
+```

Services/JWTManager.php

@@ -5,12 +5,14 @@
 use Lexik\Bundle\JWTAuthenticationBundle\Encoder\JWTEncoderInterface;
 use Lexik\Bundle\JWTAuthenticationBundle\Event\JWTCreatedEvent;
 use Lexik\Bundle\JWTAuthenticationBundle\Event\JWTDecodedEvent;
+use Lexik\Bundle\JWTAuthenticationBundle\Event\JWTEncodedEvent;
 use Lexik\Bundle\JWTAuthenticationBundle\Events;
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
 use Symfony\Component\Security\Core\User\UserInterface;
 use Symfony\Component\PropertyAccess\PropertyAccess;
+
 /**
  * JWTManager
  *
@@ -67,10 +69,15 @@ public function create(UserInterface $user)
 
         $this->addUserIdentityToPayload($user, $payload);
 
-        $event = new JWTCreatedEvent($payload, $user, $this->request);
-        $this->dispatcher->dispatch(Events::JWT_CREATED, $event);
+        $jwtCreatedEvent = new JWTCreatedEvent($payload, $user, $this->request);
+        $this->dispatcher->dispatch(Events::JWT_CREATED, $jwtCreatedEvent);
+
+        $jwtString = $this->jwtEncoder->encode($jwtCreatedEvent->getData());
+
+        $jwtEncodedEvent = new JWTEncodedEvent($jwtString);
+        $this->dispatcher->dispatch(Events::JWT_ENCODED, $jwtEncodedEvent);
 
-        return $this->jwtEncoder->encode($event->getData());
+        return $jwtString;
     }
 
     /**

Tests/Services/JWTManagerTest.php

@@ -21,13 +21,21 @@ public function testCreate()
     {
         $dispatcher = $this->getEventDispatcherMock();
         $dispatcher
-            ->expects($this->once())
+            ->expects($this->at(0))
             ->method('dispatch')
             ->with(
                 $this->equalTo(Events::JWT_CREATED),
                 $this->isInstanceOf('Lexik\Bundle\JWTAuthenticationBundle\Event\JWTCreatedEvent')
             );
 
+        $dispatcher
+            ->expects($this->at(1))
+            ->method('dispatch')
+            ->with(
+                $this->equalTo(Events::JWT_ENCODED),
+                $this->isInstanceOf('Lexik\Bundle\JWTAuthenticationBundle\Event\JWTEncodedEvent')
+            );
+
         $encoder = $this->getJWTEncoderMock();
         $encoder
             ->expects($this->once())
@@ -70,13 +78,21 @@ public function testIdentityField()
 
         $dispatcher = $this->getEventDispatcherMock();
         $dispatcher
-            ->expects($this->once())
+            ->expects($this->at(0))
             ->method('dispatch')
             ->with(
                 $this->equalTo(Events::JWT_CREATED),
                 $this->isInstanceOf('Lexik\Bundle\JWTAuthenticationBundle\Event\JWTCreatedEvent')
             );
 
+        $dispatcher
+            ->expects($this->at(1))
+            ->method('dispatch')
+            ->with(
+                $this->equalTo(Events::JWT_ENCODED),
+                $this->isInstanceOf('Lexik\Bundle\JWTAuthenticationBundle\Event\JWTEncodedEvent')
+            );
+
         $encoder = $this->getJWTEncoderMock();
         $encoder
             ->expects($this->once())