Tequilarapido\ApiResponse\ApiResponse

Complexity

Total Complexity

16

Size/Duplication

Total Lines	195
Duplicated Lines	10.77 %

Coupling/Cohesion

Components	2
Dependencies	2

Test Coverage

Coverage

92.11%

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	item()	7	7	1
A	collection()	7	7	1
A	paginatedCollection()	7	7	1
A	noContent()	0	7	2
A	errorNotFound()	0	4	1
A	errorBadRequest()	0	4	1
A	errorUnauthorized()	0	4	1
A	errorForbidden()	0	4	1
A	errorInternal()	0	4	1
A	error()	0	16	3
A	toResponseBuilder()	0	6	2

<?php

namespace Tequilarapido\ApiResponse;

use Illuminate\Support\MessageBag;

class ApiResponse
{
    /**
     * @var FractalAdapter
     */
    private $fractalAdapter;

    /**
     * Response class.
     *
     * @param FractalAdapter $fractal
     */
    public function __construct(FractalAdapter $fractal)
    {
        $this->fractalAdapter = $fractal;
    }

    /**
     * Returns one item.
     *
     * @param mixed $data
     * @param null  $transformer
     * @param null  $resourceKey
     * @param bool  $build
     *
     * @return array|\Illuminate\Http\Response|ResponseBuilder*

The doc-type array|\Illuminate\Http\Response|ResponseBuilder* could not be parsed: Unknown type name "ResponseBuilder*" at position 32. (view supported doc-types)

     */
    public function item($data, $transformer = null, $resourceKey = null, $build = true)

This method seems to be duplicated in your project.

    {
        return $this->toResponseBuilder(
            $this->fractalAdapter->item($data, $transformer, $resourceKey),
            $build
        );
    }

    /**
     * Returns collection.
     *
     * @param      $data
     * @param null $transformer
     * @param null $resourceKey
     * @param bool $build
     *
     * @return array|\Illuminate\Http\Response|ResponseBuilder
     */
    public function collection($data, $transformer = null, $resourceKey = null, $build = true)

This method seems to be duplicated in your project.

    {
        return $this->toResponseBuilder(
            $this->fractalAdapter->collection($data, $transformer, $resourceKey),
            $build
        );
    }

    /**
     * Returns paginated collection.
     *
     * @param      $paginator
     * @param null $transformer
     * @param null $resourceKey
     * @param bool $build
     *
     * @return array|\Illuminate\Http\Response|ResponseBuilder
     */
    public function paginatedCollection($paginator, $transformer = null, $resourceKey = null, $build = true)

This method seems to be duplicated in your project.

    {
        return $this->toResponseBuilder(
            $this->fractalAdapter->paginatedCollection($paginator, $transformer, $resourceKey),
            $build
        );
    }

    /**
     * Respond with a no content response.
     *
     * @param bool $build
     *
     * @return ResponseBuilder|\Illuminate\Http\Response
     */
    public function noContent($build = true)
    {
        $response = new ResponseBuilder(null);
        $response->setStatusCode(204);

        return $build ? $response->build() : $response;
    }

    /**
     * Return a 404 not found error.
     *
     * @param string|array $message
     * @param bool         $build
     *
     * @return \Illuminate\Http\Response
     */
    public function errorNotFound($message = 'Not Found', $build = true)
    {
        return $this->error($message, 404, null, $build);
    }

    /**
     * Return a 400 bad request error.
     *
     * @param string|array $message
     * @param bool         $build
     *
     * @return \Illuminate\Http\Response
     */
    public function errorBadRequest($message = 'Bad Request', $build = true)
    {
        return $this->error($message, 400, null, $build);
    }

    /**
     * Return a 401 unauthorized error.
     *
     * @param string|array $message
     * @param bool         $build
     *
     * @return \Illuminate\Http\Response
     */
    public function errorUnauthorized($message = 'Unauthorized', $build = true)
    {
        return $this->error($message, 401, null, $build);
    }

    /**
     * Return a 401 unauthorized error.
     *
     * @param string|array $message
     * @param bool         $build
     *
     * @return \Illuminate\Http\Response
     */
    public function errorForbidden($message = 'Forbidden', $build = true)
    {
        return $this->error($message, 403, null, $build);
    }

    /**
     * Return a 500 internal server error.
     *
     * @param string|array $message
     * @param bool         $build
     *
     * @return \Illuminate\Http\Response
     */
    public function errorInternal($message = 'Internal Error', $build = true)
    {
        return $this->error($message, 500, null, $build);
    }

    /**
     * Return an error response.
     *
     * @param                  $messages
     * @param int              $statusCode
     * @param mixed|MessageBag $errors
     * @param bool             $build
     *
     * @return \Illuminate\Http\Response
     */
    public function error($messages, $statusCode = 500, $errors = null, $build = true)
    {
        $error = [
            'error' => true,
            'code' => $statusCode,
            'message' => $messages,
        ];

        if (! is_null($errors)) {
            $error = array_merge($error, ['errors' => $errors]);
        }

        $response = (new ResponseBuilder($error))->setStatusCode($statusCode);

        return $build ? $response->build() : $response;
    }

    /**
     * Wrap into ResponseBuilder, and build if requested.
     * If not will return ResponseBuilder object, to be able to add headers for instance
     * before sending back response using `build()` method.
     *
     * @param $data
     * @param $build
     *
     * @return \Illuminate\Http\Response|ResponseBuilder
     */
    protected function toResponseBuilder($data, $build)
    {
        return $build
            ? (new ResponseBuilder($data))->build()
            : new ResponseBuilder($data);
    }
}