Adding /record_time command

Author: Paul Philion

docs/devlog.md

@@ -1,5 +1,9 @@
 # Netbot Development Log
 
+## 2025-09-08, v0.5
+
+Added `/record_time` command: Captures hours (float), program (popup selector based on /enumerations/time_entry_activities.json) ans an options note.
+
 ## 2025-01-30
 
 When deploying the lastest, found a problem with certain emails. The regex used to strip Fordarded emails contains the "match everything" wildcard. Except `.*` does not match new-lines.

netbot/cog_tickets.py

@@ -6,7 +6,7 @@
 import datetime as dt
 
 import discord
-from discord import ScheduledEvent
+from discord import ScheduledEvent, OptionChoice
 from discord.commands import option, SlashCommandGroup
 from discord.ext import commands
 from discord.enums import InputTextStyle
@@ -19,16 +19,39 @@
 from redmine import synctime
 from redmine.redmine import Client
 from netbot.netbot import NetBot, TEAM_MAPPING, CHANNEL_MAPPING, default_ticket
+from . import config
+
+# FIXME
+# try for empty responses.
+# await interaction.response.defer()
+
 
 
 log = logging.getLogger(__name__)
 
+# cached data for fast option-choices popup menus
+_programs: list[OptionChoice] = [
+    OptionChoice("Community Networks (General)", value=15),
+    OptionChoice("Grant: Seattle TMF 2023-4", value=16),
+    OptionChoice("Grant: Benton Fellowship 2024", value=17),
+]
+#_bot = None
 
 def setup(bot:NetBot):
+    #_programs = get_program_options()
+    #log.warning(f"initilized programs: {_programs}")
     bot.add_cog(TicketsCog(bot))
+
     log.info("initialized tickets cog")
 
 
+def get_program_options() -> list[OptionChoice]:
+    programs = []
+    for k, v in config.programs.items():
+        programs.append(OptionChoice(k, value=v))
+    return programs
+
+
 def get_trackers(ctx: discord.AutocompleteContext):
     """Returns a list of trackers that begin with the characters entered so far."""
     trackers = ctx.bot.redmine.ticket_mgr.get_trackers() # this is expected to be cached
@@ -115,6 +138,34 @@ async def callback(self, interaction: discord.Interaction):
         )
 
 
+class ProgramSelect(discord.ui.Select):
+    """Popup menu to select ticket tracker"""
+    def __init__(self, bot: discord.Bot):
+        self.bot = bot
+
+        # Get the possible trackers
+        options = []
+        for name, value in self.bot.redmine.ticket_mgr.get_programs().items():
+            options.append(discord.SelectOption(label=name))
+
+        # The placeholder is what will be shown when no option is selected.
+        # The min and max values indicate we can only pick one of the three options.
+        # The options parameter, contents shown above, define the dropdown options.
+        super().__init__(
+            placeholder="Select program...",
+            min_values=1,
+            max_values=1,
+            options=options,
+        )
+
+    async def callback(self, interaction: discord.Interaction):
+        # Use the interaction object to send a response message containing
+        # the user's favourite colour or choice. The self object refers to the
+        # Select object, and the values attribute gets a list of the user's
+        # selected options. We only want the first one.
+        log.info(f"PROGRAM SELECT {interaction.user} {interaction.data}")
+        await interaction.response.send_message(f"ProgramSelect.callback() - selected program {self.values[0]}")
+
 class StatusSelect(discord.ui.Select):
     """Popup menu to select ticket status"""
     def __init__(self, bot: discord.Bot):
@@ -808,9 +859,12 @@ async def help(self, ctx: discord.ApplicationContext):
         await ctx.respond(embed=self.bot.formatter.help_embed(ctx))
 
 
-    @discord.slash_command(name="testime", description="Record time against a program")
-    async def recordTime(self, ctx: discord.ApplicationContext, hours: float, program: str, note: str = ""):
-        log.info(f">>> {hours} {program} {note}")
+    @discord.slash_command(name="record_time", description="Record time against a program")
+    @option("hours", description="Hours worked on the program: `3.5`")
+    @option("program_id", choices=get_program_options(), description="Select the program or grant", required=True)
+    @option("note", description="Optional: Additional comments")
+    async def recordTime(self, ctx: discord.ApplicationContext, hours: float, program_id: int, note: str = ""):
+        log.info(f">>> {hours} {program_id} {note}")
         redmine: Client = ctx.bot.redmine
 
         user = redmine.user_mgr.find(ctx.user.name)
