Make username formats extensible

Author: ilijastuden

src/Authorizer/AuthorizerInterface.php

@@ -15,6 +15,10 @@
  */
 interface AuthorizerInterface
 {
+    const USERNAME_FORMAT_ANY = 'any';
+    const USERNAME_FORMAT_ALPHANUM = 'alphanum';
+    const USERNAME_FORMAT_EMAIL = 'email';
+
     /**
      * Perform user credentials verification against the real user database provider.
      *

src/Authorizer/CredentialFieldsCheckTrait.php

@@ -28,6 +28,19 @@ private function verifyRequiredFields(array $credentials, array $fields)
         }
     }
 
+    /**
+     * @param array $credentials
+     * @param array $fields
+     */
+    private function verifyAlphanumFields(array $credentials, array $fields)
+    {
+        foreach ($fields as $field) {
+            if (empty($credentials[$field]) || !ctype_alnum($credentials[$field])) {
+                throw new InvalidAuthenticationRequestException();
+            }
+        }
+    }
+
     /**
      * @param array $credentials
      * @param array $fields

src/Authorizer/LocalAuthorizer.php

@@ -28,16 +28,16 @@ class LocalAuthorizer extends Authorizer
     /**
      * @var bool
      */
-    private $username_is_email = false;
+    private $username_format;
 
     /**
      * @param RepositoryInterface $user_repository
-     * @param bool                $username_is_email
+     * @param string              $username_format
      */
-    public function __construct(RepositoryInterface $user_repository, $username_is_email = false)
+    public function __construct(RepositoryInterface $user_repository, $username_format = AuthorizerInterface::USERNAME_FORMAT_ANY)
     {
         $this->user_repository = $user_repository;
-        $this->username_is_email = (bool) $username_is_email;
+        $this->username_format = $username_format;
     }
 
     /**
@@ -50,8 +50,13 @@ public function verifyCredentials(array $credentials)
     {
         $this->verifyRequiredFields($credentials, ['username', 'password']);
 
-        if ($this->username_is_email) {
-            $this->verifyEmailFields($credentials, ['username']);
+        switch ($this->username_format) {
+            case AuthorizerInterface::USERNAME_FORMAT_ALPHANUM:
+                $this->verifyAlphanumFields($credentials, ['username']);
+                break;
+            case AuthorizerInterface::USERNAME_FORMAT_EMAIL:
+                $this->verifyEmailFields($credentials, ['username']);
+                break;
         }
 
         $user = $this->user_repository->findByUsername($credentials['username']);

test/src/LocalAuthorizerTest.php

@@ -8,6 +8,7 @@
 
 namespace ActiveCollab\Authentication\Test;
 
+use ActiveCollab\Authentication\Authorizer\AuthorizerInterface;
 use ActiveCollab\Authentication\Authorizer\LocalAuthorizer;
 use ActiveCollab\Authentication\Test\AuthenticatedUser\AuthenticatedUser;
 use ActiveCollab\Authentication\Test\AuthenticatedUser\Repository;
@@ -43,21 +44,48 @@ public function providerInvalidCredentials()
 
     /**
      * @param array $username
-     * @dataProvider providerInvalidUsername
+     * @dataProvider providerInvalidAlphaNumUsername
      * @expectedException \ActiveCollab\Authentication\Exception\InvalidAuthenticationRequestException
      * @expectedExceptionMessage Authentication request data not valid
      */
-    public function testInvalidUsernameThrowsException($username)
+    public function testInvalidAlphaNumUsernameThrowsException($username)
     {
-        $local_authorizer = new LocalAuthorizer(new Repository(), true);
+        $local_authorizer = new LocalAuthorizer(new Repository(), AuthorizerInterface::USERNAME_FORMAT_ALPHANUM);
 
         $local_authorizer->verifyCredentials([
             'username' => $username,
             'password' => 'Easy to remember, Hard to guess',
         ]);
     }
 
-    public function providerInvalidUsername()
+    public function providerInvalidAlphaNumUsername()
+    {
+        return [
+            ['username' => null],
+            ['username' => ''],
+            ['username' => 'Invalid Username'],
+            ['username' => 'not_a_username'],
+            ['username' => '[email protected]'],
+        ];
+    }
+
+    /**
+     * @param array $username
+     * @dataProvider providerInvalidEmailUsername
+     * @expectedException \ActiveCollab\Authentication\Exception\InvalidAuthenticationRequestException
+     * @expectedExceptionMessage Authentication request data not valid
+     */
+    public function testInvalidEmailUsernameThrowsException($username)
+    {
+        $local_authorizer = new LocalAuthorizer(new Repository(), AuthorizerInterface::USERNAME_FORMAT_EMAIL);
+
+        $local_authorizer->verifyCredentials([
+            'username' => $username,
+            'password' => 'Easy to remember, Hard to guess',
+        ]);
+    }
+
+    public function providerInvalidEmailUsername()
     {
         return [
             ['username' => null],
@@ -116,11 +144,22 @@ public function testUserIsAuthenticated()
         $this->assertSame(1, $user->getId());
     }
 
+    public function testUserWithAlphanumUsernameIsAuthenticated()
+    {
+        $local_authorizer = new LocalAuthorizer(new Repository([
+            '[email protected]' => new AuthenticatedUser(1, 'JohnDoe1983', 'John', 'password', true),
+        ]), AuthorizerInterface::USERNAME_FORMAT_ALPHANUM);
+
+        $user = $local_authorizer->verifyCredentials(['username' => 'JohnDoe1983', 'password' => 'password']);
+
+        $this->assertSame(1, $user->getId());
+    }
+
     public function testUserWithEmailUsernameIsAuthenticated()
     {
         $local_authorizer = new LocalAuthorizer(new Repository([
             '[email protected]' => new AuthenticatedUser(1, '[email protected]', 'John', 'password', true),
-        ]), true);
+        ]), AuthorizerInterface::USERNAME_FORMAT_EMAIL);
 
         $user = $local_authorizer->verifyCredentials(['username' => '[email protected]', 'password' => 'password']);