Merge pull request 'Coverart changes' (#65) from coverart_changes into main

Reviewed-on: #65

.gitea/workflows/tag_release.yaml

@@ -1,9 +1,9 @@
 name: Release Tagging
 
 on:
-  push:
+  pull_request:
     branches:
-      - devel
+      - main
 
 jobs:
   release:

.gitea/workflows/workflow.yaml

@@ -4,11 +4,9 @@ on:
   push:
     branches:
       - main 
-      - devel
   pull_request:
     branches:
       - main 
-      - devel
 
 jobs:
   check:

Cargo.lock

@@ -142,7 +142,7 @@ checksum = "5971ac85611da7067dbfcabef3c70ebb5606018acd9e2a3903a0da507521e0d5"
 
 [[package]]
 name = "icarus_models"
-version = "0.5.5"
+version = "0.6.6"
 dependencies = [
  "josekit",
  "rand",
@@ -150,6 +150,7 @@ dependencies = [
  "serde_json",
  "tempfile",
  "time",
+ "utoipa",
  "uuid",
 ]
 
@@ -161,6 +162,7 @@ checksum = "fe4cd85333e22411419a0bcae1297d25e58c9443848b11dc6a86fefe8c78a661"
 dependencies = [
  "equivalent",
  "hashbrown",
+ "serde",
 ]
 
 [[package]]
@@ -527,6 +529,30 @@ version = "1.0.18"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "5a5f39404a5da50712a4c1eecf25e90dd62b613502b7e925fd4e4d19b5c96512"
 
+[[package]]
+name = "utoipa"
+version = "5.4.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2fcc29c80c21c31608227e0912b2d7fddba57ad76b606890627ba8ee7964e993"
+dependencies = [
+ "indexmap",
+ "serde",
+ "serde_json",
+ "utoipa-gen",
+]
+
+[[package]]
+name = "utoipa-gen"
+version = "5.4.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "6d79d08d92ab8af4c5e8a6da20c47ae3f61a0f1dabc1997cdf2d082b757ca08b"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn",
+ "uuid",
+]
+
 [[package]]
 name = "uuid"
 version = "1.17.0"

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "icarus_models"
-version = "0.5.5"
+version = "0.6.6"
 edition = "2024"
 rust-version = "1.88"
 description = "models used for the icarus project"
@@ -13,6 +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"] }
 
 [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)]
