booru 0.7.0

An async Booru client for Rust
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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163

use itoa::Buffer;
use reqwest::IntoUrl;
use serde::de::DeserializeOwned;

use super::{Client, ClientBuilder, generic::AutoCompleteItem};
use crate::model::gelbooru::*;

/// Client that sends requests to the Gelbooru API to retrieve the data.
pub struct GelbooruClient(ClientBuilder<Self>);

impl From<ClientBuilder<Self>> for GelbooruClient {
    fn from(value: ClientBuilder<Self>) -> Self {
        Self(value)
    }
}

impl GelbooruClient {
    fn default_query(&self) -> Vec<(&str, &str)> {
        if let (Some(api_ref), Some(user_ref)) = (&self.0.key, &self.0.user) {
            let api = api_ref.as_str();
            let user = user_ref.as_str();
            return vec![("api_key", api), ("user_id", user)];
        }
        Vec::new()
    }

    async fn get<T: DeserializeOwned, U: IntoUrl>(
        &self,
        url: U,
        query: &[(&str, &str)],
    ) -> Result<T, reqwest::Error> {
        let mut e_query = self.default_query();
        e_query.extend(query);
        self.0
            .client
            .get(url)
            .query(&e_query)
            .send()
            .await?
            .error_for_status()?
            .json::<T>()
            .await
    }
}

impl Client for GelbooruClient {
    type Post = GelbooruPost;

    const URL: &'static str = "https://gelbooru.com";
    const SORT: &'static str = "sort:";

    /// Directly get a post by its unique Id
    #[tracing::instrument(skip(self))]
    async fn get_by_id(&self, id: u32) -> Result<GelbooruPost, reqwest::Error> {
        let builder = &self.0;
        let url = builder.url.as_str();

        let response = self
            .get::<GelbooruResponse, _>(
                format!("{url}/index.php"),
                &[
                    ("page", "dapi"),
                    ("s", "post"),
                    ("q", "index"),
                    ("id", Buffer::new().format(id)),
                    ("json", "1"),
                ],
            )
            .await?;
        Ok(response.posts[0].clone())
    }

    /// Pack the [`ClientBuilder`] and sent the request to the API to retrieve the posts
    #[tracing::instrument(skip(self))]
    async fn get(&self) -> Result<Vec<GelbooruPost>, reqwest::Error> {
        let builder = &self.0;
        let url = builder.url.as_str();
        let tag_string = builder.tags.join(" ");
        let response = self
            .get::<GelbooruResponse, _>(
                format!("{url}/index.php"),
                &[
                    ("page", "dapi"),
                    ("s", "post"),
                    ("q", "index"),
                    ("limit", Buffer::new().format(builder.limit)),
                    ("tags", &tag_string),
                    ("json", "1"),
                ],
            )
            .await?;

        Ok(response.posts)
    }

    /// retrieve the most top rated posts
    #[tracing::instrument(skip(self))]
    async fn get_popular(&self) -> Result<Vec<GelbooruPost>, reqwest::Error> {
        let builder = &self.0;
        let url = builder.url.as_str();
        let response = self
            .get::<GelbooruResponse, _>(
                format!("{url}/index.php"),
                &[
                    ("page", "dapi"),
                    ("s", "post"),
                    ("q", "index"),
                    ("limit", Buffer::new().format(builder.limit)),
                    ("tags", "sort:score:desc"),
                    ("json", "1"),
                ],
            )
            .await?;

        Ok(response.posts)
    }

    /// Pack the [`ClientBuilder`] and sent the request to the API to retrieve the posts
    #[tracing::instrument(skip(self))]
    async fn get_by_page(&self, page: u32) -> Result<Vec<GelbooruPost>, reqwest::Error> {
        let builder = &self.0;
        let url = builder.url.as_str();
        let tag_string = builder.tags.join(" ");
        let response = self
            .get::<GelbooruResponse, _>(
                format!("{url}/index.php"),
                &[
                    ("page", "dapi"),
                    ("s", "post"),
                    ("q", "index"),
                    ("limit", Buffer::new().format(builder.limit)),
                    ("tags", &tag_string),
                    ("pid", Buffer::new().format(builder.limit * page)),
                    ("json", "1"),
                ],
            )
            .await?;

        Ok(response.posts)
    }

    #[tracing::instrument(skip(self))]
    async fn get_autocomplete<Input: Into<String> + Send + std::fmt::Debug>(
        &self,
        input: Input,
    ) -> Result<Vec<AutoCompleteItem>, reqwest::Error> {
        let builder = &self.0;
        let url = builder.url.as_str();
        let response = self
            .get::<Vec<AutoCompleteItem>, _>(
                format!("{url}/index.php"),
                &[
                    ("page", "autocomplete2"),
                    ("type", "tag_query"),
                    ("term", &input.into()),
                    ("limit", Buffer::new().format(builder.limit)),
                ],
            )
            .await?;

        Ok(response)
    }
}