TurboSMS::setApi() - Code Metrics - Inspection of "Fix return null (new temporary errors)" - daaner/turbosms - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 2d5f59...f3a7c1 )

by Andrey

created 2022-09-13 12:58 UTC

TurboSMS::setApi() A

↳ Parent: TurboSMS

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace Daaner\TurboSMS;

use Daaner\TurboSMS\Contracts\TurboSMSInterface;
use Daaner\TurboSMS\Traits\StartTimeAddition;
use Daaner\TurboSMS\Traits\ViberAddition;
use Illuminate\Support\Collection;
use Illuminate\Support\Facades\Http;

class TurboSMS implements TurboSMSInterface
{
    use ViberAddition, StartTimeAddition;

    protected $api;
    protected $viberSender;
    protected $smsSender;
    protected $startTime;
    protected $isTest;

    protected $baseUri = 'https://api.turbosms.ua/';

    /**
     * TurboSMS constructor main settings.
     */
    public function __construct()
    {
        $this->getApi();
        $this->getViberSender();
        $this->getSMSSender();
        $this->isTest = config('turbosms.test_mode');
    }

    /**
     * @return int|null
     */
    public function getBalance(): ?int
    {
        $balance = null;
        $module = 'user';
        $method = 'balance.json';

        $url = $this->baseUri.$module.'/'.$method;
        $body = [];

        $answers = $this->getResponse($url, $body);

        if (isset($answers['result']['balance'])) {
            $balance = $answers['result']['balance'];
        }

        return $balance;
    }

    /**
     * @return array
     */
    public function getBalanceJson(): array
    {
        $module = 'user';
        $method = 'balance.json';

        $url = $this->baseUri.$module.'/'.$method;
        $body = [];

        return $this->getResponse($url, $body);
    }

    /**
     * @param  string|array  $messageId
     * @return array
     */
    public function getItemsStatus($messageId): array
    {
        $module = 'message';
        $method = 'status.json';

        $messages = collect($messageId)->values()->all();

        $url = $this->baseUri.$module.'/'.$method;
        $body = [
            'messages' => $messages,
        ];

        return $this->getResponse($url, $body);
    }

    /**
     * @param  string|array  $recipients
     * @param  string  $text
     * @param  string|null  $type
     * @return array
     */
    public function sendMessages($recipients, string $text, string $type = null): array
    {
        $module = 'message';
        $method = 'send.json';

        if (! $text) {
            return [
                'success' => false,
                'result' => null,
                'info' => __('turbosms::turbosms.empty_text'),
            ];
        }

        $phone = collect($recipients);
        $phones = $this->phonesTrim($phone);
        $phones = $phones->values()->all();

        $url = $this->baseUri.$module.'/'.$method;
        $body = [
            'recipients' => $phones,
        ];

        //SMS
        if ($type == 'sms' || ! $type) {
            $body = $this->bodySMS($body, $text);
        }
        //VIBER
        if ($type == 'viber') {
            $body = $this->bodyViber($body, $text);
        }
        //Гибридная доставка
        if ($type == 'both') {
            $body = $this->bodySMS($body, $text);
            $body = $this->bodyViber($body, $text);
        }

        //Доставка в определенное время
        if ($this->startTime) {
            $body['start_time'] = $this->startTime;
        }

        return $this->getResponse($url, $body);
    }

    /**
     * @param  string  $url
     * @param  array  $body
     * @return array
     */
    public function getResponse(string $url, array $body): array
    {
        if ($this->isTest) {
            return [
                'success' => false,
                'result' => [
                    'url' => $url,
                    'body' => $body,
                ],
                'info' => __('turbosms::turbosms.test_mode'),
            ];
        }

        $response = Http::timeout(config('turbosms.http_response_timeout', 3))
            ->retry(config('turbosms.http_retry_max_time', 2), config('turbosms.http_retry_delay', 200))
            ->withHeaders([
                'Accept' => 'application/json',
                'Authorization' => 'Bearer '.$this->api,
                'Content-Type' => 'application/json',
            ])->post($url, $body);

        if ($response->failed()) {
            return [
                'success' => false,
                'result' => null,
                'info' => __('turbosms::turbosms.error_data'),
            ];
        }

        $answer = $response->json();
        if (!$answer || ! isset($answer['response_result']) || ! $answer['response_result']) {

            $error = __('turbosms::turbosms.response_status.'.$answer['response_status']);

            return [
                'success' => false,
                'result' => null,
                'info' => $error,
            ];
        }

        $info = __('turbosms::turbosms.response_status.'.$answer['response_status']);

        return [
            'success' => true,
            'result' => $answer['response_result'],
            'info' => $info,
        ];
    }

