Skip to content
Merged
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
3 changes: 2 additions & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@
}
],
"require": {
"php": "^8.3"
"php": "^8.3",
"saloonphp/saloon": "^4.0"
},
"require-dev": {
"pestphp/pest": "^4.0",
Expand Down
26 changes: 25 additions & 1 deletion src/NieuwbouwOffice.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,28 @@

namespace NieuwbouwOffice\PhpSdk;

class NieuwbouwOffice {}
use Saloon\Http\Auth\TokenAuthenticator;
use Saloon\Http\Connector;
use Saloon\Traits\Plugins\AcceptsJson;
use Saloon\Traits\Plugins\AlwaysThrowOnErrors;

class NieuwbouwOffice extends Connector
{
use AcceptsJson;
use AlwaysThrowOnErrors;

public function __construct(
protected string $token,
protected string $baseUrl = 'https://api.nbo.nl/rest',
) {}

public function resolveBaseUrl(): string
{
return $this->baseUrl;
}

protected function defaultAuth(): TokenAuthenticator
{
return new TokenAuthenticator($this->token, 'apikey');
}
}
5 changes: 0 additions & 5 deletions tests/ExampleTest.php

This file was deleted.

73 changes: 73 additions & 0 deletions tests/NieuwbouwOfficeTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
<?php

use NieuwbouwOffice\PhpSdk\NieuwbouwOffice;
use Saloon\Enums\Method;
use Saloon\Http\Auth\TokenAuthenticator;
use Saloon\Http\Connector;
use Saloon\Http\Request;

it('extends the saloon connector', function () {
expect(new NieuwbouwOffice('test-token'))->toBeInstanceOf(Connector::class);
});

it('uses the default base url when none is provided', function () {
$connector = new NieuwbouwOffice('test-token');

expect($connector->resolveBaseUrl())->toBe('https://api.nbo.nl/rest');
});

it('allows the base url to be overridden via the constructor', function () {
$connector = new NieuwbouwOffice('test-token', 'https://staging.nbo.nl/rest');

expect($connector->resolveBaseUrl())->toBe('https://staging.nbo.nl/rest');
});

it('authenticates requests with an apikey-prefixed token', function () {
$connector = new NieuwbouwOffice('my-secret-token');

$authenticator = (function () {
return $this->defaultAuth();
})->call($connector);

expect($authenticator)
->toBeInstanceOf(TokenAuthenticator::class)
->and($authenticator->token)->toBe('my-secret-token')
->and($authenticator->prefix)->toBe('apikey');
});

it('sends the apikey authorization header on outgoing requests', function () {
$connector = new NieuwbouwOffice('my-secret-token');

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

public function resolveEndpoint(): string
{
return '/ping';
}
};

$pendingRequest = $connector->createPendingRequest($request);

expect($pendingRequest->headers()->get('Authorization'))
->toBe('apikey my-secret-token');
});

it('accepts json by default', function () {
$connector = new NieuwbouwOffice('test-token');

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

public function resolveEndpoint(): string
{
return '/ping';
}
};

$pendingRequest = $connector->createPendingRequest($request);

expect($pendingRequest->headers()->get('Accept'))->toBe('application/json');
});