Add server activity leaderboard

BaseBotService/Commands/UserModule.cs

@@ -20,13 +20,15 @@ public class UserModule : BaseModule
     private readonly ITranslationService _translationService;
     private readonly IEngagementService _engagementService;
     private readonly IMemberRepository _memberRepository;
+    private readonly IGuildMemberRepository _guildMemberRepository;
 
-    public UserModule(ILogger logger, ITranslationService translationService, IEngagementService engagementService, IMemberRepository memberRepository)
+    public UserModule(ILogger logger, ITranslationService translationService, IEngagementService engagementService, IMemberRepository memberRepository, IGuildMemberRepository guildMemberRepository)
     {
         Logger = logger.ForContext<UserModule>();
         _translationService = translationService;
         _engagementService = engagementService;
         _memberRepository = memberRepository;
+        _guildMemberRepository = guildMemberRepository;
     }
 
     [UserCommand("User Profile")]
@@ -247,6 +249,39 @@ await ModifyOriginalResponseAsync(x =>
         });
     }
 
+    [SlashCommand("leaderboard", "Show the most active users on this server.")]
+    public async Task LeaderboardAsync(
+        [Summary(description: "Number of users to display (1-100)")] int amount = 10)
+    {
+        amount = Math.Clamp(amount, 1, 100);
+        var top = _guildMemberRepository.GetTopUsers(Context.Guild.Id, amount)
+            .ToList();
+
+        StringBuilder description = new();
+        for (int i = 0; i < top.Count; i++)
+        {
+            var member = top[i];
+            var user = Context.Guild.GetUser(member.MemberId);
+            string name = user?.Username ?? member.MemberId.ToString();
+            description.AppendLine(
+                _translationService.GetString(
+                    "leaderboard-entry",
+                    TranslationHelper.Arguments(
+                        "rank", i + 1,
+                        "user", name,
+                        "points", member.ActivityPoints)));
+        }
+
+        EmbedBuilder embed = GetEmbedBuilder()
+            .WithTitle(
+                _translationService.GetString(
+                    "leaderboard-title",
+                    TranslationHelper.Arguments("amount", amount)))
+            .WithDescription(description.ToString());
+
+        await RespondOrFollowupAsync(embed: embed.Build());
+    }
+
     internal double GetActivityScore(IGuildUser user, IGuildUser bot)
     {
         const double averageOnlineHours = 4;

BaseBotService/Core/DiscordEventListener.cs

@@ -41,6 +41,7 @@ public async Task StartAsync()
         _client.JoinedGuild += (guild) => _mediator.Publish(new JoinedGuildNotification(guild), _cancellationToken);
         _client.LeftGuild += (guild) => _mediator.Publish(new LeftGuildNotification(guild), _cancellationToken);
         _client.UserJoined += (user) => _mediator.Publish(new UserJoinedNotification(user), _cancellationToken);
+        _client.UserLeft += (guild, user) => _mediator.Publish(new UserLeftNotification(guild, user), _cancellationToken);
         _handler.Log += (msg) => _mediator.Publish(new LogNotification(msg), _cancellationToken);
 
         _ = await _handler.AddModulesAsync(Assembly.GetEntryAssembly(), _services);

BaseBotService/Core/Messages/UserLeftNotification.cs

@@ -0,0 +1,14 @@
+using Discord.WebSocket;
+
+namespace BaseBotService.Core.Messages;
+public class UserLeftNotification : INotification
+{
+    public SocketGuild Guild { get; }
+    public SocketUser User { get; }
+
+    public UserLeftNotification(SocketGuild guild, SocketUser user)
+    {
+        Guild = guild;
+        User = user;
+    }
+}

BaseBotService/Data/Interfaces/IGuildMemberRepository.cs

@@ -36,4 +36,12 @@ public interface IGuildMemberRepository
     /// <returns>True if the delete was successful, otherwise false.</returns>
     bool DeleteUser(ulong guildId, ulong userId);
     int DeleteGuild(ulong guildId);
+
+    /// <summary>
+    /// Gets the top users of a guild ordered by their activity points.
+    /// </summary>
+    /// <param name="guildId">The unique identifier of the guild.</param>
+    /// <param name="limit">The maximum number of users to return.</param>
+    /// <returns>An enumerable of <see cref="GuildMemberHC"/> ordered by activity points.</returns>
+    IEnumerable<GuildMemberHC> GetTopUsers(ulong guildId, int limit);
 }

BaseBotService/Data/Repositories/GuildMemberRepository.cs

@@ -38,4 +38,10 @@ public int DeleteGuild(ulong guildId)
         }
         return 0;
     }
+
+    public IEnumerable<GuildMemberHC> GetTopUsers(ulong guildId, int limit)
+        => _guildMembers
+            .Find(a => a.GuildId == guildId)
+            .OrderByDescending(u => u.ActivityPoints)
+            .Take(limit);
 }

BaseBotService/Interactions/EntityLifecycleHandler.cs

@@ -4,7 +4,7 @@
 using BaseBotService.Data.Models;
 
 namespace BaseBotService.Interactions;
