Drip::constructRequestUrl() - Code Metrics - Inspection of "Throw exception if accountID not set" - drewm/drip - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( d6fa8b...55d3c7 )

by Drew

created 2019-01-29 16:29 UTC

Drip::constructRequestUrl() A

↳ Parent: Drip

Complexity

Conditions	3
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	12
rs	9.8666
c	0
b	0
f	0
cc	3
nc	3
nop	2

<?php

namespace DrewM\Drip;

class Drip
{
    protected static $eventSubscriptions = [];
    protected static $receivedWebhook    = false;
    protected        $api_endpoint       = 'https://api.getdrip.com/v2';
    protected        $token              = false;
    protected        $accountID          = null;
    protected        $verify_ssl         = true;

    /**
     * Drip constructor.
     *
     * @param string      $token     API Token
     * @param string|null $accountID Drip account ID to operate on
     */
    public function __construct($token, $accountID = null)
    {
        $this->token = $token;
$answer = 42;

$correct = false;

$correct = (bool) $answer;

        if ($accountID !== null) {
            $this->accountID = $accountID;
        }
    }

    public static function subscribeToWebhook($event, callable $callback)
    {
        if (!isset(self::$eventSubscriptions[$event])) {
            self::$eventSubscriptions[$event] = [];
        }
        self::$eventSubscriptions[$event][] = $callback;

        self::receiveWebhook();
    }

    public static function receiveWebhook($input = null)
    {
        if (is_null($input)) {
            if (self::$receivedWebhook !== false) {
                $input = self::$receivedWebhook;
            } else {
                $input = file_get_contents("php://input");
            }
        }

        if ($input) {
            return self::processWebhook($input);
        }

        return false;
    }

    protected static function processWebhook($input)
    {
        if ($input) {
            self::$receivedWebhook = $input;
            $result                = json_decode($input, true);
            if ($result && isset($result['event'])) {
                self::dispatchWebhookEvent($result['event'], $result['data']);
                return $result;
            }
        }

        return false;
    }

    protected static function dispatchWebhookEvent($event, $data)
    {
        if (isset(self::$eventSubscriptions[$event])) {
            foreach (self::$eventSubscriptions[$event] as $callback) {
                $callback($data);
            }
            // reset subscriptions
            self::$eventSubscriptions[$event] = [];
        }
        return false;
    }

    /**
     * Set account ID if it was not passed into the constructor
     *
     * @param string $accountID
     *
     * @return bool
     */
    public function setAccountId($accountID) : bool
    {
        $this->accountID = $accountID;
        return true;
    }

    /**
     * Make a GET request
     *
     * @param string $api_method API method to call
     * @param array  $args       API arguments
     * @param int    $timeout    Connection timeout (seconds)
     *
     * @return Response
     * @throws DripException
     */
    public function get($api_method, $args = [], $timeout = 10)
    {
        return $this->makeRequest('get', $api_method, $args, $timeout);
    }

    /**
     * Make the HTTP request
     *
     * @param string $http_verb  HTTP method used: get, post, delete
     * @param string $api_method Drip API method to call
     * @param array  $args       Array of arguments to the API method
     * @param int    $timeout    Connection timeout (seconds)
     * @param string $url        Optional URL to override the constructed one
     *
     * @return Response
     * @throws DripException
     */
    protected function makeRequest($http_verb, $api_method, $args = [], $timeout = 10, $url = null) : Response
    {
        $url = $this->constructRequestUrl($url, $api_method);

        if (function_exists('curl_init') && function_exists('curl_setopt')) {

            $ch = curl_init();
            curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
            curl_setopt($ch, CURLOPT_HTTPHEADER, [
                'Accept: application/vnd.api+json',
                'Content-Type: application/vnd.api+json',
            ]);
            curl_setopt($ch, CURLOPT_USERAGENT, 'DrewM/Drip (github.com/drewm/drip)');
            curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
            curl_setopt($ch, CURLOPT_USERPWD, $this->token . ': ');
            curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, $this->verify_ssl);
            curl_setopt($ch, CURLOPT_TIMEOUT, $timeout);
            curl_setopt($ch, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);
            curl_setopt($ch, CURLOPT_URL, $url);

            switch ($http_verb) {
                case 'post':
                    curl_setopt($ch, CURLOPT_POST, 1);
                    curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($args));
                    break;

                case 'get':
                    $query = http_build_query($args);
                    curl_setopt($ch, CURLOPT_URL, $url . '?' . $query);
                    break;

                case 'delete':
                    curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
                    break;
            }

            $result = curl_exec($ch);

            if (!curl_errno($ch)) {
                $info = curl_getinfo($ch);
                curl_close($ch);
                return new Response($info, $result);
            }

