Added the details and changed UserRepositoryInterface

Author: ezimuel

docs/book/v1/intro.md

@@ -32,6 +32,16 @@ interface UserInterface
      * @return string[]
      */
     public function getRoles() : array;
+
+    /**
+     * Get a detail $name if present, $default otherwise
+     */
+    public function getDetail(string $name, $default = null);
+
+    /**
+     * Get all the details, if any
+     */
+    public function getDetails() : array;
 }
 ```
 

docs/book/v1/user-repository.md

@@ -24,37 +24,12 @@ interface UserRepositoryInterface
      * @param string $credential can be also a token
      */
     public function authenticate(string $credential, string $password = null) : ?UserInterface;
-
-    /**
-     * Get the user roles if present.
-     *
-     * @param string $username
-     * @return string[]
-     */
-    public function getUserRoles(string $username) : array;
-
-    /**
-     * Get the user details if present.
-     *
-     * @param string $identity
-     * @return string[]
-     */
-    public function getUserDetails(string $identity) : array;
 }
 ```
 
-It contains 3 functions: `authenticate()`, `getUserRoles()`, and `getUserDetails`.
-The first function is used to authenticate the user's credential. If
-authenticated, the result will be a `UserInterface` instance, otherwise a null
-value is returned.
-
-The second function is `getUserRoles()` and it specifies how to retrieve
-the roles for a user. If a user does not have roles, this function will return
-an empty array.
-
-The last function is `getUserDetails()` and it specifies the additional user
-information (details), if any.
-
+It contains only the `authenticate()` function, to authenticate the user's
+credential. If authenticated, the result will be a `UserInterface` instance,
+otherwise a `null` value is returned.
 
 ## Configure the user repository
 
@@ -137,3 +112,9 @@ SELECT role FROM user WHERE username = :identity
 
 The `sql_get_details` parameter is similar to `sql_get_roles`, it specified the
 SQL query for retrieving the user's additional details, if any.
+For instance, if a user has an email field this can be returned as additional
+detail using the query as follows:
+
+```sql
+SELECT email FROM user WHERE username = :identity
+```

src/UserRepository/Htpasswd.php

@@ -71,22 +71,6 @@ public function authenticate(string $credential, string $password = null) : ?Use
         return null;
     }
 
-    /**
-     * {@inheritDoc}
-     */
-    public function getUserRoles(string $identity) : array
-    {
-        return [];
-    }
-
-    /**
-     * {@inheritDoc}
-     */
-    public function getUserDetails(string $identity) : array
-    {
-        return [];
-    }
-
     /**
      * Check bcrypt usage for security reason
      *

src/UserRepository/PdoDatabase.php

@@ -84,9 +84,12 @@ public function authenticate(string $credential, string $password = null) : ?Use
     }
 
     /**
-     * {@inheritDoc}
+     * Get the user roles if present.
+     *
+     * @param string $identity
+     * @return string[]
      */
-    public function getUserRoles(string $identity) : array
+    protected function getUserRoles(string $identity) : array
     {
         if (! isset($this->config['sql_get_roles'])) {
             return [];
@@ -124,7 +127,13 @@ public function getUserRoles(string $identity) : array
         return $roles;
     }
 
-    public function getUserDetails(string $identity) : array
+    /**
+     * Get the user details if present.
+     *
+     * @param string $identity
+     * @return string[]
+     */
+    protected function getUserDetails(string $identity) : array
     {
         if (! isset($this->config['sql_get_details'])) {
             return [];
@@ -154,11 +163,6 @@ public function getUserDetails(string $identity) : array
         if (! $stmt->execute()) {
             return [];
         }
-
-        $details = [];
-        foreach ($stmt->fetchAll(PDO::FETCH_NUM) as $detail) {
-            $details[] = $detail[0];
-        }
-        return $details;
+        return $stmt->fetch(PDO::FETCH_ASSOC);
     }
 }

src/UserRepositoryInterface.php

@@ -19,20 +19,4 @@ interface UserRepositoryInterface
      * @param string $credential can be also a token
      */
     public function authenticate(string $credential, string $password = null) : ?UserInterface;
-
-    /**
-     * Get the user roles if present.
-     *
-     * @param string $identity
-     * @return string[]
-     */
-    public function getUserRoles(string $identity) : array;
-
-    /**
-     * Get the user details if present.
-     *
-     * @param string $identity
-     * @return string[]
-     */
-    public function getUserDetails(string $identity) : array;
 }

test/DefaultUserFactoryTest.php

@@ -28,11 +28,34 @@ public function testConstructor()
         $this->assertInstanceOf(DefaultUserFactory::class, $factory);
     }
 
-    public function testInvoke()
+    public function testInvokeWithIdentity()
     {
         $factory = new DefaultUserFactory();
         $userFactory = $factory($this->container->reveal());
         $defaultUser = $userFactory('foo');
         $this->assertInstanceOf(DefaultUser::class, $defaultUser);
+        $this->assertEquals('foo', $defaultUser->getIdentity());
+    }
+
+    public function testInvokeWithIdentityAndRoles()
+    {
+        $factory = new DefaultUserFactory();
+        $userFactory = $factory($this->container->reveal());
+        $defaultUser = $userFactory('foo', ['admin', 'user']);
+        $this->assertInstanceOf(DefaultUser::class, $defaultUser);
+        $this->assertEquals('foo', $defaultUser->getIdentity());
+        $this->assertEquals(['admin', 'user'], $defaultUser->getRoles());
+    }
+
+    public function testInvokeWithIdentityAndRolesAndDetails()
+    {
+        $factory = new DefaultUserFactory();
+        $userFactory = $factory($this->container->reveal());
+        $defaultUser = $userFactory('foo', ['admin', 'user'], ['email' => 'foo@test.com']);
+        $this->assertInstanceOf(DefaultUser::class, $defaultUser);
+        $this->assertEquals('foo', $defaultUser->getIdentity());
+        $this->assertEquals(['admin', 'user'], $defaultUser->getRoles());
+        $this->assertEquals(['email' => 'foo@test.com'], $defaultUser->getDetails());
+        $this->assertEquals('foo@test.com', $defaultUser->getDetail('email'));
     }
 }

test/TestAssets/pdo.sqlite

@@ -1,7 +1,8 @@
 CREATE TABLE user(
     username TEXT,
     password TEXT,
-    role TEXT
+    role TEXT,
+    email TEXT
 );
 
-INSERT INTO user (username, password, role) VALUES ('test', '$2y$10$C822kPutHb8S/An9pBzJHeaN2/uqytA88O5VtTaY9m9EzWCJPDF7e', 'admin');
+INSERT INTO user (username, password, role, email) VALUES ('test', '$2y$10$C822kPutHb8S/An9pBzJHeaN2/uqytA88O5VtTaY9m9EzWCJPDF7e', 'admin', 'test@foo.com');