refactor and tests

src/Abuse/Adapter.php

@@ -2,16 +2,68 @@
 
 namespace Utopia\Abuse;
 
-interface Adapter
+abstract class Adapter
 {
+    /**
+     * @var array<string, string>
+     */
+    protected array $params = [];
+
+    /**
+     * @var string
+     */
+    protected string $key = '';
+
     /**
      * Check
      *
      * Checks if number of counts is bigger or smaller than current limit
      *
      * @return bool
      */
-    public function check(): bool;
+    abstract public function check(): bool;
+
+    /**
+    * Set Param
+    *
+    * Set custom param for key pattern parsing
+    *
+    * @param  string  $key
+    * @param  string  $value
+    * @return $this
+    */
+    public function setParam(string $key, string $value): self
+    {
+        $this->params[$key] = $value;
+
+        return $this;
+    }
+
+     /**
+     * Get Params
+     *
+     * Return array of all key params
+     *
+     * @return array<string, string>
+     */
+    protected function getParams(): array
+    {
+        return $this->params;
+    }
+
+     /**
+     * Parse key with all custom attached params
+     *
+     * @return string
+     */
+    protected function parseKey(): string
+    {
+        foreach ($this->getParams() as $key => $value) {
+            $this->key = \str_replace($key, $value, $this->key);
+        }
+
+        return $this->key;
+    }
 
     /**
      * Get abuse logs
@@ -22,13 +74,13 @@ public function check(): bool;
      * @param  int|null  $limit
      * @return array<string, mixed>
      */
-    public function getLogs(?int $offset = null, ?int $limit = 25): array;
+    abstract public function getLogs(?int $offset = null, ?int $limit = 25): array;
 
     /**
      * Delete all logs older than $datetime
      *
      * @param  string  $datetime
      * @return bool
      */
-    public function cleanup(string $datetime): bool;
+    abstract public function cleanup(string $datetime): bool;
 }

src/Abuse/Adapters/ReCaptcha.php

@@ -5,7 +5,7 @@
 use Exception;
 use Utopia\Abuse\Adapter;
 
-class ReCaptcha implements Adapter
+class ReCaptcha extends Adapter
 {
     /**
      * Use this for communication between your site and Google.

src/Abuse/Adapters/Redis.php

@@ -5,7 +5,7 @@
 use Utopia\Abuse\Adapter;
 use Redis as Client;
 
-class Redis implements Adapter
+class Redis extends Adapter
 {
     public const NAMESPACE = 'abuse';
 
@@ -14,11 +14,6 @@ class Redis implements Adapter
      */
     protected Client $redis;
 
-    /**
-     * @var string
-     */
-    protected string $key = '';
-
     /**
      * @var int
      */
@@ -34,12 +29,6 @@ class Redis implements Adapter
      */
     protected ?int $count = null;
 
-    /**
-     * @var array<string, string>
-     */
-    protected array $params = [];
-
-
     public function __construct(string $key, int $limit, int $seconds, Client $redis)
     {
         $this->redis = $redis;
@@ -49,48 +38,6 @@ public function __construct(string $key, int $limit, int $seconds, Client $redis
         $this->limit = $limit;
     }
 
-    /**
-     * Set Param
-     *
-     * Set custom param for key pattern parsing
-     *
-     * @param  string  $key
-     * @param  string  $value
-     * @return $this
-     */
-    public function setParam(string $key, string $value): self
-    {
-        $this->params[$key] = $value;
-
-        return $this;
-    }
-
-    /**
-     * Get Params
-     *
-     * Return array of all key params
-     *
-     * @return array<string, string>
-     */
-    protected function getParams(): array
-    {
-        return $this->params;
-    }
-
-    /**
-     * Parse key with all custom attached params
-     *
-     * @return string
-     */
-    protected function parseKey(): string
-    {
-        foreach ($this->getParams() as $key => $value) {
-            $this->key = \str_replace($key, $value, $this->key);
-        }
-
-        return $this->key;
-    }
-
     /**
      * Undocumented function
      *

src/Abuse/Adapters/TimeLimit.php

@@ -14,7 +14,7 @@
 use Utopia\Database\Validator\Authorization;
 use Utopia\Exception;
 
-class TimeLimit implements Adapter
+class TimeLimit extends Adapter
 {
     public const COLLECTION = 'abuse';
 
@@ -23,11 +23,6 @@ class TimeLimit implements Adapter
      */
     protected Database $db;
 
-    /**
-     * @var string
-     */
-    protected string $key = '';
-
     /**
      * @var string
      */
@@ -43,11 +38,6 @@ class TimeLimit implements Adapter
      */
     protected ?int $count = null;
 
-    /**
-     * @var array<string, string>
-     */
-    protected array $params = [];
-
     /**
      * @param  string  $key
      * @param  int  $seconds
@@ -127,48 +117,6 @@ public function setup(): void
         }
     }
 
-    /**
-     * Set Param
-     *
-     * Set custom param for key pattern parsing
-     *
-     * @param  string  $key
-     * @param  string  $value
-     * @return $this
-     */
-    public function setParam(string $key, string $value): self
-    {
-        $this->params[$key] = $value;
-
-        return $this;
-    }
-
-    /**
-     * Get Params
-     *
-     * Return array of all key params
-     *
-     * @return array<string, string>
-     */
-    protected function getParams(): array
-    {
-        return $this->params;
-    }
-
-    /**
-     * Parse key with all custom attached params
-     *
-     * @return string
-     */
-    protected function parseKey(): string
-    {
-        foreach ($this->getParams() as $key => $value) {
-            $this->key = \str_replace($key, $value, $this->key);
-        }
-
-        return $this->key;
-    }
-
     /**
      * Check
      *