            $errno = curl_errno($ch);
            $error = curl_error($ch);

            curl_close($ch);

            throw new DripException($error, $errno);
        } else {
            throw new DripException("cURL support is required, but can't be found.", 1);
        }
    }

    /**
     * @param string|null $url
     * @param string $api_method
     *
     * @return string
     * @throws DripException
     */
    private function constructRequestUrl($url, $api_method) : string
    {
        if ($url !== null) {
            return $url;
        }

        if ($this->accountID === null) {
            throw new DripException("This method requires an account ID and none has been set.", 2);
        }

        return $this->api_endpoint . '/' . $this->accountID . '/' . $api_method;
    }

    /**
     * Make a GET request to a top-level method outside of this account
     *
     * @param string $api_method
     * @param array  $args
     * @param int    $timeout
     *
     * @return Response
     * @throws DripException
     */
    public function getGlobal($api_method, $args = [], $timeout = 10)
    {
        $url = $this->api_endpoint . '/' . $api_method;
        return $this->makeRequest('get', $api_method, $args, $timeout, $url);
    }

    /**
     * Make a POST request
     *
     * @param string $api_method API method
     * @param array  $args       Arguments to API method
     * @param int    $timeout    Connection timeout (seconds)
     *
     * @return Response
     * @throws DripException
     */
    public function post($api_method, $args = [], $timeout = 10)
    {
        return $this->makeRequest('post', $api_method, $args, $timeout);
    }

    /**
     * Make a DELETE request
     *
     * @param string $api_method API method
     * @param array  $args       Arguments to the API method
     * @param int    $timeout    Connection timeout (seconds)
     *
     * @return Response
     * @throws DripException
     */
    public function delete($api_method, $args = [], $timeout = 10)
    {
        return $this->makeRequest('delete', $api_method, $args, $timeout);
    }

    public function disableSSLVerification()
    {
        $this->verify_ssl = false;
    }
}


