speedrun-api 1.3.0

A wrapper for the speedrun.com REST 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

use std::borrow::Borrow;

use serde::Serialize;
use url::Url;

use super::error::BodyError;

pub struct QueryParams<'a>(form_urlencoded::Serializer<'a, String>);

impl QueryParams<'_> {
    pub(crate) fn new() -> Self {
        Self(form_urlencoded::Serializer::new(String::new()))
    }

    #[allow(dead_code)]
    pub(crate) fn clear(&mut self) -> &mut Self {
        self.0.clear();
        self
    }

    #[allow(dead_code)]
    pub(crate) fn append_pair(
        &mut self,
        key: impl AsRef<str>,
        value: impl AsRef<str>,
    ) -> &mut Self {
        self.0.append_pair(key.as_ref(), value.as_ref());
        self
    }

    #[allow(dead_code)]
    pub(crate) fn extend_pairs<I, K, V>(&mut self, iter: I) -> &mut Self
    where
        I: IntoIterator,
        I::Item: Borrow<(K, V)>,
        K: AsRef<str>,
        V: AsRef<str>,
    {
        self.0.extend_pairs(iter);
        self
    }

    pub(crate) fn extend_from(&mut self, value: &impl Serialize) -> Result<&mut Self, BodyError> {
        value.serialize(self.serializer())?;
        Ok(self)
    }

    pub(crate) fn with(value: &impl Serialize) -> Result<Self, BodyError> {
        let mut out = Self::new();
        out.extend_from(value)?;
        Ok(out)
    }

    pub(crate) fn apply_to(self, url: &mut Url) {
        let query = &self.finish();
        if !query.is_empty() {
            url.set_query(Some(query))
        }
    }

    pub(crate) fn finish(mut self) -> String {
        self.0.finish()
    }
}

impl<'a> QueryParams<'a> {
    pub(crate) fn serializer<'b>(&'b mut self) -> serde_urlencoded::Serializer<'a, 'b, String> {
        serde_urlencoded::Serializer::new(&mut self.0)
    }
}

impl<'a> Default for QueryParams<'a> {
    fn default() -> Self {
        Self::new()
    }
}

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

    #[test]
    fn empty_query_params() {
        let mut url = Url::parse("https://example.com/").unwrap();
        let params = QueryParams::new();
        params.apply_to(&mut url);

        assert_eq!(url.as_str(), "https://example.com/");

        let mut url = Url::parse("https://example.com/?foo=bar").unwrap();
        let params = QueryParams::new();
        params.apply_to(&mut url);

        assert_eq!(url.as_str(), "https://example.com/?foo=bar");
    }

    #[test]
    fn extend_from_empty() {
        #[derive(Debug, Serialize)]
        struct A {
            foo: String,
            bar: usize,
        }

        let mut params = QueryParams::new();

        let a = A {
            foo: "abcdef".into(),
            bar: 7,
        };

        params.extend_from(&a).unwrap();

        assert_eq!(params.finish(), String::from("foo=abcdef&bar=7"))
    }

    #[test]
    fn extend_from() {
        #[derive(Debug, Serialize)]
        struct A {
            foo: String,
            bar: usize,
        }

        let mut params = QueryParams::new();
        params.append_pair("some", "value");

        let a = A {
            foo: "abcdef".into(),
            bar: 7,
        };

        params.extend_from(&a).unwrap();

        assert_eq!(params.finish(), String::from("some=value&foo=abcdef&bar=7"))
    }
}