Create OTP without model

Author: pcsaini

README.md

@@ -17,7 +17,8 @@
 
 - [x] Generate OTP
 - [x] Verify OTP
-- [x] OTP Lists
+- [x] Methods
+- [ ] OTP Lists
 - [ ] Test Cases
 
 ## Features
@@ -35,6 +36,12 @@ You can install this package via composer using:
 composer require signaturetech/laravel-otp
 ```
 
+Next run the command below to setup api-response.config file, you can set your configuration.
+
+```
+php artisan vendor:publish --tag=otp-config
+```
+
 Now add the `use SignatureTech\LaravelOtp\Traits\Otpable` trait to your model.
 
 ```
@@ -58,7 +65,7 @@ use App\Models\User;
 $user = User::first();
 ```
 
-2. Create Otp Insatance
+2. Create Otp Instance
 
 ```
 use SignatureTech\LaravelOtp\Otp;
@@ -81,7 +88,7 @@ $otp = $user->otp;
 
 ### Verify OTP
 
-You can verifu otp by useing below code:
+You can verify otp by using below code:
 
 1. Get the use details
 
@@ -91,7 +98,7 @@ use App\Models\User;
 $user = User::first();
 ```
 
-2. Get Otp Insatance
+2. Get Otp Instance
 
 ```
 use SignatureTech\LaravelOtp\Otp;
