Merge pull request #12 from TechTomaz/feat/rebase_sms_options

Feat/rebase sms options

Author: larsemil

README.md

@@ -86,13 +86,22 @@ The FortySixElksSMS have the following methods, all chainable.
 ### Available Message methods for sms
 
 
-``from($mixed)``. Accepts a string up to 11 characters or number. Sms will be sent with that name.
+``from($mixed)`` Accepts a string up to 11 characters or number. Sms will be sent with that name.
 
-``to($number)``. International phone number.
+``to($number)`` International phone number.
 
-``line($string)``. Every string in a line will be on its own row.
+``line($string)`` Every string in a line will be on its own row.
+
+``flash()`` Will set the message type to flash. Will not endup in sms inbox. See [This tweet](https://twitter.com/46elks/status/583183559420178432) to find out how it looks on an iphone.
+
+``dryrun()`` Enable when you want to verify your API request without actually sending an SMS to a mobile phone.
+              No SMS message will be sent when this is enabled. 
+
+``whendelivered('http://localhost')`` This webhook URL will receive a POST request every time the delivery status changes. 
+
+``dontlog()`` Enable to avoid storing the message text in your history.
+               The other parameters will still be stored. 
 
-``flash()``. Will set the message type to flash. Will not endup in sms inbox. See [This tweet](https://twitter.com/46elks/status/583183559420178432) to find out how it looks on an iphone.
 #### MMS
 To use MMS simply use `new FortySixElksMMS()` instead of `new FortySixElksSMS()`
 

src/FortySixElksMedia.php

@@ -16,7 +16,6 @@ class FortySixElksMedia
      */
     protected $payload = [
         'lines'   => [],
-        'subject' => '',
     ];
 
     /**
@@ -73,18 +72,6 @@ public function line($line)
         return $this;
     }
 
-    /**
-     * @param $subject
-     *
-     * @return $this
-     */
-    public function subject($subject)
-    {
-        $this->payload['subject'] = $subject;
-
-        return $this;
-    }
-
     /**
      * @param $phone_number
      *
@@ -116,12 +103,4 @@ public function getContent()
     {
         return implode(PHP_EOL, $this->payload['lines']);
     }
-
-    /**
-     * @return mixed
-     */
-    public function getSubject()
-    {
-        return $this->payload['subject'];
-    }
 }

src/FortySixElksSMS.php

@@ -7,7 +7,12 @@
 class FortySixElksSMS extends FortySixElksMedia implements FortySixElksMediaInterface
 {
     const ENDPOINT = 'https://api.46elks.com/a1/SMS';
+
     public $type = 'SMS';
+    protected $flash = 'no';
+    protected $dry = 'no';
+    protected $whendelivered = null;
+    protected $log = false;
 
     /**
      * FortySixElksSMS constructor.
@@ -25,10 +30,13 @@ public function send()
         try {
             $response = $this->client->request('POST', self::ENDPOINT, [
                 'form_params' => [
-                    'from'     => $this->from,
-                    'message'  => $this->getContent(),
-                    'to'       => $this->phone_number,
-                    'flashsms' => (isset($this->payload['flash']) && $this->payload['flash']) ? 'yes' : 'no',
+                    'from'          => $this->from,
+                    'message'       => $this->getContent(),
+                    'to'            => $this->phone_number,
+                    'flashsms'      => $this->flash,
+                    'dryrun'        => $this->dry,
+                    'whendelivered' => $this->whendelivered,
+                    'dontlog'       => $this->log,
                 ],
 
             ]);
@@ -44,9 +52,44 @@ public function send()
         return $this;
     }
 
+    /**
+     * @return $this
+     */
     public function flash()
     {
-        $this->payload['flash'] = true;
+        $this->flash = $this->payload['flash'] ?? 'yes';
+
+        return $this;
+    }
+
+    /**
+     * @return $this
+     */
+    public function dry()
+    {
+        $this->dry = $this->payload['dryrun'] ?? 'yes';
+
+        return $this;
+    }
+
+    /**
+     * @param string $url
+     *
+     * @return $this
+     */
+    public function whendelivered($url)
+    {
+        $this->whendelivered = $this->payload['whendelivered'] ?? $url;
+
+        return $this;
+    }
+
+    /**
+     * @return $this
+     */
+    public function dontLog()
+    {
+        $this->log = $this->payload['dontLog'] ?? 'message';
 
         return $this;
     }

tests/FortySixElksMediaTest.php

@@ -15,13 +15,6 @@ public function testSMSTest()
         //test content
         $this->assertInstanceOf(FortySixElksSMS::class, $class->line('test line'));
         $this->assertContains('test', $class->getContent());
-
-        //test subject
-        $this->assertEquals(
-            'test subject',
-            $class->subject('test subject')
-               ->getSubject()
-        );
     }
 
     public function testMMSTest()
@@ -33,12 +26,5 @@ public function testMMSTest()
         //test content
         $this->assertInstanceOf(FortySixElksMMS::class, $class->line('test line'));
         $this->assertContains('test', $class->getContent());
-
-        //test subject
-        $this->assertEquals(
-            'test subject',
-            $class->subject('test subject')
-                ->getSubject()
-        );
     }
 }