fix: continuing error managment and documentation
This commit is contained in:
alzalia1
parent
59e1c2558c
commit
dad000a1b9
24 changed files with 389 additions and 182 deletions
|
|
@ -9,9 +9,9 @@ import 'package:seshat/domain/models/bal.dart';
|
|||
import 'package:seshat/domain/models/bal_stats.dart';
|
||||
import 'package:seshat/domain/models/book.dart';
|
||||
import 'package:seshat/domain/models/book_instance.dart';
|
||||
import 'package:seshat/domain/models/enums.dart';
|
||||
import 'package:seshat/domain/models/owner.dart';
|
||||
import 'package:seshat/domain/models/search_result.dart';
|
||||
import 'package:seshat/utils/command.dart';
|
||||
import 'package:seshat/utils/result.dart';
|
||||
|
||||
extension StringExtension on String {
|
||||
|
|
@ -20,12 +20,17 @@ extension StringExtension on String {
|
|||
}
|
||||
}
|
||||
|
||||
/// API Client to manage all authenticated REST routes
|
||||
class ApiClient {
|
||||
ApiClient({String? host, int? port});
|
||||
ApiClient();
|
||||
|
||||
late final Command0 load;
|
||||
/// JWT for registration
|
||||
String? token;
|
||||
|
||||
/// Readiness of the API Client
|
||||
bool isReady = false;
|
||||
|
||||
/// Storage to access JWT
|
||||
FlutterSecureStorage? _secureStorage;
|
||||
Logger log = Logger(
|
||||
printer: PrettyPrinter(
|
||||
|
|
@ -36,10 +41,12 @@ class ApiClient {
|
|||
),
|
||||
);
|
||||
|
||||
/// Initializes connection to the [_secureStorage]
|
||||
Future<void> _initStore() async {
|
||||
_secureStorage ??= const FlutterSecureStorage();
|
||||
}
|
||||
|
||||
/// Generates authorization headers and option [additionalHeaders]
|
||||
Future<Map<String, String>> _getHeaders([
|
||||
Map<String, String>? additionalHeaders,
|
||||
]) async {
|
||||
|
|
@ -55,6 +62,7 @@ class ApiClient {
|
|||
* ========================
|
||||
*/
|
||||
|
||||
/// Gets data about a BAL's needed returns
|
||||
Future<Result<Accounting>> getAccounting(int balId) async {
|
||||
final url = "https://$apiBasePath/bal/$balId/accounting";
|
||||
log.i("Fetching: getAccounting ($url)");
|
||||
|
|
@ -81,6 +89,8 @@ class ApiClient {
|
|||
}
|
||||
}
|
||||
|
||||
/// Notifies the server that either Books, Money or All has been returned to the user
|
||||
/// [type] is the stringified version of [ReturnType]
|
||||
Future<Result<void>> returnToId(int balId, int ownerId, String type) async {
|
||||
final url =
|
||||
"https://$apiBasePath/bal/${balId.toString()}/accounting/return/${ownerId.toString()}";
|
||||
|
|
@ -120,8 +130,9 @@ class ApiClient {
|
|||
* =================
|
||||
*/
|
||||
|
||||
Future<Result<BalStats>> getBalStats(int id) async {
|
||||
final url = "https://$apiBasePath/bal/${id.toString()}/stats";
|
||||
/// Get stats about a BAL's performance
|
||||
Future<Result<BalStats>> getBalStats(int balId) async {
|
||||
final url = "https://$apiBasePath/bal/${balId.toString()}/stats";
|
||||
log.i("Fetching: getBalStats ($url)");
|
||||
final client = Client();
|
||||
try {
|
||||
|
|
@ -148,8 +159,9 @@ class ApiClient {
|
|||
}
|
||||
}
|
||||
|
||||
Future<Result<Bal>> stopBal(int id) async {
|
||||
final url = "https://$apiBasePath/bal/${id.toString()}/stop";
|
||||
/// Stops a BAL, putting it's [BalState] to [BalState.ended]
|
||||
Future<Result<Bal>> stopBal(int balId) async {
|
||||
final url = "https://$apiBasePath/bal/${balId.toString()}/stop";
|
||||
log.i("Fetching: stopBal ($url)");
|
||||
final client = Client();
|
||||
try {
|
||||
|
|
@ -176,8 +188,9 @@ class ApiClient {
|
|||
}
|
||||
}
|
||||
|
||||
Future<Result<Bal>> startBal(int id) async {
|
||||
final url = "https://$apiBasePath/bal/${id.toString()}/start";
|
||||
/// Starts a BAL, putting it's [BalState] to [BalState.ongoing]
|
||||
Future<Result<Bal>> startBal(int balId) async {
|
||||
final url = "https://$apiBasePath/bal/${balId.toString()}/start";
|
||||
log.i("Fetching: startBal ($url)");
|
||||
final client = Client();
|
||||
try {
|
||||
|
|
@ -204,21 +217,22 @@ class ApiClient {
|
|||
}
|
||||
}
|
||||
|
||||
/// Changes the information about a [Bal], such as its [name], [startTime] or [endTime]
|
||||
Future<Result<Bal>> editBal(
|
||||
int id,
|
||||
int balId,
|
||||
String name,
|
||||
DateTime start,
|
||||
DateTime end,
|
||||
DateTime startTime,
|
||||
DateTime endTime,
|
||||
) async {
|
||||
final url = "https://$apiBasePath/bal/${id.toString()}";
|
||||
final url = "https://$apiBasePath/bal/${balId.toString()}";
|
||||
log.i("Fetching: editBal ($url)");
|
||||
final client = Client();
|
||||
try {
|
||||
final headers = await _getHeaders({"Content-Type": "application/json"});
|
||||
final body = {
|
||||
"name": name,
|
||||
"start_timestamp": (start.millisecondsSinceEpoch / 1000).round(),
|
||||
"end_timestamp": (end.millisecondsSinceEpoch / 1000).round(),
|
||||
"start_timestamp": (startTime.millisecondsSinceEpoch / 1000).round(),
|
||||
"end_timestamp": (endTime.millisecondsSinceEpoch / 1000).round(),
|
||||
};
|
||||
final response = await client.patch(
|
||||
Uri.parse(url),
|
||||
|
|
@ -244,8 +258,9 @@ class ApiClient {
|
|||
}
|
||||
}
|
||||
|
||||
Future<Result<Bal>> getBalById(int id) async {
|
||||
final url = "https://$apiBasePath/bal/${id.toString()}";
|
||||
/// Gets a [Bal] from it's [balId]
|
||||
Future<Result<Bal>> getBalById(int balId) async {
|
||||
final url = "https://$apiBasePath/bal/${balId.toString()}";
|
||||
log.i("Fetching: getBalById ($url)");
|
||||
final client = Client();
|
||||
try {
|
||||
|
|
@ -270,7 +285,12 @@ class ApiClient {
|
|||
}
|
||||
}
|
||||
|
||||
Future<Result<Bal>> addBal(String name, DateTime start, DateTime end) async {
|
||||
/// Adds a [Bal] from it's [name], [startTime] and [endTime]
|
||||
Future<Result<Bal>> addBal(
|
||||
String name,
|
||||
DateTime startTime,
|
||||
DateTime endTime,
|
||||
) async {
|
||||
final url = "https://$apiBasePath/bal";
|
||||
log.i("Fetching: addBal ($url)");
|
||||
final client = Client();
|
||||
|
|
@ -278,8 +298,8 @@ class ApiClient {
|
|||
final headers = await _getHeaders({"Content-Type": "application/json"});
|
||||
final body = {
|
||||
"name": name,
|
||||
"start_timestamp": (start.millisecondsSinceEpoch / 1000).round(),
|
||||
"end_timestamp": (end.millisecondsSinceEpoch / 1000).round(),
|
||||
"start_timestamp": (startTime.millisecondsSinceEpoch / 1000).round(),
|
||||
"end_timestamp": (endTime.millisecondsSinceEpoch / 1000).round(),
|
||||
};
|
||||
final response = await client.post(
|
||||
Uri.parse(url),
|
||||
|
|
@ -303,6 +323,7 @@ class ApiClient {
|
|||
}
|
||||
}
|
||||
|
||||
/// Gets a [List<Bal>] of all [Bal]
|
||||
Future<Result<List<Bal>>> getBals() async {
|
||||
final url = "https://$apiBasePath/bals";
|
||||
log.i("Fetching: getBals ($url)");
|
||||
|
|
@ -328,7 +349,8 @@ class ApiClient {
|
|||
}
|
||||
}
|
||||
|
||||
Future<Result<Bal?>> getCurrentBal() async {
|
||||
/// Gets the ongoing BAL for the user
|
||||
Future<Result<Bal?>> getOngoingBal() async {
|
||||
final url = "https://$apiBasePath/bal/current";
|
||||
log.i("Fetching: getCurrentBal ($url)");
|
||||
final client = Client();
|
||||
|
|
@ -356,8 +378,9 @@ class ApiClient {
|
|||
* ===================
|
||||
*/
|
||||
|
||||
Future<Result<Book>> getBookById(int id) async {
|
||||
final url = "https://$apiBasePath/book/id/${id.toString()}";
|
||||
/// Gets a [Book] by its [bookId]
|
||||
Future<Result<Book>> getBookById(int bookId) async {
|
||||
final url = "https://$apiBasePath/book/id/${bookId.toString()}";
|
||||
log.i("Fetching: getBookById ($url)");
|
||||
final client = Client();
|
||||
try {
|
||||
|
|
@ -380,6 +403,7 @@ class ApiClient {
|
|||
}
|
||||
}
|
||||
|
||||
/// Gets a [Book] from its [ean]
|
||||
Future<Result<Book>> getBookByEAN(String ean) async {
|
||||
final url = "https://$apiBasePath/book/ean/$ean";
|
||||
log.i("Fetching: getBookByEan ($url)");
|
||||
|
|
@ -410,6 +434,7 @@ class ApiClient {
|
|||
* =============================
|
||||
*/
|
||||
|
||||
/// Gets a [BookInstance] from it's [title], [author] or both
|
||||
Future<Result<List<SearchResult>>> getBookInstanceBySearch(
|
||||
int balId,
|
||||
String title,
|
||||
|
|
@ -445,6 +470,7 @@ class ApiClient {
|
|||
}
|
||||
}
|
||||
|
||||
/// Gets a [BookInstance] from it's [ean]
|
||||
Future<Result<List<BookInstance>>> getBookInstanceByEAN(
|
||||
int balId,
|
||||
int ean,
|
||||
|
|
@ -475,6 +501,10 @@ class ApiClient {
|
|||
}
|
||||
}
|
||||
|
||||
/// Notifies the server of the sell of multiple [BookInstance]. [books] is in the form of
|
||||
/// ```dart
|
||||
/// final books = {"aBookInstanceId": 6.0} // and its price
|
||||
/// ```
|
||||
Future<Result<void>> sellBooks(Map<String, double?> books) async {
|
||||
final url = "https://$apiBasePath/book_instance/sell/bulk";
|
||||
log.i("Fetching: sellBooks ($url)");
|
||||
|
|
@ -507,7 +537,8 @@ class ApiClient {
|
|||
}
|
||||
}
|
||||
|
||||
Future<Result<BookInstance>> sendBook(
|
||||
/// Creates a new [BookInstance] from it's [book], it's [owner], it's [bal] and it's [price]
|
||||
Future<Result<BookInstance>> sendNewBookInstance(
|
||||
Book book,
|
||||
Owner owner,
|
||||
Bal bal,
|
||||
|
|
@ -551,8 +582,9 @@ class ApiClient {
|
|||
* ====================
|
||||
*/
|
||||
|
||||
Future<Result<Owner>> getOwnerById(int id) async {
|
||||
final url = "https://$apiBasePath/owner/${id.toString()}";
|
||||
/// Gets an [Owner] by it's [ownerId]
|
||||
Future<Result<Owner>> getOwnerById(int ownerId) async {
|
||||
final url = "https://$apiBasePath/owner/${ownerId.toString()}";
|
||||
log.i("Fetching: getOwnerById ($url)");
|
||||
final client = Client();
|
||||
try {
|
||||
|
|
@ -577,7 +609,8 @@ class ApiClient {
|
|||
}
|
||||
}
|
||||
|
||||
Future<Result<Owner>> getSectionOwner() async {
|
||||
/// Get the owner of the current user
|
||||
Future<Result<Owner>> getOwnerOfUser() async {
|
||||
final url = "https://$apiBasePath/owner/self";
|
||||
log.i("Fetching: getSectionOwner ($url)");
|
||||
final client = Client();
|
||||
|
|
@ -599,7 +632,7 @@ class ApiClient {
|
|||
}
|
||||
}
|
||||
|
||||
/// Call on `/owners` to get a list of all [Owner]s
|
||||
/// Get a [List<Owner>] of all [Owner]
|
||||
Future<Result<List<Owner>>> getOwners() async {
|
||||
final url = "https://$apiBasePath/owners";
|
||||
log.i("Fetching: getOwners ($url)");
|
||||
|
|
@ -623,7 +656,7 @@ class ApiClient {
|
|||
}
|
||||
}
|
||||
|
||||
/// Adds an owner to the database
|
||||
/// Adds an [Owner] from its [firstName], [lastName] and [contact]
|
||||
Future<Result<Owner>> addOwner(
|
||||
String firstName,
|
||||
String lastName,
|
||||
|
|
|
|||
Reference in a new issue