imgurs/src/imgur/mod.rs

mod album_type;
mod client;
mod image_type;
mod requests;
mod send_api_request;

pub use album_type::*;
pub(crate) use client::api_url;
pub use client::ImgurClient;
pub use image_type::*;
pub use send_api_request::*;

use crate::{Error, Result};

impl ImgurClient {
    /// Create a new Imgur Client
    /// ```
    /// use imgurs::ImgurClient;
    ///
    /// let client = ImgurClient::new("3e3ce0d7ac14d56");
    /// ```
    pub fn new(client_id: &str) -> Self {
        let client_id = client_id.to_string();
        let client = reqwest::Client::new();
        ImgurClient { client_id, client }
    }
    
    /// Create a new Imgur Client with the provided `reqwest::Client`
    ///
    /// This allows for customization of the http client settings like timeout or the user agent. 
    /// ```
    /// use imgurs::ImgurClient;
    /// use reqwest::Client;
    ///
    /// let http_client = Client::builder().build();
    ///
    /// let client = ImgurClient::with_http_client("3e3ce0d7ac14d56", http_client);
    /// ```
    pub fn new(client_id: &str, http_client: reqwest::Client) -> Self {
        let client_id = client_id.to_string();
        ImgurClient { client_id, client: http_client }
    }

    /// Upload image to Imgur
    /// ```
    /// use imgurs::ImgurClient;
    ///
    /// #[tokio::main]
    /// async fn main() {
    ///     let client = ImgurClient::new("3e3ce0d7ac14d56");
    ///
    ///     client
    ///         .upload_image("https://i.imgur.com/lFaGr1x.png")
    ///         .await
    ///         .expect("upload image");
    /// }
    /// ```
    pub async fn upload_image(&self, path: &str) -> Result<ImageInfo> {
        let mut image = path.to_string();

        // check if the specified file exists if not then check if it is a url
        if std::path::Path::new(path).exists() {
            let bytes = std::fs::read(path)?;
            image = base64::encode(bytes)
        }
        // validate url adress
        else if !validator::validate_url(path) {
            Err(Error::InvalidUrlOrFile(path.to_string()))?;
        }

        requests::upload_image(self, image).await
    }

    /// Delete image from Imgur
    /// ```
    /// use imgurs::ImgurClient;
    ///
    /// #[tokio::main]
    /// async fn main() {
    ///     let client = ImgurClient::new("3e3ce0d7ac14d56");
    ///
    ///     let image = client
    ///         .upload_image("https://i.imgur.com/lFaGr1x.png")
    ///         .await
    ///         .expect("upload image");
    ///     let deletehash = image.data.deletehash.unwrap();
    ///
    ///     client
    ///         .delete_image(&deletehash)
    ///         .await
    ///         .expect("delete image");
    /// }
    /// ```
    pub async fn delete_image(&self, delete_hash: &str) -> Result<()> {
        requests::delete_image(self, delete_hash).await
    }

    /// Get Rame Limit of this Imgur Client
    /// ```
    /// use imgurs::ImgurClient;
    ///
    /// #[tokio::main]
    /// async fn main() {
    ///     let client = ImgurClient::new("3e3ce0d7ac14d56");
    ///
    ///     client.rate_limit().await.expect("get rate limit");
    /// }
    /// ```
    pub async fn rate_limit(&self) -> Result<requests::RateLimitInfo> {
        requests::rate_limit(self).await
    }

    /// Get image info from a Imgur
    /// ```
    /// use imgurs::ImgurClient;
    ///
    /// #[tokio::main]
    /// async fn main() {
    ///     let client = ImgurClient::new("3e3ce0d7ac14d56");
    ///
    ///     client.image_info("lFaGr1x").await.expect("delete image");
    /// }
    /// ```
    pub async fn image_info(&self, id: &str) -> Result<ImageInfo> {
        requests::get_image(self, id).await
    }

    /// Get album info from a Imgur
    /// ```no_run
    /// use imgurs::ImgurClient;
    ///
    /// #[tokio::main]
    /// async fn main() {
    ///     let client = ImgurClient::new("3e3ce0d7ac14d56");
    ///
    ///     client.album_info("id").await.expect("get album info");
    /// }
    /// ```
    pub async fn album_info(&self, id: &str) -> Result<AlbumInfo> {
        requests::get_album(self, id).await
    }
}