Requestor::checkResourceMetaData() - Code Metrics - Inspection of "Merge pull request #43 from ARCANEDEV/update-json-..." - ARCANEDEV/Stripe - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a1bae7...4ea284 )

by ARCANEDEV

created 2017-02-28 16:34 UTC

Requestor::checkResourceMetaData() A

↳ Parent: Requestor

Complexity

Conditions	2
Paths	2

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	2

Importance

Changes

Metric	Value
cc	2
eloc	3
nc	2
nop	1
dl	0
loc	5
ccs	4
cts	4
cp	1
crap	2
rs	9.4285
c	0
b	0
f	0

<?php namespace Arcanedev\Stripe\Http;

use Arcanedev\Stripe\Contracts\Http\Curl\HttpClient as HttpClientContract;
use Arcanedev\Stripe\Contracts\Http\Requestor as RequestorContract;
use Arcanedev\Stripe\Exceptions\ApiException;
use Arcanedev\Stripe\Exceptions\ApiKeyNotSetException;
use Arcanedev\Stripe\Http\Curl\HttpClient;
use Arcanedev\Stripe\Stripe;
use Arcanedev\Stripe\StripeResource;
use Arcanedev\Stripe\Utilities\ErrorsHandler;
use CURLFile;

/**
 * Class     Requestor
 *
 * @package  Arcanedev\Stripe\Http
 * @author   ARCANEDEV <[email protected]>
 */
class Requestor implements RequestorContract
{
    /* ------------------------------------------------------------------------------------------------
     |  Properties
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * The API key that's to be used to make requests.
     *
     * @var string
     */
    private $apiKey;

    /**
     * The API base URL.
     *
     * @var string
     */
    private $apiBaseUrl;

    /**
     * @var \Arcanedev\Stripe\Contracts\Http\Curl\HttpClient
     */
    private static $httpClient;

    /**
     * The allowed HTTP methods.
     *
     * @var array
     */
    private static $allowedMethods = ['get', 'post', 'delete'];

    /**
     * @var \Arcanedev\Stripe\Utilities\ErrorsHandler
     */
    private $errorsHandler;

    /* ------------------------------------------------------------------------------------------------
     |  Getters & Setters
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Create Requestor instance.
     *
     * @param  string|null  $apiKey
     * @param  string|null  $apiBase
     */
    public function __construct($apiKey = null, $apiBase = null)
    {
        $this->setApiKey($apiKey);
        $this->setApiBase($apiBase);
        $this->errorsHandler = new ErrorsHandler;
    }

    /* ------------------------------------------------------------------------------------------------
     |  Getters & Setters
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Get Stripe API Key.
     *
     * @return string
     */
    public function getApiKey()
    {
        if ( ! $this->apiKey)
            $this->setApiKey(Stripe::getApiKey());

        return trim($this->apiKey);
    }

    /**
     * Set API Key.
     *
     * @param  string  $apiKey
     *
     * @return self
     */
    private function setApiKey($apiKey)
    {
        $this->apiKey = $apiKey;

        return $this;
    }

    /**
     * Set API Base URL.
     *
     * @param  string|null  $apiBaseUrl
     *
     * @return self
     */
    private function setApiBase($apiBaseUrl)
    {
        if (empty($apiBaseUrl))
            $apiBaseUrl = Stripe::getApiBaseUrl();

        $this->apiBaseUrl = $apiBaseUrl;

        return $this;
    }

    /**
     * Get the HTTP client.
     *
     * @return \Arcanedev\Stripe\Contracts\Http\Curl\HttpClient
     */
    private function httpClient()
    {
        // @codeCoverageIgnoreStart
        if ( ! self::$httpClient)
            self::$httpClient = HttpClient::instance();
        // @codeCoverageIgnoreEnd

        return self::$httpClient;
    }

    /**
     * Set the HTTP client.
     *
     * @param  \Arcanedev\Stripe\Contracts\Http\Curl\HttpClient $client
     */
    public static function setHttpClient(HttpClientContract $client)
    {
        self::$httpClient = $client;
    }

    /* ------------------------------------------------------------------------------------------------
     |  Request Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Make Requestor instance.
     *
     * @param  string|null  $apiKey
     * @param  string       $apiBase
     *
     * @return self
     */
    public static function make($apiKey = null, $apiBase = '')
    {
        return new self($apiKey, $apiBase);
    }

