libfj 0.10.0

An unofficial collection of APIs used in FreeJam games and mods
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
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297

use std::sync::Mutex;

use reqwest::{Client, Error as ReqwestError, Response};
use url::{Url};

use crate::robocraft2::{ITokenProvider, ErrorPayload};
use crate::robocraft2::{SearchPayload, SearchResponse, CreateRobotPayload, CreateRobotResponse, FactoryInfoResponse, PublishRobotPayload, PublishRobotResponse, MyRobotsResponse, GetRobotResponse, ModerateRobotPayload, ReportRobotPayload};

/// Community Factory Robot 2 root URL
pub const FACTORY_DOMAIN: &str = "https://factory.production.robocraft2.com";

#[derive(Debug)]
pub enum FactoryError {
    Protocol(ReqwestError),
    Response(ErrorPayload),
    ResponseCode(ReqwestError, u16)
}

impl std::fmt::Display for FactoryError {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> Result<(), std::fmt::Error> {
        match self {
            Self::Protocol(p) => if let Some(status) = p.status() {
                write!(f, "HTTP Error {}: {}", status, p)
            } else {
                write!(f, "HTTP Error: {}", p)
            }
            Self::Response(r) => write!(f, "Factory Error #{}: {}", r.error, r.error_message),
            Self::ResponseCode(p, s) => write!(f, "HTTP Error {}: {}", s, p)
        }
    }
}

impl std::error::Error for FactoryError {}

async fn handle_json_response<D: for<'a> serde::Deserialize<'a>>(response: Response) -> Result<D, FactoryError> {
    let status_code: u16 = response.status().into();
    if status_code > 199 && status_code < 300 {
        Ok(response.json::<D>().await.map_err(FactoryError::Protocol)?)
    } else {
        match response.json::<ErrorPayload>().await {
            Ok(err) => Err(FactoryError::Response(err)),
            Err(e) => Err(FactoryError::ResponseCode(e, status_code))
        }
    }
}

/// CRF API implementation
pub struct FactoryAPI {
    client: Client,
    token: Mutex<Box<dyn ITokenProvider + Send>>,
}

impl FactoryAPI {
    /*/// Create a new instance, using `DefaultTokenProvider`.
    pub fn new() -> FactoryAPI {
        FactoryAPI {
            client: Client::new(),
            token: Box::new(DefaultTokenProvider{}),
        }
    }*/

    /// Create a new instance using the provided token provider.
    pub fn with_auth(token_provider: Box<dyn ITokenProvider + Send>) -> FactoryAPI {
        FactoryAPI {
            client: Client::new(),
            token: Mutex::new(token_provider),
        }
    }

    /// Retrieve CRF robots on the main page.
    pub async fn list(&self) -> Result<SearchResponse, FactoryError> {
        self.search(SearchPayload::default()).await
    }

