[Refactor] Update responses and header parsing

Author: lindyhopchris

src/Codec/Codec.php

@@ -100,10 +100,17 @@ public function getEncoder(): EncoderInterface
             throw new \RuntimeException('Codec does not support encoding JSON API content.');
         }
 
-        return $this->factory->createEncoder(
-            $this->container,
-            $this->encoding->getOptions()
-        );
+        $encoder = $this->factory->createEncoder($this->container);
+        $options = $this->encoding->getOptions();
+
+        if ($options) {
+            $encoder
+                ->withEncodeOptions($options->getOptions())
+                ->withEncodeDepth($options->getDepth())
+                ->withUrlPrefix($options->getUrlPrefix() ?? '');
+        }
+
+        return $encoder;
     }
 
     /**

src/Codec/EncodingList.php

@@ -17,7 +17,7 @@
 
 namespace CloudCreativity\LaravelJsonApi\Codec;
 
-use Neomerx\JsonApi\Contracts\Http\Headers\AcceptHeaderInterface;
+use CloudCreativity\LaravelJsonApi\Contracts\Http\Headers\AcceptHeaderInterface;
 use Neomerx\JsonApi\Contracts\Http\Headers\MediaTypeInterface;
 use Neomerx\JsonApi\Http\Headers\MediaType;
 

src/Contracts/Http/Headers/HeaderParametersInterface.php

@@ -0,0 +1,37 @@
+<?php
+/*
+ * Copyright 2022 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.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+declare(strict_types=1);
+
+namespace CloudCreativity\LaravelJsonApi\Contracts\Http\Headers;
+
+interface HeaderParametersInterface
+{
+    /**
+     * Get get 'Content-Type' header if request has body and `null` otherwise.
+     *
+     * @return HeaderInterface|null
+     */
+    public function getContentTypeHeader(): ?HeaderInterface;
+
+    /**
+     * Get 'Accept' header.
+     *
+     * @return AcceptHeaderInterface
+     */
+    public function getAcceptHeader(): ?AcceptHeaderInterface;
+}

src/Contracts/Http/Headers/HeaderParametersParserInterface.php

@@ -0,0 +1,34 @@
+<?php
+/*
+ * Copyright 2022 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.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+declare(strict_types=1);
+
+namespace CloudCreativity\LaravelJsonApi\Contracts\Http\Headers;
+
+use Psr\Http\Message\ServerRequestInterface;
+
+interface HeaderParametersParserInterface
+{
+    /**
+     * Parse input parameters from request.
+     *
+     * @param ServerRequestInterface $request
+     * @param bool $checkContentType
+     * @return HeaderParametersInterface
+     */
+    public function parse(ServerRequestInterface $request, bool $checkContentType = true): HeaderParametersInterface;
+}

src/Http/Headers/HeaderParameters.php

