Initial commit

Author: f3ath

.gitignore

@@ -0,0 +1,3 @@
+composer.phar
+/vendor/
+composer.lock

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Alexey
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,54 @@
+# Implementation of [JSON API](jsonapi.org) in PHP
+
+## WARNING! Work in progress! The internal library API is not stable yet!
+This library is an attempt to express business rules of JSON API specification in a set of PHP 7 classes.
+
+A simple example to illustrate the general idea. This (slightly modified) JSON representation from
+[the documentation](http://jsonapi.org/format/#document-resource-objects)
+
+```json
+{
+    "data": {
+        "type": "articles",
+        "id": "1",
+        "attributes": {
+            "title": "Rails is Omakase"
+        },
+        "relationships": {
+            "author": {
+                "data": {
+                    "type": "people",
+                    "id": "9"
+                },
+                "links": {
+                    "self": "\/articles\/1\/relationships\/author",
+                    "related": "\/articles\/1\/author"
+                }
+            }
+        }
+    }
+}
+```
+can be built with the following php code:
+```php
+$author = Relationship::fromLinkage(
+    Linkage::fromSingleResourceId(
+        new ResourceId('people', '9')
+    )
+);
+$author->setLink('self', '/articles/1/relationships/author');
+$author->setLink('related', '/articles/1/author');
+
+$articles = new Resource('articles', '1');
+$articles->setRelationship('author', $author);
+$articles->setAttribute('title', 'Rails is Omakase');
+
+echo json_encode(Document::fromData($articles), JSON_PRETTY_PRINT);
+```
+
+Please refer to [the tests](./test) for the full API documentation:
+* [Document](./test/Document/DocumentTest.php)
+* [Errors](./test/Document/ErrorTest.php)
+* [Resources](./test/Document/Resource/ResourceTest.php)
+* [Relationships](./test/Document/Resource/Relationship/RelationshipTest.php)
+* [Linkage](./test/Document/Resource/Relationship/LinkageTest.php)

composer.json

@@ -0,0 +1,25 @@
+{
+  "name": "json-api-php/json-api",
+  "description": "jsonapi.org",
+  "type": "library",
+
+  "license": "MIT",
+  "authors": [
+    {
+      "name": "Alexey Karapetov",
+      "email": "[email protected]"
+    }
+  ],
+  "require": {
+    "php": ">=7.0"
+  },
+  "require-dev": {
+    "phpunit/phpunit": "^6.0",
+    "squizlabs/php_codesniffer": "2.8.*"
+  },
+  "autoload": {
+    "psr-4": {
+      "JsonApiPhp\\JsonApi\\": "src/"
+    }
+  }
+}

phpcs.xml.dist

@@ -0,0 +1,7 @@
+<?xml version="1.0"?>
+<ruleset>
+    <file>src</file>
+    <file>test</file>
+    <exclude-pattern>vendor/*</exclude-pattern>
+    <rule ref="PSR2"/>
+</ruleset>

phpunit.xml.dist

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<phpunit
+        bootstrap="test/bootstrap.php"
+        stopOnFailure="false"
+        verbose="true"
+        syntaxCheck="true">
+    <testsuites>
+        <testsuite name="Main">
+            <directory>./test</directory>
+        </testsuite>
+    </testsuites>
+    <filter>
+        <whitelist>
+            <directory suffix=".php">./src/</directory>
+        </whitelist>
+    </filter>
+</phpunit>

src/Document/Document.php

@@ -0,0 +1,81 @@
+<?php
+declare(strict_types=1);
+
+namespace JsonApiPhp\JsonApi\Document;
+
+use JsonApiPhp\JsonApi\HasLinksAndMeta;
+
+final class Document implements \JsonSerializable
+{
+    const MEDIA_TYPE = 'application/vnd.api+json';
+    const DEFAULT_API_VERSION = '1.0';
+
+    use HasLinksAndMeta;
+
+    protected $data;
+    protected $errors;
+    protected $meta;
+    protected $jsonapi;
+    protected $links;
+
+    /**
+     * Use named constructors instead
+     */
+    private function __construct()
+    {
+    }
+
+    public static function fromMeta(array $meta): self
+    {
+        $doc = new self;
+        $doc->replaceMeta($meta);
+        return $doc;
+    }
+
+    public static function fromErrors(Error ...$errors): self
+    {
+        $doc = new self;
+        $doc->errors = $errors;
+        return $doc;
+    }
+
+    public static function fromData(PrimaryData $data): self
+    {
+        $doc = new self;
+        $doc->data = $data;
+        return $doc;
+    }
+
+    public static function fromDataItems(PrimaryDataItem ...$data): self
+    {
+        $doc = new self;
+        $doc->data = $data;
+        return $doc;
+    }
+
+    public function setApiVersion(string $version = self::DEFAULT_API_VERSION): void
+    {
+        $this->jsonapi['version'] = $version;
+    }
+
+    public function setApiMeta(array $meta): void
+    {
+        $this->jsonapi['meta'] = $meta;
+    }
+
+    public function jsonSerialize()
+    {
+        return array_filter(
+            [
+                'data'    => $this->data,
+                'errors'  => $this->errors,
+                'meta'    => $this->meta,
+                'jsonapi' => $this->jsonapi,
+                'links'   => $this->links,
+            ],
+            function ($v) {
+                return null !== $v;
+            }
+        );
+    }
+}

src/Document/Error.php

@@ -0,0 +1,80 @@
+<?php
+declare(strict_types=1);
+
+namespace JsonApiPhp\JsonApi\Document;
+
+use JsonApiPhp\JsonApi\HasMeta;
+
+final class Error implements \JsonSerializable
+{
+    use HasMeta;
+
+    private $id;
+    private $links;
+    private $status;
+    private $code;
+    private $title;
+    private $detail;
+    private $source;
+    private $meta;
+
+    public function setId(string $id): void
+    {
+        $this->id = $id;
+    }
+
+    public function setAboutLink(string $link): void
+    {
+        $this->links['about'] = $link;
+    }
+
+    public function setStatus(string $status): void
+    {
+        $this->status = $status;
+    }
+
+    public function setCode(string $code): void
+    {
+        $this->code = $code;
+    }
+
+
+    public function setTitle(string $title): void
+    {
+        $this->title = $title;
+    }
+
+    public function setDetail(string $detail): void
+    {
+        $this->detail = $detail;
+    }
+
+    public function setSourcePointer(string $pointer): void
+    {
+        $this->source['pointer'] = $pointer;
+    }
+
+    public function setSourceParameter(string $parameter): void
+    {
+        $this->source['parameter'] = $parameter;
+    }
+
+    public function jsonSerialize()
+    {
+        return array_filter(
+            [
+                'id'     => $this->id,
+                'links'  => $this->links,
+                'status' => $this->status,
+                'code'   => $this->code,
+                'title'  => $this->title,
+                'detail' => $this->detail,
+                'source' => $this->source,
+                'meta'   => $this->meta,
+            ],
+            function ($v) {
+                return null !== $v;
+            }
+        ) ?: (object)[];
+    }
+}

src/Document/PrimaryData.php

@@ -0,0 +1,12 @@
+<?php
+declare(strict_types=1);
+
+namespace JsonApiPhp\JsonApi\Document;
+
+/**
+ * Primary data of a Single Resource Document
+ * @package F3\JsonApi\Resource
+ */
+interface PrimaryData extends \JsonSerializable
+{
+}

src/Document/PrimaryDataItem.php

@@ -0,0 +1,12 @@
+<?php
+declare(strict_types=1);
+
+namespace JsonApiPhp\JsonApi\Document;
+
+/**
+ * Primary Data Element of a Multi Resource Document
+ * @package F3\JsonApi\Resource
+ */
+interface PrimaryDataItem extends \JsonSerializable
+{
+}