ruddr 1.1.1

A lightweight Ruddr SDK Rust crate
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

//! # Request
//!
//! `client::request` consists of functions for constructing and executing requests against the Ruddr API.
use log;
use reqwest::Url;

// request struct for composing request structures
#[derive(Debug)]
pub(super) struct Request {
    url: Url,
}

impl Request {
    // request constructor with endpoint and params
    pub(super) fn new(
        endpoint: &str,
        params: Option<&str>,
    ) -> Result<Self, Box<dyn std::error::Error>> {
        // validate endpoint is not empty
        if endpoint.is_empty() {
            log::error!("endpoint is empty");
            return Err(Box::from("invalid empty endpoint"));
        }

        // prefix params with "?" char if they are specified
        match params {
            Some(params) => {
                log::debug!("request endpoint is {endpoint} and params is {params}");
                Ok(Self {
                    url: Url::parse(&format!(
                        "https://www.ruddr.io/api/workspace/{endpoint}?{params}"
                    ))?,
                })
            }
            None => {
                log::debug!("request endpoint is {endpoint} and params is empty");
                Ok(Self {
                    url: Url::parse(&format!("https://www.ruddr.io/api/workspace/{endpoint}"))?,
                })
            }
        }
    }

    // execute get request with client
    pub(super) async fn get(
        &self,
        client: &reqwest::Client,
    ) -> Result<reqwest::Response, Box<dyn std::error::Error>> {
        // execute request and receive response
        log::debug!("initiating GET request at {}", self.url);
        let response = client.get(self.url.as_str()).send().await?;

        log::debug!("response received for GET request");
        Ok(response)
    }
}

#[cfg(test)]
mod tests;