Merge branch 'master' into feature_fitness_logger

Reviewed-on: #15
Reviewed-by: T-BENZIN <[email protected]>

README.md

@@ -2,6 +2,7 @@
  cogs made for our Royal butt.
 
 ## Our Cogs:
+- [FitnessCog](./fitnessCog)
 - [RecruitmentCog](./recruitmentCog/)
 - [ReginaldCog](./reginaldCog/)
 - [TrafficCog](./trafficCog)

fitnessCog/__init__.py

@@ -0,0 +1,6 @@
+from redbot.core.bot import Red
+from .fitness import FitnessCog
+
+async def setup(bot: Red):
+    cog = FitnessCog(bot)
+    await bot.add_cog(cog)

fitnessCog/activities/climb.json

@@ -0,0 +1,48 @@
+{
+    "convertable": true,
+    "units": {
+        "meter": {
+            "factor": 1,
+            "aliases": [
+                "meter",
+                "meters",
+                "m",
+                "m."
+            ]
+        },
+        "kilometer": {
+            "factor": 1000,
+            "aliases": [
+                "kilometer",
+                "kilometers",
+                "km",
+                "km."
+            ]
+        },
+        "foot": {
+            "factor": 0.3048,
+            "aliases": [
+                "foot",
+                "feet",
+                "ft",
+                "ft."
+            ]
+        },
+        "mile": {
+            "factor": 1609.344,
+            "aliases": [
+                "mile",
+                "miles",
+                "mi",
+                "mi."
+            ]
+        },
+        "step": {
+            "factor": 0.18,
+            "aliases": [
+                "step",
+                "steps"
+            ]
+        }
+    }
+}

fitnessCog/activities/pushups.json

@@ -0,0 +1,3 @@
+{
+  "convertable": false
+}

fitnessCog/activity_logger.py

@@ -0,0 +1,119 @@
+import json
+import csv
+import os
+
+
+def activity_log_path(activity: str) -> str:
+    """
+    Returns the path of the activity log file in .csv format
+    :param activity:
+    :return:
+    """
+    filename = os.path.join("activity_logs", f"{activity}.csv")
+    return filename
+
+
+def activity_units_path(activity: str) -> str:
+    """
+    Returns the path of the activity activities file in .json format
+    :param activity:
+    :return:
+    """
+    filename = os.path.join("activities", f"{activity}.json")
+    return filename
+
+
+def is_convertable(activity: str) -> bool:
+    """
+    Returns True if the activity has multiple units that needed to be converted.
+    i.e. distance may be sent in feet, but would require to be converted in meters.
+    :param activity:
+    :return:
+    """
+    filename = activity_units_path(activity)
+    raw_data = json.load(open(filename))
+    return raw_data.get("convertable")
+
+
+
+def create_activity_log_file(activity: str) -> None:
+    """
+    Creates the activity log file in .csv format
+    :param activity:
+    :return:
+    """
+    if not os.path.exists(activity_units_path(activity)):
+        raise ValueError(f"{activity} is not a valid activity")
+    if not os.path.exists("activity_logs"):
+        os.makedirs("activity_logs")
+    filename = activity_log_path(activity)
+    with open(filename, 'a') as f:
+        writer = csv.writer(f)
+        writer.writerow(["timestamp", "username", "value"])
+
+
+
+def convert_units(activity: str, value: int | float, unit: str) -> float:
+    """
+    Returns the value of activity in a factor of 1, i.e. converting feet to meters
+    :param activity:
+    :param value:
+    :param unit:
+    :return:
+    """
+    filename = activity_units_path(activity)
+    if not os.path.exists(filename):
+        raise ValueError(f"{activity} is not a valid activity")
+
+    # Consider None unit value as factor of 1
+    if unit is None:
+        return value
+
+    raw_data = json.load(open(filename))
+    units_data = raw_data.get("units")
+
+    for unit_name, data in units_data.items():
+        if unit in data["aliases"]:
+            return value * data["factor"]
+
+    raise ValueError(f"{unit} is not a valid unit")
+
+
+def log_activity(
+        timestamp: int,
+        username: str,
+        activity: str,
+        value: int | float,
+        unit: str | None
+) -> None:
+    """
+    Logs the activity in .csv file
+    :param timestamp:
+    :param username:
+    :param activity:
+    :param value:
+    :param unit:
+    :return:
+    """
+    if value <= 0 or not isinstance(value, int | float):
+        raise ValueError(f"{value} is not a valid value")
+    filename = activity_log_path(activity)
+    if not os.path.exists(filename):
+        create_activity_log_file(activity)
+    if is_convertable(activity):
+        converted_value = round(convert_units(activity, value, unit), 2)
+    else:
+        converted_value = round(value, 2)
+    with open(filename, 'a') as f:
+        writer = csv.writer(f)
+        writer.writerow([timestamp, username, converted_value])
+
+
+if __name__ == "__main__":
+    log_activity(
+        timestamp=0,
+        username="test",
+        activity="climb",
+        value=1,
+        unit="m"
+    )

