lrclib-api-rs 0.3.1

use std::borrow::Cow;

use http::{Method, Request};
use url::Url;

pub mod types;
use types::LyricsPublishData;
mod error;
pub use error::ApiError;

pub type Result<T> = std::result::Result<T, ApiError>;

const BASE_URL: &str = "https://lrclib.net";
const DEFAULT_USER_AGENT: &str = concat!("LRCAPIWrapper/", env!("CARGO_PKG_VERSION"));

#[derive(Clone, Debug)]
pub struct LRCLibAPI {
    base_url: String,
    user_agent: String,
}

impl Default for LRCLibAPI {
    fn default() -> Self {
        Self {
            base_url: BASE_URL.into(),
            user_agent: DEFAULT_USER_AGENT.into(),
        }
    }
}

impl LRCLibAPI {
    pub fn new() -> Self {
        Default::default()
    }

    pub fn with_base_url(base_url: String) -> Self {
        Self {
            base_url,
            ..Default::default()
        }
    }

    pub fn with_user_agent(user_agent: String) -> Self {
        Self {
            user_agent,
            ..Default::default()
        }
    }

    pub fn with_parts(base_url: String, user_agent: String) -> Self {
        Self {
            base_url,
            user_agent,
        }
    }
}

impl LRCLibAPI {
    /// result: `types::GetLyricsResponse`
    pub fn get_lyrics(
        &self,
        track_name: &str,
        artist_name: &str,
        album_name: Option<&str>,
        duration: Option<u64>,
    ) -> Result<Request<()>> {
        let mut query_params: Vec<(&str, Cow<'_, str>)> = vec![
            ("track_name", track_name.into()),
            ("artist_name", artist_name.into()),
        ];

        if let Some(album) = album_name {
            query_params.push(("album_name", album.into()));
        }
        if let Some(dur) = duration {
            let dur_s = dur.to_string();
            query_params.push(("duration", Cow::Owned(dur_s)));
        }

        let query_string: String = query_params
            .into_iter()
            .map(|(key, value)| format!("{}={}", key, value))
            .collect::<Vec<String>>()
            .join("&");

        let uri = format!("{}/api/get?{}", &self.base_url, query_string);
        let uri = Url::parse(&uri)?;
        let uri = uri.as_str();

        Request::builder()
            .method(Method::GET)
            .uri(uri)
            .header("User-Agent", &self.user_agent)
            .body(())
            .map_err(ApiError::from)
    }

    /// result: `types::GetLyricsResponse`
    pub fn get_lyrics_by_id(&self, id: u64) -> Result<Request<()>> {
        let uri = format!("{}/api/get/{}", &self.base_url, id);
        let uri = Url::parse(&uri)?;
        let uri = uri.as_str();

        Request::builder()
            .method(Method::GET)
            .uri(uri)
            .header("User-Agent", &self.user_agent)
            .body(())
            .map_err(ApiError::from)
    }

    pub fn search_lyrics_query(&self, query: &str) -> Result<Request<()>> {
        let query_string = format!("q={query}");

        let uri = format!("{}/api/search?{}", &self.base_url, query_string);
        let uri = Url::parse(&uri)?;
        let uri = uri.as_str();

        Request::builder()
            .method(Method::GET)
            .uri(uri)
            .header("User-Agent", &self.user_agent)
            .body(())
            .map_err(ApiError::from)
    }

    /// result: `Vec<types::LyricsData>`
    pub fn search_lyrics_detailed(
        &self,
        track_name: &str,
        artist_name: Option<&str>,
        album_name: Option<&str>,
    ) -> Result<Request<()>> {
        let mut query_params = vec![];
        query_params.push(("track_name", track_name));

        if let Some(artist) = artist_name {
            query_params.push(("artist_name", artist));
        }
        if let Some(album) = album_name {
            query_params.push(("album_name", album));
        }

        let query_string: String = query_params
            .into_iter()
            .map(|(key, value)| format!("{}={}", key, value))
            .collect::<Vec<String>>()
            .join("&");

        let uri = format!("{}/api/search?{}", &self.base_url, query_string);
        let uri = Url::parse(&uri)?;
        let uri = uri.as_str();

        Request::builder()
            .method(Method::GET)
            .uri(uri)
            .header("User-Agent", &self.user_agent)
            .body(())
            .map_err(ApiError::from)
    }

    /// result: `types::PublishChallenge`
    pub fn request_publish_challenge(&self) -> Result<Request<()>> {
        let uri = format!("{}/api/request-challenge", &self.base_url);
        let uri = Url::parse(&uri)?;
        let uri = uri.as_str();

        Request::builder()
            .method(Method::POST)
            .uri(uri)
            .header("User-Agent", &self.user_agent)
            .body(())
            .map_err(ApiError::from)
    }

    /// result: `types::PublishResponse`
    pub fn publish_lyrics(
        &self,
        lyrics: &LyricsPublishData,
        publish_token: &str,
    ) -> Result<Request<String>> {
        let uri = format!("{}/api/publish", &self.base_url);
        let uri = Url::parse(&uri)?;
        let uri = uri.as_str();

        let body = serde_json::to_string(lyrics)?;

        Request::builder()
            .method(Method::POST)
            .uri(uri)
            .header("User-Agent", &self.user_agent)
            .header("X-Publish-Token", publish_token)
            .header("Content-Type", "application/json")
            .body(body)
            .map_err(ApiError::from)
    }
}