workos 0.8.1

Rust SDK for interacting with the WorkOS 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
138
139
140
141
142
143
144

use async_trait::async_trait;
use thiserror::Error;

use crate::directory_sync::{Directory, DirectoryId, DirectorySync};
use crate::{ResponseExt, WorkOsError, WorkOsResult};

/// An error returned from [`GetDirectory`].
#[derive(Debug, Error)]
pub enum GetDirectoryError {}

impl From<GetDirectoryError> for WorkOsError<GetDirectoryError> {
    fn from(err: GetDirectoryError) -> Self {
        Self::Operation(err)
    }
}

/// [WorkOS Docs: Get a Directory](https://workos.com/docs/reference/directory-sync/directory/get)
#[async_trait]
pub trait GetDirectory {
    /// Get the details of an existing directory.
    ///
    /// [WorkOS Docs: Get a Directory](https://workos.com/docs/reference/directory-sync/directory/get)
    ///
    /// # Examples
    ///
    /// ```
    /// # use workos::WorkOsResult;
    /// # use workos::directory_sync::*;
    /// use workos::{ApiKey, WorkOs};
    ///
    /// # async fn run() -> WorkOsResult<(), GetDirectoryError> {
    /// let workos = WorkOs::new(&ApiKey::from("sk_example_123456789"));
    ///
    /// let directory = workos
    ///     .directory_sync()
    ///     .get_directory(&DirectoryId::from("directory_01ECAZ4NV9QMV47GW873HDCX74"))
    ///     .await?;
    /// # Ok(())
    /// # }
    /// ```
    async fn get_directory(&self, id: &DirectoryId) -> WorkOsResult<Directory, GetDirectoryError>;
}

#[async_trait]
impl GetDirectory for DirectorySync<'_> {
    async fn get_directory(&self, id: &DirectoryId) -> WorkOsResult<Directory, GetDirectoryError> {
        let url = self.workos.base_url().join(&format!("/directories/{id}"))?;
        let directory = self
            .workos
            .client()
            .get(url)
            .bearer_auth(self.workos.key())
            .send()
            .await?
            .handle_unauthorized_or_generic_error()
            .await?
            .json::<Directory>()
            .await?;

        Ok(directory)
    }
}

#[cfg(test)]
mod test {
    use matches::assert_matches;
    use serde_json::json;
    use tokio;

    use crate::{ApiKey, WorkOs};

    use super::*;

    #[tokio::test]
    async fn it_calls_the_get_directory_endpoint() {
        let mut server = mockito::Server::new_async().await;

        let workos = WorkOs::builder(&ApiKey::from("sk_example_123456789"))
            .base_url(&server.url())
            .unwrap()
            .build();

        server
            .mock("GET", "/directories/directory_01ECAZ4NV9QMV47GW873HDCX74")
            .match_header("Authorization", "Bearer sk_example_123456789")
            .with_status(200)
            .with_body(
                json!({
                    "id": "directory_01ECAZ4NV9QMV47GW873HDCX74",
                    "domain": "foo-corp.com",
                    "name": "Foo Corp",
                    "organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT",
                    "state": "unlinked",
                    "type": "gsuite directory",
                    "created_at": "2021-06-25T19:07:33.155Z",
                    "updated_at": "2021-06-25T19:07:33.155Z"
                })
                .to_string(),
            )
            .create_async()
            .await;

        let directory = workos
            .directory_sync()
            .get_directory(&DirectoryId::from("directory_01ECAZ4NV9QMV47GW873HDCX74"))
            .await
            .unwrap();

        assert_eq!(
            directory.id,
            DirectoryId::from("directory_01ECAZ4NV9QMV47GW873HDCX74")
        )
    }

    #[tokio::test]
    async fn it_returns_an_error_when_the_get_directory_endpoint_returns_unauthorized() {
        let mut server = mockito::Server::new_async().await;

        let workos = WorkOs::builder(&ApiKey::from("sk_example_123456789"))
            .base_url(&server.url())
            .unwrap()
            .build();

        server
            .mock("GET", "/directories/directory_01ECAZ4NV9QMV47GW873HDCX74")
            .match_header("Authorization", "Bearer sk_example_123456789")
            .with_status(401)
            .with_body(
                json!({
                    "message": "Unauthorized"
                })
                .to_string(),
            )
            .create_async()
            .await;

        let result = workos
            .directory_sync()
            .get_directory(&DirectoryId::from("directory_01ECAZ4NV9QMV47GW873HDCX74"))
            .await;

        assert_matches!(result, Err(WorkOsError::Unauthorized))
    }
}