discordrb 3.4.0 → 3.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b44116c97ea561cc141eddb374d560c3f2ca256c0b13cde7c6fe42479a42d9e3
-  data.tar.gz: 9e8a42e010851af16ca3a1a922a268559dbafdcb66bb3e6824f68dbcea1759aa
+  metadata.gz: a5c0ecfd68356ed63ea61a7b99bb5d32e358f74b23c2f729ab531e4848bc770d
+  data.tar.gz: 4c5917f1b7a1a3e97d875a0244a8fa8e9583bce025053505b960de9e900ca16f
 SHA512:
-  metadata.gz: e025470a1b899d0494827e5f62602d18d2e96a6ddeec4076780856119c07c78cb3c7da71c14d4110572560d4992b1ae2cba8e6b6002d17abbb9fd2e2220c28d5
-  data.tar.gz: 05dd2b712800adbd8d14b659edf59750d31bad386a5a910a23c2ae447161dd3b68c42a48d28a664a9108c64f3ded641e102516a0a93a8f25b84a736f49f6b632
+  metadata.gz: '09b5b31c7e7f15c7053c476ae0c2fd11839b7f5b82c4dea330764da42321c8333559df72273cdffbafe91bc9452a51a4bece945a2e6b3a8774af5fce409750fb'
+  data.tar.gz: 1743f21d2ad48858e8ebed88984fdf5cecb2ce5878ae0cbf32dbccc451175daa1d0f37c571efa100dadd94dcb169b17515bc691884d9583e00b40f57b45242ff

data/CHANGELOG.md

