Updated Clients and added endpoints

Updated Rest\Client to support all APIs. Removed Rest\AsynchClient. Added endpoints for all APIs Added functionality to select and specify endpoint.
mobiweb · Jun 21, 2024 · d35eb81 · d35eb81
1 parent 284c013
commit d35eb81
Show file tree

Hide file tree

Showing 15 changed files with 102 additions and 107 deletions.
diff --git a/README.md b/README.md
@@ -464,7 +464,12 @@ To achieve better performance, messages you send With MobiWeb Asynchronous SMS A
 $username = "";
 $password = "";
 
-$client = new MobiWeb\Rest\AsynchClient($username, $password);
+//Endpoint Options:
+//  Client::SMPP_API_OTP_ENDPOINT - Asynchronous SMS API (SMS) - For (one-time pins) OTP & Notification messages
+//  Client::SMPP_API_MRK_ENDPOINT - Asynchronous SMS API (SMS) - For marketing messages
+$endpoint = MobiWeb\Rest\Client::SMPP_API_OTP_ENDPOINT;
+
+$client = new MobiWeb\Rest\Client($username, $password, $endpoint);
 
 //Submit message
 $message = $client->broadcast(
@@ -491,7 +496,12 @@ print_r($message);
 $username = "";
 $password = "";
 
-$client = new MobiWeb\Rest\AsynchClient($username, $password);
+//Endpoint Options:
+//  Client::SMPP_API_OTP_ENDPOINT - Asynchronous SMS API (SMS) - For (one-time pins) OTP & Notification messages
+//  Client::SMPP_API_MRK_ENDPOINT - Asynchronous SMS API (SMS) - For marketing messages
+$endpoint = MobiWeb\Rest\Client::SMPP_API_OTP_ENDPOINT;
+
+$client = new MobiWeb\Rest\Client($username, $password, $endpoint);
 
 $message = $client->broadcast(
     [[
@@ -523,7 +533,12 @@ print_r($message);
 $username = "";
 $password = "";
 
-$client = new MobiWeb\Rest\AsynchClient($username, $password);
+//Endpoint Options:
+//  Client::SMPP_API_OTP_ENDPOINT - Asynchronous SMS API (SMS) - For (one-time pins) OTP & Notification messages
+//  Client::SMPP_API_MRK_ENDPOINT - Asynchronous SMS API (SMS) - For marketing messages
+$endpoint = MobiWeb\Rest\Client::SMPP_API_OTP_ENDPOINT;
+
+$client = new MobiWeb\Rest\Client($username, $password, $endpoint);
 
 $message = $client->broadcast(
     [[
@@ -557,7 +572,12 @@ print_r($message);
 $username = "";
 $password = "";
 
-$client = new MobiWeb\Rest\AsynchClient($username, $password);
+//Endpoint Options:
+//  Client::SMPP_API_OTP_ENDPOINT - Asynchronous SMS API (SMS) - For (one-time pins) OTP & Notification messages
+//  Client::SMPP_API_MRK_ENDPOINT - Asynchronous SMS API (SMS) - For marketing messages
+$endpoint = MobiWeb\Rest\Client::SMPP_API_OTP_ENDPOINT;
+
+$client = new MobiWeb\Rest\Client($username, $password, $endpoint);
 
 //Get account balance and print it
 echo $client->getBalance();
@@ -574,10 +594,15 @@ echo $client->getBalance();
 $username = "";
 $password = "";
 
-$client = new MobiWeb\Rest\AsynchClient($username, $password);
+//Endpoint Options:
+//  Client::SMPP_API_OTP_ENDPOINT - Asynchronous SMS API (SMS) - For (one-time pins) OTP & Notification messages
+//  Client::SMPP_API_MRK_ENDPOINT - Asynchronous SMS API (SMS) - For marketing messages
+$endpoint = MobiWeb\Rest\Client::SMPP_API_OTP_ENDPOINT;
+
+$client = new MobiWeb\Rest\Client($username, $password, $endpoint);
 
 //Get account pricing and print it
-print_r($client->getPricing(MobiWeb\Rest\AsynchClient::SMS));
+print_r($client->getPricing(MobiWeb\Rest\Client::SMS));
 
 ?>
 ```

diff --git a/composer.json b/composer.json
@@ -1,9 +1,9 @@
 {
     "name": "mobiweb/sdk",
-    "description": "4.0.0 PHP library for communicating with the MobiWeb REST APIs.",
+    "description": "4.0.2 PHP library for communicating with the MobiWeb REST APIs.",
     "minimum-stability": "stable",
     "keywords": [
-        "sms", "api", "mobiweb", "php", "messaging", "hlr", "hlr lookup", "mobile lookup", "mobile number lookup", "OTP", "one time password", "2FA", "two factor authentication", "smpp", "asynch"
+        "sms", "api", "mobiweb", "php", "messaging", "hlr", "hlr lookup", "mobile lookup", "mobile number lookup", "OTP", "one time password", "2FA", "two factor authentication", "smpp api", "smpp", "asynch"
     ],
     "type": "library",
     "license": "MIT",
@@ -14,7 +14,9 @@
         "homepage": "https://www.solutions4mobiles.com"
     }],
     "require": {
-        "php": ">=7.0.0"
+        "php": ">=7.0.0",
+        "ext-curl": "*",
+        "ext-json": "*"
     },
     "support": {
         "issues": "https://github.com/mobiweb/mobiweb-php/issues",

diff --git a/src/MobiWeb/Http/Client.php b/src/MobiWeb/Http/Client.php
@@ -2,6 +2,8 @@
 
 namespace MobiWeb\Http;
 
+use \stdClass;
+
 class Client {
 
     const GET = "GET";
@@ -28,7 +30,7 @@ public function __construct(){
 
     }
 
-    public function request(string $url = null, string $method = null, array $headers = array(), $data = null): object{
+    public function request(string $url = null, string $method = null, array $headers = array(), $data = null): stdClass{
 
         if(!$url){
             throw new \Exception("Invalid URL: ". $url);
@@ -47,7 +49,6 @@ public function request(string $url = null, string $method = null, array $header
                 break;
             default:
                 throw new \Exception("Unsupported HTTP Method: ". $method);
-                break;
         }
 
         $options[CURLOPT_URL] = $url;
@@ -136,6 +137,4 @@ protected static function getResponseBody(string $response = null, string $heade
 
     }
 
-}
-
-?>
+}
diff --git a/src/MobiWeb/Rest/AsynchClient.php b/src/MobiWeb/Rest/AsynchClient.php
diff --git a/src/MobiWeb/Rest/Authentication.php b/src/MobiWeb/Rest/Authentication.php
@@ -48,7 +48,6 @@ public function authenticate() :bool{
         if($executedRequest->response->body->status_code != HttpClient::HTTP_OK){
             $apiError = new APIError($executedRequest->response->body->status_code, $executedRequest->response->body->status_message, $executedRequest->response->body->errors);
             throw new \Exception($apiError->print());
-            return false;
         }
         $this->timestamp = new \DateTime();
         $this->access_token = $executedRequest->response->body->payload->access_token;
@@ -62,7 +61,6 @@ public function refresh() :bool{
 
         if(!$this->refresh_token){
             throw new \Exception("Refresh_token is required to refresh connection");
-            return false;
         }
 
         $http = new HttpClient();
@@ -75,7 +73,6 @@ public function refresh() :bool{
         if($executedRequest->response->body->status_code != HttpClient::HTTP_OK){
             $apiError = new APIError($executedRequest->response->body->status_code, $executedRequest->response->body->status_message, $executedRequest->response->body->errors);
             throw new \Exception($apiError->print());
-            return false;
         }
         $this->timestamp = new \DateTime();
         $this->access_token = $executedRequest->response->body->payload->access_token;
@@ -110,7 +107,6 @@ public function isAuthenticated() :bool{
         if(($interval->s < Authentication::VALIDITY_PERIOD) && ($interval->s >= (Authentication::VALIDITY_PERIOD - Authentication::VALIDITY_THRESHOLD))){
             if(!$this->refresh()){
                 throw new \Exception("Refresh connection failed");
-                return false;
             }
         }
 
@@ -119,6 +115,4 @@ public function isAuthenticated() :bool{
 
     }
 
-}
-
-?>
+}
diff --git a/src/MobiWeb/Rest/Client.php b/src/MobiWeb/Rest/Client.php
@@ -11,23 +11,28 @@
 class Client {
 
     protected $auth;
-    const API_ENDPOINT = "https://sms.solutions4mobiles.com/apis"; 
+    protected $endpoint;
+    const API_ENDPOINT = "https://sms.solutions4mobiles.com/apis";
+    const SMPP_API_OTP_ENDPOINT = "https://apix.solutions4mobiles.com/apis";
+    const SMPP_API_MRK_ENDPOINT = "https://apix2.solutions4mobiles.com/apis";
     const HLR = "hlr"; 
     const SMS = "sms";
     const OTP = "otp";
 
 
-    public function __construct(string $username = null, string $password = null){
+    public function __construct(string $username = null, string $password = null, string $endpoint = Client::API_ENDPOINT){
 
         if (!$username || !$password) {
             throw new \Exception("Username and Password are required to create a Client");
         }
 
-        $this->auth = new Auth($username,$password,Client::API_ENDPOINT);
+        $this->auth = new Auth($username,$password,$endpoint);
         if(!$this->auth->authenticate()){
             throw new \Exception("Authentication failed");
         }
 
+        $this->endpoint = $endpoint;
+
     }
 
     public function broadcast(array $args): array{
@@ -46,6 +51,10 @@ public function generate(string $mobile, string $sender, string $message, int $v
             throw new \Exception("Mobile number is required to generate an OTP");
         }
 
+        if($this->endpoint != Client::API_ENDPOINT) {
+            throw new \Exception("Unsupported service for selected endpoint");
+        }
+
         return OTP::generate($this->auth, $mobile, $sender, $message, $validity);
 
     }
@@ -56,6 +65,10 @@ public function validate(string $id, string $mobile, string $pin): bool{
             throw new \Exception("Mobile number, OTP pin and OTP ID is required to validate an OTP");
         }
 
+        if($this->endpoint != Client::API_ENDPOINT) {
+            throw new \Exception("Unsupported service for selected endpoint");
+        }
+
         return OTP::validate($this->auth, $id, $mobile, $pin);
 
     }
@@ -66,6 +79,10 @@ public function lookup(string $mobile): array{
             throw new \Exception("Mobile number is required to make a HLR Lookup");
         }
 
+        if($this->endpoint != Client::API_ENDPOINT) {
+            throw new \Exception("Unsupported service for selected endpoint");
+        }
+
         return HLR::lookup($this->auth, $mobile);
 
     }
@@ -78,10 +95,12 @@ public function getBalance(): float{
 
     public function getPricing(string $service=Client::SMS): array{
 
+        if($this->endpoint != Client::API_ENDPOINT && $service != Client::SMS) {
+            throw new \Exception("Unsupported service for selected endpoint");
+        }
+
         return Util::getPricing($this->auth,$service);
 
     }
 
-}
-
-?>
+}
diff --git a/src/MobiWeb/Rest/Error.php b/src/MobiWeb/Rest/Error.php
@@ -27,6 +27,4 @@ public function print(){
         return true;
     }
 
-}
-
-?>
+}
diff --git a/src/MobiWeb/Rest/HLR.php b/src/MobiWeb/Rest/HLR.php
@@ -22,7 +22,6 @@ public static function lookup(Auth $auth = null, string $mobile): array{
         $access_token = $auth->getAccessToken();
         if(!$access_token){
             throw new \Exception("Cannot retrieve Access Token");
-            return false;
         }
 
         $http = new HttpClient();
@@ -35,7 +34,6 @@ public static function lookup(Auth $auth = null, string $mobile): array{
         if($executedRequest->response->body->status_code != HttpClient::HTTP_OK){
             $apiError = new APIError($executedRequest->response->body->status_code, $executedRequest->response->body->status_message, $executedRequest->response->body->payload->error);
             throw new \Exception($apiError->print());
-            return false;
         }
 
         return array($executedRequest->response->body->payload);

diff --git a/src/MobiWeb/Rest/Message.php b/src/MobiWeb/Rest/Message.php
@@ -22,7 +22,6 @@ public static function broadcast(Auth $auth = null, array $args): array{
         $access_token = $auth->getAccessToken();
         if(!$access_token){
             throw new \Exception("Cannot retrieve Access Token");
-            return false;
         }
 
         $endpoint = $auth->getEndPoint();

diff --git a/src/MobiWeb/Rest/OTP.php b/src/MobiWeb/Rest/OTP.php
@@ -13,7 +13,7 @@ class OTP {
     const VALIDATE_ENDPOINT = "/otp/v3/validate/";
     const OTP_METHOD = "POST";
 
-    public static function generate(Auth $auth = null, string $mobile, string $sender = "SECUREPIN", string $message = "Please do not share your password pin. Your password pin is: [PIN]", int $validity = 600){
+    public static function generate(Auth $auth = null, string $mobile, string $sender = "SECUREPIN", string $message = "Please do not share your password pin. Your password pin is: [PIN]", int $validity = 600): array{
 
         if (!$auth) {
             throw new \Exception("Cannot generate OTP without authentication");
@@ -22,7 +22,6 @@ public static function generate(Auth $auth = null, string $mobile, string $sende
         $access_token = $auth->getAccessToken();
         if(!$access_token){
             throw new \Exception("Cannot retrieve Access Token");
-            return false;
         }
 
         $http = new HttpClient();
@@ -39,7 +38,6 @@ public static function generate(Auth $auth = null, string $mobile, string $sende
         if($executedRequest->response->body->status_code != HttpClient::HTTP_CREATED){
             $apiError = new APIError($executedRequest->response->body->status_code, $executedRequest->response->body->status_message, $executedRequest->response->body->errors);
             throw new \Exception($apiError->print());
-            return false;
         }
 
         return array($executedRequest->response->body->payload);
@@ -54,7 +52,6 @@ public static function validate(Auth $auth = null, string $id, string $mobile, s
         $access_token = $auth->getAccessToken();
         if(!$access_token){
             throw new \Exception("Cannot retrieve Access Token");
-            return false;
         }
 
         $http = new HttpClient();
@@ -69,7 +66,6 @@ public static function validate(Auth $auth = null, string $id, string $mobile, s
         if($executedRequest->response->body->status_code != HttpClient::HTTP_OK){
             $apiError = new APIError($executedRequest->response->body->status_code, $executedRequest->response->body->status_message, $executedRequest->response->body->errors);
             throw new \Exception($apiError->print());
-            return false;
         }
 
         return true;
-Original file line number
+Diff line change
@@ Expand Up / @@ -27,6 +27,4 @@ public function print(){ @@
             return true;
         }
-    }
-    ?>
+    }