Skip to content

Add Media DTO and shared GetMediaRequest #12

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.

Sign up for GitHub

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

Merged
jhhazelaar merged 1 commit into from
May 20, 2026
Merged

Add Media DTO and shared GetMediaRequest #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
38 changes: 38 additions & 0 deletions src/Data/Media.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
<?php

namespace NieuwbouwOffice\PhpSdk\Data;

use Carbon\CarbonImmutable;

class Media
{
public function __construct(
public readonly string $uuid,
public readonly string $filename,
public readonly ?string $title,
public readonly string $extension,
public readonly string $url,
public readonly ?string $label,
public readonly ?int $order,
public readonly CarbonImmutable $created_at,
) {}

public static function fromResponse(array $data): self
{
return new self(
uuid: $data['Media_UUId'],
filename: $data['Media_Filename'],
title: $data['Media_Titel'] ?? null,
extension: $data['Media_Extensie'],
url: $data['URL'],
label: $data['Label'] ?? null,
order: self::toInt($data['Volgorde'] ?? null),
created_at: CarbonImmutable::parse($data['Media_Timestamp']),
);
}

private static function toInt(mixed $value): ?int
{
return $value === null ? null : (int) $value;
}
}
31 changes: 31 additions & 0 deletions src/Requests/Media/GetMediaRequest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
<?php

namespace NieuwbouwOffice\PhpSdk\Requests\Media;

use NieuwbouwOffice\PhpSdk\Data\Media;
use Saloon\Enums\Method;
use Saloon\Http\Request;
use Saloon\Http\Response;

class GetMediaRequest extends Request
{
protected Method $method = Method::GET;

public function __construct(public Request $parent) {}

public function resolveEndpoint(): string
{
return rtrim($this->parent->resolveEndpoint(), '/').'/media/';
}

/**
* @return Media[]
*/
public function createDtoFromResponse(Response $response): array
{
return array_map(
fn (array $object) => Media::fromResponse($object),
$response->json('data.objects'),
);
}
}
12 changes: 12 additions & 0 deletions src/Resources/ProjectResource.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@

namespace NieuwbouwOffice\PhpSdk\Resources;

use NieuwbouwOffice\PhpSdk\Data\Media;
use NieuwbouwOffice\PhpSdk\Data\Project;
use NieuwbouwOffice\PhpSdk\Requests\Media\GetMediaRequest;
use NieuwbouwOffice\PhpSdk\Requests\Projects\GetProjectRequest;
use NieuwbouwOffice\PhpSdk\Requests\Projects\GetProjectsRequest;
use Saloon\Http\BaseResource;
Expand All @@ -21,4 +23,14 @@ public function get(string $uuid): Project
{
return $this->connector->send(new GetProjectRequest($uuid))->dto();
}

/**
* @return Media[]
*/
public function media(string $uuid): array
{
return $this->connector
->send(new GetMediaRequest(new GetProjectRequest($uuid)))
->dto();
}
}
12 changes: 12 additions & 0 deletions src/Resources/UnitResource.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@

namespace NieuwbouwOffice\PhpSdk\Resources;

use NieuwbouwOffice\PhpSdk\Data\Media;
use NieuwbouwOffice\PhpSdk\Data\Unit;
use NieuwbouwOffice\PhpSdk\Requests\Media\GetMediaRequest;
use NieuwbouwOffice\PhpSdk\Requests\Units\GetUnitRequest;
use NieuwbouwOffice\PhpSdk\Requests\Units\GetUnitsRequest;
use Saloon\Http\BaseResource;
Expand All @@ -29,4 +31,14 @@ public function get(string $uuid): Unit
{
return $this->connector->send(new GetUnitRequest($this->projectUuid, $uuid))->dto();
}

/**
* @return Media[]
*/
public function media(string $uuid): array
{
return $this->connector
->send(new GetMediaRequest(new GetUnitRequest($this->projectUuid, $uuid)))
->dto();
}
}
12 changes: 12 additions & 0 deletions src/Resources/UnitTypeResource.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@

namespace NieuwbouwOffice\PhpSdk\Resources;

use NieuwbouwOffice\PhpSdk\Data\Media;
use NieuwbouwOffice\PhpSdk\Data\UnitType;
use NieuwbouwOffice\PhpSdk\Requests\Media\GetMediaRequest;
use NieuwbouwOffice\PhpSdk\Requests\UnitTypes\GetUnitTypeRequest;
use NieuwbouwOffice\PhpSdk\Requests\UnitTypes\GetUnitTypesRequest;
use Saloon\Http\BaseResource;
Expand All @@ -29,4 +31,14 @@ public function get(string $uuid): UnitType
{
return $this->connector->send(new GetUnitTypeRequest($this->projectUuid, $uuid))->dto();
}

/**
* @return Media[]
*/
public function media(string $uuid): array
{
return $this->connector
->send(new GetMediaRequest(new GetUnitTypeRequest($this->projectUuid, $uuid)))
->dto();
}
}
45 changes: 45 additions & 0 deletions tests/Data/MediaTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
<?php

