Add support for multiple currencies

.vscode/settings.json

@@ -11,24 +11,31 @@
     },
     "intelephense.environment.phpVersion": "8.0.0",
     "cSpell.ignoreWords": [
-        "alpinejs",
-        "fontawesome",
-        "fortawesome",
-        "yaireo",
         "Authenticatable",
         "Authorizable",
         "Cviebrock",
         "Dyrynda",
         "Gumlet",
+        "Laravel",
+        "Livewire",
+        "Lorisleiva",
         "Maatwebsite",
         "Propaganistas",
         "Sluggable",
         "Spatie",
+        "Stringable",
         "Torann",
+        "Twilio",
+        "alpinejs",
         "commentable",
         "donatj",
+        "fontawesome",
+        "fortawesome",
         "geoblock",
         "libphonenumber",
-        "taggables"
-    ],
+        "livewire",
+        "sluggable",
+        "taggables",
+        "yaireo"
+    ]
 }

app/Actions/BaseCancelOrder.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace App\Actions;
+
+use App\Dto\CostsDto;
+use App\Models\Order;
+use Lorisleiva\Actions\Concerns\AsAction;
+
+abstract class BaseCancelOrder
+{
+    use AsAction;
+
+    public function handle(Order $order): void
+    {
+        $order->status = 'cancelled';
+        $order->save();
+
+        if ($order->customer != null) {
+            $order->getCosts()->each(fn (CostsDto $costs) => $order->customer->addBalance($costs->currency_id, $costs->value));
+        }
+
+        $this->after($order);
+    }
+
+    abstract protected function after(Order $order): void;
+}

app/Actions/CancelOrder.php

@@ -3,29 +3,21 @@
 namespace App\Actions;
 
 use App\Models\Order;
-use Lorisleiva\Actions\Concerns\AsAction;
+use Illuminate\Support\Facades\Log;
 
-class CancelOrder
+class CancelOrder extends BaseCancelOrder
 {
-    use AsAction;
-
-    public function handle(Order $order): void
-    {
-        $order->status = 'cancelled';
-        $order->save();
-
-        if ($order->customer != null) {
-            $startingCredit = setting()->get('customer.starting_credit', config('shop.customer.starting_credit'));
-            $maximum = setting()->get('customer.credit_top_up.maximum', $startingCredit);
-            $order->customer->credit = max($order->customer->credit, min($order->customer->credit + $order->costs, $maximum));
-            $order->customer->save();
-        }
-
-        $this->notify($order);
-    }
-
-    protected function notify(Order $order): void
+    protected function after(Order $order): void
     {
-        // NOOP
+        Log::info('Customer cancelled order.', [
+            'event.kind' => 'event',
+            'event.outcome' => 'success',
+            'customer.name' => $order->customer?->name,
+            'customer.id_number' => $order->customer?->id_number,
+            'customer.phone' => $order->customer?->phone,
+            'customer.balance' => $order->customer?->totalBalance(),
+            'order.id' => $order->id,
+            'order.costs' => $order->getCostsString(),
+        ]);
     }
 }

app/Actions/ModifyOrder.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace App\Actions;
+
+use App\Models\Order;
+use Illuminate\Support\Collection;
+use Illuminate\Support\Facades\Log;
+use Lorisleiva\Actions\Concerns\AsAction;
+
+class ModifyOrder
+{
+    use AsAction;
+
+    /**
+     * @param  Order  $order
+     * @param  Collection<int,int>  $items
+     * @return void
+     */
+    public function handle(
+        Order $order,
+        Collection $items,
+    ): void {
+
+        // TODO: Check customer balance
+
+        $order->assignProducts($items);
+
+        // TODO: Update customer balance
+
+        Log::info('Updated order.', [
+            'event.kind' => 'event',
+            'event.outcome' => 'success',
+            'customer.name' => $order->customer?->name,
+            'customer.id_number' => $order->customer?->id_number,
+            'customer.phone' => $order->customer?->phone,
+            'customer.balance' => $order->customer?->totalBalance(),
+            'order.id' => $order->id,
+            'order.costs' => $order->getCostsString(),
+        ]);
+    }
+}

app/Actions/RegisterOrder.php

