async-discord 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 33834a7af00dffadb4f4c2c050e62dda6aa9823401a7be3814616422bce948a1
+  data.tar.gz: 40e8682837b6325b3d1a14bdb8913b535cccc96d5cd569e81822a63851275850
+SHA512:
+  metadata.gz: d07684c7f494a3cc8893b345190d2fd495b5ec57251be6a11f158e22c12aeade6a6f975ae078287bc7e1171db4adaf942f426009a685caf39df731725f0ad96d
+  data.tar.gz: d316e91be104bf9634f4ec8242c7c9f4410e0a823de3627c62232d23c7c7c85cf099c158cfb3e7adba9150d1ce1808bdd0e3b54a62774a5f18414891f5e8415e

data/lib/async/discord/channels.rb

@@ -0,0 +1,46 @@
+require_relative "representation"
+
+module Async
+	module Discord
+		class Message < Representation
+		end
+		
+		class Channel < Representation
+			def send_message(content)
+				payload = {
+					content: content
+				}
+				
+				Message.post(@resource.with(path: "messages"), payload)
+			end
+			
+			def id
+				self.value[:id]
+			end
+			
+			def text?
+				self.value[:type] == 0
+			end
+			
+			def voice?
+				self.value[:type] == 2
+			end
+		end
+		
+		class Channels < Representation
+			def each(&block)
+				return to_enum unless block_given?
+				
+				self.value.each do |value|
+					path = "/api/v10/channels/#{value[:id]}"
+					
+					yield Channel.new(@resource.with(path: path), value: value)
+				end
+			end
+			
+			def to_a
+				each.to_a
+			end
+		end
+	end
+end

data/lib/async/discord/client.rb

@@ -0,0 +1,63 @@
+# frozen_string_literals: true
+#
+# Copyright, 2019, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require_relative 'representation'
+
+require_relative 'guilds'
+require_relative 'gateway'
+
+module Async
+	module Discord
+		class Client < Async::REST::Resource
+			ENDPOINT = Async::HTTP::Endpoint.parse("https://discord.com/api/v10/")
+			USER_AGENT = "#{self.name} (https://github.com/socketry/async-discord, v#{Async::Discord::VERSION})"
+			
+			def authenticated(bot: nil, bearer: nil)
+				headers = {}
+				
+				headers["user-agent"] ||= USER_AGENT
+				
+				if bot
+					headers["authorization"] = "Bot #{bot}"
+				elsif bearer
+					headers["authorization"] = "Bearer #{bearer}"
+				else
+					raise ArgumentError, "You must provide either a bot or bearer token!"
+				end
+				
+				return self.with(headers: headers)
+			end
+			
+			def guilds
+				Guilds.new(self.with(path: "users/@me/guilds"))
+			end
+			
+			def gateway
+				Gateway.new(self.with(path: "gateway/bot"))
+			end
+			
+			def channel(id)
+				Channel.new(self.with(path: "channels/#{id}"))
+			end
+		end
+	end
+end

data/lib/async/discord/gateway.rb

