ockam_api 0.93.0

Ockam's request-response API
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

use ockam_core::errcode::{Kind, Origin};
use ockam_core::Error;

use crate::cli_state::CliState;
use crate::orchestrator::space::Space;
use crate::orchestrator::subscription::Subscription;

use super::Result;

impl CliState {
    #[instrument(skip_all, fields(space_id = space_id, space_name = space_name))]
    pub async fn store_space(
        &self,
        space_id: &str,
        space_name: &str,
        users: Vec<&str>,
        subscription: Option<&Subscription>,
    ) -> Result<Space> {
        let repository = self.spaces_repository();
        let space = Space {
            id: space_id.to_string(),
            name: space_name.to_string(),
            users: users.iter().map(|u| u.to_string()).collect(),
            subscription: subscription.cloned(),
        };

        repository.store_space(&space).await?;
        Ok(space)
    }

    #[instrument(skip_all)]
    pub async fn get_default_space(&self) -> Result<Space> {
        match self.spaces_repository().get_default_space().await? {
            Some(space) => Ok(space),
            None => Err(Error::new(
                Origin::Api,
                Kind::NotFound,
                "there is no default space",
            ))?,
        }
    }

    #[instrument(skip_all, fields(name = name))]
    pub async fn get_space_by_name(&self, name: &str) -> Result<Space> {
        match self.spaces_repository().get_space_by_name(name).await? {
            Some(space) => Ok(space),
            None => Err(Error::new(
                Origin::Api,
                Kind::NotFound,
                format!("there is no space with name {name}"),
            ))?,
        }
    }

    #[instrument(skip_all, fields(name = name))]
    pub async fn get_space_by_name_or_default(&self, name: &Option<String>) -> Result<Space> {
        match name {
            Some(name) => self.get_space_by_name(name.as_str()).await,
            None => self.get_default_space().await,
        }
    }

    #[instrument(skip_all)]
    pub async fn get_spaces(&self) -> Result<Vec<Space>> {
        Ok(self.spaces_repository().get_spaces().await?)
    }

    #[instrument(skip_all, fields(space_id = space_id))]
    pub async fn delete_space(&self, space_id: &str) -> Result<()> {
        let repository = self.spaces_repository();
        repository.delete_space(space_id).await?;
        Ok(())
    }

    #[instrument(skip_all, fields(space_id = space_id))]
    pub async fn set_space_as_default(&self, space_id: &str) -> Result<()> {
        Ok(self.spaces_repository().set_default_space(space_id).await?)
    }
}

#[cfg(test)]
mod test {
    use super::*;
    use crate::orchestrator::subscription::SubscriptionName;
    use ockam_node::database::skip_if_postgres;

    #[tokio::test]
    async fn test_cli_spaces() -> Result<()> {
        skip_if_postgres(|| async {
            let cli = CliState::test().await?;

            // the first created space becomes the default
            let space1 = cli
                .store_space(
                    "1",
                    "name1",
                    vec!["me@ockam.io", "you@ockam.io"],
                    Some(&Subscription::new(
                        SubscriptionName::Gold,
                        false,
                        None,
                        None,
                        None,
                    )),
                )
                .await?;
            let result = cli.get_default_space().await?;
            assert_eq!(result, space1);

            // the store method can be used to update a space
            let updated_space1 = cli
                .store_space("1", "name1", vec!["them@ockam.io"], None)
                .await?;
            let result = cli.get_default_space().await?;
            assert_eq!(result, updated_space1);

            Ok(())
        })
        .await
    }
}