Add inputSet method to JsonApiRequest, refactor usage in controller

Author: huntie

src/Http/Controllers/JsonApiController.php

@@ -2,7 +2,6 @@
 
 namespace Huntie\JsonApi\Http\Controllers;
 
-use Validator;
 use Huntie\JsonApi\Contracts\Model\IncludesRelatedResources;
 use Huntie\JsonApi\Exceptions\InvalidRelationPathException;
 use Huntie\JsonApi\Http\JsonApiResponse;
@@ -19,7 +18,6 @@
 use Illuminate\Foundation\Validation\ValidatesRequests;
 use Illuminate\Http\Response;
 use Illuminate\Routing\Controller;
-use Illuminate\Validation\ValidationException;
 
 abstract class JsonApiController extends Controller
 {
@@ -62,11 +60,10 @@ public function __construct()
     public function indexAction($request, $query = null)
     {
         $records = $query ?: $this->model->newQuery();
-        $params = $this->getRequestParameters($request);
-        $this->validateIncludableRelations($params['include']);
+        $this->validateIncludableRelations($request->inputSet('include'));
 
-        $records = $this->sortQuery($records, $params['sort']);
-        $records = $this->filterQuery($records, $params['filter']);
+        $records = $this->sortQuery($records, $request->inputSet('sort'));
+        $records = $this->filterQuery($records, (array) $request->input('filter'));
 
         try {
             $pageSize = min($this->model->getPerPage(), $request->input('page.size'));
@@ -77,7 +74,7 @@ public function indexAction($request, $query = null)
             return $this->error(Response::HTTP_BAD_REQUEST, 'Invalid query parameters');
         }
 
-        return new JsonApiResponse(new CollectionSerializer($records, $params['fields'], $params['include']));
+        return new JsonApiResponse(new CollectionSerializer($records, $request->inputSet('fields'), $request->inputSet('include')));
     }
 
     /**
@@ -109,10 +106,9 @@ public function storeAction($request)
     public function showAction($request, $record)
     {
         $record = $this->findModelInstance($record);
-        $params = $this->getRequestParameters($request);
-        $this->validateIncludableRelations($params['include']);
+        $this->validateIncludableRelations($request->inputSet('include'));
 
-        return new JsonApiResponse(new ResourceSerializer($record, $params['fields'], $params['include']));
+        return new JsonApiResponse(new ResourceSerializer($record, $request->inputSet('fields'), $request->inputSet('include')));
     }
 
     /**
@@ -129,8 +125,8 @@ public function updateAction($request, $record)
         $record->fill((array) $request->input('data.attributes'));
         $record->save();
 
-        if ($relationships = $request->input('data.relationships')) {
-            $this->updateResourceRelationships($record, (array) $relationships);
+        if ($request->has('data.relationships')) {
+            $this->updateResourceRelationships($record, (array) $request->input('data.relationships'));
         }
 
         return new JsonApiResponse(new ResourceSerializer($record));
@@ -220,66 +216,16 @@ protected function findModelInstance($record)
         return $this->model->findOrFail($record);
     }
 
-    /**
-     * Return any JSON API resource parameters from a request.
-     *
-     * @param Request $request
-     *
-     * @return array
-     */
-    protected function getRequestParameters($request)
-    {
-        return [
-            'fields' => $this->getRequestQuerySet($request, 'fields', '/^([A-Za-z]+.?)+[A-Za-z]+$/'),
-            'include' => $this->getRequestQuerySet($request, 'include', '/^([A-Za-z]+.?)+[A-Za-z]+$/'),
-            'sort' => $this->getRequestQuerySet($request, 'sort', '/[A-Za-z_]+/'),
-            'filter' => (array) $request->input('filter'),
-        ];
-    }
-
-    /**
-     * Return any comma separated values in a request query field as an array.
-     *
-     * @param Request     $request
-     * @param string      $key
-     * @param string|null $validate Regular expression to test for each item
-     *
-     * @throws \Illuminate\Validation\ValidationException
-     *
-     * @return array
-     */
-    protected function getRequestQuerySet($request, $key, $validate = null)
-    {
-        $values = preg_split('/,/', $request->input($key), null, PREG_SPLIT_NO_EMPTY);
-
-        $validator = Validator::make(['param' => $values], [
-            'param.*' => 'required' . ($validate ? '|regex:' . $validate : ''),
-        ]);
-
-        if ($validator->fails()) {
-            throw new ValidationException($validator, $this->error(
-                Response::HTTP_BAD_REQUEST,
-                sprintf('Invalid values for "%s" parameter', $key))
-            );
-        }
-
-        return $values;
-    }
-
     /**
      * Validate the requested included relationships against those that are
      * allowed on the requested resource type.
      *
-     * @param array|null $relations
+     * @param array $relations
      *
      * @throws InvalidRelationPathException
      */
-    protected function validateIncludableRelations($relations)
+    protected function validateIncludableRelations(array $relations)
     {
-        if (is_null($relations)) {
-            return;
-        }
-
         foreach ($relations as $relation) {
             if (!$this->model instanceof IncludesRelatedResources || !in_array($relation, $this->model->getIncludableRelations())) {
                 throw new InvalidRelationPathException($relation);

src/Http/Requests/JsonApiRequest.php

@@ -101,4 +101,14 @@ public function response(array $errors)
     {
         return new JsonApiResponse($errors, Response::HTTP_UNPROCESSABLE_ENTITY);
     }
+
+    /**
+     * Return an input field containing comma separated values as an array.
+     *
+     * @param string $key
+     */
+    public function inputSet(string $key): array
+    {
+        return preg_split('/,/', $this->input($key), null, PREG_SPLIT_NO_EMPTY);
+    }
 }