Wire specification validation for create and update requests

Author: lindyhopchris

src/Contracts/Routing/Route.php

@@ -1,5 +1,5 @@
 <?php
-/*
+/**
  * Copyright 2020 Cloud Creativity Limited
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -37,6 +37,13 @@ public function resourceType(): string;
      */
     public function modelOrResourceId();
 
+    /**
+     * Get the resource id.
+     *
+     * @return string
+     */
+    public function resourceId(): string;
+
     /**
      * Get the schema for the current route.
      *

src/Contracts/Schema/Container.php

@@ -30,6 +30,13 @@ interface Container
      */
     public function schemaFor(string $resourceType): Schema;
 
+    /**
+     * Get a list of all the supported resource types.
+     *
+     * @return array
+     */
+    public function types(): array;
+
     /**
      * Get a list of model classes mapped to their resource classes.
      *

src/Core/Document/Error.php

@@ -222,12 +222,16 @@ public function code(): ?string
     /**
      * Add an application-specific error code.
      *
-     * @param string|null $code
+     * @param string|int|null $code
      * @return $this
      */
-    public function setCode(?string $code): self
+    public function setCode($code): self
     {
-        $this->code = $code ?: null;
+        if (!is_int($code) && !is_string($code) && !is_null($code)) {
+            throw new InvalidArgumentException('Expecting an integer, string or null.');
+        }
+
+        $this->code = !is_null($code) ? strval($code) : null;
 
         return $this;
     }

src/Core/Document/ErrorList.php

@@ -20,13 +20,15 @@
 namespace LaravelJsonApi\Core\Document;
 
 use Countable;
+use Illuminate\Contracts\Support\Responsable;
+use Illuminate\Http\Response;
 use IteratorAggregate;
 use LaravelJsonApi\Contracts\Serializable;
 use LogicException;
 use function array_merge;
 use function collect;
 
-class ErrorList implements Serializable, Countable, IteratorAggregate
+class ErrorList implements Serializable, Countable, IteratorAggregate, Responsable
 {
 
     use Concerns\Serializable;
@@ -91,6 +93,33 @@ public function __clone()
         $this->stack = array_map(fn($error) => clone $error, $this->stack);
     }
 
+    /**
+     * Get the most applicable HTTP status code.
+     *
+     * When a server encounters multiple problems for a single request, the most generally applicable HTTP error
+     * code SHOULD be used in the response. For instance, 400 Bad Request might be appropriate for multiple
+     * 4xx errors or 500 Internal Server Error might be appropriate for multiple 5xx errors.
+     *
+     * @param int the default status to return, if there are no statuses.
+     * @return int
+     * @see https://jsonapi.org/format/#errors
+     */
+    public function status(int $default = Response::HTTP_INTERNAL_SERVER_ERROR): int
+    {
+        $statuses = collect($this->stack)
+            ->map(fn(Error $error) => intval($error->status()))
+            ->filter()
+            ->unique();
+
+        if (2 > count($statuses)) {
+            return $statuses->first() ?: $default;
+        }
+
+        $only4xx = $statuses->every(fn(int $status) => 400 <= $status && 499 >= $status);
+
+        return $only4xx ? Response::HTTP_BAD_REQUEST : Response::HTTP_INTERNAL_SERVER_ERROR;
+    }
+
     /**
      * Add errors.
      *
@@ -170,4 +199,24 @@ public function jsonSerialize()
         return $this->stack;
     }
 
+    /**
+     * @param $request
+     * @return ErrorResponse
+     */
+    public function prepareResponse($request): ErrorResponse
+    {
+        return new ErrorResponse($this);
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function toResponse($request)
+    {
+        return $this
+            ->prepareResponse($request)
+            ->toResponse($request);
+    }
+
+
 }

src/Core/Document/ErrorResponse.php

@@ -0,0 +1,134 @@
+<?php
+/**
+ * Copyright 2020 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\Core\Document;
+
+use Illuminate\Contracts\Support\Responsable;
+use LaravelJsonApi\Contracts\Serializable;
+
+class ErrorResponse implements Serializable, Responsable
+{
+
+    use Concerns\Serializable;
+
+    /**
+     * @var ErrorList
+     */
+    private ErrorList $errors;
+
+    /**
+     * @var int|null
+     */
+    private ?int $status = null;
+
+    /**
+     * @var array
+     */
+    private array $headers = [];
+
+    /**
+     * @var int
+     */
+    private int $encodeOptions = 0;
+
+    /**
+     * ErrorResponse constructor.
+     *
+     * @param ErrorList|Error|Error[] $errors
+     */
+    public function __construct($errors)
+    {
+        $this->errors = ErrorList::cast($errors);
+    }
+
+    /**
+     * Set JSON encode options.
+     *
+     * @param int $options
+     * @return $this
+     */
+    public function withEncodeOptions(int $options): self
+    {
+        $this->encodeOptions = $options;
+
+        return $this;
+    }
+
+    /**
+     * Set response headers.
+     *
+     * @param array $headers
+     * @return $this
+     */
+    public function withHeaders(array $headers): self
+    {
+        $this->headers = $headers;
+
+        return $this;
+    }
+
+    /**
+     * Set the response status.
+     *
+     * This overrides the default status, which is derived from
+     * the error list.
+     *
+     * @param int $status
+     * @return $this
+     */
+    public function withStatus(int $status): self
+    {
+        $this->status = $status;
+
+        return $this;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function toResponse($request)
+    {
+        return response(
+            $this->toJson($this->encodeOptions),
+            $this->status ?: $this->errors->status(),
+            $this->headers
+        );
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function toArray()
+    {
+        return [
+            'errors' => $this->errors->toArray(),
+        ];
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function jsonSerialize()
+    {
+        return [
+            'errors' => $this->errors,
+        ];
+    }
+
+}

src/Core/Schema/Container.php

@@ -84,6 +84,14 @@ public function schemaFor(string $resourceType): Schema
         throw new LogicException("No schema for JSON API resource type {$resourceType}.");
     }
 
+    /**
+     * @inheritDoc
+     */
+    public function types(): array
+    {
+        return array_keys($this->types);
+    }
+
     /**
      * @inheritDoc
      */

src/Eloquent/Repository.php

@@ -85,6 +85,8 @@ public function find(string $resourceId)
      */
     public function exists(string $resourceId): bool
     {
+        // @TODO check the resource id against a regex querying the database.
+
         return $this
             ->query()
             ->whereResourceId($resourceId)