Workflow change (#15)

Reviewed-on: phoenix/icarus-models#15
Co-authored-by: phoenix <kundeng94@gmail.com>
Co-committed-by: phoenix <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: 1.85.0
+          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,66 @@
+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
+        with:
+          toolchain: 1.85.0
+      - run: cargo check
+
+  test:
+    name: Test Suite
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions-rust-lang/setup-rust-toolchain@v1
+        with:
+          toolchain: 1.85.0
+      - run: cargo test
+
+  fmt:
+    name: Rustfmt
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions-rust-lang/setup-rust-toolchain@v1
+        with:
+          toolchain: 1.85.0
+      - 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
+        with:
+          toolchain: 1.85.0
+      - 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
+        with:
+          toolchain: 1.85.0
+      - run: cargo build
+
+

Cargo.toml

@@ -1,10 +1,11 @@
 [package]
 name = "icarus-models"
-version = "0.1.10"
+version = "0.1.14"
 edition = "2024"
 description = "models used for the icarus project"
 license = "MIT"
 
 [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

@@ -20,23 +20,23 @@ impl Default for AccessLevel {
 }
 
 pub fn default_level() -> AccessLevel {
-    return AccessLevel {
+    AccessLevel {
         id: -1,
         level: String::from("Public"),
         song_id: -1,
-    };
+    }
 }
 
 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

@@ -1,5 +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";
+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,5 +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,6 +1,10 @@
-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)]
@@ -42,14 +46,14 @@ pub struct Song {
     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,
+    // #[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 {
@@ -60,6 +64,7 @@ fn is_dur_not_set(num: &i32) -> bool {
     *num == 0
 }
 
+/*
 impl Default for Song {
     fn default() -> Self {
         Song {
@@ -81,20 +86,21 @@ impl Default for Song {
             user_id: 0,
             data: Vec::new(),
             directory: String::new(),
-            album_id: 0,
-            artist_id: 0,
-            genre_id: 0,
-            coverart_id: 0,
+            // 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);
+            serde_json::to_string_pretty(&self)
         } else {
-            return serde_json::to_string(&self);
+            serde_json::to_string(&self)
         }
     }
 
@@ -107,50 +113,85 @@ impl Song {
         }
 
         let directory = &self.directory;
-        let mut buffer: String = String::from(directory.clone());
-        let lastIndex = directory.len() - 1;
+        let mut buffer: String = directory.clone();
+        let last_index = directory.len() - 1;
 
-        if let Some(character) = directory.chars().nth(lastIndex) {
+        if let Some(character) = directory.chars().nth(last_index) {
             if character != '/' {
                 buffer += "/";
             }
 
             buffer += &self.filename.clone();
 
-            return Ok(buffer);
+            Ok(buffer)
         } else {
-            return Err(std::io::Error::new(
+            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();
+        let path_result = self.song_path();
 
-        match pathResult {
+        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.len() == 0 {
-                    return Err(std::io::Error::new(
+                if buffer.is_empty() {
+                    Err(std::io::Error::new(
                         std::io::ErrorKind::Other,
                         "File is empty",
-                    ));
+                    ))
                 } else {
-                    return Ok(buffer);
+                    Ok(buffer)
                 }
             }
-            Err(er) => {
-                return Err(er);
-            }
+            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
+    }
 }
 
+/*
 mod embedded {
     use std::io::Read;
 
@@ -159,9 +200,9 @@ mod embedded {
     impl Song {
         pub fn to_metadata_json(&self, pretty: bool) -> Result<String, serde_json::Error> {
             if pretty {
-                return serde_json::to_string_pretty(&self);
+                serde_json::to_string_pretty(&self)
             } else {
-                return serde_json::to_string(&self);
+                serde_json::to_string(&self)
             }
         }
 
@@ -174,46 +215,44 @@ mod embedded {
             }
 
             let directory = &self.directory;
-            let mut buffer: String = String::from(directory.clone());
-            let lastIndex = directory.len() - 1;
+            let mut buffer: String = directory.clone();
+            let last_index = directory.len() - 1;
 
-            if let Some(character) = directory.chars().nth(lastIndex) {
+            if let Some(character) = directory.chars().nth(last_index) {
                 if character != '/' {
                     buffer += "/";
                 }
 
                 buffer += &self.filename.clone();
 
-                return Ok(buffer);
+                Ok(buffer)
             } else {
-                return Err(std::io::Error::new(
+                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();
+            let path_result = self.song_path();
 
-            match pathResult {
+            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.len() == 0 {
-                        return Err(std::io::Error::new(
+                    if buffer.is_empty() {
+                        Err(std::io::Error::new(
                             std::io::ErrorKind::Other,
                             "File is empty",
-                        ));
+                        ))
                     } else {
-                        return Ok(buffer);
+                        Ok(buffer)
                     }
                 }
-                Err(er) => {
-                    return Err(er);
-                }
+                Err(er) => Err(er),
             }
         }
     }
@@ -258,14 +297,14 @@ mod embedded {
         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,
+        // #[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 {
@@ -297,11 +336,12 @@ mod embedded {
                 user_id: 0,
                 data: Vec::new(),
                 directory: String::new(),
-                album_id: 0,
-                artist_id: 0,
-                genre_id: 0,
-                coverart_id: 0,
+                // album_id: 0,
+                // artist_id: 0,
+                // genre_id: 0,
+                // coverart_id: 0,
             }
         }
     }
 }
+*/

src/token.rs

@@ -43,22 +43,28 @@ impl AccessToken {
     pub fn bearer_token(&self) -> String {
         let mut token: String = String::from("Bearer ");
         token += &self.token.clone();
-        return token;
+        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

@@ -52,9 +52,9 @@ impl Default for User {
 impl User {
     pub fn to_json(&self, output_pretty: bool) -> Result<String, serde_json::Error> {
         if output_pretty {
-            return serde_json::to_string_pretty(&self);
+            serde_json::to_string_pretty(&self)
         } else {
-            return serde_json::to_string(&self);
+            serde_json::to_string(&self)
         }
     }
 }