[Feature] Move default 406 and 415 messages to exception classes

Author: lindyhopchris

Diff for: CHANGELOG.md

@@ -10,6 +10,10 @@ All notable changes to this project will be documented in this file. This projec
 - The `JsonApiException` class now has a `context()` method. Laravel's exception handler uses this to add log context
   when the exception is logged. This means logging of JSON:API exceptions will now include the HTTP status code and the
   JSON:API errors.
+- Moved the default `406 Not Acceptable` and `415 Unsupported Media Type` messages to the following two new exception
+  classes:
+    - `Exceptions\HttpNotAcceptableException`
+    - `Exceptions\HttpUnsupportedMediaTypeException`
 
 ### Fixed
 

Diff for: src/Exceptions/HttpNotAcceptableException.php

@@ -0,0 +1,49 @@
+<?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 LaravelJsonApi\Laravel\Exceptions;
+
+use Illuminate\Http\Response;
+use Symfony\Component\HttpKernel\Exception\HttpException;
+use Throwable;
+
+class HttpNotAcceptableException extends HttpException
+{
+    /**
+     * HttpNotAcceptableException constructor.
+     *
+     * @param string|null $message
+     * @param Throwable|null $previous
+     * @param array $headers
+     * @param int $code
+     */
+    public function __construct(
+        string $message = null,
+        Throwable $previous = null,
+        array $headers = [],
+        int $code = 0
+    ) {
+        if (null === $message) {
+            $message = __("The requested resource is capable of generating only content not acceptable "
+                . "according to the Accept headers sent in the request.");
+        }
+
+        parent::__construct(Response::HTTP_NOT_ACCEPTABLE, $message, $previous, $headers, $code);
+    }
+}

Diff for: src/Exceptions/HttpUnsupportedMediaTypeException.php

@@ -0,0 +1,44 @@
+<?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 LaravelJsonApi\Laravel\Exceptions;
+
+use Illuminate\Http\Response;
+use Symfony\Component\HttpKernel\Exception\HttpException;
+use Throwable;
+
+class HttpUnsupportedMediaTypeException extends HttpException
+{
+    /**
+     * HttpUnsupportedMediaTypeException constructor.
+     *
+     * @param string|null $message
+     * @param Throwable|null $previous
+     * @param array $headers
+     * @param int $code
+     */
+    public function __construct(string $message = null, Throwable $previous = null, array $headers = [], int $code = 0)
+    {
+        if (null === $message) {
+            $message = __('The request entity has a media type which the server or resource does not support.');
+        }
+
+        parent::__construct(Response::HTTP_UNSUPPORTED_MEDIA_TYPE, $message, $previous, $headers, $code);
+    }
+}

Diff for: src/Http/Requests/ResourceQuery.php

@@ -21,16 +21,15 @@
 
 use Illuminate\Contracts\Validation\Validator;
 use Illuminate\Database\Eloquent\Model;
-use Illuminate\Http\Response;
 use LaravelJsonApi\Contracts\Auth\Authorizer;
 use LaravelJsonApi\Contracts\Query\QueryParameters;
 use LaravelJsonApi\Core\Exceptions\JsonApiException;
 use LaravelJsonApi\Core\Query\FieldSets;
 use LaravelJsonApi\Core\Query\FilterParameters;
 use LaravelJsonApi\Core\Query\IncludePaths;
 use LaravelJsonApi\Core\Query\SortFields;
+use LaravelJsonApi\Laravel\Exceptions\HttpNotAcceptableException;
 use LogicException;
-use Symfony\Component\HttpKernel\Exception\HttpException;
 use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface;
 use function array_key_exists;
 
@@ -336,10 +335,6 @@ protected function mediaTypes(): array
      */
     protected function notAcceptable(): HttpExceptionInterface
     {
-        return new HttpException(
-            Response::HTTP_NOT_ACCEPTABLE,
-            __("The requested resource is capable of generating only content not acceptable "
-            . "according to the Accept headers sent in the request.")
-        );
+        return new HttpNotAcceptableException();
     }
 }

Diff for: src/Http/Requests/ResourceRequest.php

@@ -22,7 +22,6 @@
 use Illuminate\Contracts\Validation\Factory as ValidationFactory;
 use Illuminate\Contracts\Validation\Validator;
 use Illuminate\Database\Eloquent\Model;
-use Illuminate\Http\Response;
 use Illuminate\Support\Collection;
 use LaravelJsonApi\Contracts\Auth\Authorizer;
 use LaravelJsonApi\Contracts\Schema\Relation;
@@ -31,10 +30,10 @@
 use LaravelJsonApi\Core\Query\IncludePaths;
 use LaravelJsonApi\Core\Store\LazyRelation;
 use LaravelJsonApi\Core\Support\Str;
+use LaravelJsonApi\Laravel\Exceptions\HttpUnsupportedMediaTypeException;
 use LaravelJsonApi\Spec\RelationBuilder;
 use LaravelJsonApi\Spec\ResourceBuilder;
 use LogicException;
-use Symfony\Component\HttpKernel\Exception\HttpException;
 use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface;
 use function array_key_exists;
 
@@ -349,10 +348,7 @@ protected function isSupportedMediaType(): bool
      */
     protected function unsupportedMediaType(): HttpExceptionInterface
     {
-        return new HttpException(
-            Response::HTTP_UNSUPPORTED_MEDIA_TYPE,
-            __('The request entity has a media type which the server or resource does not support.')
-        );
+        return new HttpUnsupportedMediaTypeException();
     }
 
     /**