feat: Utilise Role information from client apps.

Userbase client applications may supply their own roles for users loaded
by UserProvider.  UserProvider implements RoleManagerInterface and User
implements RoleInterface from the userbase-role-contracts package.
UserProvider will use any RoleProviderInterface to add roles to a User
loaded in the loadUserByUsername method.

Author: boite

composer.json

@@ -13,6 +13,7 @@
     ],
     "require": {
         "php": ">=5.3.0",
+        "linkorb/userbase-role-contracts": "^1.0",
         "symfony/security": "~2.6 || ~3.0 || ^4",
         "psr/cache": "~1.0",
         "symfony/cache": "~3.0 || ^4"

src/Model/User.php

@@ -2,11 +2,16 @@
 
 namespace UserBase\Client\Model;
 
+use LinkORB\Contracts\UserbaseRole\RoleInterface;
 use Symfony\Component\Security\Core\User\AdvancedUserInterface;
-use Symfony\Component\Security\Core\Role\Role;
 use RuntimeException;
 
-final class User implements UserInterface, AdvancedUserInterface, AccountContainerInterface, PolicyContainerInterface
+final class User implements
+    AccountContainerInterface,
+    AdvancedUserInterface,
+    PolicyContainerInterface,
+    RoleInterface,
+    UserInterface
 {
     private $password;
     private $enabled;

src/UserProvider.php

@@ -4,6 +4,8 @@
 
 use RuntimeException;
 
+use LinkORB\Contracts\UserbaseRole\RoleManagerInterface;
+use LinkORB\Contracts\UserbaseRole\RoleProviderInterface;
 use Symfony\Component\Security\Core\Exception\UnsupportedUserException;
 use Symfony\Component\Security\Core\Exception\UsernameNotFoundException;
 use Symfony\Component\Security\Core\User\UserInterface;
@@ -14,9 +16,10 @@
 use UserBase\Client\Event\UserLoadedEvent;
 
 
-class UserProvider implements UserProviderInterface
+class UserProvider implements UserProviderInterface, RoleManagerInterface
 {
     private $client;
+    private $roleProvider;
     private $shouldRefresh;
     private $dispatcher;
 
@@ -27,6 +30,11 @@ public function __construct(Client $client, $shouldRefresh = true, EventDispatch
         $this->dispatcher = $dispatcher;
     }
 
+    public function setRoleProvider(RoleProviderInterface $roleProvider)
+    {
+        $this->roleProvider = $roleProvider;
+    }
+
     public function loadUserByUsername($username)
     {
         try {
@@ -35,14 +43,23 @@ public function loadUserByUsername($username)
                 $event = new UserLoadedEvent($user);
                 $this->dispatcher->dispatch('userbase.user_loaded', $event);
             }
-            return $user;
         } catch (RuntimeException $e) {
             throw new UsernameNotFoundException(
                 "A User named \"{$username}\" cannot be found in Userbase.",
                 null,
                 $e
             );
         }
+
+        if (!$this->roleProvider) {
+            return $user;
+        }
+
+        foreach ($this->roleProvider->getRoles($user) as $roleName) {
+            $user->addRole($roleName);
+        }
+
+        return $user;
     }
 
     public function refreshUser(UserInterface $user)