Merge pull request #404 from Nyholm/cache

Use PSR6 cache

Author: cursedcoder

README.md

@@ -69,15 +69,20 @@ From `$client` object, you can access to all GitHub.
 // This file is generated by Composer
 require_once 'vendor/autoload.php';
 
+use Cache\Adapter\Redis\RedisCachePool;
+
+$client = new \Redis();
+$client->connect('127.0.0.1', 6379);
+// Create a PSR6 cache pool
+$pool = new RedisCachePool($client);
+
 $client = new \Github\Client();
-$client->useCache();
-
-// Or select directly which cache you want to use
-$client->useCache(
-    // Built in one, or any cache implementing this interface:
-    // Github\HttpClient\Cache\CacheInterface
-    new \Github\HttpClient\Cache\FilesystemCache('/tmp/github-api-cache')
-);
+$client->addCache($pool);
+
+// Do some request
+
+// Stop using cache
+$client->removeCache();
 ```
 
 Using cache, the client will get cached responses if resources haven't changed since last time,

composer.json

@@ -17,21 +17,21 @@
         }
     ],
     "require": {
-        "php":             "^5.5|^7.0",
+        "php": "^5.5 || ^7.0",
+        "psr/http-message": "^1.0",
+        "psr/cache": "^1.0",
         "php-http/httplug": "^1.0",
         "php-http/discovery": "^1.0",
         "php-http/client-implementation": "^1.0",
-        "php-http/client-common": "^1.1"
+        "php-http/client-common": "^1.1",
+        "php-http/cache-plugin": "^1.0"
     },
     "require-dev": {
         "phpunit/phpunit": "~4.0",
         "php-http/guzzle6-adapter": "~1.0",
         "guzzlehttp/psr7": "^1.2",
         "sllh/php-cs-fixer-styleci-bridge": "~1.3"
     },
-    "suggest": {
-        "knplabs/gaufrette": "Needed for optional Gaufrette cache"
-    },
     "autoload": {
         "psr-4": { "Github\\": "lib/Github/" }
     },

lib/Github/Client.php

@@ -5,9 +5,7 @@
 use Github\Api\ApiInterface;
 use Github\Exception\InvalidArgumentException;
 use Github\Exception\BadMethodCallException;
-use Github\HttpClient\Cache\CacheInterface;
 use Github\HttpClient\Plugin\Authentication;
-use Github\HttpClient\Plugin\Cache;
 use Github\HttpClient\Plugin\GithubExceptionThrower;
 use Github\HttpClient\Plugin\History;
 use Github\HttpClient\Plugin\PathPrepend;
@@ -19,6 +17,7 @@
 use Http\Discovery\MessageFactoryDiscovery;
 use Http\Discovery\UriFactoryDiscovery;
 use Http\Message\MessageFactory;
+use Psr\Cache\CacheItemPoolInterface;
 
 /**
  * Simple yet very cool PHP GitHub client.
@@ -376,19 +375,21 @@ public function addHeaders(array $headers)
     }
 
     /**
-     * @param bool|CacheInterface $cache
+     * Add a cache plugin to cache responses locally.
+     * @param CacheItemPoolInterface $cache
      */
-    public function useCache($cache = true)
+    public function addCache(CacheItemPoolInterface $cachePool)
     {
-        $this->removePlugin(Cache::class);
-        if ($cache !== false) {
-            if ($cache instanceof CacheInterface) {
-                $plugin = new Cache($cache);
-            } else {
-                $plugin = new Cache();
-            }
-            $this->addPlugin($plugin);
-        }
+        $this->removeCache();
+        $this->addPlugin(new Plugin\CachePlugin($cachePool));
+    }
+
+    /**
+     * Remove the cache plugin
+     */
+    public function removeCache()
+    {
+        $this->removePlugin(Plugin\CachePlugin::class);
     }
 
     /**