disrb 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6deda52f746ca6b5a0288842930d00b6a88ae807968faf1247e9d13ca5f6156
-  data.tar.gz: 95ca41d74b765546a14dc658671c0da64ef7bf25be9bdc9a434812836d2b1355
+  metadata.gz: 755465c33626010b7a97992a3afbcee4459e9feae3249870900531ce315ae4f5
+  data.tar.gz: dec666a3607d7d21b3a526f6435a291122239ab66ad908d6d3a2626c1fd7ea45
 SHA512:
-  metadata.gz: 35fa13cc8b978785309b19566b7daa932237afcc9125835bd75863fe456a26c7adc30b1a2d3507bcd6c4c459e17d22d1313cde56dc4a8c92e065773a8bb5e227
-  data.tar.gz: 71511d399e5ad53222a6253f63da1562abdee97a9dc1e0b6339650bc4a94e094d1dc00fa27155c039c9b8d675014c5c8077ee6aa8a4a13cf47fa9d067245ad88
+  metadata.gz: 1120cf0957b7e7ab2c7fdbf011b27816cb9085cb957f8c3eee37813a1a3627a4649adcb2ca001052740fca0fa7db50e6a0731b87d0ad73b46d0771f1b6fad764
+  data.tar.gz: d554f6fe8e41c6846d5ed186cc27988e050dc57af37a041203fa5c887414185238dce3c282c88b3c3a14c4e7f3f528eb7c6257b5fdd92e16b167fdd06b86b4df

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+# v0.1.4 (2026-04-05)
+
+- Add support for file uploading
+- Fix bug where HTTP handlers would continue executing even after an error
+- Add missing User-Agent header in requests to the HTTP API (it can be changed from the default)
+- Fix bug where functions may run `body` and `status` functions on a nil object
+- Change 200 server limit notice from a warning to an info message in `get_current_user_guilds`
+- Slight modifications in `README.md` and `LICENSE`
+
+## Breaking changes
+
+- Any project using `DiscordApi`'s `get`, `post`, `delete`, `put` and `patch` functions will not work, as they have been made private (only functions inside the same class can call them), in order to add functionality for customizing the User-Agent header included in requests to the HTTP API.
+
 # v0.1.3 (2025-11-15)
 
 - Add documentation

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2025-until the sun explodes hoovad
+Copyright (c) 2025-2026 hoovad
 
 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:
 

data/README.md

