add cost interface and unit test

Author: mschuchard

src/interface/cost.rs

@@ -0,0 +1,47 @@
+//! # Cost
+//!
+//! `interface::cost` consists of functions for interfacing with the Ruddr Cost period endpoints.
+use crate::client::client;
+use crate::model::{cost, types};
+
+/// Retrieves a specific Ruddr Cost period object by id, and deserializes it to the corresponding model struct.
+/// https://ruddr.readme.io/reference/get-a-cost-period
+/// ```ignore
+/// let cost = cost(&client, types::UUID::from("b3a100b0-8e71-4f39-9d96-32f11838aa8c")).await?;
+/// ```
+pub async fn cost(
+    client: &client::Client,
+    id: types::UUID,
+) -> Result<cost::Cost, Box<dyn std::error::Error>> {
+    // retrieve cost target period
+    Ok(client
+        .read::<cost::Cost>(&format!("cost-periods/{id}"), "")
+        .await?)
+}
+
+/// Retrieves all Ruddr Cost period objects by filters, and deserializes it to the corresponding vector of model structs.
+/// https://ruddr.readme.io/reference/list-cost-periods
+/// ```ignore
+/// let costs = costs(
+///     &client,
+///     Some(types::UUID::from("ec5543de-3b0f-47a0-b8ef-a6e18dc4b885")),
+/// ).await?;
+/// ```
+pub async fn costs(
+    client: &client::Client,
+    member_id: Option<types::UUID>,
+) -> Result<cost::Costs, Box<dyn std::error::Error>> {
+    // initialize params
+    let mut params = String::from("limit=100");
+
+    // optional parameters for LIST
+    if member_id.is_some() {
+        params = format!("{params}&memberId={}", member_id.unwrap())
+    }
+
+    // retrieve clients
+    Ok(client.read::<cost::Costs>("cost-periods", &params).await?)
+}
+
+#[cfg(test)]
+mod tests;

src/interface/cost/tests.rs

@@ -0,0 +1,43 @@
+use super::*;
+
+#[test]
+fn test_cost() {
+    let test = async {
+        let client = client::Client::new(Some("abcdefghi123456789"))
+            .expect("client with token could not be constructed");
+        assert_eq!(
+            cost(
+                &client,
+                types::UUID::from("b3a100b0-8e71-4f39-9d96-32f11838aa8c")
+            )
+            .await
+            .unwrap_err()
+            .to_string(),
+            "client read response failed",
+            "cost retrieval did not fail on auth",
+        )
+    };
+    let rt = tokio::runtime::Runtime::new().unwrap();
+    rt.block_on(test);
+}
+
+#[test]
+fn test_costs() {
+    let test = async {
+        let client = client::Client::new(Some("abcdefghi123456789"))
+            .expect("client with token could not be constructed");
+        assert_eq!(
+            costs(
+                &client,
+                Some(types::UUID::from("ec5543de-3b0f-47a0-b8ef-a6e18dc4b885")),
+            )
+            .await
+            .unwrap_err()
+            .to_string(),
+            "client read response failed",
+            "costs retrieval did not fail on auth",
+        )
+    };
+    let rt = tokio::runtime::Runtime::new().unwrap();
+    rt.block_on(test);
+}

src/interface/utilization.rs

@@ -20,7 +20,7 @@ pub async fn utilization(
 }
 
 /// Retrieves all Ruddr Utilization target period objects by filters, and deserializes it to the corresponding vector of model structs.
-/// https://ruddr.readme.io/reference/list-utilizations
+/// https://ruddr.readme.io/reference/list-utilization-target-periods
 /// ```ignore
 /// let utilizations = utilizations(
 ///     &client,

src/lib.rs

@@ -4,6 +4,7 @@ pub mod client {
 }
 pub mod interface {
     pub mod allocation;
+    pub mod cost;
     pub mod customer;
     pub mod expense_item;
     pub mod expense_report;