Use the new cache plugin factory method

composer.json

@@ -24,7 +24,7 @@
         "php-http/discovery": "^1.0",
         "php-http/client-implementation": "^1.0",
         "php-http/client-common": "^1.3",
-        "php-http/cache-plugin": "^1.2"
+        "php-http/cache-plugin": "^1.3"
     },
     "require-dev": {
         "phpunit/phpunit": "^4.0 || ^5.5",

doc/README.md

@@ -48,4 +48,5 @@ Additional features:
 * [Request any Route](request_any_route.md)
 * [Customize `php-github-api`](customize.md)
 * [Running and writing tests](testing.md)
+* [Response caching](caching.md)
 * [Request / Response info](request_response_info.md)

doc/caching.md

@@ -0,0 +1,30 @@
+## Response caching
+[Back to the navigation](README.md)
+
+This example uses the PSR6 cache pool [redis-adapter](https://github.com/php-cache/redis-adapter). See http://www.php-cache.com/ for alternatives.
+
+```php
+<?php
+
+// 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->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,
+**without** reaching the `X-Rate-Limit` [imposed by github](http://developer.github.com/v3/#rate-limiting).
+

lib/Github/HttpClient/Builder.php

@@ -176,12 +176,12 @@ public function addHeaderValue($header, $headerValue)
     /**
      * Add a cache plugin to cache responses locally.
      *
-     * @param CacheItemPoolInterface $cache
+     * @param CacheItemPoolInterface $cachePool
      * @param array                  $config
      */
     public function addCache(CacheItemPoolInterface $cachePool, array $config = [])
     {
-        $this->cachePlugin = new Plugin\CachePlugin($cachePool, $this->streamFactory, $config);
+        $this->cachePlugin = Plugin\CachePlugin::clientCache($cachePool, $this->streamFactory, $config);
         $this->httpClientModified = true;
     }