Add option to use Twilio's URL shortener (#138)

Co-authored-by: atymic <[email protected]>

Author: jbajou

README.md

@@ -44,7 +44,8 @@ TWILIO_ACCOUNT_SID=1234 # always required
 TWILIO_FROM=100000000 # optional default from
 TWILIO_ALPHA_SENDER=HELLO # optional
 TWILIO_DEBUG_TO=23423423423 # Set a number that call calls/messages should be routed to for debugging
-TWILIO_SMS_SERVICE_SID=MG0a0aaaaaa00aa00a00a000a00000a00a # Optional but recommended 
+TWILIO_SMS_SERVICE_SID=MG0a0aaaaaa00aa00a00a000a00000a00a # Optional but recommended
+TWILIO_SHORTEN_URLS=true # optional, enable URL shortener
 ```
 
 ### Advanced configuration

config/twilio-notification-channel.php

@@ -8,6 +8,7 @@
 
     'from' => env('TWILIO_FROM'), // optional
     'alphanumeric_sender' => env('TWILIO_ALPHA_SENDER'),
+    'shorten_urls' => env('TWILIO_SHORTEN_URLS', false), // optional, enable twilio URL shortener
 
     /**
      * See https://www.twilio.com/docs/sms/services.

src/Twilio.php

@@ -76,6 +76,10 @@ protected function sendSmsMessage(TwilioSmsMessage $message, ?string $to): Messa
             $params['messagingServiceSid'] = $messagingServiceSid;
         }
 
+        if ($this->config->isShortenUrlsEnabled()) {
+            $params['ShortenUrls'] = "true";
+        }
+
         if ($from = $this->getFrom($message)) {
             $params['from'] = $from;
         }

src/TwilioConfig.php

@@ -78,4 +78,9 @@ public function isIgnoredErrorCode(int $code): bool
 
         return in_array($code, $this->getIgnoredErrorCodes(), true);
     }
+
+    public function isShortenUrlsEnabled(): bool
+    {
+        return $this->config['shorten_urls'] ?? false;
+    }
 }

tests/Unit/IntegrationTest.php

@@ -82,6 +82,28 @@ public function it_can_send_a_sms_message_using_service()
         $channel->send(new NotifiableWithAttribute(), $this->notification);
     }
 
+    /** @test */
+    public function it_can_send_a_sms_message_using_url_shortener()
+    {
+        $message = TwilioSmsMessage::create('Message text');
+        $this->notification->shouldReceive('toTwilio')->andReturn($message);
+
+        $config = new TwilioConfig([
+            'from' => '+31612345678',
+            'ShortenUrls' => true,
+        ]);
+        $twilio = new Twilio($this->twilioService, $config);
+        $channel = new TwilioChannel($twilio, $this->events);
+
+        $this->smsMessageWillBeSentToTwilioWith('+22222222222', [
+            'from' => '+31612345678',
+            'body' => 'Message text',
+            'ShortenUrls' => 'true',
+        ]);
+
+        $channel->send(new NotifiableWithAttribute(), $this->notification);
+    }
+
     /** @test */
     public function it_can_send_a_sms_message_using_alphanumeric_sender()
     {