@@ -2,16 +2,27 @@
 
 [![Licensed under the MIT license](https://img.shields.io/github/license/hoovad/discord.rb)](LICENSE)
 [![Gem Version](https://img.shields.io/gem/v/disrb?logo=ruby&color=green)](https://rubygems.org/gems/disrb)
-![project status: active](https://img.shields.io/badge/project_status-active-active)
+![project status: active](https://img.shields.io/badge/project_status-active-green)
 [![main](https://github.com/hoovad/discord.rb/actions/workflows/main.yml/badge.svg)](https://github.com/hoovad/discord.rb/actions/workflows/main.yml)
 
-[Changelog](CHANGELOG.md) | [Documentation](https://www.rubydoc.info/gems/disrb/) (currently in development)
+[Changelog](CHANGELOG.md) | [Documentation](https://www.rubydoc.info/gems/disrb/) | [Contributing](CONTRIBUTING.md)
+
+> [!IMPORTANT]
+> This is project is still in early development. Expect changes that might break your code at any time. If your code suddenly doesn't work but it did on a previous version, check the [Changelog](CHANGELOG.md) for any breaking changes.
 
 W.I.P. Discord API wrapper written in Ruby for fun.
 
-The test.rb file creates two commands "test" and "test2", that return "Hi" and "Hello World!" respectively, sets the bot's current activity to 'Watching if i work', and sets the presence to online since the program was started provided you provide the required data in `env.rb.template` and rename it to `env.rb`.
+> [!NOTE]
+> This is not a full-featured Discord API handler. This gem lets you interact with the Discord API directly without all the baggage. If you want to make a bot extremely easily, this is not what you are looking for.
+
+If you wanted to use this project, but found that something is missing, doesn't work, don't be afraid to open an issue! Read the [Contributing](CONTRIBUTING.md) page.
+
+## Demonstration
+
+The test.rb file creates two commands "test" and "test2", that return "Hi" and "Hello World!" respectively, sets the bot's current activity to 'Watching if i work', and sets the presence to online since the program was started.
 
-!DISCLAIMER! This is project is in development. Expect changes that might break your code at any time.
+> [!NOTE]
+> You will need to fill out the required data in `env.rb.template` and rename it to `env.rb` before running `test.rb`.
 
 ## How to use this project
 
@@ -19,9 +30,10 @@ The documentation will contain information about the functions implemented in th
 
 Most functions in this library return a `Faraday::Response` object. Check the [Faraday documentation](https://www.rubydoc.info/github/lostisland/faraday) for info on how to use that object. 
 
-If you want to get the contents of the response, use the `body` instance method (example: `[Faraday::Response object here].body`). The contents will most likely be JSON. To convert it to a Ruby object, use `JSON.parse([Faraday::Response object here].body)`.
+If you want to get the contents of the response, use the `body` instance method (example: `[Faraday::Response object here].body`). The contents will most likely be JSON. To convert it to a Ruby object, use `JSON.parse([Faraday::Response object here].body)` (with `require 'json'` of course).
 
-When reading the documentation, there most likely will be a link to the relevant Discord Developer Documentation page. Please read that page as well, it will contain information that may help you.
+> [!TIP]
+> When reading the documentation, there most likely will be a link to the relevant Discord Developer Documentation page. Please read that page as well, it will contain information that may help you.
 
 ## Roadmap
 - [x] Indev release (v0.1.0)
@@ -46,5 +58,5 @@ When reading the documentation, there most likely will be a link to the relevant
     - [ ] Voice support
     - [ ] Add parameter validation
 - [ ] Stable release (v1.0.0)
-    - [ ] Class-ification update (instead of returning the raw HTTP response, make them into classes to make responses easier to use)
+    - [ ] Return classes instead of `Faraday::Response` objects
     - [ ] Bugfixes, consistency and improvements

data/lib/disrb/application_commands.rb

@@ -37,10 +37,11 @@ class DiscordApi
     url = "#{@base_url}/applications/#{@application_id}/guilds/#{guild_id}/commands"
     data = JSON.generate(output)
     headers = { 'Authorization': @authorization_header, 'Content-Type': 'application/json' }
-    response = DiscordApi.post(url, data, headers)
-    return response if response.status == 201 || response.status == 200
+    response = post(url, data, headers)
+    return response if response.is_a?(Faraday::Response) && (response.status == 201 || response.status == 200)
 
-    @logger.error("Failed to create guild application command in guild with ID #{guild_id}. Response: #{response.body}")
+    @logger.error("Failed to create guild application command in guild with ID #{guild_id}." \
+                  " Response: #{response_error_body(response)}")
     response
   end
 
@@ -112,10 +113,10 @@ class DiscordApi
     url = "#{@base_url}/applications/#{@application_id}/commands"
     data = JSON.generate(output)
     headers = { 'Authorization': @authorization_header, 'Content-Type': 'application/json' }
-    response = DiscordApi.post(url, data, headers)
-    return response if response.status == 201 || response.status == 200
+    response = post(url, data, headers)
+    return response if response.is_a?(Faraday::Response) && (response.status == 201 || response.status == 200)
 
-    @logger.error("Failed to create global application command. Response: #{response.body}")
+    @logger.error("Failed to create global application command. Response: #{response_error_body(response)}")
     response
   end
 
@@ -178,10 +179,11 @@ class DiscordApi
     url = "#{@base_url}/applications/#{@application_id}/commands/#{command_id}"
     data = JSON.generate(output)
     headers = { 'Authorization': @authorization_header, 'Content-Type': 'application/json' }
-    response = DiscordApi.patch(url, data, headers)
-    return response if response.status == 200
+    response = patch(url, data, headers)
+    return response if response.is_a?(Faraday::Response) && response.status == 200
 
-    @logger.error("Failed to edit global application command with ID #{command_id}. Response: #{response.body}")
+    @logger.error("Failed to edit global application command with ID #{command_id}." \
+                  " Response: #{response_error_body(response)}")
     response
   end
 
@@ -218,10 +220,11 @@ class DiscordApi
     url = "#{@base_url}/applications/#{@application_id}/guilds/#{guild_id}/commands/#{command_id}"
     data = JSON.generate(output)
     headers = { 'Authorization': @authorization_header, 'Content-Type': 'application/json' }
-    response = DiscordApi.patch(url, data, headers)
-    return response if response.status == 200
+    response = patch(url, data, headers)
+    return response if response.is_a?(Faraday::Response) && response.status == 200
 
-    @logger.error("Failed to edit guild application command with ID #{command_id}. Response: #{response.body}")
+    @logger.error("Failed to edit guild application command with ID #{command_id}." \
+                  " Response: #{response_error_body(response)}")
     response
   end
 
@@ -232,10 +235,11 @@ class DiscordApi
   def delete_global_application_command(command_id)
     url = "#{@base_url}/applications/#{@application_id}/commands/#{command_id}"
     headers = { 'Authorization': @authorization_header }
-    response = DiscordApi.delete(url, headers)
-    return response if response.status == 204
+    response = delete(url, headers)
+    return response if response.is_a?(Faraday::Response) && response.status == 204
 
-    @logger.error("Failed to delete global application command with ID #{command_id}. Response: #{response.body}")
+    @logger.error("Failed to delete global application command with ID #{command_id}." \
+                  "Response: #{response_error_body(response)}")
     response
   end
 
@@ -247,11 +251,12 @@ class DiscordApi
   def delete_guild_application_command(guild_id, command_id)
     url = "#{@base_url}/applications/#{@application_id}/guilds/#{guild_id}/commands/#{command_id}"
     headers = { 'Authorization': @authorization_header }
-    response = DiscordApi.delete(url, headers)
-    return response if response.status == 204
+    response = delete(url, headers)
+    return response if response.is_a?(Faraday::Response) && response.status == 204
 
     @logger.error("Failed to delete guild application command with ID #{command_id} in guild with ID #{guild_id}. " \
-                  "Response: #{response.body}")
+                  "Response: #{response_error_body(response)}")
+    response
   end
 
   # Returns a list of application commands for a guild. Returns 200 OK with an array of command objects.
@@ -265,10 +270,11 @@ class DiscordApi
     query_string = DiscordApi.handle_query_strings(query_string_hash)
     url = "#{@base_url}/applications/#{@application_id}/guilds/#{guild_id}/commands#{query_string}"
     headers = { 'Authorization': @authorization_header }
-    response = DiscordApi.get(url, headers)
-    return response if response.status == 200
+    response = get(url, headers)
+    return response if response.is_a?(Faraday::Response) && response.status == 200
 
-    @logger.error("Failed to get guild application commands for guild with ID #{guild_id}. Response: #{response.body}")
+    @logger.error("Failed to get guild application commands for guild with ID #{guild_id}." \
+                  " Response: #{response_error_body(response)}")
     response
   end
 
@@ -282,10 +288,10 @@ class DiscordApi
     query_string = DiscordApi.handle_query_strings(query_string_hash)
     url = "#{@base_url}/applications/#{@application_id}/commands#{query_string}"
     headers = { 'Authorization': @authorization_header }
-    response = DiscordApi.get(url, headers)
-    return response if response.status == 200
+    response = get(url, headers)
+    return response if response.is_a?(Faraday::Response) && response.status == 200
 
-    @logger.error("Failed to get global application commands. Response: #{response.body}")
+    @logger.error("Failed to get global application commands. Response: #{response_error_body(response)}")
     response
   end
 
@@ -296,10 +302,11 @@ class DiscordApi
   def get_global_application_command(command_id)
     url = "#{@base_url}/applications/#{@application_id}/commands/#{command_id}"
     headers = { 'Authorization': @authorization_header }
-    response = DiscordApi.get(url, headers)
-    return response if response.status == 200
+    response = get(url, headers)
+    return response if response.is_a?(Faraday::Response) && response.status == 200
 
-    @logger.error("Failed to get global application command with ID #{command_id}. Response: #{response.body}")
+    @logger.error("Failed to get global application command with ID #{command_id}." \
+                  " Response: #{response_error_body(response)}")
     response
   end
 
@@ -311,10 +318,11 @@ class DiscordApi
   def get_guild_application_command(guild_id, command_id)
     url = "#{@base_url}/applications/#{@application_id}/guilds/#{guild_id}/commands/#{command_id}"
     headers = { 'Authorization': @authorization_header }
-    response = DiscordApi.get(url, headers)
-    return response if response.status == 200
+    response = get(url, headers)
+    return response if response.is_a?(Faraday::Response) && response.status == 200
 
-    @logger.error("Failed to get guild application command with ID #{command_id}. Response: #{response.body}")
+    @logger.error("Failed to get guild application command with ID #{command_id}." \
+                  " Response: #{response_error_body(response)}")
     response
   end
 
@@ -326,10 +334,10 @@ class DiscordApi
     url = "#{@base_url}/applications/#{@application_id}/commands"
     data = JSON.generate(commands)
     headers = { 'Authorization': @authorization_header, 'Content-Type': 'application/json' }
-    response = DiscordApi.put(url, data, headers)
-    return response if response.status == 200
+    response = put(url, data, headers)
+    return response if response.is_a?(Faraday::Response) && response.status == 200
 
-    @logger.error("Failed to bulk overwrite global application commands. Response: #{response.body}")
+    @logger.error("Failed to bulk overwrite global application commands. Response: #{response_error_body(response)}")
     response
   end
 
@@ -342,11 +350,11 @@ class DiscordApi
     url = "#{@base_url}/applications/#{@application_id}/guilds/#{guild_id}/commands"
     data = JSON.generate(commands)
     headers = { 'Authorization': @authorization_header, 'Content-Type': 'application/json' }
-    response = DiscordApi.put(url, data, headers)
-    return response if response.status == 200
+    response = put(url, data, headers)
+    return response if response.is_a?(Faraday::Response) && response.status == 200
 
     @logger.error("Failed to bulk overwrite guild application commands in guild with ID #{guild_id}. " \
-                    "Response: #{response.body}")
+                    "Response: #{response_error_body(response)}")
     response
   end
 
@@ -357,11 +365,11 @@ class DiscordApi
   def get_guild_application_command_permissions(guild_id)
     url = "#{@base_url}/applications/#{@application_id}/guilds/#{guild_id}/commands/permissions"
     headers = { 'Authorization': @authorization_header }
-    response = DiscordApi.get(url, headers)
-    return response if response.status == 200
+    response = get(url, headers)
+    return response if response.is_a?(Faraday::Response) && response.status == 200
 
     @logger.error("Failed to get guild application command permissions for guild with ID #{guild_id}. " \
-                    "Response: #{response.body}")
+                    "Response: #{response_error_body(response)}")
     response
   end
 
@@ -373,11 +381,11 @@ class DiscordApi
   def get_application_command_permissions(guild_id, command_id)
     url = "#{@base_url}/applications/#{@application_id}/guilds/#{guild_id}/commands/#{command_id}/permissions"
     headers = { 'Authorization': @authorization_header }
-    response = DiscordApi.get(url, headers)
-    return response if response.status == 200
+    response = get(url, headers)
+    return response if response.is_a?(Faraday::Response) && response.status == 200
 
     @logger.error("Failed to get appliaction command permissions for command with ID #{command_id} in guild with ID " \
-                    "#{guild_id}. Response: #{response.body}")
+                    "#{guild_id}. Response: #{response_error_body(response)}")
     response
   end
 
@@ -391,11 +399,11 @@ class DiscordApi
     url = "#{@base_url}/applications/#{@application_id}/guilds/#{guild_id}/commands/#{command_id}/permissions"
     data = JSON.generate(permissions)
     headers = { 'Authorization': @authorization_header, 'Content-Type': 'application/json' }
-    response = DiscordApi.put(url, data, headers)
-    return response if response.status == 200
+    response = put(url, data, headers)
+    return response if response.is_a?(Faraday::Response) && response.status == 200
 
     @logger.error("Failed to edit application command permissions for command with ID #{command_id} in guild with ID " \
-                    "#{guild_id}. Response: #{response.body}")
+                    "#{guild_id}. Response: #{response_error_body(response)}")
     response
   end
 end