ruby-cqhttp 0.0.7 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e05ea3a7529706ede1358efa6735e455e8ca125242beab7107145ba78032f9b
-  data.tar.gz: 9aeeb36d26f766ee178aff75920e60256a8b7d38f9b26731ac89dc9c0f07eefc
+  metadata.gz: f4ded7c0bb8d8255401a9d13b5c98eafdba3324f7221bf6ef4e1c0bf7646ba8e
+  data.tar.gz: 2cc88a1e903da48f2b74859f3f7bc8a7c5cc2292d70061f219d528c1b90ead2e
 SHA512:
-  metadata.gz: 0fbf62999904bee4c4c3811be5ab6ad315e0ef1b10a057ac4d6ea117a982c3a353c9b614283369bb58103c1f80dcedd67c6d126417fe4603c3ed5c41b8958ac6
-  data.tar.gz: 9d5b13fb23d8f0334cf57aea46ed33e60978c517026755f8bf6880c7ac6c5fd13115ec08f378af20a8505cec64d3444a2e1b81b7f9e21b2cd2d537d480cbf159
+  metadata.gz: 8e2d94cbf60ef8697ac9a8fef81a46051939f2daac915ddb4b8b6d31193ef4cd87acfb27686c4762680e0ffbfe53653d4e9ccec2a304fbac9f8b5c604073a795
+  data.tar.gz: 5925ec6144d391cded1963e7790907dece0a8c945e269ce0c19c2a8f5e930395e98443c607a871690db8fef6306d4e6ad4722566fb70e79b13631597cb70f5e2

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Zh_Jk
+
+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

