Arcanedev\Stripe\Http\Curl\HttpClient

Complexity

Total Complexity

51

Size/Duplication

Total Lines	492
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	5

Test Coverage

Coverage

70.59%

Importance

Changes	2
Bugs	0	Features	0

23 Methods

Rating	Name	Duplication	Size	Complexity
A	__destruct()	0	4	1
A	getTimeout()	0	4	1
A	getConnectTimeout()	0	4	1
A	init()	0	4	1
A	processResourceParams()	0	18	4
A	__construct()	0	6	1
A	setApiKey()	0	6	1
A	setApiBaseUrl()	0	6	1
A	setTimeout()	0	6	1
A	setConnectTimeout()	0	6	1
A	setOptionArray()	0	6	1
A	execute()	0	6	1
A	close()	0	6	2
A	instance()	0	8	2
B	request()	0	30	3
A	checkCertErrors()	0	16	2
A	processResourceParam()	0	13	2
D	encode()	0	30	10
A	checkResourceType()	0	8	2
A	checkResourceMetaData()	0	8	2
A	checkHasResourceFile()	0	6	3
A	checkResponse()	0	7	2
B	handleCurlError()	0	29	6

<?php namespace Arcanedev\Stripe\Http\Curl;

use Arcanedev\Stripe\Contracts\Http\Curl\HttpClientInterface;
use Arcanedev\Stripe\Exceptions\ApiConnectionException;
use Arcanedev\Stripe\Exceptions\ApiException;
use CURLFile;

/**
 * Class     HttpClient
 *
 * @package  Arcanedev\Stripe\Utilities\Request
 * @author   ARCANEDEV <arcanedev.maroc@gmail.com>
 */
class HttpClient implements HttpClientInterface
{
    /* ------------------------------------------------------------------------------------------------
     |  Constants
     | ------------------------------------------------------------------------------------------------
     */
    const DEFAULT_TIMEOUT = 80;
    const DEFAULT_CONNECT_TIMEOUT = 30;

    /* ------------------------------------------------------------------------------------------------
     |  Properties
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * The HTTP Client instance.
     *
     * @var HttpClient
     */
    private static $instance;

    /**
     * @var string
     */
    private $apiKey;

    /**
     * @var string
     */
    private $apiBaseUrl;

    /**
     * @var HeaderBag
     */
    private $headers;

    /**
     * @var CurlOptions
     */
    private $options;

    /**
     * @var resource
     */
    private $curl;

    /**
     * @var int
     */
    private $timeout = self::DEFAULT_TIMEOUT;

    /**
     * @var int
     */
    private $connectTimeout = self::DEFAULT_CONNECT_TIMEOUT;

    /**
     * @var mixed
     */
    private $response;

    /**
     * @var int
     */
    private $errorCode;

    /**
     * @var string
     */
    private $errorMessage;

    /* ------------------------------------------------------------------------------------------------
     |  Constructor & Destructor
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Create a HttpClient instance.
     */
    private function __construct()
    {
        $this->headers  = new HeaderBag;
        $this->options  = new CurlOptions;
        $this->response = null;
    }

    /**
     * Destroy the instance.
     */
    public function __destruct()
    {
        $this->close();
    }

    /* ------------------------------------------------------------------------------------------------
     |  Getters & Setters
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Set API Key.
     *
     * @param  string  $apiKey
     *
     * @return self
     */
    public function setApiKey($apiKey)
    {
        $this->apiKey = $apiKey;

        return $this;
    }

    /**
     * Set Base URL.
     *
     * @param  string  $apiBaseUrl
     *
     * @return self
     */
    public function setApiBaseUrl($apiBaseUrl)
    {
        $this->apiBaseUrl = $apiBaseUrl;

        return $this;
    }

    /**
     * Get the timeout.
     *
     * @return int
     */
    public function getTimeout()
    {
        return $this->timeout;
    }

