CachedClient: added option to forbid Github rechecking [Closes #6]

When enabled and response exists in cache, it is returned as is without rechecking Github for actual data. So there is no HTTP request and HTTP response.

This is handy during development.

Author: milo

src/Github/Http/CachedClient.php

@@ -19,14 +19,23 @@ class CachedClient extends Github\Sanity implements IClient
 	/** @var IClient */
 	private $client;
 
+	/** @var bool */
+	private $forbidRecheck;
+
 	/** @var callable|NULL */
 	private $onResponse;
 
 
-	public function __construct(Storages\ICache $cache, IClient $client = NULL)
+	/**
+	 * @param Storages\ICache
+	 * @param IClient
+	 * @param bool  forbid checking Github for new data; more or less development purpose only
+	 */
+	public function __construct(Storages\ICache $cache, IClient $client = NULL, $forbidRecheck = FALSE)
 	{
 		$this->cache = $cache;
 		$this->client = $client ?: Github\Helpers::createDefaultClient();
+		$this->forbidRecheck = (bool) $forbidRecheck;
 	}
 
 
@@ -59,6 +68,12 @@ public function request(Request $request)
 		]);
 
 		if ($cached = $this->cache->load($cacheKey)) {
+			if ($this->forbidRecheck) {
+				$cached = clone $cached;
+				$this->onResponse && call_user_func($this->onResponse, $cached);
+				return $cached;
+			}
+
 			/** @var $cached Response */
 			if ($cached->hasHeader('ETag')) {
 				$request->addHeader('If-None-Match', $cached->getHeader('ETag'));

tests/Github/Http/CachedClient.phpt

@@ -47,7 +47,7 @@ class CachingTestCase extends Tester\TestCase
 	{
 		$cache = new MockCache;
 		$this->innerClient = new MockClient;
-		$this->client = new \Milo\Github\Http\CachedClient($cache, $this->innerClient);
+		$this->client = new Milo\Github\Http\CachedClient($cache, $this->innerClient);
 	}
 
 
@@ -190,6 +190,70 @@ class CachingTestCase extends Tester\TestCase
 		Assert::same('inner-304', $response->getPrevious()->getContent());
 	}
 
+
+	public function testForbidRecheckDisabled()
+	{
+		$client = new Milo\Github\Http\CachedClient(new MockCache, $this->innerClient);
+
+		$count = 0;
+		$this->innerClient->onRequest = function (Milo\Github\Http\Request $request) use (& $count) {
+			$count++;
+			return $request->hasHeader('If-None-Match')
+				? new Milo\Github\Http\Response(304, [], 'inner-304')
+				: new Milo\Github\Http\Response(200, ['ETag' => '"test"'], 'inner-200');
+		};
+
+		$request = new Milo\Github\Http\Request('', '');
+
+		$response = $client->request($request);
+		Assert::same(1, $count);
+		Assert::same('inner-200', $response->getContent());
+		Assert::null($response->getPrevious());
+
+		$response = $client->request($request);
+		Assert::same(2, $count);
+		Assert::same('inner-200', $response->getContent());
+		Assert::type('Milo\Github\Http\Response', $response->getPrevious());
+		Assert::same('inner-304', $response->getPrevious()->getContent());
+
+		$response = $client->request($request);
+		Assert::same(3, $count);
+		Assert::same('inner-200', $response->getContent());
+		Assert::type('Milo\Github\Http\Response', $response->getPrevious());
+		Assert::same('inner-304', $response->getPrevious()->getContent());
+	}
+
+
+	public function testForbidRecheckEnabled()
+	{
+		$client = new Milo\Github\Http\CachedClient(new MockCache, $this->innerClient, TRUE);
+
+		$count = 0;
+		$this->innerClient->onRequest = function (Milo\Github\Http\Request $request) use (& $count) {
+			$count++;
+			return $request->hasHeader('If-None-Match')
+				? new Milo\Github\Http\Response(304, [], 'inner-304')
+				: new Milo\Github\Http\Response(200, ['ETag' => '"test"'], 'inner-200');
+		};
+
+		$request = new Milo\Github\Http\Request('', '');
+
+		$response = $client->request($request);
+		Assert::same(1, $count);
+		Assert::same('inner-200', $response->getContent());
+		Assert::null($response->getPrevious());
+
+		$response = $client->request($request);
+		Assert::same(1, $count);
+		Assert::same('inner-200', $response->getContent());
+		Assert::null($response->getPrevious());
+
+		$response = $client->request($request);
+		Assert::same(1, $count);
+		Assert::same('inner-200', $response->getContent());
+		Assert::null($response->getPrevious());
+	}
+
 }
 
 (new CachingTestCase)->run();