    /**
     * GET Request.
     *
     * @param  string      $url
     * @param  array|null  $params
     * @param  array|null  $headers
     *
     * @return array
     */
    public function get($url, $params = [], $headers = null)
    {
        return $this->request('get', $url, $params, $headers);
    }

    /**
     * POST Request.
     *
     * @param  string      $url
     * @param  array|null  $params
     * @param  array|null  $headers
     *
     * @return array
     */
    public function post($url, $params = [], $headers = null)
    {
        return $this->request('post', $url, $params, $headers);
    }

    /**
     * DELETE Request.
     *
     * @param  string      $url
     * @param  array|null  $params
     * @param  array|null  $headers
     *
     * @return array
     */
    public function delete($url, $params = [], $headers = null)
    {
        return $this->request('delete', $url, $params, $headers);
    }

    /**
     * Make a request.
     * Note: An array whose first element is the Response object and second element is the API key used to make the request.
     *
     * @param  string      $method
     * @param  string      $url
     * @param  array|null  $params
     * @param  array|null  $headers
     *
     * @return array
     */
    public function request($method, $url, $params = null, $headers = null)
    {
        if (is_null($params))  $params  = [];
        if (is_null($headers)) $headers = [];

        list($respBody, $respCode, $respHeaders, $apiKey) = $this->requestRaw($method, $url, $params, $headers);

        $json     = $this->interpretResponse($respBody, $respCode, $respHeaders);
        $response = new Response($respBody, $respCode, $headers, $json);

        return [$response, $apiKey];
    }

    /**
     * Raw request.
     *
     * @param  string  $method
     * @param  string  $url
     * @param  array   $params
     * @param  array   $headers
     *
     * @return array
     */
    private function requestRaw($method, $url, $params, $headers)
    {
        $this->checkApiKey();
        $this->checkMethod($method);

        $this->httpClient()->setApiKey($this->getApiKey());

        $params  = self::encodeObjects($params);
        $hasFile = self::processResourceParams($params);

        list($respBody, $respCode, $respHeaders) = $this->httpClient()
            ->request($method, $this->apiBaseUrl.$url, $params, $headers, $hasFile);

        return [$respBody, $respCode, $respHeaders, $this->getApiKey()];
    }

    /**
     * Interpret Response.
     *
     * @param  string  $respBody
     * @param  int     $respCode
     * @param  array   $respHeaders
     *
     * @return array
     *
     * @throws \Arcanedev\Stripe\Exceptions\ApiException
     */
    private function interpretResponse($respBody, $respCode, $respHeaders)
    {
        $response  = json_decode($respBody, true);
        $jsonError = json_last_error();

        if ($response === null && $jsonError !== JSON_ERROR_NONE) {
            throw new ApiException(
                "Invalid response body from API: $respBody ".
                "(HTTP response code was $respCode, json_last_error() was $jsonError)",
                500, 'api_error', null, $respBody
            );
        }

        if ($respCode < 200 || $respCode >= 300) {
            $this->errorsHandler->handle($respBody, $respCode, $respHeaders, $response);
        }

        return $response;
    }

    /* ------------------------------------------------------------------------------------------------
     |  Check Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Check if API Key Exists.
     *
     * @throws \Arcanedev\Stripe\Exceptions\ApiKeyNotSetException
     */
    private function checkApiKey()
    {
        if ( ! $this->isApiKeyExists())
            throw new ApiKeyNotSetException('The Stripe API Key is required !');
    }

    /**
     * Check if the API Key is set.
     *
     * @return bool
     */
    private function isApiKeyExists()
    {
        return ! empty($this->getApiKey());
    }

    /**
     * Check Http Method.
     *
     * @param  string  $method
     *
     * @throws \Arcanedev\Stripe\Exceptions\ApiException
     */
    private function checkMethod(&$method)
    {
        if ( ! in_array($method = strtolower($method), self::$allowedMethods))
            throw new ApiException(
                "Unrecognized method $method, must be [".implode(', ', self::$allowedMethods).'].',
                500
            );
    }