fitnessCog/fitness.py

@@ -0,0 +1,134 @@
+import os
+from pathlib import Path
+
+import discord
+from redbot.core import commands
+from redbot.core.data_manager import bundled_data_path
+
+from .activity_logger import log_activity
+
+
+class FitnessCog(commands.Cog):
+    def __init__(self, bot):
+        self.bot = bot
+
+        default_threads = "1457402451530350727,1328363409648910356"
+        threads_raw = os.getenv("THREADS_ID", default_threads)
+
+        self.threads_id = []
+        for x in threads_raw.split(","):
+            x = x.strip()
+            if x.isdigit():
+                self.threads_id.append(int(x))
+
+        self.confirm_reactions = os.getenv("CONFIRMATION_REACTIONS", "🐈💨")
+        self.bundled_activities_dir: Path = bundled_data_path(self) / "activities"
+
+    # ---- path helpers ----
+    def activity_units_path(self, activity: str) -> Path:
+        return self.bundled_activities_dir / f"{activity}.json"
+
+    def activity_log_path(self, activity: str) -> Path:
+        return self.bundled_activities_dir / f"{activity}_log.json"
+
+    @commands.Cog.listener()
+    async def on_message(self, message: discord.Message):
+        if message.author.bot:
+            return
+        if message.channel.id not in self.threads_id:
+            return
+
+        content = (message.content or "").strip()
+        if not content.startswith("!"):
+            return
+
+        cmdline = content[1:].strip().lower()
+        if not cmdline:
+            return
+
+        cmd, *rest = cmdline.split(" ", 1)
+        arg = rest[0].strip() if rest else ""
+
+        if cmd == "getunits":
+            await self.get_units_file(message, arg)
+            return
+
+        if cmd == "getlog":
+            await self.get_log_file(message, arg)
+            return
+
+        await self.log_fitness(message)
+
+    async def get_units_file(self, message: discord.Message, activity: str):
+        try:
+            if not activity:
+                await message.channel.send(
+                    "Usage: `!getunits <activity>` (example: `!getunits pushups`)"
+                )
+                return
+
+            path = self.activity_units_path(activity)
+
+            if not path.exists():
+                await message.channel.send(f"No units JSON found for `{activity}`.")
+                return
+
+            await message.channel.send(file=discord.File(fp=str(path)))
+
+        except Exception as e:
+            await message.channel.send(str(e))
+
+    async def get_log_file(self, message: discord.Message, activity: str):
+        try:
+            if not activity:
+                await message.channel.send(
+                    "Usage: `!getlog <activity>` (example: `!getlog pushups`)"
+                )
+                return
+
+            path = self.activity_log_path(activity)
+
+            if not path.exists():
+                await message.channel.send(f"No log JSON found for `{activity}`.")
+                return
+
+            await message.channel.send(file=discord.File(fp=str(path)))
+
+        except Exception as e:
+            await message.channel.send(str(e))
+
+    async def log_fitness(self, message: discord.Message):
+        try:
+            parts = message.content[1:].strip().split()
+            if len(parts) < 2:
+                await message.reply(
+                    "Usage: `!<activity> <value> [unit]` (example: `!pushups 20` or `!run 5 km`)"
+                )
+                return
+
+            activity = parts[0]
+
+            try:
+                value = float(parts[1])
+            except ValueError:
+                await message.reply(
+                    "Invalid number. Usage: `!<activity> <value> [unit]` (example: `!run 5 km`)"
+                )
+                return
+
+            unit = parts[2] if len(parts) > 2 else "m"
+
+            timestamp = int(message.created_at.timestamp())
+            username = message.author.name
+
+            log_activity(timestamp, username, activity, value, unit)
+
+            for r in self.confirm_reactions:
+                await message.add_reaction(r)
+
+        except Exception as e:
+            await message.reply(str(e))
+
+
+def setup(bot):
+    bot.add_cog(FitnessCog(bot))