SmsService::signatureQueryId() - Code Metrics - Inspection of "- 微信小程序接口增加直播" - GC0202/ThinkLibrary - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — v6 ( 3606bd...432c9e )

by 光春

created 2020-09-21 05:52 UTC

SmsService::signatureQueryId() A

↳ Parent: SmsService

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	5
c	1
b	0
f	0
dl	0
loc	8
rs	10
cc	2
nc	2
nop	1

<?php

namespace DtApp\ThinkLibrary\service\qiniu;

use DtApp\ThinkLibrary\exception\DtaException;
use DtApp\ThinkLibrary\Service;
use Qiniu\Auth;
use Qiniu\Http\Client;
use think\exception\HttpException;

/**
 * Class SmsService
 * @package DtApp\ThinkLibrary\service\qiniu
 */
class SmsService extends Service
{
    /**
     * @var
     */
    private $accessKey, $secretKey, $url, $method;

    /**
     * 需要发送的的参数
     * @var
     */
    private $param = [];

    /**
     * 响应内容
     * @var
     */
    private $output;

    /**
     * @var string
     */
    private $contentType = "application/json";

    /**
     * @param string $accessKey
     * @return $this
     */
    public function accessKey(string $accessKey): self
    {
        $this->accessKey = $accessKey;
        return $this;
    }

    /**
     * @param string $secretKey
     * @return $this
     */
    public function secretKey(string $secretKey): self
    {
        $this->secretKey = $secretKey;
        return $this;
    }

    /**
     * 请求参数
     * @param array $param
     * @return $this
     */
    public function param(array $param): self
    {
        $this->param = $param;
        return $this;
    }

    /**
     * 发送短信
     * https://developer.qiniu.com/sms/api/5897/sms-api-send-message#1
     * @return $this
     */
    public function message(): self
    {
        $this->url = "https://sms.qiniuapi.com/v1/message";
        $this->method = "POST";
        return $this;
    }

    /**
     * 发送单条短信
     * https://developer.qiniu.com/sms/api/5897/sms-api-send-message#2
     * @return $this
     */
    public function messageSingle(): self
    {
        $this->url = "https://sms.qiniuapi.com/v1/message/single";
        $this->method = "POST";
        return $this;
    }

    /**
     * 发送国际/港澳台短信
     * https://developer.qiniu.com/sms/api/5897/sms-api-send-message#3
     * @return $this
     */
    public function messageOversea(): self
    {
        $this->url = "https://sms.qiniuapi.com/v1/message/oversea";
        $this->method = "POST";
        return $this;
    }

    /**
     * 发送全文本短信(不需要传模版 ID)
     * https://developer.qiniu.com/sms/api/5897/sms-api-send-message#3
     * @return $this
     */
    public function messageFulltext(): self
    {
        $this->url = "https://sms.qiniuapi.com/v1/message/fulltext";
        $this->method = "POST";
        return $this;
    }

    /**
     * 查询短信发送记录
     * https://developer.qiniu.com/sms/api/5852/query-send-sms
     * @return $this
     */
    public function messages(): self
    {
        $this->url = "https://sms.qiniuapi.com/v1/messages";
        $this->method = "GET";
        return $this;
    }

    /**
     * 创建签名
     * https://developer.qiniu.com/sms/api/5844/sms-api-create-signature
     * @return $this
     */
    public function signature(): self
    {
        $this->url = "https://sms.qiniuapi.com/v1/signature";
        $this->method = "POST";
        return $this;
    }

    /**
     * 查询签名
     * https://developer.qiniu.com/sms/api/5844/sms-api-create-signature
     * @return $this
     */
    public function signatureQuery(): self
    {
        $this->url = "https://sms.qiniuapi.com/v1/signature";
        $this->method = "GET";
        $this->contentType = "application/x-www-form-urlencoded";
        return $this;
    }

    /**
     * 查询单个签名信息
     * https://developer.qiniu.com/sms/api/5970/query-a-single-signature
     * @param $id
     * @return $this
     * @throws DtaException
     */
    public function signatureQueryId($id): self
    {
        if (empty($id)) {
            throw new DtaException('请检查id参数');
        }
        $this->url = "https://sms.qiniuapi.com/v1/signature/{$id}";
        $this->method = "GET";
        return $this;
    }

