feat(Cache): support PSR-16 cache implementations

Closes #297

Author: Jens Schulze

composer.json

@@ -30,6 +30,7 @@
     "guzzlehttp/guzzle": "^6.0 || ^5.0",
     "guzzlehttp/psr7": "^1.1",
     "psr/cache": "^1.0",
+    "psr/simple-cache": "^1.0",
     "cache/apcu-adapter": "^0.2",
     "ext-intl": "*",
     "ext-mbstring": "*"

src/Cache/CacheAdapterFactory.php

@@ -16,6 +16,7 @@
 use League\Flysystem\Adapter\Local;
 use League\Flysystem\Filesystem;
 use Psr\Cache\CacheItemPoolInterface;
+use Psr\SimpleCache\CacheInterface;
 
 /**
  * @package Commercetools\Core\Cache
@@ -70,7 +71,7 @@ public function registerCallback(callable $callback)
      * returns the cache adapter interface for the application cache
      *
      * @param $cache
-     * @return CacheItemPoolInterface
+     * @return CacheItemPoolInterface|CacheInterface
      * @throws \InvalidArgumentException
      */
     public function get($cache = null)
@@ -82,12 +83,18 @@ public function get($cache = null)
         if ($cache instanceof CacheItemPoolInterface) {
             return $cache;
         }
+        if ($cache instanceof CacheInterface) {
+            return $cache;
+        }
 
         foreach ($this->callbacks as $callBack) {
             $result = call_user_func($callBack, $cache);
             if ($result instanceof CacheItemPoolInterface) {
                 return $result;
             }
+            if ($result instanceof CacheInterface) {
+                return $result;
+            }
         }
 
         throw new InvalidArgumentException(Message::INVALID_CACHE_ADAPTER);

src/Client/OAuth/Manager.php

@@ -12,8 +12,8 @@
 use Psr\Http\Message\ResponseInterface;
 use Commercetools\Core\AbstractHttpClient;
 use Commercetools\Core\Cache\CacheAdapterFactory;
-use Commercetools\Core\Cache\CacheAdapterInterface;
 use Commercetools\Core\Error\InvalidClientCredentialsException;
+use Psr\SimpleCache\CacheInterface;
 
 /**
  * @package Commercetools\Core\OAuth
@@ -37,7 +37,7 @@ class Manager extends AbstractHttpClient
     protected $cacheKeys;
 
     /**
-     * @var CacheAdapterInterface|CacheItemPoolInterface
+     * @var CacheItemPoolInterface|CacheInterface
      */
     protected $cacheAdapter;
 
@@ -77,9 +77,9 @@ public function setCacheAdapter($cache)
 
     /**
      * @internal will become protected in version 2.0
-     * @return CacheAdapterInterface|CacheItemPoolInterface
+     * @return CacheItemPoolInterface|CacheInterface
      */
-    public function getCacheAdapter()
+    protected function getCacheAdapter()
     {
         return $this->cacheAdapter;
     }
@@ -151,27 +151,27 @@ protected function cache(Token $token, $ttl, $cacheKey = null)
             $cacheKey = $this->getCacheKey();
         }
         $cache = $this->getCacheAdapter();
-        if ($cache instanceof CacheAdapterInterface) {
-            $cache->store($cacheKey, $token->getToken(), (int)$ttl);
-        }
         if ($cache instanceof CacheItemPoolInterface) {
             $item = $cache->getItem($cacheKey)->set($token->getToken())->expiresAfter((int)$ttl);
             $cache->save($item);
         }
+        if ($cache instanceof CacheInterface) {
+            $cache->set($cacheKey, $token->getToken(), (int)$ttl);
+        }
     }
 
     protected function getCacheToken()
     {
         $cache = $this->getCacheAdapter();
-        if ($cache instanceof CacheAdapterInterface) {
-            return $cache->fetch($this->getCacheKey());
-        }
         if ($cache instanceof CacheItemPoolInterface) {
             $item = $cache->getItem($this->getCacheKey());
             if ($item->isHit()) {
                 return $item->get();
             }
         }
+        if ($cache instanceof CacheInterface) {
+            return $cache->get($this->getCacheKey(), false);
+        }
 
         return false;
     }

tests/integration/Errors/ErrorResponseTest.php

@@ -8,6 +8,7 @@
 
 use Cache\Adapter\Common\CacheItem;
 use Commercetools\Core\ApiTestCase;
+use Commercetools\Core\Cache\CacheAdapterFactory;
 use Commercetools\Core\Cache\CacheAdapterInterface;
 use Commercetools\Core\Client\OAuth\Manager;
 use Commercetools\Core\Error\AccessDeniedError;
