Arcanedev\Stripe\Stripe

Complexity

Total Complexity

37

Size/Duplication

Total Lines	418
Duplicated Lines	0 %

Coupling/Cohesion

Components	8
Dependencies	3

Test Coverage

Coverage

92.31%

Importance

Changes	2
Bugs	0	Features	0

26 Methods

Rating	Name	Duplication	Size	Complexity
A	getApiKey()	0	4	1
A	setApiKey()	0	6	1
A	getApiBaseUrl()	0	4	1
A	setApiBaseUrl()	0	6	1
A	getClientId()	0	4	1
A	setClientId()	0	4	1
A	getUploadBaseUrl()	0	4	1
A	setUploadBaseUrl()	0	6	1
A	getApiVersion()	0	4	1
A	version()	0	4	1
A	setApiVersion()	0	6	1
A	getAccountId()	0	4	1
A	setAccountId()	0	4	1
A	getVerifySslCerts()	0	4	1
A	setVerifySslCerts()	0	4	1
A	getAppInfo()	0	4	1
A	setAppInfo()	0	4	1
A	getLogger()	0	7	2
A	setLogger()	0	4	1
A	init()	0	4	1
A	checkApiKey()	0	10	3
A	checkApiBaseUrl()	0	10	3
A	checkUploadBaseUrl()	0	11	3
B	checkApiVersion()	0	17	5
A	hasApiVersion()	0	4	1
A	hasAccountId()	0	4	1

<?php namespace Arcanedev\Stripe;

use Arcanedev\Stripe\Contracts\Stripe as StripeContract;
use Arcanedev\Stripe\Exceptions\ApiException;
use Arcanedev\Stripe\Exceptions\ApiKeyNotSetException;
use Psr\Log\LoggerInterface;

/**
 * Class     Stripe
 *
 * @package  Arcanedev\Stripe
 * @author   ARCANEDEV <arcanedev.maroc@gmail.com>
 */
abstract class Stripe implements StripeContract
{
    /* -----------------------------------------------------------------
     |  Constants
     | -----------------------------------------------------------------
     */

    /**
     * Library Version.
     *
     * @var string
     */
    const VERSION = '5.2.0';

    /* -----------------------------------------------------------------
     |  Properties
     | -----------------------------------------------------------------
     */

    /**
     * The Stripe API key to be used for requests.
     *
     * @var string
     */
    private static $apiKey;

    /**
     * The Stripe client_id to be used for Connect requests.
     *
     * @var string
     */
    public static $clientId;

    /**
     * The base URL for the Stripe API.
     *
     * @var string
     */
    public static $apiBaseUrl    = 'https://api.stripe.com';

    /**
     * The base URL for the OAuth API.
     *
     * @var string
     */
    public static $connectBase = 'https://connect.stripe.com';

    /**
     * The base URL for the Stripe API uploads endpoint.
     *
     * @var string
     */
    public static $uploadBaseUrl = 'https://uploads.stripe.com';

    /**
     * The version of the Stripe API to use for requests.
     *
     * @var string|null
     */
    public static $apiVersion    = null;

    /**
     * The account ID for connected accounts requests.
     *
     * @var string|null
     */
    public static $accountId     = null;

    /**
     * Verify SSL Certs.
     *
     * @var bool
     */
    public static $verifySslCerts = true;

    /**
     * The application's information (name, version, URL).
     *
     * @var array
     */
    public static $appInfo = [];

    /**
     * The logger instance.
     *
     * @var \Psr\Log\LoggerInterface
     */
    public static $logger = null;

    /* -----------------------------------------------------------------
     |  Getters & Setters
     | -----------------------------------------------------------------
     */

    /**
     * Get the API key used for requests.
     *
     * @return string
     */
    public static function getApiKey()
    {
        return self::$apiKey;
    }

    /**
     * Sets the API key to be used for requests.
     *
     * @param  string  $apiKey
     */
    public static function setApiKey($apiKey)
    {
        self::checkApiKey($apiKey);

        self::$apiKey = $apiKey;
    }

    /**
     * Get API Base URL.
     *
     * @return string
     */
    public static function getApiBaseUrl()
    {
        return self::$apiBaseUrl;
    }

    /**
     * Set API Base URL.
     *
     * @param  string  $apiBaseUrl
     */
    public static function setApiBaseUrl($apiBaseUrl)
    {
        self::checkApiBaseUrl($apiBaseUrl);

        self::$apiBaseUrl = $apiBaseUrl;
    }

    /**
     * The client_id used for Connect requests.
     *
     * @return string
     */
    public static function getClientId()
    {
        return self::$clientId;
    }

    /**
     * Sets the client_id to be used for Connect requests.
     *
     * @param  string  $clientId
     */
    public static function setClientId($clientId)
    {
        self::$clientId = $clientId;
    }

    /**
     * Get Upload Base URL.
     *
     * @return string
     */
    public static function getUploadBaseUrl()
    {
        return self::$uploadBaseUrl;
    }

    /**
     * Set Upload Base URL.
     *
     * @param  string  $uploadBaseUrl
     */
    public static function setUploadBaseUrl($uploadBaseUrl)
    {
        self::checkUploadBaseUrl($uploadBaseUrl);

        self::$uploadBaseUrl = $uploadBaseUrl;
    }

