discordrb 1.8.1 → 2.0.0

data/lib/discordrb/errors.rb

@@ -1,14 +1,13 @@
+# frozen_string_literal: true
+
 module Discordrb
   # Custom errors raised in various places
   module Errors
     # Raised when authentication data is invalid or incorrect.
-    class InvalidAuthenticationError < RuntimeError; end
-
-    # Raised when a HTTP status code indicates a failure
-    class HTTPStatusError < RuntimeError
-      attr_reader :status
-      def initialize(status)
-        @status = status
+    class InvalidAuthenticationError < RuntimeError
+      # Default message for this exception
+      def message
+        'User login failed due to an invalid email or password!'
       end
     end
 

data/lib/discordrb/events/await.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'discordrb/events/generic'
 require 'discordrb/await'
 

data/lib/discordrb/events/bans.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'discordrb/events/generic'
 
 module Discordrb::Events
@@ -30,7 +32,7 @@ module Discordrb::Events
           elsif a.is_a? Integer
             a == e.id
           elsif a == :bot
-            e.bot?
+            e.current_bot?
           else
             a == e
           end

data/lib/discordrb/events/channels.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+require 'discordrb/events/generic'
+require 'discordrb/data'
+
+module Discordrb::Events
+  # Raised when a channel is created
+  class ChannelCreateEvent < Event
+    # @return [Channel] the channel in question.
+    attr_reader :channel
+
+    # @!attribute [r] type
+    #   @return [String] the channel's type.
+    #   @see Channel#type
+    # @!attribute [r] topic
+    #   @return [String] the channel's topic.
+    #   @see Channel#topic
+    # @!attribute [r] position
+    #   @return [Integer] the position of the channel in the channels list.
+    #   @see Channel#position
+    # @!attribute [r] name
+    #   @return [String] the channel's name
+    #   @see Channel#name
+    # @!attribute [r] id
+    #   @return [Integer] the channel's unique ID.
+    #   @see Channel#id
+    # @!attribute [r] server
+    #   @return [Server] the server the channel belongs to.
+    #   @see Channel#server
+    delegate :type, :topic, :position, :name, :id, :server, to: :channel
+
+    def initialize(data, bot)
+      @bot = bot
+      @channel = bot.channel(data['id'].to_i)
+    end
+  end
+
+  # Event handler for ChannelCreateEvent
+  class ChannelCreateEventHandler < EventHandler
+    def matches?(event)
+      # Check for the proper event type
+      return false unless event.is_a? ChannelCreateEvent
+
+      [
+        matches_all(@attributes[:type], event.type) do |a, e|
+          a == if a.is_a? String
+                 e.name
+               else
+                 e
+               end
+        end,
+        matches_all(@attributes[:name], event.name) do |a, e|
+          a == if a.is_a? String
+                 e.to_s
+               else
+                 e
+               end
+        end
+      ].reduce(true, &:&)
+    end
+  end
+
+  # Raised when a channel is deleted
+  class ChannelDeleteEvent < Event
+    # @return [String] the channel's type (text or voice)
+    attr_reader :type
+
+    # @return [String] the channel's topic
+    attr_reader :topic
+
+    # @return [Integer] the position of the channel on the list
+    attr_reader :position
+
+    # @return [String] the channel's name
+    attr_reader :name
+
+    # @return [Integer] the channel's ID
+    attr_reader :id
+
+    # @return [Server] the channel's server
+    attr_reader :server
+
+    def initialize(data, bot)
+      @type = data['type']
+      @topic = data['topic']
+      @position = data['position']
+      @name = data['name']
+      @is_private = data['is_private']
+      @id = data['id'].to_i
+      @server = bot.server(data['guild_id'].to_i) if data['guild_id']
+    end
+  end
+
+  # Event handler for ChannelDeleteEvent
+  class ChannelDeleteEventHandler < EventHandler
+    def matches?(event)
+      # Check for the proper event type
+      return false unless event.is_a? ChannelDeleteEvent
+
+      [
+        matches_all(@attributes[:type], event.type) do |a, e|
+          a == if a.is_a? String
+                 e.name
+               else
+                 e
+               end
+        end,
+        matches_all(@attributes[:name], event.name) do |a, e|
+          a == if a.is_a? String
+                 e.to_s
+               else
+                 e
+               end
+        end
+      ].reduce(true, &:&)
+    end
+  end
+
+  # Raised when a channel is updated (e.g. topic changes)
+  class ChannelUpdateEvent < ChannelCreateEvent; end
+
+  # Event handler for ChannelUpdateEvent
+  class ChannelUpdateEventHandler < ChannelCreateEventHandler; end
+end

data/lib/discordrb/events/generic.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/core_ext/module'
 
 # Events used by discordrb

data/lib/discordrb/events/guilds.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 require 'discordrb/events/generic'
 require 'discordrb/data'
 
 module Discordrb::Events
   # Generic subclass for server events (create/update/delete)
-  class GuildEvent < Event
+  class ServerEvent < Event
+    # @return [Server] the server in question.
     attr_reader :server
 
     def initialize(data, bot)
