iBrand\Sms\Sms

Complexity

Total Complexity

31

Size/Duplication

Total Lines	251
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	8

Test Coverage

Coverage

92.94%

Importance

Changes

0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	setKey()	0	5	1
A	getKey()	0	4	1
A	__construct()	0	5	1
A	setStorage()	0	4	1
B	send()	0	44	7
A	verifyMobile()	0	4	1
A	getCodeFromStorage()	0	4	1
A	needNewCode()	0	8	2
A	checkAttempts()	0	10	3
A	getNewCode()	0	8	1
A	canSend()	0	12	3
A	generateCode()	0	14	2
A	getStorage()	0	4	2
A	checkCode()	0	26	5

<?php

/*
 * This file is part of ibrand/laravel-sms.
 *
 * (c) iBrand <https://www.ibrand.cc>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace iBrand\Sms;

use Carbon\Carbon;
use iBrand\Sms\Jobs\DbLogger;
use iBrand\Sms\Messages\CodeMessage;
use iBrand\Sms\Storage\CacheStorage;
use iBrand\Sms\Storage\StorageInterface;
use Overtrue\EasySms\Contracts\MessageInterface;
use Overtrue\EasySms\EasySms;
use Overtrue\EasySms\Exceptions\NoGatewayAvailableException;

/**
 * Class Sms.
 */
class Sms
{
	/**
	 * @var EasySms
	 */
	protected $easySms;
	/**
	 * @var
	 */
	protected $storage;

	/**
	 * @var
	 */
	protected $key;

	/**
	 * @param mixed $key
	 */
	public function setKey($key)
	{
		$key       = 'ibrand.sms.' . $key;
		$this->key = md5($key);
	}

	/**
	 * @return mixed
	 */
	public function getKey()
	{
		return $this->key;
	}

	/**
	 * Sms constructor.
	 *
	 * @param EasySms $easySms
	 */
	public function __construct(EasySms $easySms, StorageInterface $storage)
	{
		$this->easySms = $easySms;
		$this->storage = $storage;
	}

	/**
	 * @param StorageInterface $storage
	 */
	public function setStorage(StorageInterface $storage)
	{
		$this->storage = $storage;
	}

	/**
	 * @param       $to
	 * @param null  $data
	 * @param array $gateways
	 *
	 * @return bool
	 */
	public function send($to, $data = [], array $gateways = [])
	{
		try {
			$flag = false;

			$this->setKey($to);

			//1. get code from storage.
			$code = $this->getCodeFromStorage();

			if ($this->needNewCode($code)) {
				$code = $this->getNewCode($to);
			}

			$validMinutes = (int) config('ibrand.sms.code.validMinutes', 5);

			if (!($data instanceof MessageInterface)) {
				$message = new CodeMessage($code->code, $validMinutes, $data);

It seems like $data defined by parameter $data on line 85 can also be of type null; however, iBrand\Sms\Messages\CodeMessage::__construct() does only seem to accept array, maybe add an additional type check?

			} else {
				$message = $data;
			}

			$results = $this->easySms->send($to, $message, $gateways);

			foreach ($results as $key => $value) {
				if ('success' == $value['status']) {
					$code->put('sent', true);
					$code->put('sentAt', Carbon::now());
					$this->storage->set($this->key, $code);
					$flag = true;
				}
			}
		} catch (NoGatewayAvailableException $noGatewayAvailableException) {
			$results = $noGatewayAvailableException->results;
			$flag    = false;
		} catch (\Exception $exception) {
			$results = $exception->getMessage();
			$flag    = false;
		}

		DbLogger::dispatch($code, json_encode($results), $flag);

The variable $code does not seem to be defined for all execution paths leading up to this point.

		return $flag;
	}

	/**
	 * check china mobile.
	 *
	 * @param $to
	 *
	 * @return false|int
	 */
	public function verifyMobile($to)
	{
		return preg_match('/^(?:\+?86)?1(?:3\d{3}|5[^4\D]\d{2}|8\d{3}|7(?:[0-35-9]\d{2}|4(?:0\d|1[0-2]|9\d))|9[0-35-9]\d{2}|6[2567]\d{2}|4(?:(?:10|4[01])\d{3}|[68]\d{4}|[579]\d{2}))\d{6}$/', $to);
	}

	/**
	 * @param $to
	 *
	 * @return mixed
	 */
	public function getCodeFromStorage()
	{
		return $this->storage->get($this->key, '');
	}

	/**
	 * @param $code
	 *
	 * @return bool
	 */
	protected function needNewCode($code)
	{
		if (empty($code)) {
			return true;
		}

		return $this->checkAttempts($code);
	}

	/**
	 * Check attempt times.
	 *
	 * @param $code
	 *
	 * @return bool
	 */
	private function checkAttempts($code)
	{
		$maxAttempts = config('ibrand.sms.code.maxAttempts');

		if ($code->expireAt > Carbon::now() && $code->attempts < $maxAttempts) {
			return false;
		}

		return true;
	}

	/**
	 * @param $to
	 *
	 * @return Code
	 */
	public function getNewCode($to)
	{
		$code = $this->generateCode($to);

		$this->storage->set($this->key, $code);

		return $code;
	}

	/**
	 * @param $to
	 *
	 * @return bool
	 */
	public function canSend($to)
	{
		$this->setKey($to);

		$code = $this->storage->get($this->key, '');

		if (empty($code) || $code->sentAt < Carbon::now()->addMinutes(-1)) {
			return true;
		}

		return false;
	}

	/**
	 * @param $to
	 *
	 * @return Code
	 */
	public function generateCode($to)
	{
		$length       = (int) config('ibrand.sms.code.length', 5);
		$characters   = '0123456789';
		$charLength   = strlen($characters);
		$randomString = '';
		for ($i = 0; $i < $length; ++$i) {
			$randomString .= $characters[mt_rand(0, $charLength - 1)];
		}

		$validMinutes = (int) config('ibrand.sms.code.validMinutes', 5);

		return new Code($to, $randomString, false, 0, Carbon::now()->addMinutes($validMinutes));
	}

	/**
	 * @return CacheStorage|StorageInterface
	 */
	public function getStorage()
	{
		return $this->storage ? $this->storage : new CacheStorage();
	}

	/**
	 * @param $to
	 * @param $inputCode
	 *
	 * @return bool
	 */
	public function checkCode($to, $inputCode)
	{
		if (config('app.debug')) {
			return true;
		}

		$this->setKey($to);

		$code = $this->storage->get($this->key, '');

		if (empty($code)) {
			return false;
		}

		if ($code && $code->code == $inputCode) {
			$this->storage->forget($this->key);

			return true;
		}

		$code->put('attempts', $code->attempts + 1);

		$this->storage->set($this->key, $code);

		return false;
	}
}