Merge pull request #16 from guywithnose/master

Add CACHE_MODE_REFRESH

Author: raybot

.gitignore

@@ -1,2 +1,3 @@
 /vendor/
 /coverage/
+/clover.xml

src/Client.php

@@ -38,6 +38,13 @@ final class Client
      */
     const CACHE_MODE_ALL = 3;
 
+    /**
+     * Flag to refresh cache on ALL requests
+     *
+     * @const int
+     */
+    const CACHE_MODE_REFRESH = 4;
+
     /**
      * Base url of the API server
      *
@@ -129,7 +136,11 @@ public function __construct(
         Util::throwIfNotType(['string' => [$accessToken, $refreshToken]], true, true);
         Util::ensure(
             true,
-            in_array($cacheMode, [self::CACHE_MODE_NONE, self::CACHE_MODE_GET, self::CACHE_MODE_TOKEN, self::CACHE_MODE_ALL], true),
+            in_array(
+                $cacheMode,
+                [self::CACHE_MODE_NONE, self::CACHE_MODE_GET, self::CACHE_MODE_TOKEN, self::CACHE_MODE_ALL, self::CACHE_MODE_REFRESH],
+                true
+            ),
             '\InvalidArgumentException',
             ['$cacheMode must be a valid cache mode constant']
         );
@@ -304,7 +315,7 @@ public function end($handle)
             $response = $this->_adapter->end($this->_adapter->start($request));
         }
 
-        if ($this->_cacheMode & self::CACHE_MODE_GET && $request->getMethod() === 'GET') {
+        if (($this->_cacheMode === self::CACHE_MODE_REFRESH || $this->_cacheMode & self::CACHE_MODE_GET) && $request->getMethod() === 'GET') {
             $this->_cache->set($request, $response);
         }
 
@@ -363,7 +374,7 @@ private function _refreshAccessToken()
 
         list($this->_accessToken, $this->_refreshToken, $expires) = Authentication::parseTokenResponse($response);
 
-        if ($this->_cacheMode & self::CACHE_MODE_TOKEN) {
+        if ($this->_cache === self::CACHE_MODE_REFRESH || $this->_cacheMode & self::CACHE_MODE_TOKEN) {
             $this->_cache->set($request, $response, $expires);
         }
     }

tests/ClientTest.php

@@ -496,6 +496,34 @@ public function get_fromCache()
         $this->assertEquals($expected, $actual);
     }
 
+    /**
+     * @test
+     * @covers ::__construct
+     * @covers ::end
+     * @covers ::startGet
+     */
+    public function get_disabledCache()
+    {
+        $cache = new ArrayCache();
+        $request = new Request('baseUrl/a+url/id', 'not under test');
+        $unexpected = new Response(200, ['key' => ['value']], ['doesnt' => 'matter']);
+        $expected = new Response(200, ['Content-Type' => ['application/json']], []);
+        $cache->set($request, $unexpected);
+        $authentication = Authentication::createClientCredentials('not under test', 'not under test');
+        $adapter = $this->getMockBuilder('\DominionEnterprises\Api\Adapter')->setMethods(['start', 'end'])->getMock();
+        $adapter->expects($this->once())->method('start');
+        $adapter->expects($this->once())->method('end')->will(
+            $this->returnValue(new Response(200, ['Content-Type' => ['application/json']], []))
+        );
+        $client = new Client($adapter, $authentication, 'baseUrl', Client::CACHE_MODE_REFRESH, $cache, 'foo');
+        $actual = $client->end($client->startGet('a url', 'id'));
+        $this->assertEquals($expected, $actual);
+        $this->assertEquals($expected, $cache->get($request));
+        $client = new Client(new TokenAdapter(), $authentication, 'baseUrl', Client::CACHE_MODE_GET, $cache);
+        $actual = $client->end($client->startGet('a url', 'id'));
+        $this->assertEquals($expected, $actual);
+    }
+
     /**
      * @test
      * @covers ::__construct

tests/Dockerfile

@@ -2,7 +2,7 @@ FROM nubs/phpunit
 
 USER root
 
-RUN pacman --sync --refresh --noconfirm --noprogressbar --quiet && pacman --sync --noconfirm --noprogressbar --quiet php-mongo
+RUN pacman-key --populate archlinux && pacman-key --refresh-keys && pacman --sync --refresh --noconfirm --noprogressbar --quiet && pacman --sync --refresh --sysupgrade --noconfirm --noprogressbar --quiet && pacman-db-upgrade && pacman --sync --noconfirm --noprogressbar --quiet php-mongo
 
 USER build