Client::getVersion() - Code Metrics - KOBASSoftware/api-client-php - Measure and Improve Code Quality continuously with Scrutinizer

Client::getVersion() A
last analyzed 2021-03-23 14:25 UTC

↳ Parent: Client
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	2
CRAP Score	1
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
eloc	1
c	1
b	0
f	0
dl	0
loc	3
ccs	2
cts	2
cp	1
rs	10
cc	1
nc	1
nop	0
crap	1
<?php

namespace Kobas\APIClient;

use Kobas\APIClient\Auth\Provider;
use Kobas\APIClient\Exception\CurlException;
use Kobas\APIClient\Exception\HttpException;
use Kobas\APIClient\Request\Curl;
use Kobas\APIClient\Request\HttpRequest;

/**
 * Class Client
 *
 * @package Kobas
 */
class Client
{
    /**
     * @var string
     */
    protected $api_base_url = 'https://api.kobas.co.uk';

    /**
     * @var string
     */
    protected $version = 'v3';

    /**
     * @var Provider
     */
    protected $oAuthProvider;

    /**
     * @var Curl|HttpRequest|null
     */
    protected $request;

    /**
     * @var array
     */
    protected $headers;

    /**
     * @var array
     */
    protected $curl_options;


    protected $request_info;


    /**
     * Client constructor.
     *
     * @param Provider $oAuthProvider
     * @param HttpRequest|null $request
     * @param array $headers
     * @param array $curl_options
     */
    public function __construct(
        Provider $oAuthProvider,
        HttpRequest $request = null,
        $headers = array(),
        $curl_options = array()
    ) {
        $this->oAuthProvider = $oAuthProvider;
        if ($request == null) {
            $request = new Curl();
        }
        $this->request = $request;
        $this->headers = $headers;
        $this->curl_options = $curl_options;
    }

    /**
     * @return string
     */
    public function getApiBaseUrl()
    {
        return $this->api_base_url;
    }

    /**
     * @return string
     */
    public function getVersion()
    {
        return $this->version;
    }

    /**
     * Allows you to set the API Base URL. Default value is 'https://api.kobas.co.uk'
     *
     * @param $url
     */
    public function setAPIBaseURL($url)
    {
        $this->api_base_url = $url;
    }

    /**
     * Allows you to set the API version to use. Default value is 'v2'
     *
     * @param $version
     */
    public function setAPIVersion($version)
    {
        $this->version = $version;
    }

    /**
     * @param $route
     * @param array $params
     * @param array $headers
     * @return mixed
     * @throws CurlException
     * @throws Exception\AuthenticationException
     * @throws HttpException
     */
    public function get($route, array $params = array(), array $headers = array())
    {
        return $this->call('GET', $route, $params, $headers);
    }


    /**
     * @param $http_method
     * @param $route
     * @param array $params
     * @param array $headers
     * @return mixed
     * @throws CurlException
     * @throws Exception\AuthenticationException
     * @throws HttpException
     */
    protected function call($http_method, $route, array $params = array(), array $headers = array())
    {
        $url = $this->api_base_url . '/';
        if (!empty($this->version)) {
            $url .= $this->version . '/';
        }

        $url .= $route;

        $this->request
            ->init()
              init()
            ->setOption(CURLOPT_CUSTOMREQUEST, strtoupper($http_method))
            ->setOption(CURLOPT_RETURNTRANSFER, true)
            ->setOption(CURLOPT_FOLLOWLOCATION, true)
            ->setOption(CURLOPT_ENCODING, '');

        foreach ($this->curl_options as $option => $value) {
            $this->request->setOption($option, $value);
        }

        $headers = array_merge($this->headers, $headers);
        $headers['Authorization'] = "Bearer " . $this->oAuthProvider->getAccessToken();
        $headers['x-kobas-company-id'] = $this->oAuthProvider->getCompanyId();
        $headers['Content-Type'] = 'application/json';

        switch ($http_method) {
            case 'POST':
                $this->request->setOption(CURLOPT_POSTFIELDS, json_encode($params));
                break;
            case 'DELETE':
            case 'PUT':
                $this->request->setOption(CURLOPT_POSTFIELDS, json_encode($params));
                break;
            case 'GET':
                if (count($params)) {
                    $url .= "?" . http_build_query($params);
                }
                break;
        }

        $this->request->setUrl($url);

        $requestHeaders = array();
        foreach ($headers as $key => $value) {
            $requestHeaders[] = $key . ': ' . $value;
        }

        $this->request->setOption(CURLOPT_HTTPHEADER, $requestHeaders);

        $result = $this->request->execute();

        if ($this->request->getErrorNumber()) {
            throw new CurlException($this->request->getErrorMessage(), $this->request->getErrorNumber());
        }

        $this->request_info = $this->request->getAllInfo();
        $last_response = $this->request->getInfo(CURLINFO_HTTP_CODE);

        $this->request->close();

        if ($last_response >= 400) {
            throw new HttpException(json_encode(json_decode($result, true)), $last_response);
            throw new HttpException(json_encode(json_decode(/** @scrutinizer ignore-type */ $result, true)), $last_response);
        }

        return json_decode($result, true);
    }


    /**
     * @param $route
     * @param array $params
     * @param array $headers
     * @return mixed
     * @throws CurlException
     * @throws Exception\AuthenticationException
     * @throws HttpException
     */
    public function post($route, array $params = array(), array $headers = array())
    {
        return $this->call('POST', $route, $params, $headers);
    }


    /**
     * @param $route
     * @param array $params
     * @param array $headers
     * @return mixed
     * @throws CurlException
     * @throws Exception\AuthenticationException
     * @throws HttpException
     */
    public function put($route, array $params = array(), array $headers = array())
    {
        return $this->call('PUT', $route, $params, $headers);
    }


    /**
     * @param $route
     * @param array $params
     * @param array $headers
     * @return mixed
     * @throws CurlException
     * @throws Exception\AuthenticationException
     * @throws HttpException
     */
    public function delete($route, array $params = array(), array $headers = array())
    {
        return $this->call('DELETE', $route, $params, $headers);
    }

    /**
     * @return array|false
     */
    public function getRequestInfo()
    {
        return $this->request_info;
    }
}

KOBASSoftware / api-client-php

GitHub Access Token became invalid

Client::getVersion() A last analyzed 2021-03-23 14:25 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Client::getVersion() A
last analyzed 2021-03-23 14:25 UTC
