feat: custom client configuration usage via per notification or notifiable

Update Textlocal.php, TextlocalChannel.php, TextlocalServiceProvider.php

Create INotificationUsesTextlocalClientConfig.php

Create IUsesTextlocalClientConfig.php

Update README.md

Author: msonowal

README.md

@@ -48,9 +48,14 @@ return [
 		'UK' => 'https://api.txtlocal.com/'
 	],
 	'country'   => env('TEXTLOCAL_COUNTRY', 'IN'),
+    'extra' => [
+        // extra config define keys as desired for use within the textlocal client config
+        // if you want to use the custom client config for each notification or notifiable 
+        // INotificationUsesTextlocalClientConfig
+    ]
 ];
 ```
-### Configuring .env 
+### Configuring .env
 ```
     TEXTLOCAL_USERNAME=Your email id or api key
     TEXTLOCAL_HASH=get it from url '/docs/' under your API KEYS section

src/Contracts/INotificationUsesTextlocalClientConfig.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace NotificationChannels\Textlocal\Contracts;
+
+interface INotificationUsesTextlocalClientConfig
+{
+    /**
+     * @param $notifiable
+     * @return array [$username, $hash, $apiKey, $country]
+     */
+    public function getTextlocalClientConfig($notifiable): array;
+}

src/Contracts/IUsesTextlocalClientConfig.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace NotificationChannels\Textlocal\Contracts;
+
+interface IUsesTextlocalClientConfig
+{
+    /**
+     * @param $notification
+     * @return array [$username, $hash, $apiKey, $country]
+     */
+    public function getTextlocalClientConfig($notification): array;
+}

src/Textlocal.php

@@ -22,12 +22,7 @@ class Textlocal
     const REQUEST_TIMEOUT = 60;
     const REQUEST_HANDLER = 'curl';
 
-    private $request_url;
-    private $country;
-
-    private $username;
-    private $hash;
-    private $apiKey;
+    private string $request_url;
 
     private $errorReporting = false;
 
@@ -40,20 +35,14 @@ class Textlocal
     /**
      * Instantiate the object.
      *
-     * @param $username
-     * @param $hash
+     * @param string|null $username
+     * @param string|null $hash
      * @param string|null $apiKey
+     * @param string $country
      */
-    public function __construct($username, $hash, $apiKey = null)
+    public function __construct(private $username, private $hash, private $apiKey, private string $country)
     {
-        $this->username = $username;
-        $this->hash = $hash;
-        if (! is_null($apiKey)) {
-            $this->apiKey = $apiKey;
-        }
-
-        $this->country = config('textlocal.country');
-        $this->request_url = config('textlocal.request_urls')[$this->country];
+        $this->request_url = config('textlocal.request_urls')[$country];
     }
 
     /**

src/TextlocalChannel.php

@@ -3,6 +3,8 @@
 namespace NotificationChannels\Textlocal;
 
 use Illuminate\Notifications\Notification;
+use NotificationChannels\Textlocal\Contracts\INotificationUsesTextlocalClientConfig;
+use NotificationChannels\Textlocal\Contracts\IUsesTextlocalClientConfig;
 use NotificationChannels\Textlocal\Exceptions\CouldNotSendNotification;
 
 /**
@@ -66,8 +68,10 @@ public function send($notifiable, Notification $notification)
             $this->sender = $notification->getSenderId();
         }
 
+        $client = $this->getClient($notifiable, $notification);
+
         try {
-            $response = $this->client
+            $response = $client
                 ->setUnicodeMode($unicode)
                 ->sendSms($numbers, $message, $this->sender);
 
@@ -76,4 +80,25 @@ public function send($notifiable, Notification $notification)
             throw CouldNotSendNotification::serviceRespondedWithAnError($exception, $message);
         }
     }
+
+    public function getClient($notifiable, Notification $notification)
+    {
+        $client = $this->client;
+
+        if ($notifiable instanceof IUsesTextlocalClientConfig) {
+
+            [$username, $hash, $apiKey, $country] = $notification->getTextlocalClientConfig($notification);
+
+            $client = new Textlocal($username, $hash, $apiKey, $country);
+        }
+
+        if ($notification instanceof INotificationUsesTextlocalClientConfig) {
+
+            [$username, $hash, $apiKey, $country] = $notification->getTextlocalClientConfig($notifiable);
+
+            $client = new Textlocal($username, $hash, $apiKey, $country);
+        }
+
+        return $client;
+    }
 }

src/TextlocalServiceProvider.php

@@ -22,7 +22,8 @@ function () {
                     return new Textlocal(
                         $config['username'],
                         $config['hash'],
-                        $config['api_key']
+                        $config['api_key'],
+                        $config['country']
                     );
                 }
             );