mortenscheel/laravel-automation

Laravel automation framework

v0.1 2022-03-20 19:57 UTC

Requires

• php: ^8.0
• illuminate/contracts: ^9.0

Requires (Dev)

• nunomaduro/collision: ^6.0
• orchestra/testbench: ^7.0
• phpunit/phpunit: ^9.5
• roave/security-advisories: dev-latest

MIT

• Morten Scheel

• laravel
• laravel-automation

README

Allow users to configure dynamic automation flows in your Laravel app. Inspired by If this then that, you define a number of triggers and actions, and then allow your users to combine and configure them.

Quick start

Install the package with composer:

composer require mortenscheel/laravel-automation

Publish and run the migrations:

php artisan vendor:publish --tag="automation-migrations"
php artisan migrate

Run automations automatically via Laravel's scheduler in app/Console/Kernel.php

protected function schedule(Schedule $schedule)
{
    // ...
    $schedule->command('automation:run');
}

Concepts

AutomationTrigger classes

Custom classes that are responsible for discovering models that meet their criteria.

AutomationAction classes

Custom Job classes that perform an action on a model.

Automation model

A concrete automation workflow that combines an AutomationTrigger with an AutomationAction. Also includes (optional) parameters for both the trigger and the action.

AutomationLog model

A record that is created when an Automation is performed on a specific model.

Automatable interface

In order to make your models automatable, they must implement the Automatable interface.

Examples

Send a welcome email 15 minutes after a new user is created

The Automation model might look something like this

Automation::create([
    'trigger_class' => ModelAgeTrigger::class,
    'trigger_params' => [
        'model' => User::class,
        'age' => 60 * 15,
    ],
    'action_class' => SendMailableAction::class,
    'action_params' => [
        'mailable' => WelcomeEmail::class,
        'mailable_params' => [
            'name',
        ],
    ],
]);

The trigger class only need to implement a single method:

class ModelAgeTrigger extends \Scheel\Automation\AutomationTrigger
{
    public function discoverAutomatable(Automation $automation): Collection
    {
        $class = $this->params->get('model');
        return $class::query()->where('created_at', '<=', now()->subSeconds($this->params->get('age')))
            ->whereDoesntHave('automationLogs', fn ($logs) => $logs->where('automation_id', $automation->id))
            ->get();
    }
}

The action class is also rather simple:

class SendMailableAction extends \Scheel\Automation\AutomationAction
{
    protected function executeAction(): bool
    {
        $params = $this->log->automation->action_params;
        $mailable_class = $params->get('mailable');
        $recipient = $this->log->automatable;
        $mailable_params = [];
        foreach ($params->get('mailable_params', []) as $mailable_param) {
            $mailable_params[] = data_get($recipient, $mailable_param);
        }
        $mailable = new $mailable_class(...$mailable_params);
        \Mail::to($recipient)->send($mailable);
        return true;
    }
}

Todo

This package is a work in progress, and feedback or pull requests will be appreciated. These are some of the areas that I would like to improve:

• Add more example triggers and actions (with tests).
• Allow using a custom Automation child class (wip).
• Add more documentation.

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Morten Scheel
• All Contributors

License

The MIT License (MIT). Please see License File for more information.