docs(gateway): add ping pong slash command example

Author: TAG-Epic

examples/gateway/ping_pong_slash_command/README.md

@@ -0,0 +1,13 @@
+# Ping pong - slash command edition
+## Environment variables
+The following environment variables is required
+
+1. TOKEN
+This can be found in your developer dashboard.
+2. APPLICATION_ID
+This is usually the ID of your bot.
+
+## Creating the commands
+Please run the [register_commands script](register_commands.py)
+
+After that just run the example

examples/gateway/ping_pong_slash_command/ping_pong_slash_command.py

@@ -0,0 +1,85 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2022-present nextcore developers
+#
+# Permission is hereby granted, free of charge, to any person obtaining a
+# copy of this software and associated documentation files (the "Software"),
+# to deal in the Software without restriction, including without limitation
+# the rights to use, copy, modify, merge, publish, distribute, sublicense,
+# and/or sell copies of the Software, and to permit persons to whom the
+# Software is furnished to do so, subject to the following conditions:
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+# DEALINGS IN THE SOFTWARE.
+
+"""
+A simple "ping pong" example of using nextcore, but in slash commands.
+
+This will respond with "pong" every time someone sends "ping" in the chat.
+"""
+
+import asyncio
+from os import environ
+from typing import cast
+
+from discord_typings import InteractionCreateData
+
+from nextcore.gateway import ShardManager
+from nextcore.http import BotAuthentication, HTTPClient, Route
+
+# Constants
+AUTHENTICATION = BotAuthentication(environ["TOKEN"])
+
+# Intents are a way to select what intents Discord should send to you.
+# For a list of intents see https://discord.dev/topics/gateway#gateway-intents
+INTENTS = 0 # Guild messages and message content intents.
+
+
+# Create a HTTPClient and a ShardManager.
+# A ShardManager is just a neat wrapper around Shard objects.
+http_client = HTTPClient()
+shard_manager = ShardManager(AUTHENTICATION, INTENTS, http_client)
+
+
+@shard_manager.event_dispatcher.listen("INTERACTION_CREATE")
+async def on_interaction_create(interaction: InteractionCreateData):
+    # Only accept application comamnds. See https://discord.dev/interactions/receiving-and-responding#interaction-object-interaction-type for a list of types
+    if interaction["type"] != 2: 
+        return
+    # Only respond to the ping command
+    if interaction["data"]["name"] != "ping":
+        return
+
+    response = {
+        "type": 4,
+        "data": {
+            "content": "Pong!"
+        }
+    }
+
+    route = Route("POST", "/interactions/{interaction_id}/{interaction_token}/callback", interaction_id=interaction["id"], interaction_token = interaction["token"])
+    # Authentication is interaction id and interaction token, not bot authenication
+    await http_client.request(route, rate_limit_key=None, json=response)
+
+
+async def main():
+    await http_client.setup()
+
+    # This should return once all shards have started to connect.
+    # This does not mean they are connected.
+    await shard_manager.connect()
+
+    # Raise a error and exit whenever a critical error occurs
+    (error,) = await shard_manager.dispatcher.wait_for(lambda: True, "critical")
+
+    raise cast(Exception, error)
+
+
+asyncio.run(main())

examples/gateway/ping_pong_slash_command/register_commands.py

@@ -0,0 +1,60 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2022-present nextcore developers
+#
+# Permission is hereby granted, free of charge, to any person obtaining a
+# copy of this software and associated documentation files (the "Software"),
+# to deal in the Software without restriction, including without limitation
+# the rights to use, copy, modify, merge, publish, distribute, sublicense,
+# and/or sell copies of the Software, and to permit persons to whom the
+# Software is furnished to do so, subject to the following conditions:
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+# DEALINGS IN THE SOFTWARE.
+
+"""
+The register script for this example.
+
+This will register the "ping" slash command we need for this example.
+
+NOTE: This only needs to be run once per bot, and should be ran before the example.
+WARNING: This will remove all other commands
+"""
+
+from __future__ import annotations # We want to use newer type hinting. If you are using python 3.9+ feel free to remove this.
+
+import asyncio
+from os import environ
+from discord_typings import ApplicationCommandPayload
+from nextcore.http import BotAuthentication, Route, HTTPClient
+
+# Constants
+AUTHENTICATION = BotAuthentication(environ["TOKEN"])
+APPLICATION_ID = environ["APPLICATION_ID"] # This should also usually be the same as your bots id.
+COMMANDS: list[ApplicationCommandPayload] = [ # TODO: Currently we have no TypedDict for this.
+    {
+        "name": "ping",
+        "description": "Responds with pong!"
+    }
+]
+
+http_client = HTTPClient()
+
+async def main() -> None:
+    await http_client.setup()
+
+    route = Route("PUT", "/applications/{application_id}/commands", application_id=APPLICATION_ID)
+    await http_client.request(route, rate_limit_key=AUTHENTICATION.rate_limit_key, headers=AUTHENTICATION.headers, json=COMMANDS)
+
+    print("Commands registered")
+
+    await http_client.close()
+
+asyncio.run(main())