discordrb 1.7.4 → 1.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 36dd991249332783c1bd50f94ddbb555cc8483d2
-  data.tar.gz: 2b68f3bb825c2e6f49290356d7f7ebcbbb8e509e
+  metadata.gz: d661448f2825e14545bff5ef277d349bdc9fe944
+  data.tar.gz: f4c846fde0f3248e6c6d3be8d69b4dabfdd6f098
 SHA512:
-  metadata.gz: b22aa3bfb28c470f931eec7e060414f349e3cd46c29cd725cdc3235e372ece0dbaccd1d72b7b6077afb0f12b76ed112abc869a844acb152c5e8eb2e0c1ef0210
-  data.tar.gz: 12ee016ea86fb2fcd721855f32466552b4e471212c247005b864c416359b969e1b5ce943141eceede6177405d12c2b210f364533a55a44210fb0ab8e96eb90f9
+  metadata.gz: 49aaa4b14e1da63c24fa1dcb03500b3926c71781e6cbd20e5cd7af296b060dd01082baa6dceaa9630ac55520b316c0fd98d1027df34c6b1e5996303117193196
+  data.tar.gz: 9a8d93545ce59f3334fa785ffaa85fd47f511ace03175045614a69441735da09fffe7305b4b6dfe95316d7e1fc2b0c8407a1fc381596d9882ab52b681311e74e

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 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.
+
+### Bugfixes
+* Attempting to `p` a data class, especially a `User` or `Profile`, should no longer lock up the interpreter due to very deep recursion.
+* Manual TTS using `API.send_message` will now work correctly.
+
 ## 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.

data/discordrb.gemspec

@@ -32,5 +32,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'yard', '~> 0.8.7.6'
   spec.add_development_dependency 'rspec', '~> 3.4.0'
-  spec.add_development_dependency 'rubocop', '0.36.0'
+  spec.add_development_dependency 'rubocop', '0.37.2'
 end

data/examples/commands.rb

@@ -22,9 +22,9 @@ end
 
 bot.command(:random, min_args: 0, max_args: 2, description: 'Generates a random number between 0 and 1, 0 and max or min and max.', usage: 'random [min/max] [max]') do |_event, min, max|
   if max
-    rand(min..max)
+    rand(min.to_i..max.to_i)
   elsif min
-    rand(0..min)
+    rand(0..min.to_i)
   else
     rand
   end

data/lib/discordrb/api.rb

@@ -305,7 +305,7 @@ module Discordrb::API
     request(
       :post,
       "#{APIBASE}/channels/#{channel_id}/messages",
-      { content: message, mentions: mentions, tts => tts }.to_json,
+      { content: message, mentions: mentions, tts: tts }.to_json,
       Authorization: token,
       content_type: :json
     )

data/lib/discordrb/bot.rb

@@ -270,13 +270,13 @@ module Discordrb
     #   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
-          }
+        op: 4,
+        d: {
+          guild_id: nil,
+          channel_id: nil,
+          self_mute: false,
+          self_deaf: false
+        }
       }
 
       debug("Voice channel destroy packet is: #{data.to_json}")
@@ -344,11 +344,12 @@ module Discordrb
     # Sends a text message to a channel given its ID and the message's content.
     # @param channel_id [Integer] The ID that identifies the channel to send something to.
     # @param content [String] The text that should be sent as a message. It is limited to 2000 characters (Discord imposed).
+    # @param tts [true, false] Whether or not this message should be sent using Discord text-to-speech.
     # @return [Message] The message that was sent.
-    def send_message(channel_id, content)
+    def send_message(channel_id, content, tts = false)
       debug("Sending message to #{channel_id} with content '#{content}'")
 
-      response = API.send_message(token, channel_id, content)
+      response = API.send_message(token, channel_id, content, [], tts)
       Message.new(JSON.parse(response), self)
     end
 
@@ -449,7 +450,7 @@ module Discordrb
     # @yieldparam event [Event] The event object that was triggered.
     # @return [Await] The await that was created.
     def add_await(key, type, attributes = {}, &block)
-      fail "You can't await an AwaitEvent!" if type == Discordrb::Events::AwaitEvent
+      raise "You can't await an AwaitEvent!" if type == Discordrb::Events::AwaitEvent
       await = Await.new(self, key, type, attributes, block)
       @awaits ||= {}
       @awaits[key] = await
@@ -730,11 +731,11 @@ module Discordrb
 
       # Login
       login_response = API.login(@email, @password)
