[5.x] Token class changes

src/Contracts/Tokens/TokenRepository.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Statamic\Contracts\Tokens;
+
+interface TokenRepository
+{
+    public function make(?string $token, string $handler, array $data = []): Token;
+
+    public function find(string $token): ?Token;
+
+    public function save(Token $token): bool;
+
+    public function delete(Token $token): bool;
+
+    public function collectGarbage(): void;
+}

src/Facades/Token.php

@@ -3,8 +3,17 @@
 namespace Statamic\Facades;
 
 use Illuminate\Support\Facades\Facade;
-use Statamic\Tokens\TokenRepository;
+use Statamic\Contracts\Tokens\TokenRepository;
 
+/**
+ * @method static \Statamic\Contracts\Tokens\Token make(?string $token, string $handler, array $data = [])
+ * @method static \Statamic\Contracts\Tokens\Token find(string $token)
+ * @method static bool save(\Statamic\Contracts\Tokens\Token $token)
+ * @method static bool delete(\Statamic\Contracts\Tokens\Token $token)
+ * @method static void collectGarbage()
+ *
+ * @see \Statamic\Tokens\TokenRepository
+ */
 class Token extends Facade
 {
     protected static function getFacadeAccessor()

src/Providers/AppServiceProvider.php

@@ -121,6 +121,7 @@ public function register()
             \Statamic\Contracts\Assets\AssetRepository::class => \Statamic\Assets\AssetRepository::class,
             \Statamic\Contracts\Forms\FormRepository::class => \Statamic\Forms\FormRepository::class,
             \Statamic\Contracts\Forms\SubmissionRepository::class => \Statamic\Stache\Repositories\SubmissionRepository::class,
+            \Statamic\Contracts\Tokens\TokenRepository::class => \Statamic\Tokens\FileTokenRepository::class,
         ])->each(function ($concrete, $abstract) {
             if (! $this->app->bound($abstract)) {
                 Statamic::repository($abstract, $concrete);

src/Tokens/FileToken.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace Statamic\Tokens;
+
+use Statamic\Data\ExistsAsFile;
+
+class FileToken extends Token
+{
+    use ExistsAsFile;
+
+    public function path()
+    {
+        return storage_path('statamic/tokens/'.$this->token().'.yaml');
+    }
+
+    public function fileData()
+    {
+        return [
+            'handler' => $this->handler,
+            'expires_at' => $this->expiry->timestamp,
+            'data' => $this->data->all(),
+        ];
+    }
+}

src/Tokens/FileTokenRepository.php

@@ -0,0 +1,67 @@
+<?php
+
+namespace Statamic\Tokens;
+
+use Illuminate\Support\Carbon;
+use Statamic\Contracts\Tokens\Token as TokenContract;
+use Statamic\Facades\File;
+use Statamic\Facades\YAML;
+
+class FileTokenRepository extends TokenRepository
+{
+    public function make(?string $token, string $handler, array $data = []): TokenContract
+    {
+        return app()->makeWith(TokenContract::class, compact('token', 'handler', 'data'));
+    }
+
+    public function find(string $token): ?TokenContract
+    {
+        $path = storage_path('statamic/tokens/'.$token.'.yaml');
+
+        if (! File::exists($path)) {
+            return null;
+        }
+
+        return $this->makeFromPath($path);
+    }
+
+    public function save(TokenContract $token): bool
+    {
+        File::put(storage_path('statamic/tokens/'.$token->token().'.yaml'), $token->fileContents());
+
+        return true;
+    }
+
+    public function delete(TokenContract $token): bool
+    {
+        File::delete(storage_path('statamic/tokens/'.$token->token().'.yaml'));
+
+        return true;
+    }
+
+    public function collectGarbage(): void
+    {
+        File::getFilesByType(storage_path('statamic/tokens'), 'yaml')
+            ->map(fn ($path) => $this->makeFromPath($path))
+            ->filter->hasExpired()
+            ->each->delete();
+    }
+
+    private function makeFromPath(string $path): FileToken
+    {
+        $yaml = YAML::file($path)->parse();
+
+        $token = basename($path, '.yaml');
+
+        return $this
+            ->make($token, $yaml['handler'], $yaml['data'] ?? [])
+            ->expireAt(Carbon::createFromTimestamp($yaml['expires_at']));
+    }
+
+    public static function bindings(): array
+    {
+        return [
+            TokenContract::class => FileToken::class,
+        ];
+    }
+}

src/Tokens/Token.php

@@ -2,23 +2,77 @@
 
 namespace Statamic\Tokens;
 
-use Statamic\Data\ExistsAsFile;
+use Closure;
+use Facades\Statamic\Tokens\Generator;
+use Illuminate\Support\Carbon;
+use Illuminate\Support\Collection;
+use Statamic\Contracts\Tokens\Token as Contract;
+use Statamic\Facades\Token as Tokens;
 
-class Token extends AbstractToken
+abstract class Token implements Contract
 {
-    use ExistsAsFile;
+    protected $token;
+    protected $handler;
+    protected $data;
+    protected $expiry;
 
-    public function path()
+    public function __construct(?string $token, string $handler, array $data = [])
     {
-        return storage_path('statamic/tokens/'.$this->token().'.yaml');
+        $this->token = $token ?? Generator::generate();
+        $this->handler = $handler;
+        $this->data = collect($data);
+        $this->expiry = Carbon::now()->addHour();
     }
 
-    public function fileData()
+    public function token(): string
     {
-        return [
-            'handler' => $this->handler,
-            'expires_at' => $this->expiry->timestamp,
-            'data' => $this->data->all(),
-        ];
+        return $this->token;
+    }
+
+    public function handler(): string
+    {
+        return $this->handler;
+    }
+
+    public function data(): Collection
+    {
+        return $this->data;
+    }
+
+    public function get(string $key)
+    {
+        return $this->data->get($key);
+    }
+
+    public function save()
+    {
+        return Tokens::save($this);
+    }
+
+    public function delete()
+    {
+        return Tokens::delete($this);
+    }
+
+    public function handle($request, Closure $next)
+    {
+        return app($this->handler)->handle($this, $request, $next);
+    }
+
+    public function expiry(): Carbon
+    {
+        return $this->expiry;
+    }
+
+    public function expireAt(Carbon $expiry): self
+    {
+        $this->expiry = $expiry;
+
+        return $this;
+    }
+
+    public function hasExpired(): bool
+    {
+        return $this->expiry->isPast();
     }
 }

src/Tokens/TokenRepository.php

@@ -2,58 +2,15 @@
 
 namespace Statamic\Tokens;
 
-use Illuminate\Support\Carbon;
-use Statamic\Facades\File;
-use Statamic\Facades\YAML;
+use Statamic\Contracts\Tokens\Token as TokenContract;
+use Statamic\Contracts\Tokens\TokenRepository as Contract;
 
-class TokenRepository
+abstract class TokenRepository implements Contract
 {
-    public function make(?string $token, string $handler, array $data = []): Token
+    public function make(?string $token, string $handler, array $data = []): TokenContract
     {
-        return new Token($token, $handler, $data);
+        return app()->makeWith(TokenContract::class, compact('token', 'handler', 'data'));
     }
 
-    public function find(string $token)
-    {
-        $path = storage_path('statamic/tokens/'.$token.'.yaml');
-
-        if (! File::exists($path)) {
-            return null;
-        }
-
-        return $this->makeFromPath($path);
-    }
-
-    public function save(Token $token)
-    {
-        File::put(storage_path('statamic/tokens/'.$token->token().'.yaml'), $token->fileContents());
-
-        return true;
-    }
-
-    public function delete(Token $token)
-    {
-        File::delete(storage_path('statamic/tokens/'.$token->token().'.yaml'));
-
-        return true;
-    }
-
-    public function collectGarbage()
-    {
-        File::getFilesByType(storage_path('statamic/tokens'), 'yaml')
-            ->map(fn ($path) => $this->makeFromPath($path))
-            ->filter->hasExpired()
-            ->each->delete();
-    }
-
-    private function makeFromPath(string $path): Token
-    {
-        $yaml = YAML::file($path)->parse();
-
-        $token = basename($path, '.yaml');
-
-        return $this
-            ->make($token, $yaml['handler'], $yaml['data'] ?? [])
-            ->expireAt(Carbon::createFromTimestamp($yaml['expires_at']));
-    }
+    abstract public static function bindings(): array;
 }

tests/Tokens/TokenRepositoryTest.php

@@ -7,7 +7,7 @@
 use Illuminate\Support\Collection;
 use Statamic\Contracts\Tokens\Token;
 use Statamic\Facades\File;
-use Statamic\Tokens\TokenRepository;
+use Statamic\Tokens\FileTokenRepository;
 use Tests\TestCase;
 
 class TokenRepositoryTest extends TestCase
@@ -18,7 +18,7 @@ public function setUp(): void
     {
         parent::setUp();
 
-        $this->tokens = new TokenRepository;
+        $this->tokens = new FileTokenRepository;
     }
 
     /** @test */

tests/Tokens/TokenTest.php

@@ -5,7 +5,7 @@
 use Illuminate\Http\Request;
 use Illuminate\Support\Carbon;
 use Statamic\Facades;
-use Statamic\Tokens\Token;
+use Statamic\Tokens\FileToken as Token;
 use Tests\TestCase;
 
 class TokenTest extends TestCase