discordrb 1.3.4 → 1.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 66f79878220c4bf42ad27bc01ab409d6613670be
-  data.tar.gz: 4bd26ca3ca4739a855344b3d0d867f8d616958ad
+  metadata.gz: 53406fbf27f1a8d7537644738f10b13967bd606b
+  data.tar.gz: 19cb23917078868028f4e02cc74d7f7ac6a4aa97
 SHA512:
-  metadata.gz: 6e83dde0d98d3cb8ad65d64964c5731d97b526fc89865f25a0c57fa2c9bf0cd6d936b28fd81b39e74156a64e602253476479a588f9ff92a76eb39cf9c1d1e756
-  data.tar.gz: 174fd8785f53d910b88b6146b3ae657e83bed445163de278f9be0f3a848d9097206835e82da5f18f8051ab5c2676bbeba42dae48e58cc480d83d5368072cdf46
+  metadata.gz: e2f4c1621d4ecde3d6b7a67a003febc31944b5592060d24a2c9e47ae98cd53b8a882d6661cc9a0e91949bd9b18838d2fde5891876d37367b8f7c54516c888a1d
+  data.tar.gz: 71e2d4c6fd71a900ef779e4a647e226fdcc7ef42f1198eb65e4d9bfddcf450af2cc93855965875fa49413ebe715d661446e585847a96e28ab29d430dccba0227

data/.rubocop.yml

@@ -0,0 +1,44 @@
+# Disable all metrics.
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+# Prefer compact module/class defs
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+# Allow CamelCase constants as well as SCREAMING_SNAKE_CASE
+Style/ConstantName:
+  Enabled: false
+
+# Allow 'Pokémon-style' exception handling
+Lint/RescueException:
+  Enabled: false
+
+# Exclude the list of games
+AllCops:
+  Exclude:
+    - '**/games_list.rb'

data/lib/discordrb.rb

@@ -1,7 +1,8 @@
-require "discordrb/version"
-require "discordrb/bot"
-require "discordrb/commands/command-bot"
+require 'discordrb/version'
+require 'discordrb/bot'
+require 'discordrb/commands/command-bot'
 
+# All discordrb functionality, to be extended by other files
 module Discordrb
   # Your code goes here...
 end

data/lib/discordrb/api.rb

@@ -1,8 +1,10 @@
 require 'rest-client'
 require 'json'
 
+# List of methods representing endpoints in Discord's API
 module Discordrb::API
   APIBASE = 'https://discordapp.com/api'
+
   module_function
 
   # Ban a user from a server and delete their messages from the last message_days days
@@ -170,7 +172,7 @@ module Discordrb::API
   def send_file(token, channel_id, file)
     RestClient.post(
       "#{APIBASE}/channels/#{channel_id}/messages",
-      {:file => file},
+      { file: file },
       Authorization: token
     )
   end
@@ -187,7 +189,7 @@ module Discordrb::API
   # Permissions are the Discord defaults; allowed: invite creation, reading/sending messages,
   # sending TTS messages, embedding links, sending files, reading the history, mentioning everybody,
   # connecting to voice, speaking and voice activity (push-to-talk isn't mandatory)
-  def update_role(token, server_id, role_id, name, colour, hoist = false, packed_permissions = 36953089)
+  def update_role(token, server_id, role_id, name, colour, hoist = false, packed_permissions = 36_953_089)
     RestClient.patch(
       "#{APIBASE}/guilds/#{server_id}/roles/#{role_id}",
       { 'color' => colour, 'name' => name, 'hoist' => hoist, 'permissions' => packed_permissions }.to_json,
@@ -275,5 +277,4 @@ module Discordrb::API
       Authorization: token
     )
   end
-
 end

data/lib/discordrb/bot.rb

@@ -21,6 +21,7 @@ require 'discordrb/exceptions'
 require 'discordrb/data'
 
 module Discordrb
+  # Represents a Discord bot, including servers, users, etc.
   class Bot
     include Discordrb::Events
 
@@ -28,8 +29,8 @@ module Discordrb
 
     def initialize(email, password, debug = false)
       # Make sure people replace the login details in the example files...
-      if email.end_with? "example.com"
-        puts "You have to replace the login details in the example files with your own!"
+      if email.end_with? 'example.com'
+        puts 'You have to replace the login details in the example files with your own!'
         exit
       end
 
@@ -46,23 +47,42 @@ module Discordrb
       @users = {}
     end
 
-    def run
+    def run(async = false)
+      run_async
+      return if async
+
+      debug('Oh wait! Not exiting yet as run was run synchronously.')
+      loop {}
+    end
+
+    def run_async
       # Handle heartbeats
       @heartbeat_interval = 1
       @heartbeat_active = false
       @heartbeat_thread = Thread.new do
