Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: command content type #143

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/Http/Command.php
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
/** @var Representation|Collection|array<mixed>|null */
private readonly Representation|Collection|array|null $payload = null,
private readonly ?Criteria $criteria = null,
private readonly ContentType $contentType = ContentType::JSON,
) {}

public function getMethod(): Method
Expand Down Expand Up @@ -61,4 +62,9 @@

return '?' . http_build_query($this->criteria->jsonSerialize());
}

public function getContentType(): ContentType
{
return $this->contentType;

Check warning on line 68 in src/Http/Command.php

View check run for this annotation

Codecov / codecov/patch

src/Http/Command.php#L68

Added line #L68 was not covered by tests
}
}
29 changes: 10 additions & 19 deletions src/Http/CommandExecutor.php
Original file line number Diff line number Diff line change
Expand Up @@ -20,29 +20,20 @@ public function __construct(

public function executeCommand(Command $command): void
{
$payload = $command->getPayload();

if (is_array($payload)) {
$this->client->request(
$command->getMethod()->value,
$command->getPath(),
[
'form_params' => $payload,
],
);

return;
}
$options = match ($command->getContentType()) {
ContentType::JSON => [
'body' => $this->serializer->serialize($command->getPayload()),
'headers' => [
'Content-Type' => $command->getContentType()->value,
]
],
ContentType::FORM_PARAMS => ['form_params' => $command->getPayload()],
};

$this->client->request(
$command->getMethod()->value,
$command->getPath(),
[
'body' => $this->serializer->serialize($command->getPayload()),
'headers' => [
'Content-Type' => 'application/json',
],
],
$options,
);
}
}
14 changes: 14 additions & 0 deletions src/Http/ContentType.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<?php

declare(strict_types=1);

namespace Fschmtt\Keycloak\Http;

/**
* @internal
*/
enum ContentType: string
{
case JSON = 'application/json';
case FORM_PARAMS = 'application/x-www-form-urlencoded';
}
2 changes: 2 additions & 0 deletions src/Resource/Organizations.php
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

use Fschmtt\Keycloak\Collection\OrganizationCollection;
use Fschmtt\Keycloak\Http\Command;
use Fschmtt\Keycloak\Http\ContentType;
use Fschmtt\Keycloak\Http\Criteria;
use Fschmtt\Keycloak\Http\Method;
use Fschmtt\Keycloak\Http\Query;
Expand Down Expand Up @@ -71,6 +72,7 @@ public function inviteUser(string $realm, string $id, string $email, string $fir
'firstName' => $firstName,
'lastName' => $lastName,
],
contentType: ContentType::FORM_PARAMS,
),
);
}
Expand Down
1 change: 1 addition & 0 deletions src/Resource/Users.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
use Fschmtt\Keycloak\Collection\RoleCollection;
use Fschmtt\Keycloak\Collection\UserCollection;
use Fschmtt\Keycloak\Http\Command;
use Fschmtt\Keycloak\Http\ContentType;
use Fschmtt\Keycloak\Http\Criteria;
use Fschmtt\Keycloak\Http\Method;
use Fschmtt\Keycloak\Http\Query;
Expand Down
20 changes: 20 additions & 0 deletions tests/Integration/Resource/UsersTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,26 @@ public function testGetUserCredentials(): void
static::assertNull($user);
}

public function testExecuteActionsEmail(): void
{
$users = $this->getKeycloak()->users();
$username = Uuid::uuid4()->toString();

$users->create('master', new User(
username: $username,
));

$user = $this->searchUserByUsername($username);
static::assertInstanceOf(User::class, $user);

$users->executeActionsEmail('master', $user->getId(), ['UPDATE_PASSWORD']);

$users->delete('master', $user->getId());

$user = $this->searchUserByUsername($username);
static::assertNull($user);
}

private function searchUserByUsername(string $username, string $realm = 'master'): ?User
{
/** @var User|null $user */
Expand Down
8 changes: 5 additions & 3 deletions tests/Unit/Http/CommandExecutorTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
use Fschmtt\Keycloak\Http\Client;
use Fschmtt\Keycloak\Http\Command;
use Fschmtt\Keycloak\Http\CommandExecutor;
use Fschmtt\Keycloak\Http\ContentType;
use Fschmtt\Keycloak\Http\Method;
use Fschmtt\Keycloak\Json\JsonEncoder;
use Fschmtt\Keycloak\Serializer\Serializer;
Expand All @@ -30,7 +31,7 @@ public function testCallsClientWithoutBodyIfCommandHasNoRepresentation(): void
'body' => null,
'headers' => [
'Content-Type' => 'application/json',
],
]
],
);

Expand All @@ -43,7 +44,7 @@ public function testCallsClientWithoutBodyIfCommandHasNoRepresentation(): void
);
}

public function testCallsClientWithBodyIfCommandHasRepresentation(): void
public function testCallsClientWithJsonIfCommandHasRepresentation(): void
{
$command = new Command(
'/path/to/resource',
Expand Down Expand Up @@ -101,13 +102,14 @@ public function testCallsClientWithBodyIfCommandHasCollection(): void
$executor->executeCommand($command);
}

public function testCallsClientWithFormParamsIfCommandHasArrayPayload(): void
public function testCallsClientWithFormParamsIfCommandFormParamContentType(): void
{
$command = new Command(
'/path/to/resource',
Method::PUT,
[],
$payload = ['UPDATE_PASSWORD', 'VERIFY_EMAIL'],
contentType: ContentType::FORM_PARAMS,
);

$client = $this->createMock(Client::class);
Expand Down
2 changes: 2 additions & 0 deletions tests/Unit/Resource/OrganizationsTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
use Fschmtt\Keycloak\Collection\OrganizationCollection;
use Fschmtt\Keycloak\Http\Command;
use Fschmtt\Keycloak\Http\CommandExecutor;
use Fschmtt\Keycloak\Http\ContentType;
use Fschmtt\Keycloak\Http\Method;
use Fschmtt\Keycloak\Http\Query;
use Fschmtt\Keycloak\Http\QueryExecutor;
Expand Down Expand Up @@ -148,6 +149,7 @@ public function testInviteUser(): void
'firstName' => 'first name',
'lastName' => 'last name',
],
contentType: ContentType::FORM_PARAMS,
);

$commandExecutor = $this->createMock(CommandExecutor::class);
Expand Down
1 change: 1 addition & 0 deletions tests/Unit/Resource/UsersTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
use Fschmtt\Keycloak\Collection\UserCollection;
use Fschmtt\Keycloak\Http\Command;
use Fschmtt\Keycloak\Http\CommandExecutor;
use Fschmtt\Keycloak\Http\ContentType;
use Fschmtt\Keycloak\Http\Criteria;
use Fschmtt\Keycloak\Http\Method;
use Fschmtt\Keycloak\Http\Query;
Expand Down
Loading