discordrb 2.1.3 → 3.0.0

data/lib/discordrb/api/channel.rb

@@ -0,0 +1,306 @@
+# API calls for Channel
+module Discordrb::API::Channel
+  module_function
+
+  # Get a channel's data
+  # https://discordapp.com/developers/docs/resources/channel#get-channel
+  def resolve(token, channel_id)
+    Discordrb::API.request(
+      :channels_cid,
+      channel_id,
+      :get,
+      "#{Discordrb::API.api_base}/channels/#{channel_id}",
+      Authorization: token
+    )
+  end
+
+  # Update a channel's data
+  # https://discordapp.com/developers/docs/resources/channel#modify-channel
+  def update(token, channel_id, name, topic, position = 0)
+    Discordrb::API.request(
+      :channels_cid,
+      channel_id,
+      :patch,
+      "#{Discordrb::API.api_base}/channels/#{channel_id}",
+      { name: name, position: position, topic: topic }.to_json,
+      Authorization: token,
+      content_type: :json
+    )
+  end
+
+  # Delete a channel
+  # https://discordapp.com/developers/docs/resources/channel#deleteclose-channel
+  def delete(token, channel_id)
+    Discordrb::API.request(
+      :channels_cid,
+      channel_id,
+      :delete,
+      "#{Discordrb::API.api_base}/channels/#{channel_id}",
+      Authorization: token
+    )
+  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)
+    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}",
+      Authorization: token
+    )
+  end
+
+  # Get a single message from a channel's history by id
+  # https://discordapp.com/developers/docs/resources/channel#get-channel-message
+  def message(token, channel_id, message_id)
+    Discordrb::API.request(
+      :channels_cid_messages_mid,
+      channel_id,
+      :get,
+      "#{Discordrb::API.api_base}/channels/#{channel_id}/messages/#{message_id}",
+      Authorization: token
+    )
+  end
+
+  # 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, _server_id = 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 }.to_json,
+      Authorization: token,
+      content_type: :json
+    )
+  rescue RestClient::InternalServerError
+    raise Discordrb::Errors::MessageTooLong, "Message over the character limit (#{message.length} > 2000)"
+  end
+
+  # Send a file as a message to a channel
+  # https://discordapp.com/developers/docs/resources/channel#upload-file
+  def upload_file(token, channel_id, file, caption: nil, tts: false)
+    Discordrb::API.request(
+      :channels_cid_messages_mid,
+      channel_id,
+      :post,
+      "#{Discordrb::API.api_base}/channels/#{channel_id}/messages",
+      { file: file, content: caption, tts: tts },
+      Authorization: token
+    )
+  end
+
+  # Edit a message
+  # https://discordapp.com/developers/docs/resources/channel#edit-message
+  def edit_message(token, channel_id, message_id, message, mentions = [])
+    Discordrb::API.request(
+      :channels_cid_messages_mid,
+      channel_id,
+      :patch,
+      "#{Discordrb::API.api_base}/channels/#{channel_id}/messages/#{message_id}",
+      { content: message, mentions: mentions }.to_json,
+      Authorization: token,
+      content_type: :json
+    )
+  end
+
+  # Delete a message
+  # https://discordapp.com/developers/docs/resources/channel#delete-message
+  def delete_message(token, channel_id, message_id)
+    Discordrb::API.request(
+      :channels_cid_messages_mid,
+      channel_id,
+      :delete,
+      "#{Discordrb::API.api_base}/channels/#{channel_id}/messages/#{message_id}",
+      Authorization: token
+    )
+  end
+
+  # Delete messages in bulk
+  # https://discordapp.com/developers/docs/resources/channel#bulk-delete-messages
+  def bulk_delete_messages(token, channel_id, messages = [])
+    Discordrb::API.request(
+      :channels_cid_messages_bulk_delete,
+      channel_id,
+      :post,
+      "#{Discordrb::API.api_base}/channels/#{channel_id}/messages/bulk_delete",
+      { messages: messages }.to_json,
+      Authorization: token,
+      content_type: :json
+    )
+  end
+
+  # 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)
+    Discordrb::API.request(
+      :channels_cid_permissions_oid,
+      channel_id,
+      :put,
+      "#{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
+    )
+  end
+
+  # Get a channel's invite list
+  # https://discordapp.com/developers/docs/resources/channel#get-channel-invites
+  def invites(token, channel_id)
+    Discordrb::API.request(
+      :channels_cid_invites,
+      channel_id,
+      :get,
+      "#{Discordrb::API.api_base}/channels/#{channel_id}/invites",
+      Authorization: token
+    )
+  end
+
+  # 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)
+    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,
+      Authorization: token,
+      content_type: :json
+    )
+  end
+
+  # Delete channel permission
+  # https://discordapp.com/developers/docs/resources/channel#delete-channel-permission
+  def delete_permission(token, channel_id, overwrite_id)
+    Discordrb::API.request(
+      :channels_cid_permissions_oid,
+      channel_id,
+      :delete,
+      "#{Discordrb::API.api_base}/channels/#{channel_id}/permissions/#{overwrite_id}",
+      Authorization: token
+    )
+  end
+
+  # Start typing (needs to be resent every 5 seconds to keep up the typing)
+  # https://discordapp.com/developers/docs/resources/channel#trigger-typing-indicator
+  def start_typing(token, channel_id)
+    Discordrb::API.request(
+      :channels_cid_typing,
+      channel_id,
+      :post,
+      "#{Discordrb::API.api_base}/channels/#{channel_id}/typing",
+      nil,
+      Authorization: token
+    )
+  end
+
+  # Get a list of pinned messages in a channel
+  # https://discordapp.com/developers/docs/resources/channel#get-pinned-messages
+  def pinned_messages(token, channel_id)
+    Discordrb::API.request(
+      :channels_cid_pins,
+      channel_id,
+      :get,
+      "#{Discordrb::API.api_base}/channels/#{channel_id}/pins",
+      Authorization: token
+    )
+  end
+
+  # Pin a message
+  # https://discordapp.com/developers/docs/resources/channel#add-pinned-channel-message
+  def pin_message(token, channel_id, message_id)
+    Discordrb::API.request(
+      :channels_cid_pins_mid,
+      channel_id,
+      :put,
+      "#{Discordrb::API.api_base}/channels/#{channel_id}/pins/#{message_id}",
+      nil,
+      Authorization: token
+    )
+  end
+
+  # Unpin a message
+  # https://discordapp.com/developers/docs/resources/channel#delete-pinned-channel-message
+  def unpin_message(token, channel_id, message_id)
+    Discordrb::API.request(
+      :channels_cid_pins_mid,
+      channel_id,
+      :delete,
+      "#{Discordrb::API.api_base}/channels/#{channel_id}/pins/#{message_id}",
+      Authorization: token
+    )
+  end
+
+  # Create an empty group channel.
+  def create_empty_group(token, bot_user_id)
+    Discordrb::API.request(
+      :users_uid_channels,
+      nil,
+      :post,
+      "#{Discordrb::API.api_base}/users/#{bot_user_id}/channels",
+      {}.to_json,
+      Authorization: token,
+      content_type: :json
+    )
+  end
+
+  # Create a group channel.
+  def create_group(token, pm_channel_id, user_id)
+    Discordrb::API.request(
+      :channels_cid_recipients_uid,
+      nil,
+      :put,
+      "#{Discordrb::API.api_base}/channels/#{pm_channel_id}/recipients/#{user_id}",
+      {}.to_json,
+      Authorization: token,
+      content_type: :json
+    )
+  rescue RestClient::InternalServerError
+    raise 'Attempted to add self as a new group channel recipient!'
+  rescue RestClient::NoContent
+    raise 'Attempted to create a group channel with the PM channel recipient!'
+  rescue RestClient::Forbidden
+    raise 'Attempted to add a user to group channel without permission!'
+  end
+
+  # Add a user to a group channel.
+  def add_group_user(token, group_channel_id, user_id)
+    Discordrb::API.request(
+      :channels_cid_recipients_uid,
+      nil,
+      :put,
+      "#{Discordrb::API.api_base}/channels/#{group_channel_id}/recipients/#{user_id}",
+      {}.to_json,
+      Authorization: token,
+      content_type: :json
+    )
+  end
+
+  # Remove a user from a group channel.
+  def remove_group_user(token, group_channel_id, user_id)
+    Discordrb::API.request(
+      :channels_cid_recipients_uid,
+      nil,
+      :delete,
+      "#{Discordrb::API.api_base}/channels/#{group_channel_id}/recipients/#{user_id}",
+      Authorization: token,
+      content_type: :json
+    )
+  end
+
+  # Leave a group channel.
+  def leave_group(token, group_channel_id)
+    Discordrb::API.request(
+      :channels_cid,
+      nil,
+      :delete,
+      "#{Discordrb::API.api_base}/channels/#{group_channel_id}",
+      Authorization: token,
+      content_type: :json
+    )
+  end
+end

