discorb 0.13.0 → 0.13.4

data/lib/discorb/client.rb

@@ -63,7 +63,7 @@ module Discorb
     # @param [Discorb::AllowedMentions] allowed_mentions The allowed mentions that the client is using.
     # @param [Discorb::Intents] intents The intents that the client is currently using.
     # @param [Integer] message_caches The number of messages to cache.
-    # @param [#puts] log The IO object to use for logging.
+    # @param [#write] log The IO object to use for logging.
     # @param [Boolean] colorize_log Whether to colorize the log.
     # @param [:debug, :info, :warn, :error, :critical] log_level The log level.
     # @param [Boolean] wait_until_ready Whether to delay event dispatch until ready.
@@ -105,7 +105,7 @@ module Discorb
 
     #
     # Registers an event handler.
-    # @see file:docs/Events.md
+    # @see file:docs/Events.md Events Documentation
     #
     # @param [Symbol] event_name The name of the event.
     # @param [Symbol] id Custom ID of the event.
@@ -146,10 +146,13 @@ module Discorb
 
     #
     # Dispatch an event.
+    # @async
     #
     # @param [Symbol] event_name The name of the event.
     # @param [Object] args The arguments to pass to the event.
     #
+    # @return [Async::Task<void>] The task.
+    #
     def dispatch(event_name, *args)
       Async do
         if (conditions = @conditions[event_name])
@@ -199,8 +202,7 @@ module Discorb
 
     #
     # Fetch user from ID.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [#to_s] id <description>
     #
@@ -210,15 +212,14 @@ module Discorb
     #
     def fetch_user(id)
       Async do
-        _resp, data = http.get("/users/#{id}").wait
+        _resp, data = @http.request(Route.new("/users/#{id}", "//users/:user_id", :get)).wait
         User.new(self, data)
       end
     end
 
     #
     # Fetch channel from ID.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [#to_s] id The ID of the channel.
     #
@@ -228,15 +229,14 @@ module Discorb
     #
     def fetch_channel(id)
       Async do
-        _resp, data = http.get("/channels/#{id}").wait
+        _resp, data = @http.request(Route.new("/channels/#{id}", "//channels/:channel_id", :get)).wait
         Channel.make_channel(self, data)
       end
     end
 
     #
     # Fetch guild from ID.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [#to_s] id <description>
     #
@@ -246,15 +246,14 @@ module Discorb
     #
     def fetch_guild(id)
       Async do
-        _resp, data = http.get("/guilds/#{id}").wait
+        _resp, data = @http.request(Route.new("/guilds/#{id}", "//guilds/:guild_id", :get)).wait
         Guild.new(self, data, false)
       end
     end
 
     #
     # Fetch invite from code.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [String] code The code of the invite.
     # @param [Boolean] with_count Whether to include the count of the invite.
@@ -264,7 +263,7 @@ module Discorb
     #
     def fetch_invite(code, with_count: false, with_expiration: false)
       Async do
-        _resp, data = http.get("/invites/#{code}?with_count=#{with_count}&with_expiration=#{with_expiration}").wait
+        _resp, data = @http.request(Route.new("/invites/#{code}?with_count=#{with_count}&with_expiration=#{with_expiration}", "//invites/:code", :get)).wait
         Invite.new(self, data, false)
       end
     end
@@ -272,8 +271,7 @@ module Discorb
     #
     # Fetch webhook from ID.
     # If application was cached, it will be used.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [Boolean] force Whether to force the fetch.
     #
@@ -283,7 +281,7 @@ module Discorb
       Async do
         next @application if @application && !force
 
-        _resp, data = http.get("/oauth2/applications/@me").wait
+        _resp, data = @http.request(Route.new("/oauth2/applications/@me", "//oauth2/applications/@me", :get)).wait
         @application = Application.new(self, data)
         @application
       end
@@ -291,14 +289,13 @@ module Discorb
 
     #
     # Fetch nitro sticker pack from ID.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @return [Async::Task<Array<Discorb::Sticker::Pack>>] The packs.
     #
     def fetch_nitro_sticker_packs
       Async do
-        _resp, data = http.get("/stickers-packs").wait
+        _resp, data = @http.request(Route.new("/stickers-packs", "//stickers-packs", :get)).wait
         data.map { |pack| Sticker::Pack.new(self, pack) }
       end
     end
@@ -334,12 +331,13 @@ module Discorb
 
     #
     # Method to wait for a event.
+    # @async
     #
     # @param [Symbol] event The name of the event.
     # @param [Integer] timeout The timeout in seconds.
     # @param [Proc] check The check to use.
     #
-    # @return [Object] The result of the event.
+    # @return [Async::Task<Object>] The result of the event.
     #
     # @raise [Discorb::TimeoutError] If the event didn't occur in time.
     #
