Napp\Core\Api\Requests\ApiRequest

Complexity

Total Complexity

14

Size/Duplication

Total Lines	144
Duplicated Lines	0 %

Test Coverage

Coverage

75.56%

Importance

Changes	3
Bugs	1	Features	1

10 Methods

Rating	Name	Duplication	Size	Complexity
A	handleApiInternalCallFailedValidation()	0	6	1
A	transformInput()	0	10	1
A	isApiInternalCall()	0	8	2
A	getTransformer()	0	3	1
A	isValueSet()	0	3	2
A	transformValidationOutput()	0	7	1
A	handleApiCallFailedValidation()	0	8	1
A	failedValidation()	0	6	2
A	validateInputFields()	0	9	2
A	getValidatorInstance()	0	6	1

<?php

namespace Napp\Core\Api\Requests;

use Illuminate\Contracts\Validation\Validator;
use Illuminate\Foundation\Http\FormRequest;
use Illuminate\Support\Str;
use Napp\Core\Api\Exceptions\Exceptions\ApiInternalCallValidationException;
use Napp\Core\Api\Exceptions\Exceptions\InvalidFieldException;
use Napp\Core\Api\Exceptions\Exceptions\ValidationException;
use Napp\Core\Api\Transformers\ApiTransformer;
use Napp\Core\Api\Transformers\TransformerInterface;

/**
 * Class ApiRequest.
 */
abstract class ApiRequest extends FormRequest
{
    /**
     * @throws \Napp\Core\Api\Exceptions\Exceptions\InvalidFieldException
     *
     * @return Validator
     */
    protected function getValidatorInstance()
    {
        $this->replace($this->transformInput());
        $this->validateInputFields();

        return parent::getValidatorInstance();
    }

    /**
     * @param Validator $validator
     *
     * @throws \Illuminate\Validation\ValidationException
     * @throws \Napp\Core\Api\Exceptions\Exceptions\ApiInternalCallValidationException
     * @throws \Napp\Core\Api\Exceptions\Exceptions\ValidationException
     *
     * @return void
     */
    protected function failedValidation(Validator $validator)
    {
        if (false === $this->isApiInternalCall()) {
            $this->handleApiCallFailedValidation($validator);
        } else {
            $this->handleApiInternalCallFailedValidation($validator);
        }
    }

    /**
     * @throws InvalidFieldException
     *
     * @return void
     */
    protected function validateInputFields(): void
    {
        $input = $this->input();
        $rules = $this->rules();

The method rules() does not exist on Napp\Core\Api\Requests\ApiRequest. Since you implemented __call, consider adding a @method annotation.

        if (false === empty(array_diff_key($input, $rules))) {
            $exception = new InvalidFieldException();
            $exception->statusMessage = $exception->statusMessage . ': ' . implode(',', array_keys(array_diff_key($input, $rules)));

            throw $exception;
        }
    }

    /**
     * @return array
     */
    protected function transformInput(): array
    {
        /**
         * Remove input fields like _method, _token, etc.
         */
        $input = array_filter($this->input(), function ($key) {
            return ! Str::startsWith($key, '_');
        }, ARRAY_FILTER_USE_KEY);

        return $this->getTransformer()->transformInput($input);
    }

    /**
     * @return TransformerInterface
     */
    protected function getTransformer(): TransformerInterface
    {
        return app(ApiTransformer::class);
    }

    /**
     * @see AppServiceProvider
     *
     * @return bool
     */
    protected function isApiInternalCall(): bool
    {
        $request = request();
        if (true === $request->hasMacro('isApiInternalCall')) {
            return $request->isApiInternalCall();
        }

        return false;
    }

    /**
     * @param Validator $validator
     *
     * @throws ValidationException
     * @throws \Illuminate\Validation\ValidationException
     *
     * @return void
     */
    protected function handleApiCallFailedValidation(Validator $validator)
    {
        $message = $validator->messages()->first();
        $exception = new ValidationException();
        $exception->statusMessage = $exception->statusMessage . ': ' . $message;
        $exception->validation = $this->transformValidationOutput($validator);

        throw $exception;
    }

    /**
     * @param Validator $validator
     *
     * @throws ApiInternalCallValidationException
     *
     * @return void
     */
    protected function handleApiInternalCallFailedValidation(Validator $validator): void
    {
        $input = $this->getTransformer()->transformOutput($this->except($this->dontFlash));
        $errors = $this->transformValidationOutput($validator);

        throw new ApiInternalCallValidationException($input, $errors);
    }

    /**
     * @param array  $input
     * @param string $key
     *
     * @return bool
     */
    protected function isValueSet(array $input, string $key): bool
    {
        return true === isset($input[$key]) && false === empty($input[$key]);
    }

    /**
     * @param Validator $validator
     *
     * @return array
     */
    protected function transformValidationOutput($validator): array
    {
        return collect($this->getTransformer()->transformOutputKeys($validator->getMessageBag()->toArray()))
            ->reject(function ($error) {
                return false === \is_array($error);
            })
            ->toArray();
    }
}