discordrb 1.7.5 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d661448f2825e14545bff5ef277d349bdc9fe944
-  data.tar.gz: f4c846fde0f3248e6c6d3be8d69b4dabfdd6f098
+  metadata.gz: 79ffeb9b74702dcf9a25f0e92fcc0c06b0af8eb9
+  data.tar.gz: bf9eca745cecae8bd9078f3fbd27aeab1ae7d0e9
 SHA512:
-  metadata.gz: 49aaa4b14e1da63c24fa1dcb03500b3926c71781e6cbd20e5cd7af296b060dd01082baa6dceaa9630ac55520b316c0fd98d1027df34c6b1e5996303117193196
-  data.tar.gz: 9a8d93545ce59f3334fa785ffaa85fd47f511ace03175045614a69441735da09fffe7305b4b6dfe95316d7e1fc2b0c8407a1fc381596d9882ab52b681311e74e
+  metadata.gz: 5cb906cf412f9e5147bbf0196d9b15c0bafbc00fad70c17e9606404770bad93b0a0eca0beb0da2f67b85ec6a4b5c643cc6ba654193404df4abaf103c0ab2b4ba
+  data.tar.gz: 187edc158381c52b3778f3d364fb399eba254963efcc28380e37371f67225d001543274331aec48138348e100a31abfe4d02e264a99cd71d901595467d9e0fbb

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 1.8.0
+* The built-in logger has been somewhat redone.
+  * It now has a fancy mode, settable using `Discordrb::LOGGER.fancy = true/false`, that makes use of ANSI escape codes to prettify the log output.
+  * It now supports more things than just `debug`, there's also `warn`, `error`, `good`, `info`, `in`, and `out`.
+  * You now have finer control over what gets output, using `Discordrb::LOGGER.mode=` which accepts one of `:debug`, `:verbose`, `:normal`, `:quiet`, `:silent`.
+* You can now log in with just a token by setting the email parameter to `:token` and the password to the token you want to log in with.
+* DCA playback now supports `DCA1`.
+* All data classes (now generalized using the `IDObject` mixin) have a `creation_date` parameter that specifies when the object was created.
+* `Channel#mention` was added that mentions a channel analogous to `User#mention`.
+* The aliases `tag` and `discord_tag` have been added to the discriminator because that's what Discord calls them now.
+
+### Bugfixes
+* A problem some users had where voice playback would leak FFmpeg processes has been fixed.
+* The VWS internal thread now has a name in debug messages (`vws-i`)
+* Users' voice channels should now always be set if they are in one
+
 ## 1.7.5
 * `Channel#send_message` and `Bot#send_message` now have an extra `tts` parameter (false by default) to specify whether the message should use TTS.
 

data/lib/discordrb.rb

@@ -8,7 +8,7 @@ module Discordrb
   Thread.current[:discordrb_name] = 'main'
 
   # The default debug logger used by discordrb.
-  LOGGER = Logger.new
+  LOGGER = Logger.new(ENV['DISCORDRB_FANCY_LOG'])
 end
 
 # In discordrb, Integer and {String} are monkey-patched to allow for easy resolution of IDs

data/lib/discordrb/bot.rb

@@ -70,7 +70,7 @@ module Discordrb
     # @param debug [Boolean] Whether or not the bug should run in debug mode, which gives increased console output.
     def initialize(email, password, debug = false)
       # Make sure people replace the login details in the example files...
-      if email.end_with? 'example.com'
+      if email.is_a?(String) && email.end_with?('example.com')
         puts 'You have to replace the login details in the example files with your own!'
         exit
       end
@@ -373,6 +373,8 @@ module Discordrb
     #   * `:frankfurt`
     #   * `:us-east`
     #   * `:us-west`
+    #   * `:us-south`
+    #   * `:us-central`
     #   * `:singapore`
     #   * `:sydney`
     # @return [Server] The server that was created.
@@ -437,6 +439,12 @@ module Discordrb
       LOGGER.debug = new_debug
     end
 