@@ -0,0 +1,136 @@
+<?php
+
+namespace App\Actions;
+
+use App\Dto\CostsDto;
+use App\Exceptions\EmptyOrderException;
+use App\Exceptions\InsufficientBalanceException;
+use App\Exceptions\PhoneNumberBlockedByAdminException;
+use App\Models\Customer;
+use App\Models\Order;
+use App\Models\Product;
+use App\Notifications\OrderRegistered;
+use Exception;
+use Illuminate\Support\Collection;
+use Illuminate\Support\Facades\Log;
+use Lorisleiva\Actions\Concerns\AsAction;
+
+class RegisterOrder
+{
+    use AsAction;
+
+    /**
+     * @param  Customer  $customer
+     * @param  Collection<int,int>  $items
+     * @param  ?string  $remarks
+     * @return Order
+     *
+     * @throws EmptyOrderException
+     * @throws InsufficientBalanceException
+     */
+    public function handle(
+        Customer $customer,
+        Collection $items,
+        ?string $remarks = null,
+        string $logMessage = 'An order has been registered.',
+        bool $notifyCustomer = false,
+        bool $ignoreCosts = false,
+    ): Order {
+        $this->ensureAnyItemsDefined($items);
+        if (! $ignoreCosts) {
+            $this->checkBalance($customer, $items);
+        }
+
+        // TODO: Check product availability
+
+        $order = $this->createOrder($customer, $remarks);
+        $order->assignProducts($items);
+        if (! $ignoreCosts) {
+            $this->subtractCosts($customer, $order);
+        }
+
+        Log::info($logMessage, [
+            'event.kind' => 'event',
+            'event.outcome' => 'success',
+            'customer.name' => $customer->name,
+            'customer.id_number' => $customer->id_number,
+            'customer.phone' => $customer->phone,
+            'customer.balance' => $customer->totalBalance(),
+            'order.id' => $order->id,
+            'order.costs' => $order->getCostsString(),
+        ]);
+
+        if ($notifyCustomer) {
+            $this->notifyCustomer($customer, $order);
+        }
+
+        return $order;
+    }
+
+    /**
+     * @param  Collection<int,int>  $items
+     */
+    private function ensureAnyItemsDefined(Collection $items)
+    {
+        $items = $items->filter(fn ($quantity) => is_numeric($quantity) && $quantity > 0);
+        if ($items->isEmpty()) {
+            throw new EmptyOrderException(__('No products have been selected.'));
+        }
+    }
+
+    /**
+     * @param  Customer  $customer
+     * @param  Collection<int,int>  $items
+     * @return void
+     */
+    private function checkBalance(Customer $customer, Collection $items): void
+    {
+        foreach ($customer->currencies as $currency) {
+            $basketCosts = (int) $items
+                ->map(function (int $quantity, int $productId) use ($currency) {
+                    $product = Product::find($productId);
+
+                    return ($product->currency_id == $currency->id) ? $product->price * $quantity : 0;
+                })
+                ->sum();
+            $balance = $customer->getBalance($currency);
+            if ($balance < $basketCosts) {
+                throw new InsufficientBalanceException(__('Insufficient account balance. :required :currency required, but only :available available.', [
+                    'currency' => $currency->name,
+                    'required' => $basketCosts,
+                    'available' => $balance,
+                ]));
+            }
+        }
+    }
+
+    private function createOrder(Customer $customer, ?string $remarks): Order
+    {
+        $order = new Order();
+        $order->fill([
+            'remarks' => $remarks,
+            'ip_address' => request()->ip(),
+            'user_agent' => request()->userAgent(),
+        ]);
+        $order->customer()->associate($customer);
+        $order->save();
+
+        return $order;
+    }
+
+    private function subtractCosts(Customer $customer, Order $order)
+    {
+        $order->getCosts()->each(fn (CostsDto $costs) => $customer->subtractBalance($costs->currency_id, $costs->value));
+    }
+
+    private function notifyCustomer(Customer $customer, Order $order)
+    {
+        try {
+            $customer->notify(new OrderRegistered($order));
+        } catch (PhoneNumberBlockedByAdminException $ex) {
+            Log::warning("The phone number {$ex->getPhone()} has been blocked by an administrator.");
+        } catch (Exception $ex) {
+            Log::warning('['.get_class($ex).'] Cannot send notification: '.$ex->getMessage());
+        }
+    }
+}

app/Actions/RejectOrder.php

@@ -5,9 +5,9 @@
 use App\Models\Order;
 use App\Notifications\OrderCancelled;
 
-class RejectOrder extends CancelOrder
+class RejectOrder extends BaseCancelOrder
 {
-    protected function notify(Order $order): void
+    protected function after(Order $order): void
     {
         if ($order->customer != null) {
             $order->customer->notify(new OrderCancelled($order));