tsk-194: Make distinction in MetadataQueue endpoints (#222)

* tsk-194: Moving metadata module

* tsk-194: Build fix

* tsk-194: Name changes

* tsk-194: Code formatting

* tsk-194: Version bump

* tsk-194: Test fixes

Cargo.lock

@@ -834,7 +834,7 @@ dependencies = [
 
 [[package]]
 name = "icarus"
-version = "0.3.7"
+version = "0.3.8"
 dependencies = [
  "axum",
  "axum-extra",

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "icarus"
-version = "0.3.7"
+version = "0.3.8"
 edition = "2024"
 rust-version = "1.90"
 

src/callers/mod.rs

@@ -1,11 +1,8 @@
 pub mod coverart;
-pub mod metadata;
 pub mod queue;
 pub mod song;
 
 pub mod endpoints {
-    pub const QUEUEMETADATA: &str = "/api/v2/song/metadata/queue";
-
     pub const CREATESONG: &str = "/api/v2/song";
     pub const GETSONGS: &str = "/api/v2/song";
     pub const GETALLSONGS: &str = "/api/v2/song/all";

src/callers/queue/metadata.rs

@@ -1,9 +1,8 @@
-// TODO: Explicitly make this module target queueing a song's metadata
 pub mod request {
     pub mod queue_metadata {
-        use serde::{Deserialize, Serialize};
+        #[derive(
-
+            Debug, Default, serde::Deserialize, serde::Serialize, sqlx::FromRow, utoipa::ToSchema,
-        #[derive(Debug, Default, Deserialize, Serialize, sqlx::FromRow, utoipa::ToSchema)]
+        )]
         pub struct Request {
             pub song_queue_id: uuid::Uuid,
             pub album: String,
@@ -59,9 +58,7 @@ pub mod request {
 
 pub mod response {
     pub mod queue_metadata {
-        use serde::{Deserialize, Serialize};
+        #[derive(Default, serde::Deserialize, serde::Serialize, utoipa::ToSchema)]
-
-        #[derive(Default, Deserialize, Serialize, utoipa::ToSchema)]
         pub struct Response {
             pub message: String,
             pub data: Vec<uuid::Uuid>,
@@ -69,9 +66,7 @@ pub mod response {
     }
 
     pub mod fetch_metadata {
-        use serde::{Deserialize, Serialize};
+        #[derive(Default, serde::Deserialize, serde::Serialize, utoipa::ToSchema)]
-
-        #[derive(Default, Deserialize, Serialize, utoipa::ToSchema)]
         pub struct Response {
             pub message: String,
             pub data: Vec<crate::repo::queue::metadata::MetadataQueue>,
@@ -81,8 +76,6 @@ pub mod response {
 
 /// Module for metadata related endpoints
 pub mod endpoint {
-    use axum::{Json, http::StatusCode};
-
     use crate::repo::queue as repo_queue;
 
     /// Endpoint to create queued metadata
@@ -101,8 +94,11 @@ pub mod endpoint {
     )]
     pub async fn queue_metadata(
         axum::Extension(pool): axum::Extension<sqlx::PgPool>,
-        Json(payload): Json<super::request::queue_metadata::Request>,
+        axum::Json(payload): axum::Json<super::request::queue_metadata::Request>,
-    ) -> (StatusCode, Json<super::response::queue_metadata::Response>) {
+    ) -> (
+        axum::http::StatusCode,
+        axum::Json<super::response::queue_metadata::Response>,
+    ) {
         let mut results: Vec<uuid::Uuid> = Vec::new();
         let mut response = super::response::queue_metadata::Response::default();
         let meta = payload.to_json_value().await;
@@ -113,14 +109,14 @@ pub mod endpoint {
                 response.message = if response.data.is_empty() {
                     String::from("Error")
                 } else {
-                    String::from(super::super::response::SUCCESSFUL)
+                    String::from(super::super::super::response::SUCCESSFUL)
                 };
 
-                (StatusCode::OK, Json(response))
+                (axum::http::StatusCode::OK, axum::Json(response))
             }
             Err(err) => {
                 response.message = err.to_string();
-                (StatusCode::BAD_REQUEST, Json(response))
+                (axum::http::StatusCode::BAD_REQUEST, axum::Json(response))
             }
         }
     }
@@ -141,7 +137,10 @@ pub mod endpoint {
     pub async fn fetch_metadata(
         axum::Extension(pool): axum::Extension<sqlx::PgPool>,
         axum::extract::Query(params): axum::extract::Query<super::request::fetch_metadata::Params>,
-    ) -> (StatusCode, Json<super::response::fetch_metadata::Response>) {
+    ) -> (
+        axum::http::StatusCode,
+        axum::Json<super::response::fetch_metadata::Response>,
+    ) {
         let mut response = super::response::fetch_metadata::Response::default();
 
         match params.id {
@@ -152,11 +151,11 @@ pub mod endpoint {
                     Ok(item) => {
                         response.message = String::from("Successful");
                         response.data.push(item);
-                        (StatusCode::OK, Json(response))
+                        (axum::http::StatusCode::OK, axum::Json(response))
                     }
                     Err(err) => {
                         response.message = err.to_string();
-                        (StatusCode::BAD_REQUEST, Json(response))
+                        (axum::http::StatusCode::BAD_REQUEST, axum::Json(response))
                     }
                 }
             }
@@ -168,17 +167,17 @@ pub mod endpoint {
                         Ok(item) => {
                             response.message = String::from("Successful");
                             response.data.push(item);
-                            (StatusCode::OK, Json(response))
+                            (axum::http::StatusCode::OK, axum::Json(response))
                         }
                         Err(err) => {
                             response.message = err.to_string();
-                            (StatusCode::BAD_REQUEST, Json(response))
+                            (axum::http::StatusCode::BAD_REQUEST, axum::Json(response))
                         }
                     }
                 }
                 None => {
                     println!("What is going on?");
-                    (StatusCode::BAD_REQUEST, Json(response))
+                    (axum::http::StatusCode::BAD_REQUEST, axum::Json(response))
                 }
             },
         }

src/callers/queue/mod.rs

@@ -1,4 +1,5 @@
 pub mod coverart;
+pub mod metadata;
 pub mod song;
 
 pub mod endpoints {
@@ -7,6 +8,7 @@ pub mod endpoints {
     pub const QUEUESONGDATA: &str = "/api/v2/song/queue/{id}";
     pub const QUEUESONGUPDATE: &str = "/api/v2/song/queue/{id}";
     pub const NEXTQUEUESONG: &str = "/api/v2/song/queue/next";
+    pub const QUEUEMETADATA: &str = "/api/v2/song/metadata/queue";
     pub const QUEUECOVERART: &str = "/api/v2/coverart/queue";
     pub const QUEUECOVERARTDATA: &str = "/api/v2/coverart/queue/data/{id}";
     pub const QUEUECOVERARTLINK: &str = "/api/v2/coverart/queue/link";

src/callers/song.rs

@@ -107,10 +107,11 @@ pub mod endpoint {
     use crate::repo;
     use crate::repo::queue as repo_queue;
 
+    // TODO: Change the name of this endpoint. Including the function name and path
     /// Endpoint to create song
     #[utoipa::path(
         post,
-        path = super::super::endpoints::QUEUEMETADATA,
+        path = super::super::queue::endpoints::QUEUEMETADATA,
         request_body(
             content = super::request::create_metadata::Request,
             description = "Data needed to create the song and save it to the filesystem",

src/main.rs

@@ -53,16 +53,16 @@ pub mod init {
     use utoipa::OpenApi;
 
     use crate::callers::coverart as coverart_caller;
-    use crate::callers::metadata as metadata_caller;
     use crate::callers::queue::coverart as coverart_queue_callers;
+    use crate::callers::queue::metadata as metadata_queue_caller;
     use crate::callers::queue::song as song_queue_callers;
     use crate::callers::song as song_caller;
     use coverart_caller::endpoint as coverart_endpoints;
     use coverart_caller::response as coverart_responses;
     use coverart_queue_callers::endpoint as coverart_queue_endpoints;
     use coverart_queue_callers::response as coverart_queue_responses;
-    use metadata_caller::endpoint as metadata_endpoints;
+    use metadata_queue_caller::endpoint as metadata_queue_endpoints;
-    use metadata_caller::response as metadata_responses;
+    use metadata_queue_caller::response as metadata_queue_responses;
     use song_caller::endpoint as song_endpoints;
     use song_caller::response as song_responses;
     use song_queue_callers::endpoint as song_queue_endpoints;
@@ -123,14 +123,14 @@ pub mod init {
             song_endpoints::delete_song, coverart_queue_endpoints::queue, coverart_queue_endpoints::link, coverart_queue_endpoints::fetch_coverart_no_data,
             coverart_queue_endpoints::fetch_coverart_with_data, coverart_endpoints::create_coverart, coverart_queue_endpoints::wipe_data_from_coverart_queue,
             coverart_endpoints::get_coverart, coverart_endpoints::download_coverart,
-            metadata_endpoints::queue_metadata, metadata_endpoints::fetch_metadata),
+            metadata_queue_endpoints::queue_metadata, metadata_queue_endpoints::fetch_metadata),
         components(schemas(song_queue_callers::response::song_queue::Response, song_queue_callers::response::link_user_id::Response, song_queue_callers::response::fetch_queue_song::Response,
                 song_queue_responses::update_status::Response, song_queue_callers::response::update_song_queue::Response, song_responses::create_metadata::Response,
                 song_queue_callers::response::wipe_data_from_song_queue::Response, song_responses::get_songs::Response, song_responses::delete_song::Response,
                 coverart_queue_responses::queue::Response, coverart_queue_responses::link::Response, coverart_queue_responses::fetch_coverart_no_data::Response,
                 coverart_queue_responses::fetch_coverart_with_data::Response, coverart_responses::create_coverart::Response,
                 coverart_queue_responses::wipe_data_from_coverart_queue::Response, coverart_responses::get_coverart::Response,
-                metadata_responses::queue_metadata::Response, metadata_responses::fetch_metadata::Response)),
+                metadata_queue_responses::queue_metadata::Response, metadata_queue_responses::fetch_metadata::Response)),
         tags(
             (name = "Icarus API", description = "Web API to manage music")
         )
@@ -184,14 +184,14 @@ pub mod init {
                     )),
             )
             .route(
-                crate::callers::endpoints::QUEUEMETADATA,
+                crate::callers::queue::endpoints::QUEUEMETADATA,
-                post(crate::callers::metadata::endpoint::queue_metadata).route_layer(
+                post(crate::callers::queue::metadata::endpoint::queue_metadata).route_layer(
                     axum::middleware::from_fn(crate::auth::auth::<axum::body::Body>),
                 ),
             )
             .route(
-                crate::callers::endpoints::QUEUEMETADATA,
+                crate::callers::queue::endpoints::QUEUEMETADATA,
-                get(crate::callers::metadata::endpoint::fetch_metadata).route_layer(
+                get(crate::callers::queue::metadata::endpoint::fetch_metadata).route_layer(
                     axum::middleware::from_fn(crate::auth::auth::<axum::body::Body>),
                 ),
             )
@@ -521,7 +521,11 @@ mod tests {
         app: &axum::Router,
         id: &uuid::Uuid,
     ) -> Result<axum::response::Response, std::convert::Infallible> {
-        let uri = format!("{}?id={}", crate::callers::endpoints::QUEUEMETADATA, id);
+        let uri = format!(
+            "{}?id={}",
+            crate::callers::queue::endpoints::QUEUEMETADATA,
+            id
+        );
 
         let req = axum::http::Request::builder()
             .method(axum::http::Method::GET)
@@ -583,7 +587,7 @@ mod tests {
 
         let req = axum::http::Request::builder()
             .method(axum::http::Method::POST)
-            .uri(crate::callers::endpoints::QUEUEMETADATA)
+            .uri(crate::callers::queue::endpoints::QUEUEMETADATA)
             .header(axum::http::header::CONTENT_TYPE, "application/json")
             .header(axum::http::header::AUTHORIZATION, bearer_auth().await)
             .body(axum::body::Body::from(payload.to_string()))
@@ -796,7 +800,7 @@ mod tests {
             match queue_song_flow(&app).await {
                 Ok((song_response, user_id)) => {
                     let resp = super::get_resp_data::<
-                        crate::callers::metadata::response::fetch_metadata::Response,
+                        crate::callers::queue::metadata::response::fetch_metadata::Response,
                     >(song_response)
                     .await;
                     assert_eq!(false, resp.data.is_empty(), "Data should not be empty");
@@ -1393,7 +1397,7 @@ mod tests {
         match sequence_flow::queue_song_flow(&app).await {
             Ok((response, _user_id)) => {
                 let resp = get_resp_data::<
-                    crate::callers::metadata::response::fetch_metadata::Response,
+                    crate::callers::queue::metadata::response::fetch_metadata::Response,
                 >(response)
                 .await;
                 assert_eq!(false, resp.data.is_empty(), "Data should not be empty");
@@ -1724,7 +1728,7 @@ mod tests {
         match sequence_flow::queue_song_flow(&app).await {
             Ok((response, user_id)) => {
                 let resp = get_resp_data::<
-                    crate::callers::metadata::response::fetch_metadata::Response,
+                    crate::callers::queue::metadata::response::fetch_metadata::Response,
                 >(response)
                 .await;
                 assert_eq!(false, resp.data.is_empty(), "Data should not be empty");
@@ -1787,7 +1791,7 @@ mod tests {
         match sequence_flow::queue_song_flow(&app).await {
             Ok((response, user_id)) => {
                 let resp = get_resp_data::<
-                    crate::callers::metadata::response::fetch_metadata::Response,
+                    crate::callers::queue::metadata::response::fetch_metadata::Response,
                 >(response)
                 .await;
                 assert_eq!(false, resp.data.is_empty(), "Data should not be empty");
@@ -1880,7 +1884,7 @@ mod tests {
         match sequence_flow::queue_song_flow(&app).await {
             Ok((response, user_id)) => {
                 let resp = get_resp_data::<
-                    crate::callers::metadata::response::fetch_metadata::Response,
+                    crate::callers::queue::metadata::response::fetch_metadata::Response,
                 >(response)
                 .await;
                 assert_eq!(false, resp.data.is_empty(), "Data should not be empty");
@@ -1986,7 +1990,7 @@ mod tests {
         match sequence_flow::queue_song_flow(&app).await {
             Ok((response, user_id)) => {
                 let resp = get_resp_data::<
-                    crate::callers::metadata::response::fetch_metadata::Response,
+                    crate::callers::queue::metadata::response::fetch_metadata::Response,
                 >(response)
                 .await;
                 assert_eq!(false, resp.data.is_empty(), "Data should not be empty");