discordrb 3.2.1 → 3.3.0

data/lib/discordrb/light.rb

@@ -2,7 +2,7 @@
 
 require 'discordrb/light/light_bot'
 
-# This module contains classes to allow connections to bots without a connection to the gateway socket, i. e. bots
+# This module contains classes to allow connections to bots without a connection to the gateway socket, i.e. bots
 # that only use the REST part of the API.
 module Discordrb::Light
 end

data/lib/discordrb/logger.rb

@@ -33,7 +33,8 @@ module Discordrb
       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
+      in: { long: 'IN', short: '←', format_code: "\u001B[35m" }, # purple
+      ratelimit: { long: 'RATELIMIT', short: 'R', format_code: "\u001B[41m" } # red background
     }.freeze
 
     # The ANSI format code that resets formatting
@@ -65,15 +66,15 @@ module Discordrb
     def mode=(value)
       case value
       when :debug
-        @enabled_modes = [:debug, :good, :info, :warn, :error, :out, :in]
+        @enabled_modes = %i[debug good info warn error out in ratelimit]
       when :verbose
-        @enabled_modes = [:good, :info, :warn, :error, :out, :in]
+        @enabled_modes = %i[good info warn error out in ratelimit]
       when :normal
-        @enabled_modes = [:info, :warn, :error]
+        @enabled_modes = %i[info warn error ratelimit]
       when :quiet
-        @enabled_modes = [:warn, :error]
+        @enabled_modes = %i[warn error]
       when :silent
-        @enabled_modes = []
+        @enabled_modes = %i[]
       end
     end
 
@@ -91,7 +92,7 @@ module Discordrb
       timestamp = Time.now.strftime(LOG_TIMESTAMP_FORMAT)
 
       # Redact token if set
-      log = if @token
+      log = if @token && @token != ''
               message.to_s.gsub(@token, 'REDACTED_TOKEN')
             else
               message.to_s

data/lib/discordrb/permissions.rb

@@ -14,8 +14,8 @@ module Discordrb
       4 => :manage_channels,       # 16
       5 => :manage_server,         # 32
       6 => :add_reactions,         # 64
-      # 7                          # 128
-      # 8                          # 256
+      7 => :view_audit_log,        # 128
+      8 => :priority_speaker,      # 256
       # 9                          # 512
       10 => :read_messages,        # 1024
       11 => :send_messages,        # 2048
@@ -56,6 +56,7 @@ module Discordrb
     end
 
     alias_method :can_administrate=, :can_administrator=
+    alias_method :administrate, :administrator
 
     attr_reader :bits
 
@@ -74,14 +75,50 @@ module Discordrb
       end
     end
 
+    # Return the corresponding bits for an array of permission flag symbols.
+    # This is a class method that can be used to calculate bits instead
+    # of instancing a new Permissions object.
+    # @example Get the bits for permissions that could allow/deny read messages, connect, and speak
+    #   Permissions.bits [:read_messages, :connect, :speak] #=> 3146752
+    # @param list [Array<Symbol>]
+    # @return [Integer] the computed permissions integer
+    def self.bits(list)
+      value = 0
+
+      Flags.each do |position, flag|
+        value += 2**position if list.include? flag
+      end
+
+      value
+    end
+
     # Create a new Permissions object either as a blank slate to add permissions to (for example for
     #   {Channel#define_overwrite}) or from existing bit data to read out.
-    # @param bits [Integer] The permission bits that should be set from the beginning.
+    # @example Create a permissions object that could allow/deny read messages, connect, and speak by setting flags
+    #   permission = Permissions.new
+    #   permission.can_read_messages = true
+    #   permission.can_connect = true
+    #   permission.can_speak = true
+    # @example Create a permissions object that could allow/deny read messages, connect, and speak by an array of symbols
+    #   Permissions.new [:read_messages, :connect, :speak]
+    # @param bits [Integer, Array<Symbol>] The permission bits that should be set from the beginning, or an array of permission flag symbols
     # @param writer [RoleWriter] The writer that should be used to update data when a permission is set.
     def initialize(bits = 0, writer = nil)
       @writer = writer
-      @bits = bits
+
+      @bits = if bits.is_a? Array
+                self.class.bits(bits)
+              else
+                bits
+              end
+
       init_vars
     end
+
+    # Comparison based on permission bits
+    def ==(other)
+      false unless other.is_a? Discordrb::Permissions
+      bits == other.bits
+    end
   end
 end

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 = '3.2.1'.freeze
+  VERSION = '3.3.0'.freeze
 end

data/lib/discordrb/voice/encoder.rb

@@ -24,13 +24,13 @@ module Discordrb::Voice
 
     # Create a new encoder
     def initialize
-      @sample_rate = 48_000
-      @frame_size = 960
-      @channels = 2
+      sample_rate = 48_000
+      frame_size = 960
+      channels = 2
       @filter_volume = 1
 
       raise LoadError, 'Opus unavailable - voice not supported! Please install opus for voice support to work.' unless OPUS_AVAILABLE
-      @opus = Opus::Encoder.new(@sample_rate, @frame_size, @channels)
+      @opus = Opus::Encoder.new(sample_rate, frame_size, channels)
     end
 
     # Set the opus encoding bitrate
