Vindi\Resource

Complexity

Total Complexity

14

Size/Duplication

Total Lines	174
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

88.24%

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	12	3
	endpoint()	0	1	?
A	url()	0	13	3
A	all()	0	4	1
A	create()	0	4	1
A	retrieve()	0	4	1
A	update()	0	4	1
A	delete()	0	4	1
A	get()	0	4	1
A	post()	0	4	1
A	getLastResponse()	0	4	1

<?php

namespace Vindi;

abstract class Resource
{
    /**
     * @var \Vindi\ApiRequester
     */
    public $apiRequester;

    /**
     * Resource constructor.
     *
     * @param array $arguments
     */
    public function __construct($arguments = [])
    {
        if (key_exists('VINDI_API_KEY', $arguments)) {
            Vindi::setApiKey($arguments['VINDI_API_KEY']);
        }

        if (key_exists('VINDI_API_URI', $arguments)) {
            Vindi::setApiUri($arguments['VINDI_API_URI']);
        }

        $this->apiRequester = new ApiRequester;
    }

    /**
     * The endpoint at default state that will hit the API.
     *
     * @return string
     */
    abstract public function endpoint();

    /**
     * Build url that will hit the API.
     *
     * @param int $id The resource's id.
     * @param string $additionalEndpoint Additional endpoint that will be appended to the URL.
     *
     * @return string
     */
    public function url($id = null, $additionalEndpoint = null)
    {
        $endpoint = $this->endpoint();

        if (!is_null($id)) {
            $endpoint .= '/' . $id;
        }
        if (!is_null($additionalEndpoint)) {
            $endpoint .= '/' . $additionalEndpoint;
        }

        return $endpoint;
    }

    /**
     * Retrieve all resources.
     *
     * @param array $params Pagination and Filter parameters.
     *
     * @return mixed
     * @throws Exceptions\RateLimitException
     * @throws Exceptions\RequestException
     * @throws \GuzzleHttp\Exception\GuzzleException
     */
    public function all(array $params = [])
    {
        return $this->apiRequester->request('GET', $this->url(), ['query' => $params]);
    }

    /**
     * Create a new resource.
     *
     * @param array $form_params The request body.
     *
     * @return mixed
     * @throws Exceptions\RateLimitException
     * @throws Exceptions\RequestException
     * @throws \GuzzleHttp\Exception\GuzzleException
     */
    public function create(array $form_params = [])
    {
        return $this->apiRequester->request('POST', $this->url(), ['json' => $form_params]);
    }

    /**
     * Retrieve a specific resource.
     *
     * @param int $id The resource's id.
     *
     * @return mixed
     * @throws Exceptions\RateLimitException
     * @throws Exceptions\RequestException
     * @throws \GuzzleHttp\Exception\GuzzleException
     */
    public function retrieve($id = null)
    {
        return $this->apiRequester->request('GET', $this->url($id));
    }

    /**
     * Update a specific resource.
     *
     * @param int $id The resource's id.
     * @param array $form_params The request body.
     *
     * @return mixed
     * @throws Exceptions\RateLimitException
     * @throws Exceptions\RequestException
     * @throws \GuzzleHttp\Exception\GuzzleException
     */
    public function update($id = null, array $form_params = [])
    {
        return $this->apiRequester->request('PUT', $this->url($id), ['json' => $form_params]);
    }

    /**
     * Delete a specific resource.
     *
     * @param int $id The resource's id.
     * @param array $form_params The request body.
     *
     * @return mixed
     * @throws Exceptions\RateLimitException
     * @throws Exceptions\RequestException
     * @throws \GuzzleHttp\Exception\GuzzleException
     */
    public function delete($id = null, array $form_params = [])
    {
        return $this->apiRequester->request('DELETE', $this->url($id), ['json' => $form_params]);
    }

    /**
     * Make a GET request to an additional endpoint for a specific resource.
     *
     * @param int $id The resource's id.
     * @param string $additionalEndpoint Additional endpoint that will be appended to the URL.
     *
     * @return mixed
     * @throws Exceptions\RateLimitException
     * @throws Exceptions\RequestException
     * @throws \GuzzleHttp\Exception\GuzzleException
     */
    public function get($id = null, $additionalEndpoint = null)
    {
        return $this->apiRequester->request('GET', $this->url($id, $additionalEndpoint));
    }

    /**
     * Make a POST request to an additional endpoint for a specific resource.
     *
     * @param int $id The resource's id.
     * @param string $additionalEndpoint Additional endpoint that will be appended to the URL.
     * @param array $form_params The request body.
     *
     * @return mixed
     * @throws Exceptions\RateLimitException
     * @throws Exceptions\RequestException
     * @throws \GuzzleHttp\Exception\GuzzleException
     */
    public function post($id = null, $additionalEndpoint = null, array $form_params = [])
    {
        return $this->apiRequester->request('POST', $this->url($id, $additionalEndpoint), ['json' => $form_params]);
    }

    /**
     * Return the last response from a preview request
     *
     * @return mixed
     */
    public function getLastResponse()
    {
        return $this->apiRequester->lastResponse;
    }
}