Twilio::sendMessage() - Code Metrics - Inspection of "feat: v3" - laravel-notification-channels/twilio - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#90)

by Atymic

created 2020-04-08 10:51 UTC

Twilio::sendMessage() B

↳ Parent: Twilio

Complexity

Conditions	7
Paths	14

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	7

Importance

Changes

Metric	Value
dl	0
loc	24
ccs	8
cts	8
cp	1
rs	8.6026
c	0
b	0
f	0
cc	7
nc	14
nop	3
crap	7

<?php

namespace NotificationChannels\Twilio;

use NotificationChannels\Twilio\Exceptions\CouldNotSendNotification;
use Twilio\Exceptions\TwilioException;
use Twilio\Rest\Api\V2010\Account\CallInstance;
use Twilio\Rest\Api\V2010\Account\MessageInstance;
use Twilio\Rest\Client as TwilioService;

class Twilio
{
    /** @var TwilioService */
    protected $twilioService;

    /** @var TwilioConfig */
    private $config;

    public function __construct(TwilioService $twilioService, TwilioConfig $config)
    {
        $this->twilioService = $twilioService;
        $this->config = $config;
    }

    /**
     * Send a TwilioMessage to the a phone number.
     *
     * @param TwilioMessage $message
     * @param string|null        $to
     * @param bool          $useAlphanumericSender
     *
     * @return mixed
     * @throws TwilioException
     * @throws CouldNotSendNotification
     */
    public function sendMessage(TwilioMessage $message, ?string $to, bool $useAlphanumericSender = false)
    {
        try {
            if ($message instanceof TwilioSmsMessage) {
                if ($useAlphanumericSender && $sender = $this->getAlphanumericSender()) {
                    $message->from($sender);
                }

                return $this->sendSmsMessage($message, $to);
            }

            if ($message instanceof TwilioCallMessage) {
                return $this->makeCall($message, $to);
            }
        } catch (TwilioException $e) {
            if ($this->config->isIgnoredErrorCode($e->getCode())) {
                return null;
            }

            throw $e;
        }

        throw CouldNotSendNotification::invalidMessageObject($message);
    }

    /**
     * Send an sms message using the Twilio Service.
     *
     * @param TwilioSmsMessage $message
     * @param string|null      $to
     *
     * @return MessageInstance
     * @throws CouldNotSendNotification
     * @throws TwilioException
     */
    protected function sendSmsMessage(TwilioSmsMessage $message, ?string $to): MessageInstance
    {
        $params = [
            'body' => trim($message->content),
        ];

        if ($messagingServiceSid = $this->getMessagingServiceSid($message)) {
            $params['messagingServiceSid'] = $messagingServiceSid;
        }

        if ($from = $this->getFrom($message)) {
            $params['from'] = $from;
        }

        if (! $from && ! $messagingServiceSid) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            throw CouldNotSendNotification::missingFrom();
        }

        $this->fillOptionalParams($params, $message, [
            'statusCallback',
            'statusCallbackMethod',
            'applicationSid',
            'forceDelivery',
            'maxPrice',
            'provideFeedback',
            'validityPeriod',
        ]);

        if ($message instanceof TwilioMmsMessage) {
            $this->fillOptionalParams($params, $message, [
                'mediaUrl',
            ]);
        }

        return $this->twilioService->messages->create($to, $params);
    }

    /**
     * Make a call using the Twilio Service.
     *
     * @param TwilioCallMessage $message
     * @param string|null           $to
     *
     * @return CallInstance
     * @throws TwilioException
     * @throws CouldNotSendNotification
     */
    protected function makeCall(TwilioCallMessage $message, ?string $to): CallInstance
    {
        $params = [
            'url' => trim($message->content),
        ];

        $this->fillOptionalParams($params, $message, [
            'statusCallback',
            'statusCallbackMethod',
            'method',
            'status',
            'fallbackUrl',
            'fallbackMethod',
        ]);

        if (! $from = $this->getFrom($message)) {
            throw CouldNotSendNotification::missingFrom();
        }

        return $this->twilioService->calls->create(
            $to,
            $from,
            $params
        );
    }

    /**
     * Get the from address from message, or config.
     *
     * @param TwilioMessage $message
     * @return string|null
     */
    protected function getFrom(TwilioMessage $message): ?string
    {
        return $message->getFrom() ?: $this->config->getFrom();
    }

    /**
     * Get the messaging service SID from message, or config.
     *
     * @param TwilioSmsMessage $message
     * @return string|null
     */
    protected function getMessagingServiceSid(TwilioSmsMessage $message): ?string
    {
        return $message->getMessagingServiceSid() ?: $this->config->getServiceSid();
    }

    /**
     * Get the alphanumeric sender from config, if one exists.
     *
     * @return string|null
     */
    protected function getAlphanumericSender(): ?string
    {
        return $this->config->getAlphanumericSender();
    }

    /**
     * @param array $params
     * @param TwilioMessage $message
     * @param array $optionalParams
     * @return Twilio
     */
    protected function fillOptionalParams(&$params, $message, $optionalParams): self
    {
        foreach ($optionalParams as $optionalParam) {
            if ($message->$optionalParam) {
                $params[$optionalParam] = $message->$optionalParam;
            }
        }

        return $this;
    }
}


