replace remote translate with db translation

.dockerignore

@@ -9,4 +9,5 @@ build/
 .packages
 .vscode
 test/
-test_load/
+test_load/
+quotes.db

.gitignore

@@ -18,3 +18,6 @@ coverage/
 # environment files
 .env
 lib/env.g.dart
+
+# db file (too big to be in git)
+quotes.db

Dockerfile

@@ -52,10 +52,10 @@ FROM scratch
 WORKDIR /app
 COPY --from=build /runtime/ /
 COPY --from=build /app/build/bin/server /app/bin/
-COPY --from=build /app/build/quotes.db /app/
+#COPY --from=build /app/build/quotes.db /app/
 COPY --from=build /app/build/.env /app/
 # Uncomment the following line if you are serving static files.
 # COPY --from=build /app/build/public /public/
 
 # Start the server.
-CMD ["/app/bin/server"]
+CMD ["/app/bin/server"]

README.md

@@ -6,6 +6,8 @@
 
 Quote API for Kuwot app.
 
+The quotes database file size is exceeding Github's 100MB limit, it can be downloaded from [here](https://drive.google.com/drive/folders/18b7Dvptf0xQ8qwXzGvCZ6qqwd7V0TPtv).
+
 [license_badge]: https://img.shields.io/badge/license-MIT-blue.svg
 [license_link]: https://opensource.org/licenses/MIT
 [very_good_analysis_badge]: https://img.shields.io/badge/style-very_good_analysis-B22C89.svg

compose.yaml

@@ -4,4 +4,6 @@ services:
       context: .
     container_name: kuwot_api_server
     ports:
-      - 3000:8080
+      - 3000:8080
+    volumes:
+      - ./quotes.db:/app/quotes.db:ro

lib/core/data/sqlite_database.dart

@@ -11,12 +11,20 @@ abstract class SqliteDb {
   /// Initializes the database connection.
   void initialize();
 
-  /// Executes a query [query] with list of [queryParams].
+  /// Executes a query [query] with list of [queryParams] for a single data.
+  /// Returns a nullable [Row] object.
   Row? select(
     String query, [
     List<Object?> queryParams = const [],
   ]);
 
+  /// Executes a query [query] with list of [queryParams] for multiple data.
+  /// Returns a [ResultSet] object.
+  ResultSet selectMany(
+    String query, [
+    List<Object?> queryParams = const [],
+  ]);
+
   /// Closes the database connection.
   void close();
 }

lib/core/error/failure.dart

@@ -0,0 +1,30 @@
+/// Base class for all failures
+abstract class Failure {
+  /// Create a new [Failure] with the provided [message].
+  const Failure({required this.message});
+
+  /// Failure message
+  final String message;
+}
+
+/// A failure for when an unexpected error occurs.
+class UnexpectedFailure extends Failure {
+  /// Create a new [UnexpectedFailure] with the provided [message].
+  const UnexpectedFailure({required super.message});
+}
+
+/// A failure for when data is not found.
+///
+/// For example, when a quote with the provided ID is not found.
+class DataNotFoundFailure extends Failure {
+  /// Create a new [DataNotFoundFailure] with the provided [message].
+  const DataNotFoundFailure({required super.message});
+}
+
+/// A failure for when an invalid request is made.
+///
+/// For example, when the user provides an invalid language code.
+class InvalidRequestFailure extends Failure {
+  /// Create a new [InvalidRequestFailure] with the provided [message].
+  const InvalidRequestFailure({required super.message});
+}

lib/data/data_sources/local/quote_local_data_source.dart

@@ -2,17 +2,27 @@ import 'dart:math' show Random;
 
 import 'package:kuwot_api/core/data/sqlite_database.dart';
 import 'package:kuwot_api/data/models/quote_model.dart';
+import 'package:kuwot_api/data/models/translation_model.dart';
 
 /// A contract for local data source of quotes.
 abstract class QuoteLocalDataSource {
   /// Get a random quote.
-  QuoteModel getRandomQuote(int maxRandomId);
+  QuoteModel getRandomQuote({
+    required int maxRandomId,
+    String? tableName,
+  });
 
   /// Get a quote by its [id].
-  QuoteModel? getQuote(int id);
+  QuoteModel? getQuote({
+    required int id,
+    String? tableName,
+  });
 
   /// Get quote count
   int getQuoteCount();
+
+  /// Get translation list.
+  List<TranslationModel> getTranslations();
 }
 
 /// An implementation of [QuoteLocalDataSource].
@@ -30,11 +40,12 @@ class QuoteLocalDataSourceImpl implements QuoteLocalDataSource {
   int _getRandomId(int min, int max) => min + _random.nextInt(max - min);
 
   @override
-  QuoteModel getRandomQuote(int maxRandomId) {
-    final result = sqliteDb.select(
-      'SELECT * FROM quotes WHERE id = ?;',
-      [_getRandomId(1, maxRandomId)],
-    );
+  QuoteModel getRandomQuote({
+    required int maxRandomId,
+    String? tableName,
+  }) {
+    final query = 'SELECT * FROM ${tableName ?? 'quotes'} WHERE id = ?;';
+    final result = sqliteDb.select(query, [_getRandomId(1, maxRandomId)]);
 
     return QuoteModel(
       id: result?['id'] as int,
@@ -44,11 +55,12 @@ class QuoteLocalDataSourceImpl implements QuoteLocalDataSource {
   }
 
   @override
-  QuoteModel? getQuote(int id) {
-    final result = sqliteDb.select(
-      'SELECT * FROM quotes WHERE id = ?;',
-      [id],
-    );
+  QuoteModel? getQuote({
+    required int id,
+    String? tableName,
+  }) {
+    final query = 'SELECT * FROM ${tableName ?? 'quotes'} WHERE id = ?;';
+    final result = sqliteDb.select(query, [id]);
 
     return result == null
         ? null
@@ -67,4 +79,22 @@ class QuoteLocalDataSourceImpl implements QuoteLocalDataSource {
 
     return result?['COUNT(*)'] as int;
   }
+
+  @override
+  List<TranslationModel> getTranslations() {
+    final result = sqliteDb.selectMany(
+      'SELECT * FROM translations ORDER BY id;',
+    );
+    final translations = <TranslationModel>[];
+    for (final row in result) {
+      translations.add(
+        TranslationModel(
+          id: row['id'] as String,
+          lang: row['lang'] as String,
+          tableName: row['table_name'] as String,
+        ),
+      );
+    }
+    return translations;
+  }
 }

lib/data/models/translation_model.dart

@@ -0,0 +1,20 @@
+// ignore_for_file: public_member_api_docs
+
+import 'package:freezed_annotation/freezed_annotation.dart';
+
+part 'translation_model.freezed.dart';
+
+@freezed
+class TranslationModel with _$TranslationModel {
+  /// A model for translation.
+  const factory TranslationModel({
+    /// The translation id, this will be a language id.
+    required String id,
+
+    /// Language name.
+    required String lang,
+
+    /// Translated quote table name.
+    required String tableName,
+  }) = _TranslationModel;
+}