feat: token (#45)

feat: token

Author: michalsn

docs/configuration.md

@@ -13,8 +13,10 @@ We will get our copy ready for modifications.
 Available options:
 
 - [$expiration](#expiration)
+- [$token](#token)
 - [$algorithm](#algorithm)
 - [$expirationKey](#expirationKey)
+- [$tokenKey](#tokenKey)
 - [$signatureKey](#signatureKey)
 - [$algorithmKey](#algorithmKey)
 - [$includeAlgorithmKey](#includeAlgorithmKey)
@@ -28,6 +30,13 @@ It's number of seconds in unix timestamp that will be added to the current date.
 
 By default, this is set to `null`.
 
+### $token
+
+This setting allows us to set a randomly generated token with given length.
+It is useful when you have very few changing parameters in the URL.
+
+By default, this is set to `null`.
+
 ### $algorithm
 
 This setting allows us to set algorithm that will be used during signing the URLs.
@@ -52,6 +61,16 @@ This is the name of the query string key, which will be responsible for storing
 
 By default, this is set to `expires`.
 
+!!! note
+
+    Whatever name you will choose, treat it as a restricted name and don't use it as a part of the query string in your code.
+
+### $tokenKey
+
+This is the name of the query string key, which will be responsible for storing the token string.
+
+By default, this is set to `token`.
+
 !!! note
 
     Whatever name you will choose, treat it as a restricted name and don't use it as a part of the query string in your code.

phpstan.neon.dist

@@ -8,6 +8,7 @@ parameters:
 		- vendor/codeigniter4/framework/system/Test/bootstrap.php
 	excludePaths:
 	ignoreErrors:
+		- '#Call to deprecated function random_string\(\):#'
 	universalObjectCratesClasses:
 		- CodeIgniter\Entity
 		- CodeIgniter\Entity\Entity

phpunit.xml.dist

@@ -24,8 +24,9 @@
             <directory suffix=".php">./src/</directory>
         </include>
         <exclude>
+            <directory suffix=".php">./src/Commands</directory>
             <directory suffix=".php">./src/Config</directory>
-            <file>./src/Debug/Toolbar.php</file>
+            <file>./src/Filters/SignedUrl.php</file>
         </exclude>
         <report>
             <clover outputFile="build/phpunit/clover.xml"/>

rector.php

@@ -44,7 +44,7 @@
 
     // The paths to refactor (can also be supplied with CLI arguments)
     $rectorConfig->paths([
-        __DIR__ . '/app/',
+        __DIR__ . '/src/',
         __DIR__ . '/tests/',
     ]);
 
@@ -111,7 +111,7 @@
              * The INLINE_PUBLIC value is default to false to avoid BC break, if you use for libraries and want to preserve BC break, you don't need to configure it, as it included in LevelSetList::UP_TO_PHP_74
              * Set to true for projects that allow BC break
              */
-            TypedPropertyFromAssignsRector::INLINE_PUBLIC => true,
+            TypedPropertyFromAssignsRector::INLINE_PUBLIC => false,
         ]);
     $rectorConfig->rule(StringClassNameToClassConstantRector::class);
     $rectorConfig->rule(PrivatizeFinalClassPropertyRector::class);

src/Commands/SignedUrlAlgorithms.php

@@ -5,9 +5,6 @@
 use CodeIgniter\CLI\BaseCommand;
 use CodeIgniter\CLI\CLI;
 
-/**
- * @codeCoverageIgnore
- */
 class SignedUrlAlgorithms extends BaseCommand
 {
     protected $group       = 'SignedUrl';

src/Commands/SignedUrlPublish.php

@@ -7,9 +7,6 @@
 use CodeIgniter\Publisher\Publisher;
 use Throwable;
 
-/**
- * @codeCoverageIgnore
- */
 class SignedUrlPublish extends BaseCommand
 {
     protected $group       = 'SignedUrl';

src/Config/SignedUrl.php

@@ -12,6 +12,13 @@ class SignedUrl extends BaseConfig
      */
     public ?int $expiration = null;
 
+    /**
+     * Length of the token string used with
+     * random_string() helper. Useful if you have
+     * very few changing parameters in the URL.
+     */
+    public ?int $token = null;
+
     /**
      * Algorithm used to sign the URL.
      *
@@ -28,6 +35,7 @@ class SignedUrl extends BaseConfig
      */
     public string $expirationKey = 'expires';
 
+    public string $tokenKey     = 'token';
     public string $signatureKey = 'signature';
     public string $algorithmKey = 'algorithm';
 

src/Exceptions/SignedUrlException.php

@@ -21,6 +21,11 @@ public static function forEmptyExpirationKey(): static
         return new self(lang('SignedUrl.emptyExpirationKey'));
     }
 
+    public static function forEmptyTokenKey(): static
+    {
+        return new self(lang('SignedUrl.emptyTokenKey'));
+    }
+
     public static function forEmptySignatureKey(): static
     {
         return new self(lang('SignedUrl.emptySignatureKey'));

src/Filters/SignedUrl.php

@@ -14,8 +14,6 @@
  * SignedUrl filter.
  *
  * This filter is not intended to be used from the command line.
- *
- * @codeCoverageIgnore
  */
 class SignedUrl implements FilterInterface
 {

src/Language/en/SignedUrl.php

@@ -4,9 +4,10 @@
     'incorrectAlgorithm' => 'Algorithm is incorrect, please run command: "php spark signedurl:algorithms" to see available options.',
     'invalidAlgorithm'   => 'Algorithm is invalid or not supported.',
     'emptyExpirationKey' => 'Expiration key cannot be empty.',
+    'emptyTokenKey'      => 'Token key cannot be empty.',
     'emptySignatureKey'  => 'Signature key cannot be empty.',
     'emptyAlgorithmKey'  => 'Algorithm key cannot be empty.',
-    'sameKeyNames'       => 'Expiration, Signature or Algorithm keys cannot share the same name.',
+    'sameKeyNames'       => 'Expiration, Token, Signature or Algorithm keys cannot share the same name.',
     'emptyEncryptionKey' => 'Encryption key is missing, please run command: "php spark key:generate"',
     'missingSignature'   => 'This URL have to be signed.',
     'urlNotValid'        => 'This URL is not valid.',