discordrb 1.7.3 → 1.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bcde95d0c926eba8368ed3553686b396a4a500db
-  data.tar.gz: 387df5587eaeab2eb24a8cb085ea4e951ffff3bf
+  metadata.gz: 36dd991249332783c1bd50f94ddbb555cc8483d2
+  data.tar.gz: 2b68f3bb825c2e6f49290356d7f7ebcbbb8e509e
 SHA512:
-  metadata.gz: 3374e7195c49d28d84cd936ff1e44b5232bbc65ad7df4fae6e9a22c2047730086b254af9e4ffde0d38c9b9a203be80fd8b1d86ef659816f9ee17fe6f3d39ca72
-  data.tar.gz: 271acc3f47814bf89b188fe02038d106a16c016b10eca67630a423e416a32c21815e743204a9028ed20991b4af5217860511690e04223c2e303d70da1c0205c4
+  metadata.gz: b22aa3bfb28c470f931eec7e060414f349e3cd46c29cd725cdc3235e372ece0dbaccd1d72b7b6077afb0f12b76ed112abc869a844acb152c5e8eb2e0c1ef0210
+  data.tar.gz: 12ee016ea86fb2fcd721855f32466552b4e471212c247005b864c416359b969e1b5ce943141eceede6177405d12c2b210f364533a55a44210fb0ab8e96eb90f9

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 1.7.4
+* Added methods `Channel#text?` and `Channel#voice?` to check a channel's type.
+* Frequently allocated strings have been turned into symbols or frozen constants, this should improve performance slightly.
+
+### Bugfixes
+* `VoiceBot#destroy` will now properly disconnect you and should no longer cause segfaults.
+* Fixed a bug where you couldn't set any settings on a role created using `Server#create_role`.
+* Fixed `Profile#avatar=` doing absolutely nothing.
+
 ## 1.7.3
 * The server banlist can now be accessed more nicely using `Server#bans`.
 * Some abstractions for OAuth application creation were added - `bot.create_oauth_application` and `bot.update_oauth_application`. See the docs about how to use them.

data/lib/discordrb/bot.rb

@@ -265,6 +265,27 @@ module Discordrb
       @voice
     end
 
+    # Disconnects the client from all voice connections across Discord.
+    # @param destroy_vws [true, false] Whether or not the VWS should also be destroyed. If you're calling this method
+    #   directly, you should leave it as true.
+    def voice_destroy(destroy_vws = true)
+      data = {
+          op: 4,
+          d: {
+              guild_id: nil,
+              channel_id: nil,
+              self_mute: false,
+              self_deaf: false
+          }
+      }
+
+      debug("Voice channel destroy packet is: #{data.to_json}")
+      @ws.send(data.to_json)
+
+      @voice.destroy if @voice && destroy_vws
+      @voice = nil
+    end
+
     # Revokes an invite to a server. Will fail unless you have the *Manage Server* permission.
     # It is recommended that you use {Invite#delete} instead.
     # @param code [String, Invite] The invite to revoke. For possible formats see {#resolve_invite_code}.
@@ -787,8 +808,9 @@ module Discordrb
       fail 'Invalid Packet' unless packet['op'] == 0 # TODO
 
       data = packet['d']
-      case packet['t']
-      when 'READY'
+      type = packet['t'].intern
+      case type
+      when :READY
         # Activate the heartbeats
         @heartbeat_interval = data['heartbeat_interval'].to_f / 1000.0
         @heartbeat_active = true
@@ -830,7 +852,7 @@ module Discordrb
 
         # Tell the run method that everything was successful
         @ws_success = true
-      when 'GUILD_MEMBERS_CHUNK'
+      when :GUILD_MEMBERS_CHUNK
         id = data['guild_id'].to_i
         members = data['members']
 
@@ -850,7 +872,7 @@ module Discordrb
         else
           debug "Got one chunk for server #{id}, parsing took #{duration} seconds"
         end
-      when 'MESSAGE_CREATE'
+      when :MESSAGE_CREATE
         create_message(data)
 
         message = Message.new(data, self)
@@ -869,22 +891,22 @@ module Discordrb
           event = PrivateMessageEvent.new(message, self)
           raise_event(event)
         end
-      when 'MESSAGE_UPDATE'
+      when :MESSAGE_UPDATE
         update_message(data)
 
         event = MessageEditEvent.new(data, self)
         raise_event(event)
-      when 'MESSAGE_DELETE'
+      when :MESSAGE_DELETE
         delete_message(data)
 
         event = MessageDeleteEvent.new(data, self)
         raise_event(event)
-      when 'TYPING_START'
+      when :TYPING_START
         start_typing(data)
 
         event = TypingEvent.new(data, self)
         raise_event(event)
-      when 'PRESENCE_UPDATE'
+      when :PRESENCE_UPDATE
         now_playing = data['game']
         presence_user = user(data['user']['id'].to_i)
         played_before = presence_user.nil? ? nil : presence_user.game
@@ -897,81 +919,81 @@ module Discordrb
                 end
 
         raise_event(event)
-      when 'VOICE_STATE_UPDATE'
+      when :VOICE_STATE_UPDATE
         update_voice_state(data)
 
         event = VoiceStateUpdateEvent.new(data, self)
         raise_event(event)
-      when 'VOICE_SERVER_UPDATE'
+      when :VOICE_SERVER_UPDATE
         update_voice_server(data)
 
         # no event as this is irrelevant to users
-      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_ADD'
+      when :GUILD_MEMBER_ADD
         add_guild_member(data)
 
         event = GuildMemberAddEvent.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_MEMBER_REMOVE'
+      when :GUILD_MEMBER_REMOVE
         delete_guild_member(data)
 
         event = GuildMemberDeleteEvent.new(data, self)
         raise_event(event)
-      when 'GUILD_BAN_ADD'
+      when :GUILD_BAN_ADD
         add_user_ban(data)
 
         event = UserBanEvent.new(data, self)
         raise_event(event)
-      when 'GUILD_BAN_REMOVE'
+      when :GUILD_BAN_REMOVE
         remove_user_ban(data)
 
         event = UserUnbanEvent.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)
-      when 'GUILD_CREATE'
+      when :GUILD_CREATE
         create_guild(data)
 
         event = GuildCreateEvent.new(data, self)
         raise_event(event)
-      when 'GUILD_UPDATE'
+      when :GUILD_UPDATE
         update_guild(data)
 
         event = GuildUpdateEvent.new(data, self)
         raise_event(event)
-      when 'GUILD_DELETE'
+      when :GUILD_DELETE
         delete_guild(data)
 
         event = GuildDeleteEvent.new(data, self)

data/lib/discordrb/data.rb

@@ -262,7 +262,7 @@ module Discordrb
     # Changes the bot's avatar.
     # @param avatar [String, File] A JPG file to be used as the avatar, either as a File object or as a base64-encoded String.
     def avatar=(avatar)
-      if avatar.is_a? File
+      if avatar.respond_to? :read
         avatar_string = 'data:image/jpg;base64,'
         avatar_string += Base64.strict_encode64(avatar.read)
         update_server_data(avatar: avatar_string)
@@ -288,7 +288,7 @@ module Discordrb
                       new_data[:email] || @email,
                       @password,
                       new_data[:username] || @username,
-                      new_data[:avatar_id] || @avatar_id,
+                      new_data[:avatar],
                       new_data[:new_password] || nil)
       update_data(new_data)
     end
@@ -474,10 +474,13 @@ module Discordrb
 
   # A Discord channel, including data like the topic
   class Channel
+    TEXT_TYPE = 'text'.freeze
+    VOICE_TYPE = 'voice'.freeze
+
     # @return [String] this channel's name.
     attr_reader :name
 
-    # @return [Server] the server this channel is on.
+    # @return [Server, nil] the server this channel is on. If this channel is a PM channel, it will be nil.
     attr_reader :server
 
     # @return [String] the type of this channel (currently either 'text' or 'voice')
@@ -523,7 +526,7 @@ module Discordrb
       data = data[-1] if data.is_a?(Array)
 
       @id = data['id'].to_i
-      @type = data['type'] || 'text'
+      @type = data['type'] || TEXT_TYPE
       @topic = data['topic']
       @position = data['position']
 
@@ -555,6 +558,16 @@ module Discordrb
       Discordrb.id_compare(@id, other)
     end
 
+    # @return [true, false] whether or not this channel is a text channel
+    def text?
+      @type == TEXT_TYPE
+    end
+
+    # @return [true, false] whether or not this channel is a voice channel
+    def voice?
+      @type == VOICE_TYPE
+    end
+
     # Sends a message to this channel.
     # @param content [String] The content to send. Should not be longer than 2000 characters or it will result in an error.
     # @return [Message] the message that was sent.
@@ -905,7 +918,7 @@ module Discordrb
     # @return [Role] the created role.
     def create_role
       response = API.create_role(@bot.token, @id)
