arnak 0.6.0

A Rust library for the BoardGameGeek XML API.
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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264

use super::{GameFamilies, GameFamily, ItemType};
use crate::{BoardGameGeekApi, Error, IntoQueryParam, QueryParam, Result};

// Query parameters for making a request to the game family endpoint.
#[derive(Clone, Debug, Default)]
struct GameFamilyQueryParams {
    // ID for the game families to retrieve.
    game_family_ids: Vec<u64>,
}

impl GameFamilyQueryParams {
    // Constructs a new search query with the list of family IDs empty.
    fn new() -> Self {
        Self::default()
    }

    // Adds an ID to the list of game family IDs to retrieve.
    fn game_family_id(mut self, id: u64) -> Self {
        self.game_family_ids.push(id);
        self
    }

    // Adds a list of IDs to the list of game family IDs to retrieve.
    fn game_family_ids(mut self, ids: Vec<u64>) -> Self {
        self.game_family_ids.extend(ids);
        self
    }
}

// Struct for building a query for the request to the game family endpoint.
#[derive(Clone, Debug)]
struct GameFamilyQueryBuilder {
    params: GameFamilyQueryParams,
}

impl<'builder> GameFamilyQueryBuilder {
    // Constructs a new query builder from the query params.
    fn new(params: GameFamilyQueryParams) -> Self {
        Self { params }
    }

    // Converts the list of parameters into a vector of
    // key value pairs that reqwest can use as HTTP query parameters.
    fn build(self) -> Vec<QueryParam<'builder>> {
        let mut query_params: Vec<_> = vec![];
        // Underlying endpoint supports RPG and Video game families too but we hide those.
        query_params.push(ItemType::BoardGameFamily.into_query_param("type"));

        if !self.params.game_family_ids.is_empty() {
            query_params.push(self.params.game_family_ids.into_query_param("id"));
        }
        query_params
    }
}

/// Game family endpoint of the API. Used for searching for game families by ID.
pub struct GameFamilyApi<'api> {
    pub(crate) api: &'api BoardGameGeekApi,
    endpoint: &'static str,
}

impl<'api> GameFamilyApi<'api> {
    pub(crate) fn new(api: &'api BoardGameGeekApi) -> Self {
        Self {
            api,
            endpoint: "family",
        }
    }

    /// Gets a family of games by ID.
    pub async fn get_by_id(&self, id: u64) -> Result<GameFamily> {
        let query = GameFamilyQueryBuilder::new(GameFamilyQueryParams::new().game_family_id(id));

        let request = self.api.build_request(self.endpoint, &query.build());
        let mut response = self.api.execute_request::<GameFamilies>(request).await?;

        match response.game_families.len() {
            0 => Err(Error::ItemNotFound),
            1 => Ok(response.game_families.remove(0)),
            len => Err(Error::UnexpectedResponseError(format!(
                "expected 1 game family but got {len}",
            ))),
        }
    }

    /// Gets families of games by their IDs.
    pub async fn get_by_ids(&self, ids: Vec<u64>) -> Result<Vec<GameFamily>> {
        let query = GameFamilyQueryBuilder::new(GameFamilyQueryParams::new().game_family_ids(ids));

        let request = self.api.build_request(self.endpoint, &query.build());
        let response = self.api.execute_request::<GameFamilies>(request).await?;

        Ok(response.game_families)
    }
}

#[cfg(test)]
mod tests {
    use mockito::Matcher;

    use super::*;
    use crate::{Game, GameFamily};

    #[tokio::test]
    async fn get_by_id() {
        let mut server = mockito::Server::new_async().await;
        let api = BoardGameGeekApi {
            base_url: server.url(),
            client: reqwest::Client::new(),
        };

        let mock = server
            .mock("GET", "/family")
            .match_query(Matcher::AllOf(vec![
                Matcher::UrlEncoded("type".to_owned(), "boardgamefamily".to_owned()),
                Matcher::UrlEncoded("id".to_owned(), "2".to_owned()),
            ]))
            .with_status(200)
            .with_body(
                std::fs::read_to_string("test_data/game_family/game_family_single.xml")
                    .expect("failed to load test data"),
            )
            .create_async()
            .await;

        let game_family = api.game_family().get_by_id(2).await;
        mock.assert_async().await;

        assert!(game_family.is_ok(), "error returned when okay expected");
        let game_family = game_family.unwrap();

        assert_eq!(
            game_family,
            GameFamily {
                id: 2,
                name: "Game: Carcassonne".to_owned(),
                alternate_names: vec!["Carcassonne: Solo-Variante".to_owned()],
                image: Some("https://cf.geekdo-images.com/c_pg0WfJKn7_P33AsDS5EA__original/img/k2t0IHkPo0nzLadfSxXhtAzyU5I=/0x0/filters:format(jpeg)/pic453826.jpg".to_owned()),
                thumbnail: Some("https://cf.geekdo-images.com/c_pg0WfJKn7_P33AsDS5EA__thumb/img/8RgZmSChaxESGjIdhMeIg0C9OZk=/fit-in/200x150/filters:strip_icc()/pic453826.jpg".to_owned()),
                description: "Games (expansions, promos, etc.) in the \"Carcassonne\" family of games, published by Hans im Glück.\n\n\nSee this Carcassonne Series wiki for more details.".to_owned(),
                games: vec![
                    Game {
                        id: 822,
                        name: "Carcassonne".to_owned(),
                    },
                    Game {
                        id: 142_057,
                        name: "Carcassonne Big Box".to_owned(),
                    },
                    Game {
                        id: 141_008,
                        name: "Carcassonne Big Box 2".to_owned(),
                    },
                ],
            },
        );
    }