@@ -73,19 +73,21 @@ module Discordrb::Voice
     # an audio track. For a list of supported formats, see https://ffmpeg.org/general.html#Audio-Codecs. It even accepts
     # URLs, though encoding them is pretty slow - I recommend to make a stream of it and then use {#encode_io} instead.
     # @param file [String] The path or URL to encode.
+    # @param options [String] ffmpeg options to pass after the -i flag
     # @return [IO] the audio, encoded as s16le PCM
-    def encode_file(file)
-      command = "#{ffmpeg_command} -loglevel 0 -i \"#{file}\" -f s16le -ar 48000 -ac 2 #{filter_volume_argument} pipe:1"
+    def encode_file(file, options = '')
+      command = "#{ffmpeg_command} -loglevel 0 -i \"#{file}\" #{options} -f s16le -ar 48000 -ac 2 #{filter_volume_argument} pipe:1"
       IO.popen(command)
     end
 
     # Encodes an arbitrary IO audio stream using ffmpeg. Accepts pretty much any media format, even videos with audio
     # tracks. For a list of supported audio formats, see https://ffmpeg.org/general.html#Audio-Codecs.
     # @param io [IO] The stream to encode.
+    # @param options [String] ffmpeg options to pass after the -i flag
     # @return [IO] the audio, encoded as s16le PCM
-    def encode_io(io)
+    def encode_io(io, options = '')
       ret_io, writer = IO.pipe
-      command = "#{ffmpeg_command} -loglevel 0 -i - -f s16le -ar 48000 -ac 2 #{filter_volume_argument} pipe:1"
+      command = "#{ffmpeg_command} -loglevel 0 -i - #{options} -f s16le -ar 48000 -ac 2 #{filter_volume_argument} pipe:1"
       spawn(command, in: io, out: writer)
       ret_io
     end

data/lib/discordrb/voice/voice_bot.rb

@@ -233,15 +233,15 @@ module Discordrb::Voice
     # Plays an encoded audio file of arbitrary format to the channel.
     # @see Encoder#encode_file
     # @see #play
-    def play_file(file)
-      play @encoder.encode_file(file)
+    def play_file(file, options = '')
+      play @encoder.encode_file(file, options)
     end
 
     # Plays a stream of encoded audio data of arbitrary format to the channel.
     # @see Encoder#encode_io
     # @see #play
-    def play_io(io)
-      play @encoder.encode_io(io)
+    def play_io(io, options = '')
+      play @encoder.encode_io(io, options)
     end
 
     # Plays a stream of audio data in the DCA format. This format has the advantage that no recoding has to be

data/lib/discordrb/websocket.rb

@@ -2,8 +2,6 @@
 
 require 'websocket-client-simple'
 
-puts "Using WSCS version: #{WebSocket::Client::Simple::VERSION}"
-
 # The WSCS module which we're hooking
 # @see Websocket::Client::Simple::Client
 module WebSocket::Client::Simple
@@ -31,6 +29,8 @@ module Discordrb
     # @param error_handler [#call] The handler that should be called when an error occurs in another handler. The error
     #   will be passed as the first parameter to the handler.
     def initialize(endpoint, open_handler, message_handler, close_handler, error_handler)
+      Discordrb::LOGGER.debug "Using WSCS version: #{::WebSocket::Client::Simple::VERSION}"
+
       @open_handler = open_handler
       @message_handler = message_handler
       @close_handler = close_handler

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: discordrb
 version: !ruby/object:Gem::Version
-  version: 3.2.1
+  version: 3.3.0
 platform: ruby
 authors:
 - meew0
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-18 00:00:00.000000000 Z
+date: 2018-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.1.0.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.1.0.rc1
 - !ruby/object:Gem::Dependency
   name: opus-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -66,20 +66,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.24
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.24
 - !ruby/object:Gem::Dependency
   name: discordrb-webhooks
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.0.1
+        version: 3.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.0.1
+        version: 3.3.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -114,14 +128,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.7.6
+        version: 0.9.9
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.7.6
+        version: 0.9.9
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -156,14 +184,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.45.0
+        version: 0.49.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.45.0
+        version: 0.49.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.0
 description: A Ruby implementation of the Discord (https://discordapp.com) API.
 email:
 - ''
@@ -186,6 +228,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- bin/travis_build_docs.sh
 - discordrb-webhooks.gemspec
 - discordrb.gemspec
 - lib/discordrb.rb
@@ -194,6 +237,7 @@ files:
 - lib/discordrb/api/invite.rb
 - lib/discordrb/api/server.rb
 - lib/discordrb/api/user.rb
+- lib/discordrb/api/webhook.rb
 - lib/discordrb/await.rb
 - lib/discordrb/bot.rb
 - lib/discordrb/cache.rb
@@ -219,6 +263,7 @@ files:
 - lib/discordrb/events/roles.rb
 - lib/discordrb/events/typing.rb
 - lib/discordrb/events/voice_state_update.rb
+- lib/discordrb/events/webhooks.rb
 - lib/discordrb/gateway.rb
 - lib/discordrb/light.rb
 - lib/discordrb/light/data.rb
@@ -235,7 +280,8 @@ files:
 homepage: https://github.com/meew0/discordrb
 licenses:
 - MIT
-metadata: {}
+metadata:
+  changelog_uri: https://github.com/meew0/discordrb/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -244,7 +290,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.2.4
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -252,9 +298,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Discord API for Ruby
 test_files: []
-has_rdoc: