khl 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ed901cab84178a2961285b975bf703bb034b998e0d70e7e8c8e06c5f27187137
+  data.tar.gz: 0447d12135db7697c59aadfd7f358e64982db782af00c2fdb90c4ea1bb2123a7
+SHA512:
+  metadata.gz: 2b71ec8d6a9f2e46c412a0552f2f6484d37a273ce141386ea9b94c8756ab54d15774d857cc42a25f1b4ea6be32b1a5e03d4544d04b1911dfc121778bed1ef4c5
+  data.tar.gz: 97ee22265dd77c70c3d432418e2a89410b2eb14984a81df83a08206fe1344f6c3479090afcb488e8f43bf9ba363ffaa8c33ff8dbe8804b3ec6932fdd4bb0e05e

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+### 1.0.0 - 2022-03-29
+
+* Add 开黑啦 HTTP API
+* Add 开黑啦 WebSocket API
+* Add GitHub CI

data/README.md

@@ -0,0 +1,53 @@
+# KHL
+
+开黑啦 Ruby SDK
+
+[官方开发者文档](https://developer.kaiheila.cn/doc)
+
+## Prerequisites
+
+* ruby >= 2.7
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'khl'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install khl
+
+## Usage
+
+```
+require "khl"
+
+token = "your_bot_token"
+
+# Call HTTP API
+http_client = KHL::HTTP::Client.new(token)
+http_client.guild.list # Call guild/list API
+
+# Connect to WebSocket API
+ws_client = KHL::WebSocket::Client.new(token)
+Thread.new { ws_client.run } # Run WebSocket client
+ws_clinet.state # Get current state
+ws_client.messages.pop # Get message from queue
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/DessertShop/KHL.

data/lib/khl/http/asset.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module KHL
+  module HTTP
+    # 媒体相关接口
+    # https://developer.kaiheila.cn/doc/http/asset
+    class Asset < Base
+      # 上传媒体文件
+      # @param [Hash] options 可选参数
+      # @option options [IO] :file 目前支持 图片，视频（.mp4 .mov），文件
+      # @return [KHL::HTTP::Response]
+      def create(options = {})
+        post_file(options)
+      end
+    end
+  end
+end

data/lib/khl/http/badge.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module KHL
+  module HTTP
+    # 徽章相关接口
+    # https://developer.kaiheila.cn/doc/http/badge
+    class Badge < Base
+      # 获取服务器徽章
+      # @param [String] guild_id 服务器 ID
+      # @param [Hash] options 可选参数
+      # @option options [Integer] :style 样式类型，默认为 0
+      # @return [KHL::HTTP::Response]
+      def guild(guild_id, options = {})
+        get(options.merge(guild_id: guild_id))
+      end
+    end
+  end
+end

data/lib/khl/http/base.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/string/inflections"
+require "json"
+require "net/http"
+require "uri"
+
+require_relative "response"
+
+module KHL
+  module HTTP
+    # 接口基类
+    class Base
+      BASE_URL = "https://www.kaiheila.cn/api"
+      API_VERSION = "v3"
+      END_POINT = "#{BASE_URL}/#{API_VERSION}"
+
+      attr_reader :config
+
+      # @param config [Hash] Config
+      # @option config [String] :token Bot token (required)
+      # @option config [String] :token_type Token type
+      # @option config [String] :language Language
+      def initialize(config)
+        raise ArgumentError, "missing token" unless config[:token]
+        config[:token_type] ||= "Bot"
+        config[:language] ||= "zh-cn"
+
+        @config = config
+      end
+
+      # GET 请求
+      def get(params = {})
+        action = params.key?(:action) ? params.delete(:action) : action_name # 可在 params 中手动配置 action
+        uri = URI("#{END_POINT}/#{resource_name}/#{action}")
+        params = filter_params(params)
+        uri.query = URI.encode_www_form(params)
+        request = Net::HTTP::Get.new(uri)
+        request["Authorization"] = "#{config[:token_type]} #{config[:token]}"
+        raw_response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
+          http.request(request)
+        end
+
+        Response.new(raw_response)
+      end
+
+      # POST 请求
+      def post(params = {})
+        action = params.key?(:action) ? params.delete(:action) : action_name
+        uri = URI("#{END_POINT}/#{resource_name}/#{action}")
+        request = Net::HTTP::Post.new(uri)
+        request["Authorization"] = "#{config[:token_type]} #{config[:token]}"
+        request["Content-type"] = "application/json"
+        params = filter_params(params)
+        request.body = JSON.generate(params)
+        raw_response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
+          http.request(request)
+        end
+
+        Response.new(raw_response)
+      end
+
+      # POST 文件请求
+      def post_file(params = {})
+        action = params.key?(:action) ? params.delete(:action) : action_name
+        uri = URI("#{END_POINT}/#{resource_name}/#{action}")
+        request = Net::HTTP::Post.new(uri)
+        request["Authorization"] = "#{config[:token_type]} #{config[:token]}"
+        request["Content-type"] = params.delete(:content_type) || "form-data" # 可在 params 中手动配置 content_type
+        params = filter_params(params)
+        request.set_form(params, "multipart/form-data")
+        raw_response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
+          http.request(request)
+        end
+
+        Response.new(raw_response)
+      end
+
+      private
+
+      # 过滤掉值为 nil 的参数，并将键全部转化为 String
+      def filter_params(params)
+        return {} unless params&.is_a?(Hash)
+
+        params = params.reject { |_, v| v.nil? }
+        params.transform_keys(&:to_s)
+      end
+
+      # 根据类名获取资源名
+      def resource_name
+        self.class.name.demodulize.underscore.dasherize
+      end
+
+      # 根据调用此方法的方法名，获取对应的接口名
+      def action_name
+        call_stack = caller(2..2)&.first
+        call_stack[/`.*'/][1..-2]&.dasherize
+      end
+    end
+  end
+end

data/lib/khl/http/blacklist.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module KHL
+  module HTTP
+    # 黑名单相关接口
+    # https://developer.kaiheila.cn/doc/http/blacklist
+    class Blacklist < Base
+      # 获取黑名单列表
+      # @param [String] guild_id 服务器 ID
+      # @param [Hash] options 可选参数
+      # @option options [Integer] :page 页数
+      # @option options [Integer] :page_size 每页数据数量
+      # @option options [String] :sort 代表排序的字段，比如 -id 代表 id 按 DESC 排序，id 代表 id 按 ASC 排序
+      # @return [KHL::HTTP::Response]
+      def list(guild_id, options = {})
+        get(options.merge(guild_id: guild_id))
+      end
+
+      # 加入黑名单
+      # @param [String] guild_id 服务器 ID
+      # @param [String] target_id 用户 ID
+      # @param [Hash] options 可选参数
+      # @option options [String] :remark 加入黑名单的原因
+      # @option options [Integer] :del_msg_days 删除最近几天的消息，最大 7 天，默认 0
+      # @return [KHL::HTTP::Response]
+      def create(guild_id, target_id, options = {})
+        post(options.merge(guild_id: guild_id, target_id: target_id))
+      end
+
+      # 移除黑名单
+      # @param [String] guild_id 服务器 ID
+      # @param [String] target_id 用户 ID
+      # @return [KHL::HTTP::Response]
+      def delete(guild_id, target_id)
+        post(guild_id: guild_id, target_id: target_id)
+      end
+    end
+  end
+end

data/lib/khl/http/channel.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module KHL
+  module HTTP
+    # 频道相关接口
+    # https://developer.kaiheila.cn/doc/http/channel
+    class Channel < Base
+      # 获取频道列表
+      # @param [String] guild_id 服务器 ID
+      # @param [Hash] options 可选参数
+      # @option options [Integer] :page 页数
+      # @option options [Integer] :page_size 每页数据数量
+      # @option options [Integer] :type 频道类型，1 为文字，2 为语音，默认为 1
+      # @return [KHL::HTTP::Response]
+      def list(guild_id, options = {})
+        get(options.merge(guild_id: guild_id))
+      end
+
+      # 获取频道详情
+      # @param [String] target_id 频道 ID
+      # @return [KHL::HTTP::Response]
+      def view(target_id)
+        get(target_id: target_id)
+      end
+
+      # 创建频道
+      # @param [String] guild_id 服务器 ID
+      # @param [String] name 频道名称
+      # @param [Hash] options 可选参数
+      # @option options [String] :parent_id 父分组 ID
+      # @option options [Integer] :type 频道类型，1 文字，2 语音，默认为 1
+      # @option options [Integer] :limit_amount 语音频道人数限制，最大 99
+      # @option options [Integer] :voice_quality 语音音质，默认为 2。1 流畅，2 正常，3 高质量
+      # @return [KHL::HTTP::Response]
+      def create(guild_id, name, options = {})
+        post(options.merge(guild_id: guild_id, name: name))
+      end
+
+      # 删除频道
+      # @param [String] channel_id 频道 ID
+      # @return [KHL::HTTP::Response]
+      def delete(channel_id)
+        post(channel_id: channel_id)
+      end
+
+      # 语音频道之间移动用户
+      # @note 只能在语音频道之间移动，用户也必须在其他语音频道在线才能够移动到目标频道
+      # @param [String] target_id 频道 ID，需要是语音频道
+      # @param [Array] user_ids 用户 ID 数组
+      # @return [KHL::HTTP::Response]
+      def move_user(target_id, user_ids)
+        post(target_id: target_id, user_ids: user_ids)
+      end
+    end
+  end
+end

data/lib/khl/http/channel_role.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module KHL
+  module HTTP
+    # 频道角色权限相关接口
+    # https://developer.kaiheila.cn/doc/http/channel
+    class ChannelRole < Base
+      # 频道角色权限详情
+      # @param [String] channel_id 频道 ID
+      # @return [KHL::HTTP::Response]
+      def index(channel_id)
+        get(channel_id: channel_id)
+      end
+
+      # 创建频道角色权限
+      # @param [String] channel_id 频道 ID，如果频道是分组的 ID，会同步给所有 sync=1 的子频道
+      # @param [Hash] options
+      # @option options [String] :type value 的类型，只能为 "role_id"，"user_id"，不传则默认为 "user_id"
+      # @option options [String] :value 根据 type 的值，为 用户 ID 或 频道 ID
+      # @return [KHL::HTTP::Response]
+      def create(channel_id, options = {})
+        post(options.merge(channel_id: channel_id))
+      end
+
+      # 更新频道角色权限
+      # @param [String] channel_id 频道 ID，如果频道是分组的 ID，会同步给所有 sync=1 的子频道
+      # @param [Hash] options
+      # @option options [String] :type value 的类型，只能为 "role_id"，"user_id"，不传则默认为 "user_id"
+      # @option options [String] :value 根据 type 的值，为 用户 ID 或 频道 ID
+      # @option options [Integer] :allow 默认为 0，想要设置的允许的权限值
+      # @option options [Integer] :deny 默认为 0，想要设置的拒绝的权限值
+      # @return [KHL::HTTP::Response]
+      def update(channel_id, options = {})
+        post(options.merge(channel_id: channel_id))
+      end
+
+      # 删除频道角色权限
+      # @param [String] channel_id 频道 ID，如果频道是分组的 ID，会同步给所有 sync=1 的子频道
+      # @param [Hash] options
+      # @option options [String] :type value 的类型，只能为 "role_id"，"user_id"，不传则默认为 "user_id"
+      # @option options [String] :value 根据 type 的值，为用户 ID 或频道 ID
+      # @return [KHL::HTTP::Response]
+      def delete(channel_id, options = {})
+        post(options.merge(channel_id: channel_id))
+      end
+    end
+  end
+end

data/lib/khl/http/channel_user.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module KHL
+  module HTTP
+    # 频道用户相关接口
+    # https://developer.kaiheila.cn/doc/http/channel-user
+    class ChannelUser < Base
+      # 根据用户 ID 和服务器 ID 获取用户所在语音频道
+      # @param [String] guild_id 服务器 ID
+      # @param [String] user_id 用户 ID
+      # @param [Hash] options 可选参数
+      # @option options [Integer] :page 页数
+      # @option options [Integer] :page_size 每页数据数量
+      # @return [KHL::HTTP::Response]
+      def get_joined_channel(guild_id, user_id, options = {})
+        get(options.merge(guild_id: guild_id, user_id: user_id))
+      end
+    end
+  end
+end

data/lib/khl/http/client.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require_relative "asset"
+require_relative "badge"
+require_relative "blacklist"
+require_relative "channel"
+require_relative "channel_role"
+require_relative "channel_user"
+require_relative "direct_message"
+require_relative "game"
+require_relative "gateway"
+require_relative "guild"
+require_relative "guild_emoji"
+require_relative "guild_mute"
+require_relative "guild_role"
+require_relative "intimacy"
+require_relative "invite"
+require_relative "message"
+require_relative "user"
+require_relative "user_chat"
+
+module KHL
+  module HTTP
+    # Client for the KHL HTTP API
+    # @example
+    # client = KHL::HTTP::Client.new(token: "bot_token")
+    # client.guild.list # Call guild/list API
+    class Client
+      attr_reader :asset,
+        :badge,
+        :blacklist,
+        :channel,
+        :channel_role,
+        :channel_user,
+        :direct_message,
+        :game,
+        :gateway,
+        :guild,
+        :guild_emoji,
+        :guild_mute,
+        :guild_role,
+        :intimacy,
+        :invite,
+        :message,
+        :user,
+        :user_chat
+
+      # @param config [Hash] Config
+      # @option config [String] :token Bot token (required)
+      # @option config [String] :token_type Token type
+      # @option config [String] :language Language
+      def initialize(config = {})
+        raise ArgumentError, "missing token" unless config[:token]
+        config[:token_type] ||= "Bot"
+        config[:language] ||= "zh-cn"
+
+        @asset = Asset.new(config)
+        @badge = Badge.new(config)
+        @blacklist = Blacklist.new(config)
+        @channel = Channel.new(config)
+        @channel_role = ChannelRole.new(config)
+        @channel_user = ChannelUser.new(config)
+        @direct_message = DirectMessage.new(config)
+        @game = Game.new(config)
+        @gateway = Gateway.new(config)
+        @guild = Guild.new(config)
+        @guild_emoji = GuildEmoji.new(config)
+        @guild_mute = GuildMute.new(config)
+        @guild_role = GuildRole.new(config)
+        @intimacy = Intimacy.new(config)
+        @invite = Invite.new(config)
+        @message = Message.new(config)
+        @user = User.new(config)
+        @user_chat = UserChat.new(config)
+      end
+    end
+  end
+end

data/lib/khl/http/direct_message.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module KHL
+  module HTTP
+    # 用户私聊消息相关接口
+    # https://developer.kaiheila.cn/doc/http/direct-message
+    class DirectMessage < Base
+      # 获取私信聊天消息列表
+      # @note 此接口非标准分页，需要根据参考消息来查询相邻分页的消息
+      # @param [Hash] options 可选参数
+      # @option options [String] :target_id 用户 ID，后端会自动创建会话。有此参数之后可不传 chat_code 参数
+      # @option options [String] :chat_code 会话 Code。chat_code 与 target_id 必须传一个
+      # @option options [String] :msg_id 消息 ID，不传则查询最新消息
+      # @option options [String] :flag 查询模式，有三种模式可以选择 before、around、after。不传则默认查询最新的消息
+      # @option options [Integer] :page 页数
+      # @option options [Integer] :page_size 当前分页消息数量，默认 50
+      # @return [KHL::HTTP::Response]
+      def list(options = {})
+        get(options)
+      end
+
+      # 发送私信聊天消息
+      # @param [String] content 消息内容
+      # @param [Hash] options 可选参数
+      # @option options [Integer] :type	消息类型，不传默认为 1，代表文本类型。9 代表 kmarkdown 消息，10 代表卡片消息
+      # @option options [String] :target_id 用户 ID，后端会自动创建会话。有此参数之后可不传 chat_code 参数
+      # @option options [String] :chat_code 会话 Code。chat_code 与 target_id 必须传一个
+      # @option options [String] :quote 回复某条消息的 msg_id
+      # @option options [String] :nonce 随机字符串，服务端不做处理, 原样返回
+      # @return [KHL::HTTP::Response]
+      def create(content, options = {})
+        post(options.merge(content: content))
+      end
+
+      # 更新私信聊天消息
+      # @note 目前支持消息 type 为 9、10 的修改，即 KMarkdown 和 CardMessage
+      # @param [String] content 消息内容
+      # @param [Hash] options 可选参数
+      # @option options [String] :msg_id 消息 ID
+      # @option options [String] :quote 回复某条消息的 msg_id。如果为空，则代表删除回复，不传则无影响
+      # @return [KHL::HTTP::Response]
+      def update(content, options = {})
+        post(options.merge(content: content))
+      end
+
+      # 删除私信聊天消息
+      # @note 只能删除自己的消息
+      # @param [Hash] options 可选参数
+      # @option options [String] :msg_id 消息 ID
+      # @return [KHL::HTTP::Response]
+      def delete(options = {})
+        post(options)
+      end
+
+      # 获取频道消息某回应的用户列表
+      # @param [String] msg_id 消息 ID
+      # @param [Hash] options 可选参数
+      # @option options [String] :emoji Emoji ID，可以为 GuildEmoji 或者 Emoji，注意：在 GET 中，应该进行 urlencode
+      # @return [KHL::HTTP::Response]
+      def reaction_list(msg_id, options = {})
+        get(options.merge(msg_id: msg_id))
+      end
+
+      # 给某个消息添加回应
+      # @param [String] msg_id 消息 ID
+      # @param [String] emoji Emoji ID，可以为 GuildEmoji 或者 Emoji，注意：在 GET 中，应该进行 urlencode
+      # @return [KHL::HTTP::Response]
+      def add_reaction(msg_id, emoji)
+        post(msg_id: msg_id, emoji: emoji)
+      end
+
+      # 删除消息的某个回应
+      # @param [String] msg_id 消息 ID
+      # @param [String] emoji Emoji ID，可以为 GuildEmoji 或者 Emoji，注意：在 GET 中，应该进行 urlencode
+      # @param [Hash] options 可选参数
+      # @option options [String] :user_id 用户 ID，如果不填则为自己的 ID。删除别人的回应需要有管理频道消息的权限
+      # @return [KHL::HTTP::Response]
+      def delete_reaction(msg_id, emoji, options = {})
+        post(options.merge(msg_id: msg_id, emoji: emoji))
+      end
+    end
+  end
+end

data/lib/khl/http/game.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module KHL
+  module HTTP
+    # 用户动态相关接口-游戏/进程/音乐
+    # https://developer.kaiheila.cn/doc/http/game
+    class Game < Base
+      # 游戏列表
+      # @return [KHL::HTTP::Response]
+      def list
+        get(action: nil)
+      end
+
+      # 添加游戏
+      # @note 本接口有数据插入频率限制，单日最大可创建 5 个游戏数据
+      # @param [String] name 名称
+      # @param [Hash] options 可选参数
+      # @option options [String] :process_name 进程名
+      # @option options [String] :icon 图标
+      # @return [KHL::HTTP::Response]
+      def create(name, options = {})
+        post(options.merge(name: name))
+      end
+
+      # 更新游戏
+      # @param [Integer] id	ID
+      # @param [Hash] options 可选参数
+      # @option options [String] :name 名称
+      # @option options [String] :icon 图标
+      # @return [KHL::HTTP::Response]
+      def update(id, options = {})
+        post(options.merge(id: id))
+      end
+
+      # 删除游戏
+      # @param [Integer] id	ID
+      # @return [KHL::HTTP::Response]
+      def delete(id)
+        post(id: id)
+      end
+
+      # 添加游戏记录-开始玩
+      # @param [Integer] id	游戏 ID
+      # @param [Integer] data_type 请求数据类型，固定传 1（游戏）
+      # @return [KHL::HTTP::Response]
+      def activity(id, data_type)
+        post(id: id, data_type: data_type)
+      end
+
+      # 删除游戏记录-结束玩
+      # @return [KHL::HTTP::Response]
+      def delete_activity
+        post
+      end
+    end
+  end
+end

data/lib/khl/http/gateway.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module KHL
+  module HTTP
+    # 网关相关接口
+    # https://developer.kaiheila.cn/doc/http/gateway
+    class Gateway < Base
+      # 获取网关连接地址
+      # @param [Hash] options 可选参数
+      # @option options [Integer] :compress 下发数据是否压缩，默认为 1，代表压缩
+      # @return [KHL::HTTP::Response]
+      def index(options = {})
+        get(options)
+      end
+    end
+  end
+end