Added basic functionality: Global and Contests statistics monitoring and /track command to start tracking user on CodeForces

Author: likespro

.github/workflows/main-branch.yml

@@ -0,0 +1,144 @@
+name: Main Branch Workflow
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build-jar:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up JDK 21
+        uses: actions/setup-java@v4
+        with:
+          java-version: '21'
+          distribution: 'corretto'
+
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v4
+
+      - name: Change wrapper permissions
+        run: chmod +x ./gradlew
+
+      - name: Build with Gradle Wrapper
+        run: ./gradlew build
+
+      - name: Extract project name from Gradle
+        id: extract_name
+        run: |
+          PROJECT_NAME=$(./gradlew -q printProjectName)
+          echo "PROJECT_NAME=${PROJECT_NAME}" >> $GITHUB_ENV
+
+      - name: Extract version from Gradle
+        id: get-version
+        run: |
+          VERSION=$(./gradlew -q printProjectVersion)
+          echo "VERSION=${VERSION}" >> $GITHUB_ENV
+
+      - name: Upload jars
+        uses: actions/upload-artifact@v4
+        with:
+          name: ${{ env.PROJECT_NAME }}-${{ env.VERSION }}
+          path: build/libs/
+
+  build-and-push-docker:
+    runs-on: ubuntu-latest
+    permissions:
+      packages: write
+      id-token: write
+      attestations: write
+    env:
+      REGISTRY: ghcr.io
+      IMAGE_NAME: ${{ github.repository }}
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Log in to GitHub Container Registry
+        uses: docker/login-action@v2
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract version from file
+        id: get-version
+        run: |
+          VERSION=$(./gradlew -q printProjectVersion)
+          echo "VERSION=${VERSION}" >> $GITHUB_ENV
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+
+      - name: Change wrapper permissions
+        run: chmod +x ./gradlew
+
+      - name: Build and push Docker image
+        id: push
+        uses: docker/build-push-action@f2a1d5e99d037542a71f64918e516c093c6f3fc4
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+
+      - name: Generate artifact attestation
+        uses: actions/attest-build-provenance@v1
+        with:
+          subject-name: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME}}
+          subject-digest: ${{ steps.push.outputs.digest }}
+          push-to-registry: true
+
+  package-and-push-helm:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Configure Git
+        run: |
+          git config user.name "$GITHUB_ACTOR"
+          git config user.email "[email protected]"
+          
+      - name: Install Helm
+        uses: azure/setup-helm@v4
+        env:
+          GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
+
+      - name: Run chart-releaser
+        uses: helm/[email protected]
+        with:
+          charts_dir: helm
+          packages_with_index: true
+        env:
+          CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
+
+  dependency-submission:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up JDK 21
+        uses: actions/setup-java@v4
+        with:
+          java-version: '21'
+          distribution: 'corretto'
+
+      - name: Generate and submit dependency graph
+        uses: gradle/actions/dependency-submission@af1da67850ed9a4cedd57bfd976089dd991e2582 # v4.0.0

.gitignore

@@ -1,24 +1,45 @@
-# Compiled class file
-*.class
+.gradle
+build/
+!gradle/wrapper/gradle-wrapper.jar
+!**/src/main/**/build/
+!**/src/test/**/build/
 
-# Log file
-*.log
+### IntelliJ IDEA ###
+.idea/modules.xml
+.idea/jarRepositories.xml
+.idea/compiler.xml
+.idea/libraries/
+*.iws
+*.iml
+*.ipr
+out/
+!**/src/main/**/out/
+!**/src/test/**/out/
 
-# BlueJ files
-*.ctxt
+### Kotlin ###
+.kotlin
 
-# Mobile Tools for Java (J2ME)
-.mtj.tmp/
+### Eclipse ###
+.apt_generated
+.classpath
+.factorypath
+.project
+.settings
+.springBeans
+.sts4-cache
+bin/
+!**/src/main/**/bin/
+!**/src/test/**/bin/
 
-# Package Files #
-*.jar
-*.war
-*.nar
-*.ear
-*.zip
-*.tar.gz
-*.rar
+### NetBeans ###
+/nbproject/private/
+/nbbuild/
+/dist/
+/nbdist/
+/.nb-gradle/
 
-# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
-hs_err_pid*
-replay_pid*
+### VS Code ###
+.vscode/
+
+### Mac OS ###
+.DS_Store