@@ -0,0 +1,50 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CloudCreativity\LaravelJsonApi\Http\Headers;
+
+use CloudCreativity\LaravelJsonApi\Contracts\Http\Headers\AcceptHeaderInterface;
+use CloudCreativity\LaravelJsonApi\Contracts\Http\Headers\HeaderInterface;
+use CloudCreativity\LaravelJsonApi\Contracts\Http\Headers\HeaderParametersInterface;
+
+class HeaderParameters implements HeaderParametersInterface
+{
+    /**
+     * @var AcceptHeaderInterface
+     */
+    private AcceptHeaderInterface $accept;
+
+    /**
+     * @var HeaderInterface|null
+     */
+    private ?HeaderInterface $contentType;
+
+    /**
+     * HeaderParameters constructor.
+     *
+     * @param AcceptHeaderInterface $accept
+     * @param HeaderInterface|null $contentType
+     */
+    public function __construct(AcceptHeaderInterface $accept, HeaderInterface $contentType = null)
+    {
+        $this->accept = $accept;
+        $this->contentType = $contentType;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getAcceptHeader(): AcceptHeaderInterface
+    {
+        return $this->accept;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getContentTypeHeader(): ?HeaderInterface
+    {
+        return $this->contentType;
+    }
+}

src/Http/Headers/HeaderParametersParser.php

@@ -0,0 +1,95 @@
+<?php
+/*
+ * Copyright 2022 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.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+declare(strict_types=1);
+
+namespace CloudCreativity\LaravelJsonApi\Http\Headers;
+
+use CloudCreativity\LaravelJsonApi\Contracts\Http\Headers\HeaderInterface;
+use CloudCreativity\LaravelJsonApi\Contracts\Http\Headers\HeaderParametersInterface;
+use CloudCreativity\LaravelJsonApi\Contracts\Http\Headers\HeaderParametersParserInterface;
+use Neomerx\JsonApi\Contracts\Http\Headers\HeaderParametersParserInterface as NeomerxHeaderParametersParser;
+use Neomerx\JsonApi\Contracts\Http\Headers\MediaTypeInterface;
+use Psr\Http\Message\ServerRequestInterface;
+use Traversable;
+
+class HeaderParametersParser implements HeaderParametersParserInterface
+{
+    /**
+     * @var NeomerxHeaderParametersParser
+     */
+    private NeomerxHeaderParametersParser $parser;
+
+    /**
+     * HeaderParametersParser constructor.
+     *
+     * @param NeomerxHeaderParametersParser $parser
+     */
+    public function __construct(NeomerxHeaderParametersParser $parser)
+    {
+        $this->parser = $parser;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function parse(ServerRequestInterface $request, bool $checkContentType = true): HeaderParametersInterface
+    {
+        $contentType = null;
+
+        if ($checkContentType === true) {
+            $contentMediaType = $this->parser->parseContentTypeHeader(
+                $this->getHeader($request, HeaderInterface::HEADER_CONTENT_TYPE)
+            );
+            $contentType = new Header(
+                HeaderInterface::HEADER_CONTENT_TYPE,
+                [$contentMediaType]
+            );
+        }
+
+        $acceptMediaTypes = $this->parser->parseAcceptHeader(
+            $this->getHeader($request, HeaderInterface::HEADER_ACCEPT)
+        );
+
+        if ($acceptMediaTypes instanceof Traversable) {
+            $acceptMediaTypes = iterator_to_array($acceptMediaTypes);
+        }
+
+        return new HeaderParameters(
+            new AcceptHeader($acceptMediaTypes),
+            $contentType,
+        );
+    }
+
+    /**
+     * @param ServerRequestInterface $request
+     * @param string $name
+     * @return string
+     */
+    private function getHeader(ServerRequestInterface $request, string $name): string
+    {
+        $value = $request->getHeader($name);
+        if (empty($value) === false) {
+            $value = $value[0];
+            if (empty($value) === false) {
+                return $value;
+            }
+        }
+
+        return MediaTypeInterface::JSON_API_MEDIA_TYPE;
+    }
+}

src/Http/Middleware/BootJsonApi.php

@@ -15,17 +15,19 @@
  * limitations under the License.
  */
 
+declare(strict_types=1);
+
 namespace CloudCreativity\LaravelJsonApi\Http\Middleware;
 
 use Closure;
 use CloudCreativity\LaravelJsonApi\Api\Api;
 use CloudCreativity\LaravelJsonApi\Api\Repository;
+use CloudCreativity\LaravelJsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
 use CloudCreativity\LaravelJsonApi\Exceptions\ResourceNotFoundException;
 use CloudCreativity\LaravelJsonApi\Routing\Route;
 use Illuminate\Contracts\Container\Container;
 use Illuminate\Http\Request;
 use Illuminate\Pagination\AbstractPaginator;
-use Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
 
 /**
  * Class BootJsonApi
@@ -38,7 +40,7 @@ class BootJsonApi
     /**
      * @var Container
      */
-    private $container;
+    private Container $container;
 
     /**
      * @param Container $container