@@ -11,17 +14,17 @@ module Discordrb::Events
     end
 
     # Initializes this event with server data. Should be overwritten in case the server doesn't exist at the time
-    # of event creation (e. g. {GuildDeleteEvent})
+    # of event creation (e. g. {ServerDeleteEvent})
     def init_server(data, bot)
       @server = bot.server(data['id'].to_i)
     end
   end
 
   # Generic event handler for member events
-  class GuildEventHandler < EventHandler
+  class ServerEventHandler < EventHandler
     def matches?(event)
       # Check for the proper event type
-      return false unless event.is_a? GuildEvent
+      return false unless event.is_a? ServerEvent
 
       [
         matches_all(@attributes[:server], event.server) do |a, e|
@@ -39,27 +42,27 @@ module Discordrb::Events
 
   # Server is created
   # @see Discordrb::EventContainer#server_create
-  class GuildCreateEvent < GuildEvent; end
+  class ServerCreateEvent < ServerEvent; end
 
-  # Event handler for {GuildCreateEvent}
-  class GuildCreateEventHandler < GuildEventHandler; end
+  # Event handler for {ServerCreateEvent}
+  class ServerCreateEventHandler < ServerEventHandler; end
 
   # Server is updated (e.g. name changed)
   # @see Discordrb::EventContainer#server_update
-  class GuildUpdateEvent < GuildEvent; end
+  class ServerUpdateEvent < ServerEvent; end
 
-  # Event handler for {GuildUpdateEvent}
-  class GuildUpdateEventHandler < GuildEventHandler; end
+  # Event handler for {ServerUpdateEvent}
+  class ServerUpdateEventHandler < ServerEventHandler; end
 
   # Server is deleted
   # @see Discordrb::EventContainer#server_delete
-  class GuildDeleteEvent < GuildEvent
+  class ServerDeleteEvent < ServerEvent
     # Overide init_server to account for the deleted server
     def init_server(data, bot)
       @server = Discordrb::Server.new(data, bot)
     end
   end
 
-  # Event handler for {GuildDeleteEvent}
-  class GuildDeleteEventHandler < GuildEventHandler; end
+  # Event handler for {ServerDeleteEvent}
+  class ServerDeleteEventHandler < ServerEventHandler; end
 end

data/lib/discordrb/events/lifetime.rb

@@ -1,14 +1,24 @@
+# frozen_string_literal: true
+
 require 'discordrb/events/generic'
 
 module Discordrb::Events
+  # Common superclass for all lifetime events
+  class LifetimeEvent < Event
+    # @!visibility private
+    def initialize(bot)
+      @bot = bot
+    end
+  end
+
   # @see Discordrb::EventContainer#ready
-  class ReadyEvent < Event; end
+  class ReadyEvent < LifetimeEvent; end
 
   # Event handler for {ReadyEvent}
   class ReadyEventHandler < TrueEventHandler; end
 
   # @see Discordrb::EventContainer#disconnected
-  class DisconnectEvent < Event; end
+  class DisconnectEvent < LifetimeEvent; end
 
   # Event handler for {DisconnectEvent}
   class DisconnectEventHandler < TrueEventHandler; end

data/lib/discordrb/events/members.rb

@@ -1,10 +1,21 @@
+# frozen_string_literal: true
+
 require 'discordrb/events/generic'
 require 'discordrb/data'
 
 module Discordrb::Events
   # Generic subclass for server member events (add/update/delete)
-  class GuildMemberEvent < Event
-    attr_reader :user, :roles, :server
+  class ServerMemberEvent < Event
+    # @return [Member] the member in question.
+    attr_reader :user
+
+    # @return [Array<Role>] the member's roles.
+    attr_reader :roles
+
+    # @return [Server] the server on which the event happened.
+    attr_reader :server
+
+    alias_method :member, :user
 
     def initialize(data, bot)
       @server = bot.server(data['guild_id'].to_i)
@@ -18,7 +29,7 @@ module Discordrb::Events
 
     def init_user(data, _)
       user_id = data['user']['id'].to_i
-      @user = @server.members.find { |u| u.id == user_id }
+      @user = @server.member(user_id)
     end
 
     def init_roles(data, _)
@@ -32,10 +43,10 @@ module Discordrb::Events
   end
 
   # Generic event handler for member events
-  class GuildMemberEventHandler < EventHandler
+  class ServerMemberEventHandler < EventHandler
     def matches?(event)
       # Check for the proper event type
-      return false unless event.is_a? GuildMemberEvent
+      return false unless event.is_a? ServerMemberEvent
 
       [
         matches_all(@attributes[:username], event.user.name) do |a, e|
@@ -51,27 +62,27 @@ module Discordrb::Events
 
   # Member joins
   # @see Discordrb::EventContainer#member_join
-  class GuildMemberAddEvent < GuildMemberEvent; end
+  class ServerMemberAddEvent < ServerMemberEvent; end
 
-  # Event handler for {GuildMemberAddEvent}
-  class GuildMemberAddEventHandler < GuildMemberEventHandler; end
+  # Event handler for {ServerMemberAddEvent}
+  class ServerMemberAddEventHandler < ServerMemberEventHandler; end
 
-  # Member is updated (e.g. name changed)
+  # Member is updated (roles added or deleted)
   # @see Discordrb::EventContainer#member_update
-  class GuildMemberUpdateEvent < GuildMemberEvent; end
+  class ServerMemberUpdateEvent < ServerMemberEvent; end
 
-  # Event handler for {GuildMemberUpdateEvent}
-  class GuildMemberUpdateEventHandler < GuildMemberEventHandler; end
+  # Event handler for {ServerMemberUpdateEvent}
+  class ServerMemberUpdateEventHandler < ServerMemberEventHandler; end
 
   # Member leaves
   # @see Discordrb::EventContainer#member_leave
-  class GuildMemberDeleteEvent < GuildMemberEvent
+  class ServerMemberDeleteEvent < ServerMemberEvent
     # Overide init_user to account for the deleted user on the server
     def init_user(data, bot)
       @user = Discordrb::User.new(data['user'], bot)
     end
   end
 
-  # Event handler for {GuildMemberDeleteEvent}
-  class GuildMemberDeleteEventHandler < GuildMemberEventHandler; end
+  # Event handler for {ServerMemberDeleteEvent}
+  class ServerMemberDeleteEventHandler < ServerMemberEventHandler; end
 end

data/lib/discordrb/events/message.rb

@@ -1,9 +1,15 @@
+# frozen_string_literal: true
+
 require 'discordrb/events/generic'
 
 module Discordrb::Events
   # Event raised when a text message is sent to a channel
   class MessageEvent < Event
-    attr_reader :message, :saved_message
+    # @return [Message] the message which triggered this event.
+    attr_reader :message
+
+    # @return [String] the message that has been saved by calls to {#<<} and will be sent to Discord upon completion.
+    attr_reader :saved_message
 
     # @!attribute [r] author
     #   @return [User] who sent this message.
@@ -40,7 +46,13 @@ module Discordrb::Events
 
     # @return [true, false] whether or not this message was sent by the bot itself
     def from_bot?
-      @message.user.id == @bot.bot_user.id
+      @message.user.id == @bot.profile.id
+    end
+
+    # Utility method to get the voice bot for the current server
+    # @return [VoiceBot, nil] the voice bot connected to this message's server, or nil if there is none connected
+    def voice
+      @bot.voice(@message.channel.server.id)
     end
 
     # Adds a string to be sent after the event has finished execution. Avoids problems with rate limiting because only
@@ -102,16 +114,17 @@ module Discordrb::Events
           elsif a.is_a? Fixnum
             a == e.id
           elsif a == :bot
-            e.bot?
+            e.current_bot?
           else
             a == e
           end
         end,
-        matches_all(@attributes[:with_text] || @attributes[:content], event.content) do |a, e|
+        matches_all(@attributes[:with_text] || @attributes[:content] || @attributes[:exact_text], event.content) do |a, e|
           if a.is_a? String
             e == a
           elsif a.is_a? Regexp
-            a.match(e) ? (e == (a.match(e)[0])) : false
+            match = a.match(e)
+            match ? (e == match[0]) : false
           end
         end,
         matches_all(@attributes[:after], event.timestamp) { |a, e| a > e },
@@ -180,10 +193,10 @@ module Discordrb::Events
 
   # Raised when a message is edited
   # @see Discordrb::EventContainer#message_edit
-  class MessageEditEvent < MessageIDEvent; end
+  class MessageEditEvent < MessageEvent; end
 
   # Event handler for {MessageEditEvent}
-  class MessageEditEventHandler < MessageIDEventHandler; end
+  class MessageEditEventHandler < MessageEventHandler; end
 
   # Raised when a message is deleted
   # @see Discordrb::EventContainer#message_delete

data/lib/discordrb/events/presence.rb

@@ -1,10 +1,19 @@
+# frozen_string_literal: true
+
 require 'discordrb/events/generic'
 require 'discordrb/data'
 
 module Discordrb::Events
   # Event raised when a user's presence state updates (idle or online)
   class PresenceEvent < Event
-    attr_reader :server, :user, :status
+    # @return [Server] the server on which the presence update happened.
+    attr_reader :server
+
+    # @return [User] the user whose status got updated.
+    attr_reader :user
+
+    # @return [String] the new status.
+    attr_reader :status
 
     def initialize(data, bot)
       @user = bot.user(data['user']['id'].to_i)
@@ -42,7 +51,14 @@ module Discordrb::Events
 
   # Event raised when a user starts or stops playing a game
   class PlayingEvent < Event
-    attr_reader :server, :user, :game
+    # @return [Server] the server on which the presence update happened.
+    attr_reader :server
+
+    # @return [User] the user whose status got updated.
+    attr_reader :user
+
+    # @return [String] the new game the user is playing.
+    attr_reader :game
 
     def initialize(data, bot)
       @user = bot.user(data['user']['id'].to_i)