PeterColes\XmlSoccer\ApiClient

Complexity

Total Complexity

19

Size/Duplication

Total Lines	167
Duplicated Lines	0 %

Coupling/Cohesion

Components	4
Dependencies	7

Importance

Changes	1
Bugs	0	Features	0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	setApiEndpoint()	0	4	2
A	setApiKey()	0	4	1
B	__call()	0	22	6
A	object()	0	6	1
A	json()	0	6	1
A	buildUri()	0	4	1
A	prepareParams()	0	12	3
A	initGuzzleClient()	0	4	1
A	request()	0	10	2

<?php

namespace PeterColes\XmlSoccer;

use Exception;
use GuzzleHttp\Client as GuzzleClient;
use PeterColes\XmlSoccer\Converters\ObjectConverter;
use PeterColes\XmlSoccer\Exceptions\ApiKeyNotAcceptedException;
use PeterColes\XmlSoccer\Exceptions\ApiThrottlingException;
use PeterColes\XmlSoccer\Exceptions\InvalidXmlException;
use PeterColes\XmlSoccer\Exceptions\MissingApiKeyException;
use PeterColes\XmlSoccer\Exceptions\RequestFailedException;

class ApiClient
{
    /**
     * Default API endpoint.
     */
    protected $apiEndpoint;

    /**
     * Subscriber's API key.
     */
    protected $apiKey;

    /**
     * Guzzle client instance.
     */
    protected $guzzleClient;

    /**
     * Data converter instance.
     */
    protected $converter = null;

    /**
     * Should data be returned as a json encoded string?
     */
    protected $encode = false;

    /**
     * Optional (recommended) setting of an API key when a new instance is instantiated.
     * Setting the API endpoint, default or demo according to the (optional) parameter.
     * Advanced users may wish to a Guzzle client with their own configuration settings
     * but this will rarely be needed.
     *
     * @param string | null $apiKey
     * @param boolean       $demo
     * @param GuzzleClient  $guzzleClient
     */
    public function __construct($apiKey = null, $demo = false, $guzzleClient = null)
    {
        $this->setApiKey($apiKey);
        $this->setApiEndpoint($demo);
        $this->initGuzzleClient($guzzleClient);
    }

    /**
     * Override default API endpoint.
     *
     * @param $apiEndpoint
     */
    public function setApiEndpoint($demo = false)
    {
        $this->apiEndpoint = 'http://www.xmlsoccer.com/FootballData'.($demo ? 'Demo' : '').'.asmx';
    }

    /**
     * Set or override the API key.
     *
     * @param $apiKey
     */
    public function setApiKey($apiKey)
    {
        $this->apiKey = $apiKey;
    }

    /**
     * Accept the requested method and its parameters, make the request to XML Soccer and validate the response.
     *
     * @param $name
     * @param $params
     * @return SimpleXMLElement
     */
    public function __call($method, $params)
    {
        $xml = $this->request($this->buildUri($method), $this->prepareParams($method, $params));

        if (false !== strpos($xml, 'Api-key not accepted')) {
            throw new ApiKeyNotAcceptedException;
        }

        if (false !== strpos($xml, 'To avoid misuse of the service')) {
            throw new ApiThrottlingException;
        }

        try {
            $xml = simplexml_load_string($xml);
        } catch (Exception $e) {
            throw new InvalidXmlException;
        }

        $result = $this->converter ? $this->converter->handle($xml) : $xml;

        return $this->encode ? json_encode($result) : $result;
    }

    public function object()
    {
        $this->converter = new ObjectConverter;

        return $this;
    }

    public function json()
    {
        $this->encode = true;

        return $this->object();
    } 

    /**
     * Build the base URI for the API from its endpoint and the resource being requested.
     *
     * @param $method
     * @return string
     */
    protected function buildUri($method)
    {
        return $this->apiEndpoint.'/'.ucfirst($method);
    }

    /**
     * Almost all API calls require an API Key so we add it to the parameters.
     *
     * @param $params
     * @return string
     */
    protected function prepareParams($method, $params)
    {
        if ('ImAlive' == ucfirst($method)) {
            return null;
        }

        if (!$this->apiKey) {
            throw new MissingApiKeyException;
        }

        return array_merge([ 'apiKey' => $this->apiKey ], $params[ 0 ] ?? [ ]);
    }

    /**
     * Initialise or inject an instance of the Guzzle client.
     *
     * @return GuzzleClient
     */
    protected function initGuzzleClient($guzzleClient = null)
    {
        $this->guzzleClient = $guzzleClient ?? new GuzzleClient;
    }

    /**
     * Make the request to the XML Soccer service and validate response.
     *
     * @param  string        $uri
     * @param  array | null  $params
     * @throws RequestFailedException
     * @return SimpleXMLElement
     */
    protected function request($uri, $params)
    {
        try {
            $response = $this->guzzleClient->get($uri, [ 'query' => $params ]);
        } catch (Exception $e) {
            throw new RequestFailedException;
        }

        return $response->getBody();
    }
}