discordrb 3.2.1 → 3.3.0

data/lib/discordrb/api/channel.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # API calls for Channel
 module Discordrb::API::Channel
   module_function
@@ -16,38 +18,42 @@ module Discordrb::API::Channel
 
   # Update a channel's data
   # https://discordapp.com/developers/docs/resources/channel#modify-channel
-  def update(token, channel_id, name, topic, position, bitrate, user_limit)
+  def update(token, channel_id, name, topic, position, bitrate, user_limit, nsfw, permission_overwrites = nil, parent_id = nil, rate_limit_per_user = nil, reason = nil)
+    data = { name: name, position: position, topic: topic, bitrate: bitrate, user_limit: user_limit, nsfw: nsfw, parent_id: parent_id, rate_limit_per_user: rate_limit_per_user }
+    data[:permission_overwrites] = permission_overwrites unless permission_overwrites.nil?
     Discordrb::API.request(
       :channels_cid,
       channel_id,
       :patch,
       "#{Discordrb::API.api_base}/channels/#{channel_id}",
-      { name: name, position: position, topic: topic, bitrate: bitrate, user_limit: user_limit }.to_json,
+      data.to_json,
       Authorization: token,
-      content_type: :json
+      content_type: :json,
+      'X-Audit-Log-Reason': reason
     )
   end
 
   # Delete a channel
   # https://discordapp.com/developers/docs/resources/channel#deleteclose-channel
-  def delete(token, channel_id)
+  def delete(token, channel_id, reason = nil)
     Discordrb::API.request(
       :channels_cid,
       channel_id,
       :delete,
       "#{Discordrb::API.api_base}/channels/#{channel_id}",
-      Authorization: token
+      Authorization: token,
+      'X-Audit-Log-Reason': reason
     )
   end
 
   # Get a list of messages from a channel's history
   # https://discordapp.com/developers/docs/resources/channel#get-channel-messages
-  def messages(token, channel_id, amount, before = nil, after = nil)
+  def messages(token, channel_id, amount, before = nil, after = nil, around = nil)
     Discordrb::API.request(
       :channels_cid_messages,
       channel_id,
       :get,
-      "#{Discordrb::API.api_base}/channels/#{channel_id}/messages?limit=#{amount}#{"&before=#{before}" if before}#{"&after=#{after}" if after}",
+      "#{Discordrb::API.api_base}/channels/#{channel_id}/messages?limit=#{amount}#{"&before=#{before}" if before}#{"&after=#{after}" if after}#{"&around=#{around}" if around}",
       Authorization: token
     )
   end
@@ -66,19 +72,19 @@ module Discordrb::API::Channel
 
   # Send a message to a channel
   # https://discordapp.com/developers/docs/resources/channel#create-message
-  def create_message(token, channel_id, message, mentions = [], tts = false, embed = nil) # send message
+  def create_message(token, channel_id, message, tts = false, embed = nil, nonce = nil) # send message
     Discordrb::API.request(
       :channels_cid_messages_mid,
       channel_id,
       :post,
       "#{Discordrb::API.api_base}/channels/#{channel_id}/messages",
-      { content: message, mentions: mentions, tts: tts, embed: embed }.to_json,
+      { content: message, tts: tts, embed: embed, nonce: nonce }.to_json,
       Authorization: token,
       content_type: :json
     )
   rescue RestClient::BadRequest => e
     parsed = JSON.parse(e.response.body)
-    raise Discordrb::Errors::MessageTooLong, "Message over the character limit (#{message.length} > 2000)" if parsed['content'] && parsed['content'].is_a?(Array) && parsed['content'].first == 'Must be 2000 or less characters long.'
+    raise Discordrb::Errors::MessageTooLong, "Message over the character limit (#{message.length} > 2000)" if parsed['content'] && parsed['content'].is_a?(Array) && parsed['content'].first == 'Must be 2000 or fewer in length.'
     raise
   end
 
@@ -203,7 +209,7 @@ module Discordrb::API::Channel
 
   # Update a channels permission for a role or member
   # https://discordapp.com/developers/docs/resources/channel#edit-channel-permissions
