squarecloud 0.1.1

Async Rust client for the SquareCloud 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

use chrono::{DateTime, Utc};
use serde::{Deserialize, Serialize};

use crate::{http::ApiClient, resources::WorkspaceResource};

/// A member of a SquareCloud workspace.
#[derive(Debug, Serialize, Deserialize)]
pub struct WorkspaceMember {
    /// The member's account identifier.
    pub id: String,
    /// The member's display name.
    pub name: String,
    /// The permission group assigned to this member (e.g. `"admin"`,
    /// `"member"`).
    pub group: String,
    /// The UTC timestamp when this member joined the workspace.
    #[serde(rename = "joinedAt")]
    pub joined_at: DateTime<Utc>,
}

/// Summary of an application that belongs to a workspace.
#[derive(Debug, Serialize, Deserialize)]
pub struct WorkspaceApp {
    /// The application's unique identifier.
    pub id: String,
    /// The application's display name.
    pub name: String,
    /// A short description of the application.
    pub desc: Option<String>,
    /// RAM allocation in megabytes.
    pub ram: u32,
    /// The programming language or runtime the application uses.
    pub lang: String,
    /// The primary domain assigned by SquareCloud, if any.
    pub domain: Option<String>,
    /// A custom domain configured by the owner, if any.
    pub custom: Option<String>,
}

/// Full details for a SquareCloud workspace.
///
/// Returned by [`ApiClient::all_workspaces`](crate::ApiClient::all_workspaces),
/// [`ApiClient::create_workspace`](crate::ApiClient::create_workspace), and
/// [`WorkspaceResource::info`](crate::resources::WorkspaceResource::info). To
/// obtain a [`WorkspaceResource`] handle from this value, call
/// [`into_resource`](WorkspaceInfo::into_resource).
#[derive(Debug, Serialize, Deserialize)]
pub struct WorkspaceInfo {
    /// The workspace's unique identifier.
    pub id: String,
    /// The workspace's display name.
    pub name: String,
    /// The account identifier of the workspace owner.
    pub owner: String,
    /// All current members of the workspace.
    #[serde(default)]
    pub members: Vec<WorkspaceMember>,
    /// All applications currently assigned to the workspace.
    #[serde(default)]
    pub applications: Vec<WorkspaceApp>,
    /// The UTC timestamp when the workspace was created.
    #[serde(rename = "createdAt")]
    pub created_at: DateTime<Utc>,
}

impl WorkspaceInfo {
    /// Converts this value into a [`WorkspaceResource`] handle bound to `api`.
    pub fn into_resource(&self, api: ApiClient) -> WorkspaceResource {
        WorkspaceResource::new(api, &self.id)
    }
}

#[cfg(test)]
mod tests {
    use chrono::Utc;

    use super::WorkspaceInfo;
    use crate::http::ApiClient;

    #[test]
    fn into_resource_binds_correct_id() {
        unsafe { std::env::set_var("API_TOKEN", "test") };
        let ws = WorkspaceInfo {
            id: "ws-abc".to_string(),
            name: "test".to_string(),
            owner: "owner-id".to_string(),
            members: vec![],
            applications: vec![],
            created_at: Utc::now(),
        };
        let resource = ws.into_resource(ApiClient::new());
        assert_eq!(resource.id, "ws-abc");
    }
}