Add iSmartSMS service for sending SMS

This commit introduces the iSmartSMS service which allows the sending of SMS via the ismartsms.net (Oman) gateway. Several files are created including services, configuration, and provider to handle the messaging functionality. A .env example has also been added to guide the user on necessary environment configurations for the SMS service.

Author: phpawcom-shared

.gitignore

@@ -0,0 +1,3 @@
+/.idea
+/vendor
+/composer.lock

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Abdulaziz Al Rashdi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,53 @@
+## IsmartSMS Library for Laravel
+This basic library help you to send SMS via ismartsms.net (Oman)
+
+## Installation:
+```bash
+composer phpawcom/ismartsms
+```
+
+In your .env, add the following:
+```dotenv
+ISMARTSMS_USER_ID="Your ismartsms API username"
+ISMARTSMS_PASSWORD="Your Password"
+```
+
+
+### publish config:
+This is an optional step, not really needed if you are using .env for configuration 
+```bash
+php artisan vendor:publish --provider "S4D\Laravel\IsmartSMS\IsmartSMSProvider"
+```
+
+The S4D\Laravel\IsmartSMS\IsmartSMSProvider is auto-discovered and registered by default.
+If you want to register it yourself, add the ServiceProvider in config/app.php:
+```php
+'providers' => [
+    S4D\Laravel\IsmartSMS\IsmartSMSProvider::class,
+]
+```
+For alias:
+```php
+'aliases' => [
+    S4D\Laravel\IsmartSMS\IsmartSMS::class,
+]
+```
+
+## Usage:
+Example code:
+```php
+if(IsmartSMS::SendSMS('{8 digits phone number}', '{SMS Content}')){ 
+    // TODO: SMS has been sent, some action here
+}else{
+    // TODO: SMS couldn't be sent, some action here
+}
+```
+
+If you want to see the result of SMS gateway:
+```php
+print_r(IsmartSMS::getRawResults());
+```
+You can add setFlashSMS() if you want the SMS to disappear after reading:
+```php
+IsmartSMS::setFlashSMS()->SendSMS('{8 digits phone number}', '{SMS Content}')
+```

composer.json

@@ -0,0 +1,37 @@
+{
+    "name": "phpawcom/ismartsms",
+    "description": "Send SMS via iSmartSMS gateway (Oman)",
+    "type": "library",
+    "license": "MIT",
+    "version": "1.0.0",
+    "autoload": {
+        "psr-4": {
+            "S4D\\Laravel\\IsmartSMS\\": "src/"
+        }
+    },
+    "authors": [
+        {
+            "name": "Abdulaziz Al Rashdi",
+            "email": "[email protected]"
+        }
+    ],
+    "minimum-stability": "dev",
+    "extra": {
+        "laravel": {
+            "providers": [
+                "S4D\\Laravel\\IsmartSMS\\IsmartSMSProvider"
+            ],
+            "aliases": {
+                "Thawani": "S4D\\Laravel\\IsmartSMS\\IsmartSMS"
+            }
+        }
+    },
+    "require": {
+        "php": ">=8.1",
+        "ext-curl": "*",
+        "guzzlehttp/guzzle": "^7.2"
+    },
+    "require-dev": {
+        "orchestra/testbench": "8.x-dev"
+    }
+}

src/IsmartSMS.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace S4D\Laravel\IsmartSMS;
+
+use Illuminate\Support\Facades\Facade;
+use S4D\Laravel\IsmartSMS\Services\IsmartSMSService;
+
+/**
+ * @method static bool SendSMS(string $receiver, string $message)
+ * @method static array getRawResults()
+ * @method static void setFlashSMS()
+ * @method static void unsetFlashSMS()
+ */
+class IsmartSMS extends Facade {
+    protected static function getFacadeAccessor() {
+        return IsmartSMSService::class;
+    }
+}

src/IsmartSMSProvider.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace S4D\Laravel\IsmartSMS;
+
+use Illuminate\Support\ServiceProvider;
+use S4D\Laravel\IsmartSMS\Services\IsmartSMSService;
+
+class IsmartSMSProvider extends ServiceProvider {
+    public function boot(){
+        $this->mergeConfigFrom(__DIR__.'/config/ismartsms.php', 'ismartsms');
+        $this->publishes([
+            __DIR__.'/config/ismartsms.php' => config_path('ismartsms.php')
+        ]);
+    }
+
+    public function register(){
+        $this->app->bind('IsmartSMS', fn() => new IsmartSMSService());
+    }
+}

src/Services/IsmartSMSService.php

@@ -0,0 +1,48 @@
+<?php
+
+namespace S4D\Laravel\IsmartSMS\Services;
+
+use Carbon\Carbon;
+use GuzzleHttp\Client;
+
+class IsmartSMSService {
+    public ?array $rawResults;
+    private bool $isFlash = false;
+    public function setFlashSMS(): static {
+        $this->isFlash = true;
+        return $this;
+    }
+    public function unsetFlashSMS(): static {
+        $this->isFlash = false;
+        return $this;
+    }
+    public function sendSMS($receiver, $message): bool {
+        $result = false;
+        $language = (int) preg_match("/\p{Arabic}/u", $receiver)? '64' : '0';
+        $client = new Client();
+        $response = $client->request('POST', config('ismartsms.service_url'), [
+            'form_params' => [
+                'UserID' => config('ismartsms.user_id'),
+                'Password' => config('ismartsms.password'),
+                'Message' => $message,
+                'Language' => $language,
+//                'ScheddateTime' => Carbon::now(),
+                'MobileNo' => strlen($receiver) == 8? '968'.$receiver : $receiver,
+                'RecipientType' => $this->isFlash == 1? 9 : 1
+            ],
+        ]);
+        try {
+            $body = json_decode($response->getBody()->getContents(), true);
+            $this->rawResults = $body;
+            if($body['Code'] == 1){
+                $result = true;
+            }
+        } catch (\Exception $e) {
+            throw new \Exception('Unable to send SMS, error: '.$e->getMessage());
+        }
+        return $result;
+    }
+    public function getRawResults(){
+        return $this->rawResults;
+    }
+}

src/config/ismartsms.php

@@ -0,0 +1,6 @@
+<?php
+return [
+    'user_id' => env('ISMARTSMS_USER_ID', ''),
+    'password' => env('ISMARTSMS_PASSWORD', ''),
+    'service_url' => env('ISMARTSMS_URL', 'https://ismartsms.net/RestApi/api/SMS/PostSMS'),
+];