@@ -0,0 +1,196 @@
+require_relative "representation"
+
+require "async/websocket"
+
+module Async
+	module Discord
+		class GatewayConnection < Async::WebSocket::Connection
+			# Gateway Opcodes:
+			DISPATCH = 0
+			HEARTBEAT = 1
+			IDENTIFY = 2
+			PRESENCE_UPDATE = 3
+			VOICE_STATE_UPDATE = 4
+			RESUME = 6
+			RECONNECT = 7
+			REQUEST_GUILD_MEMBERS = 8
+			INVALID_SESSION = 9
+			HELLO = 10
+			HEARTBEAT_ACK = 11
+			REQUEST_SOUNDBOARD_SOUNDS = 31
+			
+			# Gateway Error Codes
+			ERROR_CODES = {
+				4000 => "UNKNOWN_ERROR",
+				4001 => "UNKNOWN_OPCODE",
+				4002 => "DECODE_ERROR",
+				4003 => "NOT_AUTHENTICATED",
+				4004 => "AUTHENTICATION_FAILED",
+				4005 => "ALREADY_AUTHENTICATED",
+				4007 => "INVALID_SEQUENCE",
+				4008 => "RATE_LIMITED",
+				4009 => "SESSION_TIMEOUT",
+				4010 => "INVALID_SHARD",
+				4011 => "SHARDING_REQUIRED",
+				4012 => "INVALID_VERSION",
+				4013 => "INVALID_INTENT",
+				4014 => "DISALLOWED_INTENT"
+			}
+			
+			# Guild Intents:
+			module Intent
+				GUILDS = 1 << 0
+				GUILD_MEMBERS = 1 << 1
+				GUILD_MODERATION = 1 << 2
+				GUILD_EXPRESSIONS = 1 << 3
+				GUILD_INTEGRATIONS = 1 << 4
+				GUILD_WEBHOOKS = 1 << 5
+				GUILD_INVITES = 1 << 6
+				GUILD_VOICE_STATES = 1 << 7
+				GUILD_PRESENCES = 1 << 8
+				GUILD_MESSAGES = 1 << 9
+				GUILD_MESSAGE_REACTIONS = 1 << 10
+				GUILD_MESSAGE_TYPING = 1 << 11
+				DIRECT_MESSAGES = 1 << 12
+				DIRECT_MESSAGE_REACTIONS = 1 << 13
+				DIRECT_MESSAGE_TYPING = 1 << 14
+				MESSAGE_CONTENT = 1 << 15
+				GUILD_SCHEDULED_EVENTS = 1 << 16
+				AUTO_MODERATION_CONFIGURATION = 1 << 20
+				AUTO_MODERATION_EXECUTION = 1 << 21
+				GUILD_MESSAGE_POLLS = 1 << 24
+				DIRECT_MESSAGE_POLLS = 1 << 25
+			end
+			
+			DEFAULT_INTENT = Intent::GUILDS | Intent::GUILD_MESSAGES | Intent::DIRECT_MESSAGES
+			
+			DEFAULT_PROPERTIES = {
+				os: RUBY_PLATFORM,
+				browser: Async::Discord.name,
+				device: Async::Discord.name,
+			}
+			
+			DEFAULT_PRESENCE = {
+				status: "online",
+				afk: false,
+				activities: [],
+			}
+			
+			def initialize(...)
+				super
+				
+				@heartbeat_task = nil
+				@sequence = nil
+			end
+			
+			def close(...)
+				if heartbeat_task = @heartbeat_task
+					@heartbeat_task = nil
+					heartbeat_task.stop
+				end
+				
+				super
+			end
+			
+			def identify(**identity)
+				while message = self.read
+					payload = message.parse
+					
+					case payload[:op]
+					when HELLO
+						@heartbeat_task ||= self.run_heartbeat(payload[:d][:heartbeat_interval])
+						break
+					else
+						Console.warn(self, "Unexpected payload during identify: #{payload}")
+					end
+				end
+				
+				identity[:intents] ||= DEFAULT_INTENT
+				identity[:properties] ||= DEFAULT_PROPERTIES
+				identity[:presence] ||= DEFAULT_PRESENCE
+				
+				Console.debug(self, "Identifying...", identity: identity)
+				::Protocol::WebSocket::TextMessage.generate(op: IDENTIFY, d: identity).send(self)
+				
+				while message = self.read
+					payload = message.parse
+					
+					if payload[:op] == DISPATCH && payload[:t] == "READY"
+						Console.info(self, "Identified successfully.")
+						
+						# Store the sequence number for future heartbeats:
+						@sequence = payload[:s]
+						
+						return payload[:d]
+					elsif payload[:op] == INVALID_SESSION
+						Console.warn(self, "Invalid session.")
+						break
+					else
+						Console.warn(self, "Unexpected payload during identify: #{payload}")
+					end
+				end
+			end
+			
+			def listen
+				while message = self.read
+					payload = message.parse
+					
+					case payload[:op]
+					when DISPATCH
+						@sequence = payload[:s]
+						yield payload
+					when HEARTBEAT
+						Console.debug(self, "Received heartbeat request.", payload: payload)
+						heartbeat_message = ::Protocol::WebSocket::TextMessage.generate(op: HEARTBEAT_ACK, d: @sequence)
+						heartbeat_message.send(self)
+					when HEARTBEAT_ACK
+						Console.debug(self, "Received heartbeat ACK.", payload: payload)
+					else
+						yield payload
+					end
+				end
+			end
+			
+			private
+			
+			def run_heartbeat(duration_ms)
+				duration = duration_ms / 1000.0
+				Console.debug(self, "Running heartbeat every #{duration} seconds.")
+				
+				Async do |task|
+					sleep(duration * rand)
+					
+					while !self.closed?
+						Console.debug(self, "Sending heartbeat.", sequence: @sequence)
+						heartbeat_message = ::Protocol::WebSocket::TextMessage.generate(op: HEARTBEAT, d: @sequence)
+						heartbeat_message.send(self)
+						self.flush
+						
+						sleep(duration)
+					end
+				end
+			end
+		end
+		
+		class Gateway < Representation
+			def url
+				self.value[:url]
+			end
+			
+			def shards
+				self.value[:shards]
+			end
+			
+			def session_start_limit
+				self.value[:session_start_limit]
+			end
+			
+			def connect(shard: nil, &block)
+				endpoint = Async::HTTP::Endpoint.parse(self.url, alpn_protocols: Async::HTTP::Protocol::HTTP11.names)
+				
+				Console.info(self, "Connecting to gateway...", endpoint: endpoint)
+				Async::WebSocket::Client.connect(endpoint, handler: GatewayConnection, &block)
+			end
+		end
+	end
+end

data/lib/async/discord/guilds.rb

@@ -0,0 +1,32 @@
+require_relative "representation"
+require_relative "channels"
+
+module Async
+	module Discord
+		class Guild < Representation
+			def channels
+				Channels.new(@resource.with(path: "channels"))
+			end
+			
+			def id
+				self.value[:id]
+			end
+		end
+		
+		class Guilds < Representation
+			def each(&block)
+				return to_enum unless block_given?
+				
+				self.value.each do |value|
+					path = "/api/v10/guilds/#{value[:id]}"
+					
+					yield Guild.new(@resource.with(path: path), value: value)
+				end
+			end
+			
+			def to_a
+				each.to_a
+			end
+		end
+	end
+end

data/lib/async/discord/representation.rb

@@ -0,0 +1,34 @@
+# frozen_string_literals: true
+#
+# Copyright, 2019, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'async/rest/representation'
+require 'async/rest/wrapper/form'
+
+module Async
+	module Discord
+		class Wrapper < Async::REST::Wrapper::JSON
+		end
+		
+		class Representation < Async::REST::Representation[Wrapper]
+		end
+	end
+end

data/lib/async/discord/version.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2024, by Samuel Williams.
+
+module Async
+	module Discord
+		VERSION = "0.1.0"
+	end
+end

data/license.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright, 2024, by Samuel Williams.  
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/readme.md

@@ -0,0 +1,3 @@
+# Async::Discord
+
+Provides a simple `Async::REST` client for interacting with the Discord API.

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: async-discord
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Samuel Williams
+autorequire:
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIE2DCCA0CgAwIBAgIBATANBgkqhkiG9w0BAQsFADBhMRgwFgYDVQQDDA9zYW11
+  ZWwud2lsbGlhbXMxHTAbBgoJkiaJk/IsZAEZFg1vcmlvbnRyYW5zZmVyMRIwEAYK
+  CZImiZPyLGQBGRYCY28xEjAQBgoJkiaJk/IsZAEZFgJuejAeFw0yMjA4MDYwNDUz
+  MjRaFw0zMjA4MDMwNDUzMjRaMGExGDAWBgNVBAMMD3NhbXVlbC53aWxsaWFtczEd
+  MBsGCgmSJomT8ixkARkWDW9yaW9udHJhbnNmZXIxEjAQBgoJkiaJk/IsZAEZFgJj
+  bzESMBAGCgmSJomT8ixkARkWAm56MIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIB
+  igKCAYEAomvSopQXQ24+9DBB6I6jxRI2auu3VVb4nOjmmHq7XWM4u3HL+pni63X2
+  9qZdoq9xt7H+RPbwL28LDpDNflYQXoOhoVhQ37Pjn9YDjl8/4/9xa9+NUpl9XDIW
+  sGkaOY0eqsQm1pEWkHJr3zn/fxoKPZPfaJOglovdxf7dgsHz67Xgd/ka+Wo1YqoE
+  e5AUKRwUuvaUaumAKgPH+4E4oiLXI4T1Ff5Q7xxv6yXvHuYtlMHhYfgNn8iiW8WN
+  XibYXPNP7NtieSQqwR/xM6IRSoyXKuS+ZNGDPUUGk8RoiV/xvVN4LrVm9upSc0ss
+  RZ6qwOQmXCo/lLcDUxJAgG95cPw//sI00tZan75VgsGzSWAOdjQpFM0l4dxvKwHn
+  tUeT3ZsAgt0JnGqNm2Bkz81kG4A2hSyFZTFA8vZGhp+hz+8Q573tAR89y9YJBdYM
+  zp0FM4zwMNEUwgfRzv1tEVVUEXmoFCyhzonUUw4nE4CFu/sE3ffhjKcXcY//qiSW
+  xm4erY3XAgMBAAGjgZowgZcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0O
+  BBYEFO9t7XWuFf2SKLmuijgqR4sGDlRsMC4GA1UdEQQnMCWBI3NhbXVlbC53aWxs
+  aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MC4GA1UdEgQnMCWBI3NhbXVlbC53aWxs
+  aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MA0GCSqGSIb3DQEBCwUAA4IBgQB5sxkE
+  cBsSYwK6fYpM+hA5B5yZY2+L0Z+27jF1pWGgbhPH8/FjjBLVn+VFok3CDpRqwXCl
+  xCO40JEkKdznNy2avOMra6PFiQyOE74kCtv7P+Fdc+FhgqI5lMon6tt9rNeXmnW/
+  c1NaMRdxy999hmRGzUSFjozcCwxpy/LwabxtdXwXgSay4mQ32EDjqR1TixS1+smp
+  8C/NCWgpIfzpHGJsjvmH2wAfKtTTqB9CVKLCWEnCHyCaRVuKkrKjqhYCdmMBqCws
+  JkxfQWC+jBVeG9ZtPhQgZpfhvh+6hMhraUYRQ6XGyvBqEUe+yo6DKIT3MtGE2+CP
+  eX9i9ZWBydWb8/rvmwmX2kkcBbX0hZS1rcR593hGc61JR6lvkGYQ2MYskBveyaxt
+  Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
+  voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
+  -----END CERTIFICATE-----
+date: 2024-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: async-rest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: async-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/async/discord/channels.rb
+- lib/async/discord/client.rb
+- lib/async/discord/gateway.rb
+- lib/async/discord/guilds.rb
+- lib/async/discord/representation.rb
+- lib/async/discord/version.rb
+- license.md
+- readme.md
+homepage: https://github.com/socketry/async-discord
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/socketry/async-discord.git
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Build Discord bots and use real time messaging.
+test_files: []