Updating docs and other stuff

ARCANEDEV · Mar 17, 2017 · 071fa9a · 071fa9a
1 parent 9f1aafc
commit 071fa9a
Show file tree

Hide file tree

Showing 5 changed files with 88 additions and 3 deletions.
diff --git a/_docs/1-Installation-and-Setup.md b/_docs/1-Installation-and-Setup.md
@@ -45,8 +45,6 @@ For more details, check the [official documentation](https://developers.google.c
 
 You can install this package via [Composer](http://getcomposer.org/) by running this command `composer require arcanedev/no-captcha`.
 
-> For Laravel users, please check the [Version Compatibility](2-Version-Compatibility.md) section.
-
 ## Laravel
 
 ### Setup

diff --git a/_docs/3-Usage.md b/_docs/3-Usage.md
@@ -60,6 +60,44 @@ echo $captcha->script();
 
 Check the [examples folder](https://github.com/ARCANEDEV/noCAPTCHA/tree/master/examples) for more usage details.
 
+#### Invisible Captcha
+
+The code below explains how to enable and customize the invisible reCAPTCHA on your webpage.
+
+```php
+require_once(__DIR__ . '/../vendor/autoload.php');
+
+use Arcanedev\NoCaptcha\NoCaptcha;
+
+$secret  = 'your-secret-key';
+$sitekey = 'your-site-key';
+$captcha = new NoCaptcha($secret, $sitekey);
+
+if ( ! empty($_POST)) {
+    $response = $_POST[NoCaptcha::CAPTCHA_NAME];
+    $result   = $captcha->verify($response);
+
+    echo $result === true ? 'Yay ! You are a human.' : 'No ! You are a robot.';
+
+    exit();
+}
+?>
+
+<form method="POST" id="demo-form">
+    <?php echo $captcha->button('Send', ['data-badge' => 'inline']); ?>
+</form>
+
+<?php echo $captcha->script(); ?>
+
+<script>
+    function onSubmit(token) {
+        document.getElementById("demo-form").submit();
+    }
+</script>
+```
+
+**NOTE :** You need to specify the invisible version in your captcha admin page. Check this page for more details: https://developers.google.com/recaptcha/docs/versions
+
 ### Laravel
 
 #### Views
@@ -169,3 +207,5 @@ if ($validator->fails()) {
     // Redirect back or throw an error
 }
 ```
+
+> For more advanced usage, check the [official recaptcha documentation](https://developers.google.com/recaptcha/intro).
diff --git a/_docs/4-Extras.md b/_docs/4-Extras.md
@@ -8,7 +8,7 @@
   4. [Extras](4-Extras.md)
   5. [FAQ](5-FAQ.md)
 
-## g-recaptcha tag attributes
+## [reCaptcha V2] g-recaptcha tag attributes
 
 | Attributes            | Value            | Default | Description                                                                                                                                                                                      |
 | --------------------- | ---------------- |:-------:| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
@@ -20,6 +20,17 @@
 | data-callback         |                  |         | Optional. Your callback function that's executed when the user submits a successful CAPTCHA response. The user's response, `g-recaptcha-response`, will be the input for your callback function. |
 | data-expired-callback |                  |         | Optional. Your callback function that's executed when the recaptcha response expires and the user needs to solve a new CAPTCHA.                                                                  |
 
+## [Invisible reCaptcha] g-recaptcha tag attributes.
+
+| Attributes    | Value                             | Default     | Description                                                                                                                                                                                      |
+| ------------- | --------------------------------- |:-----------:| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| data-sitekey  |                                   |             | Your sitekey                                                                                                                                                                                     |
+| data-badge    | bottomleft / inline / bottomright | bottomright | Optional. Reposition the reCAPTCHA badge. 'inline' allows you to control the CSS.                                                                                                                |
+| data-type     | audio / image                     | image       | Optional. The type of CAPTCHA to serve.                                                                                                                                                          |
+| data-size     | compact / normal                  | normal      | Optional. The size of the widget.                                                                                                                                                                |
+| data-tabindex |                                   |             | Optional. The tabindex of the widget and challenge. If other elements in your page use tabindex, it should be set to make user navigation easier.                                                |
+| data-callback |                                   | onSubmit    | Optional. Your callback function that's executed when the user submits a successful CAPTCHA response. The user's response, `g-recaptcha-response`, will be the input for your callback function. |
+
 ## Examples
 
 Check the [examples folder](https://github.com/ARCANEDEV/noCAPTCHA/tree/master/examples) for more usage details.
diff --git a/examples/invisible-captcha.php b/examples/invisible-captcha.php
@@ -0,0 +1,31 @@
+<?php
+
+require_once(__DIR__ . '/../vendor/autoload.php');
+
+use Arcanedev\NoCaptcha\NoCaptcha;
+
+$secret  = 'your-secret-key';
+$sitekey = 'your-site-key';
+$captcha = new NoCaptcha($secret, $sitekey);
+
+if ( ! empty($_POST)) {
+    $response = $_POST[NoCaptcha::CAPTCHA_NAME];
+    $result   = $captcha->verify($response);
+
+    echo $result === true ? 'Yay ! You are a human.' : 'No ! You are a robot.';
+
+    exit();
+}
+?>
+
+<form method="POST" id="demo-form">
+    <?php echo $captcha->button('Send'); ?>
+</form>
+
+<?php echo $captcha->script(); ?>
+
+<script>
+    function onSubmit(token) {
+        document.getElementById("demo-form").submit();
+    }
+</script>
diff --git a/tests/NoCaptchaTest.php b/tests/NoCaptchaTest.php
@@ -335,6 +335,11 @@ public function it_can_display_invisible_captcha()
             $this->noCaptcha->button('Send')
         );
 
+        $this->assertSame(
+            '<button class="g-recaptcha" data-sitekey="site-key" data-callback="submitForm">Post the form</button>',
+            $this->noCaptcha->button('Post the form', ['data-callback' => 'submitForm'])
+        );
+
         $this->assertSame(
             '<button class="g-recaptcha" data-sitekey="site-key" data-callback="onSubmit" data-size="invisible">Send</button>',
             $this->noCaptcha->button('Send', ['data-size' => 'invisible'])