-        while true do
+        loop do
           sleep @heartbeat_interval
           send_heartbeat if @heartbeat_active
         end
       end
 
-      while true do
-        websocket_connect
-        debug("Disconnected! Attempting to reconnect in 5 seconds.")
-        sleep 5
-        @token = login
+      @ws_thread = Thread.new do
+        loop do
+          websocket_connect
+          debug('Disconnected! Attempting to reconnect in 5 seconds.')
+          sleep 5
+          @token = login
+        end
       end
+
+      debug('WS thread created! Now waiting for confirmation that everything worked')
+      @ws_success = false
+      sleep(0.5) until @ws_success
+      debug('Confirmation received! Exiting run.')
+    end
+
+    def sync
+      @ws_thread.join
     end
 
     def channel(id)
@@ -78,17 +98,13 @@ module Discordrb
       debug("Creating private channel with user id #{id}")
       return @private_channels[id] if @private_channels[id]
 
-      data = {
-        'recipient_id' => id
-      }
-
       response = API.create_private(@token, @bot_user.id, id)
       channel = Channel.new(JSON.parse(response), self)
       @private_channels[id] = channel
     end
 
     def join(invite)
-      invite = invite[invite.rindex('/')+1..-1] if invite.start_with?('http') || invite.start_with?('discord.gg')
+      invite = invite[invite.rindex('/') + 1..-1] if invite.start_with?('http') || invite.start_with?('discord.gg')
       resolved = JSON.parse(API.resolve_invite(@token, invite))['code']
       API.join_server(@token, resolved)
     end
@@ -103,10 +119,6 @@ module Discordrb
 
     def send_message(channel_id, content)
       debug("Sending message to #{channel_id} with content '#{content}'")
-      data = {
-        'content' => content.to_s,
-        'mentions' => []
-      }
       response = API.send_message(@token, channel_id, content)
       Message.new(JSON.parse(response), self)
     end
@@ -123,7 +135,7 @@ module Discordrb
         'op' => 3,
         'd' => {
           'idle_since' => nil,
-          'game_id' => game ? game.id : 60  # 60 blanks out the game playing
+          'game_id' => game ? game.id : 60 # 60 blanks out the game playing
         }
       }
 
@@ -131,9 +143,7 @@ module Discordrb
       game
     end
 
-    def debug=(debug)
-      @debug = debug
-    end
+    attr_writer :debug
 
     def message(attributes = {}, &block)
       register_event(MessageEvent, attributes, block)
@@ -207,7 +217,7 @@ module Discordrb
     end
 
     def debug(message, important = false)
-      puts "[DEBUG @ #{Time.now.to_s}] #{message}" if @debug || important
+      puts "[DEBUG @ #{Time.now}] #{message}" if @debug || important
     end
 
     alias_method :<<, :add_handler
@@ -219,22 +229,23 @@ module Discordrb
       user_id = data['user']['id'].to_i
       server_id = data['guild_id'].to_i
       server = @servers[server_id]
-      return if !server
+      return unless server
 
       user = @users[user_id]
-      if !user
+      unless user
         user = User.new(data['user'], self)
         @users[user_id] = user
       end
 
       status = data['status'].to_sym
       if status != :offline
-        if !(server.members.find {|u| u.id == user.id })
+        unless server.members.find { |u| u.id == user.id }
           server.members << user
         end
       end
       user.status = status
       user.game = Discordrb::Games.find_game(data['game_id'])
+      user
     end
 
     # Internal handler for VOICE_STATUS_UPDATE
@@ -242,7 +253,7 @@ module Discordrb
       user_id = data['user_id'].to_i
       server_id = data['guild_id'].to_i
       server = @servers[server_id]
-      return if !server
+      return unless server
 
       user = @users[user_id]
       user.server_mute = data['mute']
@@ -252,9 +263,7 @@ module Discordrb
 
       channel_id = data['channel_id']
       channel = nil
-      if channel_id
-        channel = @channels[channel_id.to_i]
-      end
+      channel = @channels[channel_id.to_i] if channel_id
       user.move(channel)
     end
 
@@ -269,9 +278,8 @@ module Discordrb
     # Internal handler for CHANNEL_UPDATE
     def update_channel(data)
       channel = Channel.new(data, self)
-      server = channel.server
       old_channel = @channels[channel.id]
-      return if !old_channel
+      return unless old_channel
       old_channel.update_from(channel)
     end
 
@@ -280,7 +288,7 @@ module Discordrb
       channel = Channel.new(data, self)
       server = channel.server
       @channels[channel.id] = nil
-      server.channels.reject! {|c| c.id == channel.id}
+      server.channels.reject! { |c| c.id == channel.id }
     end
 
     # Internal handler for GUILD_MEMBER_UPDATE
