Add Reference and Detail to Logs

Author: 3m1n3nc3

config/pay-pocket.php

@@ -2,5 +2,11 @@
 
 // config for HPWebdeveloper/LaravelPayPocket
 return [
-
-];
+    'log_reference_length' => 12,
+    'log_reference_prefix' => null,
+    /**
+     * The log reference generator should be static
+     * The third array item should contain optional parameters to pass to the generator
+     */
+    'log_reference_generator' => [\Illuminate\Support\Str::class, 'random', [15]],
+];

src/LaravelPayPocketServiceProvider.php

@@ -30,5 +30,16 @@ public function bootingPackage()
         $this->publishes([
             __DIR__ . '/../Enums/' => app_path('Enums'),
         ], 'pay-pocket-wallets');
+
+
+        $this->publishes([
+            __DIR__ . '/../config/pay-pocket.php' => config_path('pay-pocket.php'),
+        ], 'config');
+    }
+
+    public function registeringPackage()
+    {
+        // Automatically apply the package configuration
+        $this->mergeConfigFrom(__DIR__ . '/../config/pay-pocket.php', 'pay-pocket');
     }
 }

src/Traits/BalanceOperation.php

@@ -2,54 +2,64 @@
 
 namespace HPWebdeveloper\LaravelPayPocket\Traits;
 
+use Illuminate\Support\Str;
+
 trait BalanceOperation
 {
     protected $createdLog;
 
     /**
-     *	Check if Balance is more than zero.
+     *  Check if Balance is more than zero.
      */
     public function hasBalance(): bool
     {
         return $this->balance > 0;
     }
 
     /**
-     *	Decrement Balance and create a log entry.
+     *  Decrement Balance and create a log entry.
      */
-    public function decrementAndCreateLog($value): void
+    public function decrementAndCreateLog($value, $detail = null): void
     {
-        $this->createLog('dec', $value);
+        $this->createLog('dec', $value, $detail);
         $this->decrement('balance', $value);
     }
 
     /**
-     *	Increment Balance and create a log entry.
+     *  Increment Balance and create a log entry.
      */
-    public function incrementAndCreateLog($value): void
+    public function incrementAndCreateLog($value, $detail = null): void
     {
-        $this->createLog('inc', $value);
+        $this->createLog('inc', $value, $detail);
         $this->increment('balance', $value);
     }
 
     /**
-     *	Create a new log record
+     *  Create a new log record
      */
-    protected function createLog($logType, $value): void
+    protected function createLog($logType, $value, $detail = null): void
     {
         $currentBalance = $this->balance ?? 0;
 
         $newBalance = $logType === 'dec' ? $currentBalance - $value : $currentBalance + $value;
 
+        $refGen = config('pay-pocket.log_reference_generator', [Str::class, 'random', [12]]);
+        $reference = config('pay-pocket.reference_string_prefix', '');
+        $reference .= isset($refGen[0], $refGen[1])
+            ? $refGen[0]::{$refGen[1]}(...$refGen[2] ?? [])
+            : Str::random(config('pay-pocket.log_reference_length', 12));
+
         $this->createdLog = $this->logs()->create([
             'wallet_name' => $this->type->value,
             'from' => $currentBalance,
             'to' => $newBalance,
             'type' => $logType,
             'ip' => \Request::ip(),
             'value' => $value,
+            'detail' => $detail,
+            'reference' => $reference
         ]);
 
         $this->createdLog->changeStatus('Done');
     }
-}
+}

src/Traits/HandlesDeposit.php

@@ -15,7 +15,7 @@ trait HandlesDeposit
     /**
      * Deposit an amount to the user's wallet of a specific type.
      */
-    public function deposit(string $type, int|float $amount): bool
+    public function deposit(string $type, int|float $amount, $detail = null): bool
     {
         $depositable = $this->getDepositableTypes();
 
@@ -27,10 +27,10 @@ public function deposit(string $type, int|float $amount): bool
             throw new InvalidValueException();
         }
 
-        DB::transaction(function () use ($type, $amount) {
+        DB::transaction(function () use ($type, $amount, $detail) {
             $type = WalletEnums::tryFrom($type);
             $wallet = $this->wallets()->firstOrCreate(['type' => $type]);
-            $wallet->incrementAndCreateLog($amount);
+            $wallet->incrementAndCreateLog($amount, $detail);
         });
 
         return true;
@@ -63,4 +63,4 @@ private function isRequestValid($type, array $depositable)
 
         return true;
     }
-}
+}

src/Traits/HandlesPayment.php

@@ -13,13 +13,13 @@ trait HandlesPayment
      *
      * @throws InsufficientBalanceException
      */
-    public function pay(int|float $orderValue): void
+    public function pay(int|float $orderValue, $detail = null): void
     {
         if (! $this->hasSufficientBalance($orderValue)) {
             throw new InsufficientBalanceException('Insufficient balance to cover the order.');
         }
 
-        DB::transaction(function () use ($orderValue) {
+        DB::transaction(function () use ($orderValue, $detail) {
             $remainingOrderValue = $orderValue;
 
             $walletsInOrder = $this->wallets()->whereIn('type', $this->walletsInOrder())->get();
@@ -30,7 +30,7 @@ public function pay(int|float $orderValue): void
                 }
 
                 $amountToDeduct = min($wallet->balance, $remainingOrderValue);
-                $wallet->decrementAndCreateLog($amountToDeduct);
+                $wallet->decrementAndCreateLog($amountToDeduct, $detail);
                 $remainingOrderValue -= $amountToDeduct;
 
                 if ($remainingOrderValue <= 0) {
@@ -43,4 +43,4 @@ public function pay(int|float $orderValue): void
             }
         });
     }
-}
+}

tests/OperationsWithFacadeTest.php

@@ -18,7 +18,6 @@
     expect(LaravelPayPocket::walletBalanceByType($user, 'wallet_2'))->toBeFloat(234.56);
 
     expect(LaravelPayPocket::checkBalance($user))->toBeFloat(234.56);
-
 });
 
 test('user can deposit two times', function () {
@@ -34,7 +33,6 @@
     expect(LaravelPayPocket::walletBalanceByType($user, 'wallet_2'))->toBeFloat(1023.68);
 
     expect(LaravelPayPocket::checkBalance($user))->toBeFloat(1023.68);
-
 });
 
 test('user can pay order', function () {
@@ -96,4 +94,4 @@
     expect(LaravelPayPocket::walletBalanceByType($user, 'wallet_2'))->toBeFloat(0.12);
 
     expect(LaravelPayPocket::checkBalance($user))->toBeFloat(0.12);
-});
+});