-  def update_permission(token, channel_id, overwrite_id, allow, deny, type)
+  def update_permission(token, channel_id, overwrite_id, allow, deny, type, reason = nil)
     Discordrb::API.request(
       :channels_cid_permissions_oid,
       channel_id,
@@ -211,7 +217,8 @@ module Discordrb::API::Channel
       "#{Discordrb::API.api_base}/channels/#{channel_id}/permissions/#{overwrite_id}",
       { type: type, id: overwrite_id, allow: allow, deny: deny }.to_json,
       Authorization: token,
-      content_type: :json
+      content_type: :json,
+      'X-Audit-Log-Reason': reason
     )
   end
 
@@ -229,27 +236,29 @@ module Discordrb::API::Channel
 
   # Create an instant invite from a server or a channel id
   # https://discordapp.com/developers/docs/resources/channel#create-channel-invite
-  def create_invite(token, channel_id, max_age = 0, max_uses = 0, temporary = false)
+  def create_invite(token, channel_id, max_age = 0, max_uses = 0, temporary = false, unique = false, reason = nil)
     Discordrb::API.request(
       :channels_cid_invites,
       channel_id,
       :post,
       "#{Discordrb::API.api_base}/channels/#{channel_id}/invites",
-      { max_age: max_age, max_uses: max_uses, temporary: temporary }.to_json,
+      { max_age: max_age, max_uses: max_uses, temporary: temporary, unique: unique }.to_json,
       Authorization: token,
-      content_type: :json
+      content_type: :json,
+      'X-Audit-Log-Reason': reason
     )
   end
 
   # Delete channel permission
   # https://discordapp.com/developers/docs/resources/channel#delete-channel-permission
-  def delete_permission(token, channel_id, overwrite_id)
+  def delete_permission(token, channel_id, overwrite_id, reason = nil)
     Discordrb::API.request(
       :channels_cid_permissions_oid,
       channel_id,
       :delete,
       "#{Discordrb::API.api_base}/channels/#{channel_id}/permissions/#{overwrite_id}",
-      Authorization: token
+      Authorization: token,
+      'X-Audit-Log-Reason': reason
     )
   end
 
@@ -371,4 +380,31 @@ module Discordrb::API::Channel
       content_type: :json
     )
   end
+
+  # Create a webhook
+  # https://discordapp.com/developers/docs/resources/webhook#create-webhook
+  def create_webhook(token, channel_id, name, avatar = nil, reason = nil)
+    Discordrb::API.request(
+      :channels_cid_webhooks,
+      channel_id,
+      :post,
+      "#{Discordrb::API.api_base}/channels/#{channel_id}/webhooks",
+      { name: name, avatar: avatar }.to_json,
+      Authorization: token,
+      content_type: :json,
+      'X-Audit-Log-Reason': reason
+    )
+  end
+
+  # Get channel webhooks
+  # https://discordapp.com/developers/docs/resources/webhook#get-channel-webhooks
+  def webhooks(token, channel_id)
+    Discordrb::API.request(
+      :channels_cid_webhooks,
+      channel_id,
+      :get,
+      "#{Discordrb::API.api_base}/channels/#{channel_id}/webhooks",
+      Authorization: token
+    )
+  end
 end

data/lib/discordrb/api/invite.rb

@@ -1,28 +1,31 @@
+# frozen_string_literal: true
+
 # API calls for Invite object
 module Discordrb::API::Invite
   module_function
 
   # Resolve an invite
   # https://discordapp.com/developers/docs/resources/invite#get-invite
-  def resolve(token, invite_code)
+  def resolve(token, invite_code, counts = true)
     Discordrb::API.request(
       :invite_code,
       nil,
       :get,
-      "#{Discordrb::API.api_base}/invite/#{invite_code}",
+      "#{Discordrb::API.api_base}/invite/#{invite_code}#{counts ? '?with_counts=true' : ''}",
       Authorization: token
     )
   end
 
   # Delete an invite by code
   # https://discordapp.com/developers/docs/resources/invite#delete-invite