@@ -1,61 +1,71 @@
-# RUBY-CQHTTP
-
-[![Gem Version](https://badge.fury.io/rb/ruby-cqhttp.svg)](https://badge.fury.io/rb/ruby-cqhttp)
-[![yard docs](http://img.shields.io/badge/yard-docs-blue.svg)](https://rubydoc.info/github/fantasyzhjk/ruby-cqhttp)
-
-一个基于 OneBot 标准的 QQ 机器人框架
-
-用 Ruby 写 QQ 机器人！
-
-本库还在快速迭代更新中。。
-
-## 使用
-
-安装
-
-    $ gem install ruby-cqhttp
-
-或者
-
-在 `Gemfile` 中添加
-
-```ruby
-gem 'ruby-cqhttp'
-```
-
-然后运行
-
-    $ bundle
-
-## 示例
-
-```ruby
-require 'ruby-cqhttp'
-
-CQHttp::Bot.connect host: '127.0.0.1', port: 6700 do |bot|
-  bot.on :logged do |botQQ|
-    CQHttp::Utils.log('我开了欸')
-  end
-
-  bot.on :message do |msg, sdr, tar|
-    CQHttp::Utils.log('我收到消息了欸')
-  end
-
-  # 获取并发出好友撤回的消息
-  bot.on :notice do |notice_type, data|
-    if notice_type == 'friend_recall'
-      req = CQHttp::Api.get_msg data['message_id']
-      bot.sendPrivateMessage req['message'], req['sender']['user_id']
-    end
-  end
-  
-  # 自动同意群邀请和好友请求
-  bot.on :request do |request_type, data|
-    if request_type == 'group'
-      CQHttp::Api.acceptGroupRequest(data['flag'], data['sub_type']) if data['sub_type'] == 'invite'
-    elsif request_type == 'friend'
-      CQHttp::Api.acceptFriendRequest(data['flag'])
-    end
-  end
-end
-```
+# ruby-cqhttp
+
+[![Badge](https://img.shields.io/badge/OneBot-11-black?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAHAAAABwCAMAAADxPgR5AAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAAxQTFRF////29vbr6+vAAAAk1hCcwAAAAR0Uk5T////AEAqqfQAAAKcSURBVHja7NrbctswDATQXfD//zlpO7FlmwAWIOnOtNaTM5JwDMa8E+PNFz7g3waJ24fviyDPgfhz8fHP39cBcBL9KoJbQUxjA2iYqHL3FAnvzhL4GtVNUcoSZe6eSHizBcK5LL7dBr2AUZlev1ARRHCljzRALIEog6H3U6bCIyqIZdAT0eBuJYaGiJaHSjmkYIZd+qSGWAQnIaz2OArVnX6vrItQvbhZJtVGB5qX9wKqCMkb9W7aexfCO/rwQRBzsDIsYx4AOz0nhAtWu7bqkEQBO0Pr+Ftjt5fFCUEbm0Sbgdu8WSgJ5NgH2iu46R/o1UcBXJsFusWF/QUaz3RwJMEgngfaGGdSxJkE/Yg4lOBryBiMwvAhZrVMUUvwqU7F05b5WLaUIN4M4hRocQQRnEedgsn7TZB3UCpRrIJwQfqvGwsg18EnI2uSVNC8t+0QmMXogvbPg/xk+Mnw/6kW/rraUlvqgmFreAA09xW5t0AFlHrQZ3CsgvZm0FbHNKyBmheBKIF2cCA8A600aHPmFtRB1XvMsJAiza7LpPog0UJwccKdzw8rdf8MyN2ePYF896LC5hTzdZqxb6VNXInaupARLDNBWgI8spq4T0Qb5H4vWfPmHo8OyB1ito+AysNNz0oglj1U955sjUN9d41LnrX2D/u7eRwxyOaOpfyevCWbTgDEoilsOnu7zsKhjRCsnD/QzhdkYLBLXjiK4f3UWmcx2M7PO21CKVTH84638NTplt6JIQH0ZwCNuiWAfvuLhdrcOYPVO9eW3A67l7hZtgaY9GZo9AFc6cryjoeFBIWeU+npnk/nLE0OxCHL1eQsc1IciehjpJv5mqCsjeopaH6r15/MrxNnVhu7tmcslay2gO2Z1QfcfX0JMACG41/u0RrI9QAAAABJRU5ErkJggg==)](https://github.com/botuniverse/onebot-11)
+[![Gem Version](https://badge.fury.io/rb/ruby-cqhttp.svg)](https://badge.fury.io/rb/ruby-cqhttp)
+[![yard docs](http://img.shields.io/badge/yard-docs-blue.svg)](https://www.rubydoc.info/github/fantasyzhjk/ruby-cqhttp)
+
+![图标](https://raw.githubusercontent.com/fantasyzhjk/ruby-cqhttp/main/icon.png)
+
+一个基于 OneBot 标准的 QQ 机器人框架
+
+用 Ruby 写 QQ 机器人！
+
+本库还在快速迭代更新中。。(咕了
+
+## 使用
+
+安装
+
+    $ gem install ruby-cqhttp
+
+或者
+
+在 `Gemfile` 中添加
+
+```ruby
+gem 'ruby-cqhttp'
+```
+
+然后运行
+
+    $ bundle
+
+## 示例
+
+```ruby
+require 'onebot-ruby'
+
+logger = Onebot::Logging::Logger.new().setLoggerLevel(Logger::INFO) # 如果需要 logger 可以直接建立
+api = Onebot::Http::API.new().setLogger(logger)
+
+Onebot::Core.connect url: "ws://127.0.0.1:6700", logger: logger do |bot|
+  bot.on :logged do |botQQ|
+    logger.log('我开了欸')
+  end
+
+  bot.on :message do |data|
+    logger.log('我收到消息了欸')
+    # 复读
+    bot.sendMessage(data.message, data)
+  end
+
+  # 获取并发出好友撤回的消息
+  bot.on :notice do |notice_type, data|
+    if notice_type == 'friend_recall'
+      req = bot.get_msg(data.message_id)
+      bot.sendPrivateMessage req.message, req.sender.user_id
+    end
+  end
+  
+  # 自动同意群邀请和好友请求
+  bot.on :request do |request_type, data|
+    if request_type == 'group'
+      api.acceptGroupRequest(data.flag, data.sub_type) if data.sub_type == 'invite'
+    elsif request_type == 'friend'
+      api.acceptFriendRequest(data.flag)
+    end
+  end
+end
+```
+
+**具体使用方法请查看 examples*

data/lib/Core/Core.rb

@@ -0,0 +1,19 @@
+module Onebot
+  # 消息处理，ws连接
+  #
+  # Example:
+  #   Onebot::Core.connect host: host, port: port {|bot| ... }
+  class Core
+    # 新建连接
+    #
+    # @param host [String]
+    # @param port [Number]
+    # @return [WebSocket]
+    def self.connect(url:, logger: nil, protocols: nil, options: {})
+      client = ::Onebot::WebSocket::Client.new(url:, logger:)
+      yield client if block_given?
+      client.connect(protocols, options)
+      client
+    end
+  end
+end

data/lib/Core/Http/API.rb

@@ -0,0 +1,174 @@
+module Onebot
+  # OneBot标准API
+  # [OneBot文档] (https://github.com/howmanybots/onebot)
+  #
+  # Example:
+  #   Onebot::Api.getImage file
+  module Http
+    class API
+      # @return [URI] HTTP API链接
+      attr_accessor :url
+
+      # (初始化) 设置API地址
+      #
+      # @param host [String]
+      # @param port [Number]
+      # @return [URI]
+      def initialize(host: '127.0.0.1', port: 5700)
+        @url = URI::HTTP.build(host: host, port: port)
+        @logger = Logging::EventLogger.new
+      end
+
+      def setLogger(logger)
+        @logger = Logging::EventLogger.new(logger)
+        self
+      end
+
+      # 设置群名
+      #
+      # @param group_id [Number]
+      # @param group_name [String]
+      # @return [Hash]
+      def setGroupName(group_id, group_name)
+        data = sendReq('set_group_name', { group_id: group_id.to_i, group_name: })
+        if data['status'] == 'ok'
+          @logger.log '设置群头像成功'
+        else
+          @logger.log '设置群头像失败', Logger::WARN
+        end
+        data['data']
+      end
+
+      # 获取图片信息
+      #
+      # @param file [String]
+      # @return [Hash]
+      def getImage(file)
+        data = sendReq('get_image', { file: })
+        if data['status'] == 'ok'
+          @logger.log '下载图片成功'
+        else
+          @logger.log '下载图片失败', Logger::WARN
+        end
+        data['data']
+      end
+
+      # 获取消息
+      #
+      # @param message_id [Number]
+      # @return [Hash]
+      def get_msg(message_id)
+        data = sendReq('get_msg', { message_id: })
+        if data['status'] == 'ok'
+          @logger.log '消息获取成功'
+        else
+          @logger.log '消息获取失败', Logger::WARN
+        end
+        data['data']
+      end
+
+      # 发送私聊消息
+      #
+      # @param msg [String]
+      # @param user_id [Number]
+      # @return [Hash]
+      def sendPrivateMessage(msg, user_id)
+        data = sendReq('send_private_msg', { user_id:, message: msg })
+        if data['status'] == 'ok'
+          message_id = data['data']['message_id']
+          @logger.log "发送至私聊 #{user_id} 的消息: #{msg} (#{message_id})"
+        else
+          @logger.log '发送消息失败', Logger::WARN
+        end
+        data['data']
+      end
+
+      # 发送群聊消息
+      #
+      # @param msg [String]
+      # @param group_id [Number]
+      # @return [Hash]
+      def sendGroupMessage(msg, group_id)
+        data = sendReq('send_group_msg', { group_id:, message: msg })
+        if data['status'] == 'ok'
+          message_id = data['data']['message_id']
+          @logger.log "发送至群 #{group_id} 的消息: #{msg} (#{message_id})"
+        else
+          @logger.log '发送消息失败', Logger::WARN
+        end
+        data['data']
+      end
+
+      # 接受好友邀请
+      #
+      # @param flag [String]
+      # @param reason [String]
+      # @return [Boolean]
+      def acceptFriendRequest(flag, reason = nil)
+        data = sendReq('set_friend_add_request', { flag:, approve: true, remark: reason })
+        if data['status'] == 'ok'
+          @logger.log '已通过好友请求'
+          true
+        else
+          @logger.log '请求通过失败', Logger::WARN
+          false
+        end
+      end
+
+      # 拒绝好友邀请
+      #
+      # @param flag [String]
+      # @return [Boolean]
+      def refuseFriendRequest(flag)
+        data = sendReq('set_friend_add_request', { flag:, approve: false })
+        if data['status'] == 'ok'
+          @logger.log '已拒绝好友请求'
+          true
+        else
+          @logger.log '请求拒绝失败', Logger::WARN
+          false
+        end
+      end
+
+      # 接受加群请求
+      #
+      # @param flag [String]
+      # @param sub_type [String]
+      # @return [Boolean]
+      def acceptGroupRequest(flag, sub_type)
+        data = sendReq('set_group_add_request', { flag:, sub_type:, approve: true })
+        if data['status'] == 'ok'
+          @logger.log '已通过加群请求'
+          true
+        else
+          @logger.log '请求通过失败', Logger::WARN
+          false
+        end
+      end
+
+      # 拒绝加群请求
+      #
+      # @param flag [String]
+      # @param sub_type [String]
+      # @param reason [String]
+      # @return [Boolean]
+      def refuseGroupRequest(flag, sub_type, reason = nil)
+        data = sendReq('set_group_add_request', { flag:, sub_type:, approve: false, reason: })
+        if data['status'] == 'ok'
+          @logger.log '已拒绝加群请求'
+          true
+        else
+          @logger.log '请求拒绝失败', Logger::WARN
+          false
+        end
+      end
+
+      private
+
+      def sendReq(action, params, url = @url)
+        url.path = '/' << action
+        JSON.parse(Utils.httpPost(url, params.to_json))
+      end
+    end
+  end
+end

data/lib/Core/Logging/EventLogger.rb

@@ -0,0 +1,101 @@
+module Onebot
+  module Logging
+    class EventLogger
+      def initialize(logger = nil)
+        @logger = logger
+      end
+
+      def log(str, severity = ::Logger::INFO, app = 'Onebot')
+        return if @logger.nil?
+
+        @logger.log(str, severity, app)
+      end
+
+      #
+      #  消息解析部分
+      #
+      def dataParse(msg)
+        return if @logger.nil?
+
+        # 连接成功
+        @selfID = msg.self_id if msg.meta_event_type == 'lifecycle' && msg.sub_type == 'connect'
+        @logger.log(msg.to_json, ::Logger::DEBUG) if msg.meta_event_type != 'heartbeat' # 过滤心跳
+        case msg.post_type
+        #
+        # 请求事件
+        #
+        when 'request'
+          onReq(msg)
+        #
+        # 提醒事件
+        #
+        when 'notice'
+          onNotice(msg)
+        #
+        # 消息事件
+        #
+        when 'message'
+          onMsg(msg)
+        end
+      end
+
+      private
+
+      def onMsg(msg)
+        if msg.message_type == 'group' # 判断是否为群聊
+          @logger.log "收到群 #{msg.group_id} 内 #{msg.sender.nickname}(#{msg.user_id}) 的消息: #{msg.raw_message} (#{msg.message_id})"
+        else
+          @logger.log "收到好友 #{msg.sender.nickname}(#{msg.user_id}) 的消息: #{msg.raw_message} (#{msg.message_id})"
+        end
+      end
+
+      def onReq(msg)
+        case msg.request_type
+        when 'group'
+          if msg.sub_type == 'add'
+            @logger.log "收到用户 #{msg.user_id} 加群 #{msg.group_id} 的请求 (#{msg.flag})" # 加群请求
+          end
+          if msg.sub_type == 'invite'
+            @logger.log "收到用户 #{msg.user_id} 的加群 #{msg.group_id} 请求 (#{msg.flag})" # 加群邀请
+          end
+        when 'friend' # 加好友邀请
+          @logger.log "收到用户 #{msg.user_id} 的好友请求 (#{msg.flag})"
+        end
+      end
+
+      def onNotice(msg)
+        case msg.notice_type
+        when 'group_admin' # 群管理员变动
+          @logger.log "群 #{msg.group_id} 内 #{msg.user_id} 成了管理员" if msg.sub_type == 'set' # 设置管理员
+          @logger.log "群 #{msg.group_id} 内 #{msg.user_id} 没了管理员" if msg.sub_type == 'unset' # 取消管理员
+        when 'group_increase' # 群成员增加
+          if msg.sub_type == 'approve'
+            @logger.log "#{msg.operator_id} 已同意 #{msg.user_id} 进入了群 #{msg.group_id}" # 管理员已同意入群
+          end
+          if msg.sub_type == 'invite'
+            @logger.log "#{msg.operator_id} 邀请 #{msg.user_id} 进入了群 #{msg.group_id}" # 管理员邀请入群
+          end
+        when 'group_decrease' # 群成员减少
+          @logger.log "被 #{msg.operator_id} 踢出了群 #{msg.group_id}" if msg.sub_type == 'kick_me' # 登录号被踢
+          if msg.sub_type == 'kick'
+            @logger.log "#{msg.user_id} 被 #{msg.operator_id} 踢出了群 #{msg.group_id}" # 成员被踢
+          end
+          @logger.log "#{msg.operator_id} 退出了群 #{msg.group_id}" if msg.sub_type == 'leave' # 主动退群
+        when 'group_ban' # 群禁言
+          if msg.sub_type == 'ban'
+            @logger.log "群 #{msg.group_id} 内 #{msg.user_id} 被 #{msg.operator_id} 禁言了 #{msg.duration} 秒" # 禁言
+          end
+          if msg.sub_type == 'lift_ban'
+            @logger.log "群 #{msg.group_id} 内 #{msg.user_id} 被 #{msg.operator_id} 解除禁言" # 解除禁言
+          end
+        when 'friend_add' # 好友添加
+          @logger.log "#{msg.user_id} 成了你的好友"
+        when 'group_recall' # 群消息撤回
+          @logger.log "群 #{msg.group_id} 内 #{msg.user_id} 撤回了一条消息 (#{msg.message_id})"
+        when 'friend_recall' # 好友消息撤回
+          @logger.log "好友 #{msg.user_id} 撤回了一条消息 (#{msg.message_id})"
+        end
+      end
+    end
+  end
+end

data/lib/Core/Logging/Logger.rb

@@ -0,0 +1,58 @@
+module Onebot
+  module Logging
+    class Logger
+      # @!method stdLogger
+      #   @return [Logger] 终端Logger
+      # @!method fileLogger
+      #   @return [Logger] 文件Logger
+      # @!method loggerFile
+      #   @return [String] Logger文件地址
+      attr_accessor :stdLogger, :fileLogger, :loggerFile
+
+      # 初始化日志
+      #
+      # @param loggerFile [String]
+      def initialize(loggerFile = nil)
+        @loggerFile = loggerFile
+        @stdLogger = setLogger(::Logger.new($stdout))
+        @fileLogger = setLogger(::Logger.new(@loggerFile, 'daily')) if @loggerFile
+      end
+
+      # 设置日志等级
+      #
+      # @param loggerLevel [String]
+      def setLoggerLevel(loggerLevel)
+        @stdLogger.level = loggerLevel
+        @fileLogger.level = loggerLevel if @loggerFile
+        self
+      end
+
+      # 输出日志
+      #
+      # @param str [String]
+      # @param severity [Logger::INFO, Logger::DEBUG, Logger::WARN, Logger::ERROR]
+      # @param app [String]
+      def log(str, severity = ::Logger::INFO, app = 'Onebot')
+        @stdLogger.log(severity, str, app)
+        @fileLogger.log(severity, str, app) if @loggerFile
+      end
+
+      private
+
+      # 设置logger
+      def setLogger(logger)
+        logger.level = 'INFO'
+        logger.formatter = proc do |severity, datetime, progname, msg|
+          if progname.nil?
+            "[#{datetime.strftime('%Y-%m-%d %H:%M:%S')}][#{severity}]: #{msg.to_s.gsub(/\n/, '\n').gsub(/\r/, '\r')}\n"
+          else
+            "[#{datetime.strftime('%Y-%m-%d %H:%M:%S')}][#{progname}][#{severity}]: #{msg.to_s.gsub(/\n/, '\n').gsub(
+              /\r/, '\r'
+            )}\n"
+          end
+        end
+        logger
+      end
+    end
+  end
+end

data/lib/Core/Utils.rb

@@ -0,0 +1,85 @@
+module Onebot
+  # 各种工具包
+  #
+  # Example:
+  #   Onebot::Utils.log str, Logger::INFO
+  module Utils
+    extend self
+    # post发包
+    #
+    # @param url [URI]
+    # @param ret [String]
+    # @return [String]
+    def httpPost(url, ret)
+      req = Net::HTTP::Post.new(url.path, { 'Content-Type' => 'application/json' })
+      req.body = ret
+      res = Net::HTTP.start(url.hostname, url.port) do |http|
+        http.request(req)
+      end
+      res.body
+    end
+
+    alias post httpPost
+    # 消息转义
+    # & -> &
+    # [ -> [
+    # ] -> ]
+    #
+    # @param msg [String]
+    # @return [String]
+    def cqEscape(msg)
+      msg.gsub!('&', '&')
+      msg.gsub!('[', '[')
+      msg.gsub!(']', ']')
+      msg
+    end
+
+    # 消息反转义
+    # & -> &
+    # [ -> [
+    # ] -> ]
+    #
+    # @param msg [String]
+    # @return [String]
+    def cqUnescape(msg)
+      msg.gsub!('&', '&')
+      msg.gsub!('[', '[')
+      msg.gsub!(']', ']')
+      msg
+    end
+
+    # CQ码解析, 将字符串格式转换成 Onebot v11 的消息段数组格式
+    #
+    # @param cqmsg [String]
+    # @return [Array]
+    def cqParse(cqmsg)
+      msgary = []
+      cqary = cqmsg.scan(/\[CQ:(.*?),(.*?)\]/m)
+      isCode = false
+      i = 0
+      temp = ''
+      cqmsg.each_char do |c|
+        if isCode
+          if c == ']'
+            isCode = false
+            matches = cqary[i]
+            cqcode = { type: matches[0], data: {} }
+            matches[1].split(',').each do |arg|
+              args = arg.split('=')
+              cqcode[:data][args[0].to_sym] = args[1]
+            end
+            msgary << cqcode
+          end
+        elsif c == '['
+          msgary << { type: 'text', data: { text: cqEscape(temp) } }
+          temp = ''
+          isCode = true
+        else
+          temp << c
+        end
+      end
+      msgary << { type: 'text', data: { text: cqEscape(temp) } } unless temp.empty?
+      msgary
+    end
+  end
+end