Merge pull request #89 from punktDeForks/feature/roles-keys

FEATURE: Representations and Collection for realm keys

Author: fschmtt

README.md

@@ -128,6 +128,7 @@ $myCustomRepresentation = $myCustomResource->myCustomEndpoint();
 | `PUT /admin/realms/{realm}` | [Realm](src/Representation/Realm.php) | [Realms::update()](src/Resource/Realms.php) |
 | `DELETE /admin/realms/{realm}` | `n/a` | [Realms::delete()](src/Resource/Realms.php) |
 | `GET /admin/realms/{realm}/admin-events` | `array` | [Realms::adminEvents()](src/Resource/Realms.php) |
+| `GET /admin/realms/{realm}/keys` | [KeysMetadata](src/Representation/KeysMetadata.php) | [Realms::keys()](src/Resource/Realms.php)              |
 | `DELETE /admin/realms/{realm}/admin-events` | `n/a` | [Realms::deleteAdminEvents()](src/Resource/Realms.php) |
 | `POST /admin/realms/{realm}/clear-keys-cache` | `n/a` | [Realms::clearKeysCache()](src/Resource/Realms.php) |
 | `POST /admin/realms/{realm}/clear-realm-cache` | `n/a` | [Realms::clearRealmCache()](src/Resource/Realms.php) |

src/Collection/KeyMetadataCollection.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Fschmtt\Keycloak\Collection;
+
+use Fschmtt\Keycloak\Representation\KeyMetadata;
+
+/**
+ * @extends Collection<KeyMetadata>
+ *
+ * @codeCoverageIgnore
+ */
+class KeyMetadataCollection extends Collection
+{
+    public static function getRepresentationClass(): string
+    {
+        return KeyMetadata::class;
+    }
+}

src/Representation/KeyMetadata.php

@@ -0,0 +1,49 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Fschmtt\Keycloak\Representation;
+
+use Fschmtt\Keycloak\Attribute\Since;
+
+/**
+ * @method string|null getProviderId()
+ * @method int|null getProviderPriority()
+ * @method string|null getKid()
+ * @method string|null getStatus()
+ * @method string|null getType()
+ * @method string|null getAlgorithm()
+ * @method string|null getPublicKey()
+ * @method string|null getCertificate()
+ * @method string|null getUse()
+ * @method int|null getValidTo()
+ * @method self withProviderId(?string $providerId)
+ * @method self withProviderPriority(?int $providerPriority)
+ * @method self withKid(?string $kid)
+ * @method self withStatus(?string $status)
+ * @method self withType(?string $type)
+ * @method self withAlgorithm(?string $algorithm)
+ * @method self withPublicKey(?string $publicKey)
+ * @method self withCertificate(?string $certificate)
+ * @method self withUse(?string $use)
+ * @method self withValidTo(?int $validTo)
+ *
+ * @codeCoverageIgnore
+ */
+class KeyMetadata extends Representation
+{
+    public function __construct(
+        protected ?string $providerId = null,
+        protected ?int $providerPriority = null,
+        protected ?string $kid = null,
+        protected ?string $status = null,
+        protected ?string $type = null,
+        protected ?string $algorithm = null,
+        protected ?string $publicKey = null,
+        protected ?string $certificate = null,
+        protected ?string $use = null,
+        #[Since('23.0.0')]
+        protected ?int $validTo = null,
+    ) {
+    }
+}

src/Representation/KeysMetadata.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Fschmtt\Keycloak\Representation;
+
+use Fschmtt\Keycloak\Collection\KeyMetadataCollection;
+
+/**
+ * @method array|null getActive()
+ * @method KeyMetadataCollection|null getKeys()
+ * @method self withActive(?array $active)
+ * @method self withKeyMetadataCollection(?KeyMetadataCollection $keys)
+ *
+ * @codeCoverageIgnore
+ */
+class KeysMetadata extends Representation
+{
+    /**
+     * @param string[]|null $active
+     * @param KeyMetadataCollection|null $keys
+     */
+    public function __construct(
+        protected ?array $active = null,
+        protected ?KeyMetadataCollection $keys = null,
+    ) {
+    }
+}

src/Resource/Realms.php

@@ -9,6 +9,7 @@
 use Fschmtt\Keycloak\Http\Criteria;
 use Fschmtt\Keycloak\Http\Method;
 use Fschmtt\Keycloak\Http\Query;
+use Fschmtt\Keycloak\Representation\KeysMetadata;
 use Fschmtt\Keycloak\Representation\Realm;
 
 /**
@@ -99,6 +100,20 @@ public function adminEvents(string $realm, ?Criteria $criteria = null): array
             )
         );
     }
+    
+    public function keys(string $realm, ?Criteria $criteria = null): KeysMetadata
+    {
+        return $this->queryExecutor->executeQuery(
+            new Query(
+                '/admin/realms/{realm}/keys',
+                KeysMetadata::class,
+                [
+                    'realm' => $realm,
+                ],
+                $criteria,
+            )
+        );
+    }
 
     public function deleteAdminEvents(string $realm): void
     {

tests/Integration/Resource/RealmsTest.php

@@ -28,6 +28,13 @@ public function testCanGetRealm(): void
         static::assertEquals('master', $realm->getRealm());
     }
 
+    public function testCanGetRealmKeys(): void
+    {
+        $realmkeys = $this->getKeycloak()->realms()->keys(realm: 'master');
+        static::assertArrayHasKey('AES', $realmkeys->getActive());
+        static::assertGreaterThan(1, $realmkeys->getKeys()->count());
+    }
+
     public function testCanUpdateRealm(): void
     {
         $realm = $this->getKeycloak()->realms()->get(realm: 'master');

tests/Unit/Resource/RealmsTest.php

@@ -10,6 +10,7 @@
 use Fschmtt\Keycloak\Http\Method;
 use Fschmtt\Keycloak\Http\Query;
 use Fschmtt\Keycloak\Http\QueryExecutor;
+use Fschmtt\Keycloak\Representation\KeysMetadata;
 use Fschmtt\Keycloak\Representation\Realm;
 use Fschmtt\Keycloak\Resource\Realms;
 use PHPUnit\Framework\Attributes\CoversClass;
@@ -267,4 +268,28 @@ public function testClearUserCache(): void
         );
         $realms->clearUserCache('realm-with-cache');
     }
+
+    public function testGetKeys(): void
+    {
+        $query = new Query(
+            '/admin/realms/{realm}/keys',
+            KeysMetadata::class,
+            [
+                'realm' => 'realm-with-keys',
+            ],
+        );
+
+        $queryExecutor = $this->createMock(QueryExecutor::class);
+        $queryExecutor->expects(static::once())
+            ->method('executeQuery')
+            ->with($query)
+            ->willReturn(new KeysMetadata());
+
+        $realms = new Realms(
+            $this->createMock(CommandExecutor::class),
+            $queryExecutor,
+        );
+
+        $realms->keys('realm-with-keys');
+    }
 }