token extension and api settings

Author: samnotsowise

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Log
 
+### 1.1.1
+* Added:    ApiSettings class
+* Changed:  Token expiration time is pulled from settings. Old constant deprecated
+* Added:    Support for extending token expiration on use
+
 ### 1.1.0
 
 * Added:	Changelog

src/ApiSettings.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Rhubarb\Scaffolds\TokenBasedRestApi;
+
+use Rhubarb\Crown\Settings;
+
+class ApiSettings extends Settings
+{
+    public $tokenExpiration = '+1 day';
+    public $extendTokenExpirationOnUse = false;
+}

src/Model/ApiToken.php

@@ -18,6 +18,7 @@
 
 namespace Rhubarb\Scaffolds\TokenBasedRestApi\Model;
 
+use Rhubarb\Scaffolds\TokenBasedRestApi\ApiSettings;
 use Rhubarb\Scaffolds\TokenBasedRestApi\Exceptions\TokenInvalidException;
 use Rhubarb\Stem\Exceptions\RecordNotFoundException;
 use Rhubarb\Stem\Filters\AndGroup;
@@ -35,6 +36,7 @@
 
 class ApiToken extends Model
 {
+    /** @deprecated Use ApiSettings::$tokenExpiration */
     const TOKEN_EXPIRATION = "+1 day";
 
     protected function createSchema()
@@ -76,7 +78,13 @@ public static function validateToken($tokenString)
             throw new TokenInvalidException();
         }
 
+        /** @var ApiToken $token */
         $token = $tokens[0];
+        $settings = ApiSettings::singleton();
+        if ($settings->extendTokenExpirationOnUse) {
+            $token->Expires = $settings->tokenExpiration;
+            $token->save();
+        }
 
         return $token->AuthenticatedUser;
     }
@@ -110,8 +118,7 @@ public static function retrieveOrCreateToken(Model $user, $ipAddress)
                 new Equals("IpAddress", $ipAddress),
                 new GreaterThan("Expires", "now", true)
             ]));
-
-            $token->Expires = self::TOKEN_EXPIRATION;
+            $token->Expires = ApiSettings::singleton()->tokenExpiration;
             $token->save();
         } catch (RecordNotFoundException $ex) {
             $token = self::createToken($user, $ipAddress);
@@ -131,7 +138,7 @@ protected function createConsistencyValidator()
     protected function beforeSave()
     {
         if ($this->isNewRecord()) {
-            $this->Expires = self::TOKEN_EXPIRATION;
+            $this->Expires = ApiSettings::singleton()->tokenExpiration;
         }
 
         parent::beforeSave();