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

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

use crate::mfa::{AuthenticationFactor, AuthenticationFactorId, Mfa};
use crate::{ResponseExt, WorkOsError, WorkOsResult};

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

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

/// [WorkOS Docs: Get Factor](https://workos.com/docs/reference/mfa/get-factor)
#[async_trait]
pub trait GetFactor {
    /// Gets an Authentication Factor.
    ///
    /// [WorkOS Docs: Get Factor](https://workos.com/docs/reference/mfa/get-factor)
    ///
    /// # Examples
    ///
    /// ```
    /// # use workos::WorkOsResult;
    /// # use workos::mfa::*;
    /// use workos::{ApiKey, WorkOs};
    ///
    /// # async fn run() -> WorkOsResult<(), GetFactorError> {
    /// let workos = WorkOs::new(&ApiKey::from("sk_example_123456789"));
    ///
    /// let factor = workos
    ///     .mfa()
    ///     .get_factor(&AuthenticationFactorId::from("auth_factor_01FVYZ5QM8N98T9ME5BCB2BBMJ"))
    ///     .await?;
    /// # Ok(())
    /// # }
    /// ```
    async fn get_factor(
        &self,
        id: &AuthenticationFactorId,
    ) -> WorkOsResult<AuthenticationFactor, GetFactorError>;
}

#[async_trait]
impl GetFactor for Mfa<'_> {
    async fn get_factor(
        &self,
        id: &AuthenticationFactorId,
    ) -> WorkOsResult<AuthenticationFactor, GetFactorError> {
        let url = self
            .workos
            .base_url()
            .join(&format!("/auth/factors/{id}"))?;

        let organization = self
            .workos
            .client()
            .get(url)
            .bearer_auth(self.workos.key())
            .send()
            .await?
            .handle_unauthorized_or_generic_error()
            .await?
            .json::<AuthenticationFactor>()
            .await?;

        Ok(organization)
    }
}

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

    use crate::{ApiKey, WorkOs};

    use super::*;

    #[tokio::test]
    async fn it_calls_the_get_factor_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", "/auth/factors/auth_factor_01FVYZ5QM8N98T9ME5BCB2BBMJ")
            .match_header("Authorization", "Bearer sk_example_123456789")
            .with_status(200)
            .with_body(
                json!({
                "object": "authentication_factor",
                "id": "auth_factor_01FVYZ5QM8N98T9ME5BCB2BBMJ",
                "created_at": "2022-02-15T15:14:19.392Z",
                "updated_at": "2022-02-15T15:14:19.392Z",
                "type": "totp",
                "totp": {
                    "issuer": "Foo Corp",
                    "user": "alan.turing@foo-corp.com",
                    "qr_code": "data:image/png;base64,{base64EncodedPng}",
                    "secret": "NAGCCFS3EYRB422HNAKAKY3XDUORMSRF",
                    "uri": "otpauth://totp/FooCorp:alan.turing@example.com?secret=NAGCCFS3EYRB422HNAKAKY3XDUORMSRF&issuer=FooCorp"
                }
                })
                .to_string(),
            )
            .create_async()
            .await;

        let factor = workos
            .mfa()
            .get_factor(&AuthenticationFactorId::from(
                "auth_factor_01FVYZ5QM8N98T9ME5BCB2BBMJ",
            ))
            .await
            .unwrap();

        assert_eq!(
            factor.id,
            AuthenticationFactorId::from("auth_factor_01FVYZ5QM8N98T9ME5BCB2BBMJ")
        )
    }
}