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
60
61
62
63
64
65
66

//! # Project
//!
//! `interface::project` consists of functions for interfacing with the Ruddr Project endpoints.
use std::fmt::Write;

use crate::client::client;
use crate::model::{enums, project, types};

/// Retrieves a specific Ruddr Project object by id, and deserializes it to the corresponding model struct.
/// [API Documentation](https://ruddr.readme.io/reference/get-a-project)
/// ```ignore
/// let project = project(&client, types::UUID::try_from("095e0780-48bf-472c-8deb-2fc3ebc7d90c").expect("invalid UUID")).await?;
/// ```
pub async fn project(
    client: &client::Client,
    id: types::UUID,
) -> Result<project::Project, Box<dyn std::error::Error>> {
    // retrieve project
    Ok(client
        .read::<project::Project>(&format!("projects/{id}"), None)
        .await?)
}

/// Retrieves the first 100 Ruddr Project objects by filters, and deserializes it to the corresponding vector of model structs.
/// [API Documentation](https://ruddr.readme.io/reference/list-projects)
/// ```ignore
/// let projects = projects(
///     &client,
///     Some(types::UUID::try_from("d5afaffe-09e5-4d73-b02c-905b40fc6c22").expect("invalid UUID")),
///     Some(types::UUID::try_from("9b0927a6-35a1-4795-a4ca-10167b05f7de").expect("invalid UUID")),
///     Some(enums::Status::InProgress),
///     Some("my_project"),
/// ).await?;
/// ```
pub async fn projects(
    client: &client::Client,
    client_id: Option<types::UUID>,
    project_type: Option<types::UUID>,
    status: Option<enums::Status>,
    name_contains: Option<&str>,
) -> Result<project::Projects, Box<dyn std::error::Error>> {
    // initialize params
    let mut params = String::from("limit=100");

    // optional parameters for LIST
    if let Some(client_id) = client_id {
        write!(params, "&clientId={}", client_id)?;
    }
    if let Some(project_type) = project_type {
        write!(params, "&projectTypeId={}", project_type)?;
    }
    if let Some(status) = status {
        write!(params, "&statusId={}", status)?;
    }
    if let Some(name_contains) = name_contains {
        write!(params, "&nameContains={}", name_contains)?;
    }

    // retrieve projects
    Ok(client
        .read::<project::Projects>("projects", Some(&params))
        .await?)
}

#[cfg(test)]
mod tests;