Merge branch 'danielebuso-custom-sender'

Author: claudsonm

README.md

@@ -80,20 +80,22 @@ class AccountApproved extends Notification
 
         return SnsMessage::create()
             ->body("Your {$notifiable->service} account was approved!")
-            ->transactional();
+            ->transactional()
+            ->sender("MyStore");
 
         // or
 
         return SnsMessage::create([
             'body' => "Your {$notifiable->service} account was approved!",
-            'transactional' => true
+            'transactional' => true,
+            'sender' => "MyStore"
         ]);
 
         // or
 
         return SnsMessage::create([
             'body' => "Your {$notifiable->service} account was approved!"
-        ])->promotional();
+        ])->promotional()->sender("MyStore");
     }
 }
 ```
@@ -116,6 +118,7 @@ public function routeNotificationForSns()
 - `body('')`: Accepts a string value for the notification body. Messages with more than 140 characters will be split into multiple messages by SNS without breaking any words.
 - `promotional(bool)`: Sets the SMS attribute as the promotional delivery type (default). Optimizes the delivery for lower costs.
 - `transactional(bool)`: Sets the SMS attribute as the transactional delivery type. Optimizes the delivery to achieve the highest reliability (it also costs more). 
+- `sender(string)`: Sets the SMS sender id. It can be up to 11 characters with no spaces. 
 
 More information about the SMS Attributes can be found on the [AWS SNS Docs](https://docs.aws.amazon.com/pt_br/sdk-for-php/v3/developer-guide/sns-examples-sending-sms.html#get-sms-attributes).
 It's important to know that the attributes set on the message will override the

src/Sns.php

@@ -25,15 +25,26 @@ public function __construct(SnsService $snsService)
      */
     public function send(SnsMessage $message, $destination)
     {
+        $attributes = [
+            'AWS.SNS.SMS.SMSType' => [
+                'DataType' => 'String',
+                'StringValue' => $message->getDeliveryType(),
+            ],
+        ];
+
+        if (! empty($message->getSender())) {
+            $attributes +=  [
+                'AWS.SNS.SMS.SenderID' => [
+                    'DataType' => 'String',
+                    'StringValue' => $message->getSender(),
+                ],
+            ];
+        }
+
         $parameters = [
             'Message' => $message->getBody(),
             'PhoneNumber' => $destination,
-            'MessageAttributes' => [
-                'AWS.SNS.SMS.SMSType' => [
-                    'DataType' => 'String',
-                    'StringValue' => $message->getDeliveryType(),
-                ],
-            ],
+            'MessageAttributes' => $attributes,
         ];
 
         return $this->snsService->publish($parameters);

src/SnsMessage.php

@@ -9,18 +9,25 @@ class SnsMessage
     const TRANSACTIONAL_SMS_TYPE = 'Transactional';
 
     /**
-     * The default delivery type for the SMS message.
+     * The body of the message.
+     *
+     * @var string
+     */
+    protected $body = '';
+
+    /**
+     * The delivery type of the message.
      *
      * @var bool
      */
     protected $promotional = true;
 
     /**
-     * The body of the message.
+     * The sender identification of the message.
      *
      * @var string
      */
-    protected $body = '';
+    protected $sender = '';
 
     public function __construct($content)
     {
@@ -40,6 +47,7 @@ public function __construct($content)
     /**
      * Creates a new instance of the message.
      *
+     * @param array $data
      * @return SnsMessage
      */
     public static function create(array $data = [])
@@ -50,6 +58,7 @@ public static function create(array $data = [])
     /**
      * Sets the message body.
      *
+     * @param string $content
      * @return $this
      */
     public function body(string $content)
@@ -70,36 +79,61 @@ public function getBody()
     }
 
     /**
-     * Get the SMS delivery type.
+     * Sets the message delivery type as promotional.
      *
-     * @return string
+     * @param bool $active
+     * @return $this
      */
-    public function getDeliveryType()
+    public function promotional(bool $active = true)
     {
-        return $this->promotional ? self::PROMOTIONAL_SMS_TYPE : self::TRANSACTIONAL_SMS_TYPE;
+        $this->promotional = $active;
+
+        return $this;
     }
 
     /**
-     * Sets the SMS delivery type as promotional.
+     * Sets the message delivery type as transactional.
      *
+     * @param bool $active
      * @return $this
      */
-    public function promotional(bool $active = true)
+    public function transactional(bool $active = true)
     {
-        $this->promotional = $active;
+        $this->promotional = ! $active;
 
         return $this;
     }
 
     /**
-     * Sets the SMS delivery type as transactional.
+     * Get the message delivery type.
+     *
+     * @return string
+     */
+    public function getDeliveryType()
+    {
+        return $this->promotional ? self::PROMOTIONAL_SMS_TYPE : self::TRANSACTIONAL_SMS_TYPE;
+    }
+
+    /**
+     * Sets the message sender identification.
      *
+     * @param string $sender
      * @return $this
      */
-    public function transactional(bool $active = true)
+    public function sender(string $sender)
     {
-        $this->promotional = ! $active;
+        $this->sender = $sender;
 
         return $this;
     }
+
+    /**
+     * Get the message sender identification.
+     *
+     * @return string
+     */
+    public function getSender()
+    {
+        return $this->sender;
+    }
 }

tests/SnsMessageTest.php

@@ -61,14 +61,30 @@ public function the_sms_delivery_type_can_be_explicitly_as_promotional()
         $this->assertEquals('Promotional', $message->getDeliveryType());
     }
 
+    /** @test */
+    public function the_default_sms_sender_id_is_empty()
+    {
+        $message = SnsMessage::create();
+        $this->assertEmpty($message->getSender());
+    }
+
+    /** @test */
+    public function the_sms_sender_id_can_be_changed_using_a_proper_method()
+    {
+        $message = SnsMessage::create()->sender('Test');
+        $this->assertEquals('Test', $message->getSender());
+    }
+
     /** @test */
     public function it_can_accept_all_the_contents_when_constructing_a_message()
     {
         $message = SnsMessage::create([
             'body' => 'My mass body',
             'transactional' => true,
+            'sender' => 'Test',
         ]);
         $this->assertEquals('My mass body', $message->getBody());
         $this->assertEquals('Transactional', $message->getDeliveryType());
+        $this->assertEquals('Test', $message->getSender());
     }
 }

tests/SnsTest.php

@@ -81,4 +81,30 @@ public function it_can_send_a_transactional_sms_message_to_sns()
 
         $this->sns->send($message, '+22222222222');
     }
+
+    /** @test */
+    public function it_can_send_a_sms_message_with_sender_id()
+    {
+        $message = new SnsMessage(['body' => 'Message text', 'sender' => 'CompanyInc']);
+
+        $this->snsService->shouldReceive('publish')
+            ->atLeast()->once()
+            ->with([
+                'Message' => 'Message text',
+                'PhoneNumber' => '+33333333333',
+                'MessageAttributes' => [
+                    'AWS.SNS.SMS.SMSType' => [
+                        'DataType' => 'String',
+                        'StringValue' => 'Promotional',
+                    ],
+                    'AWS.SNS.SMS.SenderID' => [
+                        'DataType' => 'String',
+                        'StringValue' => 'CompanyInc',
+                    ],
+                ],
+            ])
+            ->andReturn(true);
+
+        $this->sns->send($message, '+33333333333');
+    }
 }