CurlOptions::prepareMethodOptions() - Code Metrics - Inspection of "Adding order returns support" - ARCANEDEV/Stripe - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#18)

by ARCANEDEV

created 2016-06-04 23:26 UTC

CurlOptions::prepareMethodOptions() B

↳ Parent: CurlOptions

Complexity

Conditions	3
Paths	2

Size

Total Lines	25
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	17
CRAP Score	3

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	0
loc	25
ccs	17
cts	17
cp	1
rs	8.8571
cc	3
eloc	15
nc	2
nop	3
crap	3

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

use Arcanedev\Stripe\Contracts\Http\Curl\CurlOptionsInterface;
use Arcanedev\Stripe\Exceptions\ApiException;
use Arcanedev\Stripe\Exceptions\BadMethodCallException;
use Arcanedev\Stripe\Exceptions\InvalidArgumentException;
use Arcanedev\Stripe\Stripe;

/**
 * Class     CurlOptions
 *
 * @package  Arcanedev\Stripe\Http\Curl
 * @author   ARCANEDEV <[email protected]>
 */
class CurlOptions implements CurlOptionsInterface
{
    /* ------------------------------------------------------------------------------------------------
     |  Properties
     | ------------------------------------------------------------------------------------------------
     */
    /** @var array */
    protected $options = [];

    /* ------------------------------------------------------------------------------------------------
     |  Constructor
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Create the CurlOptions instance.
     */
    public function __construct()
    {
        $this->options = [];
    }

    /* ------------------------------------------------------------------------------------------------
     |  Getters & Setters
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Set Options.
     *
     * @param  array  $options
     *
     * @return self
     */
    public function setOptions(array $options)
    {
        foreach($options as $option => $value) {
            $this->setOption($option, $value);
        }

        return $this;
    }

    /**
     * Add Option.
     *
     * @param  int    $option
     * @param  mixed  $value
     *
     * @return self
     */
    public function setOption($option, $value)
    {
        $this->options[$option] = $value;

        return $this;
    }

    /* ------------------------------------------------------------------------------------------------
     |  Main Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Make Curl Options.
     *
     * @param  string  $method
     * @param  string  $url
     * @param  string  $params
     * @param  array   $headers
     * @param  bool    $hasFile
     *
     * @return self
     */
    public function make($method, $url, $params, $headers, $hasFile = false)
    {
        $this->checkMethod($method);

        $this->options = [];

        $this->prepareMethodOptions($method, $params, $hasFile);
        $this->setOptions([
            CURLOPT_URL            => str_utf8($url),
            CURLOPT_RETURNTRANSFER => true,
            CURLOPT_CONNECTTIMEOUT => 30,
            CURLOPT_TIMEOUT        => 80,
            CURLOPT_HTTPHEADER     => $headers,
        ]);

        if ( ! Stripe::$verifySslCerts) {
            $this->setOption(CURLOPT_SSL_VERIFYPEER, false);
        }

        $this->setOption(CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1);

        return $this;
    }

    /**
     * Prepare options based on METHOD.
     *
     * @param  string  $method
     * @param  string  $params
     * @param  bool    $hasFile
     *
     * @throws \Arcanedev\Stripe\Exceptions\ApiException
     */
    private function prepareMethodOptions($method, $params, $hasFile)
    {
        if ($method === 'GET' && $hasFile) {
            throw new ApiException(
                'Issuing a GET request with a file parameter'
            );
        }

        $options = [
            'GET'  => [
                CURLOPT_HTTPGET       => true,
                CURLOPT_CUSTOMREQUEST => 'GET'
            ],
            'POST' => [
                CURLOPT_POST          => true,
                CURLOPT_CUSTOMREQUEST => 'POST',
                CURLOPT_POSTFIELDS    => $params
            ],
            'DELETE' => [
                CURLOPT_CUSTOMREQUEST => 'DELETE'
            ]
        ];

        $this->setOptions($options[$method]);
    }

    /**
     * Get all options.
     *
     * @return array
     */
    public function get()
    {
        return $this->options;
    }

    /* ------------------------------------------------------------------------------------------------
     |  Check Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Check Method.
     *
     * @param  string  $method
     *
     * @throws \Arcanedev\Stripe\Exceptions\BadMethodCallException
     * @throws \Arcanedev\Stripe\Exceptions\InvalidArgumentException
     */
    private function checkMethod(&$method)
    {
        if (! is_string($method)) {
            throw new InvalidArgumentException(
                'The method must be a string value, ' . gettype($method) . ' given',
                500
            );
        }

        $method = strtoupper(trim($method));

        if (! in_array($method, ['GET', 'POST', 'DELETE'])) {
            throw new BadMethodCallException(
                'The method [' . $method . '] is not allowed',
                405
            );
        }
    }
}


