SmsDev::dateFrom() - Code Metrics - Inspection of "adds phone number validation" - enricodias/smsdev-php - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#6)

by Enrico

created 2020-11-26 21:16 UTC

SmsDev::dateFrom() A

↳ Parent: SmsDev

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php

namespace enricodias;

use GuzzleHttp\Client;
use GuzzleHttp\Psr7\Request;

/**
 * SmsDev
 * 
 * Send and receive SMS using SmsDev.com.br
 * 
 * @see https://www.smsdev.com.br/ SMSDev API.
 * 
 * @author Enrico Dias <[email protected]>
 */
class SmsDev
{
    /**
     * API url.
     *
     * @var string
     */
    private $_apiUrl = 'https://api.smsdev.com.br/v1';

    /**
     * API key.
     *
     * @var string
     */
    private $_apiKey = '';

    /**
     * Whether or not to validate phone numbers locally before sending.
     *
     * @var bool
     */
    private $_numberValidation = true;

    /**
     * API timezone.
     *
     * @object \DateTimeZone
     */
    private $_apiTimeZone;

    /**
     * Date format to be used in all date functions.
     *
     * @var string
     */
    private $_dateFormat = 'U';

    /**
     * Query string to be sent to the API as a search filter.
     *
     * The default 'status' = 1 will return all received messages.
     * 
     * @var array
     */
    private $_query = [
        'status' => 1
    ];

    /**
     * Raw API response/
     *
     * @var array
     */
    private $_result = [];

    /**
     * Creates a new SmsDev instance with an API key and sets the default API timezone.
     *
     * @param string $apiKey
     */
    public function __construct($apiKey = '')
    {
        $this->_apiKey = $apiKey;

        $this->_apiTimeZone = new \DateTimeZone('America/Sao_Paulo');
    }

    /**
     * Send an SMS message.
     * 
     * This method does not guarantee that the recipient received the massage since the message delivery is async.
     *
     * @param int $number Recipient's number.
     * @param string $message SMS message.
     * @return bool true if the API accepted the request.
     */
    public function send($number, $message)
    {
        $this->_result = [];

        if ($this->_numberValidation === true) {
            
            try {

                $number = $this->validatePhoneNumber($number);

            } catch (\Exception $e) {

                return false;

            } catch (\Throwable $e) {

                return false;

            }

        }
        
        $request = new Request(
            'POST',
            $this->_apiUrl.'/send',
            [
                'Accept' => 'application/json',
            ],
            json_encode([
                'key'    => $this->_apiKey,
                'type'   => 9,
                'number' => $number,
                'msg'    => $message,
            ])
        );

        if ($this->makeRequest($request) === false) return false;

        if ($this->_result['situacao'] !== 'OK') return false;

        return true;
    }

    /**
     * Enables or disables the phone number validation
     *
     * @param bool $validate Whether or not to validate phone numbers.
     * @return void
     */
    public function setNumberValidation($validate = true)
    {
        $this->_numberValidation = (bool) $validate;
    }

    /**
     * Sets the date format to be used in all date functions.
     *
     * @param string $dateFormat A valid date format (ex: Y-m-d).
     * @return SmsDev Return itself for chaining.
     */
    public function setDateFormat($dateFormat)
    {
        $this->_dateFormat = $dateFormat;

        return $this;
    }

    /**
     * Resets the search filter.
     *
     * @return SmsDev Return itself for chaining.
     */
    public function setFilter()
    {
        $this->_query = [
            'status' => 1
        ];

        return $this;
    }

    /**
     * Sets the search filter to return unread messages only.
     *
     * @return SmsDev Return itself for chaining.
     */
    public function isUnread()
    {
        $this->_query['status'] = 0;

        return $this;
    }

    /**
     * Sets the search filter to return a message with a specific id.
     *
     * @param int $id Message id.
     * @return SmsDev Return itself for chaining.
     */
    public function byId($id)
    {
        $id = intval($id);

        if ($id > 0) $this->_query['id'] = $id;

        return $this;
    }

    /**
     * Sets the search filter to return messages older than a specific date.
     *
     * @param string $date A valid date.
     * @return SmsDev Return itself for chaining.
     */
    public function dateFrom($date)
    {
        return $this->parseDate('date_from', $date);
    }

    /**
     * Sets the search filter to return messages newer than a specific date.
     *
     * @param string $date A valid date.
     * @return SmsDev Return itself for chaining.
     */
    public function dateTo($date)
    {
        return $this->parseDate('date_to', $date);
    }