    #[tokio::test]
    async fn get_by_ids() {
        let mut server = mockito::Server::new_async().await;
        let api = BoardGameGeekApi {
            base_url: server.url(),
            client: reqwest::Client::new(),
        };

        let mock = server
            .mock("GET", "/family")
            .match_query(Matcher::AllOf(vec![
                Matcher::UrlEncoded("type".to_owned(), "boardgamefamily".to_owned()),
                Matcher::UrlEncoded("id".to_owned(), "2,3".to_owned()),
            ]))
            .with_status(200)
            .with_body(
                std::fs::read_to_string("test_data/game_family/game_family_multiple.xml")
                    .expect("failed to load test data"),
            )
            .create_async()
            .await;

        let game_families = api.game_family().get_by_ids(vec![2, 3]).await;
        mock.assert_async().await;

        assert!(game_families.is_ok(), "error returned when okay expected");
        let game_families = game_families.unwrap();

        assert_eq!(game_families.len(), 2);
        assert_eq!(
            game_families[0],
            GameFamily {
                id: 2,
                name: "Game: Carcassonne".to_owned(),
                alternate_names: vec!["Carcassonne: Solo-Variante".to_owned()],
                image: Some("https://cf.geekdo-images.com/c_pg0WfJKn7_P33AsDS5EA__original/img/k2t0IHkPo0nzLadfSxXhtAzyU5I=/0x0/filters:format(jpeg)/pic453826.jpg".to_owned()),
                thumbnail: Some("https://cf.geekdo-images.com/c_pg0WfJKn7_P33AsDS5EA__thumb/img/8RgZmSChaxESGjIdhMeIg0C9OZk=/fit-in/200x150/filters:strip_icc()/pic453826.jpg".to_owned()),
                description: "Games (expansions, promos, etc.) in the \"Carcassonne\" family of games, published by Hans im Glück.\n\n\nSee this Carcassonne Series wiki for more details.".to_owned(),
                games: vec![
                    Game {
                        id: 822,
                        name: "Carcassonne".to_owned(),
                    },
                    Game {
                        id: 142_057,
                        name: "Carcassonne Big Box".to_owned(),
                    },
                    Game {
                        id: 141_008,
                        name: "Carcassonne Big Box 2".to_owned(),
                    },
                ],
            },
        );
        assert_eq!(
            game_families[1],
            GameFamily {
                id: 3,
                name: "Game: Catan".to_owned(),
                alternate_names: vec![],
                image: Some("https://cf.geekdo-images.com/FFUKDbZw6d9mAKaL9U3ymg__original/img/rulpehNOumO24_7WzaHvl7P2aac=/0x0/filters:format(jpeg)/pic1446957.jpg".to_owned()),
                thumbnail: Some("https://cf.geekdo-images.com/FFUKDbZw6d9mAKaL9U3ymg__thumb/img/o06DBHHSC9Yck1WmSkp-rK360QI=/fit-in/200x150/filters:strip_icc()/pic1446957.jpg".to_owned()),
                description: "This is the family of Settlers of Catan games, meant to include any game in the Game: Catan universe.\n\nA detailed overview is given on the Catan Series wiki.".to_owned(),
                games: vec![
                    Game {
                        id: 13,
                        name: "CATAN".to_owned(),
                    },
                    Game {
                        id: 27710,
                        name: "Catan Dice Game".to_owned(),
                    },
                ],
            },
        );
    }

    #[tokio::test]
    async fn get_by_id_not_found() {
        let mut server = mockito::Server::new_async().await;
        let api = BoardGameGeekApi {
            base_url: server.url(),
            client: reqwest::Client::new(),
        };

        let mock = server
            .mock("GET", "/family")
            .match_query(Matcher::AllOf(vec![
                Matcher::UrlEncoded("type".to_owned(), "boardgamefamily".to_owned()),
                Matcher::UrlEncoded("id".to_owned(), "9000".to_owned()),
            ]))
            .with_status(200)
            .with_body(
                std::fs::read_to_string("test_data/game_family/game_family_not_found.xml")
                    .expect("failed to load test data"),
            )
            .create_async()
            .await;

        let game_families = api.game_family().get_by_id(9000).await;
        mock.assert_async().await;

        assert!(game_families.is_err());
        assert!(matches!(game_families.err().unwrap(), Error::ItemNotFound));
    }
}