-      fail Discordrb::Errors::HTTPStatusError, login_response.code if login_response.code >= 400
+      raise Discordrb::Errors::HTTPStatusError, login_response.code if login_response.code >= 400
 
       # Parse response
       login_response_object = JSON.parse(login_response)
-      fail Discordrb::Errors::InvalidAuthenticationError unless login_response_object['token']
+      raise Discordrb::Errors::InvalidAuthenticationError unless login_response_object['token']
 
       debug('Received token from Discord!')
 
@@ -805,7 +806,7 @@ module Discordrb
         debug("Received packet #{event.data}")
       end
 
-      fail 'Invalid Packet' unless packet['op'] == 0 # TODO
+      raise 'Invalid Packet' unless packet['op'] == 0 # TODO
 
       data = packet['d']
       type = packet['t'].intern

data/lib/discordrb/commands/container.rb

@@ -71,7 +71,7 @@ module Discordrb::Commands
         include_commands(container)
         include_buckets(container)
       elsif !container_modules.include? Discordrb::EventContainer
-        fail "Could not include! this particular container - ancestors: #{container_modules}"
+        raise "Could not include! this particular container - ancestors: #{container_modules}"
       end
     end
   end

data/lib/discordrb/commands/rate_limiter.rb

@@ -7,7 +7,7 @@ module Discordrb::Commands
     # @param time_span [Integer, nil] The time span after which the request count is reset, in seconds, or nil if the bucket should never be reset. (If this is nil, limit should be nil too)
     # @param delay [Integer, nil] The delay for which the user has to wait after performing a request, in seconds, or nil if the user shouldn't have to wait.
     def initialize(limit, time_span, delay)
-      fail ArgumentError, '`limit` and `time_span` have to either both be set or both be nil!' if !limit != !time_span
+      raise ArgumentError, '`limit` and `time_span` have to either both be set or both be nil!' if !limit != !time_span
 
       @limit = limit
       @time_span = time_span
@@ -82,7 +82,7 @@ module Discordrb::Commands
     def resolve_key(thing)
       return thing.resolve_id if thing.respond_to?(:resolve_id) && !thing.is_a?(String)
       return thing if thing.is_a?(Integer) || thing.is_a?(Symbol)
-      fail ArgumentError, "Cannot use a #{thing.class} as a rate limiting key!"
+      raise ArgumentError, "Cannot use a #{thing.class} as a rate limiting key!"
     end
   end
 

data/lib/discordrb/container.rb

@@ -330,7 +330,7 @@ module Discordrb
     # @param container [Module] A module that `extend`s {EventContainer} from which the handlers will be added.
     def include_events(container)
       handlers = container.instance_variable_get '@event_handlers'
-      fail "Couldn't include the container #{container} as it doesn't have any event handlers - have you tried to include a commands container into an event-only bot?" unless handlers
+      raise "Couldn't include the container #{container} as it doesn't have any event handlers - have you tried to include a commands container into an event-only bot?" unless handlers
       @event_handlers ||= {}
       @event_handlers.merge!(handlers) { |_, old, new| old + new }
     end

data/lib/discordrb/data.rb

@@ -223,6 +223,10 @@ module Discordrb
         permission? flag, server, channel
       end
     end
+
+    def inspect
+      "<User username=#{@username} id=#{@id} discriminator=#{@discriminator}>"
+    end
   end
 
   # This class is a special variant of User that represents the bot's user profile (things like email addresses and the avatar).
@@ -281,6 +285,10 @@ module Discordrb
       @avatar_id = new_data[:avatar_id] || @avatar_id
     end
 
+    def inspect
+      "<Profile email=#{@email} user=#{super}>"
+    end
+
     private
 
     def update_server_data(new_data)
@@ -399,6 +407,10 @@ module Discordrb
       @server.delete_role(@id)
     end
 
+    def inspect
+      "<Role name=#{@name} permissions=#{@permissions.inspect} hoist=#{@hoist} colour=#{@colour.inspect} server=#{@server.inspect}>"
+    end
+
     private
 
     def update_role_data(new_data)
@@ -470,6 +482,10 @@ module Discordrb
     end
 
     alias_method :revoke, :delete
+
+    def inspect
+      "<Invite code=#{@code} channel=#{@channel} uses=#{@uses} temporary=#{@temporary} revoked=#{@revoked} xkcd=#{@xkcd}>"
+    end
   end
 
   # A Discord channel, including data like the topic
@@ -570,9 +586,10 @@ module Discordrb
 
     # 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.
+    # @param tts [true, false] Whether or not this message should be sent using Discord text-to-speech.
     # @return [Message] the message that was sent.