@@ -416,7 +414,7 @@ module Discorb
     #
     # Starts the client.
     # @note This method behavior will change by CLI.
-    # @see file:docs/cli.md
+    # @see file:docs/cli.md CLI documentation
     #
     # @param [String, nil] token The token to use.
     #

data/lib/discorb/common.rb

@@ -4,7 +4,7 @@ module Discorb
   # @return [String] The API base URL.
   API_BASE_URL = "https://discord.com/api/v9"
   # @return [String] The version of discorb.
-  VERSION = "0.13.0"
+  VERSION = "0.13.4"
   # @return [String] The user agent for the bot.
   USER_AGENT = "DiscordBot (https://discorb-lib.github.io #{VERSION}) Ruby/#{RUBY_VERSION}"
 
@@ -117,6 +117,37 @@ module Discorb
     alias id to_s
   end
 
+  #
+  # Represents an endpoint.
+  # @private
+  #
+  class Route
+    attr_reader :url, :key, :method
+
+    def initialize(url, key, method)
+      @url = url
+      @key = key
+      @method = method
+    end
+
+    def hash
+      @url.hash
+    end
+
+    def identifier
+      "#{@method} #{@key}"
+    end
+
+    def major_param
+      param_type = @key.split("/").find { |k| k.start_with?(":") }
+      return "" unless param_type
+      param = url.gsub(API_BASE_URL, "").split("/")[@key.split("/").index(param_type) - 1]
+      %w[:channel_id :guild_id :webhook_id].include?(param_type) ? param : ""
+    end
+  end
+
+  # @return [Object] Object that represents nil.
+  #   This is used as a default value for optional parameters.
   Unset = Object.new
   class << Unset
     def method_missing(*)

data/lib/discorb/dictionary.rb

@@ -16,6 +16,7 @@ module Discorb
       @cache = hash.transform_keys(&:to_s)
       @limit = limit
       @sort = sort
+      @cache = @cache.sort_by(&@sort).to_h if @sort
     end
 
     #
@@ -39,7 +40,7 @@ module Discorb
     # @param [Discorb::Dictionary] other The dictionary to merge.
     #
     def merge(other)
-      @cache.merge!(other)
+      @cache.merge!(other.to_h)
     end
 
     #
@@ -73,6 +74,13 @@ module Discorb
       end
     end
 
+    #
+    # Convert the dictionary to a hash.
+    #
+    def to_h
+      @cache
+    end
+
     #
     # Returns the values of the dictionary.
     #
@@ -104,7 +112,7 @@ module Discorb
       end
     end
 
-    def respond_to_missing?(name, args, kwargs)
+    def respond_to_missing?(name, ...)
       if values.respond_to?(name)
         true
       else

data/lib/discorb/emoji.rb

@@ -82,8 +82,7 @@ module Discorb
 
     #
     # Edit the emoji.
-    # @macro async
-    # @macro http
+    # @async
     # @macro edit
     #
     # @param [String] name The new name of the emoji.
@@ -92,12 +91,12 @@ module Discorb
     #
     # @return [Async::Task<self>] The edited emoji.
     #
-    def edit(name: :unset, roles: :unset, reason: nil)
+    def edit(name: Discorb::Unset, roles: Discorb::Unset, reason: nil)
       Async do
         payload = {}
-        payload[:name] = name if name != :unset
-        payload[:roles] = roles.map { |r| Discorb::Utils.try(r, :id) } if roles != :unset
-        @client.http.patch("/guilds/#{@guild.id}/emojis/#{@id}", payload, audit_log_reason: reason)
+        payload[:name] = name if name != Discorb::Unset
+        payload[:roles] = roles.map { |r| Discorb::Utils.try(r, :id) } if roles != Discorb::Unset
+        @client.http.request(Route.new("/guilds/#{@guild.id}/emojis/#{@id}", "//guilds/:guild_id/emojis/:emoji_id", :patch), payload, audit_log_reason: reason)
         self
       end
     end
@@ -106,8 +105,7 @@ module Discorb
 
     #
     # Delete the emoji.
-    # @macro async
-    # @macro http
+    # @async
     #
     # @param [String] reason The reason for deleting the emoji.
     #
@@ -115,7 +113,7 @@ module Discorb
     #
     def delete!(reason: nil)
       Async do
-        @client.http.delete("/guilds/#{@guild.id}/emojis/#{@id}", audit_log_reason: reason).wait
+        @client.http.request(Route.new("/guilds/#{@guild.id}/emojis/#{@id}", "//guilds/:guild_id/emojis/:emoji_id", :delete), audit_log_reason: reason).wait
         @available = false
         self
       end