-  def delete(token, code)
+  def delete(token, code, reason = nil)
     Discordrb::API.request(
       :invites_code,
       nil,
       :delete,
       "#{Discordrb::API.api_base}/invites/#{code}",
-      Authorization: token
+      Authorization: token,
+      'X-Audit-Log-Reason': reason
     )
   end
 

data/lib/discordrb/api/server.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 # API calls for Server
 module Discordrb::API::Server
   module_function
 
   # Create a server
   # https://discordapp.com/developers/docs/resources/guild#create-guild
-  def create(token, name, region = :london)
+  def create(token, name, region = :'eu-central')
     Discordrb::API.request(
       :guilds,
       nil,
@@ -30,20 +32,21 @@ module Discordrb::API::Server
 
   # Update a server
   # https://discordapp.com/developers/docs/resources/guild#modify-guild
-  def update(token, server_id, name, region, icon, afk_channel_id, afk_timeout)
+  def update(token, server_id, name, region, icon, afk_channel_id, afk_timeout, splash, default_message_notifications, verification_level, explicit_content_filter, system_channel_id, reason = nil)
     Discordrb::API.request(
       :guilds_sid,
       server_id,
       :patch,
       "#{Discordrb::API.api_base}/guilds/#{server_id}",
-      { name: name, region: region, icon: icon, afk_channel_id: afk_channel_id, afk_timeout: afk_timeout }.to_json,
+      { name: name, region: region, icon: icon, afk_channel_id: afk_channel_id, afk_timeout: afk_timeout, splash: splash, default_message_notifications: default_message_notifications, verification_level: verification_level, explicit_content_filter: explicit_content_filter, system_channel_id: system_channel_id }.to_json,
       Authorization: token,
-      content_type: :json
+      content_type: :json,
+      'X-Audit-Log-Reason': reason
     )
   end
 
   # Transfer server ownership
-  def transfer_ownership(token, server_id, user_id)
+  def transfer_ownership(token, server_id, user_id, reason = nil)
     Discordrb::API.request(
       :guilds_sid,
       server_id,
@@ -51,7 +54,8 @@ module Discordrb::API::Server
       "#{Discordrb::API.api_base}/guilds/#{server_id}",
       { owner_id: user_id }.to_json,
       Authorization: token,
-      content_type: :json
+      content_type: :json,
+      'X-Audit-Log-Reason': reason
     )
   end
 
@@ -81,27 +85,28 @@ module Discordrb::API::Server
 
   # Create a channel
   # https://discordapp.com/developers/docs/resources/guild#create-guild-channel
-  def create_channel(token, server_id, name, type)
+  def create_channel(token, server_id, name, type, topic, bitrate, user_limit, permission_overwrites, parent_id, nsfw, rate_limit_per_user, reason = nil)
     Discordrb::API.request(
       :guilds_sid_channels,
       server_id,
       :post,
       "#{Discordrb::API.api_base}/guilds/#{server_id}/channels",
-      { name: name, type: type }.to_json,
+      { name: name, type: type, topic: topic, bitrate: bitrate, user_limit: user_limit, permission_overwrites: permission_overwrites, parent_id: parent_id, nsfw: nsfw, rate_limit_per_user: rate_limit_per_user }.to_json,
       Authorization: token,
-      content_type: :json
+      content_type: :json,
+      'X-Audit-Log-Reason': reason
     )
   end
 
   # Update a channels position
-  # https://discordapp.com/developers/docs/resources/guild#modify-guild-channel
-  def update_channel(token, server_id, channel_id, position)
+  # https://discordapp.com/developers/docs/resources/guild#modify-guild-channel-positions
+  def update_channel_positions(token, server_id, positions)
     Discordrb::API.request(
       :guilds_sid_channels,
       server_id,
       :patch,
       "#{Discordrb::API.api_base}/guilds/#{server_id}/channels",
-      { id: channel_id, position: position }.to_json,
+      positions.to_json,
       Authorization: token,
       content_type: :json
     )
@@ -133,7 +138,7 @@ module Discordrb::API::Server
 
   # Update a user properties
   # https://discordapp.com/developers/docs/resources/guild#modify-guild-member
-  def update_member(token, server_id, user_id, nick: nil, roles: nil, mute: nil, deaf: nil, channel_id: nil)
+  def update_member(token, server_id, user_id, nick: nil, roles: nil, mute: nil, deaf: nil, channel_id: nil, reason: nil)
     Discordrb::API.request(
       :guilds_sid_members_uid,
       server_id,
@@ -146,20 +151,22 @@ module Discordrb::API::Server
         channel_id: channel_id
       }.reject { |_, v| v.nil? }.to_json,
       Authorization: token,
-      content_type: :json
+      content_type: :json,
+      'X-Audit-Log-Reason': reason
     )
   end
 
   # Remove user from server
   # https://discordapp.com/developers/docs/resources/guild#remove-guild-member
