discordrb 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c01b23a0f26aef256c77bec16db1cc3526d3f7b
-  data.tar.gz: 53240d527a39b8d49d8bb684af53ed168c0a7ba5
+  metadata.gz: bef7f70f8f9ba4e684a19ddd8545909f1e81b609
+  data.tar.gz: 6d8691f3e57f0bff79958ae09cf61aa1b23d6eca
 SHA512:
-  metadata.gz: a5fef38890173193ba99fa598b875f8fb6fb738676ee25d2d5d79cee32b7783099d95c566d9c497f9036e15c3d72f92bed72b3ed4e4cd995f698738071fe6389
-  data.tar.gz: 043e53d22977fb1ded5d8c32c45974a61e5a77f69f68c0d1eb7120f9dceb4820cb66e29c1672f86bb241e16d39781b11435ec98832c91d5e34193f2dcea669b6
+  metadata.gz: e18a5a8ccd4f31162d5407e69061dace62500b5a620140c7354f325978c61d9a2298d2e9312f855f7ea468f967a93919f55f9c72477357460d17f40932640da4
+  data.tar.gz: 0579638f1f91114752bdaca6afdc2465add207ad7bca65d13c90a38f7da6681ce9a08ece963298304180f4a6dcf05ddb6af512285eb5045571348be31c578139

data/lib/discordrb/api.rb

@@ -0,0 +1,271 @@
+require 'rest-client'
+require 'json'
+
+module Discordrb::API
+  APIBASE = 'https://discordapp.com/api'
+  module_function
+
+  # Ban a user from a server and delete their messages from the last message_days days
+  def ban_user(token, server_id, user_id, message_days)
+    RestClient.put(
+      "#{APIBASE}/guilds/#{server_id}/bans/#{user_id}?delete-message-days=#{message_days}",
+      Authorization: token
+    )
+  end
+
+  # Get a server's banned users
+  def bans(token, server_id)
+    RestClient.get(
+      "#{APIBASE}/guilds/#{server_id}/bans",
+      Authorization: token
+    )
+  end
+
+  # Login to the server
+  def login(email, password)
+    RestClient.post(
+      "#{APIBASE}/auth/login",
+      email: email,
+      password: password
+    )
+  end
+
+  # Logout from the server
+  def logout(token)
+    RestClient.post(
+      "#{APIBASE}/auth/logout",
+      Authorization: token
+    )
+  end
+
+  # Create a server
+  def create_server(token, name, region)
+    RestClient.post(
+      "#{APIBASE}/guilds",
+      { 'name' => name, 'region' => region }.to_json,
+      Authorization: token,
+      content_type: :json
+    )
+  end
+
+  # Leave a server
+  def leave_server(server_id)
+    RestClient.delete(
+      "#{APIBASE}/guilds/#{server_id}",
+      Authorization: token
+    )
+  end
+
+  # Get a channel's data
+  def channel(token, channel_id)
+    RestClient.get(
+      "#{APIBASE}/channels/#{channel_id}",
+      Authorization: token
+    )
+  end
+
+  # Create a channel
+  def create_channel(token, server_id, name, type)
+    RestClient.post(
+      "#{APIBASE}/guilds/#{server_id}/channels",
+      { 'name' => name, 'type' => type }.to_json,
+      Authorization: token,
+      content_type: :json
+    )
+  end
+
+  # Update a channel's data
+  def update_channel(token, channel_id, name, topic, position = 0)
+    RestClient.patch(
+      "#{APIBASE}/channels/#{channel_id}",
+      { 'name' => name, 'position' => position, 'topic' => topic }.to_json,
+      Authorization: token,
+      content_type: :json
+    )
+  end
+
+  # Delete a channel
+  def delete_channel(token, channel_id)
+    RestClient.delete(
+      "#{APIBASE}/channels/#{channel_id}",
+      Authorization: token
+    )
+  end
+
+  # Join a server using an invite
+  def join_server(token, invite_id)
+    RestClient.post(
+      "#{APIBASE}/invite/#{invite_id}",
+      Authorization: token
+    )
+  end
+
+  # Create a private channel
+  def create_private(token, bot_user_id, user_id)
+    RestClient.post(
+      "#{APIBASE}/users/#{bot_user_id}/channels",
+      { 'recipient_id' => user_id }.to_json,
+      Authorization: token,
+      content_type: :json
+    )
+  end
+
+  # Create an instant invite from a server or a channel id
+  def create_invite(token, id, max_age = 0, max_uses = 0, temporary = false, xkcd = false)
+    RestClient.post(
+      "#{APIBASE}/channels/#{id}/invites",
+      { 'max_age' => max_age, 'max_uses' => max_uses, 'temporary' => temporary, 'xkcdpass' => xkcd }.to_json,
+      Authorization: token,
+      content_type: :json
+    )
+  end
+
+  # Send a message to a channel
+  def send_message(token, channel_id, message, mentions = [], tts = false)
+    RestClient.post(
+      "#{APIBASE}/channels/#{channel_id}/messages",
+      { 'content' => message, 'mentions' => mentions, tts => tts }.to_json,
+      Authorization: token,
+      content_type: :json
+    )
+  end
+
+  # Delete a message
+  def delete_message(token, channel_id, message_id)
+    RestClient.delete(
+      "#{APIBASE}/channels/#{channel_id}/messages/#{message_id}",
+      Authorization: token
+    )
+  end
+
+  # Edit a message
+  def edit_message(token, channel_id, message, mentions = [])
+    RestClient.patch(
+      "#{APIBASE}/channels/#{channel_id}/messages",
+      { 'content' => message, 'mentions' => mentions }.to_json,
+      Authorization: token,
+      content_type: :json
+    )
+  end
+
+  # Acknowledge that a message has been received
+  # The last acknowledged message will be sent in the ready packet,
+  # so this is an easy way to catch up on messages
+  def acknowledge_message(token, channel_id, message_id)
+    RestClient.post(
+      "#{APIBASE}/channels/#{channel_id}/messages/#{message_id}/ack",
+      Authorization: token
+    )
+  end
+
+  # Send a file as a message to a channel
+  def send_file(token, channel_id, file, filename = 'filename')
+    RestClient.post(
+      "#{APIBASE}/channels/#{channel_id}/messages",
+      (filename.to_sym) => file,
+      Authorization: token
+    )
+  end
+
+  # Create a role (parameters such as name and colour will have to be set by update_role afterwards)
+  def create_role(token, server_id)
+    RestClient.post(
+      "#{APIBASE}/guilds/#{server_id}/roles",
+      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)
+  def update_role(token, server_id, role_id, name, colour, hoist = false, packed_permissions = 36953089)
+    RestClient.patch(
+      "#{APIBASE}/guilds/#{server_id}/roles/#{role_id}",
+      { 'color' => colour, 'name' => name, 'hoist' => hoist, 'permissions' => packed_permissions }.to_json,
+      Authorization: token,
+      content_type: :json
+    )
+  end
+
+  # Delete a role
+  def delete_role(token, server_id, role_id)
+    RestClient.delete(
+      "#{APIBASE}/guilds/#{server_id}/roles/#{role_id}",
+      Authorization: token
+    )
+  end
+
+  # Update a user's roles
+  def update_user_roles(token, server_id, user_id, roles)
+    RestClient.patch(
+      "#{APIBASE}/guilds/#{server_id}/members/#{user_id}",
+      { 'roles' => roles }.to_json,
+      Authorization: token,
+      content_type: :json
+    )
+  end
+
+  # Update a user's permission overrides in a channel
+  def update_user_overrides(token, channel_id, user_id, allow, deny)
+    RestClient.put(
+      "#{APIBASE}/channels/#{channel_id}/permissions/#{user_id}",
+      { 'type' => 'member', 'id' => user_id, 'allow' => allow, 'deny' => deny }.to_json,
+      Authorization: token,
+      content_type: :json
+    )
+  end
+
+  # Update a role's permission overrides in a channel
+  def update_role_overrides(token, channel_id, role_id, allow, deny)
+    RestClient.put(
+      "#{APIBASE}/channels/#{channel_id}/permissions/#{role_id}",
+      { 'type' => 'role', 'id' => role_id, 'allow' => allow, 'deny' => deny }.to_json,
+      Authorization: token,
+      content_type: :json
+    )
+  end
+
+  # Get the gateway to be used
+  def gateway(token)
+    RestClient.get(
+      "#{APIBASE}/gateway",
+      Authorization: token
+    )
+  end
+
+  # Start typing (needs to be resent every 5 seconds to keep up the typing)
+  def start_typing(token, channel_id)
+    RestClient.post(
+      "#{APIBASE}/channels/#{channel_id}/typing",
+      Authorization: token
+    )
+  end
+
+  # Get user data
+  def user(token, user_id)
+    RestClient.get(
+      "#{APIBASE}/users/#{user_id}",
+      Authorization: token
+    )
+  end
+
+  # Update user data
+  def update_user(token, email, password, new_username, avatar, new_password = nil)
+    RestClient.patch(
+      "#{APIBASE}/users/@me",
+      { 'avatar' => avatar, 'email' => email, 'new_password' => new_password, 'password' => password, 'username' => new_username }.to_json,
+      Authorization: token,
+      content_type: :json
+    )
+  end
+
+  # Get a list of messages from a channel's history
+  def channel_log(token, channel_id, amount, before = nil, after = nil)
+    RestClient.get(
+      "#{APIBASE}/channels/#{channel_id}/messages?limit=#{amount}#{"&before=#{before}" if before}#{"&after=#{after}" if after}",
+      Authorization: token
+    )
+  end
+
+end

data/lib/discordrb/bot.rb

@@ -17,12 +17,17 @@ require 'discordrb/events/guild-role-create'
 require 'discordrb/events/guild-role-delete'
 require 'discordrb/events/guild-role-update'
 
+require 'discordrb/api'
+
 require 'discordrb/exceptions'
 require 'discordrb/data'
 
 module Discordrb
   class Bot
     include Discordrb::Events
