✨ Add status push extension

Author: Paillat-dev

readme.md

@@ -150,6 +150,7 @@ We provide multiple extensions directly within this project to get you started.
 - [`branding`](src/extensions/branding/readme.md): An extension to customize the bot's presence and status, and embed aesthetics.
 - [`add-dm`](src/extensions/add-dm/readme.md): An extension to send a direct message to the user who adds the bot to a guild.
 - [`nice-errors`](src/extensions/nice-errors/readme.md): An extension to provide user-friendly error messages during command execution.
+- [`status-post`](src/extensions/status-post/readme.md): An extension to post the bot's status to a specified URL.
 
 Read the provided documentation for each extension to learn more about their features and how to configure them.
 

src/extensions/status-post/__init__.py

@@ -0,0 +1 @@
+from .main import setup, setup_webserver, on_startup, default, schema

src/extensions/status-post/main.py

@@ -0,0 +1,49 @@
+import discord
+import aiohttp
+
+from discord.ext import commands
+from schema import Schema
+from src.logging import logger
+from discord.ext import tasks
+
+
+default = {
+    "enabled": False,
+    "url": "",
+    "every": 60,
+}
+
+schema = Schema(
+    {
+        "enabled": bool,
+        "url": str,
+        "every": int,
+    }
+)
+
+
+class Status(commands.Cog):
+    def __init__(self, bot: discord.Bot, config: dict):
+        self.bot = bot
+        self.config = config
+        tasks.loop(seconds=self.config["url"])(self.push_status_loop).start()
+
+    @commands.Cog.listener(once=True)
+    async def on_ready(self):
+        self.push_status_loop.start()
+
+    async def push_status_loop(self):
+        try:
+            await self.push_status()
+            logger.info("Pushed status.")
+        except Exception as e:
+            logger.error(f"Failed to push status: {e}")
+
+    async def push_status(self):
+        ping = str(round(self.bot.latency * 1000))
+        async with aiohttp.ClientSession() as session:
+            async with session.get(self.config["url"] + ping) as resp:
+                resp.raise_for_status()
+
+def setup(bot: discord.Bot, config: dict):
+    bot.add_cog(Status(bot, config))

src/extensions/status-post/readme.md

@@ -0,0 +1,33 @@
+# Status Extension
+
+The Status extension is a straightforward, yet essential part of your Botkit.
+It requires minimal configuration and can be enabled or disabled as needed.
+
+## Features
+
+The Status extension periodically pushes the bot's status to a specified URL.
+This can be useful for monitoring the bot's health and responsiveness.
+
+## Usage
+
+To use the Status extension, configure the `url` and `every` keys in the `config.yml` file or through environment variables. The bot will push its status to the specified URL at the configured interval.
+
+## Configuration
+
+The Status extension requires the following configuration:
+
+- `enabled`: A boolean indicating whether the extension is enabled.
+- `url`: The URL to which the bot's status will be pushed.
+- `every`: The interval (in seconds) at which the bot's status will be pushed.
+
+Example configuration in `config.yml`:
+
+```yaml
+status:
+  enabled: true
+  url: "http://example.com/status"
+  every: 60
+```
+
+## Contributing
+If you wish to contribute to the development of the Status extension, please feel free to submit a pull request. We appreciate your help in making this extension better.