.idea/.gitignore

@@ -0,0 +1,15 @@
+FROM gradle:jdk21 AS build
+
+WORKDIR /app
+
+COPY . .
+
+RUN gradle build --no-daemon
+
+FROM amazoncorretto:21
+
+WORKDIR /app
+
+COPY --from=build /app/build/libs/*-fat-*.jar app.jar
+
+CMD ["java", "-jar", "app.jar"]

.idea/gradle.xml

@@ -1,2 +1,58 @@
-# collaborative-algo-training-discord-bot
-A Discord bot for automatizing collaborative algo training
+<p align="center">
+ <img width="100px" src="https://github.com/likespro.png" align="center" alt="Competitive Template" />
+ <h2 align="center">Competitive Programming Statistics Bot</h2>
+ <p align="center">A Discord bot to track users on competitive programming platforms</p>
+</p>
+<p align="center">
+    <a href="https://github.com/anuraghazra/github-readme-stats/actions">
+      <img alt="Build Passing" src="https://github.com/likespro/cp-programming-stats-bot/workflows/Main Branch Workflow/badge.svg" />
+    </a>
+    <a href="https://github.com/likespro/cp-programming-stats-bot/graphs/contributors">
+      <img alt="GitHub Contributors" src="https://img.shields.io/github/contributors/likespro/cp-programming-stats-bot" />
+    </a>
+    <a href="https://github.com/likespro/cp-programming-stats-bot/issues">
+      <img alt="Issues" src="https://img.shields.io/github/issues/likespro/cp-programming-stats-bot?color=0088ff" />
+    </a>
+    <a href="https://github.com/likespro/cp-programming-stats-bot/pulls">
+      <img alt="GitHub pull requests" src="https://img.shields.io/github/issues-pr/likespro/cp-programming-stats-bot?color=0088ff" />
+    </a>
+  </p>
+
+
+
+
+
+## Overview
+The goal of this Discord bot is to bring users' statistics from different competitive programming platforms right to Discord.
+## How it works
+* Bot uses 2 text channels in your Guild to publish statistics: one (by default named `statistics`) to publish global leaderboard of tracked users, ranked by their rating, and another one (by default named `contests-statistics`) to publish current tracked users standings for each contest that is going on or ended no earlier than one week before.
+* Bot automatically updates statistics nearly each 60 seconds and edits messages with outdated statistics 
+* To track new user just execute `/track <platform> <username> <track_this_user_just_for_fun_or_not?>` in Discord Guild where the bot was installed
+
+**Currently supported platforms:**
+* CodeForces
+## Requirements
+* Running MongoDB server - you can download it on www.mongodb.com or use free cluster from MongoDB Atlas - https://cloud.mongodb.com
+* Discord bot token - you can create it on https://discord.com/developers/applications. The bot need to be installed to your Guild and need to have scopes `applications.commands`, `bot` and permissions `Manage Channels`, `Send Messages`. You can set they in your dashboard before bot installation to Guild.
+## How to install (traditional)
+* Build jars with `./gradlew build` or download already built fat jar artifact from the last successful action on https://github.com/likespro/cp-programming-stats-bot/actions
+* Ensure you have set all needed environment variables (see the list below)
+* Run fat jar with Java 21+: `java -jar cp-programming-stats-bot-fat-<version>.jar`. If you built jars manually, they will be located in `build/libs/`
+## How to install (docker)
+* Pull image: `docker image pull ghcr.io/likespro/cp-programming-stats-bot:main`
+* Run the image with `docker run ghcr.io/likespro/cp-programming-stats-bot:main`. You can set environment variables by `-e <VARIABLE>=<VALUE>`, for example: `docker run -e MONGODB_URL="mongodb+srv://example.com" -e MONGODB_DATABASE="stats-database" ghcr.io/likespro/cp-programming-stats-bot:main`
+## How to install (helm)
+* Add repository with `helm repo add cp-programming-stats-bot https://likespro.github.io/cp-programming-stats-bot` or update it (if you already added it earlier) with `helm repo update cp-programming-stats-bot`
+* Deploy Helm Chart: `helm install cp-programming-stats-bot/cp-programming-stats-bot`. You can set environment variables by `--set env.<VARIABLE>=<VALUE>`, for example: `helm install cp-programming-stats-bot/cp-programming-stats-bot --set env.MONGODB_URL="mongodb+srv://example.com" --set env.MONGODB_DATABASE="stats-database"`
+## Environment variables
+* Set `MONGODB_URL` environment variable to valid URL of your MongoDB server, for example: `mongodb+srv://[username:password@]host[/[defaultauthdb][?options]]`
+* [ Optional ] Set `MONGODB_DATABASE` environment variable to valid MongoDB database name. If not specified, `cp-programming-stats-bot` will be used as name
+* [ Optional ] Set `DISCORD_BOT_TOKEN` environment variable to valid Discord bot token. If not specified, you will need to set `<database>/misc/config/discordBotToken` field manually after the first launch
+* [ Optional ] Set `DISCORD_GUILD_ID` environment variable to valid Discord Guild ID. You can get ID of any guild by enabling Developer mode in `Discord/Settings/Advanced` and then right-click on the Guild you want to use and copy its ID. If not specified, you will need to set `<database>/misc/config/discordGuildId` field manually after the first launch
+* [ Optional ] Set `DISCORD_GLOBAL_STATISTICS_CHANNEL_ID` environment variable to valid ID of Discord text channel where to publish global statistics. You can get ID of any text channel by enabling Developer mode in `Discord/Settings/Advanced` and then right-click on the text channel you want to use and copy its ID. If not specified, bot will try to automatically find a text channel with name "statistics". If no such channels were found, bot will create a new text channel with this name
+* [ Optional ] Set `DISCORD_CONTESTS_STATISTICS_CHANNEL_ID` environment variable to valid ID of Discord text channel where to publish contests statistics. You can get ID of any text channel by enabling Developer mode in `Discord/Settings/Advanced` and then right-click on the text channel you want to use and copy its ID. If not specified, bot will try to automatically find a text channel with name "contests-statistics". If no such channels were found, bot will create a new text channel with this name
+## Screenshots
+Global Statistics
+![Global Statistics](https://github.com/likespro/cp-programming-stats-bot/blob/main/screenshots/global_statistics.png?raw=true)
+Contest Statistics
+![Contest Statistics](https://github.com/likespro/cp-programming-stats-bot/blob/main/screenshots/contest_statistics.png?raw=true)

.idea/kotlinc.xml

@@ -0,0 +1,58 @@
+plugins {
+    id 'org.jetbrains.kotlin.jvm' version '2.0.20'
+}
+
+group = 'eth.likespro'
+version = '1.0.0'
+
+repositories {
+    mavenCentral()
+}
+dependencies {
+    implementation 'de.vandermeer:asciitable:0.3.2'
+    implementation 'org.json:json:20231013'
+    implementation 'io.projectreactor:reactor-core:3.6.10'
+    implementation 'org.mongodb:mongodb-driver-reactivestreams:5.1.4'
+    implementation 'io.github.microutils:kotlin-logging-jvm:2.0.11'
+    implementation 'ch.qos.logback:logback-classic:1.4.12'
+    implementation "net.dv8tion:JDA:5.2.1"
+    testImplementation 'org.jetbrains.kotlin:kotlin-test'
+}
+
+test {
+    useJUnitPlatform()
+}
+kotlin {
+    jvmToolchain(21)
+}
+tasks.jar{
+    manifest {
+        attributes 'Main-Class': 'eth.likespro.MainKt'
+    }
+}
+tasks.register('fatJar', Jar) {
+    manifest {
+        attributes 'Main-Class': 'eth.likespro.MainKt'
+    }
+    archiveBaseName = rootProject.name + '-fat'
+    duplicatesStrategy = DuplicatesStrategy.EXCLUDE
+    from { configurations.runtimeClasspath.collect { println("Packing "+it.name+" into fatJar"); it.isDirectory() ? it : zipTree(it) } } {
+        exclude 'META-INF/*.RSA', 'META-INF/*.SF', 'META-INF/*.DSA'
+    }
+    exclude("META-INF/*.RSA", "META-INF/*.DSA", "META-INF/*.SF")
+    with jar
+    exclude("META-INF/*.RSA", "META-INF/*.DSA", "META-INF/*.SF")
+}
+tasks.build{
+    dependsOn(fatJar)
+}
+tasks.register('printProjectName') {
+    doLast {
+        println rootProject.name
+    }
+}
+tasks.register('printProjectVersion') {
+    doLast {
+        println version
+    }
+}