discordrb 2.0.2 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 572e630200bd7bf1c7d6909b544cf8f69fc1b86e
-  data.tar.gz: fb27acb8b8261dad408b43255eb2a4d526eab7ed
+  metadata.gz: e85a40f2b3cc06af57ecf04357e35453c6fc48ef
+  data.tar.gz: a5b5ff40e9ae47db4875392e74f6a4ce8d91bf2e
 SHA512:
-  metadata.gz: 44451c1101cf93c8eabfc3017cca46ca9c236a3dd3be88d6203f1463756558701f5edb94854be88fca2e6d9870ad9a6a09ee41962520fdd4a39636921fbe53df
-  data.tar.gz: c7e73b58ef30d7f783541d0a3799f759db38f2bdef8409cc82ed889afd44bcda77f93acaf567bb6dfb0d453202ea2cd7186f6066af29afbd89a4b182ace266c3
+  metadata.gz: cde28c5fa4b45858fa2646b19a677a8d59659d3abeb6b3b0a33f0808d6e9ec5ef830dc73be77fc05d6bb5392204a0d61742adc1fc7331b564ef38183ac47d96d
+  data.tar.gz: 02f17a29a2ebeec59047a799ce9a3564123dc7fdf8962d2940110738cb0285e8ee51daed9e5130ff5667f2621c588c689ec203c6e6f0fb282f6727b233ecef2a

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 2.0.3
+
+- All examples now fully use v2 ([#92](https://github.com/meew0/discordrb/pull/92), thanks @snapcase)
+- The message that occurs when a command is missing permission can now be changed or disabled ([#94](https://github.com/meew0/discordrb/pull/94), thanks @snapcase)
+- The log message that occurs when you disconnect from the WebSocket is now more compact ([#90](https://github.com/meew0/discordrb/issues/90))
+- `Bot#ignored?` now exists to check whether a user is ignored
+
+### Bugfixes
+
+- A problem where getting channel history would sometimes cause an exception has been fixed ([#88](https://github.com/meew0/discordrb/issues/88))
+- `split_message` should now behave correctly in a specific edge case ([#85](https://github.com/meew0/discordrb/pull/85), thanks @AnhNhan)
+- DCA playback should no longer cause an error when playback ends due to a specific reason
+
 ## 2.0.2
 
 - Added `Server#text_channels` and `#voice_channels` ([#79](https://github.com/meew0/discordrb/issues/79))

data/examples/eval.rb

@@ -2,13 +2,13 @@
 
 require 'discordrb'
 
-bot = Discordrb::Commands::CommandBot.new 'email@example.com', 'hunter2'
+bot = Discordrb::Commands::CommandBot.new token: 'B0T.T0KEN.here', application_id: 160123456789876543, prefix: '!'
 
-bot.command(:eval, help_available: false) do |event, code|
-  break if event.user.id == 000000 # Replace number with your ID
+bot.command(:eval, help_available: false) do |event, *code|
+  break unless event.user.id == 000000 # Replace number with your ID
 
   begin
-    eval(code)
+    eval code.join(' ')
   rescue
     "An error occured 😞"
   end

data/examples/ping_with_respond_time.rb

@@ -2,7 +2,7 @@
 
 require 'discordrb'
 
-bot = Discordrb::Commands::CommandBot.new 'email@example.com', 'hunter2'
+bot = Discordrb::Commands::CommandBot.new token: 'B0T.T0KEN.here', application_id: 160123456789876543, prefix: '!'
 
 bot.command(:ping) do |event|
   m = event.respond('Pong!')

data/examples/shutdown.rb

@@ -2,10 +2,10 @@
 
 require 'discordrb'
 
-bot = Discordrb::Commands::CommandBot.new 'email@example.com', 'hunter2'
+bot = Discordrb::Commands::CommandBot.new token: 'B0T.T0KEN.here', application_id: 160123456789876543, prefix: '!'
 
 bot.command(:exit, help_available: false) do |event|
-  break if event.user.id == 000000 # Replace number with your ID
+  break unless event.user.id == 000000 # Replace number with your ID
 
   bot.send_message(event.channel.id, 'Bot is shutting down')
   exit

data/lib/discordrb/bot.rb

@@ -242,12 +242,9 @@ module Discordrb
         loop do
           websocket_connect
 
-          # websocket_connect is blocking so being in here means we're disconnected
-          LOGGER.warn('Oh dear, we got disconnected!')
-
           if @reconnect_url
             # We got an op 7! Don't wait before reconnecting
-            debug('Got an op 7, reconnecting right away')
+            LOGGER.info('Got an op 7, reconnecting right away')
           else
             wait_for_reconnect
           end
@@ -543,6 +540,13 @@ module Discordrb
       @ignored_ids.delete(user.resolve_id)
     end
 
+    # Checks whether a user is being ignored.
+    # @param user [User, Integer, #resolve_id] The user, or its ID, to check.
+    # @return [true, false] whether or not the user is ignored.
+    def ignored?(user)
+      @ignored_ids.include?(user.resolve_id)
+    end
+
     # @see Logger#debug
     def debug(message)
       LOGGER.debug(message)
@@ -1056,7 +1060,7 @@ module Discordrb
         server = server(id)
         server.process_chunk(data['members'])
       when :MESSAGE_CREATE
-        if @ignored_ids.include?(data['author']['id'].to_i)
+        if ignored?(data['author']['id'].to_i)
           debug("Ignored author with ID #{data['author']['id']}")
           return
         end
@@ -1216,16 +1220,14 @@ module Discordrb
     end
 
     def websocket_close(event)
-      LOGGER.error('Disconnected from WebSocket!')
-
       # Don't handle nil events (for example if the disconnect came from our side)
       return unless event
 
       # Handle actual close frames and errors separately
       if event.respond_to? :code
-        LOGGER.error(" (Reason: #{event.data})")
-        LOGGER.error(" (Code: #{event.code})")
+        LOGGER.error(%(Disconnected from WebSocket - code #{event.code} with reason: "#{event.data}"))
       else
+        LOGGER.error('Disconnected from WebSocket due to an exception!')
         LOGGER.log_exception event
       end
 
@@ -1321,7 +1323,7 @@ module Discordrb
     # unexpected way
     def wait_for_reconnect
       # We disconnected in an unexpected way! Wait before reconnecting so we don't spam Discord's servers.
-      debug("Disconnected! Attempting to reconnect in #{@falloff} seconds.")
+      debug("Attempting to reconnect in #{@falloff} seconds.")
       sleep @falloff
 
       # Calculate new falloff

data/lib/discordrb/commands/command_bot.rb

@@ -155,7 +155,8 @@ module Discordrb::Commands
         result = command.call(event, arguments, chained)
         stringify(result)
       else
-        event.respond "You don't have permission to execute command `#{name}`!"
+        event.respond command.attributes[:permission_message].gsub('%name%', name.to_s) if command.attributes[:permission_message]
+        return
       end
     end
 

data/lib/discordrb/commands/container.rb

@@ -14,6 +14,9 @@ module Discordrb::Commands
     # @param attributes [Hash] The attributes to initialize the command with.
     # @option attributes [Integer] :permission_level The minimum permission level that can use this command, inclusive.
     #   See {CommandBot#set_user_permission} and {CommandBot#set_role_permission}.
+    # @option attributes [String, false] :permission_message Message to display when a user does not have sufficient
+    #   permissions to execute a command. %name% in the message will be replaced with the name of the command. Disable
+    #   the message by setting this option to false.
     # @option attributes [true, false] :chain_usable Whether this command is able to be used inside of a command chain
     #   or sub-chain. Typically used for administrative commands that shouldn't be done carelessly.
     # @option attributes [true, false] :help_available Whether this command is visible in the help command. See the

data/lib/discordrb/commands/parser.rb

@@ -16,6 +16,9 @@ module Discordrb::Commands
         # The lowest permission level that can use the command
         permission_level: attributes[:permission_level] || 0,
 
+        # Message to display when a user does not have sufficient permissions to execute a command
+        permission_message: (attributes[:permission_message].is_a? FalseClass) ? nil : (attributes[:permission_message] || "You don't have permission to execute command %name%!"),
+
         # Whether this command is usable in a command chain
         chain_usable: attributes[:chain_usable].nil? ? true : attributes[:chain_usable],
 

data/lib/discordrb/data.rb

@@ -42,7 +42,7 @@ module Discordrb
     tri = [*0..(lines.length - 1)].map { |i| lines.combination(i + 1).first }
 
     # Join the individual elements together to get an array of strings with consecutively more lines
-    joined = tri.map { |e| e.join("\n") }
+    joined = tri.map(&:join)
 
     # Find the largest element that is still below the character limit, or if none such element exists return the first
     ideal = joined.max_by { |e| e.length > CHARACTER_LIMIT ? -1 : e.length }
@@ -1059,7 +1059,7 @@ module Discordrb
                     # directly because the bot may also send messages to the channel
                     Recipient.new(bot.user(data['author']['id'].to_i), @channel, bot)
                   else
-                    @channel.server.member(data['author']['id'].to_i)
+                    @channel.server.member(data['author']['id'].to_i, false)
                   end
                 end
 
@@ -1199,9 +1199,11 @@ module Discordrb
 
     # Gets a member on this server based on user ID
     # @param id [Integer] The user ID to look for
-    def member(id)
+    # @param request [true, false] Whether the member should be requested from Discord if it's not cached
+    def member(id, request = true)
       id = id.resolve_id
       return @members[id] if member_cached?(id)
+      return nil unless request
 
       member = @bot.member(@id, id)
       @members[id] = member

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.2'.freeze
+  VERSION = '2.0.3'.freeze
 end

data/lib/discordrb/voice/voice_bot.rb

@@ -249,11 +249,18 @@ module Discordrb::Voice
       play_internal do
         begin
           # Read header
-          header = input_stream.read(2).unpack('s<')[0]
+          header_str = input_stream.read(2)
+
+          unless header_str
+            @bot.debug 'Finished DCA parsing (header is nil)'
+            break
+          end
+
+          header = header_str.unpack('s<')[0]
 
           raise 'Negative header in DCA file! Your file is likely corrupted.' if header < 0
         rescue EOFError
-          @bot.debug 'Finished DCA parsing'
+          @bot.debug 'Finished DCA parsing (EOFError)'
           break
         end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: discordrb
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.3
 platform: ruby
 authors:
 - meew0
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-10 00:00:00.000000000 Z
+date: 2016-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client