Fixed some warnings (#11)

Reviewed-on: phoenix/icarus-models#11
Co-authored-by: KD <kundeng94@gmail.com>
Co-committed-by: KD <kundeng94@gmail.com>

.gitea/workflows/tag_release.yaml

@@ -0,0 +1,57 @@
+name: Release Tagging
+
+on:
+  push:
+    branches:
+      - main
+      - devel
+    tags:
+      - 'v*' # Trigger on tags matching v*
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0 # Important for git describe --tags
+
+      - name: Install Rust
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+          components: cargo
+
+      - name: Extract Version from Cargo.toml
+        id: version
+        run: |
+          VERSION=$(grep '^version = "' Cargo.toml | sed -E 's/version = "([^"]+)"/\1/')
+          PROJECT_COMMIT_HASH=$(git rev-parse HEAD | cut -c 1-10)
+          BRANCH_REF="${GITHUB_REF}"
+          BRANCH_NAME=$(echo "$BRANCH_REF" | cut -d '/' -f 3)
+          PROJECT_TAG_RELEASE="v$VERSION-$BRANCH_NAME-$PROJECT_COMMIT_HASH"
+          echo "::set-output name=project_tag_release::$PROJECT_TAG_RELEASE-111"
+          echo "Version: $VERSION"
+          echo "Hash: $PROJECT_COMMIT_HASH"
+          echo "Branch: $BRANCH_NAME"
+          echo "Tag Release: $PROJECT_TAG_RELEASE"
+
+      - name: Print version
+        id: Version
+        run: |
+          echo "Printing version"
+          echo "Version: ${{ steps.version.outputs.project_tag_release }}"
+
+      - name: Create GitHub Release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ steps.version.outputs.project_tag_release }}
+          release_name: Release ${{ steps.version.outputs.project_tag_release }}
+          body: |
+           Release of version ${{ steps.version.outputs.project_tag_release }}
+          # draft: false
+          # prerelease: ${{ startsWith(github.ref, 'v') == false }} # prerelease if not a valid release tag
+

.gitea/workflows/workflow.yaml

@@ -0,0 +1,56 @@
+name: Rust Build
+
+on:
+  push:
+    branches:
+      - main 
+      - devel
+  pull_request:
+    branches:
+      - main 
+      - devel
+
+jobs:
+  check:
+    name: Check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions-rust-lang/setup-rust-toolchain@v1
+      - run: cargo check
+
+  test:
+    name: Test Suite
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions-rust-lang/setup-rust-toolchain@v1
+      - run: cargo test
+
+  fmt:
+    name: Rustfmt
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions-rust-lang/setup-rust-toolchain@v1
+      - run: rustup component add rustfmt
+      - run: cargo fmt --all -- --check
+
+  clippy:
+    name: Clippy
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions-rust-lang/setup-rust-toolchain@v1
+      - run: rustup component add clippy
+      - run: cargo clippy -- -D warnings
+
+  build:
+    name: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions-rust-lang/setup-rust-toolchain@v1
+      - run: cargo build
+
+

.gitlab-ci.yml

@@ -1,6 +1,7 @@
 stages:
   - build
   - test
+  - version
   - deploy
 
 build:
@@ -40,6 +41,32 @@ 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
@@ -53,3 +80,4 @@ deploy:
     - build
   rules:
     - if: '$CI_COMMIT_TAG'
+

Cargo.toml

@@ -1,10 +1,11 @@
 [package]
 name = "icarus-models"
+version = "0.1.14"
+edition = "2024"
 description = "models used for the icarus project"
 license = "MIT"
-version = "0.1.3"
-edition = "2024"
 
 [dependencies]
 serde = { version = "1.0.218", features = ["derive"] }
-serde_json = "1.0.139"
+serde_json = { version = "1.0.139" }
+rand = { version = "0.9" }

src/access_level.rs

@@ -19,9 +19,8 @@ impl Default for AccessLevel {
     }
 }
 