+#[derive(Clone, Debug, Deserialize, Serialize, utoipa::ToSchema)]
 pub struct AccessLevel {
     pub id: uuid::Uuid,
     pub level: String,

src/coverart.rs

@@ -1,8 +1,8 @@
-use std::io::Read;
+use std::io::Write;
 
 use serde::{Deserialize, Serialize};
 
-#[derive(Clone, Debug, Default, Deserialize, Serialize)]
+#[derive(Clone, Debug, Default, Deserialize, Serialize, utoipa::ToSchema)]
 pub struct CoverArt {
     pub id: uuid::Uuid,
     pub title: String,
@@ -28,8 +28,39 @@ pub mod init {
 }
 
 impl CoverArt {
-    pub fn to_data(&self) -> Result<Vec<u8>, std::io::Error> {
+    /// Saves the coverart to the filesystem
-        let path: &String = &self.path;
+    pub fn save_to_filesystem(&self) -> Result<(), std::io::Error> {
+        match std::fs::File::create(&self.path) {
+            Ok(mut file) => match file.write_all(&self.data) {
+                Ok(_) => Ok(()),
+                Err(err) => Err(err),
+            },
+            Err(err) => Err(err),
+        }
+    }
+
+    /// Removes the coverart from the filesystem
+    pub fn remove_from_filesystem(&self) -> Result<(), std::io::Error> {
+        let p = std::path::Path::new(&self.path);
+        if p.exists() {
+            match std::fs::remove_file(p) {
+                Ok(_) => Ok(()),
+                Err(err) => Err(err),
+            }
+        } else {
+            Err(std::io::Error::other(
+                "Cannot delete file that does not exist",
+            ))
+        }
+    }
+}
+
+pub mod io {
+    use std::io::Read;
+
+    /// Gets the raw data of the cover art
+    pub fn to_data(coverart: &super::CoverArt) -> Result<Vec<u8>, std::io::Error> {
+        let path: &String = &coverart.path;
         let mut file = std::fs::File::open(path)?;
         let mut buffer = Vec::new();
         match file.read_to_end(&mut buffer) {

src/login_result.rs

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

src/song.rs

@@ -1,13 +1,16 @@
-use std::io::Read;
+use std::io::Write;
+
+use rand::Rng;
+use serde::{Deserialize, Serialize};
 
 use crate::constants;
 use crate::init;
 use crate::types;
 
-use rand::Rng;
+/// Length of characters of a filename to be generated
-use serde::{Deserialize, Serialize};
+const FILENAME_LENGTH: i32 = 16;
 
-#[derive(Clone, Debug, Default, Deserialize, Serialize)]
+#[derive(Clone, Debug, Default, Deserialize, Serialize, utoipa::ToSchema)]
 pub struct Song {
     #[serde(skip_serializing_if = "init::is_uuid_nil")]
     #[serde(alias = "id")]
@@ -90,10 +93,116 @@ impl Song {
         }
     }
 
-    pub fn to_data(&self) -> Result<Vec<u8>, std::io::Error> {
+    /// Saves the song to the filesystem using the song's data
-        let path_result = self.song_path();
+    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),
+        }
+    }
 
-        match path_result {
+    /// Removes the song from the filesystem
+    pub fn remove_from_filesystem(&self) -> Result<(), std::io::Error> {
+        match self.song_path() {
+            Ok(song_path) => {
+                let p = std::path::Path::new(&song_path);
+                if p.exists() {
+                    match std::fs::remove_file(p) {
+                        Ok(_) => Ok(()),
+                        Err(err) => Err(err),
+                    }
+                } else {
+                    Err(std::io::Error::other(
+                        "Cannot delete file that does not exist",
+                    ))
+                }
+            }
+            Err(err) => Err(err),
+        }
+    }
+}
+
+/// Generates a filename. In order to save a song to the filesystem, the song must have
+/// a directory and filename
+pub fn generate_filename(typ: types::MusicTypes, randomize: bool) -> String {
+    let file_extension = match typ {
+        types::MusicTypes::DefaultMusicExtension => {
+            String::from(constants::file_extensions::audio::DEFAULTMUSICEXTENSION)
+        }
+
+        types::MusicTypes::WavExtension => {
+            String::from(constants::file_extensions::audio::WAVEXTENSION)
+        }
+        types::MusicTypes::FlacExtension => {
+            String::from(constants::file_extensions::audio::FLACEXTENSION)
+        }
+        types::MusicTypes::MPThreeExtension => {
+            String::from(constants::file_extensions::audio::MPTHREEEXTENSION)
+        }
+    };
+
+    if randomize {
+        let mut filename: String = String::new();
+        let some_chars: String = String::from("abcdefghij0123456789");
+        let mut rng = rand::rng();
+
+        for _ in 0..FILENAME_LENGTH {
+            let index = rng.random_range(0..=19);
+            let rando_char = some_chars.chars().nth(index);
+
+            if let Some(c) = rando_char {
+                filename.push(c);
+            }
+        }
+        filename + &file_extension
+    } else {
+        "track-output".to_string() + &file_extension
+    }
+}
+
+/// I/O operations for songs
+pub mod io {
+    use std::io::Read;
+
+    /// Copies a song using the source song's data
+    pub fn copy_song(
+        song_source: &super::Song,
+        song_target: &mut super::Song,
+    ) -> Result<(), std::io::Error> {
+        match song_target.song_path() {
+            Ok(songpath) => {
+                let p = std::path::Path::new(&songpath);
+                if p.exists() {
+                    Err(std::io::Error::other(
+                        "Cannot copy song over to one that already exists",
+                    ))
+                } else {
+                    if song_target.data.is_empty() {
+                        song_target.data = song_source.data.clone();
+                    } else {
+                        song_target.data.clear();
+                        song_target.data = song_source.data.clone();
+                    }
+
+                    match song_target.save_to_filesystem() {
+                        Ok(_) => Ok(()),
+                        Err(err) => Err(err),
+                    }
+                }
+            }
+            Err(err) => Err(err),
+        }
+    }
+
+    /// Gets the raw file data of a song from the filesystem
+    pub fn to_data(song: &super::Song) -> Result<Vec<u8>, std::io::Error> {
+        match song.song_path() {
             Ok(path) => {
                 let mut file = std::fs::File::open(path)?;
                 let mut buffer: Vec<u8> = Vec::new();
@@ -108,46 +217,4 @@ impl Song {
             Err(er) => Err(er),
         }
     }
-
-    pub fn generate_filename(&self, typ: types::MusicTypes, randomize: bool) -> String {
-        let mut filename: String = String::new();
-        let filename_len = 10;
-
-        let file_extension = match typ {
-            types::MusicTypes::DefaultMusicExtension => {
-                String::from(constants::file_extensions::audio::DEFAULTMUSICEXTENSION)
-            }
-
-            types::MusicTypes::WavExtension => {
-                String::from(constants::file_extensions::audio::WAVEXTENSION)
-            }
-            types::MusicTypes::FlacExtension => {
-                String::from(constants::file_extensions::audio::FLACEXTENSION)
-            }
-            types::MusicTypes::MPThreeExtension => {
-                String::from(constants::file_extensions::audio::MPTHREEEXTENSION)
-            }
-        };
-
-        if randomize {
-            let some_chars: String = String::from("abcdefghij0123456789");
-            let mut rng = rand::rng();
-
-            for _i in 0..filename_len {
-                let random_number: i32 = rng.random_range(0..=19);
-                let index = random_number as usize;
-                let rando_char = some_chars.chars().nth(index);
-
-                if let Some(c) = rando_char {
-                    filename.push(c);
-                }
-            }
-        } else {
-            filename += "track-output";
-        }
-
-        filename += &file_extension;
-
-        filename
-    }
 }

src/user.rs

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

tests/tests.rs

@@ -30,16 +30,12 @@ mod utils {
 
 #[cfg(test)]
 mod song_tests {
-    use std::fs::File;
-    use std::io::Write;
-
     use tempfile::tempdir;
 
+    use crate::utils;
     use icarus_models::song;
     use icarus_models::types;
 
-    use crate::utils;
-
     #[test]
     fn test_song_to_data() {
         println!("Test");
@@ -65,7 +61,7 @@ mod song_tests {
                 Ok(buffer) => {
                     assert_eq!(buffer.is_empty(), false);
 
-                    match song.to_data() {
+                    match song::io::to_data(&song) {
                         Ok(song_data) => {
                             println!("Both files match");
                             assert_eq!(buffer, song_data);
@@ -103,50 +99,47 @@ mod song_tests {
         song.directory = utils::get_tests_directory();
         song.filename = String::from("track01.flac");
 
-        match song.song_path() {
+        let mut song_cpy = song.clone();
-            Ok(songpath) => match utils::extract_data_from_file(&songpath) {
+        let temp_dir = tempdir().expect("Failed to create temp dir");
-                Ok(buffer) => {
+        song_cpy.directory = match temp_dir.path().to_str() {
-                    let mut song_cpy = song.clone();
+            Some(s) => String::from(s),
-                    let temp_dir = tempdir().expect("Failed to create temp dir");
+            None => String::new(),
-                    song_cpy.directory = match temp_dir.path().to_str() {
+        };
-                        Some(s) => String::from(s),
-                        None => String::new(),
-                    };
 
-                    assert_eq!(song.directory.is_empty(), false);
+        assert_eq!(song.directory.is_empty(), false);
-                    song_cpy.filename =
+        song_cpy.filename = song::generate_filename(types::MusicTypes::FlacExtension, true);
-                        song.generate_filename(types::MusicTypes::FlacExtension, true);
+        println!("Directory: {:?}", song_cpy.directory);
-                    println!("Directory: {:?}", song_cpy.directory);
+        println!("File to be created: {:?}", song_cpy.filename);
-                    println!("File to be created: {:?}", song_cpy.filename);
 
-                    let path = match song_cpy.song_path() {
+        match song::io::copy_song(&song, &mut song_cpy) {
-                        Ok(s_path) => s_path,
+            Ok(_) => {}
-                        Err(err) => {
+            Err(err) => {
-                            assert!(false, "Error: {:?}", err);
+                assert!(false, "Error copying song: Error: {err:?}")
-                            String::new()
+            }
-                        }
+        }
-                    };
+    }
 
-                    match File::create(path) {
+    #[test]
-                        Ok(mut file_cpy) => match file_cpy.write_all(&buffer) {
+    fn test_save_song_to_filesystem_and_remove() {
-                            Ok(success) => {
+        let mut song = song::Song::default();
-                                println!("Success: {:?}", success);
+        song.directory = utils::get_tests_directory();
-                            }
+        song.filename = String::from("track02.flac");
-                            Err(err) => {
+
-                                assert!(false, "Error saving file: {:?}", err);
+        let mut copied_song = song::Song {
-                            }
+            directory: utils::get_tests_directory(),
-                        },
+            filename: String::from("track02-coppied.flac"),
-                        Err(err) => {
+            ..Default::default()
-                            assert!(false, "Error: {:?}", err);
+        };
-                        }
+
-                    };
+        match song::io::copy_song(&song, &mut copied_song) {
-                }
+            Ok(_) => match copied_song.remove_from_filesystem() {
+                Ok(_) => {}
                 Err(err) => {
-                    assert!(false, "Error: {:?}", err);
+                    assert!(false, "Error: {err:?}")
                 }
             },
             Err(err) => {
-                assert!(false, "Error extracting song data: {:?}", err);
+                assert!(false, "Error: {err:?}")
             }
         }
     }
@@ -154,7 +147,6 @@ mod song_tests {
 
 #[cfg(test)]
 mod album_tests {
-
     use crate::utils;
     use icarus_models::album;