Ntholenaar\MultiSafepayClient\Client

Complexity

Total Complexity

29

Size/Duplication

Total Lines	329
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	14

Importance

Changes	3
Bugs	0	Features	0

21 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	14	3
A	getApiEndpoint()	0	8	2
A	getApiPath()	0	4	1
A	getUriFactory()	0	4	1
A	setUriFactory()	0	6	1
A	getHttpClient()	0	4	1
A	setHttpClient()	0	6	1
A	getLocale()	0	4	1
A	setLocale()	0	6	1
A	setTestMode()	0	6	1
A	isTestModeEnabled()	0	4	1
A	setApiKey()	0	10	1
A	addHttpPlugin()	0	8	1
A	invalidatePluginClient()	0	6	1
A	getPluginClient()	0	21	2
A	executeRequest()	0	6	1
A	parseResponse()	0	10	1
A	validateResponse()	0	8	3
A	createGatewayRequest()	0	4	1
A	createIssuerRequest()	0	4	1
A	createRequest()	0	12	3

<?php namespace Ntholenaar\MultiSafepayClient;

use Http\Client\Common\Plugin;
use Http\Client\Common\PluginClient;
use Http\Client\HttpClient;
use Http\Discovery;
use Http\Message\UriFactory;
use Ntholenaar\MultiSafepayClient\Exception\InvalidRequestException;
use Ntholenaar\MultiSafepayClient\Http\Plugin\Authentication;
use Ntholenaar\MultiSafepayClient\Http\Plugin\PrependPathPlugin;
use Ntholenaar\MultiSafepayClient\Request\GatewayRequest;
use Ntholenaar\MultiSafepayClient\Request\IssuerRequest;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;

class Client implements ClientInterface
{
    /**
     * Optional ISO 639-1 language code.
     *
     * The localization parameter determines the language which is used to
     * display gateway information and other messages in the responses.
     * The default language is English.
     *
     * @var string
     */
    protected $locale;

    /**
     * @var bool
     */
    protected $testMode = false;

    /**
     * @var HttpClient
     */
    protected $httpClient;

    /**
     * @var PluginClient
     */
    protected $pluginClient;

    /**
     * @var UriFactory
     */
    protected $uriFactory;

    /**
     * @var array
     */
    protected $plugins = array();

    /**
     * @param HttpClient $httpClient
     * @param UriFactory|null $uriFactory
     */
    public function __construct(HttpClient $httpClient = null, UriFactory $uriFactory = null)
    {
        if (is_null($httpClient)) {
            $httpClient = Discovery\HttpClientDiscovery::find();
        }

        if (is_null($uriFactory)) {
            $uriFactory = Discovery\UriFactoryDiscovery::find();
        }

        $this->setHttpClient($httpClient);

        $this->setUriFactory($uriFactory);
    }

    /**
     * Get the API endpoint.
     *
     * @return \Psr\Http\Message\UriInterface
     */
    public function getApiEndpoint()
    {
        if ($this->isTestModeEnabled()) {
            return $this->uriFactory->createUri('https://testapi.multisafepay.com');
        }

        return $this->uriFactory->createUri('https://api.multisafepay.com');
    }

    /**
     * Get the API path.
     *
     * @return \Psr\Http\Message\UriInterface
     */
    public function getApiPath()
    {
        return $this->uriFactory->createUri('/v1/json/');
    }

    /**
     * Get the UriFactory.
     *
     * @return UriFactory
     */
    protected function getUriFactory()
    {
        return $this->uriFactory;
    }

    /**
     * Set the UriFactory.
     *
     * @param UriFactory $uriFactory
     * @return $this
     */
    protected function setUriFactory(UriFactory $uriFactory)
    {
        $this->uriFactory = $uriFactory;

        return $this;
    }

    /**
     * Get the HttpClient.
     *
     * @return HttpClient
     */
    protected function getHttpClient()
    {
        return $this->httpClient;
    }

