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

use reqwest::{Client, Error};
use url::{Url};

use crate::robocraft::{ITokenProvider, DefaultTokenProvider, FactoryInfo, FactorySearchBuilder, RoboShopItemsInfo, FactoryRobotGetInfo};
use crate::robocraft::factory_json::ListPayload;

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

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

impl FactoryAPI {
    /// Create a new instance, using `DefaultTokenProvider`.
    pub fn new() -> FactoryAPI {
        FactoryAPI {
            client: Client::new(),
            token: Box::new(DefaultTokenProvider{}),
            domain: Url::parse(FACTORY_DOMAIN).unwrap(),
        }
    }
    
    /// Create a new instance using the provided token provider.
    pub fn with_auth<T: ITokenProvider + Send + Sync + 'static>(token_provider: T) -> FactoryAPI {
        FactoryAPI {
            client: Client::new(),
            token: Box::new(token_provider),
            domain: Url::parse(FACTORY_DOMAIN).unwrap(),
        }
    }

    /// Override root URL of API
    pub fn with_domain(mut self, root_url: &str) -> Result<Self, url::ParseError> {
        self.domain = Url::parse(root_url)?;
        Ok(self)
    }
    
    /// Retrieve CRF robots on the main page.
    ///
    /// For searching, use `list_builder()` instead.
    pub async fn list(&self) -> Result<FactoryInfo<RoboShopItemsInfo>, Error> {
        let url = self.domain
            .join("/api/roboShopItems/list")
            .unwrap();
        let payload = ListPayload::default();
        let mut request_builder = self.client.post(url)
            .json(&payload);
        if let Ok(token) = self.token.token() {
            request_builder = request_builder.header("Authorization", format!("{} {}", self.token.scheme(), token));
        }
        let result = request_builder.send().await;
        if let Ok(response) = result {
            return response.json::<FactoryInfo<RoboShopItemsInfo>>().await;
        }
        Err(result.err().unwrap())
    }
    
    /// Build a CRF search query.
    ///
    /// This follows the builder pattern, so functions can be chained.
    pub fn list_builder(&self) -> FactorySearchBuilder {
        let url = self.domain
            .join("/api/roboShopItems/list")
            .unwrap();
        let mut token_opt = None;
        if let Ok(token) = self.token.token() {
            token_opt = Some((self.token.scheme(), token));
        }
        let request_builder = self.client.post(url);
        FactorySearchBuilder::new(request_builder, token_opt)
    }
    
    /// Get in-depth info on a CRF robot.
    ///
    /// `item_id` corresponds to the field with the same name for FactoryRobotGetInfo and FactoryRobotListInfo.
    pub async fn get(&self, item_id: usize) -> Result<FactoryInfo<FactoryRobotGetInfo>, Error> {
        let url = self.domain
            .join(&format!("/api/roboShopItems/get/{}", item_id))
            .unwrap();
        let mut request_builder = self.client.get(url);
        if let Ok(token) = self.token.token() {
            request_builder = request_builder.header("Authorization", format!("{} {}", self.token.scheme(), token));
        }
        let result = request_builder.send().await;
        if let Ok(response) = result {
            return response.json::<FactoryInfo<FactoryRobotGetInfo>>().await;
        }
        Err(result.err().unwrap())
    }
}