README

This Laravel package provides a class-based framework for multi-source data aggregation and assimilation to Eloquent models.

Installation

You can install the package via composer:

composer require nihilsen/seeker

You run the migrations with:

php artisan migrate

You can publish the config file with:

php artisan vendor:publish --tag="seeker-config"

This is the contents of the published config file:

<?php

return [

    /*
    |--------------------------------------------------------------------------
    | Endpoints
    |--------------------------------------------------------------------------
    |
    | Endpoint classes may be listed here as an array to control which should
    | be loaded.
    |
    | Alternatively, if set to null, we will attempt auto-loading from the
    | configured endpoints namespace (see below).
    |
    */

    'endpoints' => null,

    /*
    |--------------------------------------------------------------------------
    | Namespace
    |--------------------------------------------------------------------------
    |
    | Set the namespace to associate with endpoint classes.
    |
    */

    'namespace' => \App\Seeker\Endpoints::class,

    /*
    |--------------------------------------------------------------------------
    | Rate limiting
    |--------------------------------------------------------------------------
    |
    | Set the rate limiting middleware to use for Seek jobs.
    |
    | May be set to false or null to disable queue-level rate limiting.
    |
    | For optimized rate limiting using Redis, consider using
    | "Illuminate\Queue\Middleware\RateLimitedWithRedis::class",
    | as per <https://laravel.com/docs/9.x/queues#rate-limiting>
    |
    */

    'rate_limiter' => Illuminate\Queue\Middleware\RateLimited::class,

];

Testing

composer test

Changelog

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

Contributing

Please see CONTRIBUTING for details.

Credits

License

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

nihilsen / seeker

Maintainers

Details