    /**
     * 编辑签名
     * https://developer.qiniu.com/sms/api/5890/sms-api-edit-signature
     * @param $id
     * @return $this
     * @throws DtaException
     */
    public function signatureEditId($id): self
    {
        if (empty($id)) {
            throw new DtaException('请检查id参数');
        }
        $this->url = "https://sms.qiniuapi.com/v1/signature/{$id}";
        $this->method = "PUT";
        return $this;
    }

    /**
     * 删除签名
     * https://developer.qiniu.com/sms/api/5891/sms-api-delete-signature
     * @param $id
     * @return $this
     * @throws DtaException
     */
    public function signatureDelId($id): self
    {
        if (empty($id)) {
            throw new DtaException('请检查id参数');
        }
        $this->url = "https://sms.qiniuapi.com/v1/signature/{$id}";
        $this->method = "DELETE";
        return $this;
    }

    /**
     * 创建模板
     * https://developer.qiniu.com/sms/api/5893/sms-api-create-template
     * @return $this
     */
    public function template(): self
    {
        $this->url = "https://sms.qiniuapi.com/v1/template";
        $this->method = "POST";
        return $this;
    }

    /**
     * 查询模板
     * https://developer.qiniu.com/sms/api/5894/sms-api-query-template
     * @return $this
     */
    public function templateQuery(): self
    {
        $this->url = "https://sms.qiniuapi.com/v1/template";
        $this->method = "GET";
        return $this;
    }

    /**
     * 查询单个模版信息
     * https://developer.qiniu.com/sms/api/5969/query-a-single-template
     * @param $id
     * @return $this
     * @throws DtaException
     */
    public function templateQueryId($id): self
    {
        if (empty($id)) {
            throw new DtaException('请检查id参数');
        }
        $this->url = "https://sms.qiniuapi.com/v1/template/{$id}";
        $this->method = "GET";
        return $this;
    }

    /**
     * 编辑签名
     * https://developer.qiniu.com/sms/api/5895/sms-api-edit-template
     * @param $id
     * @return $this
     * @throws DtaException
     */
    public function templateEditId($id): self
    {
        if (empty($id)) {
            throw new DtaException('请检查id参数');
        }
        $this->url = "https://sms.qiniuapi.com/v1/template/{$id}";
        $this->method = "PUT";
        return $this;
    }

    /**
     * 删除签名
     * https://developer.qiniu.com/sms/api/5896/sms-api-delete-template
     * @param $id
     * @return $this
     * @throws DtaException
     */
    public function templateDelId($id): self
    {
        if (empty($id)) {
            throw new DtaException('请检查id参数');
        }
        $this->url = "https://sms.qiniuapi.com/v1/template/{$id}";
        $this->method = "DELETE";
        return $this;
    }

    /**
     * 返回数组数据
     * @return array|mixed
     * @throws DtaException
     * @throws \GuzzleHttp\Exception\GuzzleException
     */
    public function toArray()
    {
        //首先检测是否支持curl
        if (!extension_loaded("curl")) {
            throw new HttpException(404, '请开启curl模块！');
        }
        $this->http();
        // 正常
        if (is_array($this->output)) {
            return $this->output;
        }
        if (is_object($this->output)) {
            $this->output = $this->object2array($this->output);
            return $this->output;
        }
        $this->output = json_decode($this->output, true);
        return $this->output;
    }

    /**
     * @param $object
     * @return array
     */
    private function object2array(&$object): array
    {
        if (is_object($object)) {
            $arr = (array)($object);
        } else {
            $arr = &$object;
        }
        if (is_array($arr)) {
            foreach ($arr as $varName => $varValue) {
                $arr[$varName] = $this->object2array($varValue);
            }
        }
        return $arr;
    }

