Merge pull request #21 from scottcharlesworth/v4-update

IGDB API Version 4

config/config.php

@@ -2,9 +2,12 @@
 
 return [
     /*
-     * This is the API Token you got from https://api.igdb.com
+     * These are the credentials you got from https://dev.twitch.tv/console/apps
      */
-    'api_token' => env('IGDB_TOKEN', ''),
+    'credentials' => [
+        'client_id' => env('TWITCH_CLIENT_ID', ''),
+        'client_secret' => env('TWITCH_CLIENT_SECRET', ''),
+    ],
 
     /*
      * This package caches queries automatically (for 1 hour per default).
@@ -18,9 +21,4 @@
      * This is the per-page limit for your tier.
      */
     'per_page_limit' => 500,
-
-    /*
-     * This is the offset limit for your tier.
-     */
-    'offset_limit' => 5000,
 ];

readme.md

@@ -67,8 +67,6 @@ $games = Game::where('first_release_date', '>=', 1546297200)->get();
 
 Here's a list of all available Models:
 
-- Achievement
-- AchievementIcon
 - AgeRating
 - AgeRatingContentDescription
 - AlternativeName
@@ -81,7 +79,6 @@ Here's a list of all available Models:
 - CompanyWebsite
 - Cover
 - ExternalGame
-- Feed
 - Franchise
 - Game
 - GameEngine
@@ -95,28 +92,18 @@ Here's a list of all available Models:
 - InvolvedCompany
 - Keyword
 - MultiplayerMode
-- Page
-- PageBackground
-- PageLogo
-- PageWebsite
 - Platform
+- PlatformFamily
 - PlatformLogo
 - PlatformVersion
 - PlatformVersionCompany
 - PlatformVersionReleaseDate
 - PlatformWebsite
 - PlayerPerspective
-- ProductFamily
-- Pulse
-- PulseGroup
-- PulseSource
-- PulseUrl
 - ReleaseDate
 - Screenshot
 - Search
 - Theme
-- TimeToBeat
-- Title
 - Website
 
 ### Query Builder

src/Builder.php

@@ -6,6 +6,7 @@
 use Closure;
 use GuzzleHttp\Client;
 use GuzzleHttp\Exception\ClientException;
+use GuzzleHttp\Exception\GuzzleException;
 use GuzzleHttp\Exception\ServerException;
 use Illuminate\Http\Response;
 use Illuminate\Pagination\Paginator;
@@ -14,6 +15,7 @@
 use Illuminate\Support\Arr;
 use Illuminate\Support\Str;
 use InvalidArgumentException;
+use MarcReichel\IGDBLaravel\Exceptions\AuthenticationException;
 use MarcReichel\IGDBLaravel\Exceptions\MissingEndpointException;
 use MarcReichel\IGDBLaravel\Exceptions\ModelNotFoundException;
 use MarcReichel\IGDBLaravel\Exceptions\ServiceException;
@@ -143,10 +145,10 @@ protected function init(): void
     private function initClient(): void
     {
         $this->client = new Client([
-            'base_uri' => 'https://api-v3.igdb.com/',
+            'base_uri' => 'https://api.igdb.com/v4/',
             'headers' => [
-                'user-key' => config('igdb.api_token'),
-                'User-Agent' => 'IGDB-Laravel-Wrapper/0.1-Dev',
+                'Accept' => 'application/json',
+                'Client-ID' => config('igdb.credentials.client_id'),
             ],
         ]);
     }
@@ -169,6 +171,43 @@ protected function resetCacheLifetime(): void
         $this->cacheLifetime = config('igdb.cache_lifetime');
     }
 