    /// Search for robots on the CRF which meet the provided parameters
    pub async fn search(&self, params: SearchPayload) -> Result<SearchResponse, FactoryError> {
        let mut url = Url::parse(FACTORY_DOMAIN)
            .unwrap()
            .join("/v1/foundry/search")
            .unwrap();
        if let Some(text) = &params.text {
            url.query_pairs_mut().append_pair("text", text);
        }
        if let Some(base_minimum_cpu) = params.base_minimum_cpu {
            url.query_pairs_mut().append_pair("baseCpuMinimum", &base_minimum_cpu.to_string());
        }
        if let Some(base_maximum_cpu) = &params.base_maximum_cpu {
            url.query_pairs_mut().append_pair("baseCpuMaximum", &base_maximum_cpu.to_string());
        }
        if let Some(x) = &params.weapon_minimum_cpu {
            url.query_pairs_mut().append_pair("weaponCpuMinimum", &x.to_string());
        }
        if let Some(x) = &params.weapon_maximum_cpu {
            url.query_pairs_mut().append_pair("weaponCpuMaximum", &x.to_string());
        }
        if let Some(x) = &params.cosmetic_minimum_cpu {
            url.query_pairs_mut().append_pair("cosmeticCpuMinimum", &x.to_string());
        }
        if let Some(x) = &params.cosmetic_maximum_cpu {
            url.query_pairs_mut().append_pair("cosmeticCpuMaximum", &x.to_string());
        }
        if let Some(x) = &params.cluster_minimum {
            url.query_pairs_mut().append_pair("clusterMinimum", &x.to_string());
        }
        if let Some(x) = &params.cluster_maximum {
            url.query_pairs_mut().append_pair("clusterMaximum", &x.to_string());
        }
        if let Some(x) = &params.date_minimum {
            url.query_pairs_mut().append_pair("dateMinimum", x);
        }
        if let Some(x) = &params.date_maximum {
            url.query_pairs_mut().append_pair("dateMaximum", x);
        }
        if let Some(x) = &params.purchased_only {
            url.query_pairs_mut().append_pair("purchasedOnly", if *x { "true" } else { "false" });
        }
        if let Some(x) = &params.creator_id {
            url.query_pairs_mut().append_pair("creatorId", x);
        }
        if let Some(x) = &params.page {
            url.query_pairs_mut().append_pair("page", &x.to_string());
        }
        if let Some(x) = &params.count {
            url.query_pairs_mut().append_pair("count", &x.to_string());
        }
        url.query_pairs_mut().append_pair("sortBy", &params.sort_by);
        url.query_pairs_mut().append_pair("orderBy", &params.order_by);
        url.query_pairs_mut().append_pair("modFilter", &params.moderation_filter);
        let token = self.token.lock().unwrap().token().await.map_err(FactoryError::Protocol)?;
        let result = self.client.get(url)
            .header("Authorization", "Bearer ".to_owned() + &token)
            .send().await
            .map_err(FactoryError::Protocol)?;
        //println!("result: {}", result.text().await.map_err(FactoryError::Protocol)?);
        handle_json_response::<SearchResponse>(result).await
        //Err(FactoryError::Response(ErrorPayload { error: -42, error_message: "Disabled on purpose".to_owned() }))
    }

    pub async fn create_robot(&self, robot: CreateRobotPayload) -> Result<CreateRobotResponse, FactoryError> {
        let url = Url::parse(FACTORY_DOMAIN)
            .unwrap()
            .join("/v1/foundry/garage")
            .unwrap();
        let token = self.token.lock().unwrap().token().await.map_err(FactoryError::Protocol)?;
        let result = self.client.post(url)
            .header("Authorization", "Bearer ".to_owned() + &token)
            .header("Content-Type", "application/json")
            .json(&robot)
            .send().await
            .map_err(FactoryError::Protocol)?;
        handle_json_response::<CreateRobotResponse>(result).await
    }

    pub async fn publish_robot(&self, robot: PublishRobotPayload, id: String) -> Result<PublishRobotResponse, FactoryError> {
        let url = Url::parse(FACTORY_DOMAIN)
            .unwrap()
            .join(&format!("/v1/foundry/vehicles/{}/publish", id))
            .unwrap();
        let token = self.token.lock().unwrap().token().await.map_err(FactoryError::Protocol)?;
        let result = self.client.post(url)
            .header("Authorization", "Bearer ".to_owned() + &token)
            .header("Content-Type", "application/json")
            .json(&robot)
            .send().await
            .map_err(FactoryError::Protocol)?;
        handle_json_response(result).await
    }

    pub async fn unpublish_bot(&self, id: String) -> Result<(), FactoryError> {
        let url = Url::parse(FACTORY_DOMAIN)
            .unwrap()
            .join(&format!("/v1/foundry/vehicles/{}/unpublish", id))
            .unwrap();
        let token = self.token.lock().unwrap().token().await.map_err(FactoryError::Protocol)?;
        let result = self.client.post(url)
            .header("Authorization", "Bearer ".to_owned() + &token)
            .send().await
            .map_err(FactoryError::Protocol)?;
        let status_code = result.status().as_u16();
        if status_code > 199 && status_code < 300 {
            Ok(())
        } else {
            match result.json::<ErrorPayload>().await {
                Ok(err) => Err(FactoryError::Response(err)),
                Err(e) => Err(FactoryError::ResponseCode(e, status_code))
            }
        }
    }

    pub async fn delete_robot(&self, id: String) -> Result<(), FactoryError> {
        let url = Url::parse(FACTORY_DOMAIN)
            .unwrap()
            .join(&format!("/v1/foundry/vehicles/{}", id))
            .unwrap();
        let token = self.token.lock().unwrap().token().await.map_err(FactoryError::Protocol)?;
        let result = self.client.delete(url)
            .header("Authorization", "Bearer ".to_owned() + &token)
            .header("Content-Type", "application/json")
            .send().await
            .map_err(FactoryError::Protocol)?;
        let status_code = result.status().as_u16();
        if status_code > 199 && status_code < 300 {
            Ok(())
        } else {
            match result.json::<ErrorPayload>().await {
                Ok(err) => Err(FactoryError::Response(err)),
                Err(e) => Err(FactoryError::ResponseCode(e, status_code))
            }
        }
    }

