Added fraud check (#406)

Author: SecondeJK

src/Verify2/Request/BaseVerifyRequest.php

@@ -16,6 +16,8 @@ abstract class BaseVerifyRequest implements RequestInterface
 
     protected int $timeout = 300;
 
+    protected bool $fraudCheck = true;
+
     protected ?string $clientRef = null;
 
     protected int $length = 4;
@@ -132,9 +134,22 @@ public function addWorkflow(VerificationWorkflow $verificationWorkflow): static
         return $this;
     }
 
+    public function getFraudCheck(): bool
+    {
+        return $this->fraudCheck;
+    }
+
+    public function setFraudCheck(bool $fraudCheck): BaseVerifyRequest
+    {
+        $this->fraudCheck = $fraudCheck;
+
+        return $this;
+    }
+
     public function getBaseVerifyUniversalOutputArray(): array
     {
         $returnArray = [
+            'fraud_check' => $this->getFraudCheck(),
             'locale' => $this->getLocale()->getCode(),
             'channel_timeout' => $this->getTimeout(),
             'code_length' => $this->getLength(),

test/Verify2/ClientTest.php

@@ -98,6 +98,7 @@ public function testCanRequestSMS(): void
             );
 
             $this->assertRequestJsonBodyContains('locale', 'en-us', $request);
+            $this->assertRequestJsonBodyContains('fraud_check', true, $request);
             $this->assertRequestJsonBodyContains('channel_timeout', 300, $request);
             $this->assertRequestJsonBodyContains('client_ref', $payload['client_ref'], $request);
             $this->assertRequestJsonBodyContains('code_length', 4, $request);
@@ -115,6 +116,29 @@ public function testCanRequestSMS(): void
         $this->assertArrayHasKey('request_id', $result);
     }
 
+    public function testCanBypassFraudCheck(): void
+    {
+        $payload = [
+            'to' => '07785254785',
+            'client_ref' => 'my-verification',
+            'brand' => 'my-brand',
+        ];
+
+        $smsVerification = new SMSRequest($payload['to'], $payload['brand']);
+        $smsVerification->setFraudCheck(false);
+
+        $this->vonageClient->send(Argument::that(function (Request $request) use ($payload) {
+            $this->assertRequestJsonBodyContains('fraud_check', false, $request);
+
+            return true;
+        }))->willReturn($this->getResponse('verify-request-success', 202));
+
+        $result = $this->verify2Client->startVerification($smsVerification);
+
+        $this->assertIsArray($result);
+        $this->assertArrayHasKey('request_id', $result);
+    }
+
     /**
      * @dataProvider localeProvider
      */