-public class EntityLifecycleHandler : INotificationHandler<JoinedGuildNotification>, INotificationHandler<UserJoinedNotification>, INotificationHandler<LeftGuildNotification>
+public class EntityLifecycleHandler : INotificationHandler<JoinedGuildNotification>, INotificationHandler<UserJoinedNotification>, INotificationHandler<LeftGuildNotification>, INotificationHandler<UserLeftNotification>
 {
     private readonly ILogger _logger;
     private readonly IMemberRepository _memberRepository;
@@ -54,4 +54,19 @@ public Task Handle(JoinedGuildNotification notification, CancellationToken cance
 
         return Task.CompletedTask;
     }
+
+    public Task Handle(UserLeftNotification notification, CancellationToken cancellationToken)
+    {
+        _logger.Debug($"{nameof(EntityLifecycleHandler)} received {nameof(UserLeftNotification)}");
+
+        GuildMemberHC? member = _guildMemberRepository.GetUser(notification.Guild.Id, notification.User.Id);
+        if (member != null)
+        {
+            member.ActivityPoints = 0;
+            _guildMemberRepository.UpdateUser(member);
+            _logger.Information($"User {notification.User.Id} left {notification.Guild.Id}, reset ActivityPoints.");
+        }
+
+        return Task.CompletedTask;
+    }
 }

BaseBotService/Locales/de.ftl

@@ -134,6 +134,9 @@ profile = { $username } @ { $guildname }
    *[other] Invalid activity score
 }
 
+leaderboard-title = Top { $amount } active users
+leaderboard-entry = { $rank }. { $user } - { $points } pts
+
 
 
 

BaseBotService/Locales/en.ftl

@@ -138,6 +138,9 @@ profile = { $username } @ { $guildname }
    *[other] Invalid activity score
 }
 
+leaderboard-title = Top { $amount } active users
+leaderboard-entry = { $rank }. { $user } - { $points } pts
+
 
 
 ####################################

BaseBotService/Locales/es.ftl

@@ -134,6 +134,9 @@ profile = { $username } @ { $guildname }
    *[other] Invalid activity score
 }
 
+leaderboard-title = Top { $amount } active users
+leaderboard-entry = { $rank }. { $user } - { $points } pts
+
 
 
 

BaseBotService/Locales/fr.ftl

@@ -134,6 +134,9 @@ profile = { $username } @ { $guildname }
    *[other] Invalid activity score
 }
 
+leaderboard-title = Top { $amount } active users
+leaderboard-entry = { $rank }. { $user } - { $points } pts
+
 
 
 

BaseBotServiceTests/Commands/UserModuleTests.cs

@@ -13,6 +13,7 @@ public class UserModuleTests
     private ITranslationService _translationService;
     private IEngagementService _engagementService;
     private IMemberRepository _memberRepository;
+    private IGuildMemberRepository _guildMemberRepository;
     private ILogger _logger;
     private UserModule _userModule;
     private readonly Faker _faker = new();
@@ -23,9 +24,10 @@ public void SetUp()
         _translationService = Substitute.For<ITranslationService>();
         _engagementService = Substitute.For<IEngagementService>();
         _memberRepository = Substitute.For<IMemberRepository>();
+        _guildMemberRepository = Substitute.For<IGuildMemberRepository>();
         _logger = Substitute.For<ILogger>();
 
-        _userModule = new UserModule(_logger, _translationService, _engagementService, _memberRepository);
+        _userModule = new UserModule(_logger, _translationService, _engagementService, _memberRepository, _guildMemberRepository);
     }
 
     [Test]

BaseBotServiceTests/Data/Repositories/GuildMemberRepositoryTests.cs

@@ -91,4 +91,28 @@ public void DeleteUser_ShouldDeleteExistingUser()
         var deletedUser = _guildMembers.FindOne(u => u.MemberId == existingUser.MemberId && u.GuildId == existingUser.GuildId);
         deletedUser.ShouldBeNull();
     }
+
+    [Test]
+    public void GetTopUsers_ShouldReturnOrderedLimitedList()
+    {
+        // Arrange
+        var guild = FakeDataHelper.GuildFaker.Generate();
+        _guilds.Insert(guild);
+        foreach (var member in guild.Members)
+        {
+            _guildMembers.Insert(member);
+        }
+        int limit = Math.Min(3, guild.Members.Count);
+
+        // Act
+        var result = _repository.GetTopUsers(guild.GuildId, limit).ToList();
+
+        // Assert
+        result.Count.ShouldBe(limit);
+        var expected = guild.Members
+            .OrderByDescending(m => m.ActivityPoints)
+            .Take(limit)
+            .Select(m => m.MemberId);
+        result.Select(r => r.MemberId).ShouldBe(expected);
+    }
 }

README.md

@@ -21,6 +21,7 @@ Project Honeycomb is a Discord bot designed to provide artists with some useful
 - **Commission Request Form:** Users can request a commission by filling out a form with necessary details.
 - **OC Reference Management:** Users can add references with descriptions for their OCs to easily access them when needed.
 - **Loyalty Points:** Artists can reward their loyal customers by awarding loyalty points, which can be redeemed for future commissions.
+- **Activity Leaderboard:** See which members are most active in your server.
 - **Announcement of New Art:** Artists can announce their new artwork with references to different platforms like Twitter, DeviantArt, FurAffinity, Patreon, and more.
 - **Progress Tracking of Commissions:** Artists can track the progress of their commissions using the bot.
 - **Raffles:** Organize raffles on Discord or Twitter and randomly draw the winners.