add interface for project roles

Author: mschuchard

CHANGELOG.md

@@ -1,3 +1,6 @@
+### 1.1.0 (Next)
+- Add support for project roles.
+
 ### 1.0.0
 - First official release.
 

src/interface/role.rs

@@ -0,0 +1,52 @@
+//! # Role
+//!
+//! `interface::role` consists of functions for interfacing with the Ruddr Role endpoints.
+use std::fmt::Write;
+
+use crate::client::client;
+use crate::model::role;
+use crate::model::{enums, types};
+
+/// Retrieves a specific Ruddr Role object by id, and deserializes it to the corresponding model struct.
+/// [API Documentation](https://ruddr.readme.io/reference/get-a-project-role)
+/// ```ignore
+/// let role = role(&client, types::UUID::try_from("7ad5a34a-07b7-48e9-a760-bd220d52e354").expect("uuid conversion failed")).await?;
+/// ```
+pub async fn role(
+    client: &client::Client,
+    id: types::UUID,
+) -> Result<role::Role, Box<dyn std::error::Error>> {
+    // retrieve role
+    Ok(client
+        .read::<role::Role>(&format!("project-roles/{id}"), None)
+        .await?)
+}
+
+/// Retrieves all Ruddr Role objects by filters, and deserializes it to the corresponding vector of model structs.
+/// [API Documentation](https://ruddr.readme.io/reference/list-project-roles)
+/// ```ignore
+/// let roles = roles(
+///     &client,
+///     Some(types::UUID::try_from("095e0780-48bf-472c-8deb-2fc3ebc7d90c").expect("uuid conversion failed")),
+/// ).await?;
+/// ```
+pub async fn roles(
+    client: &client::Client,
+    project: Option<types::UUID>,
+) -> Result<role::Roles, Box<dyn std::error::Error>> {
+    // initialize params
+    let mut params = String::from("limit=100");
+
+    // optional parameters for LIST
+    if let Some(project) = project {
+        write!(params, "&projectId={}", project)?;
+    }
+
+    // retrieve roles
+    Ok(client
+        .read::<role::Roles>("project-roles", Some(&params))
+        .await?)
+}
+
+#[cfg(test)]
+mod tests;

src/interface/role/tests.rs

@@ -0,0 +1,47 @@
+use super::*;
+
+#[test]
+fn test_role() {
+    let test = async {
+        let client = client::Client::new(Some("abcdefghi123456789"))
+            .expect("client with token could not be constructed");
+        assert_eq!(
+            role(
+                &client,
+                types::UUID::try_from("7ad5a34a-07b7-48e9-a760-bd220d52e354")
+                    .expect("uuid conversion failed")
+            )
+            .await
+            .unwrap_err()
+            .to_string(),
+            "client read response failed",
+            "role retrieval did not fail on auth",
+        )
+    };
+    let rt = tokio::runtime::Runtime::new().unwrap();
+    rt.block_on(test);
+}
+
+#[test]
+fn test_roles() {
+    let test = async {
+        let client = client::Client::new(Some("abcdefghi123456789"))
+            .expect("client with token could not be constructed");
+        assert_eq!(
+            roles(
+                &client,
+                Some(
+                    types::UUID::try_from("095e0780-48bf-472c-8deb-2fc3ebc7d90c")
+                        .expect("uuid conversion failed")
+                ),
+            )
+            .await
+            .unwrap_err()
+            .to_string(),
+            "client read response failed",
+            "roles retrieval did not fail on auth",
+        )
+    };
+    let rt = tokio::runtime::Runtime::new().unwrap();
+    rt.block_on(test);
+}

src/lib.rs

@@ -10,6 +10,7 @@ pub mod interface {
     pub mod expense_report;
     pub mod member;
     pub mod project;
+    pub mod role;
     pub mod time;
     pub mod utilization;
 }