    /**
     * Set the HttpClient.
     *
     * @param HttpClient $httpClient
     * @return $this
     */
    protected function setHttpClient(HttpClient $httpClient)
    {
        $this->httpClient = $httpClient;

        return $this;
    }

    /**
     * Get the locale.
     *
     * @return string
     */
    public function getLocale()
    {
        return $this->locale;
    }

    /**
     * Set the locale.
     *
     * @param $locale
     * @return $this
     */
    public function setLocale($locale)
    {
        $this->locale = $locale;

        return $this;
    }

    /**
     * Enable or disable the test environment.
     *
     * @param $testMode
     * @return $this
     */
    public function setTestMode($testMode)
    {
        $this->testMode = $testMode;

        return $this;
    }

    /**
     * Is the test environment active.
     *
     * @return bool
     */
    public function isTestModeEnabled()
    {
        return $this->testMode;
    }

    /**
     * Set the API key.
     *
     * @param $apiKey
     * @return $this
     */
    public function setApiKey($apiKey)
    {
        $this->addHttpPlugin(
            new Plugin\AuthenticationPlugin(
                new Authentication\MultiSafepayAuthentication($apiKey)
            )
        );

        return $this;
    }

    /**
     * Add an Http plugin.
     *
     * @param Plugin $plugin
     * @return $this
     */
    public function addHttpPlugin(Plugin $plugin)
    {
        $this->plugins[] = $plugin;

        $this->invalidatePluginClient();

        return $this;
    }

    /**
     * Invalidate the PluginClient instance.
     *
     * @return $this
     */
    protected function invalidatePluginClient()
    {
        $this->pluginClient = null;

        return $this;
    }

    /**
     * Get the PluginClient.
     *
     * @return PluginClient
     */
    protected function getPluginClient()
    {
        if ($this->pluginClient !== null) {
            return $this->pluginClient;
        }

        $plugins = [
            new Plugin\ErrorPlugin(),
            new Plugin\AddHostPlugin($this->getApiEndpoint()),
            new PrependPathPlugin($this->getApiPath())
        ];

        // @todo set Locale plugin, Which automatically adds the locale query parameter.

        $this->pluginClient = new PluginClient(
            $this->httpClient,
            array_merge($plugins, $this->plugins)
        );

        return $this->pluginClient;
    }

    /**
     * Execute the Http Request.
     *
     * @param RequestInterface $request
     * @return array|object
     */
    public function executeRequest(RequestInterface $request)
    {
        $response = $this->getPluginClient()->sendRequest($request);

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

    /**
     * Parse the response.
     *
     * @param ResponseInterface $response
     * @return array|object
     */
    protected function parseResponse(ResponseInterface $response)
    {
        $responseBody = json_decode(
            $response->getBody()->getContents()
        );

        $this->validateResponse($responseBody);

        return $responseBody->data;
    }

    /**
     * Validate the response.
     *
     * @param $response
     * @return bool
     * @throws InvalidRequestException
     */
    protected function validateResponse($response)
    {
        if (!property_exists($response, 'success') || $response->success !== true) {
            throw new InvalidRequestException($response->error_info, $response->error_code);
        }

        return true;
    }

    /**
     * Create an GatewayRequest.
     *
     * @return GatewayRequest
     */
    public function createGatewayRequest()
    {
        return new GatewayRequest;
    }

    /**
     * Create an IssuerRequest.
     *
     * @return IssuerRequest
     */
    public function createIssuerRequest()
    {
        return new IssuerRequest;
    }

    /**
     * Create an new request.
     *
     * @param $resource
     * @return \Ntholenaar\MultiSafepayClient\Request\RequestInterface
     */
    public function createRequest($resource)
    {
        switch ($resource) {
            case 'gateways':
                return $this->createGatewayRequest();

            case 'issuers':
                return $this->createIssuerRequest();
        }

        throw new \InvalidArgumentException('Invalid command specified.');
    }
}