From c668a628af438f63b235f12cd30307eb294f47ae Mon Sep 17 00:00:00 2001
From: Rahul Dey <rahul900day@gmail.com>
Date: Fri, 6 Oct 2023 01:42:10 +0530
Subject: [PATCH] more testing and cleaning

---
 resources/views/components/button.blade.php   |  2 +-
 .../views/components/container.blade.php      |  2 +-
 src/CaptchaServiceProvider.php                |  6 ++--
 src/Contracts/Captcha.php                     | 12 -------
 src/Drivers/FakeCaptcha.php                   |  6 +++-
 src/Drivers/HCaptcha.php                      | 14 --------
 src/Drivers/ReCaptcha.php                     | 14 --------
 src/Drivers/TurnstileCaptcha.php              | 11 ------
 src/Facades/Captcha.php                       | 11 ++----
 src/Rules/Captcha.php                         |  4 +--
 src/Views/Components/Button.php               |  4 +--
 src/Views/Components/Container.php            |  4 +--
 tests/FakeCaptchaTest.php                     | 12 +++----
 tests/ValidationTest.php                      | 36 ++++++++++++++++++-
 14 files changed, 58 insertions(+), 80 deletions(-)

diff --git a/resources/views/components/button.blade.php b/resources/views/components/button.blade.php
index 6bd72f3..8145ec1 100644
--- a/resources/views/components/button.blade.php
+++ b/resources/views/components/button.blade.php
@@ -1,6 +1,6 @@
 <button {{ $attributes->merge([
     'class' => $containerClass,
-    'data-sitekey' => $sitekey,
+    'data-sitekey' => $site_key,
     'data-callback' => $callback
 ]) }}>
     {{ $slot }}
diff --git a/resources/views/components/container.blade.php b/resources/views/components/container.blade.php
index 4a9dfbe..cb54e06 100644
--- a/resources/views/components/container.blade.php
+++ b/resources/views/components/container.blade.php
@@ -2,5 +2,5 @@
     'class' => $containerClass,
     'data-theme' => $theme,
     'data-size' => $size,
-    'data-sitekey' => $sitekey,
+    'data-sitekey' => $site_key,
 ]) }}></div>
