[Feature-WIP] Rewiring to use controller middleware

For Laravel 5.3, it is necessary to use controller middleware
to run the validation of the HTTP request once for a specific
resource type.

This commit refactors the architecture so that:

1. JSON API suppprt is initiated and as HTTP content is parsed
for conformance to the spec. This happens in route middleware
and has no knowledge of what specific resource type is the
subject of the request. This process does content negotiation,
parses encoding parameters and parses document content checking
it conforms to the spec.

2. Other application middleware is now executed, knowing that
any exceptions thrown will be cast to JSON API errors.

3. The JSON API request is finalised with knowledge of what
resource type is expected. A JSON API request object is built
from all finalised parameters, and then this is validated
according to business logic. This is all done by a new piece
of middleware - `json-api-request` - that is registered as
controller middleware as that is the only point at which the
specific resource type is known, plus therefore the business
rules for validating request parameters and content.

Refer to issue #13

Author: lindyhopchris

src/Contracts/Http/Requests/RequestHandlerInterface.php

@@ -18,64 +18,30 @@
 
 namespace CloudCreativity\LaravelJsonApi\Contracts\Http\Requests;
 
-use CloudCreativity\JsonApi\Contracts\Object\DocumentInterface;
-use CloudCreativity\LaravelJsonApi\Exceptions\RequestException;
-use Illuminate\Contracts\Validation\ValidatesWhenResolved;
-use Illuminate\Http\Request;
-use Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
+use CloudCreativity\JsonApi\Contracts\Http\RequestInterpreterInterface;
+use CloudCreativity\LaravelJsonApi\Http\Requests\JsonApiRequest;
+use Neomerx\JsonApi\Exceptions\JsonApiException;
 
 /**
  * Interface RequestHandlerInterface
  * @package CloudCreativity\LaravelJsonApi
  */
-interface RequestHandlerInterface extends ValidatesWhenResolved
+interface RequestHandlerInterface
 {
 
     /**
-     * The resource type that this request handles.
-     *
-     * @return string
-     */
-    public function getResourceType();
-
-    /**
-     * Get the record that the request relates to.
-     *
-     * E.g. if the request is `GET /posts/1`, then the record is the object that the
-     * store resolves as being `post` with id 1.
-     *
-     * @return object
-     * @throws RequestException
-     *      if the request does not related to a specific record.
-     */
-    public function getRecord();
-
-    /**
-     * Get the request body content as a JSON API document.
-     *
-     * @return DocumentInterface
-     */
-    public function getDocument();
-
-    /**
-     * Get the encoding parameters that the client sent.
-     *
-     * @return EncodingParametersInterface
+     * @param RequestInterpreterInterface $interpreter
+     * @param JsonApiRequest $request
+     * @return void
+     * @throws JsonApiException
      */
-    public function getEncodingParameters();
+    public function handle(RequestInterpreterInterface $interpreter, JsonApiRequest $request);
 
     /**
-     * Get the underlying HTTP request.
+     * Get the resource type that the handler validates
      *
-     * @return Request
-     */
-    public function getHttpRequest();
-
-    /**
-     * Did validation complete successfully?
-     *
-     * @return bool
+     * @return string
      */
-    public function isValid();
+    public function getResourceType();
 
 }

src/Http/Controllers/EloquentController.php

@@ -23,6 +23,7 @@
 use CloudCreativity\JsonApi\Contracts\Object\ResourceInterface;
 use CloudCreativity\LaravelJsonApi\Contracts\Http\Requests\RequestHandlerInterface;
 use CloudCreativity\LaravelJsonApi\Contracts\Search\SearchInterface;
+use CloudCreativity\LaravelJsonApi\Http\Requests\JsonApiRequest;
 use CloudCreativity\LaravelJsonApi\Search\SearchAll;
 use Exception;
 use Illuminate\Contracts\Pagination\Paginator;
@@ -35,7 +36,7 @@
  * Class EloquentController
  * @package CloudCreativity\LaravelJsonApi
  */