    /**
     * The API version used for requests. null if we're using the latest version.
     *
     * @return string
     */
    public static function getApiVersion()
    {
        return self::$apiVersion;
    }

    /**
     * The API version used for requests. null if we're using the latest version.
     *
     * @return string
     */
    public static function version()
    {
        return self::getApiVersion();
    }

    /**
     * Sets the API version to use for requests.
     *
     * @param  string  $apiVersion
     */
    public static function setApiVersion($apiVersion)
    {
        self::checkApiVersion($apiVersion);

        self::$apiVersion = $apiVersion;
    }

    /**
     * Get the Stripe account ID for connected accounts requests.
     *
     * @return string|null
     */
    public static function getAccountId()
    {
        return self::$accountId;
    }

    /**
     * Set the Stripe account ID to set for connected accounts requests.
     *
     * @param  string  $accountId
     */
    public static function setAccountId($accountId)
    {
        self::$accountId = $accountId;
    }

    /**
     * Get Verify SSL Certs.
     *
     * @return bool
     */
    public static function getVerifySslCerts()
    {
        return self::$verifySslCerts;
    }

    /**
     * Sets Verify SSL Certs.
     *
     * @param  bool  $verify
     */
    public static function setVerifySslCerts($verify)
    {
        self::$verifySslCerts = validate_bool($verify);
    }

    /**
     * Get the Application's information.
     *
     * @return array
     */
    public static function getAppInfo()
    {
        return self::$appInfo;
    }

    /**
     * Set the Application's information.
     *
     * @param  string  $name     The application's name
     * @param  string  $version  The application's version
     * @param  string  $url      The application's URL
     */
    public static function setAppInfo($name, $version = null, $url = null)
    {
        self::$appInfo = compact('name', 'version', 'url');
    }

    /**
     * Get the logger instance.
     *
     * @return \Psr\Log\LoggerInterface
     */
    public static function getLogger()
    {
        if (is_null(self::$logger))
            return new Utilities\DefaultLogger;

        return self::$logger;
    }

    /**
     * Set the logger instance.
     *
     * @param  \Psr\Log\LoggerInterface  $logger
     */
    public static function setLogger(LoggerInterface $logger)
    {
        self::$logger = $logger;
    }

    /* -----------------------------------------------------------------
     |  Main Methods
     | -----------------------------------------------------------------
     */

    /**
     * Init Stripe.
     *
     * @param  string  $apiKey
     */
    public static function init($apiKey)
    {
        self::setApiKey($apiKey);
    }

    /* -----------------------------------------------------------------
     |  Check Methods
     | -----------------------------------------------------------------
     */

    /**
     * Check API Key.
     *
     * @param  string  $apiKey
     *
     * @throws \Arcanedev\Stripe\Exceptions\ApiException
     * @throws \Arcanedev\Stripe\Exceptions\ApiKeyNotSetException
     */
    private static function checkApiKey(&$apiKey)
    {
        if ( ! is_string($apiKey))
            throw new ApiException('The API KEY must be a string value.', 500);

        $apiKey = trim($apiKey);

        if (empty($apiKey))
            throw new ApiKeyNotSetException('You must specify your api key to use stripe.');
    }

    /**
     * Check API Base URL.
     *
     * @param  string  $apiBaseUrl
     *
     * @throws \Arcanedev\Stripe\Exceptions\ApiException
     */
    private static function checkApiBaseUrl($apiBaseUrl)
    {
        if ( ! is_string($apiBaseUrl))
            throw new ApiException(
                'The API base URL be string value. '.gettype($apiBaseUrl).' is given.', 500
            );

        if ( ! validate_url($apiBaseUrl))
            throw new ApiException('The API base URL is not a valid URL.', 500);
    }

    /**
     * Check Upload Base URL.
     *
     * @param  string  $uploadBaseUrl
     *
     * @throws \Arcanedev\Stripe\Exceptions\ApiException
     */
    private static function checkUploadBaseUrl($uploadBaseUrl)
    {
        if ( ! is_string($uploadBaseUrl)) {
            throw new ApiException(
                'The Upload base URL be string value. '.gettype($uploadBaseUrl).' is given.', 500
            );
        }

        if ( ! validate_url($uploadBaseUrl))
            throw new ApiException('The Upload base URL is not a valid URL.', 500);
    }

    /**
     * Check API Version.
     *
     * @param  string|null  $apiVersion
     *
     * @throws \Arcanedev\Stripe\Exceptions\ApiException
     */
    private static function checkApiVersion(&$apiVersion)
    {
        if (
            ! is_null($apiVersion) &&
            ! is_string($apiVersion)
        )
            throw new ApiException(
                'The API version must be a null or string value. '.gettype($apiVersion).' is given.', 500
            );

        if (is_null($apiVersion)) return;

        $apiVersion = trim($apiVersion);

        if ( ! validate_version($apiVersion))
            throw new ApiException('The API version must valid a semantic version [x.x.x].', 500);
    }

    /**
     * Check if API version exists.
     *
     * @return bool
     */
    public static function hasApiVersion()
    {
        return ! empty(self::$apiVersion);
    }

    /**
     * Check if the Stripe has account ID for connected accounts requests.
     *
     * @return bool
     */
    public static function hasAccountId()
    {
        return ! empty(self::$accountId);
    }
}