App\Ship\Features\Tests\PhpUnit\TestsRequestHelperTrait

Complexity

Total Complexity

30

Size/Duplication

Total Lines	275
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	makeCall()	0	8	1
A	injectId()	0	8	1
A	endpoint()	0	6	1
A	auth()	0	6	1
A	getEndpoint()	0	4	2
A	getAuth()	0	4	2
C	httpRequest()	0	25	7
A	getResponse()	0	4	1
A	injectAccessToken()	0	10	3
A	headersContainAuthorization()	0	4	1
A	dataArrayToQueryParam()	0	4	2
A	hashEndpointId()	0	4	3
A	parseEndpoint()	0	19	1
A	validateEndpointExist()	0	6	2
A	validateEndpointFormat()	0	7	2

<?php

namespace App\Ship\Features\Tests\PhpUnit;

use App;
use App\Ship\Features\Exceptions\MissingTestEndpointException;
use App\Ship\Features\Exceptions\UndefinedMethodException;
use App\Ship\Features\Exceptions\WrongEndpointFormatException;
use Illuminate\Support\Facades\Config;
use Vinkla\Hashids\Facades\Hashids;

/**
 * Class TestsRequestHelperTrait
 *
 * Tests helper for making HTTP requests.
 *
 * @author  Mahmoud Zalt  <mahmoud@zalt.me>
 */
trait TestsRequestHelperTrait
{

    /**
     * property to be set on the user test class
     *
     * @var  string
     */
    protected $endpoint = '';

    /**
     * property to be set on the user test class
     *
     * @var  bool
     */
    protected $auth = true;

    /**
     * property to be set before making a call to override the default class property
     *
     * @var string
     */
    protected $overrideEndpoint;

    /**
     * property to be set before making a call to override the default class property
     *
     * @var string
     */
    protected $overrideAuth;

    /**
     * the $endpoint property will be extracted to $endpointVerb and $endpointUrl after parsing
     *
     * @var string
     */
    private $endpointVerb;

    /**
     * the $endpoint property will be extracted to $endpointVerb and $endpointUrl after parsing
     *
     * @var string
     */
    private $endpointUrl;

    /**
     * @param        $this ->endpointUrl
     * @param string $this ->endpointVerb

There is no parameter named $this. Was it maybe removed?

     * @param array  $data
     * @param bool   $protected

There is no parameter named $protected. Was it maybe removed?

     * @param array  $headers
     *
     * @return  mixed
     * @throws \Symfony\Component\Debug\Exception\UndefinedMethodException
     */
    public function makeCall(array $data = [], array $headers = [])
    {
        $this->parseEndpoint();

        $headers = $this->injectAccessToken($headers);

        return $this->getResponse($this->httpRequest($data, $headers));
    }

    /**
     * Inject the ID in the Endpoint URI before making the call by
     * overriding the `$this->endpoint` property
     *
     * Example: you give it ('users/{id}/stores', 100) it returns 'users/100/stores'
     *
     * @param        $this ->url
     * @param        $id
     * @param bool   $skipEncoding
     * @param string $replace
     *
     * @return  mixed
     */
    public function injectId($id, $skipEncoding = false, $replace = '{id}')
    {
        // In case Hash ID is enabled it will encode the ID first
        $id = $this->hashEndpointId($id, $skipEncoding);
        $this->endpoint = str_replace($replace, $id, $this->endpoint);

        return $this;
    }

    /**
     * Override the default class endpoint property before making the call
     *
     * to be used as follow: $this->endpoint('verb@url')->makeCall($data);
     *
     * @param $endpoint
     *
     * @return  $this
     */
    public function endpoint($endpoint)
    {
        $this->overrideEndpoint = $endpoint;

        return $this;
    }

    /**
     * Override the default class auth property before making the call
     *
     * to be used as follow: $this->auth('false')->makeCall($data);
     *
     * @param bool $auth
     *
     * @return  $this
     */
    public function auth(bool $auth)
    {
        $this->overrideAuth = $auth;

The property $overrideAuth was declared of type string, but $auth is of type boolean. Maybe add a type cast?

        return $this;
    }

