feat(user-management): add get user by external id (#58)

Author: DanielleHuisman

src/user_management/operations.rs

@@ -17,6 +17,7 @@ mod get_logout_url;
 mod get_magic_auth;
 mod get_password_reset;
 mod get_user;
+mod get_user_by_external_id;
 mod get_user_identities;
 mod list_auth_factors;
 mod list_users;
@@ -42,6 +43,7 @@ pub use get_logout_url::*;
 pub use get_magic_auth::*;
 pub use get_password_reset::*;
 pub use get_user::*;
+pub use get_user_by_external_id::*;
 pub use get_user_identities::*;
 pub use list_auth_factors::*;
 pub use list_users::*;

src/user_management/operations/get_user_by_external_id.rs

@@ -0,0 +1,127 @@
+use async_trait::async_trait;
+use thiserror::Error;
+
+use crate::user_management::{User, UserManagement};
+use crate::{ResponseExt, WorkOsError, WorkOsResult};
+
+/// An error returned from [`GetUserByExternalId`].
+#[derive(Debug, Error)]
+pub enum GetUserByExternalIdError {}
+
+impl From<GetUserByExternalIdError> for WorkOsError<GetUserByExternalIdError> {
+    fn from(err: GetUserByExternalIdError) -> Self {
+        Self::Operation(err)
+    }
+}
+
+/// [WorkOS Docs: Get a user by external ID](https://workos.com/docs/reference/user-management/user/get-by-external-id)
+#[async_trait]
+pub trait GetUserByExternalId {
+    /// Get the details of an existing user by an external identifier.
+    ///
+    /// [WorkOS Docs: Get a user by external ID](https://workos.com/docs/reference/user-management/user/get-by-external-id)
+    ///
+    /// # Examples
+    ///
+    /// ```
+    /// # use workos_sdk::WorkOsResult;
+    /// # use workos_sdk::user_management::*;
+    /// use workos_sdk::{ApiKey, WorkOs};
+    ///
+    /// # async fn run() -> WorkOsResult<(), GetUserByExternalIdError> {
+    /// let workos = WorkOs::new(&ApiKey::from("sk_example_123456789"));
+    ///
+    /// let user = workos
+    ///     .user_management()
+    ///     .get_user_by_external_id("f1ffa2b2-c20b-4d39-be5c-212726e11222")
+    ///     .await?;
+    /// # Ok(())
+    /// # }
+    /// ```
+    async fn get_user_by_external_id(
+        &self,
+        external_id: &str,
+    ) -> WorkOsResult<User, GetUserByExternalIdError>;
+}
+
+#[async_trait]
+impl GetUserByExternalId for UserManagement<'_> {
+    async fn get_user_by_external_id(
+        &self,
+        external_id: &str,
+    ) -> WorkOsResult<User, GetUserByExternalIdError> {
+        let url = self
+            .workos
+            .base_url()
+            .join(&format!("/user_management/users/external_id/{external_id}"))?;
+        let user = self
+            .workos
+            .client()
+            .get(url)
+            .bearer_auth(self.workos.key())
+            .send()
+            .await?
+            .handle_unauthorized_or_generic_error()?
+            .json::<User>()
+            .await?;
+
+        Ok(user)
+    }
+}
+
+#[cfg(test)]
+mod test {
+    use serde_json::json;
+    use tokio;
+
+    use crate::{user_management::UserId, ApiKey, WorkOs};
+
+    use super::*;
+
+    #[tokio::test]
+    async fn it_calls_the_get_user_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",
+                "/user_management/users/external_id/f1ffa2b2-c20b-4d39-be5c-212726e11222",
+            )
+            .match_header("Authorization", "Bearer sk_example_123456789")
+            .with_status(200)
+            .with_body(
+                json!({
+                    "object": "user",
+                    "id": "user_01E4ZCR3C56J083X43JQXF3JK5",
+                    "email": "marcelina.davis@example.com",
+                    "first_name": "Marcelina",
+                    "last_name": "Davis",
+                    "email_verified": true,
+                    "profile_picture_url": "https://workoscdn.com/images/v1/123abc",
+                    "last_sign_in_at": "2021-06-25T19:07:33.155Z",
+                    "external_id": "f1ffa2b2-c20b-4d39-be5c-212726e11222",
+                    "metadata": {
+                        "language": "en"
+                    },
+                    "created_at": "2021-06-25T19:07:33.155Z",
+                    "updated_at": "2021-06-25T19:07:33.155Z"
+                })
+                .to_string(),
+            )
+            .create_async()
+            .await;
+
+        let user = workos
+            .user_management()
+            .get_user_by_external_id("f1ffa2b2-c20b-4d39-be5c-212726e11222")
+            .await
+            .unwrap();
+
+        assert_eq!(user.id, UserId::from("user_01E4ZCR3C56J083X43JQXF3JK5"))
+    }
+}