refactor: currency exchange logic

README.md

@@ -96,22 +96,22 @@ Of course, you may use any service you wish to retrieve currency exchange rates.
 ],
 ```
 
-Additionally, you may update the following method in the `app/Services/CurrencyService.php` file which is responsible for retrieving the exchange rate:
+Additionally, you may update the following method in the `app/Services/CurrencyService.php` file which is responsible for retrieving the exchange rates:
 
 ```php
-public function getExchangeRate($from, $to)
+public function getExchangeRates($base)
 {
     $api_key = config('services.currency_api.key');
     $base_url = config('services.currency_api.base_url');
 
-    $req_url = "{$base_url}/{$api_key}/pair/{$from}/{$to}";
+    $req_url = "{$base_url}/{$api_key}/latest/{$base}";
 
     $response = Http::get($req_url);
 
     if ($response->successful()) {
         $responseData = $response->json();
-        if (isset($responseData['conversion_rate'])) {
-            return $responseData['conversion_rate'];
+        if (isset($responseData['conversion_rates'])) {
+            return $responseData['conversion_rates'];
         }
     }
 

app/Events/DefaultCurrencyChanged.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace App\Events;
+
+use App\Models\Setting\Currency;
+use Illuminate\Broadcasting\InteractsWithSockets;
+use Illuminate\Foundation\Events\Dispatchable;
+use Illuminate\Queue\SerializesModels;
+
+class DefaultCurrencyChanged
+{
+    use Dispatchable, InteractsWithSockets, SerializesModels;
+
+    public Currency $currency;
+
+    /**
+     * Create a new event instance.
+     */
+    public function __construct(Currency $currency)
+    {
+        $this->currency = $currency;
+    }
+}

app/Filament/Company/Resources/Setting/CurrencyResource.php

@@ -7,10 +7,10 @@ use App\Models\Banking\Account;
 use App\Models\Setting\Currency;
 use App\Services\CurrencyService;
 use App\Traits\ChecksForeignKeyConstraints;
+use Closure;
 use Filament\Forms\Form;
 use Filament\Notifications\Notification;
 use Filament\Resources\Resource;
-use Filament\Support\Colors\Color;
 use Filament\Tables\Table;
 use Filament\{Forms, Tables};
 use Illuminate\Database\Eloquent\Collection;
@@ -41,28 +41,23 @@ class CurrencyResource extends Resource
                             ->placeholder('Select a currency code...')
                             ->live()
                             ->required()
-                            ->hidden(static fn (Forms\Get $get): bool => $get('enabled'))
+                            ->hidden(static fn (Forms\Get $get, $state): bool => $get('enabled') && $state !== null)
                             ->afterStateUpdated(static function (Forms\Set $set, $state) {
                                 if ($state === null) {
                                     return;
                                 }
 
-                                $code = $state;
+                                $defaultCurrencyCode = Currency::getDefaultCurrencyCode();
+                                $currencyService = app(CurrencyService::class);
 
+                                $code = $state;
                                 $allCurrencies = Currency::getAllCurrencies();
-
                                 $selectedCurrencyCode = $allCurrencies[$code] ?? [];
 
-                                $currencyService = app(CurrencyService::class);
-                                $defaultCurrencyCode = Currency::getDefaultCurrencyCode();
-                                $rate = 1;
-
-                                if ($defaultCurrencyCode !== null) {
-                                    $rate = $currencyService->getCachedExchangeRate($defaultCurrencyCode, $code);
-                                }
+                                $rate = $defaultCurrencyCode ? $currencyService->getCachedExchangeRate($defaultCurrencyCode, $code) : 1;
 
                                 $set('name', $selectedCurrencyCode['name'] ?? '');
-                                $set('rate', $rate);
+                                $set('rate', $rate ?? '');
                                 $set('precision', $selectedCurrencyCode['precision'] ?? '');
                                 $set('symbol', $selectedCurrencyCode['symbol'] ?? '');
                                 $set('symbol_first', $selectedCurrencyCode['symbol_first'] ?? '');
@@ -71,7 +66,7 @@ class CurrencyResource extends Resource
                             }),
                         Forms\Components\TextInput::make('code')
                             ->label('Code')
-                            ->hidden(static fn (Forms\Get $get): bool => ! $get('enabled'))
+                            ->hidden(static fn (Forms\Get $get): bool => !($get('enabled') && $get('code') !== null))
                             ->disabled(static fn (Forms\Get $get): bool => $get('enabled'))
                             ->required(),
                         Forms\Components\TextInput::make('name')
@@ -80,14 +75,14 @@ class CurrencyResource extends Resource
                             ->required(),
                         Forms\Components\TextInput::make('rate')
                             ->label('Rate')
-                            ->dehydrateStateUsing(static fn (Forms\Get $get, $state): float => $get('enabled') ? '1.0' : (float) $state)
                             ->numeric()
+                            ->rule('gt:0')
                             ->live()
-                            ->disabled(static fn (Forms\Get $get): bool => $get('enabled'))
                             ->required(),
                         Forms\Components\Select::make('precision')
                             ->label('Precision')
-                            ->searchable()
+                            ->native(false)
+                            ->selectablePlaceholder(false)
                             ->placeholder('Select a precision...')
                             ->options(['0', '1', '2', '3', '4'])
                             ->required(),
@@ -97,8 +92,10 @@ class CurrencyResource extends Resource
                             ->required(),
                         Forms\Components\Select::make('symbol_first')
                             ->label('Symbol Position')
-                            ->searchable()
-                            ->boolean('Before Amount', 'After Amount', 'Select the currency symbol position...')
+                            ->native(false)
+                            ->selectablePlaceholder(false)
+                            ->formatStateUsing(static fn($state) => isset($state) ? (int) $state : null)
+                            ->boolean('Before Amount', 'After Amount', 'Select a symbol position...')
                             ->required(),
                         Forms\Components\TextInput::make('decimal_mark')
                             ->label('Decimal Separator')
@@ -107,29 +104,39 @@ class CurrencyResource extends Resource
                         Forms\Components\TextInput::make('thousands_separator')
                             ->label('Thousands Separator')
                             ->maxLength(1)
-                            ->required(),
+                            ->rule(static function (Forms\Get $get): Closure {
+                                return static function ($attribute, $value, Closure $fail) use ($get) {
+                                    $decimalMark = $get('decimal_mark');
+
+                                    if ($value === $decimalMark) {
+                                        $fail('The thousands separator and decimal separator must be different.');
+                                    }
+                                };
+                            })
+                            ->nullable(),
                         ToggleButton::make('enabled')
                             ->label('Default Currency')
                             ->live()
-                            ->offColor(Color::Red)
-                            ->onColor(Color::Indigo)
+                            ->offColor('danger')
+                            ->onColor('primary')
                             ->afterStateUpdated(static function (Forms\Set $set, Forms\Get $get, $state) {
-                                $enabled = $state;
+                                $enabledState = (bool)$state;
                                 $code = $get('code');
+
+                                $defaultCurrencyCode = Currency::getDefaultCurrencyCode();
                                 $currencyService = app(CurrencyService::class);
 
-                                if ($enabled) {
-                                    $rate = 1;
+                                if ($enabledState) {
+                                    $set('rate', 1);
                                 } else {
                                     if ($code === null) {
                                         return;
                                     }
 
-                                    $defaultCurrencyCode = Currency::getDefaultCurrencyCode();
-                                    $rate = $defaultCurrencyCode ? $currencyService->getCachedExchangeRate($defaultCurrencyCode, $code) : 1;
-                                }
+                                    $rate = $currencyService->getCachedExchangeRate($defaultCurrencyCode, $code);
 
-                                $set('rate', $rate);
+                                    $set('rate', $rate ?? '');
+                                }
                             }),
                     ])->columns(),
             ]);

