Laravel BotScout
Protect your website against automated scripts using the botscout.com API.
Installation
You can install the package via composer:
composer require nicolasbeauvais/laravel-botscout
Next, you must install the service provider:
// config/app.php
'providers' => [
...
NicolasBeauvais\LaravelBotScout\BotScoutServiceProvider::class,
];
Add your botscout.com api key to the .env file:
BOTSCOUT_SECRET=your-api-key
If needed you can also publish the config file:
php artisan vendor:publish --provider="NicolasBeauvais\LaravelBotScout\BotScoutServiceProvider" --tag="config"
If you want to make use of the facade you must install it as well:
// config/app.php
'aliases' => [
...
'BotScout' => NicolasBeauvais\LaravelBotScout\BotScoutFacade::class,
];
Usage
You are highly advised to read the BotScout.com API guide to understand the meaning of each method.
Validator
You can easily use botscout in your existing validators:
// Validate name
$validator = Validator::make(['name' => 'John Doe'], [
'name' => 'required|botscout_name'
]);
// Validate email
$validator = Validator::make(['email' => '[email protected]'], [
'email' => 'required|botscout_mail'
]);
// Validate ip
$validator = Validator::make(['ip' => '127.0.0.1'], [
'ip' => 'required|botscout_ip'
]);
Note that you will need to create the validation message by yourself, as described in the Laravel documentation.
Facade
You can use the BotScout facade anywhere in your app:
BotScout::multi('John Doe', '[email protected]', '127.0.0.1')->isValid();
BotScout::all('John Doe')->isValid();
BotScout::name('John Doe')->isValid();
BotScout::mail('[email protected]')->isValid();
BotScout::ip('127.0.0.1')->isValid();
// We also include a quick way of testing a user with integrated exception catch
BotScout::check('John Doe', '[email protected]', '127.0.0.1'); // true or false
Real life example using the check method
The check method is the recommended way to validate a register form:
The
checkmethod is a wrapper to themultimethod that catch any http error / timeout. If the botscout api is not responding, the method will return false.
// Create a classic validation
$validator = Validator::make($request->all(), [
'email' => 'required|email|unique:users',
'name' => 'required|max:20',
]);
$validator->after(function ($validator) {
if (!BotScout::check($request->get('name'), $request->get('email'), $request->ip())) {
$validator->errors()->add('email', 'Sorry, it looks like your a bot!');
}
});
Changelog
Please see CHANGELOG for more information what has changed recently.
Testing
$ composer test
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.
399 Aug 18, 2022
71 Sep 29, 2022
23 Dec 20, 2022
3 Feb 27, 2022
2 Mar 8, 2022
6 Oct 27, 2020
4 Oct 18, 2022
7 Mar 22, 2022
32 Dec 20, 2022
526 Dec 5, 2022
11 Dec 3, 2022
4 Jul 16, 2022
3 Dec 15, 2022
1 Oct 16, 2021
117 Oct 19, 2022
101 Oct 28, 2022
15 Jul 28, 2022
49 Jan 8, 2022
67 May 18, 2022