hans/rental_income_tracker
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Refactor ForexRateApiService to remove API key dependency and update README and launch configurations

Browse Source 
Signed-off-by: Hans Kokx <hans.d.kokx@gmail.com>
This commit is contained in:
Hans Kokx
2026-03-20 10:40:28 +01:00
parent b37dec35f5
commit 67af59bd0d
9 changed files with 82 additions and 136 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.env.example
-1
View File
@@ -1 +0,0 @@
FOREX_RATE_API_KEY=REPLACE_WITH_YOUR_FOREXRATE_API_KEY
.vscode/launch.json
Vendored
+3 -12
View File
@@ -7,28 +7,19 @@
{ {
"name": "rental_income_tracker", "name": "rental_income_tracker",
"request": "launch", "request": "launch",
"type": "dart", "type": "dart"
"toolArgs": [
"--dart-define-from-file=.env"
]
}, },
{ {
"name": "rental_income_tracker (profile mode)", "name": "rental_income_tracker (profile mode)",
"request": "launch", "request": "launch",
"type": "dart", "type": "dart",
"flutterMode": "profile", "flutterMode": "profile"
"toolArgs": [
"--dart-define-from-file=.env"
]
}, },
{ {
"name": "rental_income_tracker (release mode)", "name": "rental_income_tracker (release mode)",
"request": "launch", "request": "launch",
"type": "dart", "type": "dart",
"flutterMode": "release", "flutterMode": "release"
"toolArgs": [
"--dart-define-from-file=.env"
]
} }
] ]
} }
Makefile
+1 -1
View File
@@ -3,4 +3,4 @@
build: release build: release
release: release:
flutter build apk --release --dart-define-from-file=.env flutter build apk --release
README.md
+1 -7
View File
@@ -23,12 +23,6 @@ Simple Flutter app to track US rental income and convert to SEK for Swedish tax
## Setup ## Setup
1. Create `.env` in the project root with your FX API key:
```env
FOREX_RATE_API_KEY=REPLACE_WITH_YOUR_FOREXRATE_API_KEY
```
1. Install dependencies: 1. Install dependencies:
```bash ```bash
@@ -38,7 +32,7 @@ flutter pub get
1. Run: 1. Run:
```bash ```bash
flutter run --dart-define-from-file=.env flutter run
``` ```
1. Build release APK: 1. Build release APK:
lib/screens/settings_screen.dart
+1 -1
View File
@@ -198,7 +198,7 @@ class _SettingsScreenState extends State<SettingsScreen> {
), ),
const SizedBox(height: 16), const SizedBox(height: 16),
const Text( const Text(
'ForexRateAPI key is loaded from FOREX_RATE_API_KEY via --dart-define-from-file=.env.', 'Using Frankfurter exchange rates (no API key required).',
), ),
], ],
), ),
lib/services/open_exchange_service.dart
+29 -72
View File
@@ -5,18 +5,17 @@ import 'package:flutter/foundation.dart';
import 'package:http/http.dart' as http; import 'package:http/http.dart' as http;
import 'package:intl/intl.dart'; import 'package:intl/intl.dart';
class ForexConversionResult { class ConversionResult {
ForexConversionResult({required this.quote, required this.result}); ConversionResult({required this.quote, required this.result});
final double quote; final double quote;
final double result; final double result;
} }
class ForexRateApiService { class FrankfurterApiService {
ForexRateApiService({required this.httpClient, required this.apiKey}); FrankfurterApiService({required this.httpClient});
final http.Client httpClient; final http.Client httpClient;
final String apiKey;
void _log(String message) { void _log(String message) {
if (kDebugMode) { if (kDebugMode) {
@@ -24,13 +23,7 @@ class ForexRateApiService {
} }
} }
String _redactedUri(Uri uri) { String _redactedUri(Uri uri) => uri.toString();
final redactedQuery = <String, String>{...uri.queryParameters};
if (redactedQuery.containsKey('api_key')) {
redactedQuery['api_key'] = '***REDACTED***';
}
return uri.replace(queryParameters: redactedQuery).toString();
}
bool _isRateLimitedResponse(http.Response response) { bool _isRateLimitedResponse(http.Response response) {
if (response.statusCode == 429) { if (response.statusCode == 429) {
@@ -40,8 +33,8 @@ class ForexRateApiService {
try { try {
final parsed = jsonDecode(response.body) as Map<String, dynamic>; final parsed = jsonDecode(response.body) as Map<String, dynamic>;
final error = parsed['error'] as Map<String, dynamic>?; final error = parsed['error'] as Map<String, dynamic>?;
final code = error?['code']?.toString().toLowerCase(); final statusCode = error?['statusCode']?.toString();
return code == '104' || code == 'rate_limit_reached'; return statusCode == '429';
} catch (_) { } catch (_) {
return false; return false;
} }
@@ -51,18 +44,17 @@ class ForexRateApiService {
return DateTime.utc(value.year, value.month, value.day); return DateTime.utc(value.year, value.month, value.day);
} }
DateTime _latestHistoricalDateUtc() { DateTime _todayUtcDate() {
final nowUtc = DateTime.now().toUtc(); final nowUtc = DateTime.now().toUtc();
final todayUtcDate = DateTime.utc(nowUtc.year, nowUtc.month, nowUtc.day); return DateTime.utc(nowUtc.year, nowUtc.month, nowUtc.day);
return todayUtcDate.subtract(const Duration(days: 1));
} }
DateTime _normalizeHistoricalDate(DateTime requestedDate) { DateTime _normalizeHistoricalDate(DateTime requestedDate) {
final requestedUtcDate = _asUtcDate(requestedDate); final requestedUtcDate = _asUtcDate(requestedDate);
final latestAllowed = _latestHistoricalDateUtc(); final latestAllowed = _todayUtcDate();
if (requestedUtcDate.isAfter(latestAllowed)) { if (requestedUtcDate.isAfter(latestAllowed)) {
_log( _log(
'Historical date ${DateFormat('yyyy-MM-dd').format(requestedUtcDate)} is not available yet; clamping to ${DateFormat('yyyy-MM-dd').format(latestAllowed)}.', 'Requested date ${DateFormat('yyyy-MM-dd').format(requestedUtcDate)} is in the future; clamping to ${DateFormat('yyyy-MM-dd').format(latestAllowed)}.',
); );
return latestAllowed; return latestAllowed;
} }
@@ -96,37 +88,25 @@ class ForexRateApiService {
} }
Future<double> fetchUsdToSekRate({required DateTime estDate}) async { Future<double> fetchUsdToSekRate({required DateTime estDate}) async {
if (apiKey == 'REPLACE_WITH_YOUR_FOREXRATE_API_KEY') {
throw StateError('ForexRateAPI key is not configured.');
}
final effectiveDate = _normalizeHistoricalDate(estDate); final effectiveDate = _normalizeHistoricalDate(estDate);
final date = DateFormat('yyyy-MM-dd').format(effectiveDate); final date = DateFormat('yyyy-MM-dd').format(effectiveDate);
final uri = Uri.https('api.forexrateapi.com', '/v1/$date', <String, String>{ final uri = Uri.https('api.frankfurter.dev', '/v1/$date', <String, String>{
'api_key': apiKey,
'base': 'USD', 'base': 'USD',
'currencies': 'SEK', 'symbols': 'SEK',
}); });
_log('Daily rate request: ${_redactedUri(uri)}'); _log('Daily rate request: ${_redactedUri(uri)}');
final response = await _getWithRateLimitRetry(uri, operation: 'Daily rate'); final response = await _getWithRateLimitRetry(uri, operation: 'Daily rate');
if (response.statusCode != 200) { if (response.statusCode != 200) {
throw StateError('ForexRateAPI request failed (${response.statusCode}).'); throw StateError('Frankfurter request failed (${response.statusCode}).');
} }
final json = jsonDecode(response.body) as Map<String, dynamic>; final json = jsonDecode(response.body) as Map<String, dynamic>;
final success = json['success'] as bool? ?? false;
if (!success) {
final error = json['error'];
_log('Daily rate success=false. error=$error');
throw StateError('ForexRateAPI returned success=false. error=$error');
}
final rates = json['rates'] as Map<String, dynamic>?; final rates = json['rates'] as Map<String, dynamic>?;
final sek = rates?['SEK']; final sek = rates?['SEK'];
if (sek == null) { if (sek == null) {
throw StateError('SEK rate was missing in API response.'); throw StateError('SEK rate was missing in Frankfurter response.');
} }
_log('Daily rate parsed SEK quote: $sek'); _log('Daily rate parsed SEK quote: $sek');
@@ -134,14 +114,10 @@ class ForexRateApiService {
return (sek as num).toDouble(); return (sek as num).toDouble();
} }
Future<ForexConversionResult> convertUsdToSek({ Future<ConversionResult> convertUsdToSek({
required DateTime estDate, required DateTime estDate,
required double amount, required double amount,
}) async { }) async {
if (apiKey == 'REPLACE_WITH_YOUR_FOREXRATE_API_KEY') {
throw StateError('ForexRateAPI key is not configured.');
}
final quote = await fetchUsdToSekRate(estDate: estDate); final quote = await fetchUsdToSekRate(estDate: estDate);
final result = quote * amount; final result = quote * amount;
@@ -149,52 +125,35 @@ class ForexRateApiService {
'Computed conversion from daily rate quote=$quote result=$result amount=$amount date=${DateFormat('yyyy-MM-dd').format(estDate)}', 'Computed conversion from daily rate quote=$quote result=$result amount=$amount date=${DateFormat('yyyy-MM-dd').format(estDate)}',
); );
return ForexConversionResult(quote: quote, result: result); return ConversionResult(quote: quote, result: result);
} }
/// Fetches USD->SEK cross-rates for every day of [year] in a single timeseries /// Fetches USD->SEK cross-rates for [year] using Frankfurter's date-range
/// API call. Returns a map of 'yyyy-MM-dd' -> rate, or null if the timeseries /// endpoint. Returns a map of 'yyyy-MM-dd' -> rate.
/// endpoint is not available on the current subscription plan.
Future<Map<String, double>?> tryFetchYearRates(int year) async { Future<Map<String, double>?> tryFetchYearRates(int year) async {
if (apiKey == 'REPLACE_WITH_YOUR_FOREXRATE_API_KEY') {
throw StateError('ForexRateAPI key is not configured.');
}
final start = DateTime(year, 1, 1); final start = DateTime(year, 1, 1);
final end = DateTime(year, 12, 31); final end = DateTime(year, 12, 31);
final uri = final rangePath =
Uri.https('api.forexrateapi.com', '/v1/timeframe', <String, String>{ '/v1/${DateFormat('yyyy-MM-dd').format(start)}..${DateFormat('yyyy-MM-dd').format(end)}';
'api_key': apiKey, final uri = Uri.https('api.frankfurter.dev', rangePath, <String, String>{
'base': 'USD', 'base': 'USD',
'currencies': 'SEK', 'symbols': 'SEK',
'start_date': DateFormat('yyyy-MM-dd').format(start),
'end_date': DateFormat('yyyy-MM-dd').format(end),
}); });
_log('Timeframe request: ${_redactedUri(uri)}'); _log('Range request: ${_redactedUri(uri)}');
final response = await _getWithRateLimitRetry(uri, operation: 'Timeframe'); final response = await _getWithRateLimitRetry(uri, operation: 'Range');
if (response.statusCode != 200) { if (response.statusCode != 200) {
_log( _log(
'Timeframe endpoint unavailable for this account or request; falling back to per-day requests. status=${response.statusCode}', 'Range endpoint unavailable; falling back to per-day requests. status=${response.statusCode}',
); );
return null; return null;
} }
final json = jsonDecode(response.body) as Map<String, dynamic>; final json = jsonDecode(response.body) as Map<String, dynamic>;
final success = json['success'] as bool? ?? false;
if (!success) {
_log(
'Timeframe success=false; falling back to per-day requests. error=${json['error']}',
);
return null;
}
final rates = json['rates'] as Map<String, dynamic>?; final rates = json['rates'] as Map<String, dynamic>?;
if (rates == null) { if (rates == null) {
_log( _log('Range response missing rates; falling back to per-day requests.');
'Timeframe response missing rates; falling back to per-day requests.',
);
return null; return null;
} }
@@ -208,13 +167,11 @@ class ForexRateApiService {
} }
if (results.isEmpty) { if (results.isEmpty) {
_log( _log('Range parsed no SEK entries; falling back to per-day requests.');
'Timeframe parsed no SEK entries; falling back to per-day requests.',
);
return null; return null;
} }
_log('Timeframe parsed ${results.length} daily SEK quotes.'); _log('Range parsed ${results.length} daily SEK quotes.');
return results; return results;
} }
} }
lib/state/rent_controller.dart
+39 -34
View File
@@ -41,35 +41,17 @@ class RentController extends ChangeNotifier {
RentController({ RentController({
StorageService? storageService, StorageService? storageService,
ForexRateApiService? exchangeService, FrankfurterApiService? exchangeService,
NotificationService? notificationService, NotificationService? notificationService,
}) : _storageService = storageService ?? StorageService(), }) : _storageService = storageService ?? StorageService(),
_exchangeService = _exchangeService =
exchangeService ?? exchangeService ?? FrankfurterApiService(httpClient: http.Client()) {
ForexRateApiService(
httpClient: http.Client(),
apiKey: _exchangeRateApiKeyFromEnv(),
) {
_notificationService = _notificationService =
notificationService ?? NotificationService(_onNotificationAction); notificationService ?? NotificationService(_onNotificationAction);
} }
static String _exchangeRateApiKeyFromEnv() {
const key = String.fromEnvironment('FOREX_RATE_API_KEY');
final trimmed = key.trim();
if (trimmed.isEmpty) {
if (kDebugMode) {
debugPrint(
'[RentController] FOREX_RATE_API_KEY missing from dart defines. Pass --dart-define-from-file=.env (or --dart-define) when building/running.',
);
}
return 'REPLACE_WITH_YOUR_FOREXRATE_API_KEY';
}
return trimmed;
}
final StorageService _storageService; final StorageService _storageService;
final ForexRateApiService _exchangeService; final FrankfurterApiService _exchangeService;
late NotificationService _notificationService; late NotificationService _notificationService;
AppSettings _settings = AppSettings.defaults(); AppSettings _settings = AppSettings.defaults();
@@ -79,6 +61,33 @@ class RentController extends ChangeNotifier {
String? _errorMessage; String? _errorMessage;
int _selectedYear = DateTime.now().year; int _selectedYear = DateTime.now().year;
double? _lookupRateOnOrBefore(
Map<String, double> rates,
DateTime targetDate,
) {
final target = DateTime(targetDate.year, targetDate.month, targetDate.day);
DateTime? nearestDate;
double? nearestRate;
for (final entry in rates.entries) {
final parsed = DateTime.tryParse(entry.key);
if (parsed == null) {
continue;
}
final day = DateTime(parsed.year, parsed.month, parsed.day);
if (day.isAfter(target)) {
continue;
}
if (nearestDate == null || day.isAfter(nearestDate)) {
nearestDate = day;
nearestRate = entry.value;
}
}
return nearestRate;
}
AppSettings get settings => _settings; AppSettings get settings => _settings;
bool get isLoading => _isLoading; bool get isLoading => _isLoading;
String? get errorMessage => _errorMessage; String? get errorMessage => _errorMessage;
@@ -334,27 +343,25 @@ class RentController extends ChangeNotifier {
final usd = _settings.rentUsd; final usd = _settings.rentUsd;
final estDate = DateTime(year, month, 1); final estDate = DateTime(year, month, 1);
final ForexConversionResult conversion; final ConversionResult conversion;
if (batchRates != null) { if (batchRates != null) {
final dateStr = DateFormat('yyyy-MM-dd').format(estDate); final quote = _lookupRateOnOrBefore(batchRates, estDate);
final quote = batchRates[dateStr];
if (quote == null) { if (quote == null) {
throw StateError('Batch rates missing entry for $dateStr.'); throw StateError(
} 'Batch rates missing entry on or before ${DateFormat('yyyy-MM-dd').format(estDate)}.',
conversion = ForexConversionResult(
quote: quote,
result: quote * usd,
); );
}
conversion = ConversionResult(quote: quote, result: quote * usd);
} else { } else {
// Pace individual requests to avoid triggering the rate limit. // Pace individual requests to avoid triggering the rate limit.
if (!isFirstIndividualFetch) { if (!isFirstIndividualFetch) {
await Future.delayed(const Duration(milliseconds: 700)); await Future.delayed(const Duration(milliseconds: 700));
} }
isFirstIndividualFetch = false; isFirstIndividualFetch = false;
conversion = await _exchangeService.convertUsdToSek( final quote = await _exchangeService.fetchUsdToSekRate(
estDate: estDate, estDate: estDate,
amount: usd,
); );
conversion = ConversionResult(quote: quote, result: quote * usd);
} }
if (kDebugMode) { if (kDebugMode) {
@@ -385,9 +392,7 @@ class RentController extends ChangeNotifier {
savedMonths++; savedMonths++;
} catch (err) { } catch (err) {
final errorText = err.toString(); final errorText = err.toString();
if (errorText.contains('429') || if (errorText.contains('429')) {
errorText.contains('104') ||
errorText.toLowerCase().contains('rate_limit_reached')) {
pausedByRateLimit = true; pausedByRateLimit = true;
_errorMessage = _errorMessage =
'Backfill paused by API rate limits after $savedMonths new month(s). Run backfill again in a minute to continue.'; 'Backfill paused by API rate limits after $savedMonths new month(s). Run backfill again in a minute to continue.';
test/backup_restore_compatibility_test.dart
+3 -3
View File
@@ -31,18 +31,18 @@ class _FakeStorageService extends StorageService {
} }
} }
class _FakeExchangeService extends ForexRateApiService { class _FakeExchangeService extends FrankfurterApiService {
_FakeExchangeService({required this.quote}) _FakeExchangeService({required this.quote})
: super(httpClient: http.Client(), apiKey: 'test-key'); : super(httpClient: http.Client(), apiKey: 'test-key');
final double quote; final double quote;
@override @override
Future<ForexConversionResult> convertUsdToSek({ Future<ConversionResult> convertUsdToSek({
required DateTime estDate, required DateTime estDate,
required double amount, required double amount,
}) async { }) async {
return ForexConversionResult(quote: quote, result: quote * amount); return ConversionResult(quote: quote, result: quote * amount);
} }
} }
test/notification_scheduling_test.dart
+3 -3
View File
@@ -29,15 +29,15 @@ class _FakeStorageService extends StorageService {
} }
} }
class _FakeExchangeService extends ForexRateApiService { class _FakeExchangeService extends FrankfurterApiService {
_FakeExchangeService() : super(httpClient: http.Client(), apiKey: 'test-key'); _FakeExchangeService() : super(httpClient: http.Client(), apiKey: 'test-key');
@override @override
Future<ForexConversionResult> convertUsdToSek({ Future<ConversionResult> convertUsdToSek({
required DateTime estDate, required DateTime estDate,
required double amount, required double amount,
}) async { }) async {
return ForexConversionResult(quote: 10, result: amount * 10); return ConversionResult(quote: 10, result: amount * 10);
} }
} }