+    # Sets the logging mode
+    # @see Logger#mode=
+    def mode=(new_mode)
+      LOGGER.mode = new_mode
+    end
+
     # Prevents the READY packet from being printed regardless of debug mode.
     def suppress_ready_debug
       @prevent_ready = true
@@ -457,8 +465,8 @@ module Discordrb
     end
 
     # @see Logger#debug
-    def debug(message, important = false)
-      LOGGER.debug(message, important)
+    def debug(message)
+      LOGGER.debug(message)
     end
 
     # @see Logger#log_exception
@@ -547,7 +555,7 @@ module Discordrb
 
       channel_id = data['channel_id']
       channel = nil
-      channel = @channels[channel_id.to_i] if channel_id
+      channel = self.channel(channel_id.to_i) if channel_id
       user.move(channel)
 
       @session_id = data['session_id']
@@ -719,6 +727,13 @@ module Discordrb
     ########  #######   ######   #### ##    ##
 
     def login
+      if @email == :token
+        debug('Logging in using static token')
+
+        # The password is the token!
+        return @password
+      end
+
       debug('Logging in')
       login_attempts ||= 0
 
@@ -803,7 +818,7 @@ module Discordrb
       elsif @prevent_ready && packet['t'] == 'GUILD_MEMBERS_CHUNK'
         # Ignore chunks as they will be handled later anyway
       else
-        debug("Received packet #{event.data}")
+        LOGGER.in(event.data.to_s)
       end
 
       raise 'Invalid Packet' unless packet['op'] == 0 # TODO
@@ -851,6 +866,8 @@ module Discordrb
         }.to_json
         @ws.send(chunk_packet)
 
+        LOGGER.good 'Ready'
+
         # Tell the run method that everything was successful
         @ws_success = true
       when :GUILD_MEMBERS_CHUNK
@@ -1008,9 +1025,9 @@ module Discordrb
     end
 
     def websocket_close(event)
-      debug('Disconnected from WebSocket!')
-      debug(" (Reason: #{event.reason})")
-      debug(" (Code: #{event.code})")
+      LOGGER.error('Disconnected from WebSocket!')
+      LOGGER.error(" (Reason: #{event.reason})")
+      LOGGER.error(" (Code: #{event.code})")
       raise_event(DisconnectEvent.new)
       EM.stop
     end
@@ -1038,7 +1055,7 @@ module Discordrb
 
     def send_heartbeat
       millis = Time.now.strftime('%s%L').to_i
