🍺 initial commit

Author: badams

.gitignore

@@ -0,0 +1,4 @@
+vendor/
+coverage/
+composer.lock
+.phpunit.result.cache

LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2020 Webtools Ltd
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

composer.json

@@ -0,0 +1,47 @@
+{
+    "name": "webtools/laravel-json-schema-request",
+    "version": "1.0.0",
+    "description": "Like FormRequests, but for validating against a json-schema",
+    "keywords": [
+        "webtools",
+        "json-schema",
+        "laravel",
+        "FormRequest",
+        "validation"
+    ],
+    "homepage": "https://github.com/webtoolsnz/laravel-json-schema-request",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Byron Adams",
+            "email": "[email protected]",
+            "homepage": "https://webtools.nz",
+            "role": "Developer"
+        }
+    ],
+    "require-dev": {
+        "orchestra/testbench": "^5.3",
+        "phpunit/phpunit": "^9.2"
+    },
+    "require": {
+        "justinrainbow/json-schema": "^5.2",
+        "php": "^7.4",
+        "illuminate/support": "^7.0"
+    },
+    "config": {
+        "sort-packages": true
+    },
+    "autoload": {
+        "psr-4": {
+            "Webtools\\JsonSchemaRequest\\": "src/",
+            "Webtools\\JsonSchemaRequest\\Tests\\": "tests/"
+        }
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "Webtools\\JsonSchemaRequest\\ServiceProvider"
+            ]
+        }
+    }
+}

phpunit.xml

@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.2/phpunit.xsd"
+         bootstrap="vendor/autoload.php"
+         executionOrder="depends,defects"
+         beStrictAboutCoversAnnotation="true"
+         beStrictAboutOutputDuringTests="true"
+         beStrictAboutTodoAnnotatedTests="true"
+         verbose="true">
+    <testsuites>
+        <testsuite name="default">
+            <directory suffix="Test.php">tests</directory>
+        </testsuite>
+    </testsuites>
+
+    <filter>
+        <whitelist processUncoveredFilesFromWhitelist="true">
+            <directory suffix=".php">src</directory>
+        </whitelist>
+    </filter>
+</phpunit>

src/JsonSchemaRequest.php

@@ -0,0 +1,53 @@
+<?php
+
+namespace Webtools\JsonSchemaRequest;
+
+use Illuminate\Contracts\Container\Container;
+use Illuminate\Contracts\Validation\ValidatesWhenResolved;
+use Illuminate\Contracts\Validation\Validator as ValidatorContract;
+use Illuminate\Http\Exceptions\HttpResponseException;
+use Illuminate\Http\Request;
+use Illuminate\Http\Response;
+use Illuminate\Validation\ValidatesWhenResolvedTrait;
+
+class JsonSchemaRequest extends Request implements ValidatesWhenResolved
+{
+    use ValidatesWhenResolvedTrait;
+
+    protected Container $container;
+
+    protected ?ValidatorContract $validator = null;
+
+    public function getValidatorInstance()
+    {
+        if (!$this->validator) {
+            $this->validator = new JsonSchemaValidator(
+                $this->container->make(\JsonSchema\Validator::class),
+                $this->container->call([$this, 'schema']),
+                $this->json()->all(),
+            );
+        }
+
+        return $this->validator;
+    }
+
+    public function setContainer(Container $container)
+    {
+        $this->container = $container;
+
+        return $this;
+    }
+
+    public function failedValidation(JsonSchemaValidator $validator)
+    {
+        throw new HttpResponseException(response()->json(
+            ['errors' => $validator->errors()],
+            Response::HTTP_UNPROCESSABLE_ENTITY
+        ));
+    }
+
+    public function validated()
+    {
+        return $this->validator->validated();
+    }
+}

src/JsonSchemaValidator.php