+
+    attr_reader :bot_user
+
     def initialize(email, password, debug = false)
       # Make sure people replace the login details in the example files...
       if email.end_with? "example.com"
@@ -66,7 +71,7 @@ module Discordrb
       debug("Obtaining data for channel with id #{id}")
       return @channels[id] if @channels[id]
 
-      response = RestClient.get Discordrb::Endpoints::CHANNELS + "/#{id}", {:Authorization => @token}
+      response = API.channel(@token, id)
       channel = Channel.new(JSON.parse(response), self)
       @channels[id] = channel
     end
@@ -79,11 +84,16 @@ module Discordrb
         'recipient_id' => id
       }
 
-      response = RestClient.post Discordrb::Endpoints::USERS + "/#{@bot_user.id}/channels", data.to_json, {:Authorization => @token, :content_type => :json}
+      response = API.create_private(@token, @bot_user.id, id)
       channel = Channel.new(JSON.parse(response), self)
       @private_channels[id] = channel
     end
 
+    def join(invite)
+      invite = invite[invite.rindex('/')+1..-1] if invite.start_with?('http') || invite.start_with?('discord.gg')
+      API.join_server(@token, invite)
+    end
+
     def user(id)
       @users[id]
     end
@@ -98,7 +108,7 @@ module Discordrb
         'content' => content.to_s,
         'mentions' => []
       }
-      RestClient.post Discordrb::Endpoints::CHANNELS + "/#{channel_id}/messages", data.to_json, {:Authorization => @token, :content_type => :json}
+      API.send_message(@token, channel_id, content)
     end
 
     def debug=(debug)
@@ -308,7 +318,7 @@ module Discordrb
       login_attempts = login_attempts || 0
 
       # Login
-      login_response = RestClient.post Discordrb::Endpoints::LOGIN, :email => @email, :password => @password
+      login_response = API.login(@email, @password)
       raise HTTPStatusException.new(login_response.code) if login_response.code >= 400
 
       # Parse response
@@ -336,7 +346,7 @@ module Discordrb
 
     def get_gateway
       # Get updated websocket_hub
-      response = RestClient.get Discordrb::Endpoints::GATEWAY, :authorization => @token
+      response = API.gateway(@token)
       JSON.parse(response)["url"]
     end
 
@@ -489,8 +499,8 @@ module Discordrb
           "v" => 2,   # Another identifier
           "token" => @token,
           "properties" => {   # I'm unsure what these values are for exactly, but they don't appear to impact bot functionality in any way.
-            "$os" => "Linux",
-            "$browser" => "",
+            "$os" => "#{RUBY_PLATFORM}",
+            "$browser" => "discordrb",
             "$device" => "discordrb",
             "$referrer" => "",
             "$referring_domain" => ""

data/lib/discordrb/commands/command-bot.rb

@@ -1,6 +1,7 @@
 require 'discordrb/bot'
 require 'discordrb/data'
 require 'discordrb/commands/parser'
+require 'discordrb/commands/events'
 
 # Specialized bot to run commands
 
@@ -92,6 +93,7 @@ module Discordrb::Commands
         return
       end
       if permission?(user(event.user.id), command.attributes[:permission_level], event.server.id)
+        event.command = command
         command.call(event, arguments, chained)
       else
         event.respond "You don't have permission to execute command `#{name}`!"
@@ -106,13 +108,13 @@ module Discordrb::Commands
 
     def create_message(data)
       message = Discordrb::Message.new(data, self)
-      event = Discordrb::Events::MessageEvent.new(message, self)
+      event = CommandEvent.new(message, self)
 
       if message.content.start_with? @prefix
         chain = message.content[@prefix.length..-1]
         debug("Parsing command chain #{chain}")
         result = (@attributes[:advanced_functionality]) ? CommandChain.new(chain, self).execute(event) : simple_execute(chain, event)
-        p result
+        result = event.saved_message + (result || '')
         event.respond result if result
       end
     end

data/lib/discordrb/commands/events.rb

@@ -0,0 +1,18 @@
+require 'discordrb/events/message'
+
+module Discordrb::Commands
+  class CommandEvent < Discordrb::Events::MessageEvent
+    attr_reader :bot, :saved_message
+    attr_accessor :command
+
+    def initialize(message, bot)
+      super(message, bot)
+      @saved_message = ''
+    end
+
+    def <<(message)
+      @saved_message += "#{message}\n"
+      nil
+    end
+  end
+end

data/lib/discordrb/version.rb

@@ -1,3 +1,3 @@
 module Discordrb
-  VERSION = "1.3.0"
+  VERSION = "1.3.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: discordrb
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - meew0
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-30 00:00:00.000000000 Z
+date: 2015-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faye-websocket
@@ -99,8 +99,10 @@ files:
 - examples/ping.rb
 - examples/pm.rb
 - lib/discordrb.rb
+- lib/discordrb/api.rb
 - lib/discordrb/bot.rb
 - lib/discordrb/commands/command-bot.rb
+- lib/discordrb/commands/events.rb
 - lib/discordrb/commands/parser.rb
 - lib/discordrb/data.rb
 - lib/discordrb/endpoints/endpoints.rb