1		<?php
2
3		namespace NotificationChannels\Twilio;
4
5		use NotificationChannels\Twilio\Exceptions\CouldNotSendNotification;
6		use Twilio\Exceptions\TwilioException;
7		use Twilio\Rest\Api\V2010\Account\CallInstance;
8		use Twilio\Rest\Api\V2010\Account\MessageInstance;
9		use Twilio\Rest\Client as TwilioService;
10
11		class Twilio
12		{
13		/** @var TwilioService */
14		protected $twilioService;
15
16		/** @var TwilioConfig */
17		private $config;
18
19		public function __construct(TwilioService $twilioService, TwilioConfig $config)
20		{
21		$this->twilioService = $twilioService;
22		$this->config = $config;
23		}
24
25		/**
26	13	* Send a TwilioMessage to the a phone number.
27		*
28	13	* @param TwilioMessage $message
29	13	* @param string\|null $to
30	13	* @param bool $useAlphanumericSender
31		*
32		* @return mixed
33		* @throws TwilioException
34		* @throws CouldNotSendNotification
35		*/
36		public function sendMessage(TwilioMessage $message, ?string $to, bool $useAlphanumericSender = false)
37		{
38		try {
39		if ($message instanceof TwilioSmsMessage) {
40		if ($useAlphanumericSender && $sender = $this->getAlphanumericSender()) {
41	11	$message->from($sender);
42		}
43	11
44	8	return $this->sendSmsMessage($message, $to);
45	2	}
46
47		if ($message instanceof TwilioCallMessage) {
48	8	return $this->makeCall($message, $to);
49		}
50		} catch (TwilioException $e) {
51	3	if ($this->config->isIgnoredErrorCode($e->getCode())) {
52	2	return null;
53		}
54
55	1	throw $e;
56		}
57
58		throw CouldNotSendNotification::invalidMessageObject($message);
59		}
60
61		/**
62		* Send an sms message using the Twilio Service.
63		*
64		* @param TwilioSmsMessage $message
65	8	* @param string\|null $to
66		*
67		* @return MessageInstance
68	8	* @throws CouldNotSendNotification
69		* @throws TwilioException
70		*/
71	8	protected function sendSmsMessage(TwilioSmsMessage $message, ?string $to): MessageInstance
72	2	{
73		$params = [
74		'body' => trim($message->content),
75	8	];
76	7
77		if ($messagingServiceSid = $this->getMessagingServiceSid($message)) {
78		$params['messagingServiceSid'] = $messagingServiceSid;
79	8	}
80	1
81		if ($from = $this->getFrom($message)) {
82		$params['from'] = $from;
83	7	}
84	7
85		if (! $from && ! $messagingServiceSid) {
		0 ignored issues – show Bug Best Practice introduced 2020-04-08 01:06 UTC by Report Bug Copy Issue Report The expression `$from` of type `string\|null` is loosely compared to `false`; this is ambiguous if the string can be empty. You might want to explicitly use `=== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history... Bug Best Practice introduced 2020-03-10 17:49 UTC by Report Bug Copy Issue Report The expression `$messagingServiceSid` of type `string\|null` is loosely compared to `false`; this is ambiguous if the string can be empty. You might want to explicitly use `=== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
86		throw CouldNotSendNotification::missingFrom();
87		}
88
89		$this->fillOptionalParams($params, $message, [
90		'statusCallback',
91		'statusCallbackMethod',
92		'applicationSid',
93	7	'forceDelivery',
94	1	'maxPrice',
95	1	'provideFeedback',
96		'validityPeriod',
97		]);
98
99	7	if ($message instanceof TwilioMmsMessage) {
100		$this->fillOptionalParams($params, $message, [
101		'mediaUrl',
102		]);
103		}
104
105		return $this->twilioService->messages->create($to, $params);
106		}
107
108		/**
109		* Make a call using the Twilio Service.
110	2	*
111		* @param TwilioCallMessage $message
112		* @param string\|null $to
113	2	*
114		* @return CallInstance
115		* @throws TwilioException
116	2	* @throws CouldNotSendNotification
117	2	*/
118		protected function makeCall(TwilioCallMessage $message, ?string $to): CallInstance
119		{
120		$params = [
121		'url' => trim($message->content),
122		];
123
124		$this->fillOptionalParams($params, $message, [
125	2	'statusCallback',
126		'statusCallbackMethod',
127		'method',
128		'status',
129	2	'fallbackUrl',
130	2	'fallbackMethod',
131		]);
132
133		if (! $from = $this->getFrom($message)) {
134		throw CouldNotSendNotification::missingFrom();
135		}
136
137		return $this->twilioService->calls->create(
138		$to,
139		$from,
140		$params
141		);
142	10	}
143
144	10	/**
145		* Get the from address from message, or config.
146		*
147		* @param TwilioMessage $message
148		* @return string\|null
149		*/
150		protected function getFrom(TwilioMessage $message): ?string
151		{
152		return $message->getFrom() ?: $this->config->getFrom();
153	8	}
154
155	8	/**
156		* Get the messaging service SID from message, or config.
157		*
158		* @param TwilioSmsMessage $message
159		* @return string\|null
160		*/
161		protected function getMessagingServiceSid(TwilioSmsMessage $message): ?string
162		{
163	2	return $message->getMessagingServiceSid() ?: $this->config->getServiceSid();
164		}
165	2
166	2	/**
167		* Get the alphanumeric sender from config, if one exists.
168		*
169		* @return string\|null
170		*/
171		protected function getAlphanumericSender(): ?string
172		{
173		return $this->config->getAlphanumericSender();
174		}
175
176	9	/**
177		* @param array $params
178	9	* @param TwilioMessage $message
179	9	* @param array $optionalParams
180	3	* @return Twilio
181		*/
182		protected function fillOptionalParams(&$params, $message, $optionalParams): self
183		{
184	9	foreach ($optionalParams as $optionalParam) {
185		if ($message->$optionalParam) {
186		$params[$optionalParam] = $message->$optionalParam;
187		}
188		}
189
190		return $this;
191		}
192		}
193

laravel-notification-channels / twilio

GitHub Access Token became invalid

Pull Request — master (#90)

Twilio::sendMessage() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like