Add validation for brand (#490)

Vonage · Jul 17, 2024 · 3cbc6a8 · 3cbc6a8
1 parent 2b0131c
commit 3cbc6a8
Show file tree

Hide file tree

Showing 8 changed files with 43 additions and 4 deletions.
diff --git a/src/Verify2/Request/BaseVerifyRequest.php b/src/Verify2/Request/BaseVerifyRequest.php
@@ -170,4 +170,13 @@ public function getBaseVerifyUniversalOutputArray(): array
 
         return $returnArray;
     }
+
+    public static function isBrandValid(string $brand): bool
+    {
+        if (!strlen($brand) < 16) {
+            return true;
+        }
+
+        return false;
+    }
 }
diff --git a/src/Verify2/Request/EmailRequest.php b/src/Verify2/Request/EmailRequest.php
@@ -2,6 +2,7 @@
 
 namespace Vonage\Verify2\Request;
 
+use InvalidArgumentException;
 use Vonage\Verify2\VerifyObjects\VerificationLocale;
 use Vonage\Verify2\VerifyObjects\VerificationWorkflow;
 
@@ -13,6 +14,10 @@ public function __construct(
         protected string $from,
         protected ?VerificationLocale $locale = null,
     ) {
+        if (!self::isBrandValid($this->brand)) {
+            throw new InvalidArgumentException('The brand name cannot be longer than 16 characters.');
+        }
+
         if (!$this->locale) {
             $this->locale = new VerificationLocale();
         }

diff --git a/src/Verify2/Request/SMSRequest.php b/src/Verify2/Request/SMSRequest.php
@@ -2,6 +2,7 @@
 
 namespace Vonage\Verify2\Request;
 
+use InvalidArgumentException;
 use Vonage\Verify2\VerifyObjects\VerificationLocale;
 use Vonage\Verify2\VerifyObjects\VerificationWorkflow;
 
@@ -15,6 +16,10 @@ public function __construct(
         protected string $entityId = '',
         protected string $contentId = ''
     ) {
+        if (!self::isBrandValid($this->brand)) {
+            throw new InvalidArgumentException('The brand name cannot be longer than 16 characters.');
+        }
+
         if (!$this->locale) {
             $this->locale = new VerificationLocale();
         }

diff --git a/src/Verify2/Request/SilentAuthRequest.php b/src/Verify2/Request/SilentAuthRequest.php
@@ -2,6 +2,7 @@
 
 namespace Vonage\Verify2\Request;
 
+use InvalidArgumentException;
 use Vonage\Verify2\VerifyObjects\VerificationWorkflow;
 
 class SilentAuthRequest extends BaseVerifyRequest
@@ -11,6 +12,10 @@ public function __construct(
         protected string $brand,
         protected ?string $redirectUrl = null
     ) {
+        if (!self::isBrandValid($this->brand)) {
+            throw new InvalidArgumentException('The brand name cannot be longer than 16 characters.');
+        }
+
         $workflow = new VerificationWorkflow(VerificationWorkflow::WORKFLOW_SILENT_AUTH, $to);
 
         if ($this->redirectUrl) {

diff --git a/src/Verify2/Request/VoiceRequest.php b/src/Verify2/Request/VoiceRequest.php
@@ -2,6 +2,7 @@
 
 namespace Vonage\Verify2\Request;
 
+use InvalidArgumentException;
 use Vonage\Verify2\VerifyObjects\VerificationLocale;
 use Vonage\Verify2\VerifyObjects\VerificationWorkflow;
 
@@ -12,6 +13,10 @@ public function __construct(
         protected string $brand,
         protected ?VerificationLocale $locale = null,
     ) {
+        if (!self::isBrandValid($this->brand)) {
+            throw new InvalidArgumentException('The brand name cannot be longer than 16 characters.');
+        }
+
         if (!$this->locale) {
             $this->locale = new VerificationLocale();
         }
@@ -29,4 +34,4 @@ public function toArray(): array
     {
         return $this->getBaseVerifyUniversalOutputArray();
     }
-}
+}
diff --git a/src/Verify2/Request/WhatsAppInteractiveRequest.php b/src/Verify2/Request/WhatsAppInteractiveRequest.php
@@ -2,6 +2,7 @@
 
 namespace Vonage\Verify2\Request;
 
+use InvalidArgumentException;
 use Vonage\Verify2\VerifyObjects\VerificationLocale;
 use Vonage\Verify2\VerifyObjects\VerificationWorkflow;
 
@@ -12,6 +13,10 @@ public function __construct(
         protected string $brand,
         protected ?VerificationLocale $locale = null
     ) {
+        if (!self::isBrandValid($this->brand)) {
+            throw new InvalidArgumentException('The brand name cannot be longer than 16 characters.');
+        }
+
         if (!$this->locale) {
             $this->locale = new VerificationLocale();
         }
@@ -24,4 +29,4 @@ public function toArray(): array
     {
         return $this->getBaseVerifyUniversalOutputArray();
     }
-}
+}
diff --git a/src/Verify2/Request/WhatsAppRequest.php b/src/Verify2/Request/WhatsAppRequest.php
@@ -2,6 +2,7 @@
 
 namespace Vonage\Verify2\Request;
 
+use InvalidArgumentException;
 use Vonage\Verify2\VerifyObjects\VerificationLocale;
 use Vonage\Verify2\VerifyObjects\VerificationWorkflow;
 
@@ -13,6 +14,10 @@ public function __construct(
         protected string $from,
         protected ?VerificationLocale $locale = null,
     ) {
+        if (!self::isBrandValid($this->brand)) {
+            throw new InvalidArgumentException('The brand name cannot be longer than 16 characters.');
+        }
+
         if (!$this->locale) {
             $this->locale = new VerificationLocale();
         }

diff --git a/test/Verify2/ClientTest.php b/test/Verify2/ClientTest.php
@@ -8,6 +8,7 @@
 use Laminas\Diactoros\Response;
 use Prophecy\Argument;
 use Prophecy\Prophecy\ObjectProphecy;
+use Vonage\Messages\Channel\Messenger\InvalidCategoryException;
 use VonageTest\Traits\Psr7AssertionTrait;
 use Vonage\Client;
 use Vonage\Client\APIResource;
@@ -500,8 +501,7 @@ public function testCannotSendConcurrentVerifications(): void
 
     public function testCannotSendWithoutBrand(): void
     {
-        $this->expectException(Client\Exception\Request::class);
-        $this->expectExceptionMessage('Invalid params: The value of one or more parameters is invalid. See https://www.developer.vonage.com/api-errors#invalid-params for more information');
+        $this->expectException(\InvalidArgumentException::class);
 
         $payload = [
             'to' => '07785254785',