@@ -4,6 +4,38 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [3.4.2] - 2020-2-5
+[3.4.1]: https://github.com/shardlab/discordrb/releases/tag/v3.4.2
+
+[View diff for this release.](https://github.com/shardlab/discordrb/compare/v3.4.1..v3.4.2)
+
+### Summary
+I failed to update rest-client dependencies properly, and discovered that you can't republish gem versions the hard way.
+
+### Changed
+- `rest-client` has a requirement of `>= 2.0.0` on both `discordrb` and `discordrb-webhooks`
+
+## [3.4.1] - 2020-2-4
+[3.4.1]: https://github.com/shardlab/discordrb/releases/tag/v3.4.1
+
+[View diff for this release.](https://github.com/shardlab/discordrb/compare/v3.4.0..v3.4.1)
+
+### Summary
+
+With 3.4.0, mistakes were made during the version bump leading to a bit of a dependency issue between `discordrb` and `discordrb-webhooks` (sorry!).
+This micro bump fixes this, fixes a few other code issues, and adds a few minor features.
+
+### Added
+- Added support for `competing` activity types ([#21](https://github.com/shardlab/discordrb/pull/21), thanks @kaine119)
+- Support for a callable command_does_not_exist_message ([#25](https://github.com/shardlab/discordrb/pull/25), thanks @kmcphillips)
+
+### Fixed
+- `Bot#send_temporary_message` now properly passes `message_reference` ([#17](https://github.com/shardlab/discordrb/pull/17) thanks @swarley)
+- Rate limit precision is only supplied when the route requires headers ([#11](https://github.com/shardlab/discordrb/pull/11) thanks @dali546)
+- Remove pointless conditional in `Invite` initializer ([#26](https://github.com/shardlab/discordrb/pull/26) thanks @swarley)
+- All API methods link to their official documentation counterparts ([#12](https://github.com/shardlab/discordrb/pull/12) thanks @kaine119)
+- Links to messages now work when a `guild_id` is not present in a non DM message. ([#27](https://github.com/shardlab/discordrb/pull/27) thanks @swarley)
+
 ## [3.4.0] - 2020-12-06
 [3.4.0]: https://github.com/shardlab/discordrb/releases/tag/v3.3.0
 

data/discordrb.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'rest-client', '>= 2.0.0'
   spec.add_dependency 'websocket-client-simple', '>= 0.3.0'
 
-  spec.add_dependency 'discordrb-webhooks', '~> 3.3.0'
+  spec.add_dependency 'discordrb-webhooks', '~> 3.4.3'
 
   spec.required_ruby_version = '>= 2.5'
 

data/lib/discordrb/api/channel.rb

@@ -331,6 +331,7 @@ module Discordrb::API::Channel
   end
 
   # Create an empty group channel.
+  # https://discord.com/developers/docs/resources/user#create-group-dm
   def create_empty_group(token, bot_user_id)
     Discordrb::API.request(
       :users_uid_channels,
@@ -344,6 +345,7 @@ module Discordrb::API::Channel
   end
 
   # Create a group channel.
+  # https://discord.com/developers/docs/resources/channel#group-dm-add-recipient
   def create_group(token, pm_channel_id, user_id)
     Discordrb::API.request(
       :channels_cid_recipients_uid,
@@ -363,6 +365,7 @@ module Discordrb::API::Channel
   end
 
   # Add a user to a group channel.
+  # https://discord.com/developers/docs/resources/channel#group-dm-add-recipient
   def add_group_user(token, group_channel_id, user_id)
     Discordrb::API.request(
       :channels_cid_recipients_uid,
@@ -376,6 +379,7 @@ module Discordrb::API::Channel
   end
 
   # Remove a user from a group channel.
+  # https://discord.com/developers/docs/resources/channel#group-dm-remove-recipient
   def remove_group_user(token, group_channel_id, user_id)
     Discordrb::API.request(
       :channels_cid_recipients_uid,
@@ -388,6 +392,7 @@ module Discordrb::API::Channel
   end
 
   # Leave a group channel.
+  # https://discord.com/developers/docs/resources/channel#deleteclose-channel
   def leave_group(token, group_channel_id)
     Discordrb::API.request(
       :channels_cid,

data/lib/discordrb/api/server.rb

@@ -46,6 +46,7 @@ module Discordrb::API::Server
   end
 
   # Transfer server ownership
+  # https://discord.com/developers/docs/resources/guild#modify-guild
   def transfer_ownership(token, server_id, user_id, reason = nil)
     Discordrb::API.request(
       :guilds_sid,
@@ -498,6 +499,7 @@ module Discordrb::API::Server
   end
 
   # Available voice regions for this server
+  # https://discord.com/developers/docs/resources/guild#get-guild-voice-regions
   def regions(token, server_id)
     Discordrb::API.request(
       :guilds_sid_regions,

data/lib/discordrb/api/user.rb

@@ -29,6 +29,7 @@ module Discordrb::API::User
   end
 
   # Change the current bot's nickname on a server
+  # https://discord.com/developers/docs/resources/user#modify-current-user
   def change_own_nickname(token, server_id, nick, reason = nil)
     Discordrb::API.request(
       :guilds_sid_members_me_nick,

data/lib/discordrb/api.rb

@@ -95,7 +95,7 @@ module Discordrb::API
     attributes.last[:user_agent] = user_agent if attributes.last.is_a? Hash
 
     # Specify RateLimit precision
-    attributes.last[:x_ratelimit_precision] = 'millisecond'
+    attributes.last[:x_ratelimit_precision] = 'millisecond' if attributes.last.is_a?(Hash)
 
     # The most recent Discord rate limit requirements require the support of major parameters, where a particular route
     # and major parameter combination (*not* the HTTP method) uniquely identifies a RL bucket.

data/lib/discordrb/bot.rb

@@ -385,11 +385,12 @@ module Discordrb
     # @param embed [Hash, Discordrb::Webhooks::Embed, nil] The rich embed to append to this message.
     # @param attachments [Array<File>] Files that can be referenced in embeds via `attachment://file.png`
     # @param allowed_mentions [Hash, Discordrb::AllowedMentions, false, nil] Mentions that are allowed to ping on this message. `false` disables all pings
-    def send_temporary_message(channel, content, timeout, tts = false, embed = nil, attachments = nil, allowed_mentions = nil)
+    # @param message_reference [Message, String, Integer, nil] The message, or message ID, to reply to if any.
+    def send_temporary_message(channel, content, timeout, tts = false, embed = nil, attachments = nil, allowed_mentions = nil, message_reference = nil)
       Thread.new do
         Thread.current[:discordrb_name] = "#{@current_thread}-temp-msg"
 
-        message = send_message(channel, content, tts, embed, attachments, allowed_mentions)
+        message = send_message(channel, content, tts, embed, attachments, allowed_mentions, message_reference)
         sleep(timeout)
         message.delete
       end
@@ -504,7 +505,8 @@ module Discordrb
     # @param url [String, nil] The Twitch URL to display as a stream. nil for no stream.
     # @param since [Integer] When this status was set.
     # @param afk [true, false] Whether the bot is AFK.
-    # @param activity_type [Integer] The type of activity status to display. Can be 0 (Playing), 1 (Streaming), 2 (Listening), 3 (Watching)
+    # @param activity_type [Integer] The type of activity status to display.
+    #   Can be 0 (Playing), 1 (Streaming), 2 (Listening), 3 (Watching), or 5 (Competing).
     # @see Gateway#send_status_update
     def update_status(status, activity, url, since = 0, afk = false, activity_type = 0)
       gateway_check
@@ -557,6 +559,14 @@ module Discordrb
       name
     end
 
+    # Sets the currently competing status to the specified name.
+    # @param name [String] The name of the game to be competing in.
+    # @return [String] The game that is being competed in now.
+    def competing=(name)
+      gateway_check
+      update_status(@status, name, nil, nil, nil, 5)
+    end
+
     # Sets status to online.
     def online
       gateway_check

data/lib/discordrb/commands/command_bot.rb

@@ -44,9 +44,10 @@ module Discordrb::Commands
     # @option attributes [Symbol, Array<Symbol>, false] :help_command The name of the command that displays info for
     #   other commands. Use an array if you want to have aliases. Default is "help". If none should be created, use
     #   `false` as the value.
-    # @option attributes [String] :command_doesnt_exist_message The message that should be displayed if a user attempts
+    # @option attributes [String, #call] :command_doesnt_exist_message The message that should be displayed if a user attempts
     #   to use a command that does not exist. If none is specified, no message will be displayed. In the message, you
-    #   can use the string '%command%' that will be replaced with the name of the command.
+    #   can use the string '%command%' that will be replaced with the name of the command. Anything responding to call
+    #   such as a proc will be called with the event, and is expected to return a String or nil.
     # @option attributes [String] :no_permission_message The message to be displayed when `NoPermission` error is raised.
     # @option attributes [true, false] :spaces_allowed Whether spaces are allowed to occur between the prefix and the
     #   command. Default is false.
@@ -217,7 +218,11 @@ module Discordrb::Commands
                     (command && !command.attributes[:channels].nil?)
 
       unless command
-        event.respond @attributes[:command_doesnt_exist_message].gsub('%command%', name.to_s) if @attributes[:command_doesnt_exist_message]
+        if @attributes[:command_doesnt_exist_message]
+          message = @attributes[:command_doesnt_exist_message]
+          message = message.call(event) if message.respond_to?(:call)
+          event.respond message.gsub('%command%', name.to_s) if message
+        end
         return
       end
       return unless !check_permissions || channels?(event.channel, command.attributes[:channels])

data/lib/discordrb/data/activity.rb

@@ -17,7 +17,7 @@ module Discordrb
     # @return [String] the activity's name
     attr_reader :name
 
-    # @return [Integer, nil] activity type. Can be {GAME}, {STREAMING}, {LISTENING}, {CUSTOM}
+    # @return [Integer, nil] activity type. Can be {GAME}, {STREAMING}, {LISTENING}, {CUSTOM}, or {COMPETING}
     attr_reader :type
 
     # @return [String, nil] stream URL, when the activity type is {STREAMING}
@@ -67,6 +67,8 @@ module Discordrb
     WATCHING = 3
     # Type indicating the activity is a custom status
     CUSTOM = 4
+    # Type indicating the activity is for a competitive game
+    COMPETING = 5
 
     # @!visibility private
     def initialize(data, bot)
@@ -260,5 +262,10 @@ module Discordrb
     def custom_status
       @activities.select { |act| act.type == Activity::CUSTOM }
     end
+
+    # @return [Array<Activity>] all activities of type {Activity::COMPETING}
+    def competing
+      @activities.select { |act| act.type == Activity::COMPETING }
+    end
   end
 end

data/lib/discordrb/data/invite.rb

@@ -87,7 +87,7 @@ module Discordrb
     def initialize(data, bot)
       @bot = bot
 
-      @channel = if data['channel_id'] || bot.channel
+      @channel = if data['channel_id']
                    bot.channel(data['channel_id'])
                  else
                    InviteChannel.new(data['channel'], bot)

data/lib/discordrb/data/message.rb

@@ -83,7 +83,7 @@ module Discordrb
       @referenced_message = Message.new(data['referenced_message'], bot) if data['referenced_message']
       @message_reference = data['message_reference']
 
-      @server = bot.server(data['guild_id'].to_i) if data['guild_id']
+      @server = @channel.server
 
       @author = if data['author']
                   if data['author']['discriminator'] == ZERO_DISCRIM

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.4.0'
+  VERSION = '3.4.3'
 end

data/lib/discordrb/voice/encoder.rb

@@ -77,7 +77,7 @@ module Discordrb::Voice
     # @param options [String] ffmpeg options to pass after the -i flag
     # @return [IO] the audio, encoded as s16le PCM
     def encode_file(file, options = '')
-      command = "#{ffmpeg_command} -loglevel 0 -i \"#{file}\" #{options} -f s16le -ar 48000 -ac 2 #{filter_volume_argument} pipe:1"
+      command = ffmpeg_command(input: file, options: options)
       IO.popen(command)
     end
 
@@ -87,14 +87,23 @@ module Discordrb::Voice
     # @param options [String] ffmpeg options to pass after the -i flag
     # @return [IO] the audio, encoded as s16le PCM
     def encode_io(io, options = '')
-      command = "#{ffmpeg_command} -loglevel 0 -i - #{options} -f s16le -ar 48000 -ac 2 #{filter_volume_argument} pipe:1"
+      command = ffmpeg_command(options: options)
       IO.popen(command, in: io)
     end
 
     private
 
-    def ffmpeg_command
-      @use_avconv ? 'avconv' : 'ffmpeg'
+    def ffmpeg_command(input: '-', options: null)
+      [
+        @use_avconv ? 'avconv' : 'ffmpeg',
+        '-loglevel', '0',
+        '-i', input,
+        '-f', 's16le',
+        '-ar', '48000',
+        '-ac', '2',
+        'pipe:1',
+        filter_volume_argument,
+      ].concat(options.split).reject {|segment| segment.nil? || segment == '' }
     end
 
     def filter_volume_argument

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: discordrb
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 3.4.3
 platform: ruby
 authors:
 - meew0
 - swarley
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-06 00:00:00.000000000 Z
+date: 2023-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -73,14 +73,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: 3.4.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: 3.4.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -321,7 +321,7 @@ licenses:
 - MIT
 metadata:
   changelog_uri: https://github.com/shardlab/discordrb/blob/master/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -336,8 +336,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: Discord API for Ruby
 test_files: []