app/Filament/Company/Resources/Setting/CurrencyResource/Pages/EditCurrency.php

@@ -2,7 +2,9 @@
 
 namespace App\Filament\Company\Resources\Setting\CurrencyResource\Pages;
 
+use App\Events\DefaultCurrencyChanged;
 use App\Filament\Company\Resources\Setting\CurrencyResource;
+use App\Models\Setting\Currency;
 use App\Traits\HandlesResourceRecordUpdate;
 use Filament\Actions;
 use Filament\Resources\Pages\EditRecord;
@@ -38,7 +40,7 @@ class EditCurrency extends EditRecord
     /**
      * @throws Halt
      */
-    protected function handleRecordUpdate(Model $record, array $data): Model
+    protected function handleRecordUpdate(Model|Currency $record, array $data): Model|Currency
     {
         $user = Auth::user();
 
@@ -46,6 +48,10 @@ class EditCurrency extends EditRecord
             throw new Halt('No authenticated user found');
         }
 
+        if ($data['enabled'] && ! $record->enabled) {
+            event(new DefaultCurrencyChanged($record));
+        }
+
         return $this->handleRecordUpdateWithUniqueField($record, $data, $user);
     }
 }

app/Listeners/UpdateCurrencyRates.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace App\Listeners;
+
+use App\Events\DefaultCurrencyChanged;
+use App\Models\Setting\Currency;
+use App\Services\CurrencyService;
+
+class UpdateCurrencyRates
+{
+    /**
+     * Create the event listener.
+     */
+    public function __construct()
+    {
+        //
+    }
+
+    /**
+     * Handle the event.
+     */
+    public function handle(DefaultCurrencyChanged $event): void
+    {
+        $currencyService = app(CurrencyService::class);
+
+        $currencies = Currency::where('code', '!=', $event->currency->code)->get();
+
+        foreach ($currencies as $currency) {
+            $newRate = $currencyService->getCachedExchangeRate($event->currency->code, $currency->code);
+
+            if ($newRate !== null) {
+                $currency->update(['rate' => $newRate]);
+            }
+        }
+    }
+}

