[Feature-WIP] Fix bugs from previous commit

Identified these bugs when testing out the changes in the demo
Laravel JSON API application.

At the same time, simplified the paginator classes so they are
directly injected with the encoding parameters. This is now
possible because the encoding parameters for the current request
are registered directly in the service container.

Author: lindyhopchris

src/Http/Middleware/BootJsonApi.php

@@ -85,7 +85,7 @@ public function handle($request, Closure $next, $namespace)
         $serverRequest = $this->container->make(ServerRequestInterface::class);
 
         /** Parse headers */
-        $initiator->doContentNegotiation($api->getCodecMatcher(), $serverRequest);
+        $initiator->doContentNegotiation($api, $serverRequest);
 
         /** Set the encoding parameters into the container */
         $parameters = $initiator->parseParameters($serverRequest);

src/Http/Middleware/CreateRequest.php

@@ -112,7 +112,7 @@ private function record($resourceType, $resourceId)
     {
         /** @var StoreInterface $store */
         $store = $this->container->make(StoreInterface::class);
-        $identifier = new ResourceIdentifier($resourceType, $resourceId);
+        $identifier = ResourceIdentifier::create($resourceType, $resourceId);
 
         return $store->find($identifier);
     }

src/Http/Requests/AbstractRequest.php renamed to src/Http/Requests/AbstractRequestHandler.php

@@ -20,6 +20,7 @@
 
 use CloudCreativity\JsonApi\Contracts\Authorizer\AuthorizerInterface;
 use CloudCreativity\JsonApi\Contracts\Http\RequestInterpreterInterface;
+use CloudCreativity\JsonApi\Contracts\Validators\FilterValidatorInterface;
 use CloudCreativity\JsonApi\Contracts\Validators\ValidatorProviderInterface;
 use CloudCreativity\LaravelJsonApi\Contracts\Http\Requests\RequestHandlerInterface;
 use CloudCreativity\LaravelJsonApi\Contracts\Pagination\PageParameterHandlerInterface;
@@ -30,7 +31,7 @@
  * Class Request
  * @package CloudCreativity\LaravelJsonApi
  */
