TurboSMS::getBalanceJson() - Code Metrics - Inspection of "Add getBalanceJson()" - daaner/turbosms - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( ac2a98...d040cc )

by Andrey

created 2020-10-29 20:38 UTC

TurboSMS::getBalanceJson() A

↳ Parent: TurboSMS

Complexity

Conditions	1
Paths	1

Size

Total Lines	11
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	6
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	11
rs	10

<?php

namespace Daaner\TurboSMS;

use Daaner\TurboSMS\Contracts\TurboSMSInterface;
use Daaner\TurboSMS\Traits\StartTimeAddition;
use Daaner\TurboSMS\Traits\ViberAddition;
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 integer|null
     */
    public function getBalance()
    {
        $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()
    {
        $module = 'user';
        $method = 'balance.json';

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

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

        return $answers;
    }

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

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

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

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

        return $answers;
    }

    /**
     * @param string|array $recipients
     * @param string $text
     * @param string|null $type
     * @return array
     */
    public function sendMessages($recipients, $text, $type = null)
    {
        $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;
        }

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

        return $answers;
    }

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

        $response = Http::timeout(3)
            ->retry(2, 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 (! 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 null|string
     */
    public function getApi()
    {
        if (is_null($this->api)) {
            $this->api = config('turbosms.api_key');
        }

        return $this->api;
    }

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

        return $this;
    }

    /**
     * @return null|string
     */
    public function getViberSender()
    {
        if (is_null($this->viberSender)) {

            $this->viberSender = config('turbosms.viber_sender');
        }

        return $this->viberSender;

    }

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

        return $this;
    }

    /**
     * @return string $smsSender
     */
    public function getSMSSender()
    {
        if (is_null($this->smsSender)) {

            $this->smsSender = config('turbosms.sms_sender');
        }

        return $this->smsSender;

    }

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

        return $this;
    }


    /**
     * Убираем у телефонов пробелы, скобки, минусы и плюсы.
     *
     * @param string|array $phones
     * @return array $phones
     */
    public function phonesTrim($phones)
    {

        $phones->transform(function ($item) {
            return preg_replace('/[^0-9]/', '', $item);
        });

        return $phones;

    }

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

        return $body;
    }

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

daaner / turbosms

Push — master ( ac2a98...d040cc )

TurboSMS::getBalanceJson() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like