fixed linting issues and removed unnecessary comment

utopia-php · Oct 5, 2023 · 8131f43 · 8131f43
1 parent 616da2d
commit 8131f43
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 33 deletions.
diff --git a/src/Utopia/Messaging/Adapters/SMS/SmsGlobal.php b/src/Utopia/Messaging/Adapters/SMS/SmsGlobal.php
@@ -50,9 +50,9 @@ protected function process(SMS $message): string
 
         return $this->request(
             method: 'POST',
-            url: "https://api.smsglobal.com/v2/sms/",
+            url: 'https://api.smsglobal.com/v2/sms/',
             headers: [
-                'Authorization: ' . $authorizationHeader,
+                'Authorization: '.$authorizationHeader,
                 'Content-Type: application/json',
             ],
             body: \json_encode(
@@ -68,16 +68,20 @@ protected function process(SMS $message): string
     /**
      * Get the value to use for the Authorization header
      *
-     * @param string $method HTTP method (e.g. POST)
-     * @param string $requestUri Request URI (e.g. /v2/sms/)
-     * @param string $host Hostname
-     * @return string
+     * @param  string  $method HTTP method (e.g. POST)
+     * @param  string  $requestUri Request URI (e.g. /v2/sms/)
+     * @param  string  $host Hostname
      */
-    public function getAuthorizationHeader(string $method, string $requestUri, string $host): string
-    {
-        // Server or computer time should match with the current Unix timestamp otherwise authentication will fail
+    public function getAuthorizationHeader(
+        string $method,
+        string $requestUri,
+        string $host
+    ): string {
+        // Server or computer time should match with the
+        //current Unix timestamp otherwise authentication will fail
+
         $timestamp = time();
-        $nonce = md5(microtime() . mt_rand());
+        $nonce = md5(microtime().mt_rand());
 
         $hash = $this->getRequestHash(
             timestamp: $timestamp,
@@ -89,19 +93,19 @@ public function getAuthorizationHeader(string $method, string $requestUri, strin
 
         $headerFormat = 'MAC id="%s", ts="%s", nonce="%s", mac="%s"';
         $header = sprintf($headerFormat, $this->apiKey, $timestamp, $nonce, $hash);
+
         return $header;
     }
 
     /**
      * Hashes a request using the API secret, to use in the Authorization header
      *
-     * @param int $timestamp Unix timestamp of request time
-     * @param string $nonce Random unique string
-     * @param string $method HTTP method (e.g. POST)
-     * @param string $requestUri Request URI (e.g. /v1/sms/)
-     * @param string $host Hostname
-     * @param int $port Port (e.g. 443)
-     * @return string
+     * @param  int  $timestamp Unix timestamp of request time
+     * @param  string  $nonce Random unique string
+     * @param  string  $method HTTP method (e.g. POST)
+     * @param  string  $requestUri Request URI (e.g. /v1/sms/)
+     * @param  string  $host Hostname
+     * @param  int  $port Port (e.g. 443)
      */
     private function getRequestHash(
         int $timestamp,
@@ -111,35 +115,35 @@ private function getRequestHash(
         string $host,
         int $port = 443
     ) {
-        $string = array($timestamp, $nonce, $method, $requestUri, $host, $port, '');
+        $string = [$timestamp, $nonce, $method, $requestUri, $host, $port, ''];
         $string = sprintf("%s\n", implode("\n", $string));
         $hash = hash_hmac(self::HASH_ALGO, $string, $this->apiSecret, true);
         $hash = base64_encode($hash);
+
         return $hash;
     }
 
     /**
      * Get the request body
-     * 
-     * @param array $to
-     * @param string $text
-     * @param string|null $from
-     * @return array
+     *
+     * @param  array  $to  Phone number
+     * @param  string  $text  Message to send
+     * @param  string|null  $from Origin of the message
      */
     private function getRequestBody(array $to, string $text, string $from = null): array
     {
-        $origin = !empty($from) ? $from : '';
+        $origin = ! empty($from) ? $from : '';
         if (count($to) == 1) {
             return [
-                "destination" => $to[0],
-                "message" => $text,
-                "origin" => $origin,
+                'destination' => $to[0],
+                'message' => $text,
+                'origin' => $origin,
             ];
         } else {
             return [
-                "destinations" => $to,
-                "message" => $text,
-                "origin" => $origin,
+                'destinations' => $to,
+                'message' => $text,
+                'origin' => $origin,
             ];
         }
     }

diff --git a/tests/e2e/SMS/SmsGlobalTest.php b/tests/e2e/SMS/SmsGlobalTest.php
@@ -17,7 +17,7 @@ public function testSendSMS()
 
         $to = [getenv('SMS_GLOBAL_TO')];
         $from = getenv('SMS_GLOBAL_FROM');
-        
+
         $sender = new SmsGlobal($apiKey, $apiSecret);
         $message = new SMS(
             to: $to,
@@ -30,7 +30,5 @@ public function testSendSMS()
 
         $this->assertArrayHasKey('messages', $result);
         $this->assertEquals(count($to), count($result['messages']));
-
-        // $dummyResponseStructure = '{"messages":[{"id":"154","outgoing_id":1,"origin":"origin","destination":"destination","message":"Test Content","status":"sent","dateTime":""}]}';
     }
 }