    /**
     * 网络请求
     * @return $this
     * @throws DtaException
     * @throws \GuzzleHttp\Exception\GuzzleException
     */
    private function http(): self
    {
        if (empty($this->accessKey)) {
            throw new DtaException('请检查accessKey参数');
        }
        if (empty($this->secretKey)) {
            throw new DtaException('请检查secretKey参数');
        }
        $headers = [

            'Authorization' => $this->authentication(),
            'Content-Type' => $this->contentType
        ];

        $auth = new Auth($this->accessKey, $this->secretKey);
        $recToken = $auth->authorizationV2($this->url, $this->method, json_encode($this->param), $this->contentType);
        $rtcToken['Content-Type'] = $this->contentType;

        dump($recToken);
        dump($this->url . "?" . http_build_query($this->param));
        $ret = Client::get($this->url . "?" . http_build_query($this->param), $recToken);
        dump($ret);
        $this->output = $ret->json();
        return $this;
    }

    /**
     * 服务鉴权
     * https://developer.qiniu.com/sms/api/5842/sms-api-authentication
     * @return string
     */
    private function authentication()
    {
        $url = parse_url($this->url);
        $data = $url['path'] ?? '';
        if (isset($url['query'])) {
            $data .= '?' . $url['query'];
        }
        $data .= "\n";
        if (isset($this->param) && $this->contentType === 'application/x-www-form-urlencoded') {
            $data .= json_encode($this->param);
        }
        return $this->sign($data);
    }

    /**
     * @param $data
     * @return string
     */
    private function sign($data)
    {
        $sign = hash_hmac('sha1', $data, $this->secretKey, true);
        return "Qiniu " . sprintf('%s:%s', $this->accessKey, $this->encode($sign));
    }

    /**
     * @param $string
     * @return string|string[]
     */
    private function encode($string)
    {
        $find = ['+', '/'];
        $replace = ['-', '_'];
        return str_replace($find, $replace, base64_encode($string));
    }
}