use Carbon\CarbonImmutable;
use NieuwbouwOffice\PhpSdk\Data\Media;

it('exposes its properties as readonly public values', function () {
$createdAt = CarbonImmutable::parse('2025-12-02 14:43:30');

$media = new Media(
uuid: 'f40985b31bf3ef6e78dded76be712c0e',
filename: '33800-ext-02-appartementen-klein.jpg',
title: null,
extension: 'jpg',
url: '//static.nbo.nl//media/f4/f40985b31bf3ef6e78dded76be712c0e/O/33800-ext-02-appartementen-klein.jpg',
label: 'Algemeen',
order: 1,
created_at: $createdAt,
);

expect($media->uuid)->toBe('f40985b31bf3ef6e78dded76be712c0e')
->and($media->filename)->toBe('33800-ext-02-appartementen-klein.jpg')
->and($media->title)->toBeNull()
->and($media->extension)->toBe('jpg')
->and($media->url)->toBe('//static.nbo.nl//media/f4/f40985b31bf3ef6e78dded76be712c0e/O/33800-ext-02-appartementen-klein.jpg')
->and($media->label)->toBe('Algemeen')
->and($media->order)->toBe(1)
->and($media->created_at)->toBe($createdAt);
});

it('parses Media_Timestamp into a CarbonImmutable via fromResponse()', function () {
$media = Media::fromResponse([
'Media_UUId' => 'abc',
'Media_Filename' => 'image.jpg',
'Media_Titel' => null,
'Media_Extensie' => 'jpg',
'URL' => '//static.nbo.nl/media/ab/abc/O/image.jpg',
'Label' => 'Algemeen',
'Volgorde' => '3',
'Media_Timestamp' => '2025-12-02 14:43:30',
]);

expect($media->created_at)->toBeInstanceOf(CarbonImmutable::class)
->and($media->created_at->toDateTimeString())->toBe('2025-12-02 14:43:30')
->and($media->order)->toBe(3);
});
77 changes: 77 additions & 0 deletions tests/Requests/Media/GetMediaRequestTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
<?php

use NieuwbouwOffice\PhpSdk\Data\Media;
use NieuwbouwOffice\PhpSdk\NieuwbouwOffice;
use NieuwbouwOffice\PhpSdk\Requests\Media\GetMediaRequest;
use NieuwbouwOffice\PhpSdk\Requests\Projects\GetProjectRequest;
use NieuwbouwOffice\PhpSdk\Requests\Units\GetUnitRequest;
use NieuwbouwOffice\PhpSdk\Requests\UnitTypes\GetUnitTypeRequest;
use Saloon\Enums\Method;
use Saloon\Http\Faking\MockClient;
use Saloon\Http\Faking\MockResponse;

it('uses the GET method', function () {
expect((new GetMediaRequest(new GetProjectRequest('proj-1')))->getMethod())->toBe(Method::GET);
});

it('appends /media/ to the parent project endpoint', function () {
expect((new GetMediaRequest(new GetProjectRequest('proj-1')))->resolveEndpoint())
->toBe('/projects/proj-1/media/');
});

it('appends /media/ to the parent unit-type endpoint', function () {
expect((new GetMediaRequest(new GetUnitTypeRequest('proj-1', 'type-9')))->resolveEndpoint())
->toBe('/projects/proj-1/projectwoningen/type-9/media/');
});

it('appends /media/ to the parent unit endpoint', function () {
expect((new GetMediaRequest(new GetUnitRequest('proj-1', 'unit-9')))->resolveEndpoint())
->toBe('/projects/proj-1/woningen/unit-9/media/');
});

it('creates an array of Media DTOs from the response', function () {
$mockClient = new MockClient([
GetMediaRequest::class => MockResponse::make([
'data' => [
'objects' => [
[
'Media_UUId' => 'f40985b31bf3ef6e78dded76be712c0e',
'Media_Filename' => '33800-ext-02-appartementen-klein.jpg',
'Media_Titel' => null,
'Media_Extensie' => 'jpg',
'Media_Timestamp' => '2025-12-02 14:43:30',
'URL' => '//static.nbo.nl//media/f4/f40985b31bf3ef6e78dded76be712c0e/O/33800-ext-02-appartementen-klein.jpg',
'Label' => 'Algemeen',
'Volgorde' => '1',
],
[
'Media_UUId' => 'ab59d24f8a6204830700e8ecac697d9a',
'Media_Filename' => '33800-ext-01-rijwoningen-poort-klein.jpg',
'Media_Titel' => null,
'Media_Extensie' => 'jpg',
'Media_Timestamp' => '2025-12-02 14:43:30',
'URL' => '//static.nbo.nl//media/ab/ab59d24f8a6204830700e8ecac697d9a/O/33800-ext-01-rijwoningen-poort-klein.jpg',
'Label' => 'Algemeen',
'Volgorde' => '2',
],
],
],
'meta' => ['count' => 2],
]),
]);

$connector = new NieuwbouwOffice('test-token');
$connector->withMockClient($mockClient);

$media = $connector->send(new GetMediaRequest(new GetProjectRequest('proj-1')))->dto();

expect($media)->toBeArray()->toHaveCount(2)
->and($media[0])->toBeInstanceOf(Media::class)
->and($media[0]->uuid)->toBe('f40985b31bf3ef6e78dded76be712c0e')
->and($media[0]->filename)->toBe('33800-ext-02-appartementen-klein.jpg')
->and($media[0]->extension)->toBe('jpg')
->and($media[0]->label)->toBe('Algemeen')
->and($media[0]->order)->toBe(1)
->and($media[0]->created_at->toDateTimeString())->toBe('2025-12-02 14:43:30')
->and($media[1]->order)->toBe(2);
});
37 changes: 37 additions & 0 deletions tests/Resources/ProjectResourceTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
<?php