-class EloquentController extends JsonApiController
+abstract class EloquentController extends JsonApiController
 {
 
     /**
@@ -68,40 +69,40 @@ class EloquentController extends JsonApiController
     /**
      * EloquentController constructor.
      * @param Model $model
-     * @param RequestHandlerInterface $request
      * @param HydratorInterface|null $hydrator
      * @param SearchInterface|null $search
      */
     public function __construct(
         Model $model,
-        RequestHandlerInterface $request,
         HydratorInterface $hydrator = null,
         SearchInterface $search = null
     ) {
-        parent::__construct($request);
+        parent::__construct();
         $this->model = $model;
         $this->hydrator = $hydrator;
         $this->search = $search ?: new SearchAll();
     }
 
     /**
+     * @param JsonApiRequest $request
      * @return Response
      */
-    public function index()
+    public function index(JsonApiRequest $request)
     {
-        $result = $this->search();
+        $result = $this->search($request);
 
         return $this
             ->reply()
             ->content($result);
     }
 
     /**
+     * @param JsonApiRequest $request
      * @return Response
      */
-    public function create()
+    public function create(JsonApiRequest $request)
     {
-        $model = $this->hydrate($this->getResource(), $this->model);
+        $model = $this->hydrate($request->getDocument()->getResource(), $this->model);
         $result = ($model instanceof Response) ? $model : $this->doCommit($model);
 
         if ($result instanceof Response) {
@@ -116,23 +117,23 @@ public function create()
     }
 
     /**
-     * @param $resourceId
+     * @param JsonApiRequest $request
      * @return Response
      */
-    public function read($resourceId)
+    public function read(JsonApiRequest $request)
     {
         return $this
             ->reply()
-            ->content($this->getRecord());
+            ->content($this->getRecord($request));
     }
 
     /**
-     * @param $resourceId
+     * @param JsonApiRequest $request
      * @return Response
      */
-    public function update($resourceId)
+    public function update(JsonApiRequest $request)
     {
-        $model = $this->hydrate($this->getResource(), $this->getRecord());
+        $model = $this->hydrate($request->getDocument()->getResource(), $this->getRecord($request));
         $result = ($model instanceof Response) ? $model : $this->doCommit($model);
 
         if ($result instanceof Response) {
@@ -147,12 +148,12 @@ public function update($resourceId)
     }
 
     /**
-     * @param $resourceId
+     * @param JsonApiRequest $request
      * @return Response
      */
-    public function delete($resourceId)
+    public function delete(JsonApiRequest $request)
     {
-        $model = $this->getRecord();
+        $model = $this->getRecord($request);
         $result = $this->doDestroy($model);
 
         if ($result instanceof Response) {
@@ -167,48 +168,42 @@ public function delete($resourceId)
     }
 
     /**
-     * @param $resourceId
-     * @param $relationshipName
+     * @param JsonApiRequest $request
      * @return Response
      */
-    public function readRelatedResource($resourceId, $relationshipName)
+    public function readRelatedResource(JsonApiRequest $request)
     {
-        $model = $this->getRecord();
-        $key = $this->keyForRelationship($relationshipName);
+        $model = $this->getRecord($request);
+        $key = $this->keyForRelationship($request->getRelationshipName());
 
         return $this
             ->reply()
             ->content($model->{$key});
     }
 
     /**
-     * @param $resourceId
-     * @param $relationshipName
+     * @param JsonApiRequest $request
      * @return Response
      */
-    public function readRelationship($resourceId, $relationshipName)
+    public function readRelationship(JsonApiRequest $request)
     {
-        $model = $this->getRecord();
-        $key = $this->keyForRelationship($relationshipName);
+        $model = $this->getRecord($request);
+        $key = $this->keyForRelationship($request->getRelationshipName());
 
         return $this
             ->reply()
             ->relationship($model->{$key});
     }
 
     /**
+     * @param JsonApiRequest $request
      * @return Paginator|Collection|Model|null
      */
-    protected function search()
+    protected function search(JsonApiRequest $request)
     {
-        if (!$this->search) {
-            return $this->model->all();
-        }
-
         $builder = $this->model->newQuery();
-        $parameters = $this->getRequestHandler()->getEncodingParameters();
 
-        return $this->search->search($builder, $parameters);
+        return $this->search->search($builder, $request->getParameters());
     }
 
     /**
@@ -342,11 +337,12 @@ protected function keyForRelationship($relationshipName)
     }
 
     /**
+     * @param JsonApiRequest $request
      * @return Model
      */
-    protected function getRecord()
+    protected function getRecord(JsonApiRequest $request)
     {
-        $record = parent::getRecord();
+        $record = $request->getRecord();
 
         if (!$record instanceof Model) {
             throw new RuntimeException(sprintf('%s expects to be used with a %s record.', static::class, Model::class));