1			<?php
2
3			namespace DtApp\ThinkLibrary\service\qiniu;
4
5			use DtApp\ThinkLibrary\exception\DtaException;
6			use DtApp\ThinkLibrary\Service;
7			use Qiniu\Auth;
8			use Qiniu\Http\Client;
9			use think\exception\HttpException;
10
11			/**
12			* Class SmsService
13			* @package DtApp\ThinkLibrary\service\qiniu
14			*/
15			class SmsService extends Service
16			{
17			/**
18			* @var
19			*/
20			private $accessKey, $secretKey, $url, $method;
21
22			/**
23			* 需要发送的的参数
24			* @var
25			*/
26			private $param = [];
27
28			/**
29			* 响应内容
30			* @var
31			*/
32			private $output;
33
34			/**
35			* @var string
36			*/
37			private $contentType = "application/json";
38
39			/**
40			* @param string $accessKey
41			* @return $this
42			*/
43			public function accessKey(string $accessKey): self
44			{
45			$this->accessKey = $accessKey;
46			return $this;
47			}
48
49			/**
50			* @param string $secretKey
51			* @return $this
52			*/
53			public function secretKey(string $secretKey): self
54			{
55			$this->secretKey = $secretKey;
56			return $this;
57			}
58
59			/**
60			* 请求参数
61			* @param array $param
62			* @return $this
63			*/
64			public function param(array $param): self
65			{
66			$this->param = $param;
67			return $this;
68			}
69
70			/**
71			* 发送短信
72			* https://developer.qiniu.com/sms/api/5897/sms-api-send-message#1
73			* @return $this
74			*/
75			public function message(): self
76			{
77			$this->url = "https://sms.qiniuapi.com/v1/message";
78			$this->method = "POST";
79			return $this;
80			}
81
82			/**
83			* 发送单条短信
84			* https://developer.qiniu.com/sms/api/5897/sms-api-send-message#2
85			* @return $this
86			*/
87			public function messageSingle(): self
88			{
89			$this->url = "https://sms.qiniuapi.com/v1/message/single";
90			$this->method = "POST";
91			return $this;
92			}
93
94			/**
95			* 发送国际/港澳台短信
96			* https://developer.qiniu.com/sms/api/5897/sms-api-send-message#3
97			* @return $this
98			*/
99			public function messageOversea(): self
100			{
101			$this->url = "https://sms.qiniuapi.com/v1/message/oversea";
102			$this->method = "POST";
103			return $this;
104			}
105
106			/**
107			* 发送全文本短信(不需要传模版 ID)
108			* https://developer.qiniu.com/sms/api/5897/sms-api-send-message#3
109			* @return $this
110			*/
111			public function messageFulltext(): self
112			{
113			$this->url = "https://sms.qiniuapi.com/v1/message/fulltext";
114			$this->method = "POST";
115			return $this;
116			}
117
118			/**
119			* 查询短信发送记录
120			* https://developer.qiniu.com/sms/api/5852/query-send-sms
121			* @return $this
122			*/
123			public function messages(): self
124			{
125			$this->url = "https://sms.qiniuapi.com/v1/messages";
126			$this->method = "GET";
127			return $this;
128			}
129
130			/**
131			* 创建签名
132			* https://developer.qiniu.com/sms/api/5844/sms-api-create-signature
133			* @return $this
134			*/
135			public function signature(): self
136			{
137			$this->url = "https://sms.qiniuapi.com/v1/signature";
138			$this->method = "POST";
139			return $this;
140			}
141
142			/**
143			* 查询签名
144			* https://developer.qiniu.com/sms/api/5844/sms-api-create-signature
145			* @return $this
146			*/
147			public function signatureQuery(): self
148			{
149			$this->url = "https://sms.qiniuapi.com/v1/signature";
150			$this->method = "GET";
151			$this->contentType = "application/x-www-form-urlencoded";
152			return $this;
153			}
154
155			/**
156			* 查询单个签名信息
157			* https://developer.qiniu.com/sms/api/5970/query-a-single-signature
158			* @param $id
159			* @return $this
160			* @throws DtaException
161			*/
162			public function signatureQueryId($id): self
163			{
164			if (empty($id)) {
165			throw new DtaException('请检查id参数');
166			}
167			$this->url = "https://sms.qiniuapi.com/v1/signature/{$id}";
168			$this->method = "GET";
169			return $this;
170			}
171
172			/**
173			* 编辑签名
174			* https://developer.qiniu.com/sms/api/5890/sms-api-edit-signature
175			* @param $id
176			* @return $this
177			* @throws DtaException
178			*/
179			public function signatureEditId($id): self
180			{
181			if (empty($id)) {
182			throw new DtaException('请检查id参数');
183			}
184			$this->url = "https://sms.qiniuapi.com/v1/signature/{$id}";
185			$this->method = "PUT";
186			return $this;
187			}
188
189			/**
190			* 删除签名
191			* https://developer.qiniu.com/sms/api/5891/sms-api-delete-signature
192			* @param $id
193			* @return $this
194			* @throws DtaException
195			*/
196			public function signatureDelId($id): self
197			{
198			if (empty($id)) {
199			throw new DtaException('请检查id参数');
200			}
201			$this->url = "https://sms.qiniuapi.com/v1/signature/{$id}";
202			$this->method = "DELETE";
203			return $this;
204			}
205
206			/**
207			* 创建模板
208			* https://developer.qiniu.com/sms/api/5893/sms-api-create-template
209			* @return $this
210			*/
211			public function template(): self
212			{
213			$this->url = "https://sms.qiniuapi.com/v1/template";
214			$this->method = "POST";
215			return $this;
216			}
217
218			/**
219			* 查询模板
220			* https://developer.qiniu.com/sms/api/5894/sms-api-query-template
221			* @return $this
222			*/
223			public function templateQuery(): self
224			{
225			$this->url = "https://sms.qiniuapi.com/v1/template";
226			$this->method = "GET";
227			return $this;
228			}
229
230			/**
231			* 查询单个模版信息
232			* https://developer.qiniu.com/sms/api/5969/query-a-single-template
233			* @param $id
234			* @return $this
235			* @throws DtaException
236			*/
237			public function templateQueryId($id): self
238			{
239			if (empty($id)) {
240			throw new DtaException('请检查id参数');
241			}
242			$this->url = "https://sms.qiniuapi.com/v1/template/{$id}";
243			$this->method = "GET";
244			return $this;
245			}
246
247			/**
248			* 编辑签名
249			* https://developer.qiniu.com/sms/api/5895/sms-api-edit-template
250			* @param $id
251			* @return $this
252			* @throws DtaException
253			*/
254			public function templateEditId($id): self
255			{
256			if (empty($id)) {
257			throw new DtaException('请检查id参数');
258			}
259			$this->url = "https://sms.qiniuapi.com/v1/template/{$id}";
260			$this->method = "PUT";
261			return $this;
262			}
263
264			/**
265			* 删除签名
266			* https://developer.qiniu.com/sms/api/5896/sms-api-delete-template
267			* @param $id
268			* @return $this
269			* @throws DtaException
270			*/
271			public function templateDelId($id): self
272			{
273			if (empty($id)) {
274			throw new DtaException('请检查id参数');
275			}
276			$this->url = "https://sms.qiniuapi.com/v1/template/{$id}";
277			$this->method = "DELETE";
278			return $this;
279			}
280
281			/**
282			* 返回数组数据
283			* @return array\|mixed
284			* @throws DtaException
285			* @throws \GuzzleHttp\Exception\GuzzleException
286			*/
287			public function toArray()
288			{
289			//首先检测是否支持curl
290			if (!extension_loaded("curl")) {
291			throw new HttpException(404, '请开启curl模块！');
292			}
293			$this->http();
294			// 正常
295			if (is_array($this->output)) {
296			return $this->output;
297			}
298			if (is_object($this->output)) {
299			$this->output = $this->object2array($this->output);
300			return $this->output;
301			}
302			$this->output = json_decode($this->output, true);
303			return $this->output;
304			}
305
306			/**
307			* @param $object
308			* @return array
309			*/
310			private function object2array(&$object): array
311			{
312			if (is_object($object)) {
313			$arr = (array)($object);
314			} else {
315			$arr = &$object;
316			}
317			if (is_array($arr)) {
318			foreach ($arr as $varName => $varValue) {
319			$arr[$varName] = $this->object2array($varValue);
320			}
321			}
322			return $arr;
323			}
324
325			/**
326			* 网络请求
327			* @return $this
328			* @throws DtaException
329			* @throws \GuzzleHttp\Exception\GuzzleException
330			*/
331			private function http(): self
332			{
333			if (empty($this->accessKey)) {
334			throw new DtaException('请检查accessKey参数');
335			}
336			if (empty($this->secretKey)) {
337			throw new DtaException('请检查secretKey参数');
338			}
339			$headers = [
			0 ignored issues – show Unused Code introduced 2020-09-21 05:55 UTC by Report Bug Copy Issue Report The assignment to `$headers` is dead and can be removed. Loading history...
340			'Authorization' => $this->authentication(),
341			'Content-Type' => $this->contentType
342			];
343
344			$auth = new Auth($this->accessKey, $this->secretKey);
345			$recToken = $auth->authorizationV2($this->url, $this->method, json_encode($this->param), $this->contentType);
346			$rtcToken['Content-Type'] = $this->contentType;
			0 ignored issues – show Comprehensibility Best Practice introduced 2020-09-21 05:55 UTC by Report Bug Copy Issue Report `$rtcToken` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$rtcToken = array();` before regardless. Loading history...
347			dump($recToken);
348			dump($this->url . "?" . http_build_query($this->param));
349			$ret = Client::get($this->url . "?" . http_build_query($this->param), $recToken);
350			dump($ret);
351			$this->output = $ret->json();
352			return $this;
353			}
354
355			/**
356			* 服务鉴权
357			* https://developer.qiniu.com/sms/api/5842/sms-api-authentication
358			* @return string
359			*/
360			private function authentication()
361			{
362			$url = parse_url($this->url);
363			$data = $url['path'] ?? '';
364			if (isset($url['query'])) {
365			$data .= '?' . $url['query'];
366			}
367			$data .= "\n";
368			if (isset($this->param) && $this->contentType === 'application/x-www-form-urlencoded') {
369			$data .= json_encode($this->param);
370			}
371			return $this->sign($data);
372			}
373
374			/**
375			* @param $data
376			* @return string
377			*/
378			private function sign($data)
379			{
380			$sign = hash_hmac('sha1', $data, $this->secretKey, true);
381			return "Qiniu " . sprintf('%s:%s', $this->accessKey, $this->encode($sign));
382			}
383
384			/**
385			* @param $string
386			* @return string\|string[]
387			*/
388			private function encode($string)
389			{
390			$find = ['+', '/'];
391			$replace = ['-', '_'];
392			return str_replace($find, $replace, base64_encode($string));
393			}
394			}

GC0202 / ThinkLibrary

Push — v6 ( 3606bd...432c9e )

SmsService::signatureQueryId() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like