diff --git a/src/CaptchaServiceProvider.php b/src/CaptchaServiceProvider.php
index 845a009..34e95f4 100644
--- a/src/CaptchaServiceProvider.php
+++ b/src/CaptchaServiceProvider.php
@@ -17,9 +17,7 @@ class CaptchaServiceProvider extends ServiceProvider
 {
     public function register(): void
     {
-        $this->mergeConfigFrom(
-            __DIR__.'/../config/captcha.php', 'captcha'
-        );
+        $this->mergeConfigFrom(__DIR__.'/../config/captcha.php', 'captcha');
 
         $this->app->singleton(CaptchaContract::class, fn ($app): CaptchaManager => new CaptchaManager($app));
 
@@ -50,7 +48,7 @@ protected function bootBladeComponents(): void
 
     protected function bootValidations(): void
     {
-        Validator::extend('captcha', Captcha::class.'@passes', __(Captcha::MESSAGE));
+        Validator::extend('captcha', Captcha::class.'@passes', __(Captcha::$message));
     }
 
     protected function bootPublishing(): void
diff --git a/src/Contracts/Captcha.php b/src/Contracts/Captcha.php
index 7a51c33..6bad033 100644
--- a/src/Contracts/Captcha.php
+++ b/src/Contracts/Captcha.php
@@ -6,23 +6,11 @@
 
 interface Captcha
 {
-    /**
-     * Verify the captcha response.
-     */
     public function verify(string $token): bool;
 
-    /**
-     * Returns the name of captcha service input.
-     */
     public function getResponseName(): string;
 
-    /**
-     * Returns the name of captcha container class.
-     */
     public function getContainerClassName(): string;
 
-    /**
-     * Get javascript for captcha service.
-     */
     public function getJs(?string $hl): string;
 }
diff --git a/src/Drivers/FakeCaptcha.php b/src/Drivers/FakeCaptcha.php
index 3708b26..c1e7bcc 100644
--- a/src/Drivers/FakeCaptcha.php
+++ b/src/Drivers/FakeCaptcha.php
@@ -8,9 +8,13 @@
 
 class FakeCaptcha implements Captcha
 {
+    public function __construct(protected bool $verify = true)
+    {
+    }
+
     public function verify(string $token): bool
     {
-        return true;
+        return $this->verify;
     }
 
     public function getResponseName(): string
diff --git a/src/Drivers/HCaptcha.php b/src/Drivers/HCaptcha.php
index 31def9a..9654311 100644
--- a/src/Drivers/HCaptcha.php
+++ b/src/Drivers/HCaptcha.php
@@ -9,16 +9,8 @@
 
 class HCaptcha implements Captcha
 {
-    /**
-     * The url to verify the captcha response.
-     *
-     * @var string
-     */
     public const VERIFY_URL = 'https://hcaptcha.com/siteverify';
 
-    /**
-     * Verify the captcha response.
-     */
     public function verify(string $token): bool
     {
         $captcha_resp = Http::asForm()->post(self::VERIFY_URL, [
@@ -30,9 +22,6 @@ public function verify(string $token): bool
         return (bool) collect($captcha_resp)->get('success');
     }
 
-    /**
-     * Returns the name of captcha service input.
-     */
     public function getResponseName(): string
     {
         return 'h-captcha-response';
@@ -43,9 +32,6 @@ public function getContainerClassName(): string
         return 'h-captcha';
     }
 
-    /**
-     * Get javascript for captcha service.
-     */
     public function getJs(?string $hl = null): string
     {
         $hl ??= config('captcha.locale', 'en');
diff --git a/src/Drivers/ReCaptcha.php b/src/Drivers/ReCaptcha.php
index a298f6c..ed60b66 100644
--- a/src/Drivers/ReCaptcha.php
+++ b/src/Drivers/ReCaptcha.php
@@ -9,16 +9,8 @@
 
 class ReCaptcha implements Captcha
 {
-    /**
-     * The url to verify the captcha response.
-     *
-     * @var string
-     */
     public const VERIFY_URL = 'https://www.google.com/recaptcha/api/siteverify';
 
-    /**
-     * Verify the captcha response.
-     */
     public function verify(string $token): bool
     {
         $captcha_resp = Http::asForm()->post(self::VERIFY_URL, [
@@ -30,9 +22,6 @@ public function verify(string $token): bool
         return (bool) collect($captcha_resp)->get('success');
     }
 
-    /**
-     * Returns the name of captcha service input.
-     */
     public function getResponseName(): string
     {
         return 'g-recaptcha-response';
@@ -43,9 +32,6 @@ public function getContainerClassName(): string
         return 'g-recaptcha';
     }
 
-    /**
-     * Get javascript for captcha service.
-     */
     public function getJs(?string $hl = null): string
     {
         $hl ??= config('captcha.locale', 'en');
diff --git a/src/Drivers/TurnstileCaptcha.php b/src/Drivers/TurnstileCaptcha.php
index 94fa4ba..fbbeb4b 100644
--- a/src/Drivers/TurnstileCaptcha.php
+++ b/src/Drivers/TurnstileCaptcha.php
@@ -9,16 +9,8 @@
 
 class TurnstileCaptcha implements Captcha
 {
-    /**
-     * The url to verify the captcha response.
-     *
-     * @var string
-     */
     public const VERIFY_URL = 'https://challenges.cloudflare.com/turnstile/v0/siteverify';
 
-    /**
-     * Verify the captcha response.
-     */
     public function verify(string $token): bool
     {
         $captcha_resp = Http::asForm()->post(self::VERIFY_URL, [
@@ -30,9 +22,6 @@ public function verify(string $token): bool
         return (bool) collect($captcha_resp)->get('success');
     }
 
-    /**
-     * Returns the name of captcha service input.
-     */
     public function getResponseName(): string
     {
         return 'cf-turnstile-response';
diff --git a/src/Facades/Captcha.php b/src/Facades/Captcha.php
index 2d24eba..2c1baab 100644
--- a/src/Facades/Captcha.php
+++ b/src/Facades/Captcha.php
@@ -11,7 +11,6 @@
 /**
  * @method static bool verify(string $token)
  * @method static string getJs(null|string $hl = null)
- * @method static string getContainer(null|string $theme = null, null|string $size = null)
  * @method static string getResponseName()
  * @method static string getContainerClassName()
  *
@@ -19,19 +18,13 @@
  */
 class Captcha extends Facade
 {
-    /**
-     * Get the registered name of the component.
-     */
     protected static function getFacadeAccessor(): string
     {
         return CaptchaContract::class;
     }
 
-    /**
-     * Register a fake captcha service in request.
-     */
-    public static function fake(): void
+    public static function fake(bool $result = true): void
     {
-        self::swap(new FakeCaptcha());
+        self::swap(new FakeCaptcha($result));
     }
 }
diff --git a/src/Rules/Captcha.php b/src/Rules/Captcha.php
index e2ee061..ee91c71 100644
--- a/src/Rules/Captcha.php
+++ b/src/Rules/Captcha.php
@@ -9,7 +9,7 @@
 
 class Captcha implements Rule
 {
-    public const MESSAGE = 'The captcha verification failed.';
+    public static string $message = 'The captcha verification failed.';
 
     /**
      * Determine if the validation rule passes.
@@ -27,6 +27,6 @@ public function passes($attribute, $value): bool
      */
     public function message(): string
     {
-        return __(self::MESSAGE);
+        return __(self::$message);
     }
 }
diff --git a/src/Views/Components/Button.php b/src/Views/Components/Button.php
index c250b27..4b3fd65 100644
--- a/src/Views/Components/Button.php
+++ b/src/Views/Components/Button.php
@@ -13,7 +13,7 @@ class Button extends Component
 {
     public string $containerClass;
 
-    public string $sitekey;
+    public string $site_key;
 
     public string $callback;
 
@@ -23,7 +23,7 @@ class Button extends Component
 
     public function __construct(public string $formId, string $callback = null)
     {
-        $this->sitekey = config('captcha.sitekey', '');
+        $this->site_key = config('captcha.sitekey', '');
         $this->containerClass = Captcha::getContainerClassName();
         $this->nonce = Str::random(10);
         $this->callback = $callback ?? "onCaptchaSubmit_{$this->nonce}";
diff --git a/src/Views/Components/Container.php b/src/Views/Components/Container.php
index 811cc23..0da0fed 100644
--- a/src/Views/Components/Container.php
+++ b/src/Views/Components/Container.php
@@ -12,7 +12,7 @@ class Container extends Component
 {
     public string $containerClass;
 
-    public string $sitekey;
+    public string $site_key;
 
     public ?string $theme;
 
@@ -20,7 +20,7 @@ class Container extends Component
 
     public function __construct(string $theme = null, string $size = null)
     {
-        $this->sitekey = config('captcha.sitekey', '');
+        $this->site_key = config('captcha.sitekey', '');
         $this->theme = $theme ?? config('captcha.theme', 'light');
         $this->size = $size ?? config('captcha.size', 'normal');
         $this->containerClass = Captcha::getContainerClassName();
diff --git a/tests/FakeCaptchaTest.php b/tests/FakeCaptchaTest.php
index ec47ef6..f627134 100644
--- a/tests/FakeCaptchaTest.php
+++ b/tests/FakeCaptchaTest.php
@@ -2,27 +2,27 @@
 
 use Rahul900day\Captcha\Facades\Captcha;
 
-beforeEach(function () {
-    Captcha::fake();
-});
-
 it('can be succeed', function () {
+    Captcha::fake();
     $res = Captcha::verify('test_success_token');
 
     expect($res)->toBeTrue();
 });
 
-it('can\'t be failed', function () {
+it('can be failed', function () {
+    Captcha::fake(false);
     $res = Captcha::verify('test_fail_token');
 
-    expect($res)->toBeTrue();
+    expect($res)->not->toBeTrue();
 });
 
 it('can give captcha class', function () {
+    Captcha::fake();
     expect(Captcha::getContainerClassName())->toBe('fake-captcha-container');
 });
 
 it('can give fake captcha javascript', function () {
+    Captcha::fake();
     $js_code = Captcha::getJs('fr');
 
     expect($js_code)->toMatchSnapshot();
diff --git a/tests/ValidationTest.php b/tests/ValidationTest.php
index cc53f4d..65a9dd6 100644
--- a/tests/ValidationTest.php
+++ b/tests/ValidationTest.php
@@ -4,7 +4,7 @@
 use Rahul900day\Captcha\Facades\Captcha;
 use Rahul900day\Captcha\Rules\Captcha as CaptchaRule;
 
-it('can validate', function () {
+it('can be pass', function () {
     Captcha::fake();
 
     $validator = Validator::make([Captcha::getResponseName() => 'test_resp'], [
@@ -17,6 +17,40 @@
     expect($validator->fails())->toBeFalse();
 });
 
+it('can be fail', function () {
+    Captcha::fake(false);
+
+    $validator = Validator::make([Captcha::getResponseName() => 'test_resp'], [
+        Captcha::getResponseName() => [
+            'required',
+            new CaptchaRule(),
+        ],
+    ]);
+
+    expect($validator->fails())->toBeTrue();
+
+    $messages = $validator->messages();
+    expect($messages->get(Captcha::getResponseName())[0])->toBe(CaptchaRule::$message);
+});
+
+it('can have custom error messages', function ($message) {
+    Captcha::fake(false);
+    CaptchaRule::$message = $message;
+
+    $validator = Validator::make([Captcha::getResponseName() => 'test_resp'], [
+        Captcha::getResponseName() => [
+            'required',
+            new CaptchaRule(),
+        ],
+    ]);
+
+    $messages = $validator->messages();
+    expect($messages->get(Captcha::getResponseName())[0])->toBe($message);
+})->with([
+    'Failed.',
+    'Validation Failed.',
+]);
+
 it('can validate with alias', function () {
     Captcha::fake();