-  def remove_member(token, server_id, user_id)
+  def remove_member(token, server_id, user_id, reason = nil)
     Discordrb::API.request(
       :guilds_sid_members_uid,
       server_id,
       :delete,
       "#{Discordrb::API.api_base}/guilds/#{server_id}/members/#{user_id}",
       Authorization: token,
-      content_type: :json
+      content_type: :json,
+      'X-Audit-Log-Reason': reason
     )
   end
 
@@ -177,12 +184,13 @@ module Discordrb::API::Server
 
   # Ban a user from a server and delete their messages from the last message_days days
   # https://discordapp.com/developers/docs/resources/guild#create-guild-ban
-  def ban_user(token, server_id, user_id, message_days)
+  def ban_user(token, server_id, user_id, message_days, reason = nil)
+    reason = URI.encode(reason) if reason
     Discordrb::API.request(
       :guilds_sid_bans_uid,
       server_id,
       :put,
-      "#{Discordrb::API.api_base}/guilds/#{server_id}/bans/#{user_id}?delete-message-days=#{message_days}",
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/bans/#{user_id}?delete-message-days=#{message_days}&reason=#{reason}",
       nil,
       Authorization: token
     )
@@ -190,13 +198,14 @@ module Discordrb::API::Server
 
   # Unban a user from a server
   # https://discordapp.com/developers/docs/resources/guild#remove-guild-ban
-  def unban_user(token, server_id, user_id)
+  def unban_user(token, server_id, user_id, reason = nil)
     Discordrb::API.request(
       :guilds_sid_bans_uid,
       server_id,
       :delete,
       "#{Discordrb::API.api_base}/guilds/#{server_id}/bans/#{user_id}",
-      Authorization: token
+      Authorization: token,
+      'X-Audit-Log-Reason': reason
     )
   end
 
@@ -212,16 +221,21 @@ module Discordrb::API::Server
     )
   end
 
-  # Create a role (parameters such as name and colour will have to be set by update_role afterwards)
+  # Create a role (parameters such as name and colour if not set can be set by update_role afterwards)
+  # Permissions are the Discord defaults; allowed: invite creation, reading/sending messages,
+  # sending TTS messages, embedding links, sending files, reading the history, mentioning everybody,
+  # connecting to voice, speaking and voice activity (push-to-talk isn't mandatory)
   # https://discordapp.com/developers/docs/resources/guild#get-guild-roles
-  def create_role(token, server_id)
+  def create_role(token, server_id, name, colour, hoist, mentionable, packed_permissions, reason = nil)
     Discordrb::API.request(
       :guilds_sid_roles,
       server_id,
       :post,
       "#{Discordrb::API.api_base}/guilds/#{server_id}/roles",
-      nil,
-      Authorization: token
+      { color: colour, name: name, hoist: hoist, mentionable: mentionable, permissions: packed_permissions }.to_json,
+      Authorization: token,
+      content_type: :json,
+      'X-Audit-Log-Reason': reason
     )
   end
 
@@ -230,7 +244,7 @@ module Discordrb::API::Server
   # sending TTS messages, embedding links, sending files, reading the history, mentioning everybody,
   # connecting to voice, speaking and voice activity (push-to-talk isn't mandatory)
   # https://discordapp.com/developers/docs/resources/guild#batch-modify-guild-role