-    def send_message(content)
-      @bot.send_message(@id, content)
+    def send_message(content, tts = false)
+      @bot.send_message(@id, content, tts)
     end
 
     # Sends a file to this channel. If it is an image, it will be embedded.
@@ -650,7 +667,7 @@ module Discordrb
     # @param amount [Integer] How many messages to delete. Must be 100 or less (Discord limitation)
     # @raise [ArgumentError] if more than 100 messages are requested.
     def prune(amount)
-      fail ArgumentError, "Can't prune more than 100 messages!" if amount > 100
+      raise ArgumentError, "Can't prune more than 100 messages!" if amount > 100
 
       threads = []
       history(amount).each do |message|
@@ -700,6 +717,10 @@ module Discordrb
     alias_method :message, :send_message
     alias_method :invite, :make_invite
 
+    def inspect
+      "<Channel name=#{@name} id=#{@id} topic=\"#{@topic}\" type=#{@type} position=#{@position} server=#{@server}>"
+    end
+
     private
 
     def update_channel_data
@@ -780,6 +801,10 @@ module Discordrb
     def from_bot?
       @author.bot?
     end
+
+    def inspect
+      "<Message content=\"#{@content}\" id=#{@id} timestamp=#{@timestamp} author=#{@author} channel=#{@channel}>"
+    end
   end
 
   # A server on Discord
@@ -1020,6 +1045,10 @@ module Discordrb
       @afk_channel = @bot.channel(@afk_channel_id) if @afk_channel_id != 0 && (!@afk_channel || @afk_channel_id != @afk_channel.id)
     end
 
+    def inspect
+      "<Server name=#{@name} id=#{@id} large=#{@large} region=#{@region} owner=#{@owner} afk_channel_id=#{@afk_channel_id} afk_timeout=#{@afk_timeout}>"
+    end
+
     private
 
     def update_server_data(new_data)

data/lib/discordrb/events/generic.rb

@@ -65,7 +65,7 @@ module Discordrb::Events
     # Whether or not this event handler matches the given event with its attributes.
     # @raise [RuntimeError] if this method is called - overwrite it in your event handler!
     def matches?(_)
-      fail 'Attempted to call matches?() from a generic EventHandler'
+      raise 'Attempted to call matches?() from a generic EventHandler'
     end
 
     # Checks whether this handler matches the given event, and then calls it.

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.4'.freeze
+  VERSION = '1.7.5'.freeze
 end

data/lib/discordrb/voice/encoder.rb

@@ -30,7 +30,7 @@ module Discordrb::Voice
       if OPUS_AVAILABLE
         @opus = Opus::Encoder.new(@sample_rate, @frame_size, @channels)
       else
-        fail LoadError, 'Opus unavailable - voice not supported! Please install opus for voice support to work.'
+        raise LoadError, 'Opus unavailable - voice not supported! Please install opus for voice support to work.'
       end
     end
 

data/lib/discordrb/voice/network.rb

@@ -91,7 +91,7 @@ module Discordrb::Voice
     # @param buf [String] The encoded audio data to be encrypted
     # @return [String] the audio data, encrypted
     def encrypt_audio(header, buf)
-      fail 'No secret key found, despite encryption being enabled!' unless @secret_key
+      raise 'No secret key found, despite encryption being enabled!' unless @secret_key
       box = RbNaCl::SecretBox.new(@secret_key)
 
       # The nonce is the header of the voice packet with 12 null bytes appended
@@ -119,7 +119,7 @@ module Discordrb::Voice
     # @param session [String] The voice session ID Discord sends over the regular websocket
     # @param endpoint [String] The endpoint URL to connect to
     def initialize(channel, bot, token, session, endpoint)
-      fail 'RbNaCl is unavailable - unable to create voice bot! Please read https://github.com/meew0/discordrb/wiki/Installing-libsodium' unless RBNACL_AVAILABLE
+      raise 'RbNaCl is unavailable - unable to create voice bot! Please read https://github.com/meew0/discordrb/wiki/Installing-libsodium' unless RBNACL_AVAILABLE
 
       @channel = channel
       @bot = bot

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: discordrb
 version: !ruby/object:Gem::Version
-  version: 1.7.4
+  version: 1.7.5
 platform: ruby
 authors:
 - meew0
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-28 00:00:00.000000000 Z
+date: 2016-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faye-websocket
@@ -156,14 +156,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.36.0
+        version: 0.37.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.36.0
+        version: 0.37.2
 description: A Ruby implementation of the Discord (https://discordapp.com) API.
 email:
 - ''