discordrb 1.4.1 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ad6998ddf964b9fbb9898312e7d41d503a207bff
-  data.tar.gz: c2bfb298aacd612fee0800f8f1ff434fc0cfe90c
+  metadata.gz: 5d1542d6ad0666eb828fb415023c62059b0d29a7
+  data.tar.gz: 3f4ba2868eea476ecc4195f0ce025fe8322aea9b
 SHA512:
-  metadata.gz: cfcf66d6d21815e39b66b9dfdc1508abfd2f22e11e0d435073aa9d7de45dec0dcef62fb6a50f1921d28ddadd3e8e5c4972364e70a65813bb2284859f305b685d
-  data.tar.gz: f43645f7d126eda651ee82027eb829b7b66e6661b4fe81a6283d81b7935bcb7305e66a7d7614c03af4355a5b6e6b05f71396aae1c720f949a1c36fd20a2c4311
+  metadata.gz: 667bff54430e689507d9983e62e1288ebea7854edc82d43724f3d0fac9cf37f108ff8c2682ad1bf82341ff02d68149aa7510ad4261e343cf9e4957b418b12481
+  data.tar.gz: ca0d56615189e67ef450c26ca16f997bd3b37f33e30348832ddbd0ea949b8c077296a0deea7706d3153d1c7a278bc5eb9e6002ac81684fd7a0a5cf7955e59072

data/lib/discordrb/api.rb

@@ -8,9 +8,37 @@ module Discordrb::API
 
   module_function
 
+  # Generate a user agent identifying this requester as discordrb.
+  def user_agent
+    libraries = [
+      # rest-client
+      "rest-client/#{RestClient::VERSION}",
+
+      # ruby
+      "#{RUBY_ENGINE}/#{RUBY_VERSION}p#{RUBY_PATCHLEVEL}",
+
+      # discordrb
+      "discordrb/#{Discordrb::VERSION}"
+    ]
+
+    # Required by Discord devs
+    required = "DiscordBot (https://github.com/meew0/discordrb, v#{Discordrb::VERSION})"
+    "#{libraries.join(' ')} #{required}"
+  end
+
+  # Make an API request. Utility function to implement message queueing
+  # in the future
+  def request(type, *attributes)
+    # Add a custom user agent
+    attributes.last[:user_agent] = user_agent if attributes.last.is_a? Hash
+    puts attributes.last[:user_agent]
+    RestClient.send(type, *attributes)
+  end
+
   # 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(
+    request(
+      :put,
       "#{APIBASE}/guilds/#{server_id}/bans/#{user_id}?delete-message-days=#{message_days}",
       Authorization: token
     )
@@ -18,7 +46,8 @@ module Discordrb::API
 
   # Unban a user from a server
   def unban_user(token, server_id, user_id)
-    RestClient.delete(
+    request(
+      :delete,
       "#{APIBASE}/guilds/#{server_id}/bans/#{user_id}",
       Authorization: token
     )
@@ -26,7 +55,8 @@ module Discordrb::API
 
   # Kick a user from a server
   def kick_user(token, server_id, user_id)
-    RestClient.delete(
+    request(
+      :delete,
       "#{APIBASE}/guilds/#{server_id}/members/#{user_id}",
       Authorization: token
     )
@@ -34,7 +64,8 @@ module Discordrb::API
 
   # Get a server's banned users
   def bans(token, server_id)
-    RestClient.get(
+    request(
+      :get,
       "#{APIBASE}/guilds/#{server_id}/bans",
       Authorization: token
     )
@@ -42,7 +73,8 @@ module Discordrb::API
 
   # Login to the server
   def login(email, password)
-    RestClient.post(
+    request(
+      :post,
       "#{APIBASE}/auth/login",
       email: email,
       password: password
@@ -51,7 +83,8 @@ module Discordrb::API
 
   # Logout from the server
   def logout(token)
-    RestClient.post(
+    request(
+      :post,
       "#{APIBASE}/auth/logout",
       nil,
       Authorization: token
@@ -60,7 +93,8 @@ module Discordrb::API
 
   # Create a server
   def create_server(token, name, region = :london)
-    RestClient.post(
+    request(
+      :post,
       "#{APIBASE}/guilds",
       { 'name' => name, 'region' => region.to_s }.to_json,
       Authorization: token,
@@ -70,7 +104,8 @@ module Discordrb::API
 
   # Update a server
   def update_server(token, server_id, name, region, icon, afk_channel_id, afk_timeout)
-    RestClient.patch(
+    request(
+      :patch,
       "#{APIBASE}/guilds/#{server_id}",
       { 'name' => name, 'region' => region, 'icon' => icon, 'afk_channel_id' => afk_channel_id, 'afk_timeout' => afk_timeout }.to_json,
       Authorization: token,
@@ -80,7 +115,8 @@ module Discordrb::API
 
   # Delete a server
   def delete_server(token, server_id)
-    RestClient.delete(
+    request(
+      :delete,
       "#{APIBASE}/guilds/#{server_id}",
       Authorization: token
     )
@@ -88,7 +124,8 @@ module Discordrb::API
 
   # Leave a server
   def leave_server(server_id)
-    RestClient.delete(
+    request(
+      :delete,
       "#{APIBASE}/guilds/#{server_id}",
       Authorization: token
     )
@@ -96,7 +133,8 @@ module Discordrb::API
 
   # Get a channel's data
   def channel(token, channel_id)
-    RestClient.get(
+    request(
+      :get,
       "#{APIBASE}/channels/#{channel_id}",
       Authorization: token
     )
@@ -104,7 +142,8 @@ module Discordrb::API
 
   # Create a channel
   def create_channel(token, server_id, name, type)
-    RestClient.post(
+    request(
+      :post,
       "#{APIBASE}/guilds/#{server_id}/channels",
       { 'name' => name, 'type' => type }.to_json,
       Authorization: token,
@@ -114,7 +153,8 @@ module Discordrb::API
 
   # Update a channel's data
   def update_channel(token, channel_id, name, topic, position = 0)
-    RestClient.patch(
+    request(
+      :patch,
       "#{APIBASE}/channels/#{channel_id}",
       { 'name' => name, 'position' => position, 'topic' => topic }.to_json,
       Authorization: token,
@@ -124,7 +164,8 @@ module Discordrb::API
 
   # Delete a channel
   def delete_channel(token, channel_id)
-    RestClient.delete(
+    request(
+      :delete,
       "#{APIBASE}/channels/#{channel_id}",
       Authorization: token
     )
@@ -132,7 +173,8 @@ module Discordrb::API
 
   # Join a server using an invite
   def join_server(token, invite_code)
-    RestClient.post(
+    request(
+      :post,
       "#{APIBASE}/invite/#{invite_code}",
       nil,
       Authorization: token
@@ -141,7 +183,8 @@ module Discordrb::API
 
   # Resolve an invite
   def resolve_invite(token, invite_code)
-    RestClient.get(
+    request(
+      :get,
       "#{APIBASE}/invite/#{invite_code}",
       Authorization: token
     )
@@ -149,7 +192,8 @@ module Discordrb::API
 
   # Create a private channel
   def create_private(token, bot_user_id, user_id)
-    RestClient.post(
+    request(
+      :post,
       "#{APIBASE}/users/#{bot_user_id}/channels",
       { 'recipient_id' => user_id }.to_json,
       Authorization: token,
@@ -159,7 +203,8 @@ module Discordrb::API
 
   # Create an instant invite from a server or a channel id
   def create_invite(token, channel_id, max_age = 0, max_uses = 0, temporary = false, xkcd = false)
-    RestClient.post(
+    request(
+      :post,
       "#{APIBASE}/channels/#{channel_id}/invites",
       { 'max_age' => max_age, 'max_uses' => max_uses, 'temporary' => temporary, 'xkcdpass' => xkcd }.to_json,
       Authorization: token,
@@ -169,7 +214,8 @@ module Discordrb::API
 
   # Delete an invite by code
   def delete_invite(token, code)
-    RestClient.delete(
+    request(
+      :delete,
       "#{APIBASE}/invites/#{code}",
       Authorization: token
     )
@@ -177,7 +223,8 @@ module Discordrb::API
 
   # Send a message to a channel
   def send_message(token, channel_id, message, mentions = [], tts = false)
-    RestClient.post(
+    request(
+      :post,
       "#{APIBASE}/channels/#{channel_id}/messages",
       { 'content' => message, 'mentions' => mentions, tts => tts }.to_json,
       Authorization: token,
@@ -187,7 +234,8 @@ module Discordrb::API
 
   # Delete a message
   def delete_message(token, channel_id, message_id)
-    RestClient.delete(
+    request(
+      :delete,
       "#{APIBASE}/channels/#{channel_id}/messages/#{message_id}",
       Authorization: token
     )
@@ -195,7 +243,8 @@ module Discordrb::API
 
   # Edit a message
   def edit_message(token, channel_id, message_id, message, mentions = [])
-    RestClient.patch(
+    request(
+      :patch,
       "#{APIBASE}/channels/#{channel_id}/messages/#{message_id}",
       { 'content' => message, 'mentions' => mentions }.to_json,
       Authorization: token,
@@ -207,7 +256,8 @@ module Discordrb::API
   # 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(
+    request(
+      :post,
       "#{APIBASE}/channels/#{channel_id}/messages/#{message_id}/ack",
       nil,
       Authorization: token
@@ -216,7 +266,8 @@ module Discordrb::API
 
   # Send a file as a message to a channel
   def send_file(token, channel_id, file)
-    RestClient.post(
+    request(
+      :post,
       "#{APIBASE}/channels/#{channel_id}/messages",
       { file: file },
       Authorization: token
@@ -225,7 +276,8 @@ module Discordrb::API
 
   # 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(
+    request(
+      :post,
       "#{APIBASE}/guilds/#{server_id}/roles",
       nil,
       Authorization: token
@@ -237,7 +289,8 @@ module Discordrb::API
   # 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 = 36_953_089)
-    RestClient.patch(
+    request(
+      :patch,
       "#{APIBASE}/guilds/#{server_id}/roles/#{role_id}",
       { 'color' => colour, 'name' => name, 'hoist' => hoist, 'permissions' => packed_permissions }.to_json,
       Authorization: token,
@@ -247,7 +300,8 @@ module Discordrb::API
 
   # Delete a role
   def delete_role(token, server_id, role_id)
-    RestClient.delete(
+    request(
+      :delete,
       "#{APIBASE}/guilds/#{server_id}/roles/#{role_id}",
       Authorization: token
     )
@@ -255,7 +309,8 @@ module Discordrb::API
 
   # Update a user's roles
   def update_user_roles(token, server_id, user_id, roles)
-    RestClient.patch(
+    request(
+      :patch,
       "#{APIBASE}/guilds/#{server_id}/members/#{user_id}",
       { 'roles' => roles }.to_json,
       Authorization: token,
@@ -265,7 +320,8 @@ module Discordrb::API
 
   # Update a user's permission overrides in a channel
   def update_user_overrides(token, channel_id, user_id, allow, deny)
-    RestClient.put(
+    request(
+      :put,
       "#{APIBASE}/channels/#{channel_id}/permissions/#{user_id}",
       { 'type' => 'member', 'id' => user_id, 'allow' => allow, 'deny' => deny }.to_json,
       Authorization: token,
@@ -275,7 +331,8 @@ module Discordrb::API
 
   # Update a role's permission overrides in a channel
   def update_role_overrides(token, channel_id, role_id, allow, deny)
-    RestClient.put(
+    request(
+      :put,
       "#{APIBASE}/channels/#{channel_id}/permissions/#{role_id}",
       { 'type' => 'role', 'id' => role_id, 'allow' => allow, 'deny' => deny }.to_json,
       Authorization: token,
@@ -285,7 +342,8 @@ module Discordrb::API
 
   # Get the gateway to be used
   def gateway(token)
-    RestClient.get(
+    request(
+      :get,
       "#{APIBASE}/gateway",
       Authorization: token
     )
@@ -293,7 +351,8 @@ module Discordrb::API
 
   # Start typing (needs to be resent every 5 seconds to keep up the typing)
   def start_typing(token, channel_id)
-    RestClient.post(
+    request(
+      :post,
       "#{APIBASE}/channels/#{channel_id}/typing",
       nil,
       Authorization: token
@@ -302,7 +361,8 @@ module Discordrb::API
 
   # Get user data
   def user(token, user_id)
-    RestClient.get(
+    request(
+      :get,
       "#{APIBASE}/users/#{user_id}",
       Authorization: token
     )
@@ -310,7 +370,8 @@ module Discordrb::API
 
   # Update user data
   def update_user(token, email, password, new_username, avatar, new_password = nil)
-    RestClient.patch(
+    request(
+      :patch,
       "#{APIBASE}/users/@me",
       { 'avatar' => avatar, 'email' => email, 'new_password' => new_password, 'password' => password, 'username' => new_username }.to_json,
       Authorization: token,
@@ -320,7 +381,8 @@ module Discordrb::API
 
   # Get a list of messages from a channel's history
   def channel_log(token, channel_id, amount, before = nil, after = nil)
-    RestClient.get(
+    request(
+      :get,
       "#{APIBASE}/channels/#{channel_id}/messages?limit=#{amount}#{"&before=#{before}" if before}#{"&after=#{after}" if after}",
       Authorization: token
     )

data/lib/discordrb/bot.rb

@@ -726,6 +726,7 @@ module Discordrb
 
         # Apparently we get a 400 if the password or username is incorrect. In that case, tell the user
         debug("Are you sure you're using the correct username and password?") if e.class == RestClient::BadRequest
+        log_exception(e)
         raise $ERROR_INFO
       end
     end

data/lib/discordrb/version.rb

@@ -1,4 +1,4 @@
 # Discordrb and all its functionality, in this case only the version.
 module Discordrb
-  VERSION = '1.4.1'
+  VERSION = '1.4.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: discordrb
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.4.2
 platform: ruby
 authors:
 - meew0
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-12-07 00:00:00.000000000 Z
+date: 2015-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faye-websocket