user_and_salt (#27)

Reviewed-on: #27
Co-authored-by: phoenix <kundeng94@gmail.com>
Co-committed-by: phoenix <kundeng94@gmail.com>

.gitea/workflows/tag_release.yaml

@@ -3,14 +3,13 @@ name: Release Tagging
 on:
   push:
     branches:
-      - main
       - devel
     tags:
       - 'v*' # Trigger on tags matching v*
 
 jobs:
   release:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     steps:
       - name: Checkout code
         uses: actions/checkout@v3

.gitea/workflows/workflow.yaml

@@ -13,7 +13,7 @@ on:
 jobs:
   check:
     name: Check
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
       - uses: actions-rust-lang/setup-rust-toolchain@v1
@@ -23,7 +23,7 @@ jobs:
 
   test:
     name: Test Suite
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
       - uses: actions-rust-lang/setup-rust-toolchain@v1
@@ -33,7 +33,7 @@ jobs:
 
   fmt:
     name: Rustfmt
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
       - uses: actions-rust-lang/setup-rust-toolchain@v1
@@ -44,7 +44,7 @@ jobs:
 
   clippy:
     name: Clippy
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
       - uses: actions-rust-lang/setup-rust-toolchain@v1
@@ -55,7 +55,7 @@ jobs:
 
   build:
     name: build
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
       - uses: actions-rust-lang/setup-rust-toolchain@v1

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
-name = "icarus-models"
-version = "0.1.14"
+name = "icarus_models"
+version = "0.3.0"
 edition = "2024"
 description = "models used for the icarus project"
 license = "MIT"
@@ -9,4 +9,6 @@ license = "MIT"
 serde = { version = "1.0.218", features = ["derive"] }
 serde_json = { version = "1.0.139" }
 rand = { version = "0.9" }
+uuid = { version = "1.16.0", features = ["v4", "serde"] }
+[dev-dependencies]
 tempfile = { version = "3.19.1" }

src/access_level.rs

@@ -4,34 +4,34 @@ use serde::{Deserialize, Serialize};
 
 #[derive(Clone, Debug, Deserialize, Serialize)]
 pub struct AccessLevel {
-    pub id: i32,
+    pub id: uuid::Uuid,
     pub level: String,
-    pub song_id: i32,
+    pub song_id: uuid::Uuid,
 }
 
 impl Default for AccessLevel {
     fn default() -> Self {
         AccessLevel {
-            id: -1,
+            id: uuid::Uuid::nil(),
             level: String::new(),
-            song_id: -1,
+            song_id: uuid::Uuid::new_v4(),
         }
     }
 }
 
 pub fn default_level() -> AccessLevel {
     AccessLevel {
-        id: -1,
+        id: uuid::Uuid::nil(),
         level: String::from("Public"),
-        song_id: -1,
+        song_id: uuid::Uuid::new_v4(),
     }
 }
 
 pub fn private_level() -> AccessLevel {
     AccessLevel {
-        id: -1,
+        id: uuid::Uuid::new_v4(),
         level: String::from("Private"),
-        song_id: -1,
+        song_id: uuid::Uuid::new_v4(),
     }
 }
 

src/album.rs

@@ -5,9 +5,7 @@ pub mod collection {
     use std::fs::File;
     use std::io::BufReader;
 
-    fn is_set(num: &i32) -> bool {
-        *num >= 0
-    }
+    use crate::init;
 
     pub fn parse_album(filepath: &String) -> Result<Album, serde_json::Error> {
         let file = File::open(filepath).expect("Failed to open file");
@@ -27,7 +25,7 @@ pub mod collection {
         pub genre: String,
         pub year: i32,
         pub track_count: i32,
-        #[serde(skip_serializing_if = "is_set")]
+        #[serde(skip_serializing_if = "init::is_set")]
         pub disc_count: i32,
         #[serde(skip_serializing_if = "Vec::is_empty")]
         pub tracks: Vec<Track>,

src/coverart.rs

@@ -4,12 +4,25 @@ use serde::{Deserialize, Serialize};
 
 #[derive(Clone, Debug, Default, Deserialize, Serialize)]
 pub struct CoverArt {
-    pub id: i32,
+    pub id: uuid::Uuid,
     pub title: String,
     pub path: String,
     pub data: Vec<u8>,
 }
 
+pub mod init {
+    use crate::coverart::CoverArt;
+
+    pub fn init_coverart_only_path(path: String) -> CoverArt {
+        CoverArt {
+            id: uuid::Uuid::nil(),
+            title: String::new(),
+            path: path.clone(),
+            data: Vec::new(),
+        }
+    }
+}
+
 impl CoverArt {
     pub fn to_data(&self) -> Result<Vec<u8>, std::io::Error> {
         let path: &String = &self.path;
@@ -21,3 +34,16 @@ impl CoverArt {
         }
     }
 }
+
+#[cfg(test)]
+mod tests {
+    use crate::coverart;
+
+    #[test]
+    fn test_cover_art_image() {
+        let path: String = String::from("somepath");
+        let coverart = coverart::init::init_coverart_only_path(path.clone());
+
+        assert_eq!(path, coverart.path);
+    }
+}

src/lib.rs

@@ -7,3 +7,25 @@ pub mod song;
 pub mod token;
 pub mod types;
 pub mod user;
+
+pub mod init {
+    pub fn is_id_valid(num: &i32) -> bool {
+        *num > 0
+    }
+
+    pub fn is_uuid_nil(uuid: &uuid::Uuid) -> bool {
+        uuid.is_nil()
+    }
+
+    pub fn is_zero(num: &i32) -> bool {
+        *num == 0
+    }
+
+    pub fn is_dur_not_set(num: &i32) -> bool {
+        *num == 0
+    }
+
+    pub fn is_set(num: &i32) -> bool {
+        *num >= 0
+    }
+}

src/login_result.rs

@@ -4,7 +4,7 @@ use serde::{Deserialize, Serialize};
 
 #[derive(Clone, Debug, Deserialize, Serialize)]
 pub struct LoginResult {
-    pub id: i32,
+    pub id: uuid::Uuid,
     pub username: String,
     pub token: String,
     #[serde(alias = "token_type")]
@@ -15,7 +15,7 @@ pub struct LoginResult {
 impl Default for LoginResult {
     fn default() -> Self {
         LoginResult {
-            id: -1,
+            id: uuid::Uuid::nil(),
             username: String::new(),
             token: String::new(),
             token_type: String::new(),

src/song.rs

@@ -1,6 +1,7 @@
 use std::io::Read;
 
 use crate::constants;
+use crate::init;
 use crate::types;
 
 use rand::Rng;
@@ -8,9 +9,9 @@ use serde::{Deserialize, Serialize};
 
 #[derive(Clone, Debug, Default, Deserialize, Serialize)]
 pub struct Song {
-    #[serde(skip_serializing_if = "is_zero")]
+    #[serde(skip_serializing_if = "init::is_uuid_nil")]
     #[serde(alias = "id")]
-    pub id: i32,
+    pub id: uuid::Uuid,
     #[serde(skip_serializing_if = "String::is_empty")]
     pub title: String,
     #[serde(skip_serializing_if = "String::is_empty")]
@@ -21,17 +22,17 @@ pub struct Song {
     pub album_artist: String,
     #[serde(skip_serializing_if = "String::is_empty")]
     pub genre: String,
-    #[serde(skip_serializing_if = "is_zero")]
+    #[serde(skip_serializing_if = "init::is_zero")]
     pub year: i32,
-    #[serde(skip_serializing_if = "is_dur_not_set")]
+    #[serde(skip_serializing_if = "init::is_dur_not_set")]
     pub duration: i32,
-    #[serde(skip_serializing_if = "is_zero")]
+    #[serde(skip_serializing_if = "init::is_zero")]
     pub track: i32,
-    #[serde(skip_serializing_if = "is_zero")]
+    #[serde(skip_serializing_if = "init::is_zero")]
     pub disc: i32,
-    #[serde(skip_serializing_if = "is_zero")]
+    #[serde(skip_serializing_if = "init::is_zero")]
     pub disc_count: i32,
-    #[serde(skip_serializing_if = "is_zero")]
+    #[serde(skip_serializing_if = "init::is_zero")]
     pub track_count: i32,
     #[serde(skip_serializing_if = "String::is_empty")]
     pub audio_type: String,
@@ -39,8 +40,8 @@ pub struct Song {
     pub date_created: String,
     #[serde(skip_serializing_if = "String::is_empty")]
     pub filename: String,
-    #[serde(skip_serializing_if = "is_zero")]
-    pub user_id: i32,
+    #[serde(skip_serializing_if = "init::is_uuid_nil")]
+    pub user_id: uuid::Uuid,
     #[serde(skip)]
     pub data: Vec<u8>,
     #[serde(skip)]
@@ -55,14 +56,6 @@ pub struct Song {
     // pub coverart_id: i32,
 }
 
-fn is_zero(num: &i32) -> bool {
-    *num == 0
-}
-
-fn is_dur_not_set(num: &i32) -> bool {
-    *num == 0
-}
-
 impl Song {
     pub fn to_metadata_json(&self, pretty: bool) -> Result<String, serde_json::Error> {
         if pretty {
@@ -234,9 +227,9 @@ mod embedded {
     // The song's duration is a floating point in seconds
     #[derive(Clone, Debug, Deserialize, Serialize)]
     pub struct Song {
-        #[serde(skip_serializing_if = "is_embed_zero")]
+        #[serde(skip_serializing_if = "init::is_uuid_nil")]
         #[serde(alias = "id")]
-        pub id: i32,
+        pub id: uuid::Uuid,
         #[serde(skip_serializing_if = "String::is_empty")]
         pub title: String,
         #[serde(skip_serializing_if = "String::is_empty")]
@@ -247,17 +240,17 @@ mod embedded {
         pub album_artist: String,
         #[serde(skip_serializing_if = "String::is_empty")]
         pub genre: String,
-        #[serde(skip_serializing_if = "is_embed_zero")]
+        #[serde(skip_serializing_if = "init::is_embed_zero")]
         pub year: i32,
-        #[serde(skip_serializing_if = "is_embed_dur_not_set")]
+        #[serde(skip_serializing_if = "init::is_embed_dur_not_set")]
         pub duration: f64,
-        #[serde(skip_serializing_if = "is_embed_zero")]
+        #[serde(skip_serializing_if = "init::is_embed_zero")]
         pub track: i32,
-        #[serde(skip_serializing_if = "is_embed_zero")]
+        #[serde(skip_serializing_if = "init::is_embed_zero")]
         pub disc: i32,
-        #[serde(skip_serializing_if = "is_embed_zero")]
+        #[serde(skip_serializing_if = "init::is_embed_zero")]
         pub disc_count: i32,
-        #[serde(skip_serializing_if = "is_embed_zero")]
+        #[serde(skip_serializing_if = "init::is_embed_zero")]
         pub track_count: i32,
         #[serde(skip_serializing_if = "String::is_empty")]
         pub audio_type: String,
@@ -265,7 +258,7 @@ mod embedded {
         pub date_created: String,
         #[serde(skip_serializing_if = "String::is_empty")]
         pub filename: String,
-        #[serde(skip_serializing_if = "is_embed_zero")]
+        #[serde(skip_serializing_if = "init::is_embed_zero")]
         pub user_id: i32,
         #[serde(skip)]
         pub data: Vec<u8>,
@@ -281,18 +274,11 @@ mod embedded {
         // pub coverart_id: i32,
     }
 
-    fn is_embed_zero(num: &i32) -> bool {
-        *num == 0
-    }
-
-    fn is_embed_dur_not_set(num: &f64) -> bool {
-        *num == 0.0
-    }
 
     impl Default for Song {
         fn default() -> Self {
             Song {
-                id: 0,
+                id: uuid::Uuid::nil(),
                 title: String::new(),
                 artist: String::new(),
                 album: String::new(),

src/token.rs

@@ -13,8 +13,8 @@ pub struct Token {
 
 #[derive(Clone, Debug, Deserialize, Serialize)]
 pub struct AccessToken {
-    #[serde(alias = "user_id")]
-    pub user_id: i32,
+    #[serde(alias = "init::is_uuid_nil")]
+    pub user_id: uuid::Uuid,
     #[serde(alias = "username")]
     pub username: String,
     #[serde(alias = "token")]

src/user.rs

@@ -1,11 +1,13 @@
 use std::default::Default;
 
+use crate::init;
+
 use serde::{Deserialize, Serialize};
 
 #[derive(Clone, Debug, Deserialize, Serialize)]
 pub struct User {
-    #[serde(skip_serializing_if = "is_id_valid")]
-    pub id: i32,
+    #[serde(skip_serializing_if = "init::is_uuid_nil")]
+    pub id: uuid::Uuid,
     #[serde(skip_serializing_if = "String::is_empty")]
     pub username: String,
     #[serde(skip_serializing_if = "String::is_empty")]
@@ -25,16 +27,14 @@ pub struct User {
     pub status: String,
     #[serde(skip_serializing_if = "String::is_empty")]
     pub last_login: String,
-}
-
-fn is_id_valid(num: &i32) -> bool {
-    *num > 0
+    #[serde(skip_serializing_if = "init::is_uuid_nil")]
+    pub salt_id: uuid::Uuid,
 }
 
 impl Default for User {
     fn default() -> Self {
         User {
-            id: -1,
+            id: uuid::Uuid::new_v4(),
             username: String::new(),
             password: String::new(),
             email: String::new(),
@@ -45,6 +45,7 @@ impl Default for User {
             date_created: String::new(),
             status: String::new(),
             last_login: String::new(),
+            salt_id: uuid::Uuid::nil(),
         }
     }
 }
@@ -58,3 +59,29 @@ impl User {
         }
     }
 }
+
+pub mod salt {
+    use std::default::Default;
+
+    use crate::init;
+
+    use serde::{Deserialize, Serialize};
+
+    #[derive(Clone, Debug, Default, Deserialize, Serialize)]
+    pub struct Salt {
+        #[serde(skip_serializing_if = "init::is_uuid_nil")]
+        pub id: uuid::Uuid,
+        #[serde(skip_serializing_if = "String::is_empty")]
+        pub salt: String,
+    }
+
+    impl Salt {
+        pub fn to_json(&self, output_pretty: bool) -> Result<String, serde_json::Error> {
+            if output_pretty {
+                serde_json::to_string_pretty(&self)
+            } else {
+                serde_json::to_string(&self)
+            }
+        }
+    }
+}

tests/tests.rs

@@ -28,6 +28,7 @@ mod utils {
     }
 }
 
+#[cfg(test)]
 mod song_tests {
     use std::fs::File;
     use std::io::Write;
@@ -151,6 +152,7 @@ mod song_tests {
     }
 }
 
+#[cfg(test)]
 mod album_tests {
 
     use crate::utils;