[Feature-WIP] Upgrade dependencies and change implementations

Update the cloudcreativity/json-api and neomerx/json-api
dependencies and make immediate changes to classes that have
broken as a result of the new versions.

The changes are documented in the upgrade file but are:

- Removing abstract hydrator
- Updating abstract validator provider because of interface
changes.

Author: lindyhopchris

UPGRADE.md

@@ -2,6 +2,147 @@
 
 This file provides notes on how to upgrade between versions.
 
+## v0.4 to v0.5
+
+### Authorizers
+
+#### Abstract Authorizer
+
+If you are extending the `AbstractAuthorizer` class and implementing your own constructor, you will need to
+inject an instance of `CloudCreativity\JsonApi\Contracts\Repositories\ErrorRepositoryInterface` into the parent
+constructor. This change means you can now add errors to the error collection on your authorizer using the string
+keys for error objects held within your `json-api-errors` config file. For example:
+
+``` php
+public function canRead($record, EncodingParametersInterface $parameters)
+{
+  if (!\Auth::check()) {
+    $this->addError('access-denied');
+    return false;
+  }
+  
+  return true;
+}
+```
+
+Note that the recommended way to create error objects is via the error repository (which holds your error config)
+because it provides opportunities to add in translation etc of errors in the future.
+
+You will also need to implement the `canModifyRelationship` method. This was previously implemented in the abstract
+class but the previous implementation no longer works because of the change below.
+
+#### Update Authorization
+
+Update authorization can now access the resource sent by the client. At the point the authorizer is invoked, the
+resource will have been validated to check that it complies with the JSON API spec but it will **not** have been
+checked that it is valid according to your business logic - i.e. attributes and relationships will not have
+been validated against the specific rules for that resource type.
+
+Change the `canUpdate` method from this:
+
+``` php
+canUpdate($record, EncodingParametersInterface $parameters)
+```
+
+to:
+
+``` php
+// CloudCreativity\JsonApi\Contracts\Object\ResourceInterface;
+canUpdate(
+  $record, 
+  ResourceInterface $recource, 
+  EncodingParametersInterface $parameters
+) 
+```
+
+#### Modify Relationship Authorization
+
+Relationship modification authroization can now access the relationship sent by the client, as per the update 
+authorization changes above.
+
+Change the `canModifyRelationship` method from this:
+
+``` php
+public function canModifyRelationship(
+    $relationshipKey,
+    $record,
+    EncodingParametersInterface $parameters
+)
+```
+
+to:
+
+``` php
+// CloudCreativity\JsonApi\Contracts\Object\RelationshipInterface
+public function canModifyRelationship(
+    $relationshipKey,
+    $record,
+    RelationshipInterface $relationship,
+    EncodingParametersInterface $parameters
+)
+```
+
+### Hydrators
+
+The namespace of the `AbstractHydrator` has changed from `CloudCreativity\LaravelJsonApi\Hydrator\AbstractHydrator`
+to `CloudCreativity\JsonApi\Hydrator\AbstractHydrator`.
+
+### Validator Providers
+
+The classes that provide validators for individual resource types generally extend `AbstractValidatorProvider`. This
+now receives the resource type that is being validated into its public methods, and this is now passed down through 
+the internal methods. You'll therefore need to make the changes described below.
+
+This change has been made so that a single validator provider can be used for multiple resource types if desired. In
+general you are likely to keep a validator provider per resource type (because attribute and relationship rules will
+be specific to a resource type), this has given us the capability to implement a generic validator provider capable of
+validating any resource type according to the JSON API spec.
+
+#### Constructor
+
+If you have implemented a constructor, you will need to type hint the following interface and pass it to the parent
+constructor:
+
+```
+CloudCreativity\LaravelJsonApi\Contracts\Validators\ValidatorFactoryInterface
+```
+
+#### Resource Type Property
+
+You can remove the `$resourceType` property as it is no longer required.
+ 
+#### Method Changes
+
+You'll need to adjust the signature of the following abstract methods, from:
+ 
+``` php
+attributeRules($record = null)
+relationshipRules(RelationshipsValidatorInterface $relationships, $record = null)
+filterRules()
+```
+
+to:
+
+``` php
+attributeRules($resourceType, $record = null)
+relationshipRules(RelationshipsValidatorInterface $relationships, $resourceType, $record = null)
+filterRules($resourceType)
+```
+
+The `filterRules` method is actually no longer abstract, so if you are returning an empty array from it you can delete
+it.
+
+The signatures of other `protected` methods have also changed to pass down this additional argument. If you have
+implemented any other methods, check the abstract class for the new argument order.
+
+### Custom Validator Classes
+
+If you have written any custom validator classes, you will need to refer to the `v0.5` to `v0.6` notes here: 
+[cloudcreativty/json-api Upgrade Notes](https://github.com/cloudcreativity/json-api/blob/feature/v0.6/UPGRADE.md)
+
+By custom validators, we mean the validators that validate individual parts of a JSON API document. You are unlikely
+to have done this!
+
 ## v0.3 to v0.4
 
 This was a substantial reworking of the package based on our experience of using it in production environments.

composer.json

@@ -23,8 +23,9 @@
     ],
     "require": {
         "php": ">=5.5.0",
-        "laravel/framework": "5.1.*|5.2.*",
-        "cloudcreativity/json-api": "^0.5.2",
+        "laravel/framework": "5.1.*|5.2.*|5.3.*",
+        "neomerx/json-api": "^0.8.9",
+        "cloudcreativity/json-api": "0.6.x-dev",
         "symfony/psr-http-message-bridge": "^0.2.0",
         "zendframework/zend-diactoros": "^1.3"
     },
