Feat: Adds multi currency support (#88)

2025-04-09 19:25:15 -05:00
parent 6d6f968f42
commit eae345f243
100 changed files with 17735 additions and 35761 deletions
@@ -0,0 +1,251 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Models;
+
+use App\Jobs\BatchInsertNewCurrencyRatesJob;
+use Carbon\CarbonPeriod;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Support\Arr;
+use Illuminate\Support\Carbon;
+use Investbrain\Frankfurter\Frankfurter;
+
+class CurrencyRate extends Model
+{
+    protected $hidden = [];
+
+    protected $primaryKey = 'currency';
+
+    protected $keyType = 'string';
+
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array
+     */
+    protected $fillable = [
+        'date',
+        'currency',
+        'rate',
+    ];
+
+    /**
+     * Get the attributes that should be cast.
+     *
+     * @return array<string, string>
+     */
+    protected function casts(): array
+    {
+        return [
+            'rate' => 'float',
+            'date' => 'date',
+            'created_at' => 'datetime',
+            'updated_at' => 'datetime',
+        ];
+    }
+
+    public static function current(string $currency): float
+    {
+        return (float) self::historic($currency);
+    }
+
+    /**
+     * Get historic rate for symbol
+     */
+    public static function historic(string $currency, mixed $date = null): float
+    {
+        // No need to convert
+        if ($currency === config('investbrain.base_currency')) {
+
+            return 1;
+        }
+
+        // If we don't need historic, let's use current rate
+        if (empty($date)) {
+
+            $date = now();
+        }
+
+        // Make sure we have a Carbon date
+        $date = Carbon::parse($date);
+
+        // Handle aliases
+        [$currency, $adjustment] = self::getCurrencyAliasAdjustments($currency);
+
+        // Get or create historic rate
+        $rate = self::select('rate')
+            ->whereDate('date', $date->toDateString())
+            ->where(['currency' => $currency])
+            ->firstOr(function () use ($date, $currency) {
+
+                $currencies = Currency::all()->pluck('currency')->toArray();
+
+                $rates = Frankfurter::setSymbols($currencies)->historical($date);
+
+                $date = Arr::get($rates, 'date');
+
+                $updates = Arr::map(Arr::get($rates, 'rates', []), function ($rate, $curr) use ($date) {
+
+                    return [
+                        'currency' => $curr,
+                        'date' => $date,
+                        'rate' => $rate,
+                        'updated_at' => now()->toDateTimeString(),
+                        'created_at' => now()->toDateTimeString(),
+                    ];
+                });
+
+                // persist
+                BatchInsertNewCurrencyRatesJob::dispatch($updates);
+
+                return new CurrencyRate(Arr::first($updates, fn ($update) => $update['currency'] == $currency) ?? ['rate' => 1]);
+            });
+
+        return (float) $rate->rate * $adjustment;
+    }
+
+    /**
+     * Get rates for range of dates
+     *
+     * @return array<string, float>
+     */
+    public static function timeSeriesRates(string $currency, mixed $start = null, mixed $end = null): array
+    {
+        if (empty($start)) {
+            return [];
+        }
+
+        $end = $end ?? now();
+
+        $period = CarbonPeriod::create($start, $end);
+
+        // No need to send network request - just generate 1s
+        if ($currency === config('investbrain.base_currency')) {
+
+            $dateRange = [];
+            foreach ($period as $date) {
+                $dateRange[$date->toDateString()] = 1;
+            }
+
+            return $dateRange;
+        }
+
+        [$currency, $adjustment] = self::getCurrencyAliasAdjustments($currency);
+
+        $currencies = Currency::all()->pluck('currency')->toArray();
+
+        // call api in chunks
+        $rates = [];
+        foreach (collect($period)->chunk(500) as $chunk) {
+
+            $chunkRates = Frankfurter::setSymbols($currencies)->timeSeries($chunk->min(), $chunk->max());
+
+            $rates = array_merge($rates, Arr::get($chunkRates, 'rates', []));
+        }
+
+        // loop through each date
+        $updates = [];
+        foreach ($period as $date) {
+
+            $skip = false;
+
+            $lookupDate = $date->toDateString();
+
+            // get rates or find closest valid rate (handles missing weekend rates)
+            while (! isset($rates[$lookupDate])) {
+                $lookupDate = Carbon::parse($lookupDate)->subDay();
+
+                // prevent runaway infinite loops
+                if ($lookupDate->lessThan($date->copy()->subWeek())) {
+
+                    $skip = true;
+                    break;
+                }
+
+                $lookupDate = $lookupDate->toDateString();
+            }
+
+            if ($skip) {
+                continue;
+            }
+
+            // make date a string
+            $date = $date->toDateString();
+
+            // loop through each rate
+            foreach ($rates[$lookupDate] as $curr => $rate) {
+
+                // add to updates
+                $updates[] = [
+                    'currency' => $curr,
+                    'date' => $date,
+                    'rate' => $rate,
+                    'updated_at' => now()->toDateTimeString(),
+                    'created_at' => now()->toDateTimeString(),
+                ];
+            }
+        }
+
+        // persist
+        BatchInsertNewCurrencyRatesJob::dispatch($updates);
+
+        return collect($updates)
+            ->whereBetween('date', [$start, $end ?? now()])
+            ->where('currency', $currency)
+            ->mapWithKeys(fn ($rate) => [
+                $rate['date'] => $rate['rate'] * $adjustment,
+            ])
+            ->toArray();
+    }
+
+    public static function refreshCurrencyData($force = false): void
+    {
+        $currencies = Currency::all()->pluck('currency')->toArray();
+
+        $rates = Frankfurter::setBaseCurrency(config('investbrain.base_currency'))
+            ->setSymbols($currencies)
+            ->latest();
+
+        $updates = [];
+        foreach (Arr::get($rates, 'rates', []) as $currency => $rate) {
+
+            // update currency
+            $updates[] = [
+                'date' => now()->toDateString(),
+                'currency' => $currency,
+                'rate' => $rate,
+            ];
+        }
+
+        // nothing to update
+        if (empty($updates)) {
+            return;
+        }
+
+        if ($force) {
+
+            // force overwrite existing rates
+            CurrencyRate::upsert($updates, ['currency', 'date'], ['rate']);
+        } else {
+
+            // only insert new rates
+            CurrencyRate::insertOrIgnore($updates);
+        }
+    }
+
+    protected static function getCurrencyAliasAdjustments($currency)
+    {
+        $adjustment = 1;
+
+        if (array_key_exists($currency, config('investbrain.currency_aliases', []))) {
+
+            $config = config('investbrain.currency_aliases.'.$currency);
+
+            $adjustment = $config['adjustment'];
+            $currency = $config['alias_of'];
+        }
+
+        return [$currency, $adjustment];
+    }
+}