@@ -827,6 +881,8 @@ async def recordTime(self, ctx: discord.ApplicationContext, hours: float, progra
                 await ticket_cog.create_new_ticket(ctx, note)
                 autoresolve = True
 
-        redmine.ticket_mgr.record_time(ticket_id, user, hours, program, note)
+        redmine.ticket_mgr.record_time(ticket_id, user, hours, program_id, note)
         if autoresolve:
             redmine.ticket_mgr.resolve(ticket_id)
+
+        await ctx.respond(f"Recorded {hours} on {program_id} for {user.discord}")

netbot/config.py

@@ -0,0 +1,3 @@
+
+# programs - list of active programs {name:program_id}
+programs: dict[str,int] = {}

netbot/netbot.py

@@ -16,7 +16,7 @@
 from redmine.redmine import Client
 
 from .formatting import DiscordFormatter
-
+from . import config
 
 log = logging.getLogger(__name__)
 
@@ -49,6 +49,7 @@
 
 FALLBACK_TEAM = "intake-team"
 
+PROG_CACHE = None
 
 # utility method to get a list of (one) ticket from the title of the channel, or empty list
 def default_ticket(ctx: discord.AutocompleteContext) -> list[int]:
@@ -63,7 +64,6 @@ def default_ticket(ctx: discord.AutocompleteContext) -> list[int]:
 class NetbotException(Exception):
     """netbot exception"""
 
-
 class NetBot(commands.Bot):
     """netbot"""
     def __init__(self, client: Client):
@@ -82,6 +82,8 @@ def __init__(self, client: Client):
         self.formatter = DiscordFormatter(client.url)
 
         self.redmine = client
+        config.programs = client.ticket_mgr.get_programs()
+
         #guilds = os.getenv('DISCORD_GUILDS').split(', ')
         #if guilds:
         #    log.info(f"setting guilds: {guilds}")
@@ -116,6 +118,7 @@ def run_bot(self):
 
     #     log.debug(f"Loaded teams: {self.teams}")
 
+
     def sync_team(self, role:discord.Role, team:Team):
         team_ids = set()
         for member in role.members:
@@ -646,6 +649,7 @@ def setup_logging(log_level = logging.INFO):
 
     log.debug("log level set to debug")
 
+
 if __name__ == '__main__':
     setup_logging()
     main()

pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "netbot"
-version = "0.1.0"
-description = "Add your description here"
+version = "0.5.0"
+description = "A Discord bot to capture tickets and todos."
 readme = "README.md"
 requires-python = ">=3.13"
 dependencies = [

redmine/tickets.py

@@ -93,6 +93,12 @@ def load_programs(self) -> dict[str,int]:
         return programs
 
 
+    def get_programs(self) -> dict[str,int]:
+        if len(self.programs) == 0:
+            self.programs = self.load_programs()
+        return self.programs
+
+
     def get_program(self, program_name: str) -> int:
         return self.programs.get(program_name, self.default_program)
 
@@ -624,7 +630,7 @@ def resolve(self, ticket_id, user_id=None):
         return self.update(ticket_id, {"status_id": "3"}, user_id) # '3' is the status_id, it doesn't accept "Resolved"
 
 
-    def record_time(self, ticket_id:int, user:User, hours:float, program:str, note:str) -> TimeEntry:
+    def record_time(self, ticket_id:int, user:User, hours:float, program_id:int, note:str) -> TimeEntry:
         # time_entry (required): a hash of the time entry attributes, including:
         # issue_id or project_id (only one is required): the issue id or project id to log time on (both are integers); note that project ids can only be found using the API (e.g. at /projects.json)
         # spent_on: the date the time was spent (default to the current date); format is e.g. 2020-12-24
@@ -637,7 +643,7 @@ def record_time(self, ticket_id:int, user:User, hours:float, program:str, note:s
                 'issue_id': ticket_id,
                 # 'spent_on': "2020-12-24", # (default to the current date)
                 'hours': hours,
-                'activity_id': self.get_program(program),
+                'activity_id': program_id, #self.get_program(program),
                 'comments': note,
                 'user_id': user.id,
             }

tests/test_cog_tickets.py

@@ -593,9 +593,10 @@ async def test_record_time(self):
             ctx.channel.name = f"Ticket #{ticket.id}"
             ctx.channel.id = ticket.id
 
-            activity = "Development"
+            activity = "Community Networks (General)"
+            activity_id = self.tickets_mgr.get_program(activity)
             notes = "this is a test"
-            await self.cog.recordTime(ctx, 2.33, activity, notes)
+            await self.cog.recordTime(ctx, 2.33, activity_id, notes)
 
             records = self.redmine.ticket_mgr.get_time_records(issue_id=ticket.id)
             self.assertIsNotNone(records)

tests/test_utils.py

@@ -19,7 +19,7 @@
 from redmine.tickets import SCN_PROJECT_ID
 from redmine.session import RedmineSession
 from redmine.redmine import Client
-from netbot.netbot import NetBot, setup_logging
+from netbot.netbot import NetBot, setup_logging, config
 from tests.mock_session import MockSession
 
 
@@ -233,6 +233,7 @@ class RedmineTestCase(unittest.TestCase):
     def setUpClass(cls):
         sess = RedmineSession.fromenv()
         cls.redmine = Client.from_session(sess, SCN_PROJECT_ID)
+        config.programs = cls.redmine.ticket_mgr.get_programs()
         cls.user_mgr = cls.redmine.user_mgr
         cls.tickets_mgr = cls.redmine.ticket_mgr
         init_test_users(cls.user_mgr)