1			<?php
2
3			namespace DrewM\Drip;
4
5			class Drip
6			{
7			protected static $eventSubscriptions = [];
8			protected static $receivedWebhook = false;
9			protected $api_endpoint = 'https://api.getdrip.com/v2';
10			protected $token = false;
11			protected $accountID = null;
12			protected $verify_ssl = true;
13
14			/**
15			* Drip constructor.
16			*
17			* @param string $token API Token
18			* @param string\|null $accountID Drip account ID to operate on
19			*/
20			public function __construct($token, $accountID = null)
21			{
22			$this->token = $token;
			0 ignored issues – show Documentation Bug introduced 2019-01-29 16:23 UTC by Report Bug Copy Issue Report The property `$token` was declared of type `boolean`, but `$token` is of type `string`. Maybe add a type cast? This check looks for assignments to scalar types that may be of the wrong type. To ensure the code behaves as expected, it may be a good idea to add an explicit type cast. $answer = 42; $correct = false; $correct = (bool) $answer; Loading history...
23
24			if ($accountID !== null) {
25			$this->accountID = $accountID;
26			}
27			}
28
29			public static function subscribeToWebhook($event, callable $callback)
30			{
31			if (!isset(self::$eventSubscriptions[$event])) {
32			self::$eventSubscriptions[$event] = [];
33			}
34			self::$eventSubscriptions[$event][] = $callback;
35
36			self::receiveWebhook();
37			}
38
39			public static function receiveWebhook($input = null)
40			{
41			if (is_null($input)) {
42			if (self::$receivedWebhook !== false) {
43			$input = self::$receivedWebhook;
44			} else {
45			$input = file_get_contents("php://input");
46			}
47			}
48
49			if ($input) {
50			return self::processWebhook($input);
51			}
52
53			return false;
54			}
55
56			protected static function processWebhook($input)
57			{
58			if ($input) {
59			self::$receivedWebhook = $input;
60			$result = json_decode($input, true);
61			if ($result && isset($result['event'])) {
62			self::dispatchWebhookEvent($result['event'], $result['data']);
63			return $result;
64			}
65			}
66
67			return false;
68			}
69
70			protected static function dispatchWebhookEvent($event, $data)
71			{
72			if (isset(self::$eventSubscriptions[$event])) {
73			foreach (self::$eventSubscriptions[$event] as $callback) {
74			$callback($data);
75			}
76			// reset subscriptions
77			self::$eventSubscriptions[$event] = [];
78			}
79			return false;
80			}
81
82			/**
83			* Set account ID if it was not passed into the constructor
84			*
85			* @param string $accountID
86			*
87			* @return bool
88			*/
89			public function setAccountId($accountID) : bool
90			{
91			$this->accountID = $accountID;
92			return true;
93			}
94
95			/**
96			* Make a GET request
97			*
98			* @param string $api_method API method to call
99			* @param array $args API arguments
100			* @param int $timeout Connection timeout (seconds)
101			*
102			* @return Response
103			* @throws DripException
104			*/
105			public function get($api_method, $args = [], $timeout = 10)
106			{
107			return $this->makeRequest('get', $api_method, $args, $timeout);
108			}
109
110			/**
111			* Make the HTTP request
112			*
113			* @param string $http_verb HTTP method used: get, post, delete
114			* @param string $api_method Drip API method to call
115			* @param array $args Array of arguments to the API method
116			* @param int $timeout Connection timeout (seconds)
117			* @param string $url Optional URL to override the constructed one
118			*
119			* @return Response
120			* @throws DripException
121			*/
122			protected function makeRequest($http_verb, $api_method, $args = [], $timeout = 10, $url = null) : Response
123			{
124			$url = $this->constructRequestUrl($url, $api_method);
125
126			if (function_exists('curl_init') && function_exists('curl_setopt')) {
127
128			$ch = curl_init();
129			curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
130			curl_setopt($ch, CURLOPT_HTTPHEADER, [
131			'Accept: application/vnd.api+json',
132			'Content-Type: application/vnd.api+json',
133			]);
134			curl_setopt($ch, CURLOPT_USERAGENT, 'DrewM/Drip (github.com/drewm/drip)');
135			curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
136			curl_setopt($ch, CURLOPT_USERPWD, $this->token . ': ');
137			curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, $this->verify_ssl);
138			curl_setopt($ch, CURLOPT_TIMEOUT, $timeout);
139			curl_setopt($ch, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);
140			curl_setopt($ch, CURLOPT_URL, $url);
141
142			switch ($http_verb) {
143			case 'post':
144			curl_setopt($ch, CURLOPT_POST, 1);
145			curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($args));
146			break;
147
148			case 'get':
149			$query = http_build_query($args);
150			curl_setopt($ch, CURLOPT_URL, $url . '?' . $query);
151			break;
152
153			case 'delete':
154			curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
155			break;
156			}
157
158			$result = curl_exec($ch);
159
160			if (!curl_errno($ch)) {
161			$info = curl_getinfo($ch);
162			curl_close($ch);
163			return new Response($info, $result);
164			}
165
166			$errno = curl_errno($ch);
167			$error = curl_error($ch);
168
169			curl_close($ch);
170
171			throw new DripException($error, $errno);
172			} else {
173			throw new DripException("cURL support is required, but can't be found.", 1);
174			}
175			}
176
177			/**
178			* @param string\|null $url
179			* @param string $api_method
180			*
181			* @return string
182			* @throws DripException
183			*/
184			private function constructRequestUrl($url, $api_method) : string
185			{
186			if ($url !== null) {
187			return $url;
188			}
189
190			if ($this->accountID === null) {
191			throw new DripException("This method requires an account ID and none has been set.", 2);
192			}
193
194			return $this->api_endpoint . '/' . $this->accountID . '/' . $api_method;
195			}
196
197			/**
198			* Make a GET request to a top-level method outside of this account
199			*
200			* @param string $api_method
201			* @param array $args
202			* @param int $timeout
203			*
204			* @return Response
205			* @throws DripException
206			*/
207			public function getGlobal($api_method, $args = [], $timeout = 10)
208			{
209			$url = $this->api_endpoint . '/' . $api_method;
210			return $this->makeRequest('get', $api_method, $args, $timeout, $url);
211			}
212
213			/**
214			* Make a POST request
215			*
216			* @param string $api_method API method
217			* @param array $args Arguments to API method
218			* @param int $timeout Connection timeout (seconds)
219			*
220			* @return Response
221			* @throws DripException
222			*/
223			public function post($api_method, $args = [], $timeout = 10)
224			{
225			return $this->makeRequest('post', $api_method, $args, $timeout);
226			}
227
228			/**
229			* Make a DELETE request
230			*
231			* @param string $api_method API method
232			* @param array $args Arguments to the API method
233			* @param int $timeout Connection timeout (seconds)
234			*
235			* @return Response
236			* @throws DripException
237			*/
238			public function delete($api_method, $args = [], $timeout = 10)
239			{
240			return $this->makeRequest('delete', $api_method, $args, $timeout);
241			}
242
243			public function disableSSLVerification()
244			{
245			$this->verify_ssl = false;
246			}
247			}
248

drewm / drip

Push — master ( d6fa8b...55d3c7 )

Drip::constructRequestUrl() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like