@@ -112,6 +119,70 @@ try {
 }
 ```
 
+### Create OTP without model
+
+You can also create otp without model using the following:
+
+1. Create OTP
+
+```
+use SignatureTech\LaravelOtp\Otp;
+
+
+$otp = Otp::for($user->email)->create();
+```
+
+**Note:** You can use email/mobile/phone number to generate otp Just pass the detail using `for` method.
+
+**Note:** You can use more method to setting otp all methods described in `methods` section.
+
+2. Verify Otp
+
+```
+try {
+    $otp->verifyOtp($request->get('otp'));
+} catch (OtpInvalidException $e) {
+    return $e->getMessage;
+} catch (OtpExpiredException $e) {
+    return $e->getMessage;
+}
+```
+
+## Methods
+
+1. Set length of otp
+
+```
+use SignatureTech\LaravelOtp\Otp;
+
+// Set Length of OTP
+$otp = Otp::for($user->email)->setLength(4)->generate();
+```
+
+**Note:** Default length is 6 digit and you can change the default digit to add the `OTP_LENGTH=4` in `.env` or `config/otp.php` file
+
+2. Set Format (Available Format: alpha | alphanumeric | numeric)
+
+```
+use SignatureTech\LaravelOtp\Otp;
+
+// Set Format (Available Format: alpha | alphanumeric | numeric)
+$otp = Otp::for($user->email)->setFormat('numeric')->generate();
+```
+
+**Note:** Default format is numeric and you can change the default format to add the `OTP_FORMAT=4` in `.env` or `config/otp.php` file
+
+2. Set Expiry (In minutes)
+
+```
+use SignatureTech\LaravelOtp\Otp;
+
+// Set Format (Available Format: alpha | alphanumeric | numeric)
+$otp = Otp::for($user->email)->setExpiry(20)->generate();
+```
+
+**Note:** Default expiry is 10 minutes and you can change this to add the `OTP_EXPIRY=20` in `.env` or `config/otp.php` file
+
 ## License
 
 - Written and copyrighted ©2022 by Prem Chand Saini ([[email protected]](mailto:[email protected]))

database/migrations/2024_09_27_025709_add_event_to_otps_table.php

@@ -0,0 +1,32 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration
+{
+    /**
+     * Run the migrations.
+     */
+    public function up(): void
+    {
+        Schema::table(config('otp.table', 'otps'), function (Blueprint $table) {
+            $table->string('event')->after('otp')->nullable();
+            $table->bigInteger('model_id')->nullable()->change();
+            $table->string('model_type')->nullable()->change();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     */
+    public function down(): void
+    {
+        Schema::table(config('otp.table', 'otps'), function (Blueprint $table) {
+            $table->dropColumn('event');
+            $table->bigInteger('model_id')->change();
+            $table->string('model_type')->change();
+        });
+    }
+};

src/Models/Otp.php

@@ -2,8 +2,10 @@
 
 namespace SignatureTech\LaravelOtp\Models;
 
-use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+use SignatureTech\LaravelOtp\Exceptions\OtpExpiredException;
+use SignatureTech\LaravelOtp\Exceptions\OtpInvalidException;
 
 class Otp extends Model
 {
@@ -18,7 +20,8 @@ class Otp extends Model
         'receiver',
         'otp',
         'expired_at',
-        'used_at'
+        'used_at',
+        'event'
     ];
 
     /**
@@ -28,4 +31,20 @@ public function getOtp()
     {
         return $this->otp;
     }
+
+    public function verifyOtp($otp)
+    {
+        if (now()->gt($this->expired_at)) {
+            throw new OtpExpiredException(__('Otp Expired'));
+        }
+
+        if ($this->otp != $otp) {
+            throw new OtpInvalidException(__('Invalid Otp'));
+        }
+
+        $this->used_at = now();
+        $this->save();
+
+        return true;
+    }
 }

src/Otp.php

@@ -106,36 +106,67 @@ public function setFormat($format): self
     }
 
     /**
-     * @return OtpModel
+     *
+     * @return OtpModel|null
      */
-    public function generate()
+    public function checkOtp(): OtpModel|null
     {
-        // check exiting otp
-        $otp = OtpModel::query()
+        return OtpModel::query()
             ->where('receiver', $this->receiver)
             ->where('expired_at', '>=', now())
             ->whereNull('used_at')
             ->first();
+    }
+
+    /**
+     * @param string|null $event
+     * @return OtpModel
+     */
+    public function generate(string|null $event = null): OtpModel
+    {
+        // check exiting otp
+        $otp = $this->checkOtp();
 
         if ($otp) {
             return $otp;
         }
 
-        $this->generateOtp();
-
         $model = new OtpModel([
             'receiver' => $this->receiver,
+            'event' => $event,
             'otp' => app()->environment() == 'local' ? config('otp.default_otp') : $this->generateOtp(),
             'expired_at' => now()->addMinutes($this->expiry)
         ]);
 
         return $model;
     }
 
+    /**
+     * @param string|null $event
+     * @return OtpModel
+     */
+    public function create(string|null $event = null): OtpModel
+    {
+        $otp = $this->checkOtp();
+
+        if ($otp) {
+            return $otp;
+        }
+
+        $otp = OtpModel::create([
+            'receiver' => $this->receiver,
+            'event' => $event,
+            'otp' => app()->environment() == 'local' ? config('otp.default_otp') : $this->generateOtp(),
+            'expired_at' => now()->addMinutes($this->expiry)
+        ]);
+
+        return $otp;
+    }
+
     /**
      * @return mixed
      */
-    protected function generateOtp()
+    protected function generateOtp(): mixed
     {
         switch ($this->format) {
             case "alpha":
@@ -155,7 +186,7 @@ protected function generateOtp()
     /**
      * @return OtpModel
      */
-    public function getOtp()
+    public function getOtp(): OtpModel
     {
         $otp = OtpModel::query()
             ->where('receiver', $this->receiver)

src/Traits/Otpable.php

@@ -37,17 +37,6 @@ public function createOtp($otp)
      */
     public function verifyOtp($otpModel, $otp)
     {
-        if (now()->gt($otpModel->expired_at)) {
-            throw new OtpExpiredException(__('Otp Expired'));
-        }
-
-        if ($otpModel->otp != $otp) {
-            throw new OtpInvalidException(__('Invalid Otp'));
-        }
-
-        $otpModel->used_at = now();
-        $otpModel->save();
-
-        return true;
+        return $otpModel->verifyOtp($otp);
     }
 }