@@ -291,7 +299,7 @@ module Discordrb
       roles = []
       data['roles'].each do |element|
         role_id = element.to_i
-        roles << server.roles.find {|r| r.id == role_id}
+        roles << server.roles.find { |r| r.id == role_id }
       end
       user_id = user_data['id'].to_i
       user = @users[user_id]
@@ -305,7 +313,7 @@ module Discordrb
       server = @servers[server_id]
       new_role = Role.new(role_data, self, server)
       role_id = role_data['id'].to_i
-      old_role = server.roles.find {|r| r.id == role_id}
+      old_role = server.roles.find { |r| r.id == role_id }
       old_role.update_from(new_role)
     end
 
@@ -334,22 +342,22 @@ module Discordrb
     def start_typing(data); end
 
     def login
-      debug("Logging in")
-      login_attempts = login_attempts || 0
+      debug('Logging in')
+      login_attempts ||= 0
 
       # Login
       login_response = API.login(@email, @password)
-      raise HTTPStatusException.new(login_response.code) if login_response.code >= 400
+      fail HTTPStatusException, login_response.code if login_response.code >= 400
 
       # Parse response
       login_response_object = JSON.parse(login_response)
-      raise InvalidAuthenticationException unless login_response_object['token']
+      fail InvalidAuthenticationException unless login_response_object['token']
 
       debug("Received token: #{login_response_object['token']}")
       login_response_object['token']
     rescue Exception => e
       response_code = login_response.nil? ? 0 : login_response.code ######## mackmm145
-      if login_attempts < 100 && (e.inspect.include?("No such host is known.") || response_code == 523)
+      if login_attempts < 100 && (e.inspect.include?('No such host is known.') || response_code == 523)
         debug("Login failed! Reattempting in 5 seconds. #{100 - login_attempts} attempts remaining.")
         debug("Error was: #{e.inspect}")
         sleep 5
@@ -360,44 +368,46 @@ module Discordrb
 
         # Apparently we get a 400 if the password or username is incorrect. In that case, tell the user
         debug("Are you sure you're using the correct username and password?") if e.class == RestClient::BadRequest
-        raise $!
+        raise $ERROR_INFO
       end
     end
 
-    def get_gateway
+    def find_gateway
       # Get updated websocket_hub
       response = API.gateway(@token)
-      JSON.parse(response)["url"]
+      JSON.parse(response)['url']
     end
 
     def websocket_connect
-      debug("Attempting to get gateway URL...")
-      websocket_hub = get_gateway
+      debug('Attempting to get gateway URL...')
+      websocket_hub = find_gateway
       debug("Success! Gateway URL is #{websocket_hub}.")
-      debug("Now running bot")
+      debug('Now running bot')
 
-      EM.run {
+      EM.run do
         @ws = Faye::WebSocket::Client.new(websocket_hub)
 
-        @ws.on :open do |event|; websocket_open(event); end
-        @ws.on :message do |event|; websocket_message(event); end
-        @ws.on :error do |event|; debug(event.message); end
-        @ws.on :close do |event|; websocket_close(event); @ws = nil; end
-      }
+        @ws.on(:open) { |event| websocket_open(event) }
+        @ws.on(:message) { |event| websocket_message(event) }
+        @ws.on(:error) { |event| debug(event.message) }
+        @ws.on :close do |event|
+          websocket_close(event)
+          @ws = nil
+        end
+      end
     end
 
     def websocket_message(event)
-      begin
       debug("Received packet #{event.data}")
 
       # Parse packet
       packet = JSON.parse(event.data)
 
-      raise "Invalid Packet" unless packet['op'] == 0   # TODO
+      fail 'Invalid Packet' unless packet['op'] == 0 # TODO
 
       data = packet['d']
       case packet['t']
-      when "READY"
+      when 'READY'
         # Activate the heartbeats
         @heartbeat_interval = data['heartbeat_interval'].to_f / 1000.0
         @heartbeat_active = true
@@ -412,12 +422,12 @@ module Discordrb
           @servers[server.id] = server
 
           # Initialize users
-          server.members.each do |element|
-            unless @users[element.id]
-              @users[element.id] = element
-            else
+          server.members.each do |member|
+            if @users[member.id]
               # If the user is already cached, just add the new roles
-              @users[element.id].merge_roles(server, element.roles[server.id])
+              @users[member.id].merge_roles(server, member.roles[server.id])
+            else
+              @users[member.id] = member
             end
           end
 
@@ -435,7 +445,10 @@ module Discordrb
 
         # Make sure to raise the event
         raise_event(ReadyEvent.new)