    /**
     * Sets the search filter to return messages between a specific date interval.
     *
     * @param string $dateFrom Minimum date.
     * @param string $dateTo Maximum date.
     * @return SmsDev Return itself for chaining.
     */
    public function dateBetween($dateFrom, $dateTo)
    {
        return $this->dateFrom($dateFrom)->dateTo($dateTo);
    }

    /**
     * Query the API for received messages using search filters.
     * 
     * @see SmsDev::$_query Search filters.
     * @see SmsDev::$_result API response.
     *
     * @return bool True if the request if the API response is valid.
     */
    public function fetch()
    {
        $this->_result = [];

        $this->_query['key'] = $this->_apiKey;

        $request = new Request(
            'GET',
            $this->_apiUrl.'/inbox',
            [
                'Accept' => 'application/json',
            ],
            json_encode(
                $this->_query
            )
        );

        if ($this->makeRequest($request) === false) return false;

        // resets the filters
        $this->setFilter();

        if (is_array($this->_result)) return true;

        return false;
    }

    /**
     * Parse the received messages in a more useful format with the fields date, number and message.
     * 
     * The dates received by the API are converted to SmsDev::$_dateFormat.
     *
     * @see SmsDev::$_dateFormat Date format to be used in all date functions.
     * 
     * @return array List of received messages.
     */
    public function parsedMessages()
    {
        $localTimeZone = new \DateTimeZone(date_default_timezone_get());

        $messages = [];

        foreach ($this->_result as $key => $result) {

            if (is_array($result) === false) continue;

            if (is_array($result) === false || array_key_exists('id_sms_read', $result) === false) continue;

            $id = $result['id_sms_read'];
            $date = \DateTime::createFromFormat('d/m/Y H:i:s', $result['data_read'], $this->_apiTimeZone);

            $date->setTimezone($localTimeZone);

            $messages[$id] = [
                'date'    => $date->format($this->_dateFormat),
                'number'  => $result['telefone'],
                'message' => $result['descricao'],
            ];

        }

        return $messages;
    }

    /**
     * Get the current balance/credits.
     *
     * @return int Current balance in BRL cents.
     */
    public function getBalance()
    {
        $this->_result = [];

        $request = new Request(
            'GET',
            $this->_apiUrl.'/balance',
            [
                'Accept' => 'application/json',
            ],
            json_encode([
                'key'    => $this->_apiKey,
                'action' => 'saldo',
            ])
        );

        $this->makeRequest($request);

        if (array_key_exists('saldo_sms', $this->_result) === false) return 0;

        return (int) $this->_result['saldo_sms'];
    }

    /**
     * Get the raw API response from the last response received.
     *
     * @see SmsDev::$_result Raw API response.
     * 
     * @return array Raw API response.
     */
    public function getResult()
    {
        return $this->_result;
    }

    /**
     * Verifies if a phone number is valid
     *
     * @see https://github.com/giggsey/libphonenumber-for-php libphonenumber for PHP repository.
     * 
     * @param int $number Phone number.
     * @return int A valid mobile phone number.
     * 
     * @throws \libphonenumber\NumberParseException If the number is not valid.
     * @throws \Exception If the number is not a valid brazilian mobile number.
     */
    private function validatePhoneNumber($number)
    {
        if (class_exists('\libphonenumber\PhoneNumberUtil')) {

            $phoneNumberUtil = \libphonenumber\PhoneNumberUtil::getInstance();
filter:
    dependency_paths: ["lib/*"]

            $phoneNumberObject = $phoneNumberUtil->parse($number, 'BR');

            if ($phoneNumberUtil->isValidNumber($phoneNumberObject) === false || $phoneNumberUtil->getNumberType($phoneNumberObject) !== \libphonenumber\PhoneNumberType::MOBILE) {
filter:
    dependency_paths: ["lib/*"]

                throw new \Exception('Invalid phone number.');

            }

            $number = $phoneNumberObject->getCountryCode() . $phoneNumberObject->getNationalNumber();

        }

        return $number;

    }

    /**
     * Convert a date to format supported by the API.
     * 
     * The API requires the date format d/m/Y, but in this class any valid date format is supported.
     * Since the API is always using the timezone America/Sao_Paulo, this function must also do timezone conversions.
     *
     * @see SmsDev::$_dateFormat Date format to be used in all date functions.
     * 
     * @param string $key The filter key to be set as a search filter.
     * @param string $date A valid date format.
     * @return SmsDev Return itself for chaining.
     */
    private function parseDate($key, $date)
    {
        $parsedDate = \DateTime::createFromFormat($this->_dateFormat, $date);

        if ($parsedDate !== false) {
            
            $parsedDate->setTimezone($this->_apiTimeZone);

            $this->_query[$key] = $parsedDate->format('d/m/Y');

        }

        return $this;
    }

