Refactor CacheStorage and DatabaseStorage to support nullable store values and improve configuration handling

aslnbxrz · aslnbxrz · commit 52e5fba6ff2c · 2025-10-09T20:42:05.000+05:00
diff --git a/EXAMPLE.md b/EXAMPLE.md
@@ -542,7 +542,7 @@ SIMPLE_OTP_DB_CONNECTION=mysql
 // For simple applications, use Cache:
 // .env
 SIMPLE_OTP_STORAGE=cache
-SIMPLE_OTP_CACHE_STORE=default
+SIMPLE_OTP_CACHE_STORE=null
 ```
 
 ## Example 9: Scheduled Cleanup
diff --git a/README.md b/README.md
@@ -53,7 +53,7 @@ return [
     'drivers' => [
         'cache' => [
             'driver' => 'cache',
-            'store' => env('SIMPLE_OTP_CACHE_STORE', 'default'),
+            'store' => env('SIMPLE_OTP_CACHE_STORE', null), // null means use default cache store
         ],
         
         'database' => [
@@ -142,7 +142,7 @@ Add these variables to your `.env` file:
 ```env
 # Storage Configuration
 SIMPLE_OTP_STORAGE=cache
-SIMPLE_OTP_CACHE_STORE=default
+SIMPLE_OTP_CACHE_STORE=null
 SIMPLE_OTP_DB_CONNECTION=mysql
 SIMPLE_OTP_REDIS_CONNECTION=default
 SIMPLE_OTP_REDIS_PREFIX=simple_otp:
diff --git a/composer.json b/composer.json
@@ -1,55 +1,62 @@
 {
-    "name": "aslnbxrz/simple-otp",
-    "description": "A simple and flexible OTP (One-Time Password) management package for Laravel with multiple storage drivers and delivery methods",
-    "type": "library",
-    "keywords": ["laravel", "otp", "sms", "email", "verification", "authentication"],
-    "license": "MIT",
-    "authors": [
-        {
-            "name": "Aslnbxrz",
-            "email": "aslnbxrz@example.com"
-        }
-    ],
-    "require": {
-        "php": "^8.1",
-        "illuminate/support": "^10.0|^11.0",
-        "illuminate/database": "^10.0|^11.0",
-        "illuminate/cache": "^10.0|^11.0",
-        "illuminate/mail": "^10.0|^11.0",
-        "illuminate/notifications": "^10.0|^11.0"
-    },
-    "require-dev": {
-        "phpunit/phpunit": "^10.0",
-        "orchestra/testbench": "^8.0",
-        "mockery/mockery": "^1.4"
-    },
-    "autoload": {
-        "psr-4": {
-            "Aslnbxrz\\SimpleOTP\\": "src/"
-        }
-    },
-    "autoload-dev": {
-        "psr-4": {
-            "Aslnbxrz\\SimpleOTP\\Tests\\": "tests/"
-        }
-    },
-    "extra": {
-        "laravel": {
-            "providers": [
-                "Aslnbxrz\\SimpleOTP\\SimpleOTPServiceProvider"
-            ],
-            "aliases": {
-                "SimpleOTP": "Aslnbxrz\\SimpleOTP\\Facades\\SimpleOTP"
-            }
-        }
-    },
-    "minimum-stability": "dev",
-    "prefer-stable": true,
-    "scripts": {
-        "test": "phpunit",
-        "test-coverage": "phpunit --coverage-html coverage"
-    },
-    "config": {
-        "sort-packages": true
+  "name": "aslnbxrz/simple-otp",
+  "description": "A simple and flexible OTP (One-Time Password) management package for Laravel with multiple storage drivers and delivery methods",
+  "type": "library",
+  "keywords": [
+    "laravel",
+    "otp",
+    "sms",
+    "email",
+    "verification",
+    "authentication"
+  ],
+  "license": "MIT",
+  "authors": [
+    {
+      "name": "Aslnbxrz",
+      "email": "aslnbxrz@example.com"
     }
+  ],
+  "require": {
+    "php": "^8.1",
+    "illuminate/support": "^10.0|^11.0|^12.0",
+    "illuminate/database": "^10.0|^11.0|^12.0",
+    "illuminate/cache": "^10.0|^11.0|^12.0",
+    "illuminate/mail": "^10.0|^11.0|^12.0",
+    "illuminate/notifications": "^10.0|^11.0|^12.0"
+  },
+  "require-dev": {
+    "phpunit/phpunit": "^10.0",
+    "orchestra/testbench": "^8.0",
+    "mockery/mockery": "^1.4"
+  },
+  "autoload": {
+    "psr-4": {
+      "Aslnbxrz\\SimpleOTP\\": "src/"
+    }
+  },
+  "autoload-dev": {
+    "psr-4": {
+      "Aslnbxrz\\SimpleOTP\\Tests\\": "tests/"
+    }
+  },
+  "extra": {
+    "laravel": {
+      "providers": [
+        "Aslnbxrz\\SimpleOTP\\SimpleOTPServiceProvider"
+      ],
+      "aliases": {
+        "SimpleOTP": "Aslnbxrz\\SimpleOTP\\Facades\\SimpleOTP"
+      }
+    }
+  },
+  "minimum-stability": "dev",
+  "prefer-stable": true,
+  "scripts": {
+    "test": "phpunit",
+    "test-coverage": "phpunit --coverage-html coverage"
+  },
+  "config": {
+    "sort-packages": true
+  }
 }
diff --git a/config/simple-otp.php b/config/simple-otp.php
@@ -13,7 +13,7 @@
     | Supported: "cache", "database", "redis"
     |
     */
-    'default' => env('SIMPLE_OTP_STORAGE', 'cache'),
+    'default' => env('SIMPLE_OTP_STORAGE', 'database'),
 
     /*
     |--------------------------------------------------------------------------
@@ -27,7 +27,7 @@
     'drivers' => [
         'cache' => [
             'driver' => 'cache',
-            'store' => env('SIMPLE_OTP_CACHE_STORE', 'default'),
+            'store' => env('SIMPLE_OTP_CACHE_STORE', null), // null means use default cache store
         ],
 
         'database' => [
diff --git a/src/OTPService.php b/src/OTPService.php
@@ -40,7 +40,10 @@ public function generate(string $identifier, string $recipient, array $options =
             'options' => $options,
         ];
 
-        if (!$this->storage->store($identifier, $code, $this->config['ttl'], $metadata)) {
+        $ttlMinutes = $this->config['otp']['ttl'] ?? 5;
+        $storeResult = $this->storage->store($identifier, $code, $ttlMinutes, $metadata);
+
+        if (!$storeResult) {
             throw new OTPException('Failed to store OTP code');
         }
 
@@ -60,7 +63,7 @@ public function generate(string $identifier, string $recipient, array $options =
             'success' => true,
             'message' => $this->getMessage('sent'),
             'identifier' => $identifier,
-            'expires_at' => now()->addMinutes($this->config['ttl']),
+            'expires_at' => now()->addMinutes($ttlMinutes),
         ];
     }
 
@@ -78,7 +81,8 @@ public function verify(string $identifier, string $code): bool
         }
 
         // Check max attempts
-        if ($otpData['attempts'] >= $this->config['max_attempts']) {
+        $maxAttempts = $this->config['otp']['max_attempts'] ?? 3;
+        if ($otpData['attempts'] >= $maxAttempts) {
             $this->storage->delete($identifier);
             throw new OTPException($this->getMessage('max_attempts'));
         }
@@ -145,8 +149,8 @@ public function delete(string $identifier): bool
 
     protected function generateCode(): string
     {
-        $type = $this->config['type'];
-        $length = $this->config['length'];
+        $type = $this->config['otp']['type'] ?? 'numeric';
+        $length = $this->config['otp']['length'] ?? 6;
 
         switch ($type) {
             case 'numeric':
@@ -193,23 +197,25 @@ protected function generateAlphaCode(int $length): string
 
     protected function isRateLimited(string $identifier): bool
     {
-        if (!$this->config['rate_limit']['enabled']) {
+        $rateLimit = $this->config['otp']['rate_limit'] ?? ['enabled' => false];
+        if (!($rateLimit['enabled'] ?? false)) {
             return false;
         }
 
         $key = "simple_otp_rate_limit:{$identifier}";
-        
-        return RateLimiter::tooManyAttempts($key, $this->config['rate_limit']['max_attempts']);
+        $max = $rateLimit['max_attempts'] ?? 5;
+        return RateLimiter::tooManyAttempts($key, $max);
     }
 
     protected function incrementRateLimit(string $identifier): void
     {
-        if (!$this->config['rate_limit']['enabled']) {
+        $rateLimit = $this->config['otp']['rate_limit'] ?? ['enabled' => false];
+        if (!($rateLimit['enabled'] ?? false)) {
             return;
         }
 
         $key = "simple_otp_rate_limit:{$identifier}";
-        $decayMinutes = $this->config['rate_limit']['decay_minutes'];
+        $decayMinutes = $rateLimit['decay_minutes'] ?? 60;
         
         RateLimiter::hit($key, $decayMinutes * 60);
     }
diff --git a/src/SimpleOTPServiceProvider.php b/src/SimpleOTPServiceProvider.php
@@ -59,8 +59,9 @@ protected function registerStorageDriver(): void
 
             switch ($driver) {
                 case 'cache':
-                    $store = $app['cache']->store($driverConfig['store']);
-                    return new CacheStorage($store, $driverConfig['store']);
+                    $storeName = $driverConfig['store'];
+                    $store = $storeName ? $app['cache']->store($storeName) : $app['cache']->store();
+                    return new CacheStorage($store, $storeName);
 
                 case 'database':
                     $connection = $driverConfig['connection'] 
diff --git a/src/Storage/CacheStorage.php b/src/Storage/CacheStorage.php
@@ -8,9 +8,9 @@
 class CacheStorage implements OTPStorageContract
 {
     protected Repository $cache;
-    protected string $store;
+    protected ?string $store;
 
-    public function __construct(Repository $cache, string $store = 'default')
+    public function __construct(Repository $cache, ?string $store = null)
     {
         $this->cache = $cache;
         $this->store = $store;
@@ -81,6 +81,7 @@ public function cleanup(): int
 
     protected function getKey(string $identifier): string
     {
-        return "simple_otp:{$this->store}:{$identifier}";
+        $storePrefix = $this->store ? "{$this->store}:" : '';
+        return "simple_otp:{$storePrefix}{$identifier}";
     }
 }
diff --git a/src/Storage/DatabaseStorage.php b/src/Storage/DatabaseStorage.php
@@ -2,9 +2,9 @@
 
 namespace Aslnbxrz\SimpleOTP\Storage;
 
+use Aslnbxrz\SimpleOTP\Contracts\OTPStorageContract;
 use Illuminate\Database\ConnectionInterface;
 use Illuminate\Support\Facades\DB;
-use Aslnbxrz\SimpleOTP\Contracts\OTPStorageContract;
 
 class DatabaseStorage implements OTPStorageContract
 {
@@ -20,7 +20,7 @@ public function __construct(ConnectionInterface $connection, string $table = 'si
     public function store(string $identifier, string $code, int $ttl, array $metadata = []): bool
     {
         $now = now();
-        
+
         $data = [
             'identifier' => $identifier,
             'code' => $code,
@@ -50,15 +50,15 @@ public function get(string $identifier): ?array
             'created_at' => $record->created_at->timestamp,
             'expires_at' => $record->expires_at->timestamp,
             'attempts' => $record->attempts,
-            'verified' => (bool) $record->verified,
+            'verified' => (bool)$record->verified,
             'metadata' => json_decode($record->metadata, true) ?: [],
         ];
     }
 
     public function update(string $identifier, array $metadata): bool
     {
         $updateData = [];
-        
+
         foreach ($metadata as $key => $value) {
             if (in_array($key, ['attempts', 'verified'])) {
                 $updateData[$key] = $value;
@@ -67,7 +67,7 @@ public function update(string $identifier, array $metadata): bool
                 $existingRecord = $this->connection->table($this->table)
                     ->where('identifier', $identifier)
                     ->first();
-                
+
                 if ($existingRecord) {
                     $existingMetadata = json_decode($existingRecord->metadata, true) ?: [];
                     $existingMetadata[$key] = $value;
@@ -81,15 +81,15 @@ public function update(string $identifier, array $metadata): bool
         }
 
         return $this->connection->table($this->table)
-            ->where('identifier', $identifier)
-            ->update($updateData) > 0;
+                ->where('identifier', $identifier)
+                ->update($updateData) > 0;
     }
 
     public function delete(string $identifier): bool
     {
         return $this->connection->table($this->table)
-            ->where('identifier', $identifier)
-            ->delete() > 0;
+                ->where('identifier', $identifier)
+                ->delete() > 0;
     }
 
     public function cleanup(): int

Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,10 @@ public function generate(string $identifier, string $recipient, array $options =`
`40`	`40`	`'options' => $options,`
`41`	`41`	`];`
`42`	`42`
`43`		`- if (!$this->storage->store($identifier, $code, $this->config['ttl'], $metadata)) {`
	`43`	`+ $ttlMinutes = $this->config['otp']['ttl'] ?? 5;`
	`44`	`+ $storeResult = $this->storage->store($identifier, $code, $ttlMinutes, $metadata);`
	`45`	`+`
	`46`	`+ if (!$storeResult) {`
`44`	`47`	`throw new OTPException('Failed to store OTP code');`
`45`	`48`	`}`
`46`	`49`
`@@ -60,7 +63,7 @@ public function generate(string $identifier, string $recipient, array $options =`
`60`	`63`	`'success' => true,`
`61`	`64`	`'message' => $this->getMessage('sent'),`
`62`	`65`	`'identifier' => $identifier,`
`63`		`- 'expires_at' => now()->addMinutes($this->config['ttl']),`
	`66`	`+ 'expires_at' => now()->addMinutes($ttlMinutes),`
`64`	`67`	`];`
`65`	`68`	`}`
`66`	`69`
`@@ -78,7 +81,8 @@ public function verify(string $identifier, string $code): bool`
`78`	`81`	`}`
`79`	`82`
`80`	`83`	`// Check max attempts`
`81`		`- if ($otpData['attempts'] >= $this->config['max_attempts']) {`
	`84`	`+ $maxAttempts = $this->config['otp']['max_attempts'] ?? 3;`
	`85`	`+ if ($otpData['attempts'] >= $maxAttempts) {`
`82`	`86`	`$this->storage->delete($identifier);`
`83`	`87`	`throw new OTPException($this->getMessage('max_attempts'));`
`84`	`88`	`}`
`@@ -145,8 +149,8 @@ public function delete(string $identifier): bool`
`145`	`149`
`146`	`150`	`protected function generateCode(): string`
`147`	`151`	`{`
`148`		`- $type = $this->config['type'];`
`149`		`- $length = $this->config['length'];`
	`152`	`+ $type = $this->config['otp']['type'] ?? 'numeric';`
	`153`	`+ $length = $this->config['otp']['length'] ?? 6;`
`150`	`154`
`151`	`155`	`switch ($type) {`
`152`	`156`	`case 'numeric':`
`@@ -193,23 +197,25 @@ protected function generateAlphaCode(int $length): string`
`193`	`197`
`194`	`198`	`protected function isRateLimited(string $identifier): bool`
`195`	`199`	`{`
`196`		`- if (!$this->config['rate_limit']['enabled']) {`
	`200`	`+ $rateLimit = $this->config['otp']['rate_limit'] ?? ['enabled' => false];`
	`201`	`+ if (!($rateLimit['enabled'] ?? false)) {`
`197`	`202`	`return false;`
`198`	`203`	`}`
`199`	`204`
`200`	`205`	`$key = "simple_otp_rate_limit:{$identifier}";`
`201`		`-`
`202`		`- return RateLimiter::tooManyAttempts($key, $this->config['rate_limit']['max_attempts']);`
	`206`	`+ $max = $rateLimit['max_attempts'] ?? 5;`
	`207`	`+ return RateLimiter::tooManyAttempts($key, $max);`
`203`	`208`	`}`
`204`	`209`
`205`	`210`	`protected function incrementRateLimit(string $identifier): void`
`206`	`211`	`{`
`207`		`- if (!$this->config['rate_limit']['enabled']) {`
	`212`	`+ $rateLimit = $this->config['otp']['rate_limit'] ?? ['enabled' => false];`
	`213`	`+ if (!($rateLimit['enabled'] ?? false)) {`
`208`	`214`	`return;`
`209`	`215`	`}`
`210`	`216`
`211`	`217`	`$key = "simple_otp_rate_limit:{$identifier}";`
`212`		`- $decayMinutes = $this->config['rate_limit']['decay_minutes'];`
	`218`	`+ $decayMinutes = $rateLimit['decay_minutes'] ?? 60;`
`213`	`219`
`214`	`220`	`RateLimiter::hit($key, $decayMinutes * 60);`
`215`	`221`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,9 +8,9 @@`
`8`	`8`	`class CacheStorage implements OTPStorageContract`
`9`	`9`	`{`
`10`	`10`	`protected Repository $cache;`
`11`		`- protected string $store;`
	`11`	`+ protected ?string $store;`
`12`	`12`
`13`		`- public function __construct(Repository $cache, string $store = 'default')`
	`13`	`+ public function __construct(Repository $cache, ?string $store = null)`
`14`	`14`	`{`
`15`	`15`	`$this->cache = $cache;`
`16`	`16`	`$this->store = $store;`
`@@ -81,6 +81,7 @@ public function cleanup(): int`
`81`	`81`
`82`	`82`	`protected function getKey(string $identifier): string`
`83`	`83`	`{`
`84`		`- return "simple_otp:{$this->store}:{$identifier}";`
	`84`	`+ $storePrefix = $this->store ? "{$this->store}:" : '';`
	`85`	`+ return "simple_otp:{$storePrefix}{$identifier}";`
`85`	`86`	`}`
`86`	`87`	`}`