Merge pull request #21 from TechTomaz/dev-smsfix

Update the SMS Class after 46Elks change their optional value behavior

Author: larsemil

README.md

@@ -23,16 +23,23 @@ With more endpoints to come. Feel free to contribute.
 
 ## Contents
 
-- [Installation](#installation)
-	- [Setting up the 46Elks service](#setting-up-the-46Elks-service)
-- [Usage](#usage)
-	- [Available Message methods](#available-message-methods)
-- [Changelog](#changelog)
-- [Testing](#testing)
-- [Security](#security)
-- [Contributing](#contributing)
-- [Credits](#credits)
-- [License](#license)
+- [46Elks notification channel for Laravel](#46elks-notification-channel-for-laravel)
+  - [Contents](#contents)
+  - [Installation](#installation)
+    - [Setting up the 46Elks service](#setting-up-the-46elks-service)
+  - [Usage](#usage)
+    - [Available mediums](#available-mediums)
+      - [SMS](#sms)
+    - [Available Message methods for sms](#available-message-methods-for-sms)
+      - [MMS](#mms)
+    - [Available Message methods](#available-message-methods)
+    - [Error handling](#error-handling)
+  - [Changelog](#changelog)
+  - [Testing](#testing)
+  - [Security](#security)
+  - [Contributing](#contributing)
+  - [Credits](#credits)
+  - [License](#license)
 
 
 ## Installation
@@ -45,7 +52,7 @@ composer require laravel-notification-channels/46elks
 
 
 add the following to your config/services.php
-```
+``` php
 	'46elks' => [
 		'username' => env('FORTY_SIX_ELKS_USERNAME'),
 		'password' => env('FORTY_SIX_ELKS_PASSWORD'),
@@ -63,33 +70,52 @@ You will find your username and password at https://46elks.se/account
 
 
 To use this channel simply create a notification that has the following content:
+``` php
+use NotificationChannels\FortySixElks\FortySixElksChannel;
+use NotificationChannels\FortySixElks\FortySixElksSMS;
+
+public function via($notifiable)
+{
+    return [FortySixElksChannel::class];
+}
+
+
+public function to46Elks($notifiable)
+{
+    return (new FortySixElksSMS())
+        ->line('Testsms')
+        ->line('Olle')
+        ->to('+46701234567')
+        ->from('Emil')
+        // ->flash() - Optional
+        // ->whenDelivered(URL) - Optional
+        // ->dontLog() - Optional
+        // ->dry() - Optional
+}
 ```
-    use NotificationChannels\FortySixElks\FortySixElksChannel;
-    use NotificationChannels\FortySixElks\FortySixElksSMS;
-
-    public function via($notifiable)
-    {
-        return [FortySixElksChannel::class];
-    }
 
- 
-    public function to46Elks($notifiable)
-    {
-        return (new FortySixElksSMS())
-	        ->line('Testsms')
-	        ->line('Olle')
-	        ->to('+46762216234')
-	        ->from('Emil')
-            	// -dry()
-    }
+Another example without the notification implementation.
+``` php
+use NotificationChannels\FortySixElks\FortySixElksSMS;
+
+(new FortySixElksSMS())
+    ->line('Testsms')
+    ->line('Olle')
+    ->to('+46701234567')
+    ->from('Emil')
+    // ->flash() - Optional
+    // ->whenDelivered(URL) - Optional
+    // ->dontLog() - Optional
+    // ->dry() - Optional
+    ->send();
 ```
 ### Available mediums
 #### SMS
 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 containing A-Z, a-z, 0-9 up to 11 characters or numbers. Space is not supported. Sms will be sent with that name.
 
 ``to($number)`` International phone number.
 
@@ -101,9 +127,9 @@ The FortySixElksSMS have the following methods, all chainable.
             No SMS message will be sent when this is enabled. To be able inspect a dry() request you need to
             send your message to +4670000000 then you can inspect it at [https://46elks.com/logs](https://46elks.com/logs)
 
-``whendelivered('http://localhost')`` This webhook URL will receive a POST request every time the delivery status changes. 
+``whenDelivered('http://localhost.se/ping')`` 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.
+``dontLog()`` Enable to avoid storing the message text in your history.
                The other parameters will still be stored. 
 
 #### MMS
@@ -130,7 +156,7 @@ If for any reason there would be an error when sending a notification it will fi
 `Illuminate\Notifications\Events\NotificationFailed` event. You can then listen for that.
 
 Example:
-```
+``` php
 Event::listen(NotificationFailed::class, function($event){
     info('Error while sending sms');
 });

src/FortySixElksMedia.php

@@ -18,6 +18,11 @@ class FortySixElksMedia
         'lines'   => [],
     ];
 
+    /**
+     * @var GuzzleHttp\Client
+     */
+    protected $client;
+
     /**
      * @var int
      */

src/FortySixElksSMS.php

@@ -8,17 +8,15 @@ class FortySixElksSMS extends FortySixElksMedia implements FortySixElksMediaInte
 {
     const ENDPOINT = 'https://api.46elks.com/a1/SMS';
 
-    public $type = 'SMS';
-    protected $flash = 'no';
-    protected $dry = 'no';
-    protected $whendelivered = null;
-    protected $log = false;
+    protected array $form_params;
 
     /**
      * FortySixElksSMS constructor.
      */
     public function __construct()
     {
+        $this->form_params = [];
+
         return parent::__construct();
     }
 
@@ -29,16 +27,14 @@ public function send()
     {
         try {
             $response = $this->client->request('POST', self::ENDPOINT, [
-                'form_params' => [
-                    'from'          => $this->from,
-                    'message'       => $this->getContent(),
-                    'to'            => $this->phone_number,
-                    'flashsms'      => $this->flash,
-                    'dryrun'        => $this->dry,
-                    'whendelivered' => $this->whendelivered,
-                    'dontlog'       => $this->log ? $this->log : '',
-                ],
-
+                'form_params' => array_merge(
+                    $this->form_params,
+                    [
+                        'from'    => $this->from,
+                        'to'      => $this->phone_number,
+                        'message' => $this->getContent(),
+                    ]
+                ),
             ]);
         } catch (\GuzzleHttp\Exception\BadResponseException $e) {
             $response = $e->getResponse();
@@ -53,43 +49,55 @@ public function send()
     }
 
     /**
-     * @return $this
+     * @return array
      */
-    public function flash()
+    public function prepareParams(string $key, mixed $value): FortySixElksSMS
     {
-        $this->flash = $this->payload['flash'] ?? 'yes';
+        $this->form_params[$key] = $value;
 
         return $this;
     }
 
     /**
-     * @return $this
+     * @return void
+     */
+    public function flash(string $value = 'yes'): FortySixElksSMS
+    {
+        self::prepareParams(key: 'flash', value: $value);
+
+        return $this;
+    }
+
+    /**
+     * @param string $value
+     *
+     * @return FortySixElksSMS
      */
-    public function dry()
+    public function dry(string $value = 'yes'): FortySixElksSMS
     {
-        $this->dry = $this->payload['dryrun'] ?? 'yes';
+        self::prepareParams(key: 'dryrun', value: $value);
 
         return $this;
     }
 
     /**
      * @param string $url
      *
-     * @return $this
+     * @return FortySixElksSMS
      */
-    public function whendelivered($url)
+    public function whenDelivered(string $url): FortySixElksSMS
     {
-        $this->whendelivered = $this->payload['whendelivered'] ?? $url;
+        self::prepareParams(key: 'whendelivered', value: $url);
 
         return $this;
     }
 
     /**
-     * @return $this
+     * @return FortySixElksSMS
      */
-    public function dontLog()
+    public function dontLog(): FortySixElksSMS
     {
-        $this->log = $this->payload['dontLog'] ?? 'message';
+        self::prepareParams(key: 'dontlog', value: 'message');
 
         return $this;
     }