discordrb 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca5ae97de9345328dac0b9f9e8c14f38e2d70bc9
-  data.tar.gz: fe60d3642cecec76594a3356d93c923be5f27997
+  metadata.gz: 62c28a349c8f96a8a2774df678a355ea648ffada
+  data.tar.gz: fa5f7258abac813c417549a9a9a56aaa76c42de0
 SHA512:
-  metadata.gz: fa6c978e90c0f5338a9f6b67f0cf1fafd6d2c847c76b1fb6aadacfb820c95248ecdb8962ab84d63c2811b0bd28dd6913b72ae1463b671822f8716d526d04e9dc
-  data.tar.gz: b0eab7396be2942e2c7f9370c49fa1b45e70c2836d1281bf31e9fc98bc44919ac276c6a453000758b90a502cbde65ced78782a5b5b82c5472a20f429dc710bb7
+  metadata.gz: 8ccbce3f46ad696ed1e285c7fc6625eb06c7855d21afe41768093e82d126557b68b8acc27b530ff6864745077d27879d95c7119b043de9d117a4cce41e0a2c89
+  data.tar.gz: a308092e8dba4c4d7e491b921576c39ea5b40a2c362fe2df8a98c946f8f8cd0bb6e7a3c6f68e2189c8734041282c654d8353b0989dbedffad8a828b25d336882

data/.rubocop.yml

@@ -48,4 +48,9 @@ Style/Alias:
 # So RuboCop doesn't complain about application IDs
 Style/NumericLiterals:
   Exclude:
