Client.php

<?php
/**
 * Copyright (c) 2018 Alma / Nabla SAS
 *
 * THE MIT LICENSE
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
 * documentation files (the "Software"), to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and
 * to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
 * Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
 * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
 * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 *
 * @author    Alma / Nabla SAS <contact@getalma.eu>
 * @copyright Copyright (c) 2018 Alma / Nabla SAS
 * @license   https://opensource.org/licenses/MIT The MIT License
 *
 */

namespace Alma\API;

use Alma\API\Endpoints;
use Alma\API\Lib\ClientOptionsValidator;

class Client
{
    const VERSION = '2.5.1';

    const LIVE_MODE = 'live';
    const TEST_MODE = 'test';

    const LIVE_API_URL = 'https://api.getalma.eu';
    const SANDBOX_API_URL = 'https://api.sandbox.getalma.eu';

    protected $context;

    /***** API ENDPOINTS *****/
    /**
     * @var Endpoints\Payments
     */
    public $payments;

    /**
     * @var Endpoints\Merchants
     */
    public $merchants;

    /**
     * @var Endpoints\Orders
     */
    public $orders;

    /**
     * @var Endpoints\Webhooks
     */
    public $webhooks;

    /**
     * @var Endpoints\ShareOfCheckout
     */
    public $shareOfCheckout;

    /**
     * @var Endpoints\Insurance
     */
    public $insurance;

    /**
     * @var Endpoints\DataExports
     */
    public $dataExports;
    /*************************/
    /**
     * @var Endpoints\Configuration
     */
    public $configuration;
    /*************************/

    /**
     * Alma client initialization.
     *
     * @param string $api_key a valid API key for the service
     *
     *
     * @param $options
     *              - api_root  string|array[$mode => string]   API root URL to use. If you need different URLs for the
     *                                                          test and live modes, provide an array with the keys
     *                                                          'test' and 'live' and the URLs to use as values.
     *                                                          Default: "https://api.getalma.eu"
     *
     *              - force_tls int|boolean 0, 1 or 2 will force TLS 1.0, 1.1 or 1.2 when connecting to the API.
     *                                      `false` will not try to force TLS; `true` wil fallback to default value.
     *                                      If set to 0/1/2/true, TLS will be forced even if the API ROOT uses the
     *                                      "http://" scheme.
     *                                      Default: 2
     *              - mode      string  'test' or 'live'. Default: 'live'
     *              - logger    Psr\Log\LoggerInterface The logger instance to use for errors/warnings
     *
     * @throws DependenciesError
     * @throws ParamsError
     */
    public function __construct($api_key, $options = array())
    {
        $this->checkDependencies();

        if (empty($api_key)) {
            throw new ParamsError('An API key is required to instantiate new Alma\Client');
        }

        $options = ClientOptionsValidator::validateOptions($options);

        $this->context = new ClientContext($api_key, $options);
        $this->initUserAgent();
        $this->initEndpoints();
    }

    public function addUserAgentComponent($component, $version) {
        $this->context->addUserAgentComponent($component, $version);
    }

    /**
     * @throws DependenciesError
     */
    private function checkDependencies()
    {
        if (!function_exists('curl_init')) {
            throw new DependenciesError('Alma requires the CURL PHP extension.');
        }

        if (!function_exists('json_decode')) {
            throw new DependenciesError('Alma requires the JSON PHP extension.');
        }

        $openssl_exception = new DependenciesError('Alma requires OpenSSL >= 1.0.1');
        if (!defined('OPENSSL_VERSION_TEXT')) {
            throw $openssl_exception;
        }

        preg_match('/^(?:Libre|Open)SSL ([\d.]+)/', OPENSSL_VERSION_TEXT, $matches);
        if (empty($matches[1])) {
            throw $openssl_exception;
        }

        if (!version_compare($matches[1], '1.0.1', '>=')) {
            throw $openssl_exception;
        }
    }

    private function initEndpoints()
    {
        $this->payments = new Endpoints\Payments($this->context);
        $this->merchants = new Endpoints\Merchants($this->context);
        $this->orders = new Endpoints\Orders($this->context);
        $this->shareOfCheckout = new Endpoints\ShareOfCheckout($this->context);
        $this->webhooks = new Endpoints\Webhooks($this->context);
        $this->insurance = new Endpoints\Insurance($this->context);
        $this->dataExports = new Endpoints\DataExports($this->context);
        $this->configuration = new Endpoints\Configuration($this->context);
    }

    private function initUserAgent()
    {
        $phpVersion = rtrim(str_replace(PHP_EXTRA_VERSION, '', PHP_VERSION), '-');
        $this->addUserAgentComponent('PHP', $phpVersion);

        $this->addUserAgentComponent('Alma for PHP', self::VERSION);
    }
}

// Keep those here for backward compatibility
const LIVE_MODE = Client::LIVE_MODE;
const TEST_MODE = Client::TEST_MODE;