-  def update_role(token, server_id, role_id, name, colour, hoist = false, mentionable = false, packed_permissions = 36_953_089)
+  def update_role(token, server_id, role_id, name, colour, hoist = false, mentionable = false, packed_permissions = 104_324_161, reason = nil)
     Discordrb::API.request(
       :guilds_sid_roles_rid,
       server_id,
@@ -238,44 +252,88 @@ module Discordrb::API::Server
       "#{Discordrb::API.api_base}/guilds/#{server_id}/roles/#{role_id}",
       { color: colour, name: name, hoist: hoist, mentionable: mentionable, permissions: packed_permissions }.to_json,
       Authorization: token,
+      content_type: :json,
+      'X-Audit-Log-Reason': reason
+    )
+  end
+
+  # Update role positions
+  # https://discordapp.com/developers/docs/resources/guild#modify-guild-role-positions
+  def update_role_positions(token, server_id, roles)
+    Discordrb::API.request(
+      :guilds_sid_roles,
+      server_id,
+      :patch,
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/roles",
+      roles.to_json,
+      Authorization: token,
       content_type: :json
     )
   end
 
   # Delete a role
   # https://discordapp.com/developers/docs/resources/guild#delete-guild-role
-  def delete_role(token, server_id, role_id)
+  def delete_role(token, server_id, role_id, reason = nil)
     Discordrb::API.request(
       :guilds_sid_roles_rid,
       server_id,
       :delete,
       "#{Discordrb::API.api_base}/guilds/#{server_id}/roles/#{role_id}",
-      Authorization: token
+      Authorization: token,
+      'X-Audit-Log-Reason': reason
+    )
+  end
+
+  # Adds a single role to a member
+  # https://discordapp.com/developers/docs/resources/guild#add-guild-member-role
+  def add_member_role(token, server_id, user_id, role_id, reason = nil)
+    Discordrb::API.request(
+      :guilds_sid_members_uid_roles_rid,
+      server_id,
+      :put,
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/members/#{user_id}/roles/#{role_id}",
+      nil,
+      Authorization: token,
+      'X-Audit-Log-Reason': reason
+    )
+  end
+
+  # Removes a single role from a member
+  # https://discordapp.com/developers/docs/resources/guild#remove-guild-member-role
+  def remove_member_role(token, server_id, user_id, role_id, reason = nil)
+    Discordrb::API.request(
+      :guilds_sid_members_uid_roles_rid,
+      server_id,
+      :delete,
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/members/#{user_id}/roles/#{role_id}",
+      Authorization: token,
+      'X-Audit-Log-Reason': reason
     )
   end
 
   # Get server prune count
   # https://discordapp.com/developers/docs/resources/guild#get-guild-prune-count
-  def prune_count(token, server_id)
+  def prune_count(token, server_id, days)
     Discordrb::API.request(
       :guilds_sid_prune,
       server_id,
       :get,
-      "#{Discordrb::API.api_base}/guilds/#{server_id}/prune",
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/prune?days=#{days}",
       Authorization: token
     )
   end
 
   # Begin server prune
   # https://discordapp.com/developers/docs/resources/guild#begin-guild-prune
-  def begin_prune(token, server_id, days)
+  def begin_prune(token, server_id, days, reason = nil)
     Discordrb::API.request(
       :guilds_sid_prune,
       server_id,
       :post,
       "#{Discordrb::API.api_base}/guilds/#{server_id}/prune",
       { days: days },
-      Authorization: token
+      Authorization: token,
+      'X-Audit-Log-Reason': reason
     )
   end
 
@@ -291,6 +349,18 @@ module Discordrb::API::Server
     )
   end
 
