Merge pull request #146 from punktDeForks/feature/group-by-path-endpoint

feat: group by path endpoint and group members endpoint

Author: fschmtt

README.md

@@ -127,11 +127,14 @@ $myCustomRepresentation = $myCustomResource->myCustomEndpoint();
 | ------------------------------------------------- | ----------------------------------------------------- | --------------------------------------------- |
 | `GET /admin/realms/{realm}/groups`                | [GroupCollection](src/Collection/GroupCollection.php) | [Groups::all()](src/Resource/Groups.php)      |
 | `GET /admin/realms/{realm}/groups/{id}/children`  | [GroupCollection](src/Collection/GroupCollection.php) | [Groups::children()](src/Resource/Groups.php) |
+| `GET /admin/realms/{realm}/groups/{id}/members`   | [UserCollection](src/Collection/UserCollection.php)   | [Groups::members()](src/Resource/Groups.php)  |
 | `GET /admin/realms/{realm}/groups/{id}`           | [Group](src/Representation/Group.php)                 | [Groups::get()](src/Resource/Groups.php)      |
 | `PUT /admin/realms/{realm}/groups/{id}`           | `n/a`                                                 | [Groups::update()](src/Resource/Groups.php)   |
 | `POST /admin/realms/{realm}/groups`               | `n/a`                                                 | [Groups::create()](src/Resource/Groups.php)   |
 | `POST /admin/realms/{realm}/groups/{id}/children` | `n/a`                                                 | [Groups::create()](src/Resource/Groups.php)   |
 | `DELETE /admin/realms/{realm}/groups`             | `n/a`                                                 | [Groups::delete()](src/Resource/Groups.php)   |
+| `GET /admin/realms/{realm}/group-by-path/{path}`  | [Group](src/Representation/Group.php)                 | [Groups::byPath()](src/Resource/Groups.php)   |
+
 
 ### [Organizations](https://www.keycloak.org/docs-api/26.0.0/rest-api/index.html#_organizations)
 

src/Resource/Groups.php

@@ -5,6 +5,7 @@
 namespace Fschmtt\Keycloak\Resource;
 
 use Fschmtt\Keycloak\Collection\GroupCollection;
+use Fschmtt\Keycloak\Collection\UserCollection;
 use Fschmtt\Keycloak\Http\Command;
 use Fschmtt\Keycloak\Http\Criteria;
 use Fschmtt\Keycloak\Http\Method;
@@ -27,6 +28,20 @@ public function all(string $realm, ?Criteria $criteria = null): GroupCollection
         );
     }
 
+    public function byPath(string $realm, string $path = ''): Group
+    {
+        return $this->queryExecutor->executeQuery(
+            new Query(
+                '/admin/realms/{realm}/group-by-path/{path}',
+                Group::class,
+                [
+                    'realm' => $realm,
+                    'path' => $path,
+                ]
+            )
+        );
+    }
+
     public function children(string $realm, string $groupId, ?Criteria $criteria = null): GroupCollection
     {
         return $this->queryExecutor->executeQuery(
@@ -42,6 +57,21 @@ public function children(string $realm, string $groupId, ?Criteria $criteria = n
         );
     }
 
+    public function members(string $realm, string $groupId, ?Criteria $criteria = null): UserCollection
+    {
+        return $this->queryExecutor->executeQuery(
+            new Query(
+                '/admin/realms/{realm}/groups/{groupId}/members',
+                UserCollection::class,
+                [
+                    'realm' => $realm,
+                    'groupId' => $groupId,
+                ],
+                $criteria
+            )
+        );
+    }
+
     public function get(string $realm, string $groupId): Group
     {
         return $this->queryExecutor->executeQuery(

tests/Integration/Resource/GroupsTest.php

@@ -77,5 +77,10 @@ public function testCreateChildGroup(): void
         $childGroup = $childGroups->first();
         static::assertInstanceOf(Group::class, $childGroup);
         static::assertSame($childGroupName, $childGroup->getName());
+
+        // get child group by path
+        $pathGroup = $groups->byPath('master', $importedGroupName.'/'.$childGroupName);
+        static::assertInstanceOf(Group::class, $pathGroup);
+        static::assertSame($childGroup->getId(), $pathGroup->getId());
     }
 }

tests/Integration/Resource/UsersTest.php

@@ -92,6 +92,12 @@ public function testJoinRetrieveLeaveGroupUser(): void
         static::assertInstanceOf(Group::class, $userFirstGroup);
         static::assertSame($group->getId(), $userFirstGroup->getId());
 
+        // get group members
+        $groupMembers = $groups->members('master', $group->getId());
+        static::assertSame(1, $groupMembers->count());
+        static::assertInstanceOf(User::class, $groupMembers->first());
+        static::assertSame($user->getId(), $groupMembers->first()->getId());
+
         // leave group
         $users->leaveGroup('master', $user->getId(), $group->getId());