From eff2d7ff15c8b240e4dce8934bff0015d886d981 Mon Sep 17 00:00:00 2001
From: Aditya Tripathi <aditya@climactic.co>
Date: Fri, 29 Nov 2024 15:21:13 +0000
Subject: [PATCH] feat: add event dispatching for credit transactions

---
 src/Events/CreditsAdded.php       | 14 ++++++++
 src/Events/CreditsDeducted.php    | 14 ++++++++
 src/Events/CreditsTransferred.php | 16 +++++++++
 src/Traits/HasCredits.php         | 54 +++++++++++++++++++++++++++----
 4 files changed, 91 insertions(+), 7 deletions(-)
 create mode 100644 src/Events/CreditsAdded.php
 create mode 100644 src/Events/CreditsDeducted.php
 create mode 100644 src/Events/CreditsTransferred.php

diff --git a/src/Events/CreditsAdded.php b/src/Events/CreditsAdded.php
new file mode 100644
index 0000000..f18082d
--- /dev/null
+++ b/src/Events/CreditsAdded.php
@@ -0,0 +1,14 @@
+<?php
+
+namespace Climactic\Credits\Events;
+
+class CreditsAdded
+{
+    public function __construct(
+        public $creditable,
+        public float $amount,
+        public float $newBalance,
+        public ?string $description,
+        public array $metadata
+    ) {}
+}
diff --git a/src/Events/CreditsDeducted.php b/src/Events/CreditsDeducted.php
new file mode 100644
index 0000000..b7fa6e8
--- /dev/null
+++ b/src/Events/CreditsDeducted.php
@@ -0,0 +1,14 @@
+<?php
+
+namespace Climactic\Credits\Events;
+
+class CreditsDeducted
+{
+    public function __construct(
+        public $creditable,
+        public float $amount,
+        public float $newBalance,
+        public ?string $description,
+        public array $metadata
+    ) {}
+}
diff --git a/src/Events/CreditsTransferred.php b/src/Events/CreditsTransferred.php
new file mode 100644
index 0000000..7e8e193
--- /dev/null
+++ b/src/Events/CreditsTransferred.php
@@ -0,0 +1,16 @@
+<?php
+
+namespace Climactic\Credits\Events;
+
+class CreditsTransferred
+{
+    public function __construct(
+        public $sender,
+        public $recipient,
+        public float $amount,
+        public float $senderNewBalance,
+        public float $recipientNewBalance,
+        public ?string $description,
+        public array $metadata
+    ) {}
+}
diff --git a/src/Traits/HasCredits.php b/src/Traits/HasCredits.php
index 7334a71..1a91e08 100644
--- a/src/Traits/HasCredits.php
+++ b/src/Traits/HasCredits.php
@@ -7,6 +7,9 @@
 use Illuminate\Database\Eloquent\Relations\MorphMany;
 use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\DB;
+use Climactic\Credits\Events\CreditsAdded;
+use Climactic\Credits\Events\CreditsDeducted;
+use Climactic\Credits\Events\CreditsTransferred;
 
 trait HasCredits
 {
@@ -28,13 +31,23 @@ public function addCredits(float $amount, ?string $description = null, array $me
         $currentBalance = $this->getCurrentBalance();
         $newBalance = $currentBalance + $amount;
 
-        return $this->creditTransactions()->create([
+        $credit = $this->creditTransactions()->create([
             'amount' => $amount,
             'description' => $description,
             'type' => 'credit',
             'metadata' => $metadata,
             'running_balance' => $newBalance,
         ]);
+
+        event(new CreditsAdded(
+            creditable: $this,
+            amount: $amount,
+            newBalance: $newBalance,
+            description: $description,
+            metadata: $metadata
+        ));
+
+        return $credit;
     }
 
     /**
@@ -54,13 +67,23 @@ public function deductCredits(float $amount, ?string $description = null, array
             throw new InsufficientCreditsException($amount, $currentBalance);
         }
 
-        return $this->creditTransactions()->create([
+        $credit = $this->creditTransactions()->create([
             'amount' => $amount,
             'description' => $description,
             'type' => 'debit',
             'metadata' => $metadata,
             'running_balance' => $newBalance,
         ]);
+
+        event(new CreditsDeducted(
+            creditable: $this,
+            amount: $amount,
+            newBalance: $newBalance,
+            description: $description,
+            metadata: $metadata
+        ));
+
+        return $credit;
     }
 
     /**
@@ -86,15 +109,32 @@ public function getCurrentBalance(): float
      */
     public function transferCredits(self $recipient, float $amount, ?string $description = null, array $metadata = []): array
     {
-        DB::transaction(function () use ($recipient, $amount, $description, $metadata) {
+        $result = [];
+
+        DB::transaction(function () use ($recipient, $amount, $description, $metadata, &$result) {
             $this->deductCredits($amount, $description, $metadata);
             $recipient->addCredits($amount, $description, $metadata);
+
+            $senderBalance = $this->getCurrentBalance();
+            $recipientBalance = $recipient->getCurrentBalance();
+
+            event(new CreditsTransferred(
+                sender: $this,
+                recipient: $recipient,
+                amount: $amount,
+                senderNewBalance: $senderBalance,
+                recipientNewBalance: $recipientBalance,
+                description: $description,
+                metadata: $metadata
+            ));
+
+            $result = [
+                'sender_balance' => $senderBalance,
+                'recipient_balance' => $recipientBalance,
+            ];
         });
 
-        return [
-            'sender_balance' => $this->getCurrentBalance(),
-            'recipient_balance' => $recipient->getCurrentBalance(),
-        ];
+        return $result;
     }
 
     /**