app/Models/Setting/Currency.php

@@ -10,7 +10,6 @@ use Database\Factories\Setting\CurrencyFactory;
 use Illuminate\Database\Eloquent\Factories\{Factory, HasFactory};
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\{BelongsTo, HasMany, HasOne};
-use Illuminate\Support\Facades\DB;
 use Wallo\FilamentCompanies\FilamentCompanies;
 
 class Currency extends Model
@@ -102,21 +101,14 @@ class Currency extends Model
         $oldCurrency = $currencies->firstWhere('code', $oldCurrency);
         $newCurrency = $currencies->firstWhere('code', $newCurrency);
 
-        $oldRate = DB::table('currencies')
-            ->where('code', $oldCurrency->code)
-            ->value('rate');
-
-        $newRate = DB::table('currencies')
-            ->where('code', $newCurrency->code)
-            ->value('rate');
-
-        $precision = max($oldCurrency->precision, $newCurrency->precision);
-
-        $scale = 10 ** $precision;
+        $oldRate = $oldCurrency->rate;
+        $newRate = $newCurrency->rate;
 
         $cleanBalance = (int) filter_var($balance, FILTER_SANITIZE_NUMBER_INT);
 
-        return round(($cleanBalance * $newRate * $scale) / ($oldRate * $scale));
+        $convertedBalance = ($cleanBalance / $oldRate) * $newRate;
+
+        return round($convertedBalance);
     }
 
     protected static function newFactory(): Factory

app/Providers/EventServiceProvider.php

@@ -2,8 +2,12 @@
 
 namespace App\Providers;
 
-use App\Events\{CompanyDefaultEvent, CompanyDefaultUpdated, CompanyGenerated};
-use App\Listeners\{ConfigureCompanyDefault, CreateCompanyDefaults, SyncAssociatedModels, SyncWithCompanyDefaults};
+use App\Events\{CompanyDefaultEvent, CompanyDefaultUpdated, CompanyGenerated, DefaultCurrencyChanged};
+use App\Listeners\{ConfigureCompanyDefault,
+    CreateCompanyDefaults,
+    SyncAssociatedModels,
+    SyncWithCompanyDefaults,
+    UpdateCurrencyRates};
 use Filament\Events\TenantSet;
 use Illuminate\Auth\Events\Registered;
 use Illuminate\Auth\Listeners\SendEmailVerificationNotification;