data/lib/discordrb/api/invite.rb

@@ -0,0 +1,41 @@
+# 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)
+    Discordrb::API.request(
+      :invite_code,
+      nil,
+      :get,
+      "#{Discordrb::API.api_base}/invite/#{invite_code}",
+      Authorization: token
+    )
+  end
+
+  # Delete an invite by code
+  # https://discordapp.com/developers/docs/resources/invite#delete-invite
+  def delete(token, code)
+    Discordrb::API.request(
+      :invites_code,
+      nil,
+      :delete,
+      "#{Discordrb::API.api_base}/invites/#{code}",
+      Authorization: token
+    )
+  end
+
+  # Join a server using an invite
+  # https://discordapp.com/developers/docs/resources/invite#accept-invite
+  def accept(token, invite_code)
+    Discordrb::API.request(
+      :invite_code,
+      nil,
+      :post,
+      "#{Discordrb::API.api_base}/invite/#{invite_code}",
+      nil,
+      Authorization: token
+    )
+  end
+end

data/lib/discordrb/api/server.rb

@@ -0,0 +1,357 @@
+# 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)
+    Discordrb::API.request(
+      :guilds,
+      nil,
+      :post,
+      "#{Discordrb::API.api_base}/guilds",
+      { name: name, region: region.to_s }.to_json,
+      Authorization: token,
+      content_type: :json
+    )
+  end
+
+  # Get a server's data
+  # https://discordapp.com/developers/docs/resources/guild#get-guild
+  def resolve(token, server_id)
+    Discordrb::API.request(
+      :guilds_sid,
+      server_id,
+      :get,
+      "#{Discordrb::API.api_base}/guilds/#{server_id}",
+      Authorization: token
+    )
+  end
+
+  # 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)
+    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,
+      Authorization: token,
+      content_type: :json
+    )
+  end
+
+  # Transfer server ownership
+  def transfer_ownership(token, server_id, user_id)
+    Discordrb::API.request(
+      :guilds_sid,
+      server_id,
+      :patch,
+      "#{Discordrb::API.api_base}/guilds/#{server_id}",
+      { owner_id: user_id }.to_json,
+      Authorization: token,
+      content_type: :json
+    )
+  end
+
+  # Delete a server
+  # https://discordapp.com/developers/docs/resources/guild#delete-guild
+  def delete(token, server_id)
+    Discordrb::API.request(
+      :guilds_sid,
+      server_id,
+      :delete,
+      "#{Discordrb::API.api_base}/guilds/#{server_id}",
+      Authorization: token
+    )
+  end
+
+  # Get a server's channels list
+  # https://discordapp.com/developers/docs/resources/guild#get-guild-channels
+  def channels(token, server_id)
+    Discordrb::API.request(
+      :guilds_sid_channels,
+      server_id,
+      :get,
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/channels",
+      Authorization: token
+    )
+  end
+
+  # Create a channel
+  # https://discordapp.com/developers/docs/resources/guild#create-guild-channel
+  def create_channel(token, server_id, name, type)
+    Discordrb::API.request(
+      :guilds_sid_channels,
+      server_id,
+      :post,
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/channels",
+      { name: name, type: type }.to_json,
+      Authorization: token,
+      content_type: :json
+    )
+  end
+
+  # Update a channels position
+  # https://discordapp.com/developers/docs/resources/guild#modify-guild-channel
+  def update_channel(token, server_id, channel_id, position)
+    Discordrb::API.request(
+      :guilds_sid_channels,
+      server_id,
+      :patch,
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/channels",
+      { id: channel_id, position: position }.to_json,
+      Authorization: token,
+      content_type: :json
+    )
+  end
+
+  # Get a member's data
+  # https://discordapp.com/developers/docs/resources/guild#get-guild-member
+  def resolve_member(token, server_id, user_id)
+    Discordrb::API.request(
+      :guilds_sid_members_uid,
+      server_id,
+      :get,
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/members/#{user_id}",
+      Authorization: token
+    )
+  end
+
+  # Gets members from the server
+  # https://discordapp.com/developers/docs/resources/guild#list-guild-members
+  def resolve_members(token, server_id, limit, after = nil)
+    Discordrb::API.request(
+      :guilds_sid_members,
+      server_id,
+      :get,
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/members?limit=#{limit}#{"&after=#{after}" if after}",
+      Authorization: token
+    )
+  end
+
+  # 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)
+    Discordrb::API.request(
+      :guilds_sid_members_uid,
+      server_id,
+      :patch,
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/members/#{user_id}", {
+        roles: roles,
+        nick: nick,
+        mute: mute,
+        deaf: deaf,
+        channel_id: channel_id
+      }.reject { |_, v| v.nil? }.to_json,
+      Authorization: token,
+      content_type: :json
+    )
+  end
+
+  # Remove user from server
+  # https://discordapp.com/developers/docs/resources/guild#remove-guild-member
+  def remove_member(token, server_id, user_id)
+    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
+    )
+  end
+
+  # Get a server's banned users
+  # https://discordapp.com/developers/docs/resources/guild#get-guild-bans
+  def bans(token, server_id)
+    Discordrb::API.request(
+      :guilds_sid_bans,
+      server_id,
+      :get,
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/bans",
+      Authorization: token
+    )
+  end
+
+  # 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)
+    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}",
+      nil,
+      Authorization: token
+    )
+  end
+
+  # Unban a user from a server
+  # https://discordapp.com/developers/docs/resources/guild#remove-guild-ban
+  def unban_user(token, server_id, user_id)
+    Discordrb::API.request(
+      :guilds_sid_bans_uid,
+      server_id,
+      :delete,
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/bans/#{user_id}",
+      Authorization: token
+    )
+  end
+
+  # Get server roles
+  # https://discordapp.com/developers/docs/resources/guild#get-guild-roles
+  def roles(token, server_id)
+    Discordrb::API.request(
+      :guilds_sid_roles,
+      server_id,
+      :get,
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/roles",
+      Authorization: token
+    )
+  end
+
+  # Create a role (parameters such as name and colour will have to be set by update_role afterwards)
+  # https://discordapp.com/developers/docs/resources/guild#get-guild-roles
+  def create_role(token, server_id)
+    Discordrb::API.request(
+      :guilds_sid_roles,
+      server_id,
+      :post,
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/roles",
+      nil,
+      Authorization: token
+    )
+  end
+
+  # Update a role
+  # 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#batch-modify-guild-role
+  def update_role(token, server_id, role_id, name, colour, hoist = false, mentionable = false, packed_permissions = 36_953_089)
+    Discordrb::API.request(
+      :guilds_sid_roles_rid,
+      server_id,
+      :patch,
+      "#{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
+    )
+  end
+
+  # Delete a role
+  # https://discordapp.com/developers/docs/resources/guild#delete-guild-role
+  def delete_role(token, server_id, role_id)
+    Discordrb::API.request(
+      :guilds_sid_roles_rid,
+      server_id,
+      :delete,
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/roles/#{role_id}",
+      Authorization: token
+    )
+  end
+
+  # Get server prune count
+  # https://discordapp.com/developers/docs/resources/guild#get-guild-prune-count
+  def prune_count(token, server_id)
+    Discordrb::API.request(
+      :guilds_sid_prune,
+      server_id,
+      :get,
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/prune",
+      Authorization: token
+    )
+  end
+
+  # Begin server prune
+  # https://discordapp.com/developers/docs/resources/guild#begin-guild-prune
+  def begin_prune(token, server_id, days)
+    Discordrb::API.request(
+      :guilds_sid_prune,
+      server_id,
+      :post,
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/prune",
+      { days: days },
+      Authorization: token
+    )
+  end
+
+  # Get invites from server
+  # https://discordapp.com/developers/docs/resources/guild#get-guild-invites
+  def invites(token, server_id)
+    Discordrb::API.request(
+      :guilds_sid_invites,
+      server_id,
+      :get,
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/invites",
+      Authorization: token
+    )
+  end
+
+  # Get server integrations
+  # https://discordapp.com/developers/docs/resources/guild#get-guild-integrations
+  def integrations(token, server_id)
+    Discordrb::API.request(
+      :guilds_sid_integrations,
+      server_id,
+      :get,
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/integrations",
+      Authorization: token
+    )
+  end
+
+  # Create a server integration
+  # https://discordapp.com/developers/docs/resources/guild#create-guild-integration
+  def create_integration(token, server_id, type, id)
+    Discordrb::API.request(
+      :guilds_sid_integrations,
+      server_id,
+      :post,
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/integrations",
+      { type: type, id: id },
+      Authorization: token
+    )
+  end
+
+  # Update integration from server
+  # https://discordapp.com/developers/docs/resources/guild#modify-guild-integration
+  def update_integration(token, server_id, integration_id, expire_behavior, expire_grace_period, enable_emoticons)
+    Discordrb::API.request(
+      :guilds_sid_integrations_iid,
+      server_id,
+      :patch,
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/integrations/#{integration_id}",
+      { expire_behavior: expire_behavior, expire_grace_period: expire_grace_period, enable_emoticons: enable_emoticons }.to_json,
+      Authorization: token,
+      content_type: :json
+    )
+  end
+
+  # Delete a server integration
+  # https://discordapp.com/developers/docs/resources/guild#delete-guild-integration
+  def delete_integration(token, server_id, integration_id)
+    Discordrb::API.request(
+      :guilds_sid_integrations_iid,
+      server_id,
+      :delete,
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/integrations/#{integration_id}",
+      Authorization: token
+    )
+  end
+
+  # Sync an integration
+  # https://discordapp.com/developers/docs/resources/guild#sync-guild-integration
+  def sync_integration(token, server_id, integration_id)
+    Discordrb::API.request(
+      :guilds_sid_integrations_iid_sync,
+      server_id,
+      :post,
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/integrations/#{integration_id}/sync",
+      nil,
+      Authorization: token
+    )
+  end
+end