    /**
     * Set the timeout.
     *
     * @param  int  $seconds
     *
     * @return self
     */
    public function setTimeout($seconds)
    {
        $this->timeout = (int) max($seconds, 0);

        return $this;
    }

    /**
     * Get the connect timeout.
     *
     * @return int
     */
    public function getConnectTimeout()
    {
        return $this->connectTimeout;
    }

    /**
     * Set the connect timeout.
     *
     * @param  int  $seconds
     *
     * @return self
     */
    public function setConnectTimeout($seconds)
    {
        $this->connectTimeout = (int) max($seconds, 0);

        return $this;
    }

    /**
     * Set array options.
     *
     * @param  array  $options
     *
     * @return self
     */
    public function setOptionArray(array $options)
    {
        curl_setopt_array($this->curl, $options);

        return $this;
    }

    /* ------------------------------------------------------------------------------------------------
     |  Curl Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Init curl.
     */
    private function init()
    {
        $this->curl = curl_init();
    }

    /**
     * Execute curl.
     */
    private function execute()
    {
        $this->response     = curl_exec($this->curl);
        $this->errorCode    = curl_errno($this->curl);
        $this->errorMessage = curl_error($this->curl);
    }

    /**
     * Close curl.
     */
    private function close()
    {
        if (is_resource($this->curl)) {
            curl_close($this->curl);
        }
    }

    /* ------------------------------------------------------------------------------------------------
     |  Main Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Get the HTTP.
     *
     * @return self
     */
    public static function instance()
    {
        if ( ! self::$instance) {
            self::$instance = new self;
        }

        return self::$instance;
    }

    /**
     * Curl the request.
     *
     * @param  string        $method
     * @param  string        $url
     * @param  array|string  $params
     * @param  array         $headers
     *
     * @throws ApiConnectionException
     * @throws ApiException
     *
     * @return array
     */
    public function request($method, $url, $params, $headers)
    {
        $hasFile = self::processResourceParams($params);

        if ($method !== 'post') {
            $url    = str_parse_url($url, $params);
        }
        else {
            $params = $hasFile ? $params : str_url_queries($params);
        }

        $this->headers->prepare($this->apiKey, $headers, $hasFile);
        $this->options->make($method, $url, $params, $this->headers->get(), $hasFile);
        $this->options->setOptions([
            CURLOPT_CONNECTTIMEOUT => $this->connectTimeout,
            CURLOPT_TIMEOUT        => $this->timeout,
        ]);

        $this->init();
        $this->setOptionArray($this->options->get());
        $this->execute();

        $this->checkCertErrors();
        $this->checkResponse();

        $statusCode = curl_getinfo($this->curl, CURLINFO_HTTP_CODE);
        $this->close();

        return [$this->response, $statusCode];
    }

    /**
     * Check Cert Errors.
     */
    private function checkCertErrors()
    {
        if (SslChecker::hasCertErrors($this->errorCode)) {
            $this->headers->set(
                'X-Stripe-Client-Info',
                '{"ca":"using Stripe-supplied CA bundle"}'
            );

            $this->setOptionArray([
                CURLOPT_HTTPHEADER => $this->headers->get(),
                CURLOPT_CAINFO     => SslChecker::caBundle()
            ]);

            $this->execute();
        }
    }

    /**
     * Process Resource Parameters.
     *
     * @param  array|string  $params
     *
     * @throws ApiException
     *
     * @return bool
     */
    private static function processResourceParams(&$params)
    {
        // @codeCoverageIgnoreStart
        if ( ! is_array($params)) return false;
        // @codeCoverageIgnoreEnd

        $hasFile = false;

        foreach ($params as $key => $resource) {
            $hasFile = self::checkHasResourceFile($resource);

            if (is_resource($resource)) {
                $params[$key] = self::processResourceParam($resource);
            }
        }

        return $hasFile;
    }