-abstract class AbstractRequest implements RequestHandlerInterface
+abstract class AbstractRequestHandler implements RequestHandlerInterface
 {
 
     use ChecksUrlParameters,
@@ -99,13 +100,13 @@ abstract class AbstractRequest implements RequestHandlerInterface
 
     /**
      * AbstractRequest constructor.
-     * @param ValidatorProviderInterface $validators
      * @param AuthorizerInterface|null $authorizer
+     * @param ValidatorProviderInterface|null $validators
      * @param HttpFactoryInterface|null $factory
      */
     public function __construct(
-        ValidatorProviderInterface $validators,
-        AuthorizerInterface $authorizer,
+        AuthorizerInterface $authorizer = null,
+        ValidatorProviderInterface $validators = null,
         HttpFactoryInterface $factory = null
     ) {
         $this->validators = $validators;
@@ -118,8 +119,6 @@ public function __construct(
      */
     public function handle(RequestInterpreterInterface $interpreter, JsonApiRequest $request)
     {
-        $resourceType = $this->getResourceType();
-
         /** Check that a resource id has resolved to a record */
         $this->checkResourceId($interpreter, $request);
 
@@ -129,15 +128,17 @@ public function handle(RequestInterpreterInterface $interpreter, JsonApiRequest
         }
 
         /** Check request parameters are acceptable */
-        $filterValidator = $interpreter->isIndex() ?
-            $this->validators->filterResources($resourceType) : null;
-        $this->checkQueryParameters($this->factory, $request, $filterValidator);
+        $this->checkQueryParameters($this->factory, $request, $this->filterValidator());
 
         /** Authorize the request */
-        $this->authorize($interpreter, $this->authorizer, $request);
+        if ($this->authorizer) {
+            $this->authorize($interpreter, $this->authorizer, $request);
+        }
 
         /** Check the document content is acceptable */
-        $this->checkDocumentIsAcceptable($this->validators, $interpreter, $request);
+        if ($this->validators) {
+            $this->checkDocumentIsAcceptable($this->validators, $interpreter, $request);
+        }
     }
 
     /**
@@ -199,4 +200,11 @@ protected function allowedPagingParameters()
         return $param->getAllowedPagingParameters();
     }
 
+    /**
+     * @return FilterValidatorInterface|null
+     */
+    private function filterValidator()
+    {
+        return $this->validators ? $this->validators->filterResources($this->getResourceType()) : null;
+    }
 }

src/Pagination/PageParameterHandler.php

@@ -19,8 +19,8 @@
 namespace CloudCreativity\LaravelJsonApi\Pagination;
 
 use CloudCreativity\LaravelJsonApi\Contracts\Pagination\PageParameterHandlerInterface;
-use CloudCreativity\LaravelJsonApi\Services\JsonApiService;
 use Illuminate\Support\Arr;
+use Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
 
 /**
  * Class PageParameterHandler
@@ -29,10 +29,7 @@
 class PageParameterHandler implements PageParameterHandlerInterface
 {
 
-    /**
-     * @var JsonApiService
-     */
-    private $service;
+    private $parameters;
 
     /**
      * @var PaginatorConfiguration
@@ -41,12 +38,12 @@ class PageParameterHandler implements PageParameterHandlerInterface
 
     /**
      * PageParameter constructor.
-     * @param JsonApiService $service
+     * @param EncodingParametersInterface $parameters
      * @param PaginatorConfiguration $config
      */
-    public function __construct(JsonApiService $service, PaginatorConfiguration $config)
+    public function __construct(EncodingParametersInterface $parameters, PaginatorConfiguration $config)
     {
-        $this->service = $service;
+        $this->parameters = $parameters;
         $this->config = $config;
     }
 
@@ -124,9 +121,7 @@ public function getAllowedPagingParameters()
     protected function getParams()
     {
         return (array) $this
-            ->service
-            ->getRequest()
-            ->getEncodingParameters()
+            ->parameters
             ->getPaginationParameters();
     }
 

src/Pagination/Paginator.php

@@ -20,10 +20,10 @@
 
 use CloudCreativity\LaravelJsonApi\Contracts\Document\LinkFactoryInterface;
 use CloudCreativity\LaravelJsonApi\Contracts\Pagination\PaginatorInterface;
-use CloudCreativity\LaravelJsonApi\Services\JsonApiService;
 use Illuminate\Contracts\Pagination\LengthAwarePaginator;
 use Illuminate\Contracts\Pagination\Paginator as IlluminatePaginator;
 use Neomerx\JsonApi\Contracts\Document\LinkInterface;
+use Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
 use Neomerx\JsonApi\Contracts\Encoder\Parameters\SortParameterInterface;
 use Neomerx\JsonApi\Contracts\Http\Query\QueryParametersParserInterface;
 
@@ -35,9 +35,9 @@ class Paginator implements PaginatorInterface
 {
 
     /**
-     * @var JsonApiService
+     * @var EncodingParametersInterface
      */
-    private $service;
+    private $parameters;
 
     /**
      * @var LinkFactoryInterface
@@ -51,16 +51,16 @@ class Paginator implements PaginatorInterface
 
     /**
      * Paginator constructor.
-     * @param JsonApiService $service
+     * @param EncodingParametersInterface $parameters
      * @param LinkFactoryInterface $links
      * @param PaginatorConfiguration $config
      */
     public function __construct(
-        JsonApiService $service,
+        EncodingParametersInterface $parameters,
         LinkFactoryInterface $links,
         PaginatorConfiguration $config
     ) {
-        $this->service = $service;
+        $this->parameters = $parameters;
         $this->links = $links;
         $this->config = $config;
     }
@@ -137,16 +137,11 @@ public function addLinks(IlluminatePaginator $results, array $links = [])
      */
     protected function buildParams()
     {
-        $encodingParameters = $this
-            ->service
-            ->getRequest()
-            ->getEncodingParameters();
-
         return array_filter([
             QueryParametersParserInterface::PARAM_FILTER =>
-                $encodingParameters->getFilteringParameters(),
+                $this->parameters->getFilteringParameters(),
             QueryParametersParserInterface::PARAM_SORT =>
-                $this->buildSortParams((array) $encodingParameters->getSortParameters())
+                $this->buildSortParams((array) $this->parameters->getSortParameters())
         ]);
     }
 

src/ServiceProvider.php

@@ -27,6 +27,7 @@
 use CloudCreativity\JsonApi\Contracts\Store\StoreInterface;
 use CloudCreativity\JsonApi\Contracts\Utils\ConfigurableInterface;
 use CloudCreativity\JsonApi\Contracts\Utils\ReplacerInterface;
+use CloudCreativity\JsonApi\Contracts\Validators\ValidatorFactoryInterface as BaseValidatorFactoryInterface;
 use CloudCreativity\JsonApi\Http\ApiFactory;
 use CloudCreativity\JsonApi\Repositories\CodecMatcherRepository;
 use CloudCreativity\JsonApi\Repositories\ErrorRepository;
@@ -232,6 +233,7 @@ protected function bindResponses()
     protected function bindValidatorFactory()
     {
         $this->app->singleton(ValidatorFactoryInterface::class, ValidatorFactory::class);
+        $this->app->alias(ValidatorFactoryInterface::class, BaseValidatorFactoryInterface::class);
     }
 
     /**

src/Validators/AbstractValidatorProvider.php

@@ -144,7 +144,7 @@ public function updateResource($resourceType, $resourceId, $record)
     public function modifyRelationship($resourceType, $resourceId, $relationshipName, $record)
     {
         $validator = $this
-            ->resourceRelationships($resourceType, $resourceId, $record)
+            ->resourceRelationships($resourceType, $record)
             ->get($relationshipName);
 
         return $this->factory->relationshipDocument($validator);
@@ -195,7 +195,7 @@ protected function extractAttributes(ResourceInterface $resource, $resourceType,
 
     /**
      * @param string $resourceType
-     * @param string|int|null $resourceId
+     * @param string|null $resourceId
      * @param object|null $record
      * @return ResourceValidatorInterface
      */
@@ -258,13 +258,11 @@ protected function attributeCustomAttributes($resourceType, $record = null)
      *
      * @param string $resourceType
      *      the resource type being validated.
-     * @param string $resourceId
-     *      the resource id that is being validated.
      * @param object|null $record
      *      the record being updated, or null if it is a create request.
      * @return RelationshipsValidatorInterface
      */
-    protected function resourceRelationships($resourceType, $resourceId, $record = null)
+    protected function resourceRelationships($resourceType, $record = null)
     {
         $validator = $this->factory->relationships();
         $this->relationshipRules($validator, $resourceType, $record);