-      role = Role.new(JSON.parse(response), @bot)
+      role = Role.new(JSON.parse(response), @bot, self)
       @roles << role
       role
     end

data/lib/discordrb/events/await.rb

@@ -11,6 +11,16 @@ module Discordrb::Events
     # The event that triggered the await.
     # @return [Event] The event
     attr_reader :event
+
+    # @!attribute [r] key
+    #   @return [Symbol] the await's key.
+    #   @see Await#key
+    # @!attribute [r] type
+    #   @return [Class] the await's event class.
+    #   @see Await#type
+    # @!attribute [r] attributes
+    #   @return [Hash] a hash of attributes defined on the await.
+    #   @see Await#attributes
     delegate :key, :type, :attributes, to: :await
 
     # For internal use only

data/lib/discordrb/events/message.rb

@@ -5,7 +5,23 @@ module Discordrb::Events
   class MessageEvent < Event
     attr_reader :message, :saved_message
 
+    # @!attribute [r] author
+    #   @return [User] who sent this message.
+    #   @see Message#author
+    # @!attribute [r] channel
+    #   @return [Channel] the channel in which this message was sent.
+    #   @see Message#channel
+    # @!attribute [r] content
+    #   @return [String] the message's content.
+    #   @see Message#content
+    # @!attribute [r] timestamp
+    #   @return [Time] the time at which the message was sent.
+    #   @see Message#timestamp
     delegate :author, :channel, :content, :timestamp, to: :message
+
+    # @!attribute [r] server
+    #   @return [Server, nil] the server where this message was sent, or nil if it was sent in PM.
+    #   @see Channel#server
     delegate :server, to: :channel
 
     def initialize(message, bot)

data/lib/discordrb/logger.rb

@@ -1,4 +1,6 @@
 module Discordrb
+  LOG_TIMESTAMP_FORMAT = '%Y-%m-%d %H:%M:%S.%L %z'.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)
@@ -7,7 +9,7 @@ module Discordrb
     # 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('%Y-%m-%d %H:%M:%S.%L %z')}] #{message}" if @debug || important
+      puts "[DEBUG : #{Thread.current[:discordrb_name]} @ #{Time.now.strftime(LOG_TIMESTAMP_FORMAT)}] #{message}" if @debug || important
     end
 
     # Logs an exception to the console.

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.3'.freeze
+  VERSION = '1.7.4'.freeze
 end

data/lib/discordrb/voice/encoder.rb

@@ -47,11 +47,6 @@ module Discordrb::Voice
       @opus.encode(buffer, 1920)
     end
 
-    # Destroys this encoder and the opus connection, preventing any future encodings.
-    def destroy
-      @opus.destroy
-    end
-
     # 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

@@ -256,7 +256,7 @@ module Discordrb::Voice
 
     # Disconnects the websocket and kills the thread
     def destroy
-      @thread.kill if @thread
+      @heartbeat_running = false
     end
 
     private
@@ -267,7 +267,8 @@ module Discordrb::Voice
     end
 
     def heartbeat_loop
-      loop do
+      @heartbeat_running = true
+      while @heartbeat_running
         if @heartbeat_interval
           sleep @heartbeat_interval / 1000.0
           send_heartbeat
@@ -288,8 +289,8 @@ module Discordrb::Voice
 
       @client.on(:open) { instance.websocket_open }
       @client.on(:message) { |msg| instance.websocket_message(msg.data) }
-      @client.on(:error) { |e| puts e.to_s }
-      @client.on(:close) { |e| puts e.to_s }
+      @client.on(:error) { |e| puts "VWS error: #{e}" }
+      @client.on(:close) { |e| puts "VWS close: #{e}" }
 
       # Block any further execution
       heartbeat_loop

data/lib/discordrb/voice/voice_bot.rb

@@ -141,8 +141,8 @@ module Discordrb::Voice
     # Permanently disconnects from the voice channel; to reconnect you will have to call {Bot#voice_connect} again.
     def destroy
       stop_playing
+      @bot.voice_destroy(false)
       @ws.destroy
-      @encoder.destroy
     end
 
     # Plays a stream of raw data to the channel. All playback methods are blocking, i. e. they wait for the playback to

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: discordrb
 version: !ruby/object:Gem::Version
-  version: 1.7.3
+  version: 1.7.4
 platform: ruby
 authors:
 - meew0
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-27 00:00:00.000000000 Z
+date: 2016-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faye-websocket