    // =================== SUPPORT ===================

    /**
     * @return string
     */
    public function getApi(): string
    {
        if (is_null($this->api)) {
            $this->api = (string) config('turbosms.api_key');
        }

        return $this->api;
    }

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

        return $this;
    }

    /**
     * @return string
     */
    public function getViberSender(): string
    {
        if (is_null($this->viberSender)) {
            $this->viberSender = (string) config('turbosms.viber_sender');
        }

        return $this->viberSender;

    }

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

        return $this;
    }

    /**
     * @return string
     */
    public function getSMSSender(): ?string
    {
        if (is_null($this->smsSender)) {
            $this->smsSender = config('turbosms.sms_sender');
        }

        return $this->smsSender;

    }

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

        return $this;
    }

    /**
     * Убираем у телефонов пробелы, скобки, минусы и плюсы.
     *
     * @param  Collection  $phones
     * @return Collection $phones
     */
    public function phonesTrim(Collection $phones): Collection
    {
        $phones->transform(function ($item) {
            return preg_replace('/[^0-9]/', '', $item);
        });

        return $phones;
    }

    /**
     * Формируем $body для SMS.
     *
     * @param  array  $body
     * @param  string  $text
     * @return array $body
     */
    public function bodySMS(array $body, string $text): array
    {
        $body['sms'] = [
            'sender' => $this->smsSender,
            'text' => $text,
        ];

        return $body;
    }

    /**
     * Формируем $body для Viber.
     *
     * @param  array  $body
     * @param  string  $text
     * @return array $body
     */
    public function bodyViber(array $body, string $text): array
    {
        $msg = $text;
        if ($this->viberReplaceText) {
            $msg = $this->viberReplaceText;
        }

        $body['viber'] = [
            'sender' => $this->viberSender,
            'text' => $msg,
        ];

        if ($this->ttl) {
            $body['viber']['ttl'] = $this->ttl;
        }
        if ($this->imageUrl) {
            $body['viber']['image_url'] = $this->imageUrl;
        }
        if ($this->caption) {
            $body['viber']['caption'] = $this->caption;
        }
        if ($this->action) {
            $body['viber']['action'] = $this->action;
        }
        if ($this->countClicks) {
            $body['viber']['count_clicks'] = $this->countClicks;
        }
        if ($this->isTransactional) {
            $body['viber']['is_transactional'] = $this->isTransactional;
        }

        return $body;
    }
}


