feat: redirectTo (#46)

feat: redirectTo

Author: michalsn

docs/configuration.md

@@ -101,6 +101,12 @@ This setting determines if the algorithm will be included to the query string of
 
 By default, this is set to `false`.
 
+### $redirectTo
+
+This setting is used in the Filter to determine whether we will redirect user to the given URI path with the `error`, when URL will not be valid or expired.
+
+By default, this is set to `null`.
+
 ### $redirect
 
 This setting is used in the Filter to determine whether we will redirect user to the previous page with the `error`, when URL will not be valid or expired.

src/Config/SignedUrl.php

@@ -44,6 +44,12 @@ class SignedUrl extends BaseConfig
      */
     public bool $includeAlgorithmKey = false;
 
+    /**
+     * In Filter - redirect to the given URI path
+     * with error on failure.
+     */
+    public ?string $redirectTo = null;
+
     /**
      * In Filter - redirect to the previous page
      * with error on failure.

src/Filters/SignedUrl.php

@@ -44,6 +44,10 @@ public function before(RequestInterface $request, $arguments = null)
         try {
             $signedUrl->verify($request);
         } catch (SignedUrlException $e) {
+            if ($path = $signedUrl->shouldRedirectTo()) {
+                return redirect()->to($path)->with('error', $e->getMessage());
+            }
+
             if ($signedUrl->shouldRedirect()) {
                 return redirect()->back()->with('error', $e->getMessage());
             }

src/SignedUrl.php

@@ -175,6 +175,14 @@ public function verify(IncomingRequest $request): bool
         return true;
     }
 
+    /**
+     * Return redirectTo config option.
+     */
+    public function shouldRedirectTo(): ?string
+    {
+        return $this->config->redirectTo;
+    }
+
     /**
      * Check if redirect option is enabled.
      */

tests/SignedUrlTest.php

@@ -297,6 +297,13 @@ public function testVerifyThrowExceptionForExpiredUrl(): void
         $signedUrl->verify($request);
     }
 
+    public function testShouldRedirectTo(): void
+    {
+        $config    = new SignedUrlConfig();
+        $signedUrl = new SignedUrl($config);
+        $this->assertNull($signedUrl->shouldRedirectTo());
+    }
+
     public function testShouldRedirect(): void
     {
         $config    = new SignedUrlConfig();