Merge branch 'version_bump' into 'dev'

Updated version

See merge request kdeng00/icarus-models!35

.gitlab-ci.yml

@@ -1,6 +1,7 @@
 stages:
   - build
   - test
+  - version
   - deploy
 
 build:
@@ -40,16 +41,43 @@ test_variable:
     rules:
         - if: '$CI_COMMIT_TAG'
 
+extract_version:
+  stage: version
+  image: alpine:latest
+  script:
+    - apk add --no-cache jq
+    - VERSION=$(grep 'version = "' Cargo.toml | awk -F'"' '{print $2}' | head -n 1)
+    - VER_HASH=${CI_COMMIT_SHA:0:10}
+    - VERSION="$VERSION-$VER_HASH"
+    - if [ $? -ne 0 ]; then echo "Error extracting version"; exit 1; fi
+    - echo "Extracted version is"
+    - echo "$VERSION"
+    - echo "VERSION=$VERSION" > version.env
+  artifacts:
+    reports:
+      dotenv: version.env
+
+tag_release:
+  stage: deploy
+  image: registry.gitlab.com/gitlab-org/release-cli:latest
+  rules:
+    - if: '($CI_COMMIT_BRANCH == "dev" || $CI_COMMIT_BRANCH == "main") && $CI_PIPELINE_SOURCE == "push"'
+  dependencies:
+    - extract_version
+  script:
+    - release-cli create --name "Release $CI_COMMIT_BRANCH-v$VERSION" --tag-name "$CI_COMMIT_BRANCH-v$VERSION"
+
 deploy:
   stage: deploy
   image: rust:1.85
   script:
-    - echo "Printing environment"
-    - env
-    - cargo login "$CARGO_LOGIN_TOKEN"
-    - echo "Next step"
+    - echo "Deployment will be configured when this is ready for use"
+    # - env
+    # Uncomment when you are ready for this to be published
+    # - cargo login "$CARGO_LOGIN_TOKEN"
     # - cargo publish
   dependencies:
     - build
   rules:
     - if: '$CI_COMMIT_TAG'
+

Cargo.toml

@@ -1,9 +1,9 @@
 [package]
 name = "icarus-models"
+version = "0.1.10"
+edition = "2024"
 description = "models used for the icarus project"
 license = "MIT"
-version = "0.1.1"
-edition = "2024"
 
 [dependencies]
 serde = { version = "1.0.218", features = ["derive"] }

src/access_level.rs

@@ -19,6 +19,22 @@ impl Default for AccessLevel {
     }
 }
 
