discordrb 3.4.0 → 3.5.0

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-2020 meew0
+Copyright (c) 2015-2023 meew0
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,24 +1,25 @@
+# discordrb
+
 [![Gem](https://img.shields.io/gem/v/discordrb.svg)](https://rubygems.org/gems/discordrb)
 [![Gem](https://img.shields.io/gem/dt/discordrb.svg)](https://rubygems.org/gems/discordrb)
 [![CircleCI](https://circleci.com/gh/shardlab/discordrb.svg?style=svg)](https://circleci.com/gh/shardlab/discordrb)
-[![Inline docs](http://inch-ci.org/github/shardlab/discordrb.svg?branch=main)](http://inch-ci.org/github/shardlab/discordrb)
+[![Inline docs](https://inch-ci.org/github/shardlab/discordrb.svg?branch=main)](https://drb.shardlab.dev/v3.4.0/)
 [![Join Discord](https://img.shields.io/badge/discord-join-7289DA.svg)](https://discord.gg/cyK3Hjm)
-# discordrb
 
 An implementation of the [Discord](https://discord.com/) API using Ruby.
 
 ## Quick links to sections
 
-* [Introduction](https://github.com/shardlab/discordrb#introduction)
-* [Dependencies](https://github.com/shardlab/discordrb#dependencies)
-* [Installation](https://github.com/shardlab/discordrb#installation)
-* [Usage](https://github.com/shardlab/discordrb#usage)
-* [Webhooks Client](https://github.com/shardlab/discordrb#webhooks-client)
-* [Support](https://github.com/shardlab/discordrb#support)
-* [Development](https://github.com/shardlab/discordrb#development), [Contributing](https://github.com/shardlab/discordrb#contributing)
-* [License](https://github.com/shardlab/discordrb#license)
+- [Introduction](https://github.com/shardlab/discordrb#introduction)
+- [Dependencies](https://github.com/shardlab/discordrb#dependencies)
+- [Installation](https://github.com/shardlab/discordrb#installation)
+- [Usage](https://github.com/shardlab/discordrb#usage)
+- [Webhooks Client](https://github.com/shardlab/discordrb#webhooks-client)
+- [Support](https://github.com/shardlab/discordrb#support)
+- [Development](https://github.com/shardlab/discordrb#development), [Contributing](https://github.com/shardlab/discordrb#contributing)
+- [License](https://github.com/shardlab/discordrb#license)
 
-See also: [Documentation](https://www.rubydoc.info/gems/discordrb), [Tutorials](https://github.com/shardlab/discordrb/wiki)
+See also: [Documentation](https://drb.shardlab.dev/v3.4.0/), [Tutorials](https://github.com/shardlab/discordrb/wiki)
 
 ## Introduction
 
@@ -43,15 +44,16 @@ If you enjoy using the library, consider getting involved with the community to
 
 ## Dependencies
 
-* Ruby >= 2.5 supported
+* Ruby >= 2.7 supported
 * An installed build system for native extensions (on Windows, make sure you download the "Ruby+Devkit" version of [RubyInstaller](https://rubyinstaller.org/downloads/))
 
 ### Voice dependencies
 
 This section only applies to you if you want to use voice functionality.
-* [libsodium](https://github.com/shardlab/discordrb/wiki/Installing-libsodium)
-* A compiled libopus distribution for your system, anywhere the script can find it. See [here](https://github.com/shardlab/discordrb/wiki/Installing-libopus) for installation instructions.
-* [FFmpeg](https://www.ffmpeg.org/download.html) installed and in your PATH
+
+- [libsodium](https://github.com/shardlab/discordrb/wiki/Installing-libsodium)
+- A compiled libopus distribution for your system, anywhere the script can find it. See [here](https://github.com/shardlab/discordrb/wiki/Installing-libopus) for installation instructions.
+- [FFmpeg](https://www.ffmpeg.org/download.html) installed and in your PATH
 
 ## Installation
 
@@ -59,15 +61,19 @@ This section only applies to you if you want to use voice functionality.
 
 Using [Bundler](https://bundler.io/#getting-started), you can add discordrb to your Gemfile:
 
-    gem 'discordrb'
+```ruby
+gem 'discordrb'
+```
 
 And then install via `bundle install`.
 
-Run the [ping example](https://github.com/shardlab/discordrb/blob/master/examples/ping.rb) to verify that the installation works (make sure to replace the token and client ID in there with your bots'!):
+Run the [ping example](https://github.com/shardlab/discordrb/blob/main/examples/ping.rb) to verify that the installation works (make sure to replace the token and client ID in there with your bots'!):
 
 To run the bot while using bundler:
 
-    bundle exec ruby ping.rb
+```sh
+bundle exec ruby ping.rb
+```
 
 ### With Gem
 
@@ -75,21 +81,27 @@ Alternatively, while Bundler is the recommended option, you can also install dis
 
 #### Linux / macOS
 
-    gem install discordrb
+```sh
+gem install discordrb
+```
 
 #### Windows
 
 > **Make sure you have the DevKit installed! See the [Dependencies](https://github.com/shardlab/discordrb#dependencies) section)**
 
-    gem install discordrb --platform=ruby
+```sh
+gem install discordrb --platform=ruby
+```
 
 To run the bot:
 
-    ruby ping.rb
+```sh
+ruby ping.rb
+```
 
 ### Installation Troubleshooting
 
-See https://github.com/shardlab/discordrb/wiki/FAQ#installation for a list of common problems and solutions when installing `discordrb`.
+See <https://github.com/shardlab/discordrb/wiki/FAQ#installation> for a list of common problems and solutions when installing `discordrb`.
 
 ## Usage
 
@@ -109,7 +121,7 @@ bot.run
 
 This bot responds to every "Ping!" with a "Pong!".
 
-See [additional examples here](https://github.com/shardlab/discordrb/tree/master/examples).
+See [additional examples here](https://github.com/shardlab/discordrb/tree/main/examples).
 
 You can find examples of projects that use discordrb by [searching for the discordrb topic on GitHub](https://github.com/topics/discordrb).
 
@@ -119,7 +131,7 @@ If you've made an open source project on GitHub that uses discordrb, consider ad
 
 Also included is a webhooks client, which can be used as a separate gem `discordrb-webhooks`. This special client can be used to form requests to Discord webhook URLs in a high-level manner.
 
-- [`discordrb-webhooks` documentation](https://www.rubydoc.info/gems/discordrb-webhooks)
+- [`discordrb-webhooks` documentation](https://drb.shardlab.dev/v3.4.0/Discordrb/Webhooks.html)
 - [More information about webhooks](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks)
 - [Embed visualizer tool](https://leovoel.github.io/embed-visualizer/) - Includes a discordrb code generator for forming embeds
 
@@ -153,7 +165,7 @@ If you need help or have a question, you can:
 ## Contributing
 
 Thank you for your interest in contributing!
-Bug reports and pull requests are welcome on GitHub at https://github.com/shardlab/discordrb.
+Bug reports and pull requests are welcome on GitHub at <https://github.com/shardlab/discordrb>.
 
 In general, we recommend starting by discussing what you would like to contribute in the [Discord channel](https://discord.gg/cyK3Hjm).
 There are usually a handful of people working on things for the library, and what you're looking for may already be on the way.

data/discordrb-webhooks.gemspec

@@ -22,5 +22,8 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'rest-client', '>= 2.0.0'
 
-  spec.required_ruby_version = '>= 2.5'
+  spec.required_ruby_version = '>= 2.7'
+  spec.metadata = {
+    'rubygems_mfa_required' => 'true'
+  }
 end

data/discordrb.gemspec

@@ -19,7 +19,8 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.metadata = {
-    'changelog_uri' => 'https://github.com/shardlab/discordrb/blob/master/CHANGELOG.md'
+    'changelog_uri' => 'https://github.com/shardlab/discordrb/blob/main/CHANGELOG.md',
+    'rubygems_mfa_required' => 'true'
   }
   spec.require_paths = ['lib']
 
@@ -28,17 +29,19 @@ 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.5.0'
 
-  spec.required_ruby_version = '>= 2.5'
+  spec.required_ruby_version = '>= 2.7'
 
   spec.add_development_dependency 'bundler', '>= 1.10', '< 3'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'redcarpet', '~> 3.5.0' # YARD markdown formatting
-  spec.add_development_dependency 'rspec', '~> 3.10.0'
+  spec.add_development_dependency 'rspec', '~> 3.11.0'
+  spec.add_development_dependency 'rspec_junit_formatter', '~> 0.5.1'
   spec.add_development_dependency 'rspec-prof', '~> 0.0.7'
-  spec.add_development_dependency 'rubocop', '~> 1.4.0'
+  spec.add_development_dependency 'rubocop', '~> 1.36.0'
   spec.add_development_dependency 'rubocop-performance', '~> 1.0'
-  spec.add_development_dependency 'simplecov', '~> 0.19.0'
+  spec.add_development_dependency 'rubocop-rake', '~> 0.6.0'
+  spec.add_development_dependency 'simplecov', '~> 0.21.0'
   spec.add_development_dependency 'yard', '~> 0.9.9'
 end

data/lib/discordrb/api/application.rb

@@ -0,0 +1,202 @@
+# frozen_string_literal: true
+
+# API calls for slash commands.
+module Discordrb::API::Application
+  module_function
+
+  # Get a list of global application commands.
+  # https://discord.com/developers/docs/interactions/slash-commands#get-global-application-commands
+  def get_global_commands(token, application_id)
+    Discordrb::API.request(
+      :applications_aid_commands,
+      nil,
+      :get,
+      "#{Discordrb::API.api_base}/applications/#{application_id}/commands",
+      Authorization: token
+    )
+  end
+
+  # Get a global application command by ID.
+  # https://discord.com/developers/docs/interactions/slash-commands#get-global-application-command
+  def get_global_command(token, application_id, command_id)
+    Discordrb::API.request(
+      :applications_aid_commands_cid,
+      nil,
+      :get,
+      "#{Discordrb::API.api_base}/applications/#{application_id}/commands/#{command_id}",
+      Authorization: token
+    )
+  end
+
+  # Create a global application command.
+  # https://discord.com/developers/docs/interactions/slash-commands#create-global-application-command
+  def create_global_command(token, application_id, name, description, options = [], default_permission = nil, type = 1)
+    Discordrb::API.request(
+      :applications_aid_commands,
+      nil,
+      :post,
+      "#{Discordrb::API.api_base}/applications/#{application_id}/commands",
+      { name: name, description: description, options: options, default_permission: default_permission, type: type }.to_json,
+      Authorization: token,
+      content_type: :json
+    )
+  end
+
+  # Edit a global application command.
+  # https://discord.com/developers/docs/interactions/slash-commands#edit-global-application-command
+  def edit_global_command(token, application_id, command_id, name = nil, description = nil, options = nil, default_permission = nil, type = 1)
+    Discordrb::API.request(
+      :applications_aid_commands_cid,
+      nil,
+      :patch,
+      "#{Discordrb::API.api_base}/applications/#{application_id}/commands/#{command_id}",
+      { name: name, description: description, options: options, default_permission: default_permission, type: type }.compact.to_json,
+      Authorization: token,
+      content_type: :json
+    )
+  end
+
+  # Delete a global application command.
+  # https://discord.com/developers/docs/interactions/slash-commands#delete-global-application-command
+  def delete_global_command(token, application_id, command_id)
+    Discordrb::API.request(
+      :applications_aid_commands_cid,
+      nil,
+      :delete,
+      "#{Discordrb::API.api_base}/applications/#{application_id}/commands/#{command_id}",
+      Authorization: token
+    )
+  end
+
+  # Set global application commands in bulk.
+  # https://discord.com/developers/docs/interactions/slash-commands#bulk-overwrite-global-application-commands
+  def bulk_overwrite_global_commands(token, application_id, commands)
+    Discordrb::API.request(
+      :applications_aid_commands,
+      nil,
+      :put,
+      "#{Discordrb::API.api_base}/applications/#{application_id}/commands",
+      commands.to_json,
+      Authorization: token,
+      content_type: :json
+    )
+  end
+
+  # Get a guild's commands for an application.
+  # https://discord.com/developers/docs/interactions/slash-commands#get-guild-application-commands
+  def get_guild_commands(token, application_id, guild_id)
+    Discordrb::API.request(
+      :applications_aid_guilds_gid_commands,
+      guild_id,
+      :get,
+      "#{Discordrb::API.api_base}/applications/#{application_id}/guilds/#{guild_id}/commands",
+      Authorization: token
+    )
+  end
+
+  # Get a guild command by ID.
+  # https://discord.com/developers/docs/interactions/slash-commands#get-guild-application-command
+  def get_guild_command(token, application_id, guild_id, command_id)
+    Discordrb::API.request(
+      :applications_aid_guilds_gid_commands_cid,
+      guild_id,
+      :get,
+      "#{Discordrb::API.api_base}/applications/#{application_id}/guilds/#{guild_id}/commands/#{command_id}",
+      Authorization: token
+    )
+  end
+
+  # Create an application command for a guild.
+  # https://discord.com/developers/docs/interactions/slash-commands#create-guild-application-command
+  def create_guild_command(token, application_id, guild_id, name, description, options = nil, default_permission = nil, type = 1)
+    Discordrb::API.request(
+      :applications_aid_guilds_gid_commands,
+      guild_id,
+      :post,
+      "#{Discordrb::API.api_base}/applications/#{application_id}/guilds/#{guild_id}/commands",
+      { name: name, description: description, options: options, default_permission: default_permission, type: type }.to_json,
+      Authorization: token,
+      content_type: :json
+    )
+  end
+
+  # Edit an application command for a guild.
+  # https://discord.com/developers/docs/interactions/slash-commands#edit-guild-application-command
+  def edit_guild_command(token, application_id, guild_id, command_id, name = nil, description = nil, options = nil, default_permission = nil, type = 1)
+    Discordrb::API.request(
+      :applications_aid_guilds_gid_commands_cid,
+      guild_id,
+      :patch,
+      "#{Discordrb::API.api_base}/applications/#{application_id}/guilds/#{guild_id}/commands/#{command_id}",
+      { name: name, description: description, options: options, default_permission: default_permission, type: type }.compact.to_json,
+      Authorization: token,
+      content_type: :json
+    )
+  end
+
+  # Delete an application command for a guild.
+  # https://discord.com/developers/docs/interactions/slash-commands#delete-guild-application-command
+  def delete_guild_command(token, application_id, guild_id, command_id)
+    Discordrb::API.request(
+      :applications_aid_guilds_gid_commands_cid,
+      guild_id,
+      :delete,
+      "#{Discordrb::API.api_base}/applications/#{application_id}/guilds/#{guild_id}/commands/#{command_id}",
+      Authorization: token
+    )
+  end
+
+  # Set guild commands in bulk.
+  # https://discord.com/developers/docs/interactions/slash-commands#bulk-overwrite-guild-application-commands
+  def bulk_overwrite_guild_commands(token, application_id, guild_id, commands)
+    Discordrb::API.request(
+      :applications_aid_guilds_gid_commands,
+      guild_id,
+      :put,
+      "#{Discordrb::API.api_base}/applications/#{application_id}/guilds/#{guild_id}/commands",
+      commands.to_json,
+      Authorization: token,
+      content_type: :json
+    )
+  end
+
+  # Get the permissions for a specific guild command.
+  # https://discord.com/developers/docs/interactions/slash-commands#get-application-command-permissions
+  def get_guild_command_permissions(token, application_id, guild_id)
+    Discordrb::API.request(
+      :applications_aid_guilds_gid_commands_permissions,
+      guild_id,
+      :get,
+      "#{Discordrb::API.api_base}/applications/#{application_id}/guilds/#{guild_id}/commands/permissions",
+      Authorization: token
+    )
+  end
+
+  # Edit the permissions for a specific guild command.
+  # https://discord.com/developers/docs/interactions/slash-commands#edit-application-command-permissions
+  def edit_guild_command_permissions(token, application_id, guild_id, command_id, permissions)
+    Discordrb::API.request(
+      :applications_aid_guilds_gid_commands_cid_permissions,
+      guild_id,
+      :put,
+      "#{Discordrb::API.api_base}/applications/#{application_id}/guilds/#{guild_id}/commands/#{command_id}/permissions",
+      { permissions: permissions }.to_json,
+      Authorization: token,
+      content_type: :json
+    )
+  end
+
+  # Edit permissions for all commands in a guild.
+  # https://discord.com/developers/docs/interactions/slash-commands#batch-edit-application-command-permissions
+  def batch_edit_command_permissions(token, application_id, guild_id, permissions)
+    Discordrb::API.request(
+      :applications_aid_guilds_gid_commands_cid_permissions,
+      guild_id,
+      :put,
+      "#{Discordrb::API.api_base}/applications/#{application_id}/guilds/#{guild_id}/commands/permissions",
+      permissions.to_json,
+      Authorization: token,
+      content_type: :json
+    )
+  end
+end