Allow tokens with unlimited usages (#31)

Entity/Token.php

@@ -288,7 +288,12 @@ public function isUsed()
      */
     public function isConsumed()
     {
-        return $this->getCountUsages() >= $this->getAllowedUsages();
+        $allowed = $this->getAllowedUsages();
+        if ($allowed === 0) {
+            return false;
+        }
+
+        return $this->getCountUsages() >= $allowed;
     }
 
     /**

Resources/doc/2-configuration.md

@@ -14,7 +14,7 @@ Each token can have following options :
 
 - `generator` : a service id that implements [`Yokai\SecurityTokenBundle\Generator\TokenGeneratorInterface`](../../Generator/TokenGeneratorInterface.php)
 - `duration` : a valid [`DateTime::modify`](https://php.net/manual/datetime.modify.php) argument that represent the validity duration for tokens of this type
-- `usages` : an integer that represent the number of allowed usages for tokens of this type
+- `usages` : an integer that represent the number of allowed usages for tokens of this type (`0` means unlimited)
 - `keep` : a valid [`DateTime::modify`](https://php.net/manual/datetime.modify.php) argument that represent the keep duration for tokens of this type
 - `unique` : a boolean that indicates whether or not the token must be unique per user
 

Tests/Entity/TokenTest.php

@@ -0,0 +1,43 @@
+<?php
+
+namespace Yokai\SecurityTokenBundle\Tests\Entity;
+
+use Yokai\SecurityTokenBundle\Entity\Token;
+
+/**
+ * @author Yann Eugoné <[email protected]>
+ */
+class TokenTest extends \PHPUnit_Framework_TestCase
+{
+    public function testLimitedUsagesToken()
+    {
+        $token = new Token('string', 'jdoe', 'unique-token', 'reset-password', '+1 day', '+1 month', 2);
+        self::assertFalse($token->isConsumed());
+
+        $token->consume([1]);
+        self::assertFalse($token->isConsumed());
+        $token->consume([2]);
+        self::assertTrue($token->isConsumed());
+
+        self::assertCount(2, $token->getUsages());
+        self::assertSame(2, $token->getCountUsages());
+        self::assertSame([2], $token->getLastUsage()->getInformation());
+    }
+
+    public function testUnlimitedUsagesToken()
+    {
+        $token = new Token('string', 'jdoe', 'unique-token', 'reset-password', '+1 day', '+1 month', 0);
+        self::assertFalse($token->isConsumed());
+
+        $token->consume([1]);
+        self::assertFalse($token->isConsumed());
+        $token->consume([2]);
+        self::assertFalse($token->isConsumed());
+        $token->consume([3]);
+        self::assertFalse($token->isConsumed());
+
+        self::assertCount(3, $token->getUsages());
+        self::assertSame(3, $token->getCountUsages());
+        self::assertSame([3], $token->getLastUsage()->getInformation());
+    }
+}