✨ Introduce Webhook Handling

README.md

@@ -379,9 +379,89 @@ if ($game) {
 If you used the Query Builder itself you must check if a property exists
 yourself.
 
+## ✨ Webhooks (since v2.3.0)
+
+Since version 2.3.0 of this package you can create webhooks and handle their requests with ease. 🎉
+
+### Initial setup
+
+#### Configuration
+
+Inside your `config/igdb.php` file you need to have a `webhook_secret` of your choice like so (you only need to create this if you upgraded from a prior version of this package. New installations have this configured automatically):
+
+```php
+return [
+    // ...
+    // Other configs
+    // ...
+
+    'webhook_secret' => env('IGDB_WEBHOOK_SECRET', null)
+];
+```
+
+And then set a secret inside your `.env` file:
+
+```dotenv
+IGDB_WEBHOOK_SECRET=yoursecret
+```
+
+#### Routing
+
+Create a POST route where you want to handle the incoming webhook requests and simply call `Webhook::handle($request)`:
+
+```php
+use Illuminate\Http\Request;
+use MarcReichel\IGDBLaravel\Models\Webhook;
+
+Route::post('webhook/handle', function (Request $request) {
+    return Webhook::handle($request);
+})->name('handle-webhook');
+```
+
+That's it!
+
+### Creating a webhook
+
+Let's say we want to be informed whenever a new game is created on https://igdb.com.
+
+First of all we need to inform IGDB that we want to be informed.
+
+For this we create a webhook like so:
+
+```php
+use MarcReichel\IGDBLaravel\Models\Game;
+
+Game::createWebhook(route('handle-webhook'), 'create');
+```
+
+The first parameter describes the route where we want to handle the webhook.
+The second parameter needs to be one of `create`, `update` or `delete` according to
+which event we want to listen for.
+
+### Listen for events
+
+Now that we have created our webhook we can listen for a specific event - in our case
+when a game is created.
+
+For this we create a Laravel EventListener or for sake of simplicity we just listen for an event
+inside the `boot()` method of our `app/providers/EventServiceProvider.php`:
+
+```php
+use MarcReichel\IGDBLaravel\Events\GameCreated;
+use Illuminate\Support\Facades\Event;
+
+public function boot()
+{
+    Event::listen(function (GameCreated $event) {
+        // $event->game holds the game data
+    });
+}
+```
+
+Further information on how to set up event listeners can be found on the [official docs](https://laravel.com/docs/events).
+
 ## TODO List
 
-- Refactor code (beautify code)
 - Write unit tests
 
 ## Contribution

config/config.php

@@ -16,4 +16,12 @@
      * To turn cache off set this value to 0
      */
     'cache_lifetime' => env('IGDB_CACHE_LIFETIME', 3600),
+
+    /*
+     * Default 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),
 ];

src/ApiHelper.php

@@ -9,6 +9,8 @@
 
 class ApiHelper
 {
+    public const IGDB_BASE_URI = 'https://api.igdb.com/v4/';
+
     /**
      * Retrieves an Access Token from Twitch.
      *

src/Builder.php

@@ -155,7 +155,7 @@ protected function init(): void
     private function initClient(): void
     {
         $this->client = new Client([
-            'base_uri' => 'https://api.igdb.com/v4/',
+            'base_uri' => ApiHelper::IGDB_BASE_URI,
             'headers' => [
                 'Accept' => 'application/json',
                 'Client-ID' => config('igdb.credentials.client_id'),

src/Enums/Webhook/Method.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace MarcReichel\IGDBLaravel\Enums\Webhook;
+
+class Method
+{
+    public const CREATE = 'create';
+    public const DELETE = 'delete';
+    public const UPDATE = 'update';
+}

src/Events/AgeRatingContentDescriptionCreated.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace MarcReichel\IGDBLaravel\Events;
+
+use Illuminate\Broadcasting\InteractsWithSockets;
+use Illuminate\Foundation\Events\Dispatchable;
+use Illuminate\Queue\SerializesModels;
+use MarcReichel\IGDBLaravel\Models\AgeRatingContentDescription;
+
+class AgeRatingContentDescriptionCreated
+{
+    use Dispatchable, InteractsWithSockets, SerializesModels;
+
+    /**
+     * @var AgeRatingContentDescription
+     */
+    public $ageRatingContentDescription;
+
+    /**
+     * @param AgeRatingContentDescription $ageRatingContentDescription
+     * @return void
+     */
+    public function __construct(AgeRatingContentDescription $ageRatingContentDescription)
+    {
+        $this->ageRatingContentDescription = $ageRatingContentDescription;
+    }
+}

src/Events/AgeRatingContentDescriptionDeleted.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace MarcReichel\IGDBLaravel\Events;
+
+class AgeRatingContentDescriptionDeleted extends AgeRatingContentDescriptionCreated
+{
+    //
+}

src/Events/AgeRatingContentDescriptionUpdated.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace MarcReichel\IGDBLaravel\Events;
+
+class AgeRatingContentDescriptionUpdated extends AgeRatingContentDescriptionCreated
+{
+    //
+}

src/Events/AgeRatingCreated.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace MarcReichel\IGDBLaravel\Events;
+
+use Illuminate\Broadcasting\InteractsWithSockets;
+use Illuminate\Foundation\Events\Dispatchable;
+use Illuminate\Queue\SerializesModels;
+use MarcReichel\IGDBLaravel\Models\AgeRating;
+
+class AgeRatingCreated
+{
+    use Dispatchable, InteractsWithSockets, SerializesModels;
+
+    /**
+     * @var AgeRating
+     */
+    public $ageRating;
+
+    /**
+     * @param AgeRating $ageRating
+     * @return void
+     */
+    public function __construct(AgeRating $ageRating)
+    {
+        $this->ageRating = $ageRating;
+    }
+}

src/Events/AgeRatingDeleted.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace MarcReichel\IGDBLaravel\Events;
+
+class AgeRatingDeleted extends AgeRatingCreated
+{
+    //
+}

src/Events/AgeRatingUpdated.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace MarcReichel\IGDBLaravel\Events;
+
+class AgeRatingUpdated extends AgeRatingCreated
+{
+    //
+}

src/Events/AlternativeNameCreated.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace MarcReichel\IGDBLaravel\Events;
+
+use Illuminate\Broadcasting\InteractsWithSockets;
+use Illuminate\Foundation\Events\Dispatchable;
+use Illuminate\Queue\SerializesModels;
+use MarcReichel\IGDBLaravel\Models\AlternativeName;
+
+class AlternativeNameCreated
+{
+    use Dispatchable, InteractsWithSockets, SerializesModels;
+
+    /**
+     * @var AlternativeName
+     */
+    public $alternativeName;
+
+    /**
+     * @param AlternativeName $alternativeName
+     * @return void
+     */
+    public function __construct(AlternativeName $alternativeName)
+    {
+        $this->alternativeName = $alternativeName;
+    }
+}

src/Events/AlternativeNameDeleted.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace MarcReichel\IGDBLaravel\Events;
+
+class AlternativeNameDeleted extends AlternativeNameCreated
+{
+    //
+}

src/Events/AlternativeNameUpdated.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace MarcReichel\IGDBLaravel\Events;
+
+class AlternativeNameUpdated extends AlternativeNameCreated
+{
+    //
+}

src/Events/ArtworkCreated.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace MarcReichel\IGDBLaravel\Events;
+
+use Illuminate\Broadcasting\InteractsWithSockets;
+use Illuminate\Foundation\Events\Dispatchable;
+use Illuminate\Queue\SerializesModels;
+use MarcReichel\IGDBLaravel\Models\Artwork;
+
+class ArtworkCreated
+{
+    use Dispatchable, InteractsWithSockets, SerializesModels;
+
+    /**
+     * @var Artwork
+     */
+    public $artwork;
+
+    /**
+     * @param Artwork $artwork
+     * @return void
+     */
+    public function __construct(Artwork $artwork)
+    {
+        $this->artwork = $artwork;
+    }
+}

src/Events/ArtworkDeleted.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace MarcReichel\IGDBLaravel\Events;
+
+class ArtworkDeleted extends ArtworkCreated
+{
+    //
+}

src/Events/ArtworkUpdated.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace MarcReichel\IGDBLaravel\Events;
+
+class ArtworkUpdated extends ArtworkCreated
+{
+    //
+}

src/Events/CharacterCreated.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace MarcReichel\IGDBLaravel\Events;
+
+use Illuminate\Broadcasting\InteractsWithSockets;
+use Illuminate\Foundation\Events\Dispatchable;
+use Illuminate\Queue\SerializesModels;
+use MarcReichel\IGDBLaravel\Models\Character;
+
+class CharacterCreated
+{
+    use Dispatchable, InteractsWithSockets, SerializesModels;
+
+    /**
+     * @var Character
+     */
+    public $character;
+
+    /**
+     * @param Character $character
+     * @return void
+     */
+    public function __construct(Character $character)
+    {
+        $this->character = $character;
+    }
+}

src/Events/CharacterDeleted.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace MarcReichel\IGDBLaravel\Events;
+
+class CharacterDeleted extends CharacterCreated
+{
+    //
+}

src/Events/CharacterMugShotCreated.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace MarcReichel\IGDBLaravel\Events;
+
+use Illuminate\Broadcasting\InteractsWithSockets;
+use Illuminate\Foundation\Events\Dispatchable;
+use Illuminate\Queue\SerializesModels;
+use MarcReichel\IGDBLaravel\Models\CharacterMugShot;
+
+class CharacterMugShotCreated
+{
+    use Dispatchable, InteractsWithSockets, SerializesModels;
+
+    /**
+     * @var CharacterMugShot
+     */
+    public $characterMugShot;
+
+    /**
+     * @param CharacterMugShot $characterMugShot
+     * @return void
+     */
+    public function __construct(CharacterMugShot $characterMugShot)
+    {
+        $this->characterMugShot = $characterMugShot;
+    }
+}

src/Events/CharacterMugShotUpdated.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace MarcReichel\IGDBLaravel\Events;
+
+class CharacterMugShotUpdated extends CharacterMugShotCreated
+{
+    //
+}

src/Events/CharacterUpdated.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace MarcReichel\IGDBLaravel\Events;
+
+class CharacterUpdated extends CharacterCreated
+{
+    //
+}