marcreichel/igdb-laravel

A Laravel wrapper for version 4 of the IGDB API (Apicalypse) including webhook handling

Fund package maintenance!
marcreichel

3.5.3 2021-11-07 19:58 UTC

README

Packagist Version Packagist Downloads Tests PHPStan CodeFactor codecov License Gitmoji

This is a Laravel wrapper for version 4 of the IGDB API (Apicalypse) including webhook handling since version 2.3.0.

Cover

Basic installation

You can install this package via composer using:

composer require marcreichel/igdb-laravel

The package will automatically register its service provider.

To publish the config file to config/igdb.php run:

php artisan igdb:publish

This is the default content of the config file:

return [
    /*
     * These are the credentials you got from https://dev.twitch.tv/console/apps
     */
    'credentials' => [
        'client_id' => env('TWITCH_CLIENT_ID', ''),
        'client_secret' => env('TWITCH_CLIENT_SECRET', ''),
    ],

    /*
     * This package caches queries automatically (for 1 hour per default).
     * Here you can set how long each query should be cached (in seconds).
     *
     * To turn cache off set this value to 0
     */
    'cache_lifetime' => env('IGDB_CACHE_LIFETIME', 3600),

    /*
     * Path where the webhooks should be handled.
     */
    'webhook_path' => 'igdb-webhook/handle',

    /*
     * The webhook secret.
     *
     * This needs to be a string of your choice in order to use the webhook
     * functionality.
     */
    'webhook_secret' => env('IGDB_WEBHOOK_SECRET', null),
];

Documentation

You will find the full documentation on the dedicated documentation site.

Testing

Run the tests with:

composer test

Roadmap

  • Restructure/Optimize Builder class for better code quality

Contribution

Pull requests are welcome :)