    /**
     * Sends a request to the smsdev.com.br API.
     *
     * @param \GuzzleHttp\Psr7\Request $request Request object.
     * @return bool True if the API response is valid.
     */
    private function makeRequest($request)
    {
        $client = $this->getGuzzleClient();

        try {

            $response = $client->send($request);

        } catch (\Exception $e) {
            
            return false;
            
        }

        $response = json_decode($response->getBody(), true);
        
        if (json_last_error() != JSON_ERROR_NONE || is_array($response) === false) return false;

        $this->_result = $response;

        return true;
    }

    /**
     * Creates GuzzleHttp\Client to be used in API requests.
     * This method is needed to test API calls in unit tests.
     *
     * @return object GuzzleHttp\Client instance.
     * 
     * @codeCoverageIgnore
     */
    protected function getGuzzleClient()
    {
        return new Client();
    }
}

1		<?php
2
3		namespace enricodias;
4
5		use GuzzleHttp\Client;
6		use GuzzleHttp\Psr7\Request;
7
8		/**
9		* SmsDev
10		*
11		* Send and receive SMS using SmsDev.com.br
12		*
13		* @see https://www.smsdev.com.br/ SMSDev API.
14		*
15		* @author Enrico Dias <[email protected]>
16		*/
17		class SmsDev
18		{
19		/**
20		* API url.
21		*
22		* @var string
23		*/
24		private $_apiUrl = 'https://api.smsdev.com.br/v1';
25
26		/**
27		* API key.
28		*
29		* @var string
30		*/
31		private $_apiKey = '';
32
33		/**
34		* Whether or not to validate phone numbers locally before sending.
35		*
36		* @var bool
37		*/
38		private $_numberValidation = true;
39
40		/**
41		* API timezone.
42		*
43		* @object \DateTimeZone
44		*/
45		private $_apiTimeZone;
46
47		/**
48		* Date format to be used in all date functions.
49		*
50		* @var string
51		*/
52		private $_dateFormat = 'U';
53
54		/**
55		* Query string to be sent to the API as a search filter.
56		*
57		* The default 'status' = 1 will return all received messages.
58		*
59		* @var array
60		*/
61		private $_query = [
62		'status' => 1
63		];
64
65		/**
66		* Raw API response/
67		*
68		* @var array
69		*/
70		private $_result = [];
71
72		/**
73		* Creates a new SmsDev instance with an API key and sets the default API timezone.
74		*
75		* @param string $apiKey
76		*/
77	43	public function __construct($apiKey = '')
78		{
79	43	$this->_apiKey = $apiKey;
80
81	43	$this->_apiTimeZone = new \DateTimeZone('America/Sao_Paulo');
82	43	}
83
84		/**
85		* Send an SMS message.
86		*
87		* This method does not guarantee that the recipient received the massage since the message delivery is async.
88		*
89		* @param int $number Recipient's number.
90		* @param string $message SMS message.
91		* @return bool true if the API accepted the request.
92		*/
93	28	public function send($number, $message)
94		{
95	28	$this->_result = [];
96
97	28	if ($this->_numberValidation === true) {
98
99		try {
100
101	20	$number = $this->validatePhoneNumber($number);
102
103	20	} catch (\Exception $e) {
104
105	18	return false;
106
107		} catch (\Throwable $e) {
108
109		return false;
110
111		}
112
113	2	}
114
115	10	$request = new Request(
116	10	'POST',
117	10	$this->_apiUrl.'/send',
118		[
119	10	'Accept' => 'application/json',
120	10	],
121	10	json_encode([
122	10	'key' => $this->_apiKey,
123	10	'type' => 9,
124	10	'number' => $number,
125	10	'msg' => $message,
126	10	])
127	10	);
128
129	10	if ($this->makeRequest($request) === false) return false;
130
131	9	if ($this->_result['situacao'] !== 'OK') return false;
132
133	5	return true;
134		}
135
136		/**
137		* Enables or disables the phone number validation
138		*
139		* @param bool $validate Whether or not to validate phone numbers.
140		* @return void
141		*/
142	8	public function setNumberValidation($validate = true)
143		{
144	8	$this->_numberValidation = (bool) $validate;
145	8	}
146
147		/**
148		* Sets the date format to be used in all date functions.
149		*
150		* @param string $dateFormat A valid date format (ex: Y-m-d).
151		* @return SmsDev Return itself for chaining.
152		*/
153	9	public function setDateFormat($dateFormat)
154		{
155	9	$this->_dateFormat = $dateFormat;
156
157	9	return $this;
158		}
159
160		/**
161		* Resets the search filter.
162		*
163		* @return SmsDev Return itself for chaining.
164		*/
165	11	public function setFilter()
166		{
167	11	$this->_query = [
168		'status' => 1
169	11	];
170
171	11	return $this;
172		}
173
174		/**
175		* Sets the search filter to return unread messages only.
176		*
177		* @return SmsDev Return itself for chaining.
178		*/
179	3	public function isUnread()
180		{
181	3	$this->_query['status'] = 0;
182
183	3	return $this;
184		}
185
186		/**
187		* Sets the search filter to return a message with a specific id.
188		*
189		* @param int $id Message id.
190		* @return SmsDev Return itself for chaining.
191		*/
192	3	public function byId($id)
193		{
194	3	$id = intval($id);
195
196	3	if ($id > 0) $this->_query['id'] = $id;
197
198	3	return $this;
199		}
200
201		/**
202		* Sets the search filter to return messages older than a specific date.
203		*
204		* @param string $date A valid date.
205		* @return SmsDev Return itself for chaining.
206		*/
207	5	public function dateFrom($date)
208		{
209	5	return $this->parseDate('date_from', $date);
210		}
211
212		/**
213		* Sets the search filter to return messages newer than a specific date.
214		*
215		* @param string $date A valid date.
216		* @return SmsDev Return itself for chaining.
217		*/
218	4	public function dateTo($date)
219		{
220	4	return $this->parseDate('date_to', $date);
221		}
222
223		/**
224		* Sets the search filter to return messages between a specific date interval.
225		*
226		* @param string $dateFrom Minimum date.
227		* @param string $dateTo Maximum date.
228		* @return SmsDev Return itself for chaining.
229		*/
230	2	public function dateBetween($dateFrom, $dateTo)
231		{
232	2	return $this->dateFrom($dateFrom)->dateTo($dateTo);
233		}
234
235		/**
236		* Query the API for received messages using search filters.
237		*
238		* @see SmsDev::$_query Search filters.
239		* @see SmsDev::$_result API response.
240		*
241		* @return bool True if the request if the API response is valid.
242		*/
243	13	public function fetch()
244		{
245	13	$this->_result = [];
246
247	13	$this->_query['key'] = $this->_apiKey;
248
249	13	$request = new Request(
250	13	'GET',
251	13	$this->_apiUrl.'/inbox',
252		[
253	13	'Accept' => 'application/json',
254	13	],
255	13	json_encode(
256	13	$this->_query
257	13	)
258	13	);
259
260	13	if ($this->makeRequest($request) === false) return false;
261
262		// resets the filters
263	4	$this->setFilter();
264
265	4	if (is_array($this->_result)) return true;
266
267		return false;
268		}
269
270		/**
271		* Parse the received messages in a more useful format with the fields date, number and message.
272		*
273		* The dates received by the API are converted to SmsDev::$_dateFormat.
274		*
275		* @see SmsDev::$_dateFormat Date format to be used in all date functions.
276		*
277		* @return array List of received messages.
278		*/
279	5	public function parsedMessages()
280		{
281	5	$localTimeZone = new \DateTimeZone(date_default_timezone_get());
282
283	5	$messages = [];
284
285	5	foreach ($this->_result as $key => $result) {
286
287	3	if (is_array($result) === false) continue;
288
289	3	if (is_array($result) === false \|\| array_key_exists('id_sms_read', $result) === false) continue;
290
291	2	$id = $result['id_sms_read'];
292	2	$date = \DateTime::createFromFormat('d/m/Y H:i:s', $result['data_read'], $this->_apiTimeZone);
293
294	2	$date->setTimezone($localTimeZone);
295
296	2	$messages[$id] = [
297	2	'date' => $date->format($this->_dateFormat),
298	2	'number' => $result['telefone'],
299	2	'message' => $result['descricao'],
300		];
301
302	5	}
303
304	5	return $messages;
305		}
306
307		/**
308		* Get the current balance/credits.
309		*
310		* @return int Current balance in BRL cents.
311		*/
312	3	public function getBalance()
313		{
314	3	$this->_result = [];
315
316	3	$request = new Request(
317	3	'GET',
318	3	$this->_apiUrl.'/balance',
319		[
320	3	'Accept' => 'application/json',
321	3	],
322	3	json_encode([
323	3	'key' => $this->_apiKey,
324	3	'action' => 'saldo',
325	3	])
326	3	);
327
328	3	$this->makeRequest($request);
329
330	3	if (array_key_exists('saldo_sms', $this->_result) === false) return 0;
331
332	1	return (int) $this->_result['saldo_sms'];
333		}
334
335		/**
336		* Get the raw API response from the last response received.
337		*
338		* @see SmsDev::$_result Raw API response.
339		*
340		* @return array Raw API response.
341		*/
342	2	public function getResult()
343		{
344	2	return $this->_result;
345		}
346
347		/**
348		* Verifies if a phone number is valid
349		*
350		* @see https://github.com/giggsey/libphonenumber-for-php libphonenumber for PHP repository.
351		*
352		* @param int $number Phone number.
353		* @return int A valid mobile phone number.
354		*
355		* @throws \libphonenumber\NumberParseException If the number is not valid.
356		* @throws \Exception If the number is not a valid brazilian mobile number.
357		*/
358	20	private function validatePhoneNumber($number)
359		{
360	20	if (class_exists('\libphonenumber\PhoneNumberUtil')) {
361
362	20	$phoneNumberUtil = \libphonenumber\PhoneNumberUtil::getInstance();
		0 ignored issues – show Bug introduced 2020-11-26 21:17 UTC by Report Bug Copy Issue Report The type `libphonenumber\PhoneNumberUtil` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
363
364	20	$phoneNumberObject = $phoneNumberUtil->parse($number, 'BR');
365
366	15	if ($phoneNumberUtil->isValidNumber($phoneNumberObject) === false \|\| $phoneNumberUtil->getNumberType($phoneNumberObject) !== \libphonenumber\PhoneNumberType::MOBILE) {
		0 ignored issues – show Bug introduced 2020-11-26 21:17 UTC by Report Bug Copy Issue Report The type `libphonenumber\PhoneNumberType` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
367
368	13	throw new \Exception('Invalid phone number.');
369
370		}
371
372	2	$number = $phoneNumberObject->getCountryCode() . $phoneNumberObject->getNationalNumber();
373
374	2	}
375
376	2	return $number;
		0 ignored issues – show Bug Best Practice introduced 2020-11-26 21:17 UTC by Report Bug Copy Issue Report The expression `return $number` also could return the type `string` which is incompatible with the documented return type `integer`. Loading history...
377		}
378
379		/**
380		* Convert a date to format supported by the API.
381		*
382		* The API requires the date format d/m/Y, but in this class any valid date format is supported.
383		* Since the API is always using the timezone America/Sao_Paulo, this function must also do timezone conversions.
384		*
385		* @see SmsDev::$_dateFormat Date format to be used in all date functions.
386		*
387		* @param string $key The filter key to be set as a search filter.
388		* @param string $date A valid date format.
389		* @return SmsDev Return itself for chaining.
390		*/
391	5	private function parseDate($key, $date)
392		{
393	5	$parsedDate = \DateTime::createFromFormat($this->_dateFormat, $date);
394
395	5	if ($parsedDate !== false) {
396
397	5	$parsedDate->setTimezone($this->_apiTimeZone);
398
399	5	$this->_query[$key] = $parsedDate->format('d/m/Y');
400
401	5	}
402
403	5	return $this;
404		}
405
406		/**
407		* Sends a request to the smsdev.com.br API.
408		*
409		* @param \GuzzleHttp\Psr7\Request $request Request object.
410		* @return bool True if the API response is valid.
411		*/
412	25	private function makeRequest($request)
413		{
414	25	$client = $this->getGuzzleClient();
415
416		try {
417
418	25	$response = $client->send($request);
419
420	25	} catch (\Exception $e) {
421
422	2	return false;
423
424		}
425
426	25	$response = json_decode($response->getBody(), true);
427
428	25	if (json_last_error() != JSON_ERROR_NONE \|\| is_array($response) === false) return false;
429
430	14	$this->_result = $response;
431
432	14	return true;
433		}
434
435		/**
436		* Creates GuzzleHttp\Client to be used in API requests.
437		* This method is needed to test API calls in unit tests.
438		*
439		* @return object GuzzleHttp\Client instance.
440		*
441		* @codeCoverageIgnore
442		*/
443		protected function getGuzzleClient()
444		{
445		return new Client();
446		}
447		}

enricodias / smsdev-php

Pull Request — master (#6)

SmsDev::dateFrom() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like