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
145
146
147
148
149
150
151
152
153
154
155
156
157

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

use crate::sso::{Connection, ConnectionId, Sso};
use crate::{ResponseExt, WorkOsError, WorkOsResult};

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

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

/// [WorkOS Docs: Get a Connection](https://workos.com/docs/reference/sso/connection/get)
#[async_trait]
pub trait GetConnection {
    /// Retrieves a [`Connection`] by its ID.
    ///
    /// [WorkOS Docs: Get a Connection](https://workos.com/docs/reference/sso/connection/get)
    ///
    /// # Examples
    ///
    /// ```
    /// # use workos::WorkOsResult;
    /// # use workos::sso::*;
    /// use workos::{ApiKey, WorkOs};
    ///
    /// # async fn run() -> WorkOsResult<(), GetConnectionError> {
    /// let workos = WorkOs::new(&ApiKey::from("sk_example_123456789"));
    ///
    /// let connection = workos
    ///     .sso()
    ///     .get_connection(&ConnectionId::from("conn_01E4ZCR3C56J083X43JQXF3JK5"))
    ///     .await?;
    /// # Ok(())
    /// # }
    /// ```
    async fn get_connection(
        &self,
        id: &ConnectionId,
    ) -> WorkOsResult<Connection, GetConnectionError>;
}

#[async_trait]
impl GetConnection for Sso<'_> {
    async fn get_connection(
        &self,
        id: &ConnectionId,
    ) -> WorkOsResult<Connection, GetConnectionError> {
        let url = self.workos.base_url().join(&format!("/connections/{id}"))?;
        let connection = self
            .workos
            .client()
            .get(url)
            .bearer_auth(self.workos.key())
            .send()
            .await?
            .handle_unauthorized_or_generic_error()
            .await?
            .json::<Connection>()
            .await?;

        Ok(connection)
    }
}

#[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_connection_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", "/connections/conn_01E4ZCR3C56J083X43JQXF3JK5")
            .match_header("Authorization", "Bearer sk_example_123456789")
            .with_status(200)
            .with_body(
                json!({
                  "object": "connection",
                  "id": "conn_01E4ZCR3C56J083X43JQXF3JK5",
                  "organization_id": "org_01EHWNCE74X7JSDV0X3SZ3KJNY",
                  "connection_type": "GoogleOAuth",
                  "name": "Foo Corp",
                  "state": "active",
                  "created_at": "2021-06-25T19:07:33.155Z",
                  "updated_at": "2021-06-25T19:07:33.155Z",
                  "domains": [
                    {
                      "id": "conn_domain_01EHWNFTAFCF3CQAE5A9Q0P1YB",
                      "object": "connection_domain",
                      "domain": "foo-corp.com"
                    }
                  ]
                })
                .to_string(),
            )
            .create_async()
            .await;

        let connection = workos
            .sso()
            .get_connection(&ConnectionId::from("conn_01E4ZCR3C56J083X43JQXF3JK5"))
            .await
            .unwrap();

        assert_eq!(
            connection.id,
            ConnectionId::from("conn_01E4ZCR3C56J083X43JQXF3JK5")
        )
    }

    #[tokio::test]
    async fn it_returns_an_error_when_the_get_connection_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", "/connections/conn_01E4ZCR3C56J083X43JQXF3JK5")
            .match_header("Authorization", "Bearer sk_example_123456789")
            .with_status(401)
            .with_body(
                json!({
                    "message": "Unauthorized"
                })
                .to_string(),
            )
            .create_async()
            .await;

        let result = workos
            .sso()
            .get_connection(&ConnectionId::from("conn_01E4ZCR3C56J083X43JQXF3JK5"))
            .await;

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