Merge branch 'release/2.0.0'

Author: lindyhopchris

CHANGELOG.md

@@ -2,6 +2,19 @@
 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/).
 
+## [2.0.0] - 2020-06-17
+
+### Added
+- Translation files can now be published using the `vendor:publish` Artisan command.
+
+### Fixed
+- [#506](https://github.com/cloudcreativity/laravel-json-api/pull/506)
+Resolve model bindings correctly when substituting URL parameters.
+- Updated type-hinting for `Responses::errors()` method and allowed a `null` default
+status code to be passed to `Helpers::httpErrorStatus()` method.
+- [#518](https://github.com/cloudcreativity/laravel-json-api/issues/518)
+Ensure empty `sort` and `include` query parameters pass validation.
+
 ## [2.0.0-beta.3] - 2020-04-13
 
 ### Added

README.md

@@ -62,7 +62,7 @@ A demo application is available at [here](https://github.com/cloudcreativity/dem
 
 | Laravel | This Package |
 | --- | --- |
-| `^7.0` | `^2.0` (currently `beta` releases) |
+| `^7.0` | `^2.0` |
 | `^6.0` | `^1.7` |
 | `5.8.*` | `^1.7` |
 | `5.7.*` | `^1.0` |

docs/features/async.md

@@ -1,9 +1,9 @@
 # Asynchronous Processing
 
-The JSON API specification 
+The JSON API specification
 [provides a recommendation](https://jsonapi.org/recommendations/#asynchronous-processing)
-for how APIs can implement long running processes. For example, if the operation to create a 
-resource takes a long time, it is more appropriate to process the creation using 
+for how APIs can implement long running processes. For example, if the operation to create a
+resource takes a long time, it is more appropriate to process the creation using
 [Laravel's queue system](https://laravel.com/docs/queues)
 and return a `202 Accepted` response to the client.
 
@@ -29,14 +29,14 @@ use Illuminate\Support\ServiceProvider;
 
 class AppServiceProvider extends ServiceProvider
 {
-    
+
     // ...
-    
+
     public function register()
     {
         LaravelJsonApi::runMigrations();
     }
-    
+
 }
 ```
 
@@ -45,7 +45,7 @@ class AppServiceProvider extends ServiceProvider
 If you want to customise the migrations, you can publish them as follows:
 
 ```bash
-$ php artisan vendor:publish --tag="json-api-migrations"
+$ php artisan vendor:publish --tag="json-api:migrations"
 ```
 
 If you do this, you **must not** call `LaravelJsonApi::runMigrations()` in your service provider.
@@ -76,7 +76,7 @@ use Neomerx\JsonApi\Schema\SchemaProvider;
 class Schema extends SchemaProvider
 {
     use AsyncSchema;
-    
+
     // ...
 }
 ```
@@ -112,7 +112,7 @@ class ProcessPodcast implements ShouldQueue
 {
 
     use ClientDispatchable;
-    
+
     // ...
 }
 
@@ -130,7 +130,7 @@ means you can use any of the normal Laravel methods. The only difference is you
 `dispatch` method at the end of the chain so that you have access to the process that was stored
 and can be serialized into JSON by your API.
 
-You can use this method of dispatching jobs in either 
+You can use this method of dispatching jobs in either
 [Controller Hooks](../basics/controllers.md) or within
 [Resource Adapters](../basics/adapters.md), depending on your preference.
 
@@ -190,9 +190,9 @@ class Adapter extends AbstractAdapter
 If a dispatched job creates a new resource (e.g. a new model), there is one additional step you will
 need to follow in the job's `handle` method. This is to link the stored process to the resource that was
 created as a result of the job completing successfully. The link must exist otherwise your API
-will not be able to inform a client of the location of the created resource once the job is complete. 
+will not be able to inform a client of the location of the created resource once the job is complete.
 
-You can easily create this link by calling the `didCreate` method that the `ClientDispatchable` 
+You can easily create this link by calling the `didCreate` method that the `ClientDispatchable`
 trait adds to your job. For example:
 
 ```php
@@ -205,13 +205,13 @@ class ProcessPodcast implements ShouldQueue
 {
 
     use ClientDispatchable;
-    
+
     // ...
-    
+
     public function handle()
     {
         // ...logic to process a podcast
-        
+
         $this->didCreate($podcast);
     }
 }
@@ -272,11 +272,11 @@ This enables the following routes:
 
 - `GET /podcasts/queue-jobs`: this lists all `queue-jobs` resources for the `podcasts`
 resource type.
-- `GET /podcasts/queue-jobs/<UUID>`: this retrieves a specific `queue-jobs` resource 
+- `GET /podcasts/queue-jobs/<UUID>`: this retrieves a specific `queue-jobs` resource
 for the `podcasts` resource type.
 
 The resource type `queue-jobs` is the name used in the JSON API's recommendation for
-asynchronous processing. If you want to use a resource type, then you can change this 
+asynchronous processing. If you want to use a resource type, then you can change this
 by editing the `jobs.resource` config setting in your API's configuration file.
 
 Note that we assume the resource id of a process is a valid UUID. If you use something
@@ -291,7 +291,7 @@ JsonApi::register('default')->withNamespace('Api')->routes(function ($api) {
 ## HTTP Requests and Responses
 
 Once you have followed the above instructions, you can now make HTTP requests and receive
-asynchronous process responses that following the 
+asynchronous process responses that following the
 [JSON API recommendation.](https://jsonapi.org/recommendations/#asynchronous-processing)
 
 For example, a request to create a podcast would receive the following response:

src/Api/Url.php

@@ -103,7 +103,13 @@ public function replace(iterable $parameters): self
         $copy = clone $this;
 
         foreach ($parameters as $key => $value) {
-            $copy->namespace = \str_replace('{' . $key . '}', $value, $copy->namespace);
+            $routeParamValue = $value;
+
+            if ($value instanceof UrlRoutable) {
+              $routeParamValue = $value->getRouteKey();
+            }
+
+            $copy->namespace = \str_replace('{' . $key . '}', $routeParamValue, $copy->namespace);
         }
 
         return $copy;

src/Http/Responses/Responses.php

@@ -413,7 +413,7 @@ public function error($error, int $defaultStatusCode = null, array $headers = []
      * @param array $headers
      * @return mixed
      */
-    public function errors(iterable $errors, $defaultStatusCode = null, array $headers = [])
+    public function errors(iterable $errors, int $defaultStatusCode = null, array $headers = [])
     {
         $errors = $this->factory->createErrors($errors);
         $statusCode = Helpers::httpErrorStatus($errors, $defaultStatusCode);

src/ServiceProvider.php

@@ -80,7 +80,11 @@ public function boot(Router $router)
 
             $this->publishes([
                 __DIR__ . '/../database/migrations' => database_path('migrations'),
-            ], 'json-api-migrations');
+            ], 'json-api:migrations');
+
+            $this->publishes([
+                __DIR__ . '/../resources/lang' => resource_path('lang/vendor/jsonapi'),
+            ], 'json-api:translations');
 
             $this->commands([
                 Console\Commands\MakeAdapter::class,

src/Utils/Helpers.php

@@ -157,13 +157,17 @@ public static function isJsonApi($request)
      * 4xx errors or 500 Internal Server Error might be appropriate for multiple 5xx errors.
      *
      * @param iterable|ErrorInterface $errors
-     * @param int $default
+     * @param int|null $default
      * @return int
      * @see https://jsonapi.org/format/#errors
      * @deprecated 3.0.0 use `Document\Error\Errors::getStatus()`
      */
-    public static function httpErrorStatus($errors, int $default = SymfonyResponse::HTTP_BAD_REQUEST): int
+    public static function httpErrorStatus($errors, int $default = null): int
     {
+        if (\is_null($default)) {
+            $default = SymfonyResponse::HTTP_BAD_REQUEST;
+        }
+
         if ($errors instanceof ErrorInterface) {
             $errors = [$errors];
         }

src/Validation/AbstractValidators.php

@@ -655,6 +655,7 @@ protected function defaultQueryRules(): array
             ],
             'include' => [
                 'bail',
+                'nullable',
                 'string',
                 $this->allowedIncludePaths(),
             ],
@@ -665,6 +666,7 @@ protected function defaultQueryRules(): array
             ],
             'sort' => [
                 'bail',
+                'nullable',
                 'string',
                 $this->allowedSortParameters(),
             ],

tests/lib/Integration/Eloquent/ResourceTest.php

@@ -67,6 +67,15 @@ public function testSortedSearch()
             ->assertFetchedManyInOrder([$b, $a]);
     }
 
+    public function testEmptySort(): void
+    {
+        $posts = factory(Post::class, 2)->create();
+
+        $this->jsonApi()
+            ->get('api/v1/posts?sort=')
+            ->assertFetchedMany($posts);
+    }
+
     public function testFilteredSearch()
     {
         $a = factory(Post::class)->create([
@@ -329,6 +338,18 @@ public function testReadWithInclude()
             ->assertIsIncluded('tags', $tag);
     }
 
+    /**
+     * @see https://github.com/cloudcreativity/laravel-json-api/issues/518
+     */
+    public function testReadWithEmptyInclude(): void
+    {
+        $post = factory(Post::class)->create();
+
+        $this->jsonApi()
+            ->get("api/v1/posts/{$post->getRouteKey()}?include=")
+            ->assertFetchedOne($this->serialize($post));
+    }
+
     /**
      * @see https://github.com/cloudcreativity/laravel-json-api/issues/194
      */

tests/lib/Integration/Routing/RouteParameterTest.php

@@ -20,6 +20,7 @@
 use CloudCreativity\LaravelJsonApi\Routing\RouteRegistrar;
 use CloudCreativity\LaravelJsonApi\Tests\Integration\TestCase;
 use DummyApp\Post;
+use DummyApp\User;
 use Illuminate\Support\Arr;
 
 /**
@@ -77,4 +78,16 @@ public function testManual(): void
             Arr::get($data, 'data.links.self')
         );
     }
+
+    public function testModelBinding(): void
+    {
+        $post = factory(Post::class)->create();
+        $user = factory(User::class)->create();
+        $data = json_api(null, null, ['tenant' => $user])->encoder()->serializeData($post);
+
+        $this->assertSame(
+            url('/foo/2/api/posts', $post),
+            Arr::get($data, 'data.links.self')
+        );
+    }
 }