added skip ip support

Author: RyanDaDeng

config/googlerecaptchav3.php

@@ -91,6 +91,17 @@
             'score_comparision' => false,
         ],
     ],
+
+    /*
+    |--------------------------------------------------------------------------
+    | Setting
+    |--------------------------------------------------------------------------
+    | Type: array
+    | Define a list of ip that you want to skip
+    */
+    'skip_ips'=>[
+
+    ],
     /*
     |--------------------------------------------------------------------------
     | Options

src/Configurations/ReCaptchaConfigV3.php

@@ -93,4 +93,12 @@ public function getLanguage()
     {
         return config('googlerecaptchav3.language');
     }
+
+    /**
+     * @return string
+     */
+    public function getSkipIps()
+    {
+        return config('googlerecaptchav3.skip_ips');
+    }
 }

src/Interfaces/ReCaptchaConfigV3Interface.php

@@ -64,4 +64,9 @@ public function isInline();
      * @return string
      */
     public function getLanguage();
+
+    /**
+     * @return array
+     */
+    public function getSkipIps();
 }

src/Services/GoogleReCaptchaV3Service.php

@@ -25,20 +25,31 @@ public function __construct(ReCaptchaConfigV3Interface $config, RequestClientInt
         $this->requestClient = $requestClient;
     }
 
+    /**
+     * @param $ip
+     * @return bool
+     */
+    public function ifInSkippedIps($ip)
+    {
+        $ips = $this->config->getSkipIps();
+        return in_array($ip, $ips);
+    }
+
     /**
      * @param $response
      * @param null $ip
      * @return GoogleReCaptchaV3Response
      */
     public function verifyResponse($response, $ip = null)
     {
-        if (! $this->config->isServiceEnabled()) {
+        if (!$this->config->isServiceEnabled() || ($ip && $this->ifInSkippedIps($ip)) === true) {
             $res = new GoogleReCaptchaV3Response([], $ip);
             $res->setSuccess(true);
 
             return $res;
         }
 
+
         if (empty($response)) {
             $res = new GoogleReCaptchaV3Response([], $ip, GoogleReCaptchaV3Response::MISSING_INPUT_ERROR);
             $res->setSuccess(false);
@@ -67,7 +78,7 @@ public function verifyResponse($response, $ip = null)
             return $rawResponse;
         }
 
-        if (! empty($this->config->getHostName()) && strcasecmp($this->config->getHostName(), $rawResponse->getHostname()) !== 0) {
+        if (!empty($this->config->getHostName()) && strcasecmp($this->config->getHostName(), $rawResponse->getHostname()) !== 0) {
             $rawResponse->setMessage(GoogleReCaptchaV3Response::ERROR_HOSTNAME);
             $rawResponse->setSuccess(false);
 

tests/ConfigTest.php

@@ -220,4 +220,57 @@ public function testActionSkip()
         $response = $service->verifyResponse('test response');
         $this->assertEquals(true, $response->isSuccess());
     }
+
+
+
+    public function testIpSkip1()
+    {
+        // Create a stub for the SomeClass class.
+        $configStub = $this->createMock(ReCaptchaConfigV3::class);
+
+        // Configure the stub.
+        $configStub->method('isServiceEnabled')
+            ->willReturn(true);
+
+        $configStub->method('getSkipIps')
+            ->willReturn(['1.1.1.1']);
+
+        $testJson = '{ "success": false, "challenge_ts": "2018-12-25T03:35:32Z", "hostname": "ryandeng.test", "score": 0.9, "action": "contact_us" }';
+
+        $clientStub = $this->createMock(GuzzleRequestClient::class);
+        $clientStub->method('post')
+            ->willReturn($testJson);
+
+        $_service = new GoogleReCaptchaV3Service($configStub, $clientStub);
+        $service = new GoogleReCaptchaV3($_service);
+
+        $response = $service->verifyResponse('test response','1.1.1.1');
+        $this->assertEquals(true, $response->isSuccess());
+    }
+
+
+    public function testIpSkip2()
+    {
+        // Create a stub for the SomeClass class.
+        $configStub = $this->createMock(ReCaptchaConfigV3::class);
+
+        // Configure the stub.
+        $configStub->method('isServiceEnabled')
+            ->willReturn(true);
+
+        $configStub->method('getSkipIps')
+            ->willReturn(['1.1.1.1']);
+
+        $testJson = '{ "success": false, "challenge_ts": "2018-12-25T03:35:32Z", "hostname": "ryandeng.test", "score": 0.9, "action": "contact_us" }';
+
+        $clientStub = $this->createMock(GuzzleRequestClient::class);
+        $clientStub->method('post')
+            ->willReturn($testJson);
+
+        $_service = new GoogleReCaptchaV3Service($configStub, $clientStub);
+        $service = new GoogleReCaptchaV3($_service);
+
+        $response = $service->verifyResponse('test response','1.1.1.2');
+        $this->assertEquals(false, $response->isSuccess());
+    }
 }