replicate-rust 0.0.5

An Unofficial Rust Client for Replicate.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98

//! The config module contains the Config struct, which is used to initialize configuration for the API.
//! Currently contains the `API token`, the `user agent` and the `base url`.
//!
//!
//! # Example
//! ```
//! use replicate_rust::{Replicate, config::Config};
//!
//! let config = Config {
//!     auth : String::from("REPLICATE_API_TOKEN"),
//!     ..Default::default()
//! };
//!
//! let replicate = Replicate::new(config); // config OR Default::default()
//! ```
//! ### Note
//!
//! The Config struct implements the `Default` trait, so you can also use `Default::default()` to initialize the config.
//!
//! ```
//! use replicate_rust::{Replicate, config::Config};
//!
//! let config = Config::default();
//!
//! let replicate = Replicate::new(config);
//! ```    

/// The Config struct is used to initialize configuration for the API. Currently contains the `API token`, the `user agent` and the `base url`.
#[derive(Clone, Debug)]
pub struct Config {
    /// The API token to use for authentication.
    pub auth: String,

    /// The user agent to use for the API requests. Defaults to `replicate-rust/{version}`.
    pub user_agent: String,

    /// The base url to use for the API requests. Defaults to `https://api.replicate.com/v1`.
    pub base_url: String,
}

// Default implementation for Client

impl Default for Config {
    /// Create a new Config struct with the default values.
    fn default() -> Self {
        Self {
            auth: match std::env::var("REPLICATE_API_TOKEN") {
                Ok(token) => token,
                Err(_) => String::new(),
            },
            user_agent: format!("replicate-rust/{}", env!("CARGO_PKG_VERSION")),
            base_url: String::from("https://api.replicate.com/v1"),
        }
    }
}

impl Config {
    /// Check if auth is set and exit if not.
    /// The auth token can be set in the environment variable `REPLICATE_API_TOKEN`.
    /// Otherwise, it can be set in the `Config` struct.
    pub fn check_auth(&self) {
        // Check if auth is set.
        if self.auth.is_empty() {
            eprintln!("No API token provided. You need to set the REPLICATE_API_TOKEN environment variable or create a client with `Config {{auth: String::from('REPLICATE_API_TOKEN'), ..Default::default()}}`.

You can find your API key on https://replicate.com");

            std::process::exit(1);
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_default() {
        let config = Config::default();

        assert_eq!(config.auth, String::new());
        assert_eq!(
            config.user_agent,
            format!("replicate-rust/{}", env!("CARGO_PKG_VERSION"))
        );
        assert_eq!(config.base_url, "https://api.replicate.com/v1");
    }

    // Check if auth is set. It is supposed to exit with code 1.
    #[test]
    fn test_check_auth() {
        let config = Config {
            auth: "Test".to_string(),
            ..Default::default()
        };
        config.check_auth();
    }
}