+pub fn default_level() -> AccessLevel {
+    return AccessLevel {
+        id: -1,
+        level: String::from("Public"),
+        song_id: -1,
+    };
+}
+
+pub fn private_level() -> AccessLevel {
+    return AccessLevel {
+        id: -1,
+        level: String::from("Private"),
+        song_id: -1,
+    };
+}
+
 impl AccessLevel {
     pub fn _to_json(&self) -> Result<String, serde_json::Error> {
         return serde_json::to_string_pretty(&self);

src/constants.rs

@@ -0,0 +1,5 @@
+pub const DEFAULT_MUSIC_EXTENSION: &str = FLAC_EXTENSION;
+pub const FLAC_EXTENSION: &str = ".flac";
+pub const WAV_EXTENSION: &str = ".wav";
+pub const MPTHREE_EXTENSION: &str = ".mp3";
+pub const JPG_EXTENSION: &str = ".jpg";

src/lib.rs

@@ -1,6 +1,9 @@
 pub mod access_level;
+pub mod constants;
 pub mod login_result;
+pub mod song;
 pub mod token;
+pub mod types;
 pub mod user;
 
 pub fn add(left: u64, right: u64) -> u64 {

src/song.rs

@@ -0,0 +1,307 @@
+use std::default::Default;
+use std::io::Read;
+
+use serde::{Deserialize, Serialize};
+
+#[derive(Clone, Debug, Deserialize, Serialize)]
+pub struct Song {
+    #[serde(skip_serializing_if = "is_zero")]
+    #[serde(alias = "id")]
+    pub id: i32,
+    #[serde(skip_serializing_if = "String::is_empty")]
+    pub title: String,
+    #[serde(skip_serializing_if = "String::is_empty")]
+    pub artist: String,
+    #[serde(skip_serializing_if = "String::is_empty")]
+    pub album: String,
+    #[serde(skip_serializing_if = "String::is_empty")]
+    pub album_artist: String,
+    #[serde(skip_serializing_if = "String::is_empty")]
+    pub genre: String,
+    #[serde(skip_serializing_if = "is_zero")]
+    pub year: i32,
+    #[serde(skip_serializing_if = "is_dur_not_set")]
+    pub duration: i32,
+    #[serde(skip_serializing_if = "is_zero")]
+    pub track: i32,
+    #[serde(skip_serializing_if = "is_zero")]
+    pub disc: i32,
+    #[serde(skip_serializing_if = "is_zero")]
+    pub disc_count: i32,
+    #[serde(skip_serializing_if = "is_zero")]
+    pub track_count: i32,
+    #[serde(skip_serializing_if = "String::is_empty")]
+    pub audio_type: String,
+    #[serde(skip_serializing_if = "String::is_empty")]
+    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)]
+    pub data: Vec<u8>,
+    #[serde(skip)]
+    pub directory: String,
+    #[serde(skip)]
+    pub album_id: i32,
+    #[serde(skip)]
+    pub artist_id: i32,
+    #[serde(skip)]
+    pub genre_id: i32,
+    #[serde(skip)]
+    pub coverart_id: i32,
+}
+
+fn is_zero(num: &i32) -> bool {
+    *num == 0
+}
+
+fn is_dur_not_set(num: &i32) -> bool {
+    *num == 0
+}
+
+impl Default for Song {
+    fn default() -> Self {
+        Song {
+            id: 0,
+            title: String::new(),
+            artist: String::new(),
+            album: String::new(),
+            album_artist: String::new(),
+            genre: String::new(),
+            year: 0,
+            duration: 0,
+            track: 0,
+            disc: 0,
+            disc_count: 0,
+            track_count: 0,
+            audio_type: String::new(),
+            date_created: String::new(),
+            filename: String::new(),
+            user_id: 0,
+            data: Vec::new(),
+            directory: String::new(),
+            album_id: 0,
+            artist_id: 0,
+            genre_id: 0,
+            coverart_id: 0,
+        }
+    }
+}
+
+impl Song {
+    pub fn to_metadata_json(&self, pretty: bool) -> Result<String, serde_json::Error> {
+        if pretty {
+            return serde_json::to_string_pretty(&self);
+        } else {
+            return serde_json::to_string(&self);
+        }
+    }
+
+    pub fn song_path(&self) -> Result<String, std::io::Error> {
+        if self.directory.is_empty() {
+            return Err(std::io::Error::new(
+                std::io::ErrorKind::Other,
+                "Directory does not exist",
+            ));
+        }
+
+        let directory = &self.directory;
+        let mut buffer: String = String::from(directory.clone());
+        let lastIndex = directory.len() - 1;
+
+        if let Some(character) = directory.chars().nth(lastIndex) {
+            if character != '/' {
+                buffer += "/";
+            }
+
+            buffer += &self.filename.clone();
+
+            return Ok(buffer);
+        } else {
+            return Err(std::io::Error::new(
+                std::io::ErrorKind::Other,
+                "Could not access last character of directory",
+            ));
+        }
+    }
+
+    pub fn to_data(&self) -> Result<Vec<u8>, std::io::Error> {
+        let pathResult = self.song_path();
+
+        match pathResult {
+            Ok(path) => {
+                let mut file = std::fs::File::open(path)?;
+                let mut buffer: Vec<u8> = Vec::new();
+                file.read_to_end(&mut buffer)?;
+
+                if buffer.len() == 0 {
+                    return Err(std::io::Error::new(
+                        std::io::ErrorKind::Other,
+                        "File is empty",
+                    ));
+                } else {
+                    return Ok(buffer);
+                }
+            }
+            Err(er) => {
+                return Err(er);
+            }
+        }
+    }
+}
+
+mod embedded {
+    use std::io::Read;
+
+    use serde::{Deserialize, Serialize};
+
+    impl Song {
+        pub fn to_metadata_json(&self, pretty: bool) -> Result<String, serde_json::Error> {
+            if pretty {
+                return serde_json::to_string_pretty(&self);
+            } else {
+                return serde_json::to_string(&self);
+            }
+        }
+
+        pub fn song_path(&self) -> Result<String, std::io::Error> {
+            if self.directory.is_empty() {
+                return Err(std::io::Error::new(
+                    std::io::ErrorKind::Other,
+                    "Directory does not exist",
+                ));
+            }
+
+            let directory = &self.directory;
+            let mut buffer: String = String::from(directory.clone());
+            let lastIndex = directory.len() - 1;
+
+            if let Some(character) = directory.chars().nth(lastIndex) {
+                if character != '/' {
+                    buffer += "/";
+                }
+
+                buffer += &self.filename.clone();
+
+                return Ok(buffer);
+            } else {
+                return Err(std::io::Error::new(
+                    std::io::ErrorKind::Other,
+                    "Could not access last character of directory",
+                ));
+            }
+        }
+
+        pub fn to_data(&self) -> Result<Vec<u8>, std::io::Error> {
+            let pathResult = self.song_path();
+
+            match pathResult {
+                Ok(path) => {
+                    let mut file = std::fs::File::open(path)?;
+                    let mut buffer: Vec<u8> = Vec::new();
+                    file.read_to_end(&mut buffer)?;
+
+                    if buffer.len() == 0 {
+                        return Err(std::io::Error::new(
+                            std::io::ErrorKind::Other,
+                            "File is empty",
+                        ));
+                    } else {
+                        return Ok(buffer);
+                    }
+                }
+                Err(er) => {
+                    return Err(er);
+                }
+            }
+        }
+    }
+
+    // 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(alias = "id")]
+        pub id: i32,
+        #[serde(skip_serializing_if = "String::is_empty")]
+        pub title: String,
+        #[serde(skip_serializing_if = "String::is_empty")]
+        pub artist: String,
+        #[serde(skip_serializing_if = "String::is_empty")]
+        pub album: String,
+        #[serde(skip_serializing_if = "String::is_empty")]
+        pub album_artist: String,
+        #[serde(skip_serializing_if = "String::is_empty")]
+        pub genre: String,
+        #[serde(skip_serializing_if = "is_embed_zero")]
+        pub year: i32,
+        #[serde(skip_serializing_if = "is_embed_dur_not_set")]
+        pub duration: f64,
+        #[serde(skip_serializing_if = "is_embed_zero")]
+        pub track: i32,
+        #[serde(skip_serializing_if = "is_embed_zero")]
+        pub disc: i32,
+        #[serde(skip_serializing_if = "is_embed_zero")]
+        pub disc_count: i32,
+        #[serde(skip_serializing_if = "is_embed_zero")]
+        pub track_count: i32,
+        #[serde(skip_serializing_if = "String::is_empty")]
+        pub audio_type: String,
+        #[serde(skip_serializing_if = "String::is_empty")]
+        pub date_created: String,
+        #[serde(skip_serializing_if = "String::is_empty")]
+        pub filename: String,
+        #[serde(skip_serializing_if = "is_embed_zero")]
+        pub user_id: i32,
+        #[serde(skip)]
+        pub data: Vec<u8>,
+        #[serde(skip)]
+        pub directory: String,
+        #[serde(skip)]
+        pub album_id: i32,
+        #[serde(skip)]
+        pub artist_id: i32,
+        #[serde(skip)]
+        pub genre_id: i32,
+        #[serde(skip)]
+        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,
+                title: String::new(),
+                artist: String::new(),
+                album: String::new(),
+                album_artist: String::new(),
+                genre: String::new(),
+                year: 0,
+                duration: 0.0,
+                track: 0,
+                disc: 0,
+                disc_count: 0,
+                track_count: 0,
+                audio_type: String::new(),
+                date_created: String::new(),
+                filename: String::new(),
+                user_id: 0,
+                data: Vec::new(),
+                directory: String::new(),
+                album_id: 0,
+                artist_id: 0,
+                genre_id: 0,
+                coverart_id: 0,
+            }
+        }
+    }
+}