    /**
     * Check Resource type is stream.
     *
     * @param  resource  $resource
     *
     * @throws \Arcanedev\Stripe\Exceptions\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 \Arcanedev\Stripe\Exceptions\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
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Process Resource Parameters.
     *
     * @param  array|string  $params
     *
     * @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
     *
     * @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 Objects.
     *
     * @param  \Arcanedev\Stripe\StripeResource|bool|array|string  $obj
     *
     * @throws \Arcanedev\Stripe\Exceptions\ApiException
     *
     * @return array|string
     */
    private static function encodeObjects($obj)
    {
        if ($obj instanceof StripeResource)
            return str_utf8($obj->id);

        if (is_bool($obj))
            return $obj ? 'true' : 'false';

        if (is_array($obj))
            return array_map(function($v) {
                return self::encodeObjects($v);
            }, $obj);

        return str_utf8($obj);
    }
}


1		<?php namespace Arcanedev\Stripe\Http;
2
3		use Arcanedev\Stripe\Contracts\Http\Curl\HttpClient as HttpClientContract;
4		use Arcanedev\Stripe\Contracts\Http\Requestor as RequestorContract;
5		use Arcanedev\Stripe\Exceptions\ApiException;
6		use Arcanedev\Stripe\Exceptions\ApiKeyNotSetException;
7		use Arcanedev\Stripe\Http\Curl\HttpClient;
8		use Arcanedev\Stripe\Stripe;
9		use Arcanedev\Stripe\StripeResource;
10		use Arcanedev\Stripe\Utilities\ErrorsHandler;
11		use CURLFile;
12
13		/**
14		* Class Requestor
15		*
16		* @package Arcanedev\Stripe\Http
17		* @author ARCANEDEV <[email protected]>
18		*/
19		class Requestor implements RequestorContract
20		{
21		/* ------------------------------------------------------------------------------------------------
22		\| Properties
23		\| ------------------------------------------------------------------------------------------------
24		*/
25		/**
26		* The API key that's to be used to make requests.
27		*
28		* @var string
29		*/
30		private $apiKey;
31
32		/**
33		* The API base URL.
34		*
35		* @var string
36		*/
37		private $apiBaseUrl;
38
39		/**
40		* @var \Arcanedev\Stripe\Contracts\Http\Curl\HttpClient
41		*/
42		private static $httpClient;
43
44		/**
45		* The allowed HTTP methods.
46		*
47		* @var array
48		*/
49		private static $allowedMethods = ['get', 'post', 'delete'];
50
51		/**
52		* @var \Arcanedev\Stripe\Utilities\ErrorsHandler
53		*/
54		private $errorsHandler;
55
56		/* ------------------------------------------------------------------------------------------------
57		\| Getters & Setters
58		\| ------------------------------------------------------------------------------------------------
59		*/
60		/**
61		* Create Requestor instance.
62		*
63		* @param string\|null $apiKey
64		* @param string\|null $apiBase
65		*/
66		public function __construct($apiKey = null, $apiBase = null)
67	355	{
68		$this->setApiKey($apiKey);
69	355	$this->setApiBase($apiBase);
70	355	$this->errorsHandler = new ErrorsHandler;
71	355	}
72	355
73		/* ------------------------------------------------------------------------------------------------
74		\| Getters & Setters
75		\| ------------------------------------------------------------------------------------------------
76		*/
77		/**
78		* Get Stripe API Key.
79		*
80		* @return string
81		*/
82		public function getApiKey()
83	346	{
84		if ( ! $this->apiKey)
85	346	$this->setApiKey(Stripe::getApiKey());
86	345
87		return trim($this->apiKey);
88	346	}
89
90		/**
91		* Set API Key.
92		*
93		* @param string $apiKey
94		*
95		* @return self
96		*/
97		private function setApiKey($apiKey)
98	355	{
99		$this->apiKey = $apiKey;
100	355
101		return $this;
102	355	}
103
104		/**
105		* Set API Base URL.
106		*
107		* @param string\|null $apiBaseUrl
108		*
109		* @return self
110		*/
111		private function setApiBase($apiBaseUrl)
112	355	{
113		if (empty($apiBaseUrl))
114	355	$apiBaseUrl = Stripe::getApiBaseUrl();
115	183
116		$this->apiBaseUrl = $apiBaseUrl;
117	355
118		return $this;
119	355	}
120
121		/**
122		* Get the HTTP client.
123		*
124		* @return \Arcanedev\Stripe\Contracts\Http\Curl\HttpClient
125		*/
126		private function httpClient()
127	346	{
128		// @codeCoverageIgnoreStart
129		if ( ! self::$httpClient)
130		self::$httpClient = HttpClient::instance();
131		// @codeCoverageIgnoreEnd
132
133		return self::$httpClient;
134	346	}
135
136		/**
137		* Set the HTTP client.
138		*
139		* @param \Arcanedev\Stripe\Contracts\Http\Curl\HttpClient $client
140		*/
141		public static function setHttpClient(HttpClientContract $client)
142	605	{
143		self::$httpClient = $client;
144	605	}
145	605
146		/* ------------------------------------------------------------------------------------------------
147		\| Request Functions
148		\| ------------------------------------------------------------------------------------------------
149		*/
150		/**
151		* Make Requestor instance.
152		*
153		* @param string\|null $apiKey
154		* @param string $apiBase
155		*
156		* @return self
157		*/
158		public static function make($apiKey = null, $apiBase = '')
159	344	{
160		return new self($apiKey, $apiBase);
161	344	}
162
163		/**
164		* GET Request.
165		*
166		* @param string $url
167		* @param array\|null $params
168		* @param array\|null $headers
169		*
170		* @return array
171		*/
172		public function get($url, $params = [], $headers = null)
173	162	{
174		return $this->request('get', $url, $params, $headers);
175	162	}
176
177		/**
178		* POST Request.
179		*
180		* @param string $url
181		* @param array\|null $params
182		* @param array\|null $headers
183		*
184		* @return array
185		*/
186		public function post($url, $params = [], $headers = null)
187	18	{
188		return $this->request('post', $url, $params, $headers);
189	18	}
190
191		/**
192		* DELETE Request.
193		*
194		* @param string $url
195		* @param array\|null $params
196		* @param array\|null $headers
197		*
198		* @return array
199		*/
200		public function delete($url, $params = [], $headers = null)
201		{
202		return $this->request('delete', $url, $params, $headers);
203		}
204
205		/**
206		* Make a request.
207		* Note: An array whose first element is the Response object and second element is the API key used to make the request.
208		*
209		* @param string $method
210		* @param string $url
211		* @param array\|null $params
212		* @param array\|null $headers
213		*
214		* @return array
215		*/
216		public function request($method, $url, $params = null, $headers = null)
217	344	{
218		if (is_null($params)) $params = [];
219	344	if (is_null($headers)) $headers = [];
220	344
221		list($respBody, $respCode, $respHeaders, $apiKey) = $this->requestRaw($method, $url, $params, $headers);
222	344
223		$json = $this->interpretResponse($respBody, $respCode, $respHeaders);
224	344	$response = new Response($respBody, $respCode, $headers, $json);
225	328
226		return [$response, $apiKey];
227	328	}
228
229		/**
230		* Raw request.
231		*
232		* @param string $method
233		* @param string $url
234		* @param array $params
235		* @param array $headers
236		*
237		* @return array
238		*/
239		private function requestRaw($method, $url, $params, $headers)
240	344	{
241		$this->checkApiKey();
242	344	$this->checkMethod($method);
243	344
244		$this->httpClient()->setApiKey($this->getApiKey());
245	344
246		$params = self::encodeObjects($params);
247	344	$hasFile = self::processResourceParams($params);
248	344
249		list($respBody, $respCode, $respHeaders) = $this->httpClient()
250	344	->request($method, $this->apiBaseUrl.$url, $params, $headers, $hasFile);
251	344
252		return [$respBody, $respCode, $respHeaders, $this->getApiKey()];
253	344	}
254
255		/**
256		* Interpret Response.
257		*
258		* @param string $respBody
259		* @param int $respCode
260		* @param array $respHeaders
261		*
262		* @return array
263		*
264		* @throws \Arcanedev\Stripe\Exceptions\ApiException
265		*/
266		private function interpretResponse($respBody, $respCode, $respHeaders)
267	346	{
268		$response = json_decode($respBody, true);
269		$jsonError = json_last_error();
270	346
271		if ($response === null && $jsonError !== JSON_ERROR_NONE) {
272	346	throw new ApiException(
273		"Invalid response body from API: $respBody ".
274	174	"(HTTP response code was $respCode, json_last_error() was $jsonError)",
275	2	500, 'api_error', null, $respBody
276	2	);
277	2	}
278	1
279		if ($respCode < 200 \|\| $respCode >= 300) {
280		$this->errorsHandler->handle($respBody, $respCode, $respHeaders, $response);
281	344	}
282
283	328	return $response;
284		}
285
286		/* ------------------------------------------------------------------------------------------------
287		\| Check Functions
288		\| ------------------------------------------------------------------------------------------------
289		*/
290		/**
291		* Check if API Key Exists.
292		*
293		* @throws \Arcanedev\Stripe\Exceptions\ApiKeyNotSetException
294		*/
295	346	private function checkApiKey()
296		{
297	346	if ( ! $this->isApiKeyExists())
298	174	throw new ApiKeyNotSetException('The Stripe API Key is required !');
299	344	}
300
301		/**
302		* Check if the API Key is set.
303		*
304		* @return bool
305		*/
306	346	private function isApiKeyExists()
307		{
308	346	return ! empty($this->getApiKey());
309		}
310
311		/**
312		* Check Http Method.
313		*
314		* @param string $method
315		*
316		* @throws \Arcanedev\Stripe\Exceptions\ApiException
317		*/
318	345	private function checkMethod(&$method)
319		{
320	345	if ( ! in_array($method = strtolower($method), self::$allowedMethods))
321	173	throw new ApiException(
322	1	"Unrecognized method $method, must be [".implode(', ', self::$allowedMethods).'].',
323		500
324	1	);
325	344	}
326
327		/**
328		* Check Resource type is stream.
329		*
330		* @param resource $resource
331		*
332		* @throws \Arcanedev\Stripe\Exceptions\ApiException
333		*/
334	4	private static function checkResourceType($resource)
335		{
336	4	if (get_resource_type($resource) !== 'stream')
337	2	throw new ApiException('Attempted to upload a resource that is not a stream');
338	4	}
339
340		/**
341		* Check resource MetaData.
342		*
343		* @param array $metaData
344		*
345		* @throws \Arcanedev\Stripe\Exceptions\ApiException
346		*/
347	4	private static function checkResourceMetaData(array $metaData)
348		{
349	4	if ($metaData['wrapper_type'] !== 'plainfile')
350	2	throw new ApiException('Only plainfile resource streams are supported');
351	4	}
352
353		/**
354		* Check if param is resource File.
355		*
356		* @param mixed $resource
357		*
358		* @return bool
359		*/
360	284	private static function checkHasResourceFile($resource)
361		{
362		return
363	284	is_resource($resource) \|\|
364	284	(class_exists('CURLFile') && $resource instanceof CURLFile);
365		}
366
367		/* ------------------------------------------------------------------------------------------------
368		\| Other Functions
369		\| ------------------------------------------------------------------------------------------------
370		*/
371		/**
372		* Process Resource Parameters.
373		*
374		* @param array\|string $params
375		*
376		* @return bool
377		*/
378	344	private static function processResourceParams(&$params)
379		{
380		// @codeCoverageIgnoreStart
381		if ( ! is_array($params)) return false;
382		// @codeCoverageIgnoreEnd
383
384	344	$hasFile = false;
385
386	344	foreach ($params as $key => $resource) {
387	284	$hasFile = self::checkHasResourceFile($resource);
388
389	284	if (is_resource($resource))
390	284	$params[$key] = self::processResourceParam($resource);
391	172	}
392
393	344	return $hasFile;
394		}
395
396		/**
397		* Process Resource Parameter.
398		*
399		* @param resource $resource
400		*
401		* @return \CURLFile\|string
402		*/
403	4	private static function processResourceParam($resource)
404		{
405	4	self::checkResourceType($resource);
406
407	4	$metaData = stream_get_meta_data($resource);
408
409	4	self::checkResourceMetaData($metaData);
410
411		// We don't have the filename or mimetype, but the API doesn't care
412	4	return class_exists('CURLFile') ? new CURLFile($metaData['uri']) : '@'.$metaData['uri'];
413		}
414
415		/**
416		* Encode Objects.
417		*
418		* @param \Arcanedev\Stripe\StripeResource\|bool\|array\|string $obj
419		*
420		* @throws \Arcanedev\Stripe\Exceptions\ApiException
421		*
422		* @return array\|string
423		*/
424	346	private static function encodeObjects($obj)
425		{
426	346	if ($obj instanceof StripeResource)
427	176	return str_utf8($obj->id);
428
429	346	if (is_bool($obj))
430	189	return $obj ? 'true' : 'false';
431
432	346	if (is_array($obj))
433	346	return array_map(function($v) {
434	286	return self::encodeObjects($v);
435	346	}, $obj);
436
437	284	return str_utf8($obj);
438		}
439		}
440

ARCANEDEV / Stripe

Push — master ( a1bae7...4ea284 )

Requestor::checkResourceMetaData() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like