-      debug("Sending heartbeat at #{millis}")
+      LOGGER.out("Sending heartbeat at #{millis}")
       data = {
         op: 1,
         d: millis

data/lib/discordrb/data.rb

@@ -9,21 +9,46 @@ require 'base64'
 
 # Discordrb module
 module Discordrb
+  # The unix timestamp Discord IDs are based on
+  DISCORD_EPOCH = 1420070400000
+
   # Compares two objects based on IDs - either the objects' IDs are equal, or one object is equal to the other's ID.
   def self.id_compare(one_id, other)
     other.respond_to?(:resolve_id) ? (one_id.resolve_id == other.resolve_id) : (one_id == other)
   end
 
+  # Mixin for objects that have IDs
+  module IDObject
+    # @return [Integer] the ID which uniquely identifies this object across Discord.
+    attr_reader :id
+    alias_method :resolve_id, :id
+
+    # ID based comparison
+    def ==(other)
+      Discordrb.id_compare(@id, other)
+    end
+
+    # Estimates the time this object was generated on based on the beginning of the ID. This is fairly accurate but
+    # shouldn't be relied on as Discord might change its algorithm at any time
+    # @return [Time] when this object was created at
+    def creation_time
+      # Milliseconds
+      ms = (@id >> 22) + DISCORD_EPOCH
+      Time.at(ms / 1000.0)
+    end
+  end
+
   # User on Discord, including internal data like discriminators
   class User
+    include IDObject
+
     # @return [String] this user's username
     attr_reader :username
 
-    # @return [Integer] this user's ID which uniquely identifies them across Discord.
-    attr_reader :id
-
     # @return [String] this user's discriminator which is used internally to identify users with identical usernames.
     attr_reader :discriminator
+    alias_method :tag, :discriminator
+    alias_method :discord_tag, :discriminator
 
     # @return [String] the ID of this user's current avatar, can be used to generate an avatar URL.
     # @see #avatar_url
@@ -52,7 +77,6 @@ module Discordrb
     attr_accessor :server_mute, :server_deaf, :self_deaf
 
     alias_method :name, :username
-    alias_method :resolve_id, :id
 
     def initialize(data, bot)
       @bot = bot
@@ -66,11 +90,6 @@ module Discordrb
       @status = :offline
     end
 
-    # ID based comparison
-    def ==(other)
-      Discordrb.id_compare(@id, other)
-    end
-
     # Gets the user's avatar ID.
     # @deprecated Use {#avatar_id} instead.
     def avatar
@@ -224,6 +243,7 @@ module Discordrb
       end
     end
 
+    # The inspect method is overwritten to give more useful output
     def inspect
       "<User username=#{@username} id=#{@id} discriminator=#{@discriminator}>"
     end
@@ -285,6 +305,7 @@ module Discordrb
       @avatar_id = new_data[:avatar_id] || @avatar_id
     end
 
+    # The inspect method is overwritten to give more useful output
     def inspect
       "<Profile email=#{@email} user=#{super}>"
     end
@@ -304,15 +325,14 @@ module Discordrb
 
   # A Discord role that contains permissions and applies to certain users
   class Role
+    include IDObject
+
     # @return [Permissions] this role's permissions.
     attr_reader :permissions
 
     # @return [String] this role's name ("new role" if it hasn't been changed)
     attr_reader :name
 
-    # @return [Integer] the ID used to identify this role internally
-    attr_reader :id
-
     # @return [true, false] whether or not this role should be displayed separately from other users
     attr_reader :hoist
 
@@ -320,7 +340,6 @@ module Discordrb
     attr_reader :colour
 
     alias_method :color, :colour
-    alias_method :resolve_id, :id
 
     # This class is used internally as a wrapper to a Role object that allows easy writing of permission data.
     class RoleWriter
@@ -348,11 +367,6 @@ module Discordrb
       @colour = ColourRGB.new(data['color'])
     end
 
-    # ID based comparison
-    def ==(other)
-      Discordrb.id_compare(@id, other)
-    end
-
     # Updates the data cache from another Role object
     # @note For internal use only
     # @!visibility private
@@ -407,6 +421,7 @@ module Discordrb
       @server.delete_role(@id)
     end
 
+    # The inspect method is overwritten to give more useful output
     def inspect
       "<Role name=#{@name} permissions=#{@permissions.inspect} hoist=#{@hoist} colour=#{@colour.inspect} server=#{@server.inspect}>"
     end
@@ -483,6 +498,7 @@ module Discordrb
 
     alias_method :revoke, :delete
 
+    # The inspect method is overwritten to give more useful output
     def inspect
       "<Invite code=#{@code} channel=#{@channel} uses=#{@uses} temporary=#{@temporary} revoked=#{@revoked} xkcd=#{@xkcd}>"
     end
@@ -490,9 +506,16 @@ module Discordrb
 
   # A Discord channel, including data like the topic
   class Channel
+    # The type string that stands for a text channel
+    # @see Channel#type
     TEXT_TYPE = 'text'.freeze
+
+    # The type string that stands for a voice channel
+    # @see Channel#type
     VOICE_TYPE = 'voice'.freeze
 
+    include IDObject
+
     # @return [String] this channel's name.
     attr_reader :name
 
@@ -502,10 +525,6 @@ module Discordrb
     # @return [String] the type of this channel (currently either 'text' or 'voice')
     attr_reader :type
 
-    # @note If this channel is a #general channel, its ID will be equal to the server on which it is on.
-    # @return [Integer] the channel's unique ID.
-    attr_reader :id
-
     # @note This data is sent by Discord and it's possible for this to falsely be true for certain kinds of integration
     #   channels (like Twitch subscriber ones). This appears to be a Discord bug that I can't reproduce myself, due to
     #   not having any integrations in place. If this occurs to you please tell me.
@@ -527,13 +546,16 @@ module Discordrb
     # @return [Hash<Integer => OpenStruct>] the channel's permission overwrites
     attr_reader :permission_overwrites
 
-    alias_method :resolve_id, :id
-
     # @return [true, false] whether or not this channel is a PM channel, with more accuracy than {#is_private}.
     def private?
       @server.nil?
     end
 
+    # @return [String] a string that will mention the channel as a clickable link on Discord.
+    def mention
+      "<##{@id}>"
+    end
+
     # @!visibility private
     def initialize(data, bot, server = nil)
       @bot = bot
@@ -569,11 +591,6 @@ module Discordrb
       end
     end
 
-    # ID based comparison
-    def ==(other)
-      Discordrb.id_compare(@id, other)
-    end
-
     # @return [true, false] whether or not this channel is a text channel
     def text?
       @type == TEXT_TYPE
@@ -717,6 +734,7 @@ module Discordrb
     alias_method :message, :send_message
     alias_method :invite, :make_invite
 
+    # The inspect method is overwritten to give more useful output
     def inspect
       "<Channel name=#{@name} id=#{@id} topic=\"#{@topic}\" type=#{@type} position=#{@position} server=#{@server}>"
     end
@@ -730,6 +748,8 @@ module Discordrb
 
   # A message on Discord that was sent to a text channel
   class Message
+    include IDObject
+
     # @return [String] the content of this message.
     attr_reader :content
 
@@ -742,16 +762,12 @@ module Discordrb
     # @return [Time] the timestamp at which this message was sent.
     attr_reader :timestamp
 
-    # @return [Integer] the ID used to uniquely identify this message.
-    attr_reader :id
-
     # @return [Array<User>] the users that were mentioned in this message.
     attr_reader :mentions
 
     alias_method :user, :author
     alias_method :text, :content
     alias_method :to_s, :content
-    alias_method :resolve_id, :id
 
     # @!visibility private
     def initialize(data, bot)
@@ -769,11 +785,6 @@ module Discordrb
       end
     end
 
-    # ID based comparison
-    def ==(other)
-      Discordrb.id_compare(@id, other)
-    end
-
     # Replies to this message with the specified content.
     # @see Channel#send_message
     def reply(content)
@@ -802,6 +813,7 @@ module Discordrb
       @author.bot?
     end
 
+    # The inspect method is overwritten to give more useful output
     def inspect
       "<Message content=\"#{@content}\" id=#{@id} timestamp=#{@timestamp} author=#{@author} channel=#{@channel}>"
     end
@@ -809,22 +821,21 @@ module Discordrb
 
   # A server on Discord
   class Server
+    include IDObject
+
     # @return [String] the region the server is on (e. g. `amsterdam`).
     attr_reader :region
 
     # @return [String] this server's name.
     attr_reader :name
 
-    # @deprecated Use #owner instead, then get the resulting {User}'s {User#id}.
+    # @deprecated Use #owner instead, then get the resulting {User}'s ID.
     # @return [Integer] the server owner's user ID.
     attr_reader :owner_id
 
     # @return [User] The server owner.
     attr_reader :owner
 
-    # @return [Integer] the ID used to uniquely identify this server.
-    attr_reader :id
-
     # @return [Array<User>] an array of all the users on this server.
     attr_reader :members
     alias_method :users, :members
@@ -854,8 +865,6 @@ module Discordrb
     # @return [Integer] the channel ID of the AFK channel, or `nil` if none is set.
     attr_reader :afk_channel_id
 
-    alias_method :resolve_id, :id
-
     # @!visibility private
     def initialize(data, bot)
       @bot = bot
@@ -874,11 +883,6 @@ module Discordrb
       process_voice_states(data['voice_states'])
     end
 
-    # ID based comparison
-    def ==(other)
-      Discordrb.id_compare(@id, other)
-    end
-
     # @return [Channel] The default channel on this server (usually called #general)
     def default_channel
       @bot.channel(@id)
@@ -1045,6 +1049,7 @@ module Discordrb
       @afk_channel = @bot.channel(@afk_channel_id) if @afk_channel_id != 0 && (!@afk_channel || @afk_channel_id != @afk_channel.id)
     end
 
+    # The inspect method is overwritten to give more useful output
     def inspect
       "<Server name=#{@name} id=#{@id} large=#{@large} region=#{@region} owner=#{@owner} afk_channel_id=#{@afk_channel_id} afk_timeout=#{@afk_timeout}>"
     end

data/lib/discordrb/logger.rb

@@ -1,23 +1,94 @@
 module Discordrb
-  LOG_TIMESTAMP_FORMAT = '%Y-%m-%d %H:%M:%S.%L %z'.freeze
+  # The format log timestamps should be in, in strftime format
+  LOG_TIMESTAMP_FORMAT = '%Y-%m-%d %H:%M:%S.%L'.freeze
 
   # Logs debug messages
   class Logger
-    # @return [true, false] whether or not this logger should be in debug mode (all debug messages will be printed)
-    attr_writer :debug
+    # @return [true, false] whether this logger is in extra-fancy mode!
+    attr_writer :fancy
 
-    # Writes a debug message to the console.
-    # @param important [true, false] Whether this message should be printed regardless of debug mode being on or off.
-    def debug(message, important = false)
-      puts "[DEBUG : #{Thread.current[:discordrb_name]} @ #{Time.now.strftime(LOG_TIMESTAMP_FORMAT)}] #{message}" if @debug || important
+    def initialize(fancy = false)
+      @fancy = fancy
+      self.mode = :normal
+    end
+
+    # The modes this logger can have. This is probably useless unless you want to write your own Logger
+    MODES = {
+      debug: { long: 'DEBUG', short: 'D', format_code: '' },
+      good: { long: 'GOOD', short: '✓', format_code: "\u001B[32m" }, # green
+      info: { long: 'INFO', short: 'i', format_code: '' },
+      warn: { long: 'WARN', short: '!', format_code: "\u001B[33m" }, # yellow
+      error: { long: 'ERROR', short: '✗', format_code: "\u001B[31m" }, # red
+      out: { long: 'OUT', short: '→', format_code: "\u001B[36m" }, # cyan
+      in: { long: 'IN', short: '←', format_code: "\u001B[35m" } # purple
+    }.freeze
+
+    # The ANSI format code that resets formatting
+    FORMAT_RESET = "\u001B[0m".freeze
+
+    # The ANSI format code that makes something bold
+    FORMAT_BOLD = "\u001B[1m".freeze
+
+    MODES.each do |mode, hash|
+      define_method(mode) do |message|
+        write(message, hash) if @enabled_modes.include? mode
+      end
+    end
+
+    # Sets the logging mode to :debug
+    # @param value [true, false] Whether debug mode should be on. If it is off the mode will be set to :normal.
+    def debug=(value)
+      self.mode = value ? :debug : :normal
+    end
+
+    # Sets the logging mode
+    # Possible modes are:
+    #  * :debug logs everything
+    #  * :verbose logs everything except for debug messages
+    #  * :normal logs useful information, warnings and errors
+    #  * :quiet only logs warnings and errors
+    #  * :silent logs nothing
+    # @param value [Symbol] What logging mode to use
+    def mode=(value)
+      case value
+      when :debug
+        @enabled_modes = [:debug, :good, :info, :warn, :error, :out, :in]
+      when :verbose
+        @enabled_modes = [:good, :info, :warn, :error, :out, :in]
+      when :normal
+        @enabled_modes = [:info, :warn, :error]
+      when :quiet
+        @enabled_modes = [:warn, :error]
+      when :silent
+        @enabled_modes = []
+      end
     end
 
     # Logs an exception to the console.
     # @param e [Exception] The exception to log.
-    # @param important [true, false] Whether this exception should be printed regardless of debug mode being on or off.
-    def log_exception(e, important = true)
-      debug("Exception: #{e.inspect}", important)
-      e.backtrace.each { |line| debug(line, important) }
+    def log_exception(e)
+      error("Exception: #{e.inspect}")
+      e.backtrace.each { |line| error(line) }
+    end
+
+    private
+
+    def write(message, mode)
+      thread_name = Thread.current[:discordrb_name]
+      timestamp = Time.now.strftime(LOG_TIMESTAMP_FORMAT)
+      if @fancy
+        fancy_write(message, mode, thread_name, timestamp)
+      else
+        simple_write(message, mode, thread_name, timestamp)
+      end
+    end
+
+    def fancy_write(message, mode, thread_name, timestamp)
+      puts "#{timestamp} #{FORMAT_BOLD}#{thread_name.ljust(16)}#{FORMAT_RESET} #{mode[:format_code]}#{mode[:short]}#{FORMAT_RESET} #{message}"
+    end
+
+    def simple_write(message, mode, thread_name, timestamp)
+      puts "[#{mode[:long]} : #{thread_name} @ #{timestamp}] #{message}"
     end
   end
 end

data/lib/discordrb/token_cache.rb

@@ -169,8 +169,8 @@ module Discordrb
     private
 
     def fail_token(msg, email = nil, e = nil)
-      LOGGER.debug("Token not retrieved from cache - #{msg}")
-      LOGGER.log_exception(e, false) if e
+      LOGGER.warn("Token not retrieved from cache - #{msg}")
+      LOGGER.log_exception(e) if e
       @data.delete(email) if email
       nil
     end

data/lib/discordrb/version.rb

@@ -1,5 +1,5 @@
 # Discordrb and all its functionality, in this case only the version.
 module Discordrb
   # The current version of discordrb.
-  VERSION = '1.7.5'.freeze
+  VERSION = '1.8.0'.freeze
 end

data/lib/discordrb/voice/network.rb

@@ -194,6 +194,9 @@ module Discordrb::Voice
     # Event handlers; public for websocket-simple to work correctly
     # @!visibility private
     def websocket_open
+      # Give the current thread a name ('Voice Web Socket Internal')
+      Thread.current[:discordrb_name] = 'vws-i'
+
       # Send the init packet
       send_init(@channel.server.id, @bot.bot_user.id, @session, @token)
     end

data/lib/discordrb/voice/voice_bot.rb

@@ -180,6 +180,12 @@ module Discordrb::Voice
         # Encode data
         @encoder.encode(buf)
       end
+
+      # If the stream is a process, kill it
+      Process.kill('TERM', encoded_io.pid) if encoded_io.respond_to? :pid
+
+      # Close the stream
+      encoded_io.close
     end
 
     # Plays an encoded audio file of arbitrary format to the channel.
@@ -206,11 +212,20 @@ module Discordrb::Voice
       @bot.debug "Reading DCA file #{file}"
       input_stream = open(file)
 
+      magic = input_stream.read(4)
+      raise ArgumentError, 'Not a DCA1 file! The file might have been corrupted, please recreate it.' unless magic == 'DCA1'
+
+      # Read the metadata header, then read the metadata and discard it as we don't care about it
+      metadata_header = input_stream.read(4).unpack('l<')[0]
+      input_stream.read(metadata_header)
+
       # Play the data, without re-encoding it to opus
       play_internal do
         begin
           # Read header
-          header = input_stream.read(2).unpack('S')[0]
+          header = input_stream.read(2).unpack('s<')[0]
+
+          raise RuntimeError, 'Negative header in DCA file! Your file is likely corrupted.' if header < 0
         rescue EOFError
           @bot.debug 'Finished DCA parsing'
           break

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: discordrb
 version: !ruby/object:Gem::Version
-  version: 1.7.5
+  version: 1.8.0
 platform: ruby
 authors:
 - meew0
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-03 00:00:00.000000000 Z
+date: 2016-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faye-websocket