@@ -41,5 +42,10 @@
         "psr-4": {
             "CloudCreativity\\LaravelJsonApi\\": "test/"
         }
+    },
+    "extra": {
+      "branch-alias": {
+        "dev-feature/v0.5": "0.5.x-dev"
+      }
     }
 }

src/Http/Requests/AbstractRequest.php

@@ -258,7 +258,7 @@ protected function authorizeBeforeValidation()
             $authorized = $this->authorizer->canRead($this->getRecord(), $parameters);
         } /** Update Resource */
         elseif ($this->isUpdateResource()) {
-            $authorized = $this->authorizer->canUpdate($this->getRecord(), $parameters);
+            $authorized = $this->authorizer->canUpdate($this->getRecord(), $this->getDocument()->getResource(), $parameters);
         } /** Delete Resource */
         elseif ($this->isDeleteResource()) {
             $authorized = $this->authorizer->canDelete($this->getRecord(), $parameters);
@@ -281,6 +281,7 @@ protected function authorizeBeforeValidation()
             $authorized = $this->authorizer->canModifyRelationship(
                 $this->getRelationshipName(),
                 $this->getRecord(),
+                $this->getDocument()->getRelationship(),
                 $parameters
             );
         }
@@ -361,7 +362,7 @@ protected function validateParameters()
 
         /** If we are on an index route, we also validate the filter parameters. */
         $validator = ($this->isIndex() && $this->validators) ?
-            $this->validators->filterResources() : null;
+            $this->validators->filterResources($this->getResourceType()) : null;
 
         if ($validator && !$validator->isValid((array) $parameters->getFilteringParameters())) {
             throw new ValidationException($validator->getErrors());
@@ -381,13 +382,13 @@ protected function validator()
 
         /** Create Resource */
         if ($this->isCreateResource()) {
-            return $this->validators->createResource();
+            return $this->validators->createResource($this->getResourceType());
         } /** Update Resource */
         elseif ($this->isUpdateResource()) {
-            return $this->validators->updateResource($this->getRecord(), $this->getResourceId());
+            return $this->validators->updateResource($this->getResourceType(), $this->getResourceId(), $this->getRecord());
         } /** Replace Relationship */
         elseif ($this->isModifyRelationship()) {
-            return $this->validators->modifyRelationship($this->getRelationshipName(), $this->getRecord());
+            return $this->validators->modifyRelationship($this->getResourceType(), $this->getResourceId(), $this->getRelationshipName(), $this->getRecord());
         }
 
         return null;

src/Hydrator/AbstractHydrator.php

@@ -173,16 +173,13 @@ protected function createLink($page, $perPage, array $parameters = [], $meta = n
 
     /**
      * @param SortParameterInterface[] $parameters
-     * @return string
+     * @return string|null
      */
     private function buildSortParams(array $parameters)
     {
-        $sort = [];
-
-        /** @var SortParameterInterface $param */
-        foreach ($parameters as $param) {
-            $sort[] = $param->isAscending() ? $param->getField() : '-' . $param->getField();
-        }
+        $sort = array_map(function (SortParameterInterface $param) {
+            return (string) $param;
+        }, $parameters);
 
         return !empty($sort) ? implode(',', $sort) : null;
     }