feat(remaining-validity): add getSecuredApiKeyRemainingValidity method (#581)

Author: chloelbn

src/Exceptions/ValidUntilNotFoundException.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Algolia\AlgoliaSearch\Exceptions;
+
+final class ValidUntilNotFoundException extends AlgoliaException
+{
+}

src/SearchClient.php

@@ -2,6 +2,7 @@
 
 namespace Algolia\AlgoliaSearch;
 
+use Algolia\AlgoliaSearch\Exceptions\ValidUntilNotFoundException;
 use Algolia\AlgoliaSearch\Response\DeleteApiKeyResponse;
 use Algolia\AlgoliaSearch\Response\IndexingResponse;
 use Algolia\AlgoliaSearch\Response\MultipleIndexBatchIndexingResponse;
@@ -355,4 +356,28 @@ public function custom($method, $path, $requestOptions = array(), $hosts = null)
     {
         return $this->api->send($method, $path, $requestOptions, $hosts);
     }
+
+    /**
+     * Returns the time the given securedAPIKey remains valid in seconds.
+     *
+     * @param string $securedAPIKey the key to check
+     *
+     * @return int remaining validity in seconds
+     *
+     * @throws ValidUntilNotFoundException
+     */
+    public static function getSecuredApiKeyRemainingValidity($securedAPIKey)
+    {
+        $decodedKey = base64_decode($securedAPIKey);
+        $regex = '/validUntil=(\d+)/';
+        preg_match($regex, $decodedKey, $matches);
+
+        if (0 === count($matches)) {
+            throw new ValidUntilNotFoundException("The SecuredAPIKey doesn't have a validUntil parameter.");
+        }
+
+        $validUntil = (int) $matches[1];
+
+        return $validUntil - time();
+    }
 }

tests/Integration/SearchClientTest.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace Algolia\AlgoliaSearch\Tests\Integration;
+
+use Algolia\AlgoliaSearch\SearchClient;
+use PHPUnit\Framework\TestCase;
+
+class SearchClientTest extends TestCase
+{
+    public function testGetSecuredApiKeyRemainingValidity()
+    {
+        $now = time();
+
+        $newSecuredKey = SearchClient::generateSecuredApiKey('foo',
+            array('validUntil' => $now - (10 * 60))
+        );
+
+        $this->assertLessThan(0, SearchClient::getSecuredApiKeyRemainingValidity($newSecuredKey));
+
+        $newSecuredKey = SearchClient::generateSecuredApiKey('foo',
+            array('validUntil' => $now + (10 * 60))
+        );
+
+        $this->assertGreaterThan(0, SearchClient::getSecuredApiKeyRemainingValidity($newSecuredKey));
+
+        try {
+            $newSecuredKey = SearchClient::generateSecuredApiKey('foo', array());
+            SearchClient::getSecuredApiKeyRemainingValidity($newSecuredKey);
+        } catch (\Exception $e) {
+            $this->assertInstanceOf('Algolia\AlgoliaSearch\Exceptions\ValidUntilNotFoundException', $e);
+        }
+    }
+}