Merge branch 'release/3.2.0'

Author: lindyhopchris

.gitattributes

@@ -0,0 +1,8 @@
+/docs export-ignore
+/tests export-ignore
+.editorconfig export-ignore
+.gitattributes export-ignore
+.gitignore export-ignore
+.travis.yml export-ignore
+mkdocs.yml export-ignore
+phpunit.xml export-ignore

.travis.yml

@@ -1,14 +1,18 @@
 language: php
-dist: trusty
+dist: xenial
 sudo: false
 
 matrix:
   include:
-    - php: "7.3"
+    - php: 7.3
       env:
         - LARAVEL_VERSION=^8.0
         - PHPUNIT_VERSION=^9.0
-    - php: "7.4"
+    - php: 7.4
+      env:
+        - LARAVEL_VERSION=^8.0
+        - PHPUNIT_VERSION=^9.0
+    - php: 8.0snapshot
       env:
         - LARAVEL_VERSION=^8.0
         - PHPUNIT_VERSION=^9.0

CHANGELOG.md

@@ -2,6 +2,21 @@
 All notable changes to this project will be documented in this file. This project adheres to
 [Semantic Versioning](http://semver.org/) and [this changelog format](http://keepachangelog.com/).
 
+## [3.2.0] - 2020-11-26
+
+### Added
+- Package now supports PHP 8.
+- [#570](https://github.com/cloudcreativity/laravel-json-api/issues/570)
+Exception parser now handles the Symfony request exception interface.
+- [#507](https://github.com/cloudcreativity/laravel-json-api/issues/507)
+Can now specify the resource type and relationship URIs when registering routes. This allows
+the URI fragment to be different from the resource type or relationship name.
+
+### Fixed
+- Fixed qualifying column for morph-to-many relations. This was caused by Laravel introducing
+a breaking change of adding a `qualifyColumn` method to the relation builder. Previously
+calling `qualifyColumn` on the relation forwarded the call to the model.
+
 ## [3.1.0] - 2020-10-28
 
 ### Added

composer.json

@@ -22,7 +22,7 @@
         }
     ],
     "require": {
-        "php": "^7.3",
+        "php": "^7.3|^8.0",
         "ext-json": "*",
         "illuminate/console": "^8.0",
         "illuminate/contracts": "^8.0",
@@ -41,7 +41,7 @@
         "cloudcreativity/json-api-testing": "^3.1",
         "guzzlehttp/guzzle": "^7.0",
         "laravel/legacy-factories": "^1.0.4",
-        "laravel/ui": "^2.0",
+        "laravel/ui": "^3.0",
         "mockery/mockery": "^1.1",
         "orchestra/testbench": "^6.0",
         "phpunit/phpunit": "^9.0"

docs/basics/routing.md

@@ -22,8 +22,8 @@ to it.
 
 ### API Route Prefix
 
-When registering a JSON API, we automatically read the URL prefix and route name prefix from your 
-[API's URL configuration](./api#url) and apply this to the route group for your API. The URL prefix in your JSON API 
+When registering a JSON API, we automatically read the URL prefix and route name prefix from your
+[API's URL configuration](./api#url) and apply this to the route group for your API. The URL prefix in your JSON API
 config is **always** relative to the root URL on a host, i.e. from `/`.
 **This means when registering your routes, you need to ensure that no prefix has already been applied.**
 
@@ -42,7 +42,7 @@ JsonApi::register('default')->withNamespace('Api')->routes(function ($api) {
 ```
 
 > We use `withNamespace()` instead of Laravel's usual `namespace()` method because `namespace` is a
-[Reserved Keyword](http://php.net/manual/en/reserved.keywords.php). 
+[Reserved Keyword](http://php.net/manual/en/reserved.keywords.php).
 
 ## Resource Routes
 
@@ -67,6 +67,16 @@ JsonApi::register('default')->routes(function ($api) {
 });
 ```
 
+By default the resource type is used as the URI fragment: i.e. the `posts` resource will have a URI of
+`/posts`. If you want to use a different URI fragment, use the `uri()` method. In the following example,
+the resource type is `posts` but the URI will be `/blog_posts`:
+
+```php
+JsonApi::register('default')->routes(function ($api) {
+    $api->resource('posts')->uri('blog_posts');
+});
+```
+
 ## Relationship Routes
 
 The JSON API spec also defines routes for relationships on a resource type. There are two types of relationships:
@@ -87,6 +97,19 @@ JsonApi::register('default')->routes(function ($api) {
 });
 ```
 
+By default the relationship name is used as the URI fragment: i.e. for the `comments` relationship on the
+`posts` resource, the related resource URI is `/posts/{record}/comments`. To customise the URI framgent,
+use the `uri()` method. In the following example, the relationship name is `comments` but the URI
+will be `/posts/{record}/blog_comments`:
+
+```php
+JsonApi::register('default')->routes(function ($api) {
+    $api->resource('posts')->relationships(function ($relations) {
+        $relations->hasMany('comments')->uri('blog_comments');
+    });
+});
+```
+
 ### Related Resource Type
 
 When registering relationship routes, it is assumed that the resource type returned in the response is the
@@ -252,7 +275,7 @@ JsonApi::register('default')->withNamespace('Api')->routes(function ($api, $rout
 
 ### Controller Names
 
-If you call `controller()` without any arguments, we assume your controller is the camel case name version of 
+If you call `controller()` without any arguments, we assume your controller is the camel case name version of
 the resource type with `Controller` on the end. I.e. `posts` would expect `PostsController` and
 `blog-posts` would expect `BlogPostsController`. Or if your resource type was `post`,
 we would guess `PostController`.
@@ -332,7 +355,7 @@ If you are using these, you will also need to refer to the *Custom Actions* sect
 
 Also note that custom routes are registered *before* the routes defined by the JSON API specification,
 i.e. those that are added when you call `$api->resource('posts')`. You will need to ensure that your
-custom route definitions do not collide with these defined routes. 
+custom route definitions do not collide with these defined routes.
 
 > Generally we advise against registering custom routes. This is because the JSON API specification may
 have additional routes added to it in the future, which might collide with your custom routes.
@@ -396,7 +419,7 @@ does not contain an `@` symbol we add the controller name to it.
 
 Secondly, if you are defining a custom relationship route, you must use the `field` method. This takes
 the relationship name as its first argument. The inverse resource type can be specified as the second argument,
-for example: 
+for example:
 
 ```php
 JsonApi::register('default')->withNamespace('Api')->routes(function ($api) {

src/Eloquent/Concerns/SortsModels.php

@@ -127,7 +127,7 @@ protected function getQualifiedSortColumn($query, $field)
     {
         $key = $this->getSortColumn($field, $query->getModel());
 
-        return $query->qualifyColumn($key);
+        return $query->getModel()->qualifyColumn($key);
     }
 
     /**

src/Exceptions/ExceptionParser.php

@@ -29,6 +29,7 @@
 use Neomerx\JsonApi\Contracts\Document\ErrorInterface;
 use Neomerx\JsonApi\Document\Error;
 use Neomerx\JsonApi\Exceptions\JsonApiException as NeomerxJsonApiException;
+use Symfony\Component\HttpFoundation\Exception\RequestExceptionInterface;
 use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface;
 
 /**
@@ -101,6 +102,10 @@ protected function getErrors(\Throwable $e): array
             return [$this->getHttpError($e)];
         }
 
+        if ($e instanceof RequestExceptionInterface) {
+            return [$this->getRequestError($e)];
+        }
+
         return [$this->getDefaultError()];
     }
 
@@ -125,6 +130,22 @@ protected function getHttpError(HttpExceptionInterface $e): ErrorInterface
         return new Error(null, null, $status, null, $title, $e->getMessage() ?: null);
     }
 
+    /**
+     * @param RequestExceptionInterface|\Throwable $e
+     * @return ErrorInterface
+     */
+    protected function getRequestError(RequestExceptionInterface $e): ErrorInterface
+    {
+        return new Error(
+            null,
+            null,
+            $status = Response::HTTP_BAD_REQUEST,
+            null,
+            $this->getDefaultTitle($status),
+            $e->getMessage() ?: null
+        );
+    }
+
     /**
      * @return ErrorInterface
      */

src/Routing/RelationshipRegistration.php

@@ -37,6 +37,17 @@ public function __construct(array $options = [])
         $this->options = $options;
     }
 
+    /**
+     * @param string $uri
+     * @return $this
+     */
+    public function uri(string $uri): self
+    {
+        $this->options['relationship_uri'] = $uri;
+
+        return $this;
+    }
+
     /**
      * @param string $resourceType
      * @return $this

src/Routing/RelationshipsRegistrar.php

@@ -115,7 +115,7 @@ private function add(string $field, array $options): void
 
         $this->router->group([], function () use ($field, $options, $inverse) {
             foreach ($options['actions'] as $action) {
-                $this->route($field, $action, $inverse);
+                $this->route($field, $action, $inverse, $options);
             }
         });
     }
@@ -125,13 +125,14 @@ private function add(string $field, array $options): void
      * @param string $action
      * @param string $inverse
      *      the inverse resource type
+     * @param array $options
      * @return Route
      */
-    private function route(string $field, string $action, string $inverse): Route
+    private function route(string $field, string $action, string $inverse, array $options): Route
     {
         $route = $this->createRoute(
             $this->methodForAction($action),
-            $this->urlForAction($field, $action),
+            $this->urlForAction($field, $action, $options),
             $this->actionForRoute($field, $action)
         );
 
@@ -161,24 +162,30 @@ private function hasManyActions(array $options): array
 
     /**
      * @param string $relationship
+     * @param array $options
      * @return string
      */
-    private function relatedUrl($relationship): string
+    private function relatedUrl(string $relationship, array $options): string
     {
-        return sprintf('%s/%s', $this->resourceUrl(), $relationship);
+        return sprintf(
+            '%s/%s',
+            $this->resourceUrl(),
+            $options['relationship_uri'] ?? $relationship
+        );
     }
 
     /**
-     * @param $relationship
+     * @param string $relationship
+     * @param array $options
      * @return string
      */
-    private function relationshipUrl($relationship): string
+    private function relationshipUrl(string $relationship, array $options): string
     {
         return sprintf(
             '%s/%s/%s',
             $this->resourceUrl(),
             ResourceRegistrar::KEYWORD_RELATIONSHIPS,
-            $relationship
+            $options['relationship_uri'] ?? $relationship
         );
     }
 
@@ -194,15 +201,16 @@ private function methodForAction(string $action): string
     /**
      * @param string $field
      * @param string $action
+     * @param array $options
      * @return string
      */
-    private function urlForAction(string $field, string $action): string
+    private function urlForAction(string $field, string $action, array $options): string
     {
         if ('related' === $action) {
-            return $this->relatedUrl($field);
+            return $this->relatedUrl($field, $options);
         }
 
-        return $this->relationshipUrl($field);
+        return $this->relationshipUrl($field, $options);
     }
 
     /**

src/Routing/ResourceRegistrar.php

@@ -168,10 +168,12 @@ private function contentNegotiation(): string
      */
     private function attributes(): array
     {
+        $prefix = $this->options['resource_uri'] ?? $this->resourceType;
+
         return [
             'middleware' => $this->middleware(),
             'as' => "{$this->resourceType}.",
-            'prefix' => $this->resourceType,
+            'prefix' => $prefix,
         ];
     }