1			<?php
2
3			namespace Daaner\TurboSMS;
4
5			use Daaner\TurboSMS\Contracts\TurboSMSInterface;
6			use Daaner\TurboSMS\Traits\StartTimeAddition;
7			use Daaner\TurboSMS\Traits\ViberAddition;
8			use Illuminate\Support\Collection;
9			use Illuminate\Support\Facades\Http;
10
11			class TurboSMS implements TurboSMSInterface
12			{
13			use ViberAddition, StartTimeAddition;
14
15			protected $api;
16			protected $viberSender;
17			protected $smsSender;
18			protected $startTime;
19			protected $isTest;
20
21			protected $baseUri = 'https://api.turbosms.ua/';
22
23			/**
24			* TurboSMS constructor main settings.
25			*/
26			public function __construct()
27			{
28			$this->getApi();
29			$this->getViberSender();
30			$this->getSMSSender();
31			$this->isTest = config('turbosms.test_mode');
32			}
33
34			/**
35			* @return int\|null
36			*/
37			public function getBalance(): ?int
38			{
39			$balance = null;
40			$module = 'user';
41			$method = 'balance.json';
42
43			$url = $this->baseUri.$module.'/'.$method;
44			$body = [];
45
46			$answers = $this->getResponse($url, $body);
47
48			if (isset($answers['result']['balance'])) {
49			$balance = $answers['result']['balance'];
50			}
51
52			return $balance;
53			}
54
55			/**
56			* @return array
57			*/
58			public function getBalanceJson(): array
59			{
60			$module = 'user';
61			$method = 'balance.json';
62
63			$url = $this->baseUri.$module.'/'.$method;
64			$body = [];
65
66			return $this->getResponse($url, $body);
67			}
68
69			/**
70			* @param string\|array $messageId
71			* @return array
72			*/
73			public function getItemsStatus($messageId): array
74			{
75			$module = 'message';
76			$method = 'status.json';
77
78			$messages = collect($messageId)->values()->all();
79
80			$url = $this->baseUri.$module.'/'.$method;
81			$body = [
82			'messages' => $messages,
83			];
84
85			return $this->getResponse($url, $body);
86			}
87
88			/**
89			* @param string\|array $recipients
90			* @param string $text
91			* @param string\|null $type
92			* @return array
93			*/
94			public function sendMessages($recipients, string $text, string $type = null): array
95			{
96			$module = 'message';
97			$method = 'send.json';
98
99			if (! $text) {
100			return [
101			'success' => false,
102			'result' => null,
103			'info' => __('turbosms::turbosms.empty_text'),
104			];
105			}
106
107			$phone = collect($recipients);
108			$phones = $this->phonesTrim($phone);
109			$phones = $phones->values()->all();
110
111			$url = $this->baseUri.$module.'/'.$method;
112			$body = [
113			'recipients' => $phones,
114			];
115
116			//SMS
117			if ($type == 'sms' \|\| ! $type) {
118			$body = $this->bodySMS($body, $text);
119			}
120			//VIBER
121			if ($type == 'viber') {
122			$body = $this->bodyViber($body, $text);
123			}
124			//Гибридная доставка
125			if ($type == 'both') {
126			$body = $this->bodySMS($body, $text);
127			$body = $this->bodyViber($body, $text);
128			}
129
130			//Доставка в определенное время
131			if ($this->startTime) {
132			$body['start_time'] = $this->startTime;
133			}
134
135			return $this->getResponse($url, $body);
136			}
137
138			/**
139			* @param string $url
140			* @param array $body
141			* @return array
142			*/
143			public function getResponse(string $url, array $body): array
144			{
145			if ($this->isTest) {
146			return [
147			'success' => false,
148			'result' => [
149			'url' => $url,
150			'body' => $body,
151			],
152			'info' => __('turbosms::turbosms.test_mode'),
153			];
154			}
155
156			$response = Http::timeout(config('turbosms.http_response_timeout', 3))
157			->retry(config('turbosms.http_retry_max_time', 2), config('turbosms.http_retry_delay', 200))
158			->withHeaders([
159			'Accept' => 'application/json',
160			'Authorization' => 'Bearer '.$this->api,
161			'Content-Type' => 'application/json',
162			])->post($url, $body);
163
164			if ($response->failed()) {
165			return [
166			'success' => false,
167			'result' => null,
168			'info' => __('turbosms::turbosms.error_data'),
169			];
170			}
171
172			$answer = $response->json();
173			if (!$answer \|\| ! isset($answer['response_result']) \|\| ! $answer['response_result']) {
			0 ignored issues – show Bug Best Practice introduced 2022-09-13 13:05 UTC by Report Bug Copy Issue Report The expression `$answer` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
174			$error = __('turbosms::turbosms.response_status.'.$answer['response_status']);
175
176			return [
177			'success' => false,
178			'result' => null,
179			'info' => $error,
180			];
181			}
182
183			$info = __('turbosms::turbosms.response_status.'.$answer['response_status']);
184
185			return [
186			'success' => true,
187			'result' => $answer['response_result'],
188			'info' => $info,
189			];
190			}
191
192			// =================== SUPPORT ===================
193
194			/**
195			* @return string
196			*/
197			public function getApi(): string
198			{
199			if (is_null($this->api)) {
200			$this->api = (string) config('turbosms.api_key');
201			}
202
203			return $this->api;
204			}
205
206			/**
207			* @param string $api
208			* @return $this
209			*/
210			public function setApi(string $api): self
211			{
212			$this->api = $api;
213
214			return $this;
215			}
216
217			/**
218			* @return string
219			*/
220			public function getViberSender(): string
221			{
222			if (is_null($this->viberSender)) {
223			$this->viberSender = (string) config('turbosms.viber_sender');
224			}
225
226			return $this->viberSender;
			0 ignored issues – show Bug Best Practice introduced 2022-07-22 09:30 UTC by Report Bug Copy Issue Report The expression `return $this->viberSender` returns the type `mixed` which is incompatible with the type-hinted return `string`. Loading history...
227			}
228
229			/**
230			* @param string $viberSender
231			* @return $this
232			*/
233			public function setViberSender(string $viberSender): self
234			{
235			$this->viberSender = $viberSender;
236
237			return $this;
238			}
239
240			/**
241			* @return string
242			*/
243			public function getSMSSender(): ?string
244			{
245			if (is_null($this->smsSender)) {
246			$this->smsSender = config('turbosms.sms_sender');
247			}
248
249			return $this->smsSender;
			0 ignored issues – show Bug Best Practice introduced 2022-07-20 18:37 UTC by Report Bug Copy Issue Report The expression `return $this->smsSender` returns the type `mixed` which is incompatible with the type-hinted return `null\|string`. Loading history...
250			}
251
252			/**
253			* @param string $smsSender
254			* @return $this
255			*/
256			public function setSMSSender(string $smsSender): self
257			{
258			$this->smsSender = $smsSender;
259
260			return $this;
261			}
262
263			/**
264			* Убираем у телефонов пробелы, скобки, минусы и плюсы.
265			*
266			* @param Collection $phones
267			* @return Collection $phones
268			*/
269			public function phonesTrim(Collection $phones): Collection
270			{
271			$phones->transform(function ($item) {
272			return preg_replace('/[^0-9]/', '', $item);
273			});
274
275			return $phones;
276			}
277
278			/**
279			* Формируем $body для SMS.
280			*
281			* @param array $body
282			* @param string $text
283			* @return array $body
284			*/
285			public function bodySMS(array $body, string $text): array
286			{
287			$body['sms'] = [
288			'sender' => $this->smsSender,
289			'text' => $text,
290			];
291
292			return $body;
293			}
294
295			/**
296			* Формируем $body для Viber.
297			*
298			* @param array $body
299			* @param string $text
300			* @return array $body
301			*/
302			public function bodyViber(array $body, string $text): array
303			{
304			$msg = $text;
305			if ($this->viberReplaceText) {
306			$msg = $this->viberReplaceText;
307			}
308
309			$body['viber'] = [
310			'sender' => $this->viberSender,
311			'text' => $msg,
312			];
313
314			if ($this->ttl) {
315			$body['viber']['ttl'] = $this->ttl;
316			}
317			if ($this->imageUrl) {
318			$body['viber']['image_url'] = $this->imageUrl;
319			}
320			if ($this->caption) {
321			$body['viber']['caption'] = $this->caption;
322			}
323			if ($this->action) {
324			$body['viber']['action'] = $this->action;
325			}
326			if ($this->countClicks) {
327			$body['viber']['count_clicks'] = $this->countClicks;
328			}
329			if ($this->isTransactional) {
330			$body['viber']['is_transactional'] = $this->isTransactional;
331			}
332
333			return $body;
334			}
335			}
336

daaner / turbosms

Push — master ( 2d5f59...f3a7c1 )

TurboSMS::setApi() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like