src/token.rs

@@ -11,6 +11,22 @@ pub struct Token {
     pub issued: i32,
 }
 
+#[derive(Clone, Debug, Deserialize, Serialize)]
+pub struct AccessToken {
+    #[serde(alias = "user_id")]
+    pub user_id: i32,
+    #[serde(alias = "username")]
+    pub username: String,
+    #[serde(alias = "token")]
+    pub token: String,
+    #[serde(alias = "token_type")]
+    pub token_type: String,
+    #[serde(alias = "expiration")]
+    pub expiration: i32,
+    #[serde(alias = "message")]
+    pub message: String,
+}
+
 impl Default for Token {
     fn default() -> Self {
         Token {
@@ -23,6 +39,14 @@ impl Default for Token {
     }
 }
 
+impl AccessToken {
+    pub fn bearer_token(&self) -> String {
+        let mut token: String = String::from("Bearer ");
+        token += &self.token.clone();
+        return token;
+    }
+}
+
 impl Token {
     pub fn _to_json(&self) -> Result<String, serde_json::Error> {
         return serde_json::to_string_pretty(&self);

src/types.rs

@@ -0,0 +1,9 @@
+use std::default::Default;
+
+mod types {
+    pub enum Types {
+        WAV_EXTENSION,
+        FLAC_EXTENSION,
+        MP_EXTENSION,
+    }
+}

src/user.rs

@@ -4,19 +4,33 @@ 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 = "String::is_empty")]
     pub username: String,
+    #[serde(skip_serializing_if = "String::is_empty")]
     pub password: String,
+    #[serde(skip_serializing_if = "String::is_empty")]
     pub email: String,
+    #[serde(skip_serializing_if = "String::is_empty")]
     pub phone: String,
+    #[serde(skip_serializing_if = "String::is_empty")]
     pub firstname: String,
+    #[serde(skip_serializing_if = "String::is_empty")]
     pub lastname: String,
     pub email_verified: bool,
+    #[serde(skip_serializing_if = "String::is_empty")]
     pub date_created: String,
+    #[serde(skip_serializing_if = "String::is_empty")]
     pub status: String,
+    #[serde(skip_serializing_if = "String::is_empty")]
     pub last_login: String,
 }
 
+fn is_id_valid(num: &i32) -> bool {
+    *num > 0
+}
+
 impl Default for User {
     fn default() -> Self {
         User {
@@ -36,7 +50,11 @@ impl Default for User {
 }
 
 impl User {
-    pub fn _to_json(&self) -> Result<String, serde_json::Error> {
-        return serde_json::to_string_pretty(&self);
+    pub fn to_json(&self, output_pretty: bool) -> Result<String, serde_json::Error> {
+        if output_pretty {
+            return serde_json::to_string_pretty(&self);
+        } else {
+            return serde_json::to_string(&self);
+        }
     }
 }