+    /**
+     * Retrieves an Access Token from Twitch.
+     *
+     * @return string
+     * @throws AuthenticationException
+     */
+    protected function retrieveAccessToken(): string
+    {
+        $accessTokenCacheKey = 'igdb_cache.access_token';
+
+        if ($accessToken = Cache::get($accessTokenCacheKey, false)) {
+            return $accessToken;
+        }
+
+        try {
+            $guzzleClient = new Client();
+            $response = $guzzleClient->post(
+                'https://id.twitch.tv/oauth2/token?'
+                .'client_id='.config('igdb.credentials.client_id')
+                .'&client_secret='.config('igdb.credentials.client_secret')
+                .'&grant_type=client_credentials'
+            )->getBody();
+        } catch (GuzzleException $exception) {
+            $response = '';
+        }
+
+        $response = json_decode($response, true);
+
+        if (isset($response['access_token']) && $response['expires_in']) {
+            Cache::put($accessTokenCacheKey, (string) $response['access_token'], (int) $response['expires_in']);
+
+            return (string) $response['access_token'];
+        } else {
+            throw new AuthenticationException('Access Token could not be retrieved from Twitch.');
+        }
+    }
+
     /**
      * Set the "limit" value of the query.
      *
@@ -205,13 +244,7 @@ public function take(int $limit): self
      */
     public function offset(int $offset): self
     {
-        $tierMaximum = max(0, config('igdb.offset_limit', 150));
-        if ($tierMaximum === 0) {
-            $this->query->put('offset', $offset);
-        } else {
-            $offset = min($offset, config('igdb.offset_limit', 150));
-            $this->query->put('offset', $offset);
-        }
+        $this->query->put('offset', $offset);
 
         return $this;
     }
@@ -1323,7 +1356,7 @@ protected function getQuery()
     public function endpoint(string $endpoint)
     {
         if ($this->class === null) {
-            $this->endpoint = Str::start($endpoint, '/');
+            $this->endpoint = $endpoint;
         }
 
         return $this;
@@ -1356,8 +1389,7 @@ protected function setEndpoint($model)
 
                     $class = class_basename($this->class);
 
-                    $this->endpoint = ($model->privateEndpoint ? '/private' : '') . Str::start(Str::snake(Str::plural($class)),
-                            '/');
+                    $this->endpoint = Str::snake(Str::plural($class));
                 }
             } catch (\ReflectionException $e) {
             }
@@ -1392,10 +1424,12 @@ private function castDate($date)
      * Execute the query.
      *
      * @return mixed|string
-     * @throws \MarcReichel\IGDBLaravel\Exceptions\MissingEndpointException
+     * @throws \MarcReichel\IGDBLaravel\Exceptions\MissingEndpointException|AuthenticationException
      */
     public function get()
     {
+        $accessToken = $this->retrieveAccessToken();
+
         if ($this->endpoint) {
 
             $cacheKey = 'igdb_cache.' . md5($this->endpoint . $this->getQuery());
@@ -1405,10 +1439,13 @@ public function get()
             }
 
             $data = Cache::remember($cacheKey, $this->cacheLifetime,
-                function () {
+                function () use ($accessToken) {
                     try {
-                        return collect(json_decode($this->client->get($this->endpoint,
+                        return collect(json_decode($this->client->post($this->endpoint,
                             [
+                                'headers' => [
+                                    'Authorization' => 'Bearer '.$accessToken,
+                                ],
                                 'body' => $this->getQuery(),
                             ])->getBody()));
                     } catch (\Exception $exception) {

src/Exceptions/AuthenticationException.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace MarcReichel\IGDBLaravel\Exceptions;
+
+use Exception;
+
+class AuthenticationException extends Exception
+{
+}

src/Models/Model.php

@@ -19,7 +19,6 @@ class Model implements ArrayAccess, Arrayable, Jsonable
         HasRelationships;
 
     public $identifier;
-    public $privateEndpoint = false;
 
     protected $endpoint;
     public $builder;
@@ -321,8 +320,7 @@ protected function setEndpoint()
         if (!$this->endpoint) {
             $class = class_basename(get_class($this));
 
-            $this->endpoint = ($this->privateEndpoint ? '/private' : '') .
-                Str::start(Str::snake(Str::plural($class)), '/');
+            $this->endpoint = Str::snake(Str::plural($class));
         }
     }