Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mcaskill/charcoal-recaptcha
Google reCAPTCHA for Charcoal.
https://github.com/mcaskill/charcoal-recaptcha
Last synced: 12 days ago
JSON representation
Google reCAPTCHA for Charcoal.
- Host: GitHub
- URL: https://github.com/mcaskill/charcoal-recaptcha
- Owner: mcaskill
- License: mit
- Created: 2016-06-22T19:31:57.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2021-07-21T19:35:56.000Z (over 3 years ago)
- Last Synced: 2024-10-04T07:41:38.518Z (about 1 month ago)
- Language: PHP
- Size: 55.7 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Google reCAPTCHA for Charcoal
[![License][badge-license]][charcoal/recaptcha]
[![Latest Stable Version][badge-version]][charcoal/recaptcha]
[![Code Quality][badge-scrutinizer]][dev-scrutinizer]
[![Coverage Status][badge-coveralls]][dev-coveralls]
[![Build Status][badge-travis]][dev-travis]
A [Charcoal][charcoal/app] service provider for the [Google reCAPTCHA client Library][google/recaptcha].
This package can be used as a PSR-7 middleware or as an object in your service layer.
## Installation
```shell
composer require mcaskill/charcoal-recaptcha
```
See [`composer.json`](composer.json) for depenencides.
## What's inside?
- **`Charcoal\ReCaptcha\CaptchaServiceProvider`**:
Pimple service provider.
- **`Charcoal\ReCaptcha\CaptchaConfig`**:
Configuring the CAPTCHA service.
- **`Charcoal\ReCaptcha\CaptchaAwareTrait`**:
Convenient trait for interfacing with the CAPTCHA service.
- **`Charcoal\ReCaptcha\Captcha`**:
Service that handles the reCAPTCHA client.
- **`Charcoal\ReCaptcha\LocalizedCaptcha`**:
[Translator-aware][charcoal/translator] variant of the service.
## Usage
```php
use Charcoal\ReCaptcha\Captcha;
$captcha = new Captcha([
'config' => [
'public_key' => '…',
'private_key' => '…',
]
]);
// As middleware
$app->post('/signup', '…')->add($captcha);
// As standalone, with direct user input
$captcha->verify($input, $ip);
// With a PSR-7 request
$captcha->verifyRequest($request);
// Display the widget in your views
echo $captcha->display(
[
'data-theme' => 'dark',
'data-type' => 'audio',
],
[
'hl' => 'fr'
]
);
```
By default, the `Captcha` adapter will defer the instantiation of [`ReCaptcha`][class-recaptcha] until the first verification request.
### Custom ReCaptcha Class
The `ReCaptcha` class be swapped using the `client_class` option.
```php
use Charcoal\ReCaptcha\Captcha;
use MyApp\ MyCustomReCaptcha;
$captcha = new Captcha([
'config' => [
'public_key' => '…',
'private_key' => '…',
],
'client_class' => MyCustomReCaptcha::class
]);
```
### Custom ReCaptcha Instance
An instance of the `ReCaptcha` class can be assigned using the `client` option.
```php
use Charcoal\ReCaptcha\Captcha;
use ReCaptcha\ReCaptcha;
use ReCaptcha\RequestMethod\CurlPost;
$client = new ReCaptcha('…', new CurlPost());
$captcha = new Captcha([
'config' => [
'public_key' => '…',
'private_key' => '…',
],
'client' => $client
]);
```
## Service Provider
If [`CaptchaServiceProvider`](src/CaptchaServiceProvider.php) is used, the following are provided.
### Parameters
- **charcoal/captcha/config**: An instance of [`CaptchaConfig`](src/CaptchaConfig.php).
### Services
- **charcoal/captcha**: An instance of [`Captcha`](src/CaptchaConfig.php).
### Registering
Via Charcoal configuration file:
```json
{
"apis": {
"google": {
"recaptcha": {
"public_key": "…",
"private_key": "…"
}
},
},
"service_providers": {
"charcoal/re-captcha/captcha": {}
}
}
```
Via PHP:
```php
$container->register(new Charcoal\ReCaptcha\CaptchaServiceProvider(), [
'charcoal/captcha/config' => [
'public_key' => '…',
'private_key' => '…'
]
]);
```
## Acknowledgements
This package is inspired by:
- [`geggleto/psr7-recaptcha`](https://github.com/geggleto/psr7-recaptcha)
- [`anhskohbo/no-captcha`](https://github.com/anhskohbo/no-captcha)
- [`buzz/laravel-google-captcha`](https://github.com/thinhbuzz/laravel-google-captcha)
## License
- Charcoal reCAPTCHA component is licensed under the MIT license. See [LICENSE](LICENSE) for details.
- Charcoal framework is licensed under the MIT license. See [LICENSE][license-charcoal] for details.
- Google reCAPTCHA PHP client library is licensed under the BSD License. See the [LICENSE][license-recaptcha] file for details.
[dev-scrutinizer]: https://scrutinizer-ci.com/g/mcaskill/charcoal-recaptcha/
[dev-coveralls]: https://coveralls.io/r/mcaskill/charcoal-recaptcha
[dev-travis]: https://travis-ci.org/mcaskill/charcoal-recaptcha
[badge-license]: https://img.shields.io/packagist/l/mcaskill/charcoal-recaptcha.svg?style=flat-square
[badge-version]: https://img.shields.io/packagist/v/mcaskill/charcoal-recaptcha.svg?style=flat-square
[badge-scrutinizer]: https://img.shields.io/scrutinizer/g/mcaskill/charcoal-recaptcha.svg?style=flat-square
[badge-coveralls]: https://img.shields.io/coveralls/mcaskill/charcoal-recaptcha.svg?style=flat-square
[badge-travis]: https://img.shields.io/travis/mcaskill/charcoal-recaptcha.svg?style=flat-square
[charcoal/recaptcha]: https://packagist.org/packages/mcaskill/charcoal-recaptcha
[charcoal/app]: https://packagist.org/packages/locomotivemtl/charcoal-app
[charcoal/translator]: https://packagist.org/packages/locomotivemtl/charcoal-translator
[pimple]: https://packagist.org/packages/pimple/pimple
[google/recaptcha]: https://packagist.org/packages/google/recaptcha
[class-recaptcha]: https://github.com/google/recaptcha/blob/1.1.3/src/ReCaptcha/ReCaptcha.php
[license-charcoal]: https://github.com/locomotivemtl/charcoal-app/blob/master/LICENSE
[license-recaptcha]: https://github.com/google/recaptcha/blob/master/LICENSE