feat: Bot support

.github/workflows/lint-and-test.yml

@@ -1,8 +1,5 @@
 name: Lint and Test
 
-env:
-  GH_USER: cryptoAlgorithm
-
 on:
   push:
     branches: [ main ] # Running on every branch causes double runs for PR commits
@@ -20,9 +17,15 @@ jobs:
       - uses: actions/checkout@v3
 
       - name: Xcode Select
-        uses: devbotsxyz/[email protected]
+        uses: maxim-lobanov/setup-xcode@v1
+        with:
+          xcode-version: '14.1'
+
+      - name: Cache Swift Build
+        uses: actions/cache@v3
         with:
-          version: 13.3.1
+          path: .build
+          key: swift-build-cache
 
       # Runs a single command using the runners shell
       - name: Build
@@ -36,9 +39,15 @@ jobs:
       - uses: actions/checkout@v3
 
       - name: Xcode Select
-        uses: devbotsxyz/[email protected]
+        uses: maxim-lobanov/setup-xcode@v1
+        with:
+          xcode-version: '14.1'
+
+      - name: Cache Swift Build
+        uses: actions/cache@v3
         with:
-          version: 13.3.1
+          path: .build
+          key: swift-build-cache # -${{ hashFiles('**/*.swift') }}
 
       - name: Test
         run: swift test

.swiftlint.yml

@@ -3,13 +3,15 @@ disabled_rules:
   - unused_closure_parameter
   - multiple_closures_with_trailing_closure
   - large_tuple
+  - todo # TODOs are precisely for reminding me of tasks I'll have to do in the future. If they are flagged as violations, it completely defeats the point.
 opt_in_rules:
 
 force_cast: warning
 force_try: warning
 
 excluded:
   - Sources/DiscordKit/protos
+  - .build
 
 identifier_name:
   min_length:
@@ -19,4 +21,11 @@ identifier_name:
     warning: 40
     error: 50
   allowed_symbols: ["_"]
+cyclomatic_complexity:
+  ignores_case_statements: true
+nesting:
+  type_level:
+    warning: 5
+    error: 8
+
 reporter: "xcode" # reporter type (xcode, json, csv, checkstyle, junit, html, emoji, sonarqube, markdown)

Package.swift

@@ -10,36 +10,44 @@ let package = Package(
     ],
 	products: [
         .library(name: "DiscordKitCore", targets: ["DiscordKitCore"]),
-		.library(name: "DiscordKit", targets: ["DiscordKit"]),
-		.library(name: "DiscordKitCommon", targets: ["DiscordKitCommon"]),
+		.library(name: "DiscordKit", targets: ["DiscordKit"]), // User-oriented module, simplifies use of API for UI apps
+        .library(name: "DiscordKitBot", targets: ["DiscordKitBot"]) // Bot-oriented module, for use in bots
 	],
 	dependencies: [
         .package(url: "https://github.com/ashleymills/Reachability.swift", from: "5.1.0"),
         .package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0"),
         .package(url: "https://github.com/apple/swift-protobuf.git", from: "1.6.0"),
+        .package(url: "https://github.com/apple/swift-log.git", from: "1.0.0")
 	],
 	targets: [
         .target(
             name: "DiscordKitCore",
             dependencies: [
                 .product(name: "Reachability", package: "Reachability.swift", condition: .when(platforms: [.macOS])),
                 .product(name: "SwiftProtobuf", package: "swift-protobuf"),
-                .target(name: "DiscordKitCommon"),
+                .product(name: "Logging", package: "swift-log")
             ],
             exclude: [
                 "REST/README.md",
-                "Gateway/README.md"
+                "Gateway/README.md",
+                "Objects/README.md"
             ]
         ),
 		.target(
             name: "DiscordKit",
-            dependencies: [.target(name: "DiscordKitCore")]
+            dependencies: [
+                .target(name: "DiscordKitCore"),
+                .product(name: "Logging", package: "swift-log")
+            ]
         ),
-		.target(
-            name: "DiscordKitCommon",
-            exclude: ["Objects/README.md"]
+        .target(
+            name: "DiscordKitBot",
+            dependencies: [
+                .target(name: "DiscordKitCore"),
+                .product(name: "SwiftProtobuf", package: "swift-protobuf")
+            ]
         ),
-        .testTarget(name: "DiscordKitCommonTests", dependencies: ["DiscordKitCommon"])
+        .testTarget(name: "DiscordKitCommonTests", dependencies: ["DiscordKitCore"])
 	],
     swiftLanguageVersions: [.v5]
 )

README.md

@@ -1,32 +1,112 @@
-# DiscordKit
+<p align="center">
+  <img src="https://user-images.githubusercontent.com/64193267/208341700-75fb1d63-f044-4b60-9c86-ed945916b65c.png" height="128">
+</p>
 