    /**
     * Process Resource Parameter.
     *
     * @param  resource  $resource
     *
     * @throws ApiException
     *
     * @return CURLFile|string
     */
    private static function processResourceParam($resource)
    {
        self::checkResourceType($resource);

        $metaData = stream_get_meta_data($resource);

        self::checkResourceMetaData($metaData);

        // We don't have the filename or mimetype, but the API doesn't care
        return class_exists('CURLFile')
            ? new CURLFile($metaData['uri'])
            : '@' . $metaData['uri'];
    }

    /**
     * Encode array to query string
     *
     * @param  array        $array
     * @param  string|null  $prefix
     *
     * @return string
     */
    protected static function encode($array, $prefix = null)
    {
        // @codeCoverageIgnoreStart
        if ( ! is_array($array)) return $array;
        // @codeCoverageIgnoreEnd

        $result = [];

        foreach ($array as $key => $value) {
            if (is_null($value)) {
                continue;
            }

            if ($prefix && $key && ! is_int($key)) {
                $key = $prefix .'[' . $key . ']';
            }
            elseif ($prefix) {
                $key = $prefix . '[]';
            }

            if ( ! is_array($value)) {
                $result[] = urlencode($key) . '=' . urlencode($value);
            }
            elseif ($enc = self::encode($value, $key)) {
                $result[] = $enc;
            }
        }

        return implode('&', $result);
    }

    /* ------------------------------------------------------------------------------------------------
     |  Check Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Check Resource type is stream.
     *
     * @param  resource  $resource
     *
     * @throws ApiException
     */
    private static function checkResourceType($resource)
    {
        if (get_resource_type($resource) !== 'stream') {
            throw new ApiException(
                'Attempted to upload a resource that is not a stream'
            );
        }
    }

    /**
     * Check resource MetaData.
     *
     * @param  array  $metaData
     *
     * @throws ApiException
     */
    private static function checkResourceMetaData(array $metaData)
    {
        if ($metaData['wrapper_type'] !== 'plainfile') {
            throw new ApiException(
                'Only plainfile resource streams are supported'
            );
        }
    }

    /**
     * Check if param is resource File.
     *
     * @param  mixed  $resource
     *
     * @return bool
     */
    private static function checkHasResourceFile($resource)
    {
        return
            is_resource($resource) ||
            (class_exists('CURLFile') && $resource instanceof CURLFile);
    }

    /* ------------------------------------------------------------------------------------------------
     |  Other Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Check Response.
     *
     * @throws ApiConnectionException
     */
    private function checkResponse()
    {
        if ($this->response !== false) return;

        $this->close();
        $this->handleCurlError();
    }

    /**
     * Handle CURL errors.
     *
     * @throws ApiConnectionException
     */
    private function handleCurlError()
    {
        switch ($this->errorCode) {
            case CURLE_COULDNT_CONNECT:
            case CURLE_COULDNT_RESOLVE_HOST:
            case CURLE_OPERATION_TIMEOUTED:
                $msg = 'Could not connect to Stripe (' . $this->apiBaseUrl . '). Please check your internet connection '
                    . 'and try again.  If this problem persists, you should check Stripe\'s service status at '
                    . 'https://twitter.com/stripestatus, or';
                break;

            case CURLE_SSL_CACERT:
            case CURLE_SSL_PEER_CERTIFICATE:
                $msg = 'Could not verify Stripe\'s SSL certificate.  Please make sure that your network is not '
                    . 'intercepting certificates. (Try going to ' . $this->apiBaseUrl . ' in your browser.) '
                    . 'If this problem persists,';
                break;

            default:
                $msg = 'Unexpected error communicating with Stripe. If this problem persists,';
                // no break
        }

        $msg .= ' let us know at support@stripe.com.';

        $msg .= "\n\n(Network error [errno {$this->errorCode}]: {$this->errorMessage})";

        throw new ApiConnectionException($msg);
    }
}