@@ -613,16 +614,12 @@ public function testInsufficientScope()
 
     public function testInvalidToken()
     {
+        $factory = new CacheAdapterFactory();
+        $cacheAdapter = $factory->get();
         $client = $this->getClient('manage_project');
         $cacheScope = $client->getConfig()->getScope() . '-' . $client->getConfig()->getGrantType();
         $cacheKey = Manager::TOKEN_CACHE_KEY . '_' . sha1($cacheScope);
-        $cacheAdapter = $client->getOauthManager()->getCacheAdapter();
-        if ($cacheAdapter instanceof CacheAdapterInterface) {
-            $cacheAdapter->store($cacheKey, '1234');
-        }
-        if ($cacheAdapter instanceof CacheItemPoolInterface) {
-            $cacheAdapter->save(new CacheItem($cacheKey, true, '1234'));
-        }
+        $cacheAdapter->save(new CacheItem($cacheKey, true, '1234'));
 
         $request = ProductQueryRequest::of();
         $client->addBatchRequest($request);

tests/unit/Cache/CacheAdapterFactoryTest.php

@@ -11,6 +11,7 @@
 use Cache\Adapter\PHPArray\ArrayCachePool;
 use Cache\Adapter\Redis\RedisCachePool;
 use Doctrine\Common\Cache\ArrayCache;
+use Psr\SimpleCache\CacheInterface;
 
 class CacheAdapterFactoryTest extends \PHPUnit_Framework_TestCase
 {
@@ -72,6 +73,15 @@ public function testPsrCache()
         $this->assertInstanceOf(ArrayCachePool::class, $adapter);
     }
 
+    public function testSimpleCache()
+    {
+        $cache = $this->prophesize(CacheInterface::class);
+        $factory = $this->getFactory();
+        $adapter = $factory->get($cache->reveal());
+
+        $this->assertInstanceOf(CacheInterface::class, $adapter);
+    }
+
     /**
      * test correct type handling
      *

tests/unit/Client/OAuth/ManagerTest.php

@@ -8,6 +8,7 @@
 
 use Cache\Adapter\PHPArray\ArrayCachePool;
 use Cache\Adapter\Void\VoidCachePool;
+use Commercetools\Core\Cache\CacheAdapterFactory;
 use GuzzleHttp\Client as HttpClient;
 use GuzzleHttp\Handler\MockHandler;
 use GuzzleHttp\HandlerStack;
@@ -16,6 +17,8 @@
 use GuzzleHttp\Subscriber\Mock;
 use Commercetools\Core\Cache\NullCacheAdapter;
 use Commercetools\Core\Config;
+use Prophecy\Argument;
+use Psr\SimpleCache\CacheInterface;
 
 class ManagerTest extends \PHPUnit_Framework_TestCase
 {
@@ -191,31 +194,44 @@ public function testCache()
         $this->assertEmpty($manager->getToken()->getTtl()); // ttl should be empty as token comes from cache
     }
 
-    public function testCacheAdapter()
+    public function testPsrCacheAdapter()
     {
         $cache1 = new VoidCachePool();
         $manager = new Manager($this->getConfig(), $cache1);
 
-        $cache2 = new VoidCachePool();
+        $cache2 = new ArrayCachePool();
         $this->assertInstanceOf(Manager::class, $manager->setCacheAdapter($cache2));
-        $this->assertSame($cache2, $manager->getCacheAdapter());
     }
 
-    public function testPsrCacheAdapter()
+    public function testPsrSimpleCacheAdapter()
     {
-        if (version_compare(phpversion(), '5.5.0', '<')) {
-            $this->markTestSkipped(
-                'PHP >= 5.5 needed to run this test'
-            );
-        }
-        $cache1 = new VoidCachePool();
-        $manager = new Manager($this->getConfig(), $cache1);
+        $cache = $this->prophesize(CacheInterface::class);
+        $cache->get(Argument::type('string'), false)->willReturn('test')->shouldBeCalled();
+        $manager = new Manager($this->getConfig(), $cache->reveal());
 
-        $cache2 = new ArrayCachePool();
-        $this->assertInstanceOf(Manager::class, $manager->setCacheAdapter($cache2));
-        $this->assertSame($cache2, $manager->getCacheAdapter());
+        $this->assertSame('test', $manager->getToken()->getToken());
+    }
+
+    public function testSetPsrSimpleCacheAdapter()
+    {
+        $cache = $this->prophesize(CacheInterface::class);
+        $cache->get(Argument::type('string'), false)->willReturn(false)->shouldBeCalled();
+        $cache->set(Argument::type('string'), 'myToken', 500)->shouldBeCalled();
+
+        $manager = $this->getManager(
+            $this->getConfig(),
+            [
+                "access_token" => "myToken",
+                "token_type" => "Bearer",
+                "expires_in" => 1000,
+                "scope" => "manage_project:testCache"
+            ]
+        );
+        $manager->setCacheAdapter($cache->reveal());
+        $this->assertSame('myToken', $manager->getToken()->getToken());
     }
 
+
     /**
      * @expectedException \Commercetools\Core\Error\InvalidClientCredentialsException
      */