-      when "MESSAGE_CREATE"
+
+        # Tell the run method that everything was successful
+        @ws_success = true
+      when 'MESSAGE_CREATE'
         create_message(data)
 
         message = Message.new(data, self)
@@ -446,84 +459,83 @@ module Discordrb
           event = MentionEvent.new(message, self)
           raise_event(event)
         end
-      when "TYPING_START"
+      when 'TYPING_START'
         start_typing(data)
 
         event = TypingEvent.new(data, self)
         raise_event(event)
-      when "PRESENCE_UPDATE"
+      when 'PRESENCE_UPDATE'
         update_presence(data)
 
         event = PresenceEvent.new(data, self)
         raise_event(event)
-      when "VOICE_STATE_UPDATE"
+      when 'VOICE_STATE_UPDATE'
         update_voice_state(data)
 
         event = VoiceStateUpdateEvent.new(data, self)
         raise_event(event)
-      when "CHANNEL_CREATE"
+      when 'CHANNEL_CREATE'
         create_channel(data)
 
         event = ChannelCreateEvent.new(data, self)
         raise_event(event)
-      when "CHANNEL_UPDATE"
+      when 'CHANNEL_UPDATE'
         update_channel(data)
 
         event = ChannelUpdateEvent.new(data, self)
         raise_event(event)
-      when "CHANNEL_DELETE"
+      when 'CHANNEL_DELETE'
         delete_channel(data)
 
         event = ChannelDeleteEvent.new(data, self)
         raise_event(event)
-      when "GUILD_MEMBER_UPDATE"
+      when 'GUILD_MEMBER_UPDATE'
         update_guild_member(data)
 
         event = GuildMemberUpdateEvent.new(data, self)
         raise_event(event)
-      when "GUILD_ROLE_UPDATE"
+      when 'GUILD_ROLE_UPDATE'
         update_guild_role(data)
 
         event = GuildRoleUpdateEvent.new(data, self)
         raise_event(event)
-      when "GUILD_ROLE_CREATE"
+      when 'GUILD_ROLE_CREATE'
         create_guild_role(data)
 
         event = GuildRoleCreateEvent.new(data, self)
         raise_event(event)
-      when "GUILD_ROLE_DELETE"
+      when 'GUILD_ROLE_DELETE'
         delete_guild_role(data)
 
         event = GuildRoleDeleteEvent.new(data, self)
         raise_event(event)
       end
-      rescue Exception => e
-        debug("Exception: #{e.inspect}", true)
-        e.backtrace.each {|line| debug(line) }
-      end
+    rescue Exception => e
+      debug("Exception: #{e.inspect}", true)
+      e.backtrace.each { |line| debug(line) }
     end
 
     def websocket_close(event)
-      debug("Disconnected from WebSocket!")
+      debug('Disconnected from WebSocket!')
       debug(" (Reason: #{event.reason})")
       debug(" (Code: #{event.code})")
       raise_event(DisconnectEvent.new)
       EM.stop
     end
 
-    def websocket_open(event)
+    def websocket_open(_)
       # Send the initial packet
       packet = {
-        "op" => 2,    # Packet identifier
-        "d" => {      # Packet data
-          "v" => 2,   # Another identifier
-          "token" => @token,
-          "properties" => {   # I'm unsure what these values are for exactly, but they don't appear to impact bot functionality in any way.
-            "$os" => "#{RUBY_PLATFORM}",
-            "$browser" => "discordrb",
-            "$device" => "discordrb",
-            "$referrer" => "",
-            "$referring_domain" => ""
+        'op' => 2,    # Packet identifier
+        'd' => {      # Packet data
+          'v' => 2,   # Another identifier
+          'token' => @token,
+          'properties' => { # I'm unsure what these values are for exactly, but they don't appear to impact bot functionality in any way.
+            '$os' => "#{RUBY_PLATFORM}",
+            '$browser' => 'discordrb',
+            '$device' => 'discordrb',
+            '$referrer' => '',
+            '$referring_domain' => ''
           }
         }
       }
@@ -550,7 +562,7 @@ module Discordrb
     end
 
     def send_heartbeat
-      millis = Time.now.strftime("%s%L").to_i
+      millis = Time.now.strftime('%s%L').to_i
       debug("Sending heartbeat at #{millis}")
       data = {
         'op' => 1,
@@ -568,13 +580,13 @@ module Discordrb
 
     def event_class(handler_class)
       class_name = handler_class.to_s
-      return nil unless class_name.end_with? "Handler"
+      return nil unless class_name.end_with? 'Handler'
 
       class_from_string(class_name[0..-8])
     end
 
     def handler_class(event_class)
-      class_from_string(event_class.to_s + "Handler")
+      class_from_string(event_class.to_s + 'Handler')
     end
   end
 end