Merge pull request #3 from kirschbaum-development/add-cache

Added the ability to cache bee auth token

Author: luisdalmolin

README.md

@@ -93,6 +93,12 @@ $token->getRefreshToken();
 $token->getExpires();
 ```
 
+Auth tokens are valid for 5 minutes. If you want to cache your tokens for as long as possible, you will need to pass a [PSR-16](https://www.php-fig.org/psr/psr-16/) compatible cache implementation. Laravel, Symfony and all major frameworks are already compatible with this interface. To enable the cache, you only need to call the `setCache` method passing a `Psr\SimpleCache\CacheInterface` implementation.
+
+```php
+$beeAuth->setCache($cacheImplementation);
+```
+
 ## Usage with Laravel
 
 If you use Laravel, `BeePluginServiceProvider` will be auto-registered if you use Laravel package discovery. Otherwise, you can manually register the following provider:
@@ -114,6 +120,8 @@ Client Secret: `config('services.bee.client_secret')`
 
 If you don't want to use this config, you can always pass the values manually.
 
+Laravel service provider will also automatically inject Laravel's cache implementation on `BeeAuth`, so your auth tokens will be cached for as long as possible.
+
 ### Testing
 
 ``` bash

composer.json

@@ -20,6 +20,7 @@
         "guzzlehttp/guzzle": "^6.3"
     },
     "require-dev": {
+        "cache/array-adapter": "^1.0",
         "phpunit/phpunit": "^7.0"
     },
     "autoload": {

src/BeeAuth.php

@@ -2,6 +2,7 @@
 
 namespace KirschbaumDevelopment\Bee;
 
+use Psr\SimpleCache\CacheInterface;
 use GuzzleHttp\Client as GuzzleClient;
 use KirschbaumDevelopment\Bee\Resources\AuthorizationToken;
 
@@ -24,6 +25,13 @@ class BeeAuth
      */
     protected $clientSecret;
 
+    /**
+     * Cache PSR compatible.
+     *
+     * @var \Psr\SimpleCache\CacheInterface
+     */
+    protected $cache;
+
     /**
      * @param \GuzzleHttp\Client $httpClient
      */
@@ -56,13 +64,29 @@ public function setClientSecret($clientSecret)
         return $this;
     }
 
+    /**
+     * Set the cache.
+     *
+     * @param Psr\SimpleCache\CacheInterface $cache
+     */
+    public function setCache(CacheInterface $cache)
+    {
+        $this->cache = $cache;
+
+        return $this;
+    }
+
     /**
      * Return the 'Authorization' header value.
      *
      * @return string
      */
     public function generateToken()
     {
+        if ($this->cache && $this->cache->has($this->getCacheKey())) {
+            return new AuthorizationToken($this->cache->get($this->getCacheKey()));
+        }
+
         $response = $this->httpClient->post(static::API_AUTH_URL, [
             'form_params' => [
                 'grant_type' => 'password',
@@ -71,6 +95,17 @@ public function generateToken()
             ],
         ]);
 
-        return new AuthorizationToken(json_decode($response->getBody()->getContents(), true));
+        $token = new AuthorizationToken(json_decode($response->getBody()->getContents(), true));
+
+        if ($this->cache) {
+            $this->cache->set($this->getCacheKey(), $token->toArray(), ($token->getExpiresIn() - 10));
+        }
+
+        return $token;
+    }
+
+    protected function getCacheKey()
+    {
+        return 'bee-plugin.bee-auth.token';
     }
 }

src/Laravel/BeePluginServiceProvider.php

