libpixiv 0.1.2

pixiv.net API client library
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

use std::{error::Error, fmt::Display};
use reqwest::StatusCode;

/// Core client functionality
pub mod client;
/// Illustration endpoints for the client
pub mod illusts;
/// API data models
pub mod models;
/// Search endpoints for the client
pub mod search;
/// Ugora (GIF) endpoints for the client
pub mod ugoira;
/// User endpoints for the client
pub mod users;

/// Pixiv application errors
#[derive(Debug, Clone)]
pub enum PixivAppError {
    /// (404) the requested content does not exist
    TargetNotFound,
    /// (400) the request failed, probably because it is malformed
    RequestFailed,
    /// (403) the request is not authorized and we need to log in
    MissingLogin,
    /// (429) we've hit the rate limit and need to wait a bit (no, we do not get headers that tell
    /// us how long we should wait)
    RateLimitReached, 
    /// (everything else) the request was sent and the server responded, but we dont know what
    /// exactly the issue is
    UnhandledStatus(StatusCode),
    /// no one knows what went wrong
    Unknown,
}

impl Error for PixivAppError {}
impl Display for PixivAppError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(
            f,
            "{}",
            match self {
                PixivAppError::TargetNotFound => "Requested endpoint not found",
                PixivAppError::RequestFailed => "Request failed, check request parameters!",
                PixivAppError::MissingLogin => "Request failed because of missing authorization!",
                PixivAppError::RateLimitReached => "Too many requests, try again later",
                PixivAppError::UnhandledStatus(s) => s.as_str(),
                PixivAppError::Unknown => "An unknown error happened and no data was returned.",
            }
        )
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::{assert, assert_eq, env, sync::Arc};

    #[tokio::test]
    async fn login() {
        let token = env::var("PIXIV_REFRESH_TOKEN");
        let mut client = client::PixivAppClient::new(
            token.expect("expecting PIXIV_REFRESH_TOKEN variable for testing!"),
        );
        client.refresh_token().await;
        let cloned_access_token = Arc::clone(&client.access_token);
        let t = cloned_access_token.lock().await;
        assert!(!t.is_empty(), "Expected to receive token!");
    }

    #[tokio::test]
    async fn illust_details() {
        let illust_id = 122388293;
        let token = env::var("PIXIV_REFRESH_TOKEN");
        let mut client = client::PixivAppClient::new(
            token.expect("expecting PIXIV_REFRESH_TOKEN variable for testing!"),
        );
        client.refresh_token().await;
        let illust = client.illust_details(illust_id).await;
        assert!(illust.is_ok(), "Expected illustration data: {:#?}", illust);
        assert_eq!(illust.unwrap().id, illust_id);
    }
}