andrey-helldar/blacklist-client

This package is abandoned and no longer maintained. The author suggests using the johannebert/laravel-spam-protector package instead.

The blacklist client package for connecting to the Blacklist Server

v2.2.1 2020-12-30 19:48 UTC

Requires

• php: ^7.1.3|^8.0
• ext-json: *
• ext-mbstring: *
• andrey-helldar/blacklist-core: ^2.0

Requires (Dev)

• phpunit/phpunit: ^8.0

Suggests

• andrey-helldar/blacklist-server: The blacklist server package

MIT

• Andrey Helldar

• spam
• laravel
• anti-spam
• antispam
• blacklist

README

The blacklist client package for connecting to the Blacklist Server.

Content

• Installation
• Using
• License

Installation

To get the latest version of Laravel Blacklist Client, simply require the project using Composer:

composer require andrey-helldar/blacklist-client

Instead, you may of course manually update your require block and run composer update if you so choose:

{
    "require": {
        "andrey-helldar/blacklist-client": "^2.0"
    }
}

Now, you can also publish the config file to change implementations (ie. interface to specific class):

php artisan vendor:publish --provider="Helldar\BlacklistClient\ServiceProvider"

Using

First look at the config.

check / exists

To check the existence of a spammer in the database, you need to transfer the data type and value:

/*
 * DATABASE
 * [e-mail] - exists
 * [e-mail] - not exists
 */

use Helldar\BlacklistClient\Facades\Client;

return Client::check('http://example.com'); // false
return Client::check('192.168.1.1'); // false
return Client::check('+0 [phone]'); // false

return Client::check('[e-mail]');
/* GuzzleHttp\Exception\ClientException with 423 code and content:
 *
 * {"error":{"code":400,"msg":["Checked [e-mail] was found in our database.]}}
 */

For example:

use GuzzleHttp\Exception\ClientException;
use Helldar\BlacklistClient\Facades\Client;

class Foo
{
    public function store(array $data)
    {
        if (! $this->isSpammer($data['email'])) {
            // storing data
        }
    }

    private function isSpammer(string $value): bool
    {
        try {
            return Client::check($value);
        }
        catch (ClientException $exception) {
            return true;
        }
    }
}

store

To storing a spammer to the database, use the method store of the facade Client:

use Helldar\BlacklistClient\Facades\Client;

return Client::store('[e-mail]', 'email');
return Client::store('http://example.com', 'url');
return Client::store('192.168.1.1', 'ip');
return Client::store('+0 [phone]', 'phone');

For example:

use Helldar\BlacklistClient\Facades\Client;

$item = Client::store('[e-mail]', 'email');

return $item->expired_at; // 2019-09-27 23:25:27

License

This package is released under the MIT License.