library akismet-spam

chrisyoyo/akismet-spam

Akismet Service for spam detection.

About

, _(*1)

Laravel 5 package that allows you to deal with spams using Akismet., _(*2)

Usage

In your project: composer require chrisyoyo/akismet-spam, _(*3)

In config/app.php providers:, _(*4)

Chrisyoyo\AkismetSpam\SpamServiceProvider::class,

Next, publish the package default config:, _(*5)

php artisan vendor:publish --provider="Chrisyoyo\AkismetSpam\SpamServiceProvider"

In the .env change your akismet secret and website., _(*6)

Then add a boolean 'spam' column with default to false on models you want to use. And add the spammable trait, and the getSpamColumns function to it like this :, _(*7)

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;
use Chrisyoyo\AkismetSpam\Spammable;

class Post extends Model
{
    use Spammable;

    public function getSpamColumns()
    {
        return [
            'body' => 'body',
            'author' => 'user.name',
            'author_email' => 'user.email',
        ];
    }

    public function user()
    {
        return $this->belongsTo(User::class);
    }
}

...

It is very flexible, in your controller you have 3 choices of implementation, first the easiest for the store method:, _(*8)

public function store(Request $request)
    {
        $post = new Post;
        $post->body = 'Hello, my name is ' . $request->user()->name;
        $post->user()->associate($request->user());

        if ($post->isSpam()) {
            $post->spam = true;
        }

        $post->save();
    }

...

It can be done because you have the Spammable trait on your model., _(*9)

You can also add the interface on your controller and use it like this:, _(*10)

use Chrisyoyo\AkismetSpam\Service\SpamServiceInterface;

...


protected $spam;

public function __construct(SpamServiceInterface $spam)
{
    $this->middleware(['auth']);

    $this->spam = $spam;
}

public function store(Request $request)
{
    $post = new Post;
    $post->body = 'Hello, my name is ' . $request->user()->name;
    $post->user()->associate($request->user());

    if ($this->spam->isSpam([
        'body' => $post->body,
        'author' => $post->user->name,
        'author_email' => $post->user->email,
    ])) {
        $this->spam->markAsSpam([
            'body' => $post->body,
            'author' => $post->user->name,
            'author_email' => $post->user->email,
        ]);

        $post->spam = true;
    }

    $post->save();
}

...

or simply use the Spam Facade:, _(*11)

use Chrisyoyo\AkismetSpam\Spam;

...

public function store(Request $request)
{
    if (Spam::isSpam([
        'body' => $post->body,
        'author' => $post->user->name,
        'author_email' => $post->user->email,
    ])) {
        Spam::markAsSpam([
            'body' => $post->body,
            'author' => $post->user->name,
            'author_email' => $post->user->email,
        ])

        $post->spam = true;
    }
}

...

Then you have two examples function to mark as a spam, or say that is not a spam., _(*12)

public function spam(Post $post)
{
    $post->markAsSpam();

    $post->spam = true;
    $post->save();
}

public function ham(Post $post)
{
    $post->markAsHam();

    $post->spam = false;
    $post->save();
}

...