CryptoMarkets\Common\Endpoint

Complexity

Total Complexity

13

Size/Duplication

Total Lines	184
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	2

Importance

Changes

0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	make()	0	8	1
A	configure()	0	6	1
A	send()	0	8	1
A	createRequest()	0	9	1
A	getMethod()	0	4	1
	getUrl()	0	1	?
A	getPreparedHeaders()	0	4	1
A	getHeaders()	0	4	1
A	getPreparedData()	0	10	2
A	getData()	0	4	1
A	authenticationData()	0	4	1
A	parseResponse()	0	4	1
	mapResponse()	0	1	?

<?php

namespace CryptoMarkets\Common;

use Psr\Http\Message\ResponseInterface;

abstract class Endpoint
{
    /**
     * The request parameters.
     *
     * @var array
     */
    protected $params;

    /**
     * The HTTP client instance.
     *
     * @var \CryptoMarkets\Common\Client
     */
    protected $httpClient;

    /**
     * Determine if the request need authorized.
     *
     * @var bool
     */
    protected $authorize = false;

    /**
     * Create a new Endpoint instance.
     *
     * @param  \CryptoMarkets\Common\Client  $httpClient
     * @return void

Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

     */
    public function __construct(Client $httpClient)
    {
        $this->httpClient = $httpClient;
    }

    /**
     * Create a new resource instance.
     *
     * @param  \CryptoMarkets\Common\Client  $httpClient
     * @param  array  $params
     * @return static
     */
    public static function make(Client $httpClient, array $params = [])
    {
        $instance = new static($httpClient);

        $instance->configure($params);

        return $instance;
    }

    /**
     * Configure the request parameters.
     *
     * @param  array  $params
     * @return $this
     */
    public function configure(array $params = [])
    {
        $this->params = $params;

        return $this;
    }

    /**
     * Send a new request.
     *
     * @return array
     */
    public function send()
    {
        $request = $this->createRequest();

        $response = $this->httpClient->sendRequest($request);

The method sendRequest does not exist on object<CryptoMarkets\Common\Client>? Since you implemented __call, maybe consider adding a @method annotation.

        return $this->mapResponse((array) $this->parseResponse($response));
    }

    /**
     * Create a new request object.
     *
     * @return \GuzzleHttp\Psr7\Request
     */
    public function createRequest()
    {
        return $this->httpClient->createRequest(
            $this->getMethod(),
            $this->getUrl(),
            $this->getPreparedHeaders(),
            $this->getPreparedData()
        );
    }

    /**
     * Get the request method.
     *
     * @return string
     */
    public function getMethod()
    {
        return 'POST';
    }

    /**
     * Get the request url.
     *
     * @return string
     */
    abstract public function getUrl();

    /**
     * Get the request headers for authorized or not.
     *
     * @return array
     */
    public function getPreparedHeaders()
    {
        return $this->getHeaders();
    }

    /**
     * Get the request headers.
     *
     * @return array
     */
    public function getHeaders()
    {
        return [];
    }

    /**
     * Get the request data for authorized or not.
     *
     * @return string
     */
    public function getPreparedData()
    {
        $params = $this->getData();

        if ($this->authorize) {
            $params = array_merge($params, $this->authenticationData($params));

The call to Endpoint::authenticationData() has too many arguments starting with $params.

        }

        return $params;
    }

    /**
     * Get the request data.
     *
     * @return array
     */
    public function getData()
    {
        return [];
    }

    /**
     * Get the authentication request data.
     *
     * @return array
     */
    protected function authenticationData()
    {
        return [];
    }

    /**
     * Parse and normalize the raw response.
     *
     * @param  \Psr\Http\Message\ResponseInterface  $response
     * @return array
     */
    public function parseResponse(ResponseInterface $response)
    {
        return json_decode($response->getBody(), true);
    }

    /**
     * Map the given array to create a response object.
     *
     * @param  array  $data
     * @return array
     */
    abstract public function mapResponse(array $data = []);
}