feat(backend): use api key for google books

Otherwise the project was getting rate limited.

Author: IgnisDa

.github/workflows/release.yml

@@ -132,6 +132,7 @@ jobs:
             APP_VERSION=${{ steps.required_args.outputs.APP_VERSION }}
             DEFAULT_TMDB_ACCESS_TOKEN=${{ secrets.DEFAULT_TMDB_ACCESS_TOKEN }}
             DEFAULT_MAL_CLIENT_ID=${{ secrets.DEFAULT_MAL_CLIENT_ID }}
+            DEFAULT_GOOGLE_BOOKS_API_KEY=${{ secrets.DEFAULT_GOOGLE_BOOKS_API_KEY }}
 
   upload-kodi-plugin:
     runs-on: ubuntu-20.04

Dockerfile

@@ -37,16 +37,19 @@ ARG BUILD_PROFILE=release
 ARG APP_VERSION
 ARG DEFAULT_TMDB_ACCESS_TOKEN
 ARG DEFAULT_MAL_CLIENT_ID
+ARG DEFAULT_GOOGLE_BOOKS_API_KEY
 RUN test -n "$APP_VERSION" && \
     test -n "$DEFAULT_TMDB_ACCESS_TOKEN" && \
-    test -n "$DEFAULT_MAL_CLIENT_ID"
+    test -n "$DEFAULT_MAL_CLIENT_ID" && \
+    test -n "$DEFAULT_GOOGLE_BOOKS_API_KEY"
 COPY --from=backend-planner /app/recipe.json recipe.json
 RUN cargo chef cook --profile $BUILD_PROFILE --recipe-path recipe.json
 COPY . .
 COPY --from=frontend-builder /app/apps/backend/templates ./apps/backend/templates
 RUN APP_VERSION=$APP_VERSION \
     DEFAULT_TMDB_ACCESS_TOKEN=$DEFAULT_TMDB_ACCESS_TOKEN \
     DEFAULT_MAL_CLIENT_ID=$DEFAULT_MAL_CLIENT_ID \
+    DEFAULT_GOOGLE_BOOKS_API_KEY=$DEFAULT_GOOGLE_BOOKS_API_KEY \
     cargo build --profile ${BUILD_PROFILE} --bin ryot
 RUN cp -R /app/target/${BUILD_PROFILE}/ryot /app/ryot
 

apps/backend/src/miscellaneous.rs

@@ -3699,12 +3699,7 @@ impl MiscellaneousService {
     }
 
     pub async fn get_tmdb_non_media_service(&self) -> Result<NonMediaTmdbService> {
-        Ok(NonMediaTmdbService::new(
-            self.config.movies_and_shows.tmdb.access_token.clone(),
-            *self.timezone,
-            self.config.movies_and_shows.tmdb.locale.clone(),
-        )
-        .await)
+        Ok(NonMediaTmdbService::new(&self.config.movies_and_shows.tmdb, *self.timezone).await)
     }
 
     async fn get_non_metadata_provider(&self, source: MediaSource) -> Result<Provider> {

apps/backend/src/providers/google_books.rs

@@ -3,7 +3,10 @@ use async_trait::async_trait;
 use convert_case::{Case, Casing};
 use database::{MediaLot, MediaSource};
 use itertools::Itertools;
-use reqwest::Client;
+use reqwest::{
+    header::{HeaderName, HeaderValue},
+    Client,
+};
 use rs_utils::convert_date_to_year;
 use rust_decimal::Decimal;
 use serde::{Deserialize, Serialize};
@@ -41,7 +44,13 @@ impl MediaProviderLanguages for GoogleBooksService {
 
 impl GoogleBooksService {
     pub async fn new(config: &config::GoogleBooksConfig, page_limit: i32) -> Self {
-        let client = get_base_http_client(URL, None);
+        let client = get_base_http_client(
+            URL,
+            Some(vec![(
+                HeaderName::from_static("x-goog-api-key"),
+                HeaderValue::from_str(&config.api_key).unwrap(),
+            )]),
+        );
         Self {
             client,
             page_limit,

apps/backend/src/providers/tmdb.rs

@@ -390,12 +390,12 @@ pub struct NonMediaTmdbService {
 }
 
 impl NonMediaTmdbService {
-    pub async fn new(access_token: String, timezone: chrono_tz::Tz, language: String) -> Self {
-        let (client, settings) = get_client_config(URL, &access_token).await;
+    pub async fn new(config: &config::TmdbConfig, timezone: chrono_tz::Tz) -> Self {
+        let (client, settings) = get_client_config(URL, &config.access_token).await;
         Self {
             base: TmdbService {
                 client,
-                language,
+                language: config.locale.clone(),
                 settings,
                 timezone,
             },

docs/includes/backend-config-schema.yaml

@@ -32,6 +32,10 @@ audio_books:
 books:
   # Settings related to Google Books.
   google_books:
+    # The API key to be used for the Google Books API.
+    # @envvar BOOKS_GOOGLE_BOOKS_API_KEY
+    api_key: ""
+
     # Whether to pass the raw query string to the search API.
     # @envvar BOOKS_GOOGLE_BOOKS_PASS_RAW_QUERY
     pass_raw_query: false

libs/config/src/lib.rs

@@ -23,6 +23,16 @@ fn default_mal_client_id(_ctx: &()) -> Result<Option<String>, HandlerError> {
     Ok(Some(DEFAULT_MAL_CLIENT_ID.to_owned()))
 }
 
+#[cfg(debug_assertions)]
+pub const DEFAULT_GOOGLE_BOOKS_API_KEY: &str =
+    dotenvy_macro::dotenv!("DEFAULT_GOOGLE_BOOKS_API_KEY");
+#[cfg(not(debug_assertions))]
+pub const DEFAULT_GOOGLE_BOOKS_API_KEY: &str = env!("DEFAULT_GOOGLE_BOOKS_API_KEY");
+
+fn default_google_books_api_key(_ctx: &()) -> Result<Option<String>, HandlerError> {
+    Ok(Some(DEFAULT_GOOGLE_BOOKS_API_KEY.to_owned()))
+}
+
 #[derive(Debug, Serialize, Deserialize, Clone, Config)]
 #[config(rename_all = "snake_case", env_prefix = "ANIME_AND_MANGA_MAL_")]
 pub struct MalConfig {
@@ -116,6 +126,9 @@ pub struct OpenlibraryConfig {
 #[derive(Debug, Serialize, Deserialize, Clone, Config)]
 #[config(rename_all = "snake_case", env_prefix = "BOOKS_GOOGLE_BOOKS_")]
 pub struct GoogleBooksConfig {
+    /// The API key to be used for the Google Books API.
+    #[setting(default = default_google_books_api_key)]
+    pub api_key: String,
     /// Whether to pass the raw query string to the search API.
     pub pass_raw_query: bool,
 }
@@ -475,11 +488,11 @@ pub struct AppConfig {
 }
 
 impl AppConfig {
-    // TODO: Denote masked values via attribute
     pub fn masked_value(&self) -> Self {
         let gt = || "****".to_owned();
         let mut cl = self.clone();
         cl.anime_and_manga.mal.client_id = gt();
+        cl.books.google_books.api_key = gt();
         cl.database.url = gt();
         cl.file_storage.s3_region = gt();
         cl.file_storage.s3_bucket_name = gt();