use NieuwbouwOffice\PhpSdk\Data\Media;
use NieuwbouwOffice\PhpSdk\Data\Project;
use NieuwbouwOffice\PhpSdk\NieuwbouwOffice;
use NieuwbouwOffice\PhpSdk\Requests\Media\GetMediaRequest;
use NieuwbouwOffice\PhpSdk\Requests\Projects\GetProjectRequest;
use NieuwbouwOffice\PhpSdk\Requests\Projects\GetProjectsRequest;
use NieuwbouwOffice\PhpSdk\Resources\ProjectResource;
Expand Down Expand Up @@ -73,6 +75,41 @@
});
});

it('media() sends a GetMediaRequest wrapping a GetProjectRequest and returns an array of Media DTOs', function () {
$mockClient = new MockClient([
GetMediaRequest::class => MockResponse::make([
'data' => [
'objects' => [
[
'Media_UUId' => 'm1',
'Media_Filename' => 'a.jpg',
'Media_Extensie' => 'jpg',
'URL' => '//static.nbo.nl/media/m1.jpg',
'Label' => 'Algemeen',
'Volgorde' => '1',
'Media_Timestamp' => '2025-12-02 14:43:30',
],
],
],
'meta' => ['count' => 1],
]),
]);

$connector = new NieuwbouwOffice('test-token');
$connector->withMockClient($mockClient);

$media = $connector->projects()->media('abc-123');

expect($media)->toBeArray()->toHaveCount(1)
->and($media[0])->toBeInstanceOf(Media::class)
->and($media[0]->uuid)->toBe('m1');

$mockClient->assertSent(function ($request) {
return $request instanceof GetMediaRequest
&& $request->resolveEndpoint() === '/projects/abc-123/media/';
});
});

it('can be instantiated directly with a connector', function () {
$connector = new NieuwbouwOffice('test-token');

Expand Down
37 changes: 37 additions & 0 deletions tests/Resources/UnitResourceTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
<?php

use NieuwbouwOffice\PhpSdk\Data\Media;
use NieuwbouwOffice\PhpSdk\Data\Unit;
use NieuwbouwOffice\PhpSdk\NieuwbouwOffice;
use NieuwbouwOffice\PhpSdk\Requests\Media\GetMediaRequest;
use NieuwbouwOffice\PhpSdk\Requests\Units\GetUnitRequest;
use NieuwbouwOffice\PhpSdk\Requests\Units\GetUnitsRequest;
use NieuwbouwOffice\PhpSdk\Resources\UnitResource;
Expand Down Expand Up @@ -76,6 +78,41 @@
});
});

it('media() sends a GetMediaRequest wrapping a GetUnitRequest and returns an array of Media DTOs', function () {
$mockClient = new MockClient([
GetMediaRequest::class => MockResponse::make([
'data' => [
'objects' => [
[
'Media_UUId' => 'm1',
'Media_Filename' => 'a.jpg',
'Media_Extensie' => 'jpg',
'URL' => '//static.nbo.nl/media/m1.jpg',
'Label' => 'Algemeen',
'Volgorde' => '1',
'Media_Timestamp' => '2025-12-02 14:43:30',
],
],
],
'meta' => ['count' => 1],
]),
]);

$connector = new NieuwbouwOffice('test-token');
$connector->withMockClient($mockClient);

$media = $connector->units('proj-1')->media('unit-9');

expect($media)->toBeArray()->toHaveCount(1)
->and($media[0])->toBeInstanceOf(Media::class)
->and($media[0]->uuid)->toBe('m1');

$mockClient->assertSent(function ($request) {
return $request instanceof GetMediaRequest
&& $request->resolveEndpoint() === '/projects/proj-1/woningen/unit-9/media/';
});
});

it('can be instantiated directly with a connector and project uuid', function () {
$connector = new NieuwbouwOffice('test-token');

Expand Down
Loading
Loading