containers_api/
url.rs

1//! Utility functions to handle URL manipulation.
2
3pub use url;
4
5use std::{borrow::Borrow, string::ToString};
6use url::form_urlencoded;
7
8/// Creates an endpoint with a query
9pub fn construct_ep<E, Q>(ep: E, query: Option<Q>) -> String
10where
11    E: Into<String>,
12    Q: AsRef<str>,
13{
14    let mut ep = ep.into();
15    if let Some(query) = query {
16        append_query(&mut ep, query);
17    }
18    ep
19}
20
21/// Appends a query to an endpoint
22pub fn append_query<Q>(ep: &mut String, query: Q)
23where
24    Q: AsRef<str>,
25{
26    ep.push('?');
27    ep.push_str(query.as_ref());
28}
29
30/// Encodes `key` and `val` as urlencoded values.
31pub fn encoded_pair<K, V>(key: K, val: V) -> String
32where
33    K: AsRef<str>,
34    V: ToString,
35{
36    form_urlencoded::Serializer::new(String::new())
37        .append_pair(key.as_ref(), &val.to_string())
38        .finish()
39}
40
41/// Encodes multiple values for the same key
42pub fn encoded_vec_pairs<K, I>(pairs: impl IntoIterator<Item = (K, I)>) -> String
43where
44    K: AsRef<str>,
45    I: IntoIterator,
46    I::Item: AsRef<str>,
47{
48    let mut serializer = form_urlencoded::Serializer::new(String::new());
49    pairs.into_iter().for_each(|(key, vals)| {
50        let key = key.as_ref();
51        vals.into_iter().for_each(|val| {
52            serializer.append_pair(key, val.as_ref());
53        });
54    });
55
56    serializer.finish()
57}
58
59/// Encodes an iterator of key:value pairs as urlencoded values.
60pub fn encoded_pairs<I, K, V>(iter: I) -> String
61where
62    I: IntoIterator,
63    I::Item: Borrow<(K, V)>,
64    K: AsRef<str>,
65    V: AsRef<str>,
66{
67    iter.into_iter()
68        .fold(
69            form_urlencoded::Serializer::new(String::new()),
70            |mut acc, v| {
71                let (k, v) = v.borrow();
72                let k = k.as_ref();
73                let v = v.as_ref();
74                if v.is_empty() {
75                    acc.append_key_only(k);
76                } else {
77                    acc.append_pair(k, v);
78                }
79                acc
80            },
81        )
82        .finish()
83}
84
85#[cfg(test)]
86mod tests {
87    use super::{append_query, construct_ep, encoded_pair, encoded_pairs, encoded_vec_pairs};
88
89    #[test]
90    fn appends_query() {
91        let mut ep = "http://somewebsite.xxx".to_owned();
92        let query = "lang=en";
93        let want = "http://somewebsite.xxx?lang=en";
94        append_query(&mut ep, query);
95        assert_eq!(ep, want);
96    }
97
98    #[test]
99    fn constructs_endpoint() {
100        let ep = "http://somewebsite.xxx";
101        let query = "lang=en,id=55555";
102        let want = "http://somewebsite.xxx?lang=en,id=55555";
103        assert_eq!(construct_ep(ep, None::<&str>), ep);
104        assert_eq!(construct_ep(ep, Some(query)), want);
105    }
106
107    #[test]
108    fn encodes_pair() {
109        let key = "lang";
110        let val = "en&";
111        let want = "lang=en%26";
112        assert_eq!(encoded_pair(key, val), want);
113    }
114
115    #[test]
116    fn encodes_pairs() {
117        let pairs = [("lang", "en&"), ("id", "1337"), ("country", "xxx")];
118        let want = "lang=en%26&id=1337&country=xxx";
119        assert_eq!(encoded_pairs(pairs), want);
120    }
121
122    #[test]
123    fn encodes_vec_pairs() {
124        let pairs = [
125            ("lang", vec!["en", "pl&"]),
126            ("id", vec!["1337"]),
127            ("country", vec!["xxx", "yyy", "zzz"]),
128        ];
129        let want = "lang=en&lang=pl%26&id=1337&country=xxx&country=yyy&country=zzz";
130        assert_eq!(encoded_vec_pairs(pairs), want);
131    }
132}
containers_api/url.rs

containers_api/
url.rs