-    - examples/*
+    - examples/*
+
+# Ignore `eval` in the examples folder
+Lint/Eval:
+  Exclude:
+    - examples/*

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## 2.0.1
+
+- Added some more examples ([#75](https://github.com/meew0/discordrb/pull/75), thanks @greenbigfrog)
+- Users can now be ignored from messages at gateway level (`Bot#ignore_user`, `Bot#unignore_user`)
+- `Member#add_role` and `Member#remove_role` were re-added from User - they were missing before
+
+
+### Bugfixes
+
+- Fixed some typos in the documentation
+- If a server is actually unavailable it will no longer spam the console with timeout messages
+- VoiceBot now sends five frames of silence after finishing a track. This fixes an issue where the sound from the last track would bleed over into the new one due to interpolation.
+- Fixed a bug where playing something right after connecting to voice would sometimes cause the encryption key to not be set
+
 ## 2.0.0
 
 This is the first major update with some breaking changes! Those are highlighted in bold with migration advice after them. Ask in the Discord channel (see the README) if you have questions.

data/README.md

@@ -7,8 +7,6 @@
 
 An implementation of the [Discord](https://discordapp.com/) API using Ruby.
 
-**News**: Please help test version 2 of discordrb with a lot of changes! A preliminary changelog can be found [here](https://gist.github.com/meew0/ea120051da52604e7873b7cfaed4c40b). The code can be found on the `v2` branch; if you're using bundler you can change the gem reference to `gem 'discordrb', git: 'git://github.com/meew0/discordrb.git', branch: 'v2'`. A downloadable gem file for everybody else will follow here shortly.
-
 ## Quick links to sections
 
 * [Dependencies](https://github.com/meew0/discordrb#dependencies)
@@ -78,7 +76,7 @@ You can make a simple bot like this:
 ```ruby
 require 'discordrb'
 
-bot = Discordrb::Bot.new token: '<token here>'
+bot = Discordrb::Bot.new token: '<token here>', application_id: 168123456789123456
 
 bot.message(with_text: 'Ping!') do |event|
   event.respond 'Pong!'

data/examples/eval.rb

@@ -0,0 +1,17 @@
+# Gives you the ability to execute code on the fly
+
+require 'discordrb'
+
+bot = Discordrb::Commands::CommandBot.new 'email@example.com', 'hunter2'
+
+bot.command(:eval, help_available: false) do |event, code|
+  break if event.user.id == 000000 # Replace number with your ID
+
+  begin
+    eval(code)
+  rescue
+    "An error occured 😞"
+  end
+end
+
+bot.run

data/examples/ping_with_respond_time.rb

@@ -0,0 +1,13 @@
+# Pinging the bot will also tell you the time it takes the bot to send the message
+
+require 'discordrb'
+
+bot = Discordrb::Commands::CommandBot.new 'email@example.com', 'hunter2'
+
+bot.command(:ping) do |event|
+  m = event.respond('Pong!')
+  m.edit "Pong! Time taken: #{Time.now - event.timestamp} seconds."
+  nil
+end
+
+bot.run

data/examples/shutdown.rb

@@ -0,0 +1,14 @@
+# This script allows you to shutdown the bot on command
+
+require 'discordrb'
+
+bot = Discordrb::Commands::CommandBot.new 'email@example.com', 'hunter2'
+
+bot.command(:exit, help_available: false) do |event|
+  break if event.user.id == 000000 # Replace number with your ID
+
+  bot.send_message(event.channel.id, 'Bot is shutting down')
+  exit
+end
+
+bot.run

data/lib/discordrb/bot.rb

@@ -2,6 +2,7 @@
 
 require 'rest-client'
 require 'zlib'
+require 'set'
 
 require 'discordrb/events/message'
 require 'discordrb/events/typing'
@@ -81,11 +82,11 @@ module Discordrb
   # Represents a Discord bot, including servers, users, etc.
   class Bot
     # The list of users the bot shares a server with.
-    # @return [Array<User>] The users.
+    # @return [Hash<Integer => User>] The users by ID.
     attr_reader :users
 
     # The list of servers the bot is currently in.
-    # @return [Array<Server>] The servers.
+    # @return [Hash<Integer => Server>] The servers by ID.
     attr_reader :servers
 
     # The list of currently running threads used to parse and call events.
@@ -184,6 +185,8 @@ module Discordrb
       @voices = {}
       @should_connect_to_voice = {}
 
+      @ignored_ids = Set.new
+
       @event_threads = []
       @current_thread = 0
     end
@@ -525,6 +528,20 @@ module Discordrb
       @awaits[key] = await
     end
 
+    # Add a user to the list of ignored users. Those users will be ignored in message events at event processing level.
+    # @note Ignoring a user only prevents any message events (including mentions, commands etc.) from them! Typing and
+    #   presence and any other events will still be received.
+    # @param user [User, Integer, #resolve_id] The user, or its ID, to be ignored.
+    def ignore_user(user)
+      @ignored_ids << user.resolve_id
+    end
+
+    # Remove a user from the ignore list.
+    # @param user [User, Integer, #resolve_id] The user, or its ID, to be unignored.
+    def unignore_user(user)
+      @ignored_ids.delete(user.resolve_id)
+    end
+
     # @see Logger#debug
     def debug(message)
       LOGGER.debug(message)
@@ -966,6 +983,10 @@ module Discordrb
         # The server streaming timed out!
         LOGGER.warn("Server streaming timed out with #{@unavailable_servers} servers remaining")
         LOGGER.warn("This means some servers are unavailable due to an outage. Notifying ready now, we'll have to live without these servers")
+
+        # Unset the unavailable server count so this doesn't get triggered again
+        @unavailable_servers = nil
+
         notify_ready
       end
 
@@ -1039,6 +1060,11 @@ module Discordrb
         server = server(id)
         server.process_chunk(data['members'])
       when :MESSAGE_CREATE
+        if @ignored_ids.include?(data['author']['id'].to_i)
+          debug("Ignored author with ID #{data['author']['id']}")
+          return
+        end
+
         create_message(data)
 
         message = Message.new(data, self)

data/lib/discordrb/container.rb

@@ -26,7 +26,6 @@ module Discordrb
     # @option attributes [String, Integer, Channel] :in Matches the channel the message was sent in.
     # @option attributes [String, Integer, User] :from Matches the user that sent the message.
     # @option attributes [String] :content Exactly matches the entire content of the message.
-    # @option attributes [String] :content Exactly matches the entire content of the message.
     # @option attributes [Time] :after Matches a time after the time the message was sent at.
     # @option attributes [Time] :before Matches a time before the time the message was sent at.
     # @option attributes [Boolean] :private Matches whether or not the channel is private.
@@ -124,7 +123,6 @@ module Discordrb
     # @option attributes [String, Integer, Channel] :in Matches the channel the message was sent in.
     # @option attributes [String, Integer, User] :from Matches the user that sent the message.
     # @option attributes [String] :content Exactly matches the entire content of the message.
-    # @option attributes [String] :content Exactly matches the entire content of the message.
     # @option attributes [Time] :after Matches a time after the time the message was sent at.
     # @option attributes [Time] :before Matches a time before the time the message was sent at.
     # @option attributes [Boolean] :private Matches whether or not the channel is private.
@@ -157,7 +155,7 @@ module Discordrb
       register_event(ChannelUpdateEvent, attributes, block)
     end
 
-    # This **event** is raised when a channel is updated.
+    # This **event** is raised when a channel is deleted.
     # @param attributes [Hash] The event's attributes.
     # @option attributes [String] :type Matches the type of channel that is being deleted (text or voice)
     # @option attributes [String] :name Matches the name of the deleted channel.
@@ -288,7 +286,6 @@ module Discordrb
     # @option attributes [String, Integer, Channel] :in Matches the channel the message was sent in.
     # @option attributes [String, Integer, User] :from Matches the user that sent the message.
     # @option attributes [String] :content Exactly matches the entire content of the message.
-    # @option attributes [String] :content Exactly matches the entire content of the message.
     # @option attributes [Time] :after Matches a time after the time the message was sent at.
     # @option attributes [Time] :before Matches a time before the time the message was sent at.
     # @option attributes [Boolean] :private Matches whether or not the channel is private.

data/lib/discordrb/data.rb

@@ -338,6 +338,26 @@ module Discordrb
       @server.owner == self
     end
 
+    # Adds one or more roles to this member.
+    # @param role [Role, Array<Role>] The role(s) to add.
+    def add_role(role)
+      role_ids = role_id_array(role)
+      old_role_ids = @roles.map(&:id)
+      new_role_ids = (old_role_ids + role_ids).uniq
+
+      API.update_user_roles(@bot.token, @server.id, @user.id, new_role_ids)
+    end
+
+    # Removes one or more roles from this member.
+    # @param role [Role, Array<Role>] The role(s) to remove.
+    def remove_role(role)
+      old_role_ids = @roles.map(&:id)
+      role_ids = role_id_array(role)
+      new_role_ids = old_role_ids.reject { |i| role_ids.include?(i) }
+
+      API.update_user_roles(@bot.token, @server.id, @user.id, new_role_ids)
+    end
+
     # Update this member's roles
     # @note For internal use only.
     # @!visibility private
@@ -364,6 +384,17 @@ module Discordrb
     def inspect
       "<Member user=#{@user.inspect} server=#{@server.inspect} joined_at=#{@joined_at} roles=#{@roles.inspect} voice_channel=#{@voice_channel.inspect} mute=#{@mute} deaf=#{@deaf} self_mute=#{@self_mute} self_deaf=#{@self_deaf}>"
     end
+
+    private
+
+    # Utility method to get a list of role IDs from one role or an array of roles
+    def role_id_array(role)
+      if role.is_a? Array
+        role.map(&:resolve_id)
+      else
+        [role.resolve_id]
+      end
+    end
   end
 
   # Recipients are members on private channels - they exist for completeness purposes, but all

data/lib/discordrb/events/channels.rb

@@ -81,6 +81,8 @@ module Discordrb::Events
     attr_reader :server
 
     def initialize(data, bot)
+      @bot = bot
+
       @type = data['type']
       @topic = data['topic']
       @position = data['position']

data/lib/discordrb/events/guilds.rb

@@ -10,6 +10,8 @@ module Discordrb::Events
     attr_reader :server
 
     def initialize(data, bot)
+      @bot = bot
+
       init_server(data, bot)
     end
 

data/lib/discordrb/events/members.rb

@@ -18,6 +18,8 @@ module Discordrb::Events
     alias_method :member, :user
 
     def initialize(data, bot)
+      @bot = bot
+
       @server = bot.server(data['guild_id'].to_i)
       return unless @server
 

data/lib/discordrb/events/presence.rb

@@ -16,6 +16,8 @@ module Discordrb::Events
     attr_reader :status
 
     def initialize(data, bot)
+      @bot = bot
+
       @user = bot.user(data['user']['id'].to_i)
       @status = data['status'].to_sym
       @server = bot.server(data['guild_id'].to_i)
@@ -61,10 +63,10 @@ module Discordrb::Events
     attr_reader :game
 
     def initialize(data, bot)
-      @user = bot.user(data['user']['id'].to_i)
+      @bot = bot
 
+      @user = bot.user(data['user']['id'].to_i)
       @game = data['game'] ? data['game']['name'] : nil
-
       @server = bot.server(data['guild_id'].to_i)
     end
   end

data/lib/discordrb/events/roles.rb

@@ -13,6 +13,8 @@ module Discordrb::Events
     attr_reader :server
 
     def initialize(data, bot)
+      @bot = bot
+
       @server = bot.server(data['guild_id'].to_i)
       return unless @server
 
@@ -48,6 +50,8 @@ module Discordrb::Events
     attr_reader :server
 
     def initialize(data, bot)
+      @bot = bot
+
       # The role should already be deleted from the server's list
       # by the time we create this event, so we'll create a temporary
       # role object for event consumers to use.

data/lib/discordrb/events/typing.rb

@@ -16,6 +16,8 @@ module Discordrb::Events
     attr_reader :timestamp
 
     def initialize(data, bot)
+      @bot = bot
+
       @user_id = data['user_id'].to_i
 
       @channel_id = data['channel_id'].to_i

data/lib/discordrb/events/voice_state_update.rb

@@ -9,6 +9,8 @@ module Discordrb::Events
     attr_reader :user, :token, :suppress, :session_id, :self_mute, :self_deaf, :mute, :deaf, :server, :channel
 
     def initialize(data, bot)
+      @bot = bot
+
       @token = data['token']
       @suppress = data['suppress']
       @session_id = data['session_id']

data/lib/discordrb/version.rb

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

data/lib/discordrb/voice/encoder.rb

@@ -49,6 +49,9 @@ module Discordrb::Voice
       @opus.encode(buffer, 1920)
     end
 
+    # One frame of complete silence Opus encoded
+    OPUS_SILENCE = [0xF8, 0xFF, 0xFE].pack('C*').freeze
+
     # Adjusts the volume of a given buffer of s16le PCM data.
     # @param buf [String] An unencoded PCM (s16le) buffer.
     # @param mult [Float] The volume multiplier, 1 for same volume.

data/lib/discordrb/voice/network.rb

@@ -260,6 +260,11 @@ module Discordrb::Voice
 
       # Send UDP init packet with received UDP data
       send_udp_connection(ip, port, @udp_mode)
+
+      @bot.debug('Waiting for op 4 now')
+
+      # Wait for op 4, then finish
+      sleep 0.05 until @ready
     end
 
     # Disconnects the websocket and kills the thread

data/lib/discordrb/voice/voice_bot.rb

@@ -227,6 +227,9 @@ module Discordrb::Voice
 
     # Plays a stream of audio data in the DCA format. This format has the advantage that no recoding has to be
     # done - the file contains the data exactly as Discord needs it.
+    # @note DCA playback will not be affected by the volume modifier ({volume=}) because the modifier operates on raw
+    #   PCM, not opus data. Modifying the volume of DCA data would involve decoding it, multiplying the samples and
+    #   re-encoding it, which defeats its entire purpose (no recoding).
     # @see https://github.com/bwmarrin/dca
     # @see #play
     def play_dca(file)
@@ -290,8 +293,7 @@ module Discordrb::Voice
 
         # Track packet count, sequence and time (Discord requires this)
         count += 1
-        (@sequence + 10 < 65_535) ? @sequence += 1 : @sequence = 0
-        (@time + 9600 < 4_294_967_295) ? @time += 960 : @time = 0
+        increment_packet_headers
 
         # Get packet data
         buf = yield
@@ -335,10 +337,26 @@ module Discordrb::Voice
         sleep @length / 1000.0
       end
 
+      @bot.debug('Sending five silent frames to clear out buffers')
+
+      5.times do
+        increment_packet_headers
+        @udp.send_audio(Encoder::OPUS_SILENCE, @sequence, @time)
+
+        # Length adjustments don't matter here, we can just wait 20 ms since nobody is going to hear it anyway
+        sleep IDEAL_LENGTH / 1000.0
+      end
+
       @bot.debug('Performing final cleanup after stream ended')
 
       # Final cleanup
       stop_playing
     end
+
+    # Increment sequence and time
+    def increment_packet_headers
+      (@sequence + 10 < 65_535) ? @sequence += 1 : @sequence = 0
+      (@time + 9600 < 4_294_967_295) ? @time += 960 : @time = 0
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: discordrb
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - meew0
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-08 00:00:00.000000000 Z
+date: 2016-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -172,8 +172,11 @@ files:
 - bin/setup
 - discordrb.gemspec
 - examples/commands.rb
+- examples/eval.rb
 - examples/ping.rb
+- examples/ping_with_respond_time.rb
 - examples/pm_send.rb
+- examples/shutdown.rb
 - lib/discordrb.rb
 - lib/discordrb/api.rb
 - lib/discordrb/await.rb