Merge branch 'release/3.0.0'

Author: lindyhopchris

.travis.yml

@@ -4,17 +4,13 @@ sudo: false
 
 matrix:
   include:
-    - php: "7.2"
-      env:
-        - LARAVEL_VERSION=^7.0
-        - PHPUNIT_VERSION=^8.0
     - php: "7.3"
       env:
-        - LARAVEL_VERSION=^7.0
+        - LARAVEL_VERSION=^8.0
         - PHPUNIT_VERSION=^9.0
     - php: "7.4"
       env:
-        - LARAVEL_VERSION=^7.0
+        - LARAVEL_VERSION=^8.0
         - PHPUNIT_VERSION=^9.0
 
 install:

CHANGELOG.md

@@ -2,6 +2,49 @@
 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.0.0] - 2020-09-09
+
+### Added
+- [#545](https://github.com/cloudcreativity/laravel-json-api/issues/545)
+The request test builder now supports testing requests that do not have JSON API request content,
+but expect a JSON API response. For example, a file upload that results in a JSON API resource
+in the response body can be tested using:
+`$this->jsonApi()->asMultiPartFormData()->withPayload($data)->post('/api/v1/avatars');`.
+
+### Changed
+- Minimum PHP version is now `7.3`.
+- Minimum Laravel version is now `8.0`.
+- [#497](https://github.com/cloudcreativity/laravel-json-api/issues/497) and
+[#529](https://github.com/cloudcreativity/laravel-json-api/pull/529)
+**BREAKING:** The method signature of the `AbstractValidators::rules()` method has changed,
+so that the method has access to the data that will be validated.
+- [#393](https://github.com/cloudcreativity/laravel-json-api/issues/393)
+**BREAKING:** when using the `SoftDeletesModel` trait on an adapter, the expected JSON API field
+for the soft delete attribute now defaults to the camel-case version of the model column. For example,
+column `deleted_at` previously defaulted to the JSON API field `deleted-at`, whereas now it will
+default to `deletedAt`. To continue to use dash-case, set the `softDeleteField` property on your adapter.
+
+## [2.2.0] - 2020-09-09
+
+### Added
+- [#549](https://github.com/cloudcreativity/laravel-json-api/issues/549)
+Can now add sort methods to an Eloquent adapter if sorting is more complex than just sorting by
+a column value.
+
+### Fixed
+- The error translator will now detect if the translated value is identical to the translation
+key path, and return `null` when it is. This fixes behaviour that changed in Laravel 7.28.
+
+## [2.1.0] - 2020-09-04
+
+### Added
+- [#538](https://github.com/cloudcreativity/laravel-json-api/issues/538)
+New JSON API exception class that accepts the new error objects from this package.
+It is recommended that you use `CloudCreativity\LaravelJsonApi\Exceptions\JsonApiException`
+combined with the `CloudCreativity\LaravelJsonApi\Document\Error\Error`. It is not
+recommended to use the `Neomerx\JsonApi\Exceptions\JsonApiException` class as support
+for this exception class will be removed in a future version.
+
 ## [2.0.0] - 2020-06-17
 
 ### Added

LICENSE

@@ -187,7 +187,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright 2020 Cloud Creativity Limited
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

README.md

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

composer.json

@@ -22,27 +22,28 @@
         }
     ],
     "require": {
-        "php": "^7.2",
+        "php": "^7.3",
         "ext-json": "*",
-        "illuminate/console": "^7.0",
-        "illuminate/contracts": "^7.0",
-        "illuminate/database": "^7.0",
-        "illuminate/filesystem": "^7.0",
-        "illuminate/http": "^7.0",
-        "illuminate/pagination": "^7.0",
-        "illuminate/support": "^7.0",
+        "illuminate/console": "^8.0",
+        "illuminate/contracts": "^8.0",
+        "illuminate/database": "^8.0",
+        "illuminate/filesystem": "^8.0",
+        "illuminate/http": "^8.0",
+        "illuminate/pagination": "^8.0",
+        "illuminate/support": "^8.0",
         "neomerx/json-api": "^1.0.3",
         "nyholm/psr7": "^1.2",
         "ramsey/uuid": "^3.0|^4.0",
         "symfony/psr-http-message-bridge": "^2.0"
     },
     "require-dev": {
         "ext-sqlite3": "*",
-        "cloudcreativity/json-api-testing": "^3.0",
-        "guzzlehttp/guzzle": "^6.3",
+        "cloudcreativity/json-api-testing": "^3.1",
+        "guzzlehttp/guzzle": "^7.0",
+        "laravel/legacy-factories": "^1.0.4",
         "laravel/ui": "^2.0",
         "mockery/mockery": "^1.1",
-        "orchestra/testbench": "^5.0",
+        "orchestra/testbench": "^6.0",
         "phpunit/phpunit": "^9.0"
     },
     "suggest": {
@@ -66,7 +67,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-develop": "2.x-dev"
+            "dev-develop": "3.x-dev"
         },
         "laravel": {
             "providers": [

docs/basics/adapters.md

@@ -103,21 +103,21 @@ If your resource supports client-generated ids, refer to the client-generated id
 
 When filling a model with attributes received in a JSON API request, the adapter will convert the JSON API
 field name to either the snake case or camel case equivalent. For example, if your JSON API resource had
-an attribute field called `published-at`, this is mapped to `published_at` if your model uses snake case keys,
+an attribute field called `publishedAt`, this is mapped to `published_at` if your model uses snake case keys,
 or `publishedAt` if not.
 
 > We work out whether your model uses snake case or camel case keys based on your model's `$snakeAttributes`
 static property.
 
 If you have a JSON API field name that needs to map to a different model attribute, this can be defined in your
-adapter's `$attributes` property. For example, if the `published-at` field needed to be mapped to the
+adapter's `$attributes` property. For example, if the `publishedAt` field needed to be mapped to the
 `published_date` attribute on your model, it must be defined as follows:
 
 ```php
 class Adapter extends AbstractAdapter
 {
     protected $attributes = [
-        'published-at' => 'published_date',
+        'publishedAt' => 'published_date',
     ];
 
     // ...
@@ -132,25 +132,25 @@ you will protect any attributes that are not fillable using Eloquent's
 
 There may be cases where an attribute is fillable on your model, but you do not want to allow your JSON API to
 fill it. You can set your adapter to skip attributes received from a client by listing the JSON API
-field name in the `$guarded` property on your adapter. For example, if we did not want the `published-at` field
+field name in the `$guarded` property on your adapter. For example, if we did not want the `publishedAt` field
 to be filled into our model, we would define it as follows:
 
 ```php
 class Adapter extends AbstractAdapter
 {
-    protected $guarded = ['published-at'];
+    protected $guarded = ['publishedAt'];
 
     // ...
 }
 ```
 
 Alternatively, you can white-list JSON API fields that can be filled by adding them to the `$fillable` property
-on your adapter. For example, if we only wanted the `title`, `content` and `published-at` fields to be filled:
+on your adapter. For example, if we only wanted the `title`, `content` and `publishedAt` fields to be filled:
 
 ```php
 class Adapter extends AbstractAdapter
 {
-    protected $fillable = ['title', 'content', 'published-at'];
+    protected $fillable = ['title', 'content', 'publishedAt'];
 
     // ...
 }
@@ -170,7 +170,7 @@ your adapter. For example:
 ```php
 class Adapter extends AbstractAdapter
 {
-    protected $dates = ['created-at', 'updated-at', 'published-at'];
+    protected $dates = ['createdAt', 'updatedAt', 'publishedAt'];
 
     // ...
 }

docs/basics/controllers.md

@@ -90,8 +90,8 @@ class PostsController extends JsonApiController
 
 ### Resource Hooks
 
-The controller allows you to hook into the resource lifecycle by invoking the following methods if they are 
-implemented. These methods allow you to easily implement application specific actions, such as firing events 
+The controller allows you to hook into the resource lifecycle by invoking the following methods if they are
+implemented. These methods allow you to easily implement application specific actions, such as firing events
 or dispatching jobs.
 
 | Hook | Arguments | Request Class |
@@ -106,12 +106,12 @@ or dispatching jobs.
 | `created` | record, request | `CreateResource` |
 | `saved` | record, request | `CreateResource` or `UpdateResource` |
 | `deleting` | record, request | `DeleteResource` |
-| `deleted` | record, request | `DeleteResource` | 
+| `deleted` | record, request | `DeleteResource` |
 
 > The request class is the validated request in the `CloudCreativity\LaravelJsonApi\Http\Requests` namespace.
 
 The `searching`, `searched`, `reading` and `didRead` hooks are invoked when resource(s) are being accessed,
-i.e. a `GET` request. The `searching` and `searched` hooks are invoked when reading any resources 
+i.e. a `GET` request. The `searching` and `searched` hooks are invoked when reading any resources
 (the *index* action), while `reading` and `didRead` are invoked when reading a specific record
 (the *read* action).
 
@@ -158,7 +158,7 @@ if reading the `author` relationship on a `posts` resource, the `readingRelation
 methods will be invoked if they exist.
 
 The `reading...` and `didRead...` methods are invoked when accessing the related resource or the relationship data,
-i.e. a `GET` relationship request. The `replacing...` and `replaced...` methods are invoked when changing the 
+i.e. a `GET` relationship request. The `replacing...` and `replaced...` methods are invoked when changing the
 entire relationship in a `PATCH` relationship request.
 
 For *to-many* relationships, the `adding...` and `added...` methods are invoked when adding resources to the
@@ -184,7 +184,7 @@ For example, if we wanted to send a `202 Accepted` response when a resource was
 protected function deleted($record)
 {
     return $this->reply()->meta([
-        'accepted-at' => Carbon\Carbon::now()->toW3cString()
+        'acceptedAt' => Carbon\Carbon::now(),
     ], 202);
 }
 ```
@@ -197,7 +197,7 @@ Content-Type: application/vnd.api+json
 
 {
   "meta": {
-    "accepted-at": "2018-04-10T11:56:52+00:00"
+    "acceptedAt": "2018-04-10T11:56:52+00:00"
   }
 }
 ```
@@ -224,11 +224,11 @@ use CloudCreativity\LaravelJsonApi\Http\Controllers\JsonApiController;
 
 class PostsController extends JsonApiController
 {
-    
+
     public function share(\App\Post $post): \Illuminate\Http\Response
     {
         \App\Jobs\SharePost::dispatch($post);
-        
+
         return $this->reply()->content($post);
     }
 }
@@ -257,11 +257,11 @@ use CloudCreativity\LaravelJsonApi\Http\Requests\FetchResource;
 
 class PostsController extends JsonApiController
 {
-    
+
     public function share(FetchResource $request, \App\Post $post): \Illuminate\Http\Response
     {
         \App\Jobs\SharePost::dispatch($post);
-        
+
         return $this->reply()->content($post);
     }
 }