Skip to content

Add extensions and profiles to root self link #67

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
merged 7 commits into from
Aug 21, 2021
Merged

Add extensions and profiles to root self link #67

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
05b0b8e
Merge branch '2.3.0' into type-on-root-self
lode May 16, 2021
e02f986
add the extension/profile headers to the root self link
lode May 16, 2021
9c3143b
improve tests around applying extensions and profiles
lode May 16, 2021
9afcda0
test whether the extended self link works
lode May 16, 2021
d357322
re-use links initialization of the link manager
lode May 16, 2021
2675b65
Merge branch '2.3.0' into type-on-root-self
lode Aug 21, 2021
8dc7855
Merge branch '2.3.0' into type-on-root-self
lode Aug 21, 2021
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
25 changes: 18 additions & 7 deletions src/Document.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,17 @@
use alsvanzelf\jsonapi\interfaces\ExtensionInterface;
use alsvanzelf\jsonapi\interfaces\ProfileInterface;
use alsvanzelf\jsonapi\objects\JsonapiObject;
use alsvanzelf\jsonapi\objects\LinkObject;
use alsvanzelf\jsonapi\objects\LinksObject;
use alsvanzelf\jsonapi\objects\MetaObject;

/**
* @see ResourceDocument, CollectionDocument, ErrorsDocument or MetaDocument
*/
abstract class Document implements DocumentInterface, \JsonSerializable {
use AtMemberManager, ExtensionMemberManager, HttpStatusCodeManager, LinksManager;
use AtMemberManager, ExtensionMemberManager, HttpStatusCodeManager, LinksManager {
LinksManager::addLink as linkManagerAddLink;
}

const JSONAPI_VERSION_1_0 = '1.0';
const JSONAPI_VERSION_1_1 = '1.1';
Expand Down Expand Up @@ -97,11 +100,7 @@ public function __construct() {
*/
public function addLink($key, $href, array $meta=[], $level=Document::LEVEL_ROOT) {
if ($level === Document::LEVEL_ROOT) {
if ($this->links === null) {
$this->setLinksObject(new LinksObject());
}

$this->links->add($key, $href, $meta);
$this->linkManagerAddLink($key, $href, $meta);
}
elseif ($level === Document::LEVEL_JSONAPI) {
throw new InputException('level "jsonapi" can not be used for links');
Expand All @@ -117,12 +116,24 @@ public function addLink($key, $href, array $meta=[], $level=Document::LEVEL_ROOT
/**
* set the self link on the document
*
* @note a LinkObject is added when extensions or profiles are applied
*
* @param string $href
* @param array $meta optional, if given a LinkObject is added, otherwise a link string is added
* @param string $level one of the Document::LEVEL_* constants, optional, defaults to Document::LEVEL_ROOT
*/
public function setSelfLink($href, array $meta=[], $level=Document::LEVEL_ROOT) {
$this->addLink('self', $href, $meta, $level);
if ($level === Document::LEVEL_ROOT && ($this->extensions !== [] || $this->profiles !== [])) {
$contentType = Converter::prepareContentType(Document::CONTENT_TYPE_OFFICIAL, $this->extensions, $this->profiles);

$linkObject = new LinkObject($href, $meta);
$linkObject->setMediaType($contentType);

$this->addLinkObject('self', $linkObject);
}
else {
$this->addLink('self', $href, $meta, $level);
}
}

/**
Expand Down
28 changes: 24 additions & 4 deletions tests/DocumentTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,23 +237,33 @@ public function testAddLinkObject_HappyPath() {
public function testApplyExtension_HappyPath() {
$extension = new TestExtension();
$extension->setNamespace('test');
$extension->setOfficialLink('https://jsonapi.org');
$extension->setOfficialLink('https://jsonapi.org/extension');

$document = new Document();
$document->applyExtension($extension);
$document->addExtensionMember($extension, 'foo', 'bar');
$document->setSelfLink('https://jsonapi.org/foo');

$array = $document->toArray();

$this->assertCount(3, $array);
$this->assertArrayHasKey('jsonapi', $array);
$this->assertCount(2, $array['jsonapi']);
$this->assertSame('1.1', $array['jsonapi']['version']);
$this->assertArrayHasKey('ext', $array['jsonapi']);
$this->assertCount(1, $array['jsonapi']['ext']);
$this->assertArrayHasKey(0, $array['jsonapi']['ext']);
$this->assertSame('https://jsonapi.org', $array['jsonapi']['ext'][0]);
$this->assertSame('https://jsonapi.org/extension', $array['jsonapi']['ext'][0]);
$this->assertArrayHasKey('test:foo', $array);
$this->assertSame('bar', $array['test:foo']);
$this->assertArrayHasKey('links', $array);
$this->assertCount(1, $array['links']);
$this->assertArrayHasKey('self', $array['links']);
$this->assertCount(2, $array['links']['self']);
$this->assertArrayHasKey('href', $array['links']['self']);
$this->assertArrayHasKey('type', $array['links']['self']);
$this->assertSame('https://jsonapi.org/foo', $array['links']['self']['href']);
$this->assertSame('application/vnd.api+json; ext="https://jsonapi.org/extension"', $array['links']['self']['type']);
}

/**
Expand Down Expand Up @@ -298,20 +308,30 @@ public function testApplyExtension_ConflictingNamespace() {
*/
public function testApplyProfile_HappyPath() {
$profile = new TestProfile();
$profile->setOfficialLink('https://jsonapi.org');
$profile->setOfficialLink('https://jsonapi.org/profile');

$document = new Document();
$document->applyProfile($profile);
$document->setSelfLink('https://jsonapi.org/foo');

$array = $document->toArray();

$this->assertCount(2, $array);
$this->assertArrayHasKey('jsonapi', $array);
$this->assertCount(2, $array['jsonapi']);
$this->assertSame('1.1', $array['jsonapi']['version']);
$this->assertArrayHasKey('profile', $array['jsonapi']);
$this->assertCount(1, $array['jsonapi']['profile']);
$this->assertArrayHasKey(0, $array['jsonapi']['profile']);
$this->assertSame('https://jsonapi.org', $array['jsonapi']['profile'][0]);
$this->assertSame('https://jsonapi.org/profile', $array['jsonapi']['profile'][0]);
$this->assertArrayHasKey('links', $array);
$this->assertCount(1, $array['links']);
$this->assertArrayHasKey('self', $array['links']);
$this->assertCount(2, $array['links']['self']);
$this->assertArrayHasKey('href', $array['links']['self']);
$this->assertArrayHasKey('type', $array['links']['self']);
$this->assertSame('https://jsonapi.org/foo', $array['links']['self']['href']);
$this->assertSame('application/vnd.api+json; profile="https://jsonapi.org/profile"', $array['links']['self']['type']);
}

public function testToJson_HappyPath() {
Expand Down