    /**
     * @return  string
     */
    public function getEndpoint()
    {
        return !is_null($this->overrideEndpoint) ? $this->overrideEndpoint : $this->endpoint;
    }

    /**
     * @return  bool
     */
    public function getAuth()
    {
        return !is_null($this->overrideAuth) ? $this->overrideAuth : $this->auth;
    }

    /**
     * @param array $data
     * @param array $headers
     *
     * @return  mixed
     */
    private function httpRequest(array $data = [], array $headers = [])
    {
        $verb = $this->endpointVerb;
        $url = $this->endpointUrl;

        switch ($verb) {
            case 'post':
            case 'put':
            case 'patch':
            case 'delete':
                $httpResponse = $this->{$verb}($url, $data, $headers);
                break;
            case 'get':
                $url = $this->dataArrayToQueryParam($data, $url);
                $httpResponse = $this->get($url, $headers);

It seems like get() must be provided by classes using this trait. How about adding it as abstract method to this trait?

                break;
            case 'json:post':
                $httpResponse = $this->json('post', $url, $data, $headers);

It seems like json() must be provided by classes using this trait. How about adding it as abstract method to this trait?

                break;
            default:
                throw new UndefinedMethodException('Undefined HTTP Verb (' . $verb . ').');
        }

        return $httpResponse;
    }

    /**
     * @param $responseContent
     *
     * @return  mixed
     */
    private function getResponse($responseContent)
    {
        return $responseContent->response;
    }

    /**
     * Attach Authorization Bearer Token to the request headers
     * if it doesn't exist already and the authentication is required
     * for the endpoint `$this->auth = true`.
     *
     * @param $headers
     *
     * @return  mixed
     */
    private function injectAccessToken(array $headers = [])
    {
        // if endpoint is protected (requires token to access it's functionality)
        if ($this->getAuth() && !$this->headersContainAuthorization($headers)) {
            // append the token to the header
            $headers['Authorization'] = 'Bearer ' . $this->getTestingUser()->token;

It seems like getTestingUser() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        }

        return $headers;
    }

    /**
     * just check if headers array has an `Authorization` as key.
     *
     * @param $headers
     *
     * @return  bool
     */
    private function headersContainAuthorization($headers)
    {
        return array_has($headers, 'Authorization');
    }

    /**
     * @param $data
     * @param $endpointUrl
     *
     * @return  null|string
     */
    private function dataArrayToQueryParam($data, $url)
    {
        return $data ? $url . '?' . http_build_query($data) : $url;
    }


    /**
     * @param      $id
     * @param bool $skipEncoding
     *
     * @return  mixed
     */
    private function hashEndpointId($id, $skipEncoding = false)
    {
        return (Config::get('hello.hash-id') && !$skipEncoding) ? Hashids::encode($id) : $id;
    }

    /**
     * read `$this->endpoint` property (`verb@url`) and get `$this->endpointVerb` & `$this->endpointUrl`
     */
    private function parseEndpoint()
    {
        $this->validateEndpointExist();

        $separator = '@';

        $this->validateEndpointFormat($separator);

        // convert the string to array
        $asArray = explode($separator, $this->getEndpoint(), 2);

        // get the verb and url values from the array
        extract(array_combine(['verb', 'url'], $asArray));

array_combine(array('verb', 'url'), $asArray) cannot be passed to extract() as the parameter $var_array expects a reference.

        /** @var TYPE_NAME $verb */
        $this->endpointVerb = $verb;

It seems like $verb of type object<App\Ship\Features\Tests\PhpUnit\TYPE_NAME> is incompatible with the declared type string of property $endpointVerb.

        /** @var TYPE_NAME $url */
        $this->endpointUrl = $url;

It seems like $url of type object<App\Ship\Features\Tests\PhpUnit\TYPE_NAME> is incompatible with the declared type string of property $endpointUrl.

    }

    /**
     * @void
     */
    private function validateEndpointExist()
    {
        if (!$this->getEndpoint()) {
            throw new MissingTestEndpointException();
        }
    }

    /**
     * @param $separator
     */
    private function validateEndpointFormat($separator)
    {
        // check if string contains the separator
        if (!strpos($this->getEndpoint(), $separator)) {
            throw new WrongEndpointFormatException();
        }
    }
}