tsk-57: Adding utoipia crate for documentation

Cargo.lock

@@ -142,7 +142,7 @@ checksum = "5971ac85611da7067dbfcabef3c70ebb5606018acd9e2a3903a0da507521e0d5"
 
 [[package]]
 name = "icarus_models"
-version = "0.5.6"
+version = "0.5.5"
 dependencies = [
  "josekit",
  "rand",
@@ -550,7 +550,6 @@ dependencies = [
  "proc-macro2",
  "quote",
  "syn",
- "uuid",
 ]
 
 [[package]]

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "icarus_models"
-version = "0.5.6"
+version = "0.5.5"
 edition = "2024"
 rust-version = "1.88"
 description = "models used for the icarus project"
@@ -13,7 +13,7 @@ rand = { version = "0.9.1" }
 time = { version = "0.3.41", features = ["formatting", "macros", "parsing", "serde"] }
 uuid = { version = "1.17.0", features = ["v4", "serde"] }
 josekit = { version = "0.10.3" }
-utoipa = { version = "5.4.0", features = ["uuid", "time"] }
+utoipa = { version = "5.4.0" }
 
 [dev-dependencies]
 tempfile = { version = "3.20.0" }

src/access_level.rs

@@ -2,7 +2,7 @@ use std::default::Default;
 
 use serde::{Deserialize, Serialize};
 
-#[derive(Clone, Debug, Deserialize, Serialize, utoipa::ToSchema)]
+#[derive(Clone, Debug, Deserialize, Serialize)]
 pub struct AccessLevel {
     pub id: uuid::Uuid,
     pub level: String,

src/coverart.rs

@@ -2,7 +2,7 @@ use std::io::Read;
 
 use serde::{Deserialize, Serialize};
 
-#[derive(Clone, Debug, Default, Deserialize, Serialize, utoipa::ToSchema)]
+#[derive(Clone, Debug, Default, Deserialize, Serialize)]
 pub struct CoverArt {
     pub id: uuid::Uuid,
     pub title: String,
@@ -37,9 +37,6 @@ impl CoverArt {
             Err(err) => Err(err),
         }
     }
-
-    // TODO: Add method to save to filesystem
-    // TODO: Add method to remove from filesystem
 }
 
 #[cfg(test)]

src/login_result.rs

@@ -2,7 +2,7 @@ use std::default::Default;
 
 use serde::{Deserialize, Serialize};
 
-#[derive(Clone, Debug, Deserialize, Serialize, utoipa::ToSchema)]
+#[derive(Clone, Debug, Deserialize, Serialize)]
 pub struct LoginResult {
     pub id: uuid::Uuid,
     pub username: String,

src/song.rs

@@ -1,4 +1,4 @@
-use std::io::{Read, Write};
+use std::io::Read;
 
 use crate::constants;
 use crate::init;
@@ -7,7 +7,7 @@ use crate::types;
 use rand::Rng;
 use serde::{Deserialize, Serialize};
 
-#[derive(Clone, Debug, Default, Deserialize, Serialize, utoipa::ToSchema)]
+#[derive(Clone, Debug, Default, Deserialize, Serialize)]
 pub struct Song {
     #[serde(skip_serializing_if = "init::is_uuid_nil")]
     #[serde(alias = "id")]
@@ -90,7 +90,6 @@ impl Song {
         }
     }
 
-    // TODO: Make this available as a function
     pub fn to_data(&self) -> Result<Vec<u8>, std::io::Error> {
         let path_result = self.song_path();
 
@@ -110,7 +109,6 @@ impl Song {
         }
     }
 
-    // TODO: Make this available as a function
     pub fn generate_filename(&self, typ: types::MusicTypes, randomize: bool) -> String {
         let mut filename: String = String::new();
         let filename_len = 10;
@@ -152,21 +150,4 @@ impl Song {
 
         filename
     }
-
-    pub fn save_to_filesystem(&self) -> Result<(), std::io::Error> {
-        match self.song_path() {
-            Ok(song_path) => match std::fs::File::create(&song_path) {
-                Ok(mut file) => match file.write_all(&self.data) {
-                    Ok(_res) => Ok(()),
-                    Err(err) => Err(err),
-                },
-                Err(err) => Err(err),
-            },
-            Err(err) => Err(err),
-        }
-    }
-
-    // TODO: Add function to remove file from the filesystem
 }
-
-// TODO: Add function to copy song

src/user.rs

@@ -4,7 +4,7 @@ use crate::init;
 
 use serde::{Deserialize, Serialize};
 
-#[derive(Clone, Debug, Deserialize, Serialize, utoipa::ToSchema)]
+#[derive(Clone, Debug, Deserialize, Serialize)]
 pub struct User {
     #[serde(skip_serializing_if = "init::is_uuid_nil")]
     pub id: uuid::Uuid,

tests/tests.rs

@@ -150,39 +150,6 @@ mod song_tests {
             }
         }
     }
-
-    #[test]
-    fn test_save_song_to_filesystem() {
-        let mut song = song::Song::default();
-        song.directory = utils::get_tests_directory();
-        song.filename = String::from("track02.flac");
-
-        match song.song_path() {
-            Ok(song_path) => match utils::extract_data_from_file(&song_path) {
-                Ok(data) => {
-                    let copied_song = song::Song {
-                        directory: utils::get_tests_directory(),
-                        filename: String::from("track02-coppied.flac"),
-                        data: data,
-                        ..Default::default()
-                    };
-
-                    match copied_song.save_to_filesystem() {
-                        Ok(_) => {}
-                        Err(err) => {
-                            assert!(false, "Error: {err:?}")
-                        }
-                    }
-                }
-                Err(err) => {
-                    assert!(false, "Error: {err:?}")
-                }
-            },
-            Err(err) => {
-                assert!(false, "Error: {err:?}");
-            }
-        }
-    }
 }
 
 #[cfg(test)]