@@ -0,0 +1,136 @@
+<?php
+
+namespace Webtools\JsonSchemaRequest;
+
+use Illuminate\Contracts\Validation\Validator as ValidatorContract;
+use Illuminate\Support\MessageBag;
+use JsonSchema\Validator as SchemaValidator;
+use JsonSchema\Constraints\Constraint;
+use Illuminate\Validation\ValidationException;
+
+class JsonSchemaValidator implements ValidatorContract
+{
+    protected SchemaValidator $validator;
+    protected array $schema;
+    protected array $data;
+    protected ?MessageBag $failedConstraints = null;
+    protected ?MessageBag $messages = null;
+
+    /**
+     * Array of callbacks to be executed after validation
+     *
+     * @var \Closure[]
+     */
+    private array $after = [];
+
+    public function __construct(SchemaValidator $validator, array $schema, array $data)
+    {
+        $this->validator = $validator;
+        $this->schema = $schema;
+        $this->data = $data;
+    }
+
+    public function passes(): bool
+    {
+        $this->messages = new MessageBag();
+        $this->failedConstraints = new MessageBag();
+
+        $this->validator->validate($this->data, $this->schema, Constraint::CHECK_MODE_TYPE_CAST);
+
+        foreach ($this->validator->getErrors(SchemaValidator::ERROR_DOCUMENT_VALIDATION) as $error) {
+            $this->messages->add($error['property'], $error['message']);
+            $this->failedConstraints->add($error['property'], $error['constraint']);
+        }
+
+        foreach ($this->after as $after) {
+            $after();
+        }
+
+        return $this->messages->isEmpty();
+    }
+
+    public function getMessageBag()
+    {
+        return $this->messages;
+    }
+
+    /**
+     * @inheritDoc
+     * @throws ValidationException
+     */
+    public function validate()
+    {
+        if ($this->fails()) {
+            $this->signalFailure();
+        }
+
+        return $this->validated();
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function validated()
+    {
+        if (!$this->messages) {
+            $this->passes();
+        }
+
+        if ($this->messages->isNotEmpty()) {
+            $this->signalFailure();
+        }
+
+        return $this->data;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function fails()
+    {
+        return !$this->passes();
+    }
+
+    /**
+     * Returns a list of the failed constraints for each property
+     * @return array
+     */
+    public function failed()
+    {
+        return $this->failedConstraints->messages();
+    }
+
+    /**
+     * This is a NO-OP, was only added to support the ValidatorContract,
+     * Rules cannot be applied to a schema in this manner.
+     */
+    public function sometimes($attribute, $rules, callable $callback)
+    {
+        return $this;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function after($callback)
+    {
+        $this->after[] = function () use ($callback) {
+            return call_user_func_array($callback, [$this]);
+        };
+
+        return $this;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function errors()
+    {
+        return $this->getMessageBag();
+    }
+
+    private function signalFailure()
+    {
+        throw new ValidationException($this);
+    }
+}

src/ServiceProvider.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Webtools\JsonSchemaRequest;
+
+use Illuminate\Support\ServiceProvider as BaseServiceProvider;
+
+class ServiceProvider extends BaseServiceProvider
+{
+    /**
+     * Bootstrap the application services.
+     *
+     * @return void
+     */
+    public function boot()
+    {
+        $this->app->resolving(JsonSchemaRequest::class, function ($request, $app) {
+            $request = JsonSchemaRequest::createFrom($app['request'], $request);
+            $request->setContainer($app);
+        });
+    }
+}

tests/JsonSchemaRequestTest.php

@@ -0,0 +1,61 @@
+<?php
+
+namespace Webtools\JsonSchemaRequest\Tests;
+
+use Orchestra\Testbench\TestCase;
+use Webtools\JsonSchemaRequest\ServiceProvider;
+use Webtools\JsonSchemaRequest\Tests\Support\ApiRequest;
+use Illuminate\Routing\Router;
+
+class JsonSchemaRequestTest extends TestCase
+{
+    protected function getPackageProviders($app)
+    {
+        return [ServiceProvider::class];
+    }
+
+    /**
+     * @test
+     */
+    public function controllers_should_reject_invalid_json_resolve()
+    {
+        $router = $this->app->get(Router::class);
+        $router->post('/test', fn(ApiRequest $request) => response(200));
+
+        $response = $this->postJson('/test', [
+            'first_name' => 'foo',
+        ]);
+
+        $response
+            ->assertStatus(422)
+            ->assertJson([
+                'errors' => [
+                    'last_name' => ['The property last_name is required'],
+                    'email' => ['The property email is required']
+                ]
+            ]);
+    }
+
+    /**
+     * @test
+     */
+    public function it_should_accept_valid_json()
+    {
+        $router = $this->app->get(Router::class);
+        $router->post('/test', fn(ApiRequest $request) => $request->validated());
+
+        $data = [
+            'first_name' => 'foo',
+            'last_name' => 'bar',
+            'email' => '[email protected]',
+        ];
+
+        $this->postJson('/test', $data)->assertOk()->assertJson($data);
+    }
+
+    public function it_should_not_resolve_the_validator_more_than_once()
+    {
+        $request = app(ApiRequest::class);
+        $request->getValidatorInstance();
+    }
+}