@@ -23,6 +23,7 @@ public function boot()
 
         $this->app->bind(BeeAuth::class, function () {
             $client = new BeeAuth(resolve(Client::class));
+            $client->setCache($this->app('cache.store'));
 
             if (config('services.bee.client_id')) {
                 $client->setClientId(config('services.bee.client_id'));

src/Resources/AuthorizationToken.php

@@ -68,4 +68,17 @@ public function getRefreshToken()
     {
         return $this->refreshToken;
     }
+
+    /**
+     * @return array
+     */
+    public function toArray()
+    {
+        return [
+            'access_token' => $this->accessToken,
+            'token_type' => $this->tokenType,
+            'expires_in' => $this->expiresIn,
+            'refresh_token' => $this->refreshToken,
+        ];
+    }
 }

tests/BeeAuthTest.php

@@ -8,6 +8,7 @@
 use PHPUnit\Framework\TestCase;
 use GuzzleHttp\Handler\MockHandler;
 use KirschbaumDevelopment\Bee\BeeAuth;
+use Cache\Adapter\PHPArray\ArrayCachePool;
 use KirschbaumDevelopment\Bee\Resources\AuthorizationToken;
 
 /**
@@ -17,21 +18,10 @@ class BeeAuthTest extends TestCase
 {
     /**
      * @covers ::generateToken
+     * @dataProvider data
      */
-    public function testGenerateToken()
+    public function testGenerateToken($response)
     {
-        $response = [
-            'access_token' => 'isufgisufdhguisdfhuisdf.oasihuifghsdif79s87f9sd8f7sd98f7sd98f7dsu89f.owTLmGhqv6ZJSikUhGeLBv-JANoXEAVvMZomivT2o-g',
-            'token_type' => 'bearer',
-            'expires_in' => 300,
-            'refresh_token' => '09a7sd98as7f98ds6f79sd8f.09a8s7da98sd7as98d7as9d8a7s9d8as6d9as86das98d67as.owTLmGhqv6ZJSikUhGeLBv-JANoXEAVvMZomivT2o-g',
-            'as:client_id' => 'da91fe57-1ca6-4dba-b557-61edb96f4149',
-            'userName' => 'Tn3KV7JYavWn',
-            'as:region' => 'eu-west-1',
-            '.issued' => 'Sat, 17 Aug 2019 00:08:50 GMT',
-            '.expires' => 'Sat, 17 Aug 2019 00:13:50 GMT',
-        ];
-
         $mock = new MockHandler([new Response(200, [], json_encode($response))]);
         $guzzleClient = new Client(['handler' => HandlerStack::create($mock)]);
 
@@ -46,4 +36,49 @@ public function testGenerateToken()
         $this->assertEquals($response['expires_in'], $token->getExpiresIn());
         $this->assertEquals($response['refresh_token'], $token->getRefreshToken());
     }
+
+    /**
+     * @covers ::generateToken
+     * @dataProvider data
+     */
+    public function testGenerateTokenUsingCache($response)
+    {
+        $cachePool = new ArrayCachePool;
+        $mock = new MockHandler([new Response(200, [], json_encode($response))]);
+        $guzzleClient = new Client(['handler' => HandlerStack::create($mock)]);
+
+        $beeClient = new BeeAuth($guzzleClient);
+        $beeClient->setCache($cachePool);
+        $beeClient->setClientId('fake-client-id');
+        $beeClient->setClientSecret('fake-client-secret');
+
+        $token1 = $beeClient->generateToken();
+        $token2 = $beeClient->generateToken();
+
+        $this->assertEquals($token1, $token2);
+        $this->assertInstanceOf(AuthorizationToken::class, $token1);
+        $this->assertEquals($response['access_token'], $token1->getAccessToken());
+        $this->assertEquals($response['token_type'], $token1->getTokenType());
+        $this->assertEquals($response['expires_in'], $token1->getExpiresIn());
+        $this->assertEquals($response['refresh_token'], $token1->getRefreshToken());
+    }
+
+    public function data()
+    {
+        return [
+            [
+                'response' => [
+                    'access_token' => 'isufgisufdhguisdfhuisdf.oasihuifghsdif79s87f9sd8f7sd98f7sd98f7dsu89f.owTLmGhqv6ZJSikUhGeLBv-JANoXEAVvMZomivT2o-g',
+                    'token_type' => 'bearer',
+                    'expires_in' => 300,
+                    'refresh_token' => '09a7sd98as7f98ds6f79sd8f.09a8s7da98sd7as98d7as9d8a7s9d8as6d9as86das98d67as.owTLmGhqv6ZJSikUhGeLBv-JANoXEAVvMZomivT2o-g',
+                    'as:client_id' => 'da91fe57-1ca6-4dba-b557-61edb96f4149',
+                    'userName' => 'Tn3KV7JYavWn',
+                    'as:region' => 'eu-west-1',
+                    '.issued' => 'Sat, 17 Aug 2019 00:08:50 GMT',
+                    '.expires' => 'Sat, 17 Aug 2019 00:13:50 GMT',
+                ],
+            ],
+        ];
+    }
 }

tests/Resources/AuthorizationTokenTest.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace KirschbaumDevelopment\Bee\Tests\Resources;
+
+use PHPUnit\Framework\TestCase;
+use KirschbaumDevelopment\Bee\Resources\AuthorizationToken;
+
+/**
+ * @coversDefaultClass \KirschbaumDevelopment\Bee\Resources\AuthorizationToken
+ */
+class AuthorizationTokenTest extends TestCase
+{
+    /**
+     * @covers ::toArray
+     */
+    public function testToArray()
+    {
+        $response = [
+            'access_token' => 'isufgisufdhguisdfhuisdf.oasihuifghsdif79s87f9sd8f7sd98f7sd98f7dsu89f.owTLmGhqv6ZJSikUhGeLBv-JANoXEAVvMZomivT2o-g',
+            'token_type' => 'bearer',
+            'expires_in' => 300,
+            'refresh_token' => '09a7sd98as7f98ds6f79sd8f.09a8s7da98sd7as98d7as9d8a7s9d8as6d9as86das98d67as.owTLmGhqv6ZJSikUhGeLBv-JANoXEAVvMZomivT2o-g',
+        ];
+
+        $token = new AuthorizationToken($response);
+        $this->assertEquals($response, $token->toArray());
+    }
+}