Flugg\Responder\Traits\HandlesApiErrors

Complexity

Total Complexity

11

Size/Duplication

Total Lines	99
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	5

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	isApiError()	0	4	1
A	renderApiErrors()	0	8	2
A	isRunningTests()	0	4	1
A	renderTestErrors()	0	4	1
A	transformExceptions()	0	10	3
A	renderApiResponse()	0	6	2
A	renderConsoleResponse()	0	4	1
	renderForConsole()	0	1	?

<?php

namespace Flugg\Responder\Traits;

use Exception;
use Illuminate\Auth\Access\AuthorizationException;
use Illuminate\Database\Eloquent\ModelNotFoundException;
use Illuminate\Http\JsonResponse;
use Flugg\Responder\Exceptions\ApiException;
use Flugg\Responder\Exceptions\ResourceNotFoundException;
use Flugg\Responder\Exceptions\UnauthorizedException;
use Flugg\Responder\Exceptions\ValidationFailedException;
use Flugg\Responder\Responder;
use Symfony\Component\Console\Output\ConsoleOutput;

/**
 * You may apply this trait to your exceptions handler to give you access to methods
 * you may use to let the package catch and handle any API exceptions.
 *
 * @package Laravel Responder
 * @author  Alexander Tømmerås <flugged@gmail.com>
 * @license The MIT License
 */
trait HandlesApiErrors
{
    /**
     * Checks if the exception extends from the package API exception.
     *
     * @param  Exception $e
     * @return bool
     */
    protected function isApiError( Exception $e ):bool
    {
        return $e instanceof ApiException;
    }

    /**
     * Transforms and renders api responses.
     *
     * @param  Exception $e
     * @return JsonResponse
     */
    protected function renderApiErrors( Exception $e ):JsonResponse
    {
        $this->transformExceptions( $e );

        if ( $e instanceof ApiException ) {
            return $this->renderApiResponse( $e );
        }
    }

    /**
     * Checks if the application is currently in testing mode.
     *
     * @return bool
     */
    protected function isRunningTests():bool
    {
        return app()->runningUnitTests();
    }

    /**
     * Renders readable responses for console, useful for testing.
     *
     * @param  Exception $e
     * @return void
     */
    protected function renderTestErrors( Exception $e )
    {
        $this->renderConsoleResponse( $e );
    }

    /**
     * Transform Laravel exceptions into API exceptions.
     *
     * @param  Exception $e
     * @return void
     * @throws ResourceNotFoundException
     * @throws UnauthorizedException
     */
    protected function transformExceptions( Exception $e )
    {
        if ( $e instanceof AuthorizationException ) {
            throw new UnauthorizedException();
        }

        if ( $e instanceof ModelNotFoundException ) {
            throw new ResourceNotFoundException();
        }
    }

    /**
     * Render an exception into an API response.
     *
     * @param  ApiException $e
     * @return JsonResponse
     */
    protected function renderApiResponse( ApiException $e ):JsonResponse
    {
        $message = $e instanceof ValidationFailedException ? $e->getValidationMessages() : $e->getMessage();

        return app( Responder::class )->error( $e->getErrorCode(), $e->getStatusCode(), $message );
    }

    /**
     * Render an exception into an HTTP response for the console, used for debugging in test mode.
     *
     * @param  Exception $e
     * @return void
     */
    protected function renderConsoleResponse( Exception $e )
    {
        $this->renderForConsole( new ConsoleOutput( ConsoleOutput::VERBOSITY_VERBOSE ), $e );
    }

    /**
     * Render an exception to the console.
     *
     *
     */
    abstract public function renderForConsole( $output, Exception $e );
}