-
 pub fn default_level() -> AccessLevel {
-    return AccessLevel {
+    AccessLevel {
         id: -1,
         level: String::from("Public"),
         song_id: -1,
@@ -29,17 +28,15 @@ pub fn default_level() -> AccessLevel {
 }
 
 pub fn private_level() -> AccessLevel {
-    return AccessLevel {
+    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);
+        serde_json::to_string_pretty(&self)
     }
 }

src/album.rs

@@ -0,0 +1,31 @@
+pub mod collection {
+    use serde::{Deserialize, Serialize};
+
+    fn is_set(num: &i32) -> bool {
+        *num >= 0
+    }
+
+    #[derive(Clone, Debug, Deserialize, Serialize)]
+    pub struct Album {
+        #[serde(skip_serializing_if = "String::is_empty")]
+        #[serde(alias = "album")]
+        pub title: String,
+        pub genre: String,
+        pub year: i32,
+        pub track_count: i32,
+        #[serde(skip_serializing_if = "is_set")]
+        pub disc_count: i32,
+        #[serde(skip_serializing_if = "Vec::is_empty")]
+        pub tracks: Vec<Track>,
+    }
+
+    #[derive(Clone, Debug, Deserialize, Serialize)]
+    pub struct Track {
+        pub title: String,
+        pub artist: String,
+        pub disc: i32,
+        pub track: i32,
+        // In seconds
+        pub duration: f64,
+    }
+}

src/constants.rs

@@ -0,0 +1,5 @@
+pub const DEFAULTMUSICEXTENSION: &str = FLACEXTENSION;
+pub const FLACEXTENSION: &str = ".flac";
+pub const WAVEXTENSION: &str = ".wav";
+pub const MPTHREEEXTENSION: &str = ".mp3";
+pub const JPGEXTENSION: &str = ".jpg";

src/coverart.rs

@@ -0,0 +1,23 @@
+use std::io::Read;
+
+use serde::{Deserialize, Serialize};
+
+#[derive(Debug, Clone, Deserialize, Serialize)]
+pub struct CoverArt {
+    pub id: i32,
+    pub title: String,
+    pub path: String,
+    pub data: Vec<u8>,
+}
+
+impl CoverArt {
+    pub fn to_data(&self) -> Result<Vec<u8>, std::io::Error> {
+        let path: &String = &self.path;
+        let mut file = std::fs::File::open(path)?;
+        let mut buffer = Vec::new();
+        match file.read_to_end(&mut buffer) {
+            Ok(_) => Ok(buffer),
+            Err(err) => Err(err),
+        }
+    }
+}

src/lib.rs

@@ -1,4 +1,7 @@
 pub mod access_level;
+pub mod album;
+pub mod constants;
+pub mod coverart;
 pub mod login_result;
 pub mod song;
 pub mod token;

src/login_result.rs

@@ -26,6 +26,6 @@ impl Default for LoginResult {
 
 impl LoginResult {
     pub fn _to_json(&self) -> Result<String, serde_json::Error> {
-        return serde_json::to_string_pretty(&self);
+        serde_json::to_string_pretty(&self)
     }
 }

src/song.rs

@@ -1,73 +1,347 @@
-use std::default::Default;
+// use std::default::Default;
 use std::io::Read;
 
+use crate::constants;
+use crate::types;
+
+use rand::Rng;
 use serde::{Deserialize, Serialize};
 
 #[derive(Clone, Debug, Deserialize, Serialize)]
 pub struct Song {
+    #[serde(skip_serializing_if = "is_zero")]
     #[serde(alias = "id")]
-    pub id: Option<i32>,
-    pub title: Option<String>,
-    pub artist: Option<String>,
-    pub album: Option<String>,
-    pub album_artist: Option<String>,
-    pub genre: Option<String>,
-    pub year: Option<i32>,
-    pub duration: Option<i32>,
-    pub track: Option<i32>,
-    pub disc: Option<i32>,
-    pub disc_count: Option<i32>,
-    pub track_count: Option<i32>,
-    pub audio_type: Option<String>,
-    pub date_created: Option<String>,
-    pub filename: Option<String>,
-    pub user_id: Option<i32>,
+    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: Option<Vec<u8>>,
+    pub data: Vec<u8>,
     #[serde(skip)]
-    pub directory: Option<String>,
-    #[serde(skip)]
-    pub album_id: Option<i32>,
-    #[serde(skip)]
-    pub artist_id: Option<i32>,
-    #[serde(skip)]
-    pub genre_id: Option<i32>,
-    #[serde(skip)]
-    pub coverart_id: Option<i32>,
+    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: None,
-            title: None,
-            artist: None,
-            album: None,
-            album_artist: None,
-            genre: None,
-            year: None,
-            duration: None,
-            track: None,
-            disc: None,
-            disc_count: None,
-            track_count: None,
-            audio_type: None,
-            date_created: None,
-            filename: None,
-            user_id: None,
-            data: None,
-            directory: None,
-            album_id: None,
-            artist_id: None,
-            genre_id: None,
-            coverart_id: None,
+            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 {
+            serde_json::to_string_pretty(&self)
+        } else {
+            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 = directory.clone();
+        let last_index = directory.len() - 1;
+
+        if let Some(character) = directory.chars().nth(last_index) {
+            if character != '/' {
+                buffer += "/";
+            }
+
+            buffer += &self.filename.clone();
+
+            Ok(buffer)
+        } else {
+            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 path_result = self.song_path();
+
+        match path_result {
+            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.is_empty() {
+                    Err(std::io::Error::new(
+                        std::io::ErrorKind::Other,
+                        "File is empty",
+                    ))
+                } else {
+                    Ok(buffer)
+                }
+            }
+            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::DEFAULTMUSICEXTENSION)
+            }
+
+            types::MusicTypes::WavExtension => String::from(constants::WAVEXTENSION),
+            types::MusicTypes::FlacExtension => String::from(constants::FLACEXTENSION),
+            types::MusicTypes::MPThreeExtension => String::from(constants::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
+    }
+}
 
-impl Song {
-    // TODO: Implement
-    pub fn to_metadata_json(&self) -> Result<String, serde_json::Error> {
-        return serde_json::to_string_pretty(&self);
+/*
+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 {
+                serde_json::to_string_pretty(&self)
+            } else {
+                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 = directory.clone();
+            let last_index = directory.len() - 1;
+
+            if let Some(character) = directory.chars().nth(last_index) {
+                if character != '/' {
+                    buffer += "/";
+                }
+
+                buffer += &self.filename.clone();
+
+                Ok(buffer)
+            } else {
+                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 path_result = self.song_path();
+
+            match path_result {
+                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.is_empty() {
+                        Err(std::io::Error::new(
+                            std::io::ErrorKind::Other,
+                            "File is empty",
+                        ))
+                    } else {
+                        Ok(buffer)
+                    }
+                }
+                Err(er) => 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,18 +39,32 @@ impl Default for Token {
     }
 }
 
+impl AccessToken {
+    pub fn bearer_token(&self) -> String {
+        let mut token: String = String::from("Bearer ");
+        token += &self.token.clone();
+        token
+    }
+}
+
 impl Token {
     pub fn _to_json(&self) -> Result<String, serde_json::Error> {
-        return serde_json::to_string_pretty(&self);
+        serde_json::to_string_pretty(&self)
     }
 
     // TODO: Implement
     pub fn token_expired(&self) -> bool {
-        return false;
+        false
     }
 
     // TODO: Implement
-    pub fn contains_scope(&self, des_scope: String) -> bool {
-        return false;
+    pub fn contains_scope(&self, des_scope: &String) -> bool {
+        let extracted_token: String = String::from("Token");
+
+        if extracted_token == *des_scope {
+            return true;
+        }
+
+        false
     }
 }

src/types.rs

@@ -1,9 +1,6 @@
-use std::default::Default;
-
-mod types {
-    pub enum Types {
-        WAV_EXTENSION,
-        FLAC_EXTENSION,
-        MP_EXTENSION,
-    }
+pub enum MusicTypes {
+    DefaultMusicExtension,
+    WavExtension,
+    FlacExtension,
+    MPThreeExtension,
 }

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 {
+            serde_json::to_string_pretty(&self)
+        } else {
+            serde_json::to_string(&self)
+        }
     }
 }