@@ -32,6 +36,9 @@ class EventServiceProvider extends ServiceProvider
         CompanyGenerated::class => [
             CreateCompanyDefaults::class,
         ],
+        DefaultCurrencyChanged::class => [
+            UpdateCurrencyRates::class,
+        ],
     ];
 
     /**

app/Services/CurrencyService.php

@@ -6,43 +6,50 @@ use Illuminate\Support\Facades\{Cache, Http};
 
 class CurrencyService
 {
-    public function getExchangeRate($from, $to)
+    public function getExchangeRates($base)
     {
         $api_key = config('services.currency_api.key');
         $base_url = config('services.currency_api.base_url');
 
-        $req_url = "{$base_url}/{$api_key}/pair/{$from}/{$to}";
+        $req_url = "{$base_url}/{$api_key}/latest/{$base}";
 
         $response = Http::get($req_url);
 
         if ($response->successful()) {
             $responseData = $response->json();
-            if (isset($responseData['conversion_rate'])) {
-                return $responseData['conversion_rate'];
+            if (isset($responseData['conversion_rates'])) {
+                return $responseData['conversion_rates'];
             }
         }
 
         return null;
     }
 
-    public function getCachedExchangeRate(string $defaultCurrencyCode, string $code): ?float
+    public function updateCachedExchangeRates(string $base): void
     {
-        $cacheKey = 'currency_data_' . $defaultCurrencyCode . '_' . $code;
+        $rates = $this->getExchangeRates($base);
 
-        $cachedData = Cache::get($cacheKey);
+        if ($rates !== null) {
+            $expirationTimeInSeconds = 60 * 60 * 24; // 1 day (24 hours)
 
-        if ($cachedData !== null) {
-            return $cachedData['rate'];
+            foreach ($rates as $code => $rate) {
+                $cacheKey = 'currency_data_' . $base . '_' . $code;
+                Cache::put($cacheKey, $rate, $expirationTimeInSeconds);
+            }
         }
+    }
+
+    public function getCachedExchangeRate(string $defaultCurrencyCode, string $code): ?float
+    {
+        $cacheKey = 'currency_data_' . $defaultCurrencyCode . '_' . $code;
 
-        $rate = $this->getExchangeRate($defaultCurrencyCode, $code);
+        $cachedRate = Cache::get($cacheKey);
 
-        if ($rate !== null) {
-            $dataToCache = compact('rate');
-            $expirationTimeInSeconds = 60 * 60 * 24; // 24 hours
-            Cache::put($cacheKey, $dataToCache, $expirationTimeInSeconds);
+        if ($cachedRate === null) {
+            $this->updateCachedExchangeRates($defaultCurrencyCode);
+            $cachedRate = Cache::get($cacheKey);
         }
 
-        return $rate;
+        return $cachedRate;
     }
 }

config/money.php

@@ -1464,6 +1464,17 @@ return [
             'thousands_separator' => ',',
         ],
 
+        'STN' => [
+            'name' => 'Dobra',
+            'code' => 930,
+            'precision' => 2,
+            'subunit' => 100,
+            'symbol' => 'Db',
+            'symbol_first' => false,
+            'decimal_mark' => '.',
+            'thousands_separator' => ',',
+        ],
+
         'SVC' => [
             'name' => 'El Salvador Colon',
             'code' => 222,

database/migrations/2023_09_03_032820_create_currencies_table.php

@@ -21,7 +21,7 @@ return new class extends Migration
             $table->string('symbol')->default('$');
             $table->boolean('symbol_first')->default(true);
             $table->string('decimal_mark')->default('.');
-            $table->string('thousands_separator')->default(',');
+            $table->string('thousands_separator')->nullable();
             $table->boolean('enabled')->default(true);
             $table->foreignId('created_by')->nullable()->constrained('users')->nullOnDelete();
             $table->foreignId('updated_by')->nullable()->constrained('users')->nullOnDelete();