    pub async fn factory_info(&self) -> Result<FactoryInfoResponse, FactoryError> {
        let url = Url::parse(FACTORY_DOMAIN)
            .unwrap()
            .join("/v1/foundry/info")
            .unwrap();
        let token = self.token.lock().unwrap().token().await.map_err(FactoryError::Protocol)?;
        let result = self.client.get(url)
            .header("Authorization", "Bearer ".to_owned() + &token)
            .send().await
            .map_err(FactoryError::Protocol)?;
        //println!("result: {}", result.text().await.map_err(FactoryError::Protocol)?);
        handle_json_response::<FactoryInfoResponse>(result).await
        //Err(FactoryError::Response(ErrorPayload { error: -42, error_message: "Disabled on purpose".to_owned() }))
    }

    pub async fn my_robots(&self) -> Result<MyRobotsResponse, FactoryError> {
        let url = Url::parse(FACTORY_DOMAIN)
            .unwrap()
            .join("/v1/foundry/garage")
            .unwrap();
        let token = self.token.lock().unwrap().token().await.map_err(FactoryError::Protocol)?;
        let result = self.client.get(url)
            .header("Authorization", "Bearer ".to_owned() + &token)
            .send().await
            .map_err(FactoryError::Protocol)?;
        handle_json_response::<MyRobotsResponse>(result).await
    }

    pub async fn my_published_robots(&self) -> Result<MyRobotsResponse, FactoryError> {
        let url = Url::parse(FACTORY_DOMAIN)
            .unwrap()
            .join("/v1/foundry/published")
            .unwrap();
        let token = self.token.lock().unwrap().token().await.map_err(FactoryError::Protocol)?;
        let result = self.client.get(url)
            .header("Authorization", "Bearer ".to_owned() + &token)
            .send().await
            .map_err(FactoryError::Protocol)?;
        handle_json_response::<MyRobotsResponse>(result).await
    }

    pub async fn get(&self, id: String) -> Result<GetRobotResponse, FactoryError> {
        let url = Url::parse(FACTORY_DOMAIN)
            .unwrap()
            .join(&format!("/v1/foundry/vehicles/{}", id))
            .unwrap();
        let token = self.token.lock().unwrap().token().await.map_err(FactoryError::Protocol)?;
        let result = self.client.get(url)
            .header("Authorization", "Bearer ".to_owned() + &token)
            .send().await
            .map_err(FactoryError::Protocol)?;
        //println!("result: {}", result.text().await.map_err(FactoryError::Protocol)?);
        handle_json_response::<GetRobotResponse>(result).await
        //Err(FactoryError::Response(ErrorPayload { error: -42, error_message: "Disabled on purpose".to_owned() }))
    }

    pub async fn moderate(&self, payload: ModerateRobotPayload, id: String) -> Result<(), FactoryError> {
        let url = Url::parse(FACTORY_DOMAIN)
            .unwrap()
            .join(&format!("/v1/foundry/vehicles/{}/moderate", id))
            .unwrap();
        let token = self.token.lock().unwrap().token().await.map_err(FactoryError::Protocol)?;
        let _result = self.client.post(url)
            .header("Authorization", "Bearer ".to_owned() + &token)
            .header("Content-Type", "application/json")
            .json(&payload)
            .send().await
            .map_err(FactoryError::Protocol)?;
        Ok(())
    }

    pub async fn report(&self, payload: ReportRobotPayload, id: String) -> Result<(), FactoryError> {
        let url = Url::parse(FACTORY_DOMAIN)
            .unwrap()
            .join(&format!("/v1/foundry/vehicles/{}/report", id))
            .unwrap();
        let token = self.token.lock().unwrap().token().await.map_err(FactoryError::Protocol)?;
        let _result = self.client.post(url)
            .header("Authorization", "Bearer ".to_owned() + &token)
            .header("Content-Type", "application/json")
            .json(&payload)
            .send().await
            .map_err(FactoryError::Protocol)?;
        Ok(())
    }
}