-![Discord](https://img.shields.io/discord/964741354112577557?style=for-the-badge)
+<h1 align="center">DiscordKit</h1>
 
-The Discord API implementation that powers [Swiftcord](https://github.com/SwiftcordApp/Swiftcord),
-a native Discord client for macOS also written in Swift.
+<p align="center">
+  <a aria-label="Join the community on Discord" href="https://discord.gg/he7n6MGDXS" target="_blank">
+    <img alt="" src="https://img.shields.io/discord/964741354112577557?style=for-the-badge&labelColor=black&label=Discord">
+  </a>
 
-A (mainly) fully functional Discord API library written from scratch fully in Swift!
-Currently only supports user accounts, bot support coming soon. Check out the
-[`bot-support`](https://github.com/SwiftcordApp/DiscordKit/tree/bot-support) branch
-and SwiftcordApp/DiscordKit#18 for a quick peep into what we've been up to ;D
+  <!-- Self-hosted tokei_rs instance, only works for repos in the SwiftcordApp org -->
+  <img alt="" src="https://vinkwok.tk/tokei/github/SwiftcordApp/DiscordKit?style=for-the-badge&branch=bot-support">
 
-**If you like DiscordKit, please give it a ⭐ star, or consider sponsoring! It helps motivate
-me to continue developing it**
+  <a aria-label="DiscordKit Guide" href="https://swiftcord.gitbook.io/discordkit-guide/" target="_blank">
+    <img alt="" src="https://img.shields.io/badge/guide-gitbook-important?style=for-the-badge&labelColor=black">
+  </a>
+</p>
 
-## Documentation
+<p align="center">Package for interacting with Discord's API to build Swift bots</p>
 
-WIP Developer Documentation is available [here](https://swiftcordapp.github.io/DiscordKit/documentation/discordkit/).
+> DiscordKit for Bots is now released! Use DiscordKit to create that bot you've been
+> looking to make, in the Swift that you know and love!
 
-## Platform Support
+## About
+
+DiscordKit is a Swift package for creating Discord bots in Swift.
+
+**If DiscordKit has helped you, please give it a ⭐ star, or consider sponsoring! It
+keeps me motivated to continue developing this and other projects.**
+
+## Installation
+
+### Swift Package Manager (SPM):
+
+<details>
+  <summary><code>Package.swift</code></summary>
+
+  Add the following to your `Package.swift`:
+  ```swift
+  .package(url: "https://github.com/SwiftcordApp/DiscordKit", branch: "bot-support")
+  ```
+</details>
+<details>
+  <summary>Xcode Project</summary>
 
-Currently, DiscordKit only offically supports macOS versions 12 and up. Theoretically, You should be able to compile and use DiscordKit on i(Pad)OS/tvOS, however this has not been tested and is considered an unsupported setup.
+  Add a package dependancy in your Xcode project with the following parameters:
 
-Linux and Windows is not supported at the moment, due to our reliance on Apple's `Security` and `SystemConfiguration` frameworks. We have not blocked building DiscordKit on Linux and Windows in the event that support for those frameworks is added in the future. We may rework the code to add support for linux/windows in the future.
+  **Package URL:**
+  ```
+  https://github.com/SwiftcordApp/DiscordKit
+  ```
+
+  **Branch:**
+  ```
+  bot-support
+  ```
+
+  **Product:**
+  - [x] DiscordKitBot
+</details>
+
+For more detailed instructions, refer to [this page](https://app.gitbook.com/o/bq2pyf3PEDPf2CURHt4z/s/WJuHiYLW9jKqPb7h8D7t/getting-started/installation)
+in the DiscordKit guide.
+
+## Example Usage
+
+Create a simple bot with a **/ping** command:
 
-## Adding DiscordKit to your project
-### SPM:
-Add the following to your `Package.swift`:
 ```swift
-.package(url: "https://github.com/SwiftcordApp/DiscordKit", branch: "main"),
+
+import DiscordKitBot
+
+let bot = Client(intents: .unprivileged)
+
+bot.ready.listen {
+    print("Logged in as \(bot.user!.username)#\(bot.user!.discriminator)!")
+
+    print("Started refreshing application (/) commands.")
+    try? await bot.registerApplicationCommands(guild: ProcessInfo.processInfo.environment["COMMAND_GUILD_ID"]) {
+        NewAppCommand("ping", description: "Ping me!") { interaction in
+            try? await interaction.reply("Pong!")
+        }
+    }
+    print("Successfully reloaded application (/) commands.")
+}
+
+bot.login() // Reads the bot token from the DISCORD_TOKEN environment variable and logs in with the token
+
+// Run the main RunLoop to prevent the program from exiting
+RunLoop.main.run()
 ```
-Currently, DiscordKit is in alpha, so it's recommended to use the latest commit on the `main` branch.
+_(Yes, that's really the whole code, no messing with registering commands with the REST
+API or anything!)_
+
+Not sure what to do next? Check out the guide below, which walks you through
+all the steps to create your own Discord bot!
+
+## Resources
+
+Here are some (WIP) resources that might be useful while developing with DiscordKit.
+
+* [DiscordKit Guide](https://swiftcord.gitbook.io/discordkit-guide/)
+* [Developer Documentation](https://swiftcordapp.github.io/DiscordKit/documentation/discordkit/)
+
+## Platform Support
+
+Currently, DiscordKit only offically supports macOS versions 11 and up. Theoretically, you should be able to compile and use DiscordKit on any Apple platform with equivalent APIs, however this has not been tested and is considered an unsupported setup.
+
+Linux and Windows is not supported at the moment, primarily due to our reliance on Apple's `Combine` framework. We have not blocked building DiscordKit on other platforms in the event that support for those frameworks is added to Swift's corelibs in the future.
+
+Linux support is planned, and will arrive sometime in the future. Unfortunately, we do not have a timeline for that at the moment.

Sources/DiscordKit/Extensions/Presence+.swift

@@ -1,12 +1,12 @@
 //
-//  File.swift
+//  Presence+.swift
 //  
 //
 //  Created by Vincent Kwok on 7/9/22.
 //
 
 import Foundation
-import DiscordKitCommon
+import DiscordKitCore
 
 extension Presence {
     init(protoStatus: StatusSettings, id: Snowflake) {