1		<?php namespace Arcanedev\Stripe\Http\Curl;
2
3		use Arcanedev\Stripe\Contracts\Http\Curl\CurlOptionsInterface;
4		use Arcanedev\Stripe\Exceptions\ApiException;
5		use Arcanedev\Stripe\Exceptions\BadMethodCallException;
6		use Arcanedev\Stripe\Exceptions\InvalidArgumentException;
7		use Arcanedev\Stripe\Stripe;
8
9		/**
10		* Class CurlOptions
11		*
12		* @package Arcanedev\Stripe\Http\Curl
13		* @author ARCANEDEV <[email protected]>
14		*/
15		class CurlOptions implements CurlOptionsInterface
16		{
17		/* ------------------------------------------------------------------------------------------------
18		\| Properties
19		\| ------------------------------------------------------------------------------------------------
20		*/
21		/** @var array */
22		protected $options = [];
23
24		/* ------------------------------------------------------------------------------------------------
25		\| Constructor
26		\| ------------------------------------------------------------------------------------------------
27		*/
28		/**
29		* Create the CurlOptions instance.
30		*/
31	45	public function __construct()
32		{
33	45	$this->options = [];
34	45	}
35
36		/* ------------------------------------------------------------------------------------------------
37		\| Getters & Setters
38		\| ------------------------------------------------------------------------------------------------
39		*/
40		/**
41		* Set Options.
42		*
43		* @param array $options
44		*
45		* @return self
46		*/
47	674	public function setOptions(array $options)
48		{
49	674	foreach($options as $option => $value) {
50	674	$this->setOption($option, $value);
51	539	}
52
53	674	return $this;
54		}
55
56		/**
57		* Add Option.
58		*
59		* @param int $option
60		* @param mixed $value
61		*
62		* @return self
63		*/
64	674	public function setOption($option, $value)
65		{
66	674	$this->options[$option] = $value;
67
68	674	return $this;
69		}
70
71		/* ------------------------------------------------------------------------------------------------
72		\| Main Functions
73		\| ------------------------------------------------------------------------------------------------
74		*/
75		/**
76		* Make Curl Options.
77		*
78		* @param string $method
79		* @param string $url
80		* @param string $params
81		* @param array $headers
82		* @param bool $hasFile
83		*
84		* @return self
85		*/
86	689	public function make($method, $url, $params, $headers, $hasFile = false)
87		{
88	689	$this->checkMethod($method);
89
90	679	$this->options = [];
91
92	679	$this->prepareMethodOptions($method, $params, $hasFile);
93	674	$this->setOptions([
94	674	CURLOPT_URL => str_utf8($url),
95	674	CURLOPT_RETURNTRANSFER => true,
96	674	CURLOPT_CONNECTTIMEOUT => 30,
97	674	CURLOPT_TIMEOUT => 80,
98	674	CURLOPT_HTTPHEADER => $headers,
99	539	]);
100
101	674	if ( ! Stripe::$verifySslCerts) {
102	5	$this->setOption(CURLOPT_SSL_VERIFYPEER, false);
103	4	}
104
105	674	$this->setOption(CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1);
106
107	674	return $this;
108		}
109
110		/**
111		* Prepare options based on METHOD.
112		*
113		* @param string $method
114		* @param string $params
115		* @param bool $hasFile
116		*
117		* @throws \Arcanedev\Stripe\Exceptions\ApiException
118		*/
119	679	private function prepareMethodOptions($method, $params, $hasFile)
120		{
121	679	if ($method === 'GET' && $hasFile) {
122	5	throw new ApiException(
123	1	'Issuing a GET request with a file parameter'
124	4	);
125		}
126
127		$options = [
128		'GET' => [
129	674	CURLOPT_HTTPGET => true,
130	674	CURLOPT_CUSTOMREQUEST => 'GET'
131	674	],
132		'POST' => [
133	674	CURLOPT_POST => true,
134	674	CURLOPT_CUSTOMREQUEST => 'POST',
135	674	CURLOPT_POSTFIELDS => $params
136	539	],
137		'DELETE' => [
138	674	CURLOPT_CUSTOMREQUEST => 'DELETE'
139	539	]
140	539	];
141
142	674	$this->setOptions($options[$method]);
143	674	}
144
145		/**
146		* Get all options.
147		*
148		* @return array
149		*/
150	679	public function get()
151		{
152	679	return $this->options;
153		}
154
155		/* ------------------------------------------------------------------------------------------------
156		\| Check Functions
157		\| ------------------------------------------------------------------------------------------------
158		*/
159		/**
160		* Check Method.
161		*
162		* @param string $method
163		*
164		* @throws \Arcanedev\Stripe\Exceptions\BadMethodCallException
165		* @throws \Arcanedev\Stripe\Exceptions\InvalidArgumentException
166		*/
167	689	private function checkMethod(&$method)
168		{
169	689	if (! is_string($method)) {
170	5	throw new InvalidArgumentException(
171	5	'The method must be a string value, ' . gettype($method) . ' given',
172	1	500
173	4	);
174		}
175
176	684	$method = strtoupper(trim($method));
177
178	684	if (! in_array($method, ['GET', 'POST', 'DELETE'])) {
179	5	throw new BadMethodCallException(
180	5	'The method [' . $method . '] is not allowed',
181	1	405
182	4	);
183		}
184	679	}
185		}
186

ARCANEDEV / Stripe

Pull Request — master (#18)

CurlOptions::prepareMethodOptions() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like