+  # Gets a server's audit logs
+  # https://discordapp.com/developers/docs/resources/audit-log#get-guild-audit-log
+  def audit_logs(token, server_id, limit, userid = nil, actiontype = nil, before = nil)
+    Discordrb::API.request(
+      :guilds_sid_auditlogs,
+      server_id,
+      :get,
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/audit-logs?limit=#{limit}#{"&user_id=#{userid}" if userid}#{"&action_type=#{actiontype}" if actiontype}#{"&before=#{before}" if before}",
+      Authorization: token
+    )
+  end
+
   # Get server integrations
   # https://discordapp.com/developers/docs/resources/guild#get-guild-integrations
   def integrations(token, server_id)
@@ -355,8 +425,35 @@ module Discordrb::API::Server
     )
   end
 
+  # Retrieves a server's embed information
+  # https://discordapp.com/developers/docs/resources/guild#get-guild-embed
+  def embed(token, server_id)
+    Discordrb::API.request(
+      :guilds_sid_embed,
+      server_id,
+      :get,
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/embed",
+      Authorization: token
+    )
+  end
+
+  # Modify a server's embed settings
+  # https://discordapp.com/developers/docs/resources/guild#modify-guild-embed
+  def modify_embed(token, server_id, enabled, channel_id, reason = nil)
+    Discordrb::API.request(
+      :guilds_sid_embed,
+      server_id,
+      :patch,
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/embed",
+      { enabled: enabled, channel_id: channel_id }.to_json,
+      Authorization: token,
+      'X-Audit-Log-Reason': reason,
+      content_type: :json
+    )
+  end
+
   # Adds a custom emoji
-  def add_emoji(token, server_id, image, name)
+  def add_emoji(token, server_id, image, name, reason = nil)
     Discordrb::API.request(
       :guilds_sid_emojis,
       server_id,
@@ -364,12 +461,13 @@ module Discordrb::API::Server
       "#{Discordrb::API.api_base}/guilds/#{server_id}/emojis",
       { image: image, name: name }.to_json,
       Authorization: token,
-      content_type: :json
+      content_type: :json,
+      'X-Audit-Log-Reason': reason
     )
   end
 
   # Changes an emoji name
-  def edit_emoji(token, server_id, emoji_id, name)
+  def edit_emoji(token, server_id, emoji_id, name, reason = nil)
     Discordrb::API.request(
       :guilds_sid_emojis_eid,
       server_id,
@@ -377,17 +475,56 @@ module Discordrb::API::Server
       "#{Discordrb::API.api_base}/guilds/#{server_id}/emojis/#{emoji_id}",
       { name: name }.to_json,
       Authorization: token,
-      content_type: :json
+      content_type: :json,
+      'X-Audit-Log-Reason': reason
     )
   end
 
   # Deletes a custom emoji
-  def delete_emoji(token, server_id, emoji_id)
+  def delete_emoji(token, server_id, emoji_id, reason = nil)
     Discordrb::API.request(
       :guilds_sid_emojis_eid,
       server_id,
       :delete,
       "#{Discordrb::API.api_base}/guilds/#{server_id}/emojis/#{emoji_id}",
+      Authorization: token,
+      'X-Audit-Log-Reason': reason
+    )
+  end
+
+  # Available voice regions for this server
+  def regions(token, server_id)
+    Discordrb::API.request(
+      :guilds_sid_regions,
+      server_id,
+      :get,
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/regions",
+      Authorization: token
+    )
+  end
+
+  # Get server webhooks
+  # https://discordapp.com/developers/docs/resources/webhook#get-guild-webhooks
+  def webhooks(token, server_id)
+    Discordrb::API.request(
+      :guilds_sid_webhooks,
+      server_id,
+      :get,
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/webhooks",
+      Authorization: token
+    )
+  end
+
+  # Adds a member to a server with an OAuth2 Bearer token that has been granted `guilds.join`
+  # https://discordapp.com/developers/docs/resources/guild#add-guild-member
+  def add_member(token, server_id, user_id, access_token, nick = nil, roles = [], mute = false, deaf = false)
+    Discordrb::API.request(
+      :guilds_sid_members_uid,
+      server_id,
+      :put,
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/members/#{user_id}",
+      { access_token: access_token, nick: nick, roles: roles, mute: mute, deaf: deaf }.to_json,
+      content_type: :json,
       Authorization: token
     )
   end