Clientbase
/
json-api-server
mirror of https://github.com/basemaster/json-api-server.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

wip

This commit is contained in:
Toby Zerner 2019-08-14 22:49:19 +02:00
parent 25ef9ab56f
commit 40776bc6ab
38 changed files with 455 additions and 327 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

282
README.md
View File

@ -1,20 +1,20 @@
# tobscure/json-api-server # tobyz/json-api-server
[![Build Status](https://img.shields.io/travis/com/tobscure/json-api-server.svg?style=flat)](https://travis-ci.com/tobscure/json-api-server) [![Build Status](https://img.shields.io/travis/com/tobyz/json-api-server.svg?style=flat)](https://travis-ci.com/tobyz/json-api-server)
[![Pre Release](https://img.shields.io/packagist/vpre/tobscure/json-api-server.svg?style=flat)](https://github.com/tobscure/json-api-server/releases) [![Pre Release](https://img.shields.io/packagist/vpre/tobyz/json-api-server.svg?style=flat)](https://github.com/tobyz/json-api-server/releases)
[![License](https://img.shields.io/packagist/l/tobscure/json-api-server.svg?style=flat)](https://packagist.org/packages/tobscure/json-api-server) [![License](https://img.shields.io/packagist/l/tobyz/json-api-server.svg?style=flat)](https://packagist.org/packages/tobyz/json-api-server)
**A fully automated framework-agnostic [JSON:API](http://jsonapi.org) server implementation in PHP.** **A fully automated framework-agnostic [JSON:API](http://jsonapi.org) server implementation in PHP.**
Define your schema, plug in your models, and we'll take care of the rest. 🍻 Define your schema, plug in your models, and we'll take care of the rest. 🍻
```bash ```bash
composer require tobscure/json-api-server composer require tobyz/json-api-server
``` ```
```php ```php
use Tobscure\JsonApiServer\Api; use Tobyz\JsonApiServer\Api;
use Tobscure\JsonApiServer\Adapter\EloquentAdapter; use Tobyz\JsonApiServer\Adapter\EloquentAdapter;
use Tobscure\JsonApiServer\Schema\Builder; use Tobyz\JsonApiServer\Schema\Builder;
$api = new Api('http://example.com/api'); $api = new Api('http://example.com/api');
@ -44,7 +44,7 @@ try {
} }
``` ```
Assuming you have a few [Eloquent](https://laravel.com/docs/5.7/eloquent) models set up, the above code will serve a **complete JSON:API that conforms to the [spec](https://jsonapi.org/format/)**, including support for: Assuming you have a few [Eloquent](https://laravel.com/docs/5.8/eloquent) models set up, the above code will serve a **complete JSON:API that conforms to the [spec](https://jsonapi.org/format/)**, including support for:
- **Showing** individual resources (`GET /api/articles/1`) - **Showing** individual resources (`GET /api/articles/1`)
- **Listing** resource collections (`GET /api/articles`) - **Listing** resource collections (`GET /api/articles`)
@ -60,7 +60,7 @@ The schema definition is extremely powerful and lets you easily apply [permissio
### Handling Requests ### Handling Requests
```php ```php
use Tobscure\JsonApiServer\Api; use Tobyz\JsonApiServer\Api;
$api = new Api('http://example.com/api'); $api = new Api('http://example.com/api');
@ -71,24 +71,24 @@ try {
} }
``` ```
`Tobscure\JsonApiServer\Api` is a [PSR-15 Request Handler](https://www.php-fig.org/psr/psr-15/). Instantiate it with your API's base URL. Convert your framework's request object into a [PSR-7 Request](https://www.php-fig.org/psr/psr-7/#321-psrhttpmessageserverrequestinterface) implementation, then let the `Api` handler take it from there. Catch any exceptions and give them back to `Api` if you want a JSON:API error response. `Tobyz\JsonApiServer\Api` is a [PSR-15 Request Handler](https://www.php-fig.org/psr/psr-15/). Instantiate it with your API's base URL. Convert your framework's request object into a [PSR-7 Request](https://www.php-fig.org/psr/psr-7/#321-psrhttpmessageserverrequestinterface) implementation, then let the `Api` handler take it from there. Catch any exceptions and give them back to `Api` if you want a JSON:API error response.
### Defining Resources ### Defining Resources
Define your API's resources using the `resource` method. The first argument is the [resource type](https://jsonapi.org/format/#document-resource-object-identification). The second is an implementation of `Tobscure\JsonApiServer\Adapter\AdapterInterface` which will allow the handler to interact with your models. The third is a closure in which you'll build the schema for your resource. Define your API's resources using the `resource` method. The first argument is the [resource type](https://jsonapi.org/format/#document-resource-object-identification). The second is an instance of `Tobyz\JsonApiServer\Adapter\AdapterInterface` which will allow the handler to interact with your models. The third is a closure in which you'll build the schema for your resource.
```php ```php
use Tobscure\JsonApiServer\Schema\Builder; use Tobyz\JsonApiServer\Schema\Builder;
$api->resource('comments', $adapter, function (Builder $schema) { $api->resource('comments', $adapter, function (Builder $schema) {
// define your schema // define your schema
}); });
``` ```
We provide an `EloquentAdapter` to hook your resources up with Laravel [Eloquent](https://laravel.com/docs/5.7/eloquent) models. Set it up with an instance of the model that your resource represents. You can [implement your own adapter](https://github.com/tobscure/json-api-server/blob/master/src/Adapter/AdapterInterface.php) if you use a different ORM. We provide an `EloquentAdapter` to hook your resources up with Laravel [Eloquent](https://laravel.com/docs/5.8/eloquent) models. Set it up with an instance of the model that your resource represents. You can [implement your own adapter](https://github.com/tobyz/json-api-server/blob/master/src/Adapter/AdapterInterface.php) if you use a different ORM.
```php ```php
use Tobscure\JsonApiServer\Adapter\EloquentAdapter; use Tobyz\JsonApiServer\Adapter\EloquentAdapter;
$adapter = new EloquentAdapter(new User); $adapter = new EloquentAdapter(new User);
``` ```
@ -124,23 +124,67 @@ $schema->hasOne('author', 'people');
Like attributes, the relationship will automatically read and write to the relation on your model with the same name. If you'd like it to correspond to a different relation, provide it as a third argument. Like attributes, the relationship will automatically read and write to the relation on your model with the same name. If you'd like it to correspond to a different relation, provide it as a third argument.
Has-one relationships are available for [inclusion](https://jsonapi.org/format/#fetching-includes) via the `include` query parameter. You can include them by default, if the `include` query parameter is empty, by calling the `included` method: #### Relationship Links
Relationships include [`self`](https://jsonapi.org/format/#fetching-relationships) and [`related`](https://jsonapi.org/format/#document-resource-object-related-resource-links) links automatically. For some relationships it may not make sense to have them accessible via their own URL; you may disable these links by calling the `noLinks` method:
```php
$schema->hasOne('mostRelevantPost')
->noLinks();
```
> **Note:** Accessing these URLs is not yet implemented.
#### Relationship Linkage
By default relationships include no [resource linkage](https://jsonapi.org/format/#document-resource-object-linkage). You can toggle this (without forcing the related resources to be included) by calling the `linkage` or `noLinkage` methods.
```php ```php
$schema->hasOne('user') $schema->hasOne('user')
->included(); ->linkage();
``` ```
Has-many relationships must be explicitly made available for inclusion via the `includable` method. This is because pagination of included resources is not supported, so performance may suffer if there are large numbers of related resources. > **Warning:** Be careful when enabling linkage on to-many relationships as pagination is not supported.
#### Relationship Inclusion
To make a relationship available for [inclusion](https://jsonapi.org/format/#fetching-includes) via the `include` query parameter, call the `includable` method.
```php ```php
$schema->hasMany('comments') $schema->hasOne('user')
->includable(); ->includable();
``` ```
> **Warning:** Be careful when making to-many relationships includable as pagination is not supported.
Relationships included via the `include` query parameter are automatically eager-loaded. However, you may wish to define your own eager-loading logic, or prevent a relationship from being eager-loaded. You can do so using the `loadable` and `notLoadable` methods:
```php
$schema->hasOne('user')
->includable()
->loadable(function ($models, $request) {
collect($models)->load(['user' => function () { /* constraints */ }]);
});
$schema->hasOne('user')
->includable()
->notLoadable();
```
#### Polymorphic Relationships
Define polymorphic relationships on your resource using the `morphOne` and `morphMany` methods:
```php
$schema->morphOne('commentable');
$schema->morphMany('taggable');
```
Polymorphic relationships do not accept a second argument for the resource type, because it will be automatically derived from each related resource. Nested includes cannot be requested on these relationships.
### Getters ### Getters
Use the `get` method to define custom retrieval logic for your field, instead of just reading the value straight from the model property. (Of course, if you're using Eloquent, you could also define [casts](https://laravel.com/docs/5.7/eloquent-mutators#attribute-casting) or [accessors](https://laravel.com/docs/5.7/eloquent-mutators#defining-an-accessor) on your model to achieve a similar thing.) Use the `get` method to define custom retrieval logic for your field, instead of just reading the value straight from the model property. (If you're using Eloquent, you could also define [casts](https://laravel.com/docs/5.8/eloquent-mutators#attribute-casting) or [accessors](https://laravel.com/docs/5.8/eloquent-mutators#defining-an-accessor) on your model to achieve a similar thing.)
```php ```php
$schema->attribute('firstName') $schema->attribute('firstName')
@ -151,7 +195,21 @@ $schema->attribute('firstName')
### Visibility ### Visibility
You can specify logic to restrict the visibility of a field using any one of the `visible`, `visibleIf`, `hidden`, and `hiddenIf` methods: #### Resource Visibility
You can restrict the visibility of the whole resource using the `scope` method. This will allow you to modify the query builder object provided by your adapter:
```php
$schema->scope(function ($query, $request, $id = null) {
$query->where('user_id', $request->getAttribute('userId'));
});
```
The third argument to this callback (`$id`) is only populated if the request is to access a single resource. If the request is to a resource index, it will be `null`.
#### Field Visibility
You can specify logic to restrict the visibility of a field using the `visible` and `hidden` methods:
```php ```php
$schema->attribute('email') $schema->attribute('email')
@ -159,7 +217,7 @@ $schema->attribute('email')
->visible() ->visible()
// Make a field visible only if certain logic is met // Make a field visible only if certain logic is met
->visibleIf(function ($model, $request) { ->visible(function ($model, $request) {
return $model->id == $request->getAttribute('userId'); return $model->id == $request->getAttribute('userId');
}) })
@ -167,22 +225,14 @@ $schema->attribute('email')
->hidden() ->hidden()
// Hide a field only if certain logic is met // Hide a field only if certain logic is met
->hiddenIf(function ($model, $request) { ->hidden(function ($model, $request) {
return $request->getAttribute('userIsSuspended'); return $request->getAttribute('userIsSuspended');
}); });
``` ```
You can also restrict the visibility of the whole resource using the `scope` method. This will allow you to modify the query builder object provided by your adapter: ### Writability
```php By default, fields are read-only. You can allow a field to be written to via `PATCH` and `POST` requests using the `writable` and `readonly` methods:
$schema->scope(function ($query, $request) {
$query->where('user_id', $request->getAttribute('userId'));
});
```
### Making Fields Writable
By default, fields are read-only. You can allow a field to be written to using any one of the `writable`, `writableIf`, `readonly`, and `readonlyIf` methods:
```php ```php
$schema->attribute('email') $schema->attribute('email')
@ -190,7 +240,7 @@ $schema->attribute('email')
->writable() ->writable()
// Make an attribute writable only if certain logic is met // Make an attribute writable only if certain logic is met
->writableIf(function ($model, $request) { ->writable(function ($model, $request) {
return $model->id == $request->getAttribute('userId'); return $model->id == $request->getAttribute('userId');
}) })
@ -198,7 +248,7 @@ $schema->attribute('email')
->readonly() ->readonly()
// Make an attribute writable *unless* certain logic is met // Make an attribute writable *unless* certain logic is met
->readonlyIf(function ($model, $request) { ->readonly(function ($model, $request) {
return $request->getAttribute('userIsSuspended'); return $request->getAttribute('userIsSuspended');
}); });
``` ```
@ -218,7 +268,7 @@ $schema->attribute('ipAddress')
}); });
``` ```
If you're using Eloquent, you could also define [default attribute values](https://laravel.com/docs/5.7/eloquent#default-attribute-values) to achieve a similar thing, although you wouldn't have access to the request object. If you're using Eloquent, you could also define [default attribute values](https://laravel.com/docs/5.8/eloquent#default-attribute-values) to achieve a similar thing, although you wouldn't have access to the request object.
### Validation ### Validation
@ -226,14 +276,18 @@ You can ensure that data provided for a field is valid before it is saved. Provi
```php ```php
$schema->attribute('email') $schema->attribute('email')
->validate(function ($fail, $email) { ->validate(function ($fail, $email, $model, $request, $field) {
if (! filter_var($email, FILTER_VALIDATE_EMAIL)) { if (! filter_var($email, FILTER_VALIDATE_EMAIL)) {
$fail('Invalid email'); $fail('Invalid email');
} }
}); });
```
This works for relationships too – the related models will be retrieved via your adapter and passed into your validation function.
```php
$schema->hasMany('groups') $schema->hasMany('groups')
->validate(function ($fail, $groups) { ->validate(function ($fail, $groups, $model, $request, $field) {
foreach ($groups as $group) { foreach ($groups as $group) {
if ($group->id === 1) { if ($group->id === 1) {
$fail('You cannot assign this group'); $fail('You cannot assign this group');
@ -242,11 +296,18 @@ $schema->hasMany('groups')
}); });
``` ```
See [Macros](#macros) below to learn how to use Laravel's [Validation](https://laravel.com/docs/5.7/validation) component in your schema. You can easily use Laravel's [Validation](https://laravel.com/docs/5.8/validation) component for field validation with the `rules` function:
```php
use Tobyz\JsonApi\Server\Laravel\rules;
$schema->attribute('username')
->validate(rules('required', 'min:3', 'max:30'));
```
### Setters & Savers ### Setters & Savers
Use the `set` method to define custom mutation logic for your field, instead of just setting the value straight on the model property. (Of course, if you're using Eloquent, you could also define [casts](https://laravel.com/docs/5.7/eloquent-mutators#attribute-casting) or [mutators](https://laravel.com/docs/5.7/eloquent-mutators#defining-a-mutator) on your model to achieve a similar thing.) Use the `set` method to define custom mutation logic for your field, instead of just setting the value straight on the model property. (Of course, if you're using Eloquent, you could also define [casts](https://laravel.com/docs/5.8/eloquent-mutators#attribute-casting) or [mutators](https://laravel.com/docs/5.8/eloquent-mutators#defining-a-mutator) on your model to achieve a similar thing.)
```php ```php
$schema->attribute('firstName') $schema->attribute('firstName')
@ -260,7 +321,9 @@ If your attribute corresponds to some other form of data storage rather than a s
```php ```php
$schema->attribute('locale') $schema->attribute('locale')
->save(function ($model, $value, $request) { ->save(function ($model, $value, $request) {
$model->preferences()->update(['value' => $value])->where('key', 'locale'); $model->preferences()
->update(['value' => $value])
->where('key', 'locale');
}); });
``` ```
@ -278,16 +341,31 @@ $schema->hasMany('groups')
// e.g. GET /api/users?filter[firstName]=Toby&filter[groups]=1,2,3 // e.g. GET /api/users?filter[firstName]=Toby&filter[groups]=1,2,3
``` ```
You can optionally pass a closure to customize how the filter is applied to the query builder object provided by your adapter: The `EloquentAdapter` automatically parses and applies `>`, `>=`, `<`, `<=`, and `..` operators on attribute filter values, so you can do:
```
GET /api/users?filter[postCount]=>=10
GET /api/users?filter[postCount]=5..15
```
You can also pass a closure to customize how the filter is applied to the query builder object:
```php ```php
$schema->attribute('minPosts') $schema->attribute('name')
->hidden()
->filterable(function ($query, $value, $request) { ->filterable(function ($query, $value, $request) {
$query->where('postCount', '>=', $value); $query->where('first_name', $value)
->orWhere('last_name', $value);
}); });
``` ```
To define filters that do not correspond to an attribute, use the `filter` method:
```php
$schema->filter('minPosts', function ($query, $value, $request) {
$query->where('postCount', '>=', $value);
});
```
### Sorting ### Sorting
You can define an attribute as `sortable` to allow the resource index to be [sorted](https://jsonapi.org/format/#fetching-sorting) by the attribute's value: You can define an attribute as `sortable` to allow the resource index to be [sorted](https://jsonapi.org/format/#fetching-sorting) by the attribute's value:
@ -302,67 +380,127 @@ $schema->attribute('lastName')
// e.g. GET /api/users?sort=lastName,firstName // e.g. GET /api/users?sort=lastName,firstName
``` ```
### Pagination You can pass a closure to customize how the sort is applied to the query builder object:
By default, resources are automatically [paginated](https://jsonapi.org/format/#fetching-pagination) with 20 records per page. You can change this limit using the `paginate` method on the schema builder:
```php ```php
$schema->paginate(50); $schema->attribute('name')
->sortable(function ($query, $direction, $request) {
$query->orderBy('last_name', $direction)
->orderBy('first_name', $direction);
});
```
You can set a default sort string to be used when the consumer has not supplied one using the `defaultSort` method on the schema builder:
```php
$schema->defaultSort('-updatedAt,-createdAt');
```
### Pagination
By default, resource listings are automatically [paginated](https://jsonapi.org/format/#fetching-pagination) with 20 records per page. You can change this limit using the `paginate` method on the schema builder, or you can remove it by passing `null`:
```php
$schema->paginate(50); // default to listing 50 resources per page
$schema->paginate(null); // default to listing all resources
```
Consumers may request a different limit using the `page[limit]` query parameter. By default the maximum possible limit is capped at 50; you can change this cap using the `limit` method, or you can remove it by passing `null`:
```php
$schema->limit(100); // set the maximum limit for resources per page to 100
$schema->limit(null); // remove the maximum limit for resources per page
```
#### Countability
By default a query will be performed to count the total number of resources in a collection. This will be used to populate a `count` attribute in the document's `meta` object, as well as the `last` pagination link. For some types of resources, or when a query is resource-intensive (especially when certain filters or sorting is applied), it may be undesirable to have this happen. So it can be toggled using the `countable` and `uncountable` methods:
```php
$schema->countable();
$schema->uncountable();
```
### Meta Information
You can add meta information to the document or any relationship field using the `meta` method. Pass a value or a closure:
```php
$schema->meta('author', 'Toby Zerner');
$schema->meta('requestTime', function ($request) {
return new DateTime;
});
``` ```
### Creating Resources ### Creating Resources
By default, resources are not [creatable](https://jsonapi.org/format/#crud-creating) (i.e. `POST` requests will return `403 Forbidden`). You can allow them to be created using the `creatable`, `creatableIf`, `notCreatable`, and `notCreatableIf` methods on the schema builder: By default, resources are not [creatable](https://jsonapi.org/format/#crud-creating) (i.e. `POST` requests will return `403 Forbidden`). You can allow them to be created using the `creatable` and `notCreatable` methods on the schema builder:
```php ```php
$schema->creatableIf(function ($request) { $schema->creatable(function ($request) {
return $request->getAttribute('isAdmin');
});
```
#### Customizing the Model
When creating a resource, an empty model is supplied by the adapter. You may wish to provide a custom model in special circumstances. You can do so using the `create` method:
```php
$schema->create(function ($request) {
return new CustomModel;
});
```
### Updating Resources
By default, resources are not [updatable](https://jsonapi.org/format/#crud-updating) (i.e. `PATCH` requests will return `403 Forbidden`). You can allow them to be updated using the `updatable` and `notUpdatable` methods on the schema builder:
```php
$schema->updatable(function ($request) {
return $request->getAttribute('isAdmin'); return $request->getAttribute('isAdmin');
}); });
``` ```
### Deleting Resources ### Deleting Resources
By default, resources are not [deletable](https://jsonapi.org/format/#crud-deleting) (i.e. `DELETE` requests will return `403 Forbidden`). You can allow them to be deleted using the `deletable`, `deletableIf`, `notDeletable`, and `notDeletableIf` methods on the schema builder: By default, resources are not [deletable](https://jsonapi.org/format/#crud-deleting) (i.e. `DELETE` requests will return `403 Forbidden`). You can allow them to be deleted using the `deletable` and `notDeletable` methods on the schema builder:
```php ```php
$schema->deletableIf(function ($request) { $schema->deletable(function ($request) {
return $request->getAttribute('isAdmin'); return $request->getAttribute('isAdmin');
}); });
``` ```
### Macros ### Events
You can define macros on the `Tobscure\JsonApiServer\Schema\Attribute` class to aid construction of your API schema. Below is an example that sets up a `rules` macro which will add a validator to validate the attribute value using Laravel's [Validation](https://laravel.com/docs/5.7/validation) component: The server will fire several events, allowing you to hook into the following points in a resource's lifecycle: `creating`, `created`, `updating`, `updated`, `saving`, `saved`, `deleting`, `deleted`. (Of course, if you're using Eloquent, you could also use [model events](https://laravel.com/docs/5.8/eloquent#events) to achieve a similar thing, although you wouldn't have access to the request object.)
To listen for an event, simply call the matching method name on the schema builder and pass a closure to be executed, which will receive the model and the request:
```php ```php
use Tobscure\JsonApiServer\Schema\Attribute; $schema->creating(function ($model, $request) {
// do something before a new model is saved
Attribute::macro('rules', function ($rules) use ($validator) {
$this->validate(function ($fail, $value) use ($validator, $rules) {
$key = $this->name;
$validation = Validator::make([$key => $value], [$key => $rules]);
if ($validation->fails()) {
$fail((string) $validation->messages());
}
});
return $this;
}); });
``` ```
### Authentication
You are responsible for performing your own authentication. An effective way to pass information about the authenticated user is by setting attributes on your request object before passing it into the request handler.
You should indicate to the server if the consumer is authenticated using the `authenticated` method. This is important because it will determine whether the response will be `401 Unauthorized` or `403 Forbidden` in the case of an unauthorized request.
```php ```php
$schema->attribute('username') $api->authenticated();
->rules(['required', 'min:3', 'max:30']);
``` ```
## Examples ## Examples
- [Flarum](https://github.com/flarum/core/tree/master/src/Api) is forum software that uses tobscure/json-api-server to power its API. - [Forust](https://github.com/forust/core/tree/master/schema) is forum software that uses tobyz/json-api-server to power its API.
## Contributing ## Contributing
Feel free to send pull requests or create issues if you come across problems or have great ideas. See the [Contributing Guide](https://github.com/tobscure/json-api-server/blob/master/CONTRIBUTING.md) for more information. Feel free to send pull requests or create issues if you come across problems or have great ideas. See the [Contributing Guide](https://github.com/tobyz/json-api-server/blob/master/CONTRIBUTING.md) for more information.
### Running Tests ### Running Tests

6
composer.json
View File

@ -1,5 +1,5 @@
{ {
"name": "tobscure/json-api-server", "name": "tobyz/json-api-server",
"require": { "require": {
"php": "^7.2", "php": "^7.2",
"doctrine/inflector": "^1.3", "doctrine/inflector": "^1.3",
@ -17,12 +17,12 @@
], ],
"autoload": { "autoload": {
"psr-4": { "psr-4": {
"Tobscure\\JsonApiServer\\": "src/" "Tobyz\\JsonApiServer\\": "src/"
} }
}, },
"autoload-dev": { "autoload-dev": {
"psr-4": { "psr-4": {
"Tobscure\\Tests\\JsonApiServer\\": "tests/" "Tobyz\\Tests\\JsonApiServer\\": "tests/"
} }
}, },
"require-dev": { "require-dev": {

15
src/Adapter/AdapterInterface.php
View File

@ -1,13 +1,16 @@
<?php <?php
namespace Tobscure\JsonApiServer\Adapter; namespace Tobyz\JsonApiServer\Adapter;
use Tobscure\JsonApiServer\Schema\Attribute; use Tobyz\JsonApiServer\Schema\Attribute;
use Tobscure\JsonApiServer\Schema\HasMany; use Tobyz\JsonApiServer\Schema\HasMany;
use Tobscure\JsonApiServer\Schema\HasOne; use Tobyz\JsonApiServer\Schema\HasOne;
use Tobyz\JsonApiServer\Schema\Relationship;
interface AdapterInterface interface AdapterInterface
{ {
public function handles($model);
public function create(); public function create();
public function query(); public function query();
@ -46,5 +49,7 @@ interface AdapterInterface
public function paginate($query, int $limit, int $offset); public function paginate($query, int $limit, int $offset);
public function load(array $models, array $relationships, \Closure $scope); public function load(array $models, array $relationships);
public function loadIds(array $models, Relationship $relationship);
} }

25
src/Adapter/EloquentAdapter.php
View File

@ -1,16 +1,16 @@
<?php <?php
namespace Tobscure\JsonApiServer\Adapter; namespace Tobyz\JsonApiServer\Adapter;
use Illuminate\Database\Eloquent\Collection; use Illuminate\Database\Eloquent\Collection;
use Illuminate\Database\Eloquent\Model; use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo; use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Database\Eloquent\Relations\BelongsToMany; use Illuminate\Database\Eloquent\Relations\BelongsToMany;
use Illuminate\Database\Eloquent\SoftDeletes; use Illuminate\Database\Eloquent\SoftDeletes;
use Tobscure\JsonApiServer\Schema\Attribute; use Tobyz\JsonApiServer\Schema\Attribute;
use Tobscure\JsonApiServer\Schema\HasMany; use Tobyz\JsonApiServer\Schema\HasMany;
use Tobscure\JsonApiServer\Schema\HasOne; use Tobyz\JsonApiServer\Schema\HasOne;
use Tobscure\JsonApiServer\Schema\Relationship; use Tobyz\JsonApiServer\Schema\Relationship;
class EloquentAdapter implements AdapterInterface class EloquentAdapter implements AdapterInterface
{ {
@ -28,6 +28,11 @@ class EloquentAdapter implements AdapterInterface
} }
} }
public function handles($model)
{
return $model instanceof $this->model;
}
public function create() public function create()
{ {
return $this->model->newInstance(); return $this->model->newInstance();
@ -186,13 +191,9 @@ class EloquentAdapter implements AdapterInterface
$query->take($limit)->skip($offset); $query->take($limit)->skip($offset);
} }
public function load(array $models, array $trail, \Closure $scope) public function load(array $models, array $trail)
{ {
(new Collection($models))->load([ (new Collection($models))->loadMissing($this->relationshipTrailToPath($trail));
$this->relationshipTrailToPath($trail) => function ($relation) use ($scope) {
$scope($relation->getQuery());
}
]);
} }
public function loadIds(array $models, Relationship $relationship) public function loadIds(array $models, Relationship $relationship)
@ -208,7 +209,7 @@ class EloquentAdapter implements AdapterInterface
return; return;
} }
(new Collection($models))->load([ (new Collection($models))->loadMissing([
$property => function ($query) use ($relation) { $property => function ($query) use ($relation) {
$query->select([ $query->select([
$relation->getRelated()->getKeyName(), $relation->getRelated()->getKeyName(),

19
src/Api.php
View File

@ -1,17 +1,17 @@
<?php <?php
namespace Tobscure\JsonApiServer; namespace Tobyz\JsonApiServer;
use Closure; use Closure;
use JsonApiPhp\JsonApi; use JsonApiPhp\JsonApi;
use Psr\Http\Message\ResponseInterface as Response; use Psr\Http\Message\ResponseInterface as Response;
use Psr\Http\Message\ServerRequestInterface as Request; use Psr\Http\Message\ServerRequestInterface as Request;
use Psr\Http\Server\RequestHandlerInterface; use Psr\Http\Server\RequestHandlerInterface;
use Tobscure\JsonApiServer\Exception\BadRequestException; use Tobyz\JsonApiServer\Exception\BadRequestException;
use Tobscure\JsonApiServer\Exception\MethodNotAllowedException; use Tobyz\JsonApiServer\Exception\MethodNotAllowedException;
use Tobscure\JsonApiServer\Exception\NotImplementedException; use Tobyz\JsonApiServer\Exception\NotImplementedException;
use Tobscure\JsonApiServer\Exception\ResourceNotFoundException; use Tobyz\JsonApiServer\Exception\ResourceNotFoundException;
use Tobscure\JsonApiServer\Handler\Concerns\FindsResources; use Tobyz\JsonApiServer\Handler\Concerns\FindsResources;
class Api implements RequestHandlerInterface class Api implements RequestHandlerInterface
{ {
@ -30,6 +30,11 @@ class Api implements RequestHandlerInterface
$this->resources[$type] = new ResourceType($type, $adapter, $buildSchema); $this->resources[$type] = new ResourceType($type, $adapter, $buildSchema);
} }
public function getResources(): array
{
return $this->resources;
}
public function getResource(string $type): ResourceType public function getResource(string $type): ResourceType
{ {
if (! isset($this->resources[$type])) { if (! isset($this->resources[$type])) {
@ -116,7 +121,7 @@ class Api implements RequestHandlerInterface
return $handler->handle($request); return $handler->handle($request);
} }
public function handleError($e) public function error($e)
{ {
if (! $e instanceof ErrorProviderInterface) { if (! $e instanceof ErrorProviderInterface) {
$e = new Exception\InternalServerErrorException; $e = new Exception\InternalServerErrorException;

2
src/ErrorProviderInterface.php
View File

@ -1,6 +1,6 @@
<?php <?php
namespace Tobscure\JsonApiServer; namespace Tobyz\JsonApiServer;
interface ErrorProviderInterface interface ErrorProviderInterface
{ {

4
src/Exception/BadRequestException.php
View File

@ -1,9 +1,9 @@
<?php <?php
namespace Tobscure\JsonApiServer\Exception; namespace Tobyz\JsonApiServer\Exception;
use JsonApiPhp\JsonApi\Error; use JsonApiPhp\JsonApi\Error;
use Tobscure\JsonApiServer\ErrorProviderInterface; use Tobyz\JsonApiServer\ErrorProviderInterface;
class BadRequestException extends \DomainException implements ErrorProviderInterface class BadRequestException extends \DomainException implements ErrorProviderInterface
{ {

4
src/Exception/ForbiddenException.php
View File

@ -1,9 +1,9 @@
<?php <?php
namespace Tobscure\JsonApiServer\Exception; namespace Tobyz\JsonApiServer\Exception;
use JsonApiPhp\JsonApi\Error; use JsonApiPhp\JsonApi\Error;
use Tobscure\JsonApiServer\ErrorProviderInterface; use Tobyz\JsonApiServer\ErrorProviderInterface;
class ForbiddenException extends \DomainException implements ErrorProviderInterface class ForbiddenException extends \DomainException implements ErrorProviderInterface
{ {

4
src/Exception/InternalServerErrorException.php
View File

@ -1,9 +1,9 @@
<?php <?php
namespace Tobscure\JsonApiServer\Exception; namespace Tobyz\JsonApiServer\Exception;
use JsonApiPhp\JsonApi\Error; use JsonApiPhp\JsonApi\Error;
use Tobscure\JsonApiServer\ErrorProviderInterface; use Tobyz\JsonApiServer\ErrorProviderInterface;
class InternalServerErrorException extends \RuntimeException implements ErrorProviderInterface class InternalServerErrorException extends \RuntimeException implements ErrorProviderInterface
{ {

4
src/Exception/MethodNotAllowedException.php
View File

@ -1,9 +1,9 @@
<?php <?php
namespace Tobscure\JsonApiServer\Exception; namespace Tobyz\JsonApiServer\Exception;
use JsonApiPhp\JsonApi\Error; use JsonApiPhp\JsonApi\Error;
use Tobscure\JsonApiServer\ErrorProviderInterface; use Tobyz\JsonApiServer\ErrorProviderInterface;
class MethodNotAllowedException extends \DomainException implements ErrorProviderInterface class MethodNotAllowedException extends \DomainException implements ErrorProviderInterface
{ {

4
src/Exception/NotImplementedException.php
View File

@ -1,9 +1,9 @@
<?php <?php
namespace Tobscure\JsonApiServer\Exception; namespace Tobyz\JsonApiServer\Exception;
use JsonApiPhp\JsonApi\Error; use JsonApiPhp\JsonApi\Error;
use Tobscure\JsonApiServer\ErrorProviderInterface; use Tobyz\JsonApiServer\ErrorProviderInterface;
class NotImplementedException extends \DomainException implements ErrorProviderInterface class NotImplementedException extends \DomainException implements ErrorProviderInterface
{ {

4
src/Exception/ResourceNotFoundException.php
View File

@ -1,9 +1,9 @@
<?php <?php
namespace Tobscure\JsonApiServer\Exception; namespace Tobyz\JsonApiServer\Exception;
use JsonApiPhp\JsonApi\Error; use JsonApiPhp\JsonApi\Error;
use Tobscure\JsonApiServer\ErrorProviderInterface; use Tobyz\JsonApiServer\ErrorProviderInterface;
class ResourceNotFoundException extends \RuntimeException implements ErrorProviderInterface class ResourceNotFoundException extends \RuntimeException implements ErrorProviderInterface
{ {

24
src/Exception/UnauthorizedException.php Normal file
View File

@ -0,0 +1,24 @@
<?php
namespace Tobyz\JsonApiServer\Exception;
use JsonApiPhp\JsonApi\Error;
use Tobyz\JsonApiServer\ErrorProviderInterface;
class UnauthorizedException extends \DomainException implements ErrorProviderInterface
{
public function getJsonApiErrors(): array
{
return [
new Error(
new Error\Title('Unauthorized'),
new Error\Status($this->getJsonApiStatus())
)
];
}
public function getJsonApiStatus(): string
{
return '401';
}
}

4
src/Exception/UnprocessableEntityException.php
View File

@ -1,9 +1,9 @@
<?php <?php
namespace Tobscure\JsonApiServer\Exception; namespace Tobyz\JsonApiServer\Exception;
use JsonApiPhp\JsonApi\Error; use JsonApiPhp\JsonApi\Error;
use Tobscure\JsonApiServer\ErrorProviderInterface; use Tobyz\JsonApiServer\ErrorProviderInterface;
class UnprocessableEntityException extends \DomainException implements ErrorProviderInterface class UnprocessableEntityException extends \DomainException implements ErrorProviderInterface
{ {

10
src/Handler/Concerns/FindsResources.php
View File

@ -1,10 +1,10 @@
<?php <?php
namespace Tobscure\JsonApiServer\Handler\Concerns; namespace Tobyz\JsonApiServer\Handler\Concerns;
use Psr\Http\Message\ServerRequestInterface as Request; use Psr\Http\Message\ServerRequestInterface as Request;
use Tobscure\JsonApiServer\Exception\ResourceNotFoundException; use Tobyz\JsonApiServer\Exception\ResourceNotFoundException;
use Tobscure\JsonApiServer\ResourceType; use Tobyz\JsonApiServer\ResourceType;
trait FindsResources trait FindsResources
{ {
@ -15,10 +15,6 @@ trait FindsResources
$query = $adapter->query(); $query = $adapter->query();
foreach ($resource->getSchema()->scopes as $scope) { foreach ($resource->getSchema()->scopes as $scope) {
$scope($request, $query);
}
foreach ($resource->getSchema()->singleScopes as $scope) {
$scope($request, $query, $id); $scope($request, $query, $id);
} }

24
src/Handler/Concerns/IncludesData.php
View File

@ -1,12 +1,12 @@
<?php <?php
namespace Tobscure\JsonApiServer\Handler\Concerns; namespace Tobyz\JsonApiServer\Handler\Concerns;
use Psr\Http\Message\ServerRequestInterface as Request; use Psr\Http\Message\ServerRequestInterface as Request;
use Tobscure\JsonApiServer\Exception\BadRequestException; use Tobyz\JsonApiServer\Exception\BadRequestException;
use Tobscure\JsonApiServer\ResourceType; use Tobyz\JsonApiServer\ResourceType;
use Tobscure\JsonApiServer\Schema\HasMany; use Tobyz\JsonApiServer\Schema\HasMany;
use Tobscure\JsonApiServer\Schema\Relationship; use Tobyz\JsonApiServer\Schema\Relationship;
trait IncludesData trait IncludesData
{ {
@ -57,10 +57,12 @@ trait IncludesData
throw new BadRequestException("Invalid include [{$path}{$name}]", 'include'); throw new BadRequestException("Invalid include [{$path}{$name}]", 'include');
} }
if (is_string($schema->fields[$name]->resource)) { if ($schema->fields[$name]->resource) {
$relatedResource = $this->api->getResource($schema->fields[$name]->resource); $relatedResource = $this->api->getResource($schema->fields[$name]->resource);
$this->validateInclude($relatedResource, $nested, $name.'.'); $this->validateInclude($relatedResource, $nested, $name.'.');
} elseif ($nested) {
throw new BadRequestException("Invalid include [{$path}{$name}.*]", 'include');
} }
} }
} }
@ -77,7 +79,7 @@ trait IncludesData
$trails[] = [$relationship]; $trails[] = [$relationship];
} }
if (is_string($schema->fields[$name]->resource)) { if ($schema->fields[$name]->resource) {
$relatedResource = $this->api->getResource($relationship->resource); $relatedResource = $this->api->getResource($relationship->resource);
$trails = array_merge( $trails = array_merge(
@ -119,13 +121,7 @@ trait IncludesData
// TODO: probably need to loop through relationships here // TODO: probably need to loop through relationships here
($loader)($models, false); ($loader)($models, false);
} else { } else {
$scope = function ($query) use ($relationships, $request) { $adapter->load($models, $relationships);
foreach ($this->api->getResource(end($relationships)->resource)->getSchema()->scopes as $scope) {
$scope($request, $query);
}
};
$adapter->load($models, $relationships, $scope);
} }
} }
} }

12
src/Handler/Concerns/SavesData.php
View File

@ -1,12 +1,12 @@
<?php <?php
namespace Tobscure\JsonApiServer\Handler\Concerns; namespace Tobyz\JsonApiServer\Handler\Concerns;
use Psr\Http\Message\ServerRequestInterface as Request; use Psr\Http\Message\ServerRequestInterface as Request;
use Tobscure\JsonApiServer\Exception\BadRequestException; use Tobyz\JsonApiServer\Exception\BadRequestException;
use Tobscure\JsonApiServer\Exception\UnprocessableEntityException; use Tobyz\JsonApiServer\Exception\UnprocessableEntityException;
use Tobscure\JsonApiServer\ResourceType; use Tobyz\JsonApiServer\ResourceType;
use Tobscure\JsonApiServer\Schema; use Tobyz\JsonApiServer\Schema;
trait SavesData trait SavesData
{ {
@ -164,7 +164,7 @@ trait SavesData
}; };
foreach ($field->validators as $validator) { foreach ($field->validators as $validator) {
$validator($fail, $data[$field->location][$name] ?? null, $request, $model, $field); $validator($fail, $data[$field->location][$name] ?? null, $model, $request, $field);
} }
} }

8
src/Handler/Create.php
View File

@ -1,13 +1,13 @@
<?php <?php
namespace Tobscure\JsonApiServer\Handler; namespace Tobyz\JsonApiServer\Handler;
use Psr\Http\Message\ResponseInterface as Response; use Psr\Http\Message\ResponseInterface as Response;
use Psr\Http\Message\ServerRequestInterface as Request; use Psr\Http\Message\ServerRequestInterface as Request;
use Psr\Http\Server\RequestHandlerInterface; use Psr\Http\Server\RequestHandlerInterface;
use Tobscure\JsonApiServer\Api; use Tobyz\JsonApiServer\Api;
use Tobscure\JsonApiServer\Exception\ForbiddenException; use Tobyz\JsonApiServer\Exception\ForbiddenException;
use Tobscure\JsonApiServer\ResourceType; use Tobyz\JsonApiServer\ResourceType;
class Create implements RequestHandlerInterface class Create implements RequestHandlerInterface
{ {

6
src/Handler/Delete.php
View File

@ -1,12 +1,12 @@
<?php <?php
namespace Tobscure\JsonApiServer\Handler; namespace Tobyz\JsonApiServer\Handler;
use Psr\Http\Message\ResponseInterface as Response; use Psr\Http\Message\ResponseInterface as Response;
use Psr\Http\Message\ServerRequestInterface as Request; use Psr\Http\Message\ServerRequestInterface as Request;
use Psr\Http\Server\RequestHandlerInterface; use Psr\Http\Server\RequestHandlerInterface;
use Tobscure\JsonApiServer\Exception\ForbiddenException; use Tobyz\JsonApiServer\Exception\ForbiddenException;
use Tobscure\JsonApiServer\ResourceType; use Tobyz\JsonApiServer\ResourceType;
use Zend\Diactoros\Response\EmptyResponse; use Zend\Diactoros\Response\EmptyResponse;
class Delete implements RequestHandlerInterface class Delete implements RequestHandlerInterface

20
src/Handler/Index.php
View File

@ -1,6 +1,6 @@
<?php <?php
namespace Tobscure\JsonApiServer\Handler; namespace Tobyz\JsonApiServer\Handler;
use JsonApiPhp\JsonApi; use JsonApiPhp\JsonApi;
use JsonApiPhp\JsonApi\Link; use JsonApiPhp\JsonApi\Link;
@ -8,13 +8,13 @@ use JsonApiPhp\JsonApi\Meta;
use Psr\Http\Message\ResponseInterface as Response; use Psr\Http\Message\ResponseInterface as Response;
use Psr\Http\Message\ServerRequestInterface as Request; use Psr\Http\Message\ServerRequestInterface as Request;
use Psr\Http\Server\RequestHandlerInterface; use Psr\Http\Server\RequestHandlerInterface;
use Tobscure\JsonApiServer\Api; use Tobyz\JsonApiServer\Api;
use Tobscure\JsonApiServer\Exception\BadRequestException; use Tobyz\JsonApiServer\Exception\BadRequestException;
use Tobscure\JsonApiServer\Exception\ForbiddenException; use Tobyz\JsonApiServer\Exception\ForbiddenException;
use Tobscure\JsonApiServer\JsonApiResponse; use Tobyz\JsonApiServer\JsonApiResponse;
use Tobscure\JsonApiServer\ResourceType; use Tobyz\JsonApiServer\ResourceType;
use Tobscure\JsonApiServer\Schema; use Tobyz\JsonApiServer\Schema;
use Tobscure\JsonApiServer\Serializer; use Tobyz\JsonApiServer\Serializer;
class Index implements RequestHandlerInterface class Index implements RequestHandlerInterface
{ {
@ -48,10 +48,6 @@ class Index implements RequestHandlerInterface
$request = $scope($request, $query) ?: $request; $request = $scope($request, $query) ?: $request;
} }
foreach ($schema->indexScopes as $scope) {
$request = $scope($request, $query) ?: $request;
}
if ($filter = $request->getAttribute('jsonApiFilter')) { if ($filter = $request->getAttribute('jsonApiFilter')) {
$this->filter($query, $filter, $request); $this->filter($query, $filter, $request);
} }

12
src/Handler/Show.php
View File

@ -1,16 +1,16 @@
<?php <?php
namespace Tobscure\JsonApiServer\Handler; namespace Tobyz\JsonApiServer\Handler;
use JsonApiPhp\JsonApi; use JsonApiPhp\JsonApi;
use Psr\Http\Message\ResponseInterface as Response; use Psr\Http\Message\ResponseInterface as Response;
use Psr\Http\Message\ServerRequestInterface as Request; use Psr\Http\Message\ServerRequestInterface as Request;
use Psr\Http\Server\RequestHandlerInterface; use Psr\Http\Server\RequestHandlerInterface;
use Tobscure\JsonApiServer\Api; use Tobyz\JsonApiServer\Api;
use Tobscure\JsonApiServer\Exception\ForbiddenException; use Tobyz\JsonApiServer\Exception\ForbiddenException;
use Tobscure\JsonApiServer\JsonApiResponse; use Tobyz\JsonApiServer\JsonApiResponse;
use Tobscure\JsonApiServer\ResourceType; use Tobyz\JsonApiServer\ResourceType;
use Tobscure\JsonApiServer\Serializer; use Tobyz\JsonApiServer\Serializer;
class Show implements RequestHandlerInterface class Show implements RequestHandlerInterface
{ {

8
src/Handler/Update.php
View File

@ -1,13 +1,13 @@
<?php <?php
namespace Tobscure\JsonApiServer\Handler; namespace Tobyz\JsonApiServer\Handler;
use Psr\Http\Message\ResponseInterface as Response; use Psr\Http\Message\ResponseInterface as Response;
use Psr\Http\Message\ServerRequestInterface as Request; use Psr\Http\Message\ServerRequestInterface as Request;
use Psr\Http\Server\RequestHandlerInterface; use Psr\Http\Server\RequestHandlerInterface;
use Tobscure\JsonApiServer\Api; use Tobyz\JsonApiServer\Api;
use Tobscure\JsonApiServer\Exception\ForbiddenException; use Tobyz\JsonApiServer\Exception\ForbiddenException;
use Tobscure\JsonApiServer\ResourceType; use Tobyz\JsonApiServer\ResourceType;
class Update implements RequestHandlerInterface class Update implements RequestHandlerInterface
{ {

2
src/JsonApiResponse.php
View File

@ -1,6 +1,6 @@
<?php <?php
namespace Tobscure\JsonApiServer; namespace Tobyz\JsonApiServer;
use Zend\Diactoros\Response\JsonResponse; use Zend\Diactoros\Response\JsonResponse;

6
src/ResourceType.php
View File

@ -1,10 +1,10 @@
<?php <?php
namespace Tobscure\JsonApiServer; namespace Tobyz\JsonApiServer;
use Closure; use Closure;
use Tobscure\JsonApiServer\Adapter\AdapterInterface; use Tobyz\JsonApiServer\Adapter\AdapterInterface;
use Tobscure\JsonApiServer\Schema\Builder; use Tobyz\JsonApiServer\Schema\Builder;
class ResourceType class ResourceType
{ {

2
src/Schema/Attribute.php
View File

@ -1,6 +1,6 @@
<?php <?php
namespace Tobscure\JsonApiServer\Schema; namespace Tobyz\JsonApiServer\Schema;
use Closure; use Closure;

48
src/Schema/Builder.php
View File

@ -1,6 +1,6 @@
<?php <?php
namespace Tobscure\JsonApiServer\Schema; namespace Tobyz\JsonApiServer\Schema;
use Closure; use Closure;
@ -12,9 +12,6 @@ class Builder
public $limit = 50; public $limit = 50;
public $countable = true; public $countable = true;
public $scopes = []; public $scopes = [];
public $indexScopes = [];
public $singleScopes = [];
public $isVisible;
public $isCreatable; public $isCreatable;
public $creatingCallbacks = []; public $creatingCallbacks = [];
public $createdCallbacks = []; public $createdCallbacks = [];
@ -52,6 +49,11 @@ class Builder
return $field; return $field;
} }
public function morphOne(string $name, string $property = null): HasOne
{
return $this->field(HasOne::class, $name, $property)->resource(null);
}
public function hasMany(string $name, $resource = null, string $property = null): HasMany public function hasMany(string $name, $resource = null, string $property = null): HasMany
{ {
$field = $this->field(HasMany::class, $name, $property); $field = $this->field(HasMany::class, $name, $property);
@ -98,44 +100,6 @@ class Builder
$this->scopes[] = $callback; $this->scopes[] = $callback;
} }
public function scopeIndex(Closure $callback)
{
$this->indexScopes[] = $callback;
}
public function scopeSingle(Closure $callback)
{
$this->singleScopes[] = $callback;
}
public function visibleIf(Closure $condition)
{
$this->isVisible = $condition;
return $this;
}
public function visible()
{
return $this->visibleIf(function () {
return true;
});
}
public function notVisibleIf(Closure $condition)
{
return $this->visibleIf(function (...$args) use ($condition) {
return ! $condition(...$args);
});
}
public function notVisible()
{
return $this->notVisibleIf(function () {
return true;
});
}
public function creatableIf(Closure $condition) public function creatableIf(Closure $condition)
{ {
$this->isCreatable = $condition; $this->isCreatable = $condition;

2
src/Schema/Field.php
View File

@ -1,6 +1,6 @@
<?php <?php
namespace Tobscure\JsonApiServer\Schema; namespace Tobyz\JsonApiServer\Schema;
use Closure; use Closure;

2
src/Schema/HasMany.php
View File

@ -1,6 +1,6 @@
<?php <?php
namespace Tobscure\JsonApiServer\Schema; namespace Tobyz\JsonApiServer\Schema;
class HasMany extends Relationship class HasMany extends Relationship
{ {

2
src/Schema/HasOne.php
View File

@ -1,6 +1,6 @@
<?php <?php
namespace Tobscure\JsonApiServer\Schema; namespace Tobyz\JsonApiServer\Schema;
use Doctrine\Common\Inflector\Inflector; use Doctrine\Common\Inflector\Inflector;

2
src/Schema/Meta.php
View File

@ -1,6 +1,6 @@
<?php <?php
namespace Tobscure\JsonApiServer\Schema; namespace Tobyz\JsonApiServer\Schema;
use Closure; use Closure;

20
src/Schema/Relationship.php
View File

@ -1,9 +1,9 @@
<?php <?php
namespace Tobscure\JsonApiServer\Schema; namespace Tobyz\JsonApiServer\Schema;
use Closure; use Closure;
use Tobscure\JsonApiServer\Handler\Show; use Tobyz\JsonApiServer\Handler\Show;
abstract class Relationship extends Field abstract class Relationship extends Field
{ {
@ -44,13 +44,6 @@ abstract class Relationship extends Field
}); });
} }
public function linkageIfSingle()
{
return $this->linkageIf(function ($request) {
return $request->getAttribute('jsonApiHandler') instanceof Show;
});
}
public function noLinkage() public function noLinkage()
{ {
return $this->linkageIf(function () { return $this->linkageIf(function () {
@ -93,15 +86,6 @@ abstract class Relationship extends Field
return $this; return $this;
} }
public function included()
{
$this->includable();
$this->included = true;
return $this;
}
public function noLinks() public function noLinks()
{ {
$this->hasLinks = false; $this->hasLinks = false;

33
src/Serializer.php
View File

@ -1,12 +1,12 @@
<?php <?php
namespace Tobscure\JsonApiServer; namespace Tobyz\JsonApiServer;
use DateTime; use DateTime;
use DateTimeInterface; use DateTimeInterface;
use JsonApiPhp\JsonApi; use JsonApiPhp\JsonApi;
use Psr\Http\Message\ServerRequestInterface as Request; use Psr\Http\Message\ServerRequestInterface as Request;
use Tobscure\JsonApiServer\Adapter\AdapterInterface; use Tobyz\JsonApiServer\Adapter\AdapterInterface;
class Serializer class Serializer
{ {
@ -114,11 +114,7 @@ class Serializer
{ {
$links = $this->getRelationshipLinks($field, $resourceUrl); $links = $this->getRelationshipLinks($field, $resourceUrl);
if ($field->getter) { $value = $isIncluded ? ($field->getter ? ($field->getter)($this->request, $model) : $adapter->getHasOne($model, $field)) : ($isLinkage && $field->loadable ? $adapter->getHasOneId($model, $field) : null);
$value = ($field->getter)($this->request, $model);
} else {
$value = $isIncluded ? $adapter->getHasOne($model, $field) : ($isLinkage && $field->loadable ? $adapter->getHasOneId($model, $field) : null);
}
if (! $value) { if (! $value) {
return new JsonApi\ToNull( return new JsonApi\ToNull(
@ -190,23 +186,24 @@ class Serializer
private function addRelated(Schema\Relationship $field, $model, array $include): JsonApi\ResourceIdentifier private function addRelated(Schema\Relationship $field, $model, array $include): JsonApi\ResourceIdentifier
{ {
if (is_array($field->resource)) { $relatedResource = $field->resource ? $this->api->getResource($field->resource) : $this->resourceForModel($model);
foreach ($field->resource as $class => $resource) {
if ($model instanceof $class) {
break;
}
}
} else {
$resource = $field->resource;
}
$relatedResource = $this->api->getResource($resource);
return $this->resourceIdentifier( return $this->resourceIdentifier(
$this->addToMap($relatedResource, $model, $include) $this->addToMap($relatedResource, $model, $include)
); );
} }
private function resourceForModel($model)
{
foreach ($this->api->getResources() as $resource) {
if ($resource->getAdapter()->handles($model)) {
return $resource;
}
}
throw new \RuntimeException('No resource defined to handle model of type '.get_class($model));
}
private function merge($data): void private function merge($data): void
{ {
$key = $data['type'].':'.$data['id']; $key = $data['type'].':'.$data['id'];

2
src/StatusProviderInterface.php
View File

@ -1,6 +1,6 @@
<?php <?php
namespace Tobscure\JsonApiServer; namespace Tobyz\JsonApiServer;
interface StatusProviderInterface interface StatusProviderInterface
{ {

4
tests/AbstractTestCase.php
View File

@ -9,7 +9,7 @@
* file that was distributed with this source code. * file that was distributed with this source code.
*/ */
namespace Tobscure\Tests\JsonApiServer; namespace Tobyz\Tests\JsonApiServer;
use PHPUnit\Framework\TestCase; use PHPUnit\Framework\TestCase;
use Zend\Diactoros\ServerRequest; use Zend\Diactoros\ServerRequest;
@ -28,7 +28,7 @@ abstract class AbstractTestCase extends TestCase
protected function buildRequest(string $method, string $uri): ServerRequest protected function buildRequest(string $method, string $uri): ServerRequest
{ {
return (new ServerRequest()) return (new ServerRequest)
->withMethod($method) ->withMethod($method)
->withUri(new Uri($uri)); ->withUri(new Uri($uri));
} }

18
tests/CreateTest.php
View File

@ -9,13 +9,13 @@
* file that was distributed with this source code. * file that was distributed with this source code.
*/ */
namespace Tobscure\Tests\JsonApiServer; namespace Tobyz\Tests\JsonApiServer;
use Tobscure\JsonApiServer\Api; use Tobyz\JsonApiServer\Api;
use Tobscure\JsonApiServer\Exception\BadRequestException; use Tobyz\JsonApiServer\Exception\BadRequestException;
use Tobscure\JsonApiServer\Exception\ForbiddenException; use Tobyz\JsonApiServer\Exception\ForbiddenException;
use Tobscure\JsonApiServer\Serializer; use Tobyz\JsonApiServer\Serializer;
use Tobscure\JsonApiServer\Schema\Builder; use Tobyz\JsonApiServer\Schema\Builder;
use Psr\Http\Message\ServerRequestInterface as Request; use Psr\Http\Message\ServerRequestInterface as Request;
use JsonApiPhp\JsonApi; use JsonApiPhp\JsonApi;
use Zend\Diactoros\ServerRequest; use Zend\Diactoros\ServerRequest;
@ -118,13 +118,13 @@ class CreateTest extends AbstractTestCase
$schema->attribute('writable1')->writable(); $schema->attribute('writable1')->writable();
$schema->attribute('writable2')->writableIf(function ($arg1, $arg2) use ($adapter, $request) { $schema->attribute('writable2')->writableIf(function ($arg1, $arg2) use ($adapter, $request) {
$this->assertEquals($request, $arg1); $this->assertInstanceOf(Request::class, $arg1);
$this->assertEquals($adapter->createdModel, $arg2); $this->assertEquals($adapter->createdModel, $arg2);
return true; return true;
}); });
$schema->attribute('writable3')->readonlyIf(function ($arg1, $arg2) use ($adapter, $request) { $schema->attribute('writable3')->readonlyIf(function ($arg1, $arg2) use ($adapter, $request) {
$this->assertEquals($request, $arg1); $this->assertInstanceOf(Request::class, $arg1);
$this->assertEquals($adapter->createdModel, $arg2); $this->assertEquals($adapter->createdModel, $arg2);
return false; return false;
}); });
@ -182,7 +182,7 @@ class CreateTest extends AbstractTestCase
$schema->attribute('attribute1')->default('defaultValue'); $schema->attribute('attribute1')->default('defaultValue');
$schema->attribute('attribute2')->default(function ($arg1) use ($request) { $schema->attribute('attribute2')->default(function ($arg1) use ($request) {
$this->assertEquals($request, $arg1); $this->assertInstanceOf(Request::class, $arg1);
return 'defaultValue'; return 'defaultValue';
}); });
$schema->attribute('attribute3')->writable()->default('defaultValue'); $schema->attribute('attribute3')->writable()->default('defaultValue');

12
tests/DeleteTest.php
View File

@ -9,13 +9,13 @@
* file that was distributed with this source code. * file that was distributed with this source code.
*/ */
namespace Tobscure\Tests\JsonApiServer; namespace Tobyz\Tests\JsonApiServer;
use Tobscure\JsonApiServer\Api; use Tobyz\JsonApiServer\Api;
use Tobscure\JsonApiServer\Exception\BadRequestException; use Tobyz\JsonApiServer\Exception\BadRequestException;
use Tobscure\JsonApiServer\Exception\ForbiddenException; use Tobyz\JsonApiServer\Exception\ForbiddenException;
use Tobscure\JsonApiServer\Serializer; use Tobyz\JsonApiServer\Serializer;
use Tobscure\JsonApiServer\Schema\Builder; use Tobyz\JsonApiServer\Schema\Builder;
use Psr\Http\Message\ServerRequestInterface as Request; use Psr\Http\Message\ServerRequestInterface as Request;
use JsonApiPhp\JsonApi; use JsonApiPhp\JsonApi;
use Zend\Diactoros\ServerRequest; use Zend\Diactoros\ServerRequest;

40
tests/MockAdapter.php
View File

@ -1,21 +1,24 @@
<?php <?php
namespace Tobscure\Tests\JsonApiServer; namespace Tobyz\Tests\JsonApiServer;
use Tobscure\JsonApiServer\Adapter\AdapterInterface; use Tobyz\JsonApiServer\Adapter\AdapterInterface;
use Tobscure\JsonApiServer\Schema\Attribute; use Tobyz\JsonApiServer\Schema\Attribute;
use Tobscure\JsonApiServer\Schema\Field; use Tobyz\JsonApiServer\Schema\Field;
use Tobscure\JsonApiServer\Schema\HasMany; use Tobyz\JsonApiServer\Schema\HasMany;
use Tobscure\JsonApiServer\Schema\HasOne; use Tobyz\JsonApiServer\Schema\HasOne;
use Tobyz\JsonApiServer\Schema\Relationship;
class MockAdapter implements AdapterInterface class MockAdapter implements AdapterInterface
{ {
public $models = []; public $models = [];
public $createdModel; public $createdModel;
private $type;
public function __construct(array $models = []) public function __construct(array $models = [], string $type = null)
{ {
$this->models = $models; $this->models = $models;
$this->type = $type;
} }
public function create() public function create()
@ -87,6 +90,11 @@ class MockAdapter implements AdapterInterface
$model->deleteWasCalled = true; $model->deleteWasCalled = true;
} }
public function filterByIds($query, array $ids)
{
$query->filters[] = ['ids', $ids];
}
public function filterByAttribute($query, Attribute $attribute, $value) public function filterByAttribute($query, Attribute $attribute, $value)
{ {
$query->filters[] = [$attribute, $value]; $query->filters[] = [$attribute, $value];
@ -117,13 +125,27 @@ class MockAdapter implements AdapterInterface
$query->include[] = $relationships; $query->include[] = $relationships;
} }
public function load($model, array $relationships) public function load(array $models, array $relationships)
{ {
$model->load[] = $relationships; foreach ($models as $model) {
$model->load[] = $relationships;
}
}
public function loadIds(array $models, Relationship $relationship)
{
foreach ($models as $model) {
$model->loadIds[] = $relationship;
}
} }
private function getProperty(Field $field) private function getProperty(Field $field)
{ {
return $field->property ?: $field->name; return $field->property ?: $field->name;
} }
public function handles($model)
{
return isset($model['type']) && $model['type'] === $this->type;
}
} }

86
tests/ShowTest.php
View File

@ -9,12 +9,12 @@
* file that was distributed with this source code. * file that was distributed with this source code.
*/ */
namespace Tobscure\Tests\JsonApiServer; namespace Tobyz\Tests\JsonApiServer;
use Tobscure\JsonApiServer\Api; use Tobyz\JsonApiServer\Api;
use Tobscure\JsonApiServer\Exception\BadRequestException; use Tobyz\JsonApiServer\Exception\BadRequestException;
use Tobscure\JsonApiServer\Serializer; use Tobyz\JsonApiServer\Serializer;
use Tobscure\JsonApiServer\Schema\Builder; use Tobyz\JsonApiServer\Schema\Builder;
use Psr\Http\Message\ServerRequestInterface as Request; use Psr\Http\Message\ServerRequestInterface as Request;
use JsonApiPhp\JsonApi; use JsonApiPhp\JsonApi;
use Zend\Diactoros\ServerRequest; use Zend\Diactoros\ServerRequest;
@ -93,7 +93,7 @@ class ShowTest extends AbstractTestCase
$api->resource('users', $adapter, function (Builder $schema) use ($model, $request) { $api->resource('users', $adapter, function (Builder $schema) use ($model, $request) {
$schema->attribute('attribute1') $schema->attribute('attribute1')
->get(function ($arg1, $arg2) use ($model, $request) { ->get(function ($arg1, $arg2) use ($model, $request) {
$this->assertEquals($request, $arg1); $this->assertInstanceOf(Request::class, $arg1);
$this->assertEquals($model, $arg2); $this->assertEquals($model, $arg2);
return 'value1'; return 'value1';
}); });
@ -127,13 +127,13 @@ class ShowTest extends AbstractTestCase
$schema->attribute('visible2')->visible(); $schema->attribute('visible2')->visible();
$schema->attribute('visible3')->visibleIf(function ($arg1, $arg2) use ($model, $request) { $schema->attribute('visible3')->visibleIf(function ($arg1, $arg2) use ($model, $request) {
$this->assertEquals($request, $arg1); $this->assertInstanceOf(Request::class, $arg1);
$this->assertEquals($model, $arg2); $this->assertEquals($model, $arg2);
return true; return true;
}); });
$schema->attribute('visible4')->hiddenIf(function ($arg1, $arg2) use ($model, $request) { $schema->attribute('visible4')->hiddenIf(function ($arg1, $arg2) use ($model, $request) {
$this->assertEquals($request, $arg1); $this->assertInstanceOf(Request::class, $arg1);
$this->assertEquals($model, $arg2); $this->assertEquals($model, $arg2);
return false; return false;
}); });
@ -180,21 +180,19 @@ class ShowTest extends AbstractTestCase
] ]
]); ]);
$request = $this->buildRequest('GET', '/users/1'); $request = $this->buildRequest('GET', '/users/1')
->withQueryParams(['include' => 'phone,phone2,phone3']);
$api = new Api('http://example.com'); $api = new Api('http://example.com');
$api->resource('users', $usersAdapter, function (Builder $schema) { $api->resource('users', $usersAdapter, function (Builder $schema) {
$schema->hasOne('phone') $schema->hasOne('phone');
->included();
$schema->hasOne('phone2', 'phones', 'property2') $schema->hasOne('phone2', 'phones', 'property2');
->included();
$schema->hasOne('phone3') $schema->hasOne('phone3')
->resource('phones') ->resource('phones')
->property('property3') ->property('property3');
->included();
}); });
$api->resource('phones', $phonesAdapter, function (Builder $schema) { $api->resource('phones', $phonesAdapter, function (Builder $schema) {
@ -266,15 +264,15 @@ class ShowTest extends AbstractTestCase
] ]
]); ]);
$request = $this->buildRequest('GET', '/users/1'); $request = $this->buildRequest('GET', '/users/1')
->withQueryParams(['include' => 'phone2']);
$api = new Api('http://example.com'); $api = new Api('http://example.com');
$api->resource('users', $usersAdapter, function (Builder $schema) { $api->resource('users', $usersAdapter, function (Builder $schema) {
$schema->hasOne('phone'); $schema->hasOne('phone');
$schema->hasOne('phone2', 'phones', 'property2') $schema->hasOne('phone2', 'phones', 'property2');
->included();
}); });
$api->resource('phones', $phonesAdapter, function (Builder $schema) { $api->resource('phones', $phonesAdapter, function (Builder $schema) {
@ -381,7 +379,7 @@ class ShowTest extends AbstractTestCase
$body = json_decode($response->getBody(), true); $body = json_decode($response->getBody(), true);
$this->assertArrayNotHasKey('relationships', $body['data']); $this->assertArrayNotHasKey('data', $body['data']['relationships']);
$this->assertArrayNotHasKey('included', $body); $this->assertArrayNotHasKey('included', $body);
} }
@ -398,7 +396,7 @@ class ShowTest extends AbstractTestCase
'1' => $user = (object) [ '1' => $user = (object) [
'id' => '1', 'id' => '1',
'property1' => [$group1, $group2], 'property1' => [$group1, $group2],
'property2' => [$group3, $group4] 'property2' => [$group3, $group4],
] ]
]); ]);
@ -408,7 +406,7 @@ class ShowTest extends AbstractTestCase
$api->resource('users', $usersAdapter, function (Builder $schema) use (&$relationships) { $api->resource('users', $usersAdapter, function (Builder $schema) use (&$relationships) {
$relationships[] = $schema->hasMany('groups1', 'groups', 'property1') $relationships[] = $schema->hasMany('groups1', 'groups', 'property1')
->included(); ->includable();
$relationships[] = $schema->hasMany('groups2', 'groups', 'property2') $relationships[] = $schema->hasMany('groups2', 'groups', 'property2')
->includable(); ->includable();
@ -418,7 +416,8 @@ class ShowTest extends AbstractTestCase
$schema->attribute('name'); $schema->attribute('name');
}); });
$request = $this->buildRequest('GET', '/users/1'); $request = $this->buildRequest('GET', '/users/1')
->withQueryParams(['include' => 'groups1']);
$response = $api->handle($request); $response = $api->handle($request);
@ -525,18 +524,19 @@ class ShowTest extends AbstractTestCase
$relationships = []; $relationships = [];
$api->resource('posts', $postsAdapter, function (Builder $schema) use (&$relationships) { $api->resource('posts', $postsAdapter, function (Builder $schema) use (&$relationships) {
$relationships[] = $schema->hasOne('user')->included(); $relationships[] = $schema->hasOne('user');
}); });
$api->resource('users', $usersAdapter, function (Builder $schema) use (&$relationships) { $api->resource('users', $usersAdapter, function (Builder $schema) use (&$relationships) {
$relationships[] = $schema->hasMany('groups')->included(); $relationships[] = $schema->hasMany('groups')->includable();
}); });
$api->resource('groups', $groupsAdapter, function (Builder $schema) { $api->resource('groups', $groupsAdapter, function (Builder $schema) {
$schema->attribute('name'); $schema->attribute('name');
}); });
$request = $this->buildRequest('GET', '/posts/1'); $request = $this->buildRequest('GET', '/posts/1')
->withQueryParams(['include' => 'user,user.groups']);
$response = $api->handle($request); $response = $api->handle($request);
@ -556,24 +556,24 @@ class ShowTest extends AbstractTestCase
$included = json_decode($response->getBody(), true)['included']; $included = json_decode($response->getBody(), true)['included'];
$this->assertContains( // $this->assertContains(
[ // [
'type' => 'users', // 'type' => 'users',
'id' => '1', // 'id' => '1',
'relationships' => [ // 'relationships' => [
'groups' => [ // 'groups' => [
'data' => [ // 'data' => [
['type' => 'groups', 'id' => '1'], // ['type' => 'groups', 'id' => '1'],
['type' => 'groups', 'id' => '2'] // ['type' => 'groups', 'id' => '2']
] // ]
] // ]
], // ],
'links' => [ // 'links' => [
'self' => 'http://example.com/users/1' // 'self' => 'http://example.com/users/1'
] // ]
], // ],
$included // $included
); // );
$this->assertContains( $this->assertContains(
[ [