klbfw 0.1.3

Comprehensive REST API client with OAuth2, API key authentication, and file upload support
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

/// Configuration for REST API client
#[derive(Debug, Clone)]
pub struct Config {
    /// URL scheme (http or https)
    scheme: String,
    /// API host (may include a `:port` suffix)
    host: String,
    /// Enable debug logging
    debug: bool,
}

impl Default for Config {
    fn default() -> Self {
        Config {
            scheme: "https".to_string(),
            host: "www.atonline.com".to_string(),
            debug: false,
        }
    }
}

impl Config {
    /// Create a new configuration with the given scheme and host
    pub fn new(scheme: String, host: String) -> Self {
        Config {
            scheme,
            host,
            debug: false,
        }
    }

    /// Create a configuration for the given host, keeping the default `https`
    /// scheme.
    ///
    /// The host may include a `:port` suffix. Use [`new`](Self::new) to also
    /// override the scheme.
    pub fn for_host(host: impl Into<String>) -> Self {
        Config {
            host: host.into(),
            ..Config::default()
        }
    }

    /// Set debug mode (builder style)
    pub fn with_debug(mut self, debug: bool) -> Self {
        self.debug = debug;
        self
    }

    /// Set debug mode in place
    pub fn set_debug(&mut self, debug: bool) {
        self.debug = debug;
    }

    /// URL scheme (http or https)
    pub fn scheme(&self) -> &str {
        &self.scheme
    }

    /// API host (may include a `:port` suffix)
    pub fn host(&self) -> &str {
        &self.host
    }

    /// Whether debug logging is enabled
    pub fn debug(&self) -> bool {
        self.debug
    }

    /// Get the base URL for API requests.
    ///
    /// Non-ASCII hostnames are IDNA-encoded (punycode); a `:port` suffix is
    /// preserved as-is.
    pub fn base_url(&self) -> String {
        format!("{}://{}", self.scheme, self.encoded_host())
    }

    /// IDNA-encode the host, leaving an optional `:port` suffix untouched.
    fn encoded_host(&self) -> String {
        // Split an optional numeric port suffix off the host.
        let (host, port) = match self.host.rsplit_once(':') {
            Some((h, p)) if !p.is_empty() && p.chars().all(|c| c.is_ascii_digit()) => (h, Some(p)),
            _ => (self.host.as_str(), None),
        };

        let encoded = if host.is_ascii() {
            host.to_string()
        } else {
            // Fall back to the raw host if IDNA encoding fails.
            intl::unicode::idna::to_ascii(host).unwrap_or_else(|_| host.to_string())
        };

        match port {
            Some(p) => format!("{}:{}", encoded, p),
            None => encoded,
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_base_url_default() {
        let config = Config::default();
        assert_eq!(config.base_url(), "https://www.atonline.com");
    }

    #[test]
    fn test_base_url_with_port() {
        let config = Config::new("http".to_string(), "localhost:8080".to_string());
        assert_eq!(config.base_url(), "http://localhost:8080");
    }

    #[test]
    fn test_for_host_keeps_default_scheme() {
        let config = Config::for_host("api.example.com");
        assert_eq!(config.scheme(), "https");
        assert_eq!(config.host(), "api.example.com");
        assert_eq!(config.base_url(), "https://api.example.com");
    }

    #[test]
    fn test_base_url_idna() {
        let config = Config::new("https".to_string(), "bücher.example".to_string());
        assert_eq!(config.base_url(), "https://xn--bcher-kva.example");
    }
}