rubirai 0.0.3.pre.a1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9af7ce359d2d64f6e7f1228870a74558fc3004b6b5f23257b951c13893ca4599
-  data.tar.gz: 421a1ecaa61dd1049501873197b01b22fe78bbdc7ef8c38766f20582ee598125
+  metadata.gz: 5f41f579f9ae1486c4a8f5af2e12e7e98e2aab20b880b9d2b1781eb57f480c3b
+  data.tar.gz: 2044c0aabd41caba57890b30b1951e0440046201e1b4eaa1f91fc766ae404e1a
 SHA512:
-  metadata.gz: ae1ada8f42c7d9c8df3422262782b2c2a5ee16a8611d104ccd53d78c156430d8e88e9d8bff1283b05bca3c7faf530ab8af71e3ea1cdf81dbfab9b296838bbbc5
-  data.tar.gz: 9621c881cd3812da59a2c1371c5ed56d87bd8971c6c472c056ce05b1159a37333f1d3701a0b3fe287278fe9e33b5de357baa7f8df4c7bbea554ab93a4c035224
+  metadata.gz: c34f19d099e6f2d85e403e93d9c03b82b5ad9325f26f7de0714e517b73d0ec041de372bf534bbffa34aef342394411012dd1cbf78da2a3afac87409006a547b7
+  data.tar.gz: 8392b2ea57dc0eb3df290a4e2b357bc184102879904fb38bbd5e9ce60bd7071b9be686fad559aff5b9ef4b8711e93bf205949fc9605991c661429425d3b31ebb

data/.github/workflows/docs.yml

@@ -5,7 +5,7 @@ on:
     branches: [ master ]
 
 jobs:
-  test:
+  gendoc:
     runs-on: ubuntu-latest
     strategy:
       matrix:

data/.github/workflows/package.yml

@@ -7,7 +7,6 @@ on:
 
 jobs:
   publish:
-    if: github.event.base_ref == 'refs/heads/master'
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2

data/.github/workflows/pull_request.yml

@@ -9,7 +9,9 @@ name: Pull Request
 
 on:
   pull_request:
-    branches: [ master ]
+    branches:
+      - master
+      - dev
 
 jobs:
   test:

data/README.md

@@ -11,6 +11,28 @@ A light-weight Mirai QQ bot http interface lib for Ruby.
 
 [中文][wiki] | [Rubydocs][rubydocs]
 
+## Description
+
+This library is designed specifically for integration with [mirai-api-http].
+[Mirai][mirai] is a QQ bot framework. The relationship is like this:
+
+```
+mirai <-jvm-> mirai-console <-plugin-> mirai-api-http <-http-> rubirai
+```
+
+[mirai-api-http]: https://github.com/project-mirai/mirai-api-http
+[mirai]: https://github.com/mamoe/mirai
+
+## Prerequisite
+
+Install [mirai-api-http] and configure its `setting.yml` file.
+
+Now its easier to enable `singleMode` if you have only one account
+in the mirai console.
+
+Note that you **must** enable Http Adapter with configuration of
+`http` under `adapterSettings`. More mode support to come.
+
 ## Usage
 
 First, download the package using `gem`. In your `Gemfile`, add
@@ -26,7 +48,7 @@ require 'rubirai'
 # assuming your mirai http api address and port
 # are 127.0.0.1 and 8080
 bot = Rubirai::Bot.new('127.0.0.1', '8080')
-# qq and auth key
+# qq and verify key
 bot.login 1145141919, 'ikisugi_key'
 
 # Add a listener function
@@ -53,10 +75,13 @@ gem install rubirai
 - [中文 Wiki][wiki]
 - [Docs][rubydocs]
 
-
 ## License
+
+[AGPL-3.0 License][license]
+
 [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FShimogawa%2Frubirai.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2FShimogawa%2Frubirai?ref=badge_large)
 
 
 [wiki]: https://github.com/Shimogawa/rubirai/wiki
 [rubydocs]: https://www.rebuild.moe/rubirai/
+[license]: LICENSE

data/lib/rubirai/auth.rb

@@ -2,11 +2,11 @@
 
 module Rubirai
   class Bot
-    # Start authentication. Will store the session.
-    # @param auth_key [String] the auth key defined in config file
+    # Start verification. Will store the session.
+    # @param verify_key [String] the auth key defined in config file
     # @return [String] the session key which will also be stored in the bot
-    def auth(auth_key)
-      v = call :post, '/auth', json: { "authKey": auth_key }
+    def verify(verify_key)
+      v = call :post, '/verify', json: { "verifyKey": verify_key }
       @session = v['session']
     end
 
@@ -14,11 +14,11 @@ module Rubirai
     # @param qq [String, Integer] qq id
     # @param session [String, nil] the session key. Set to `nil` will use the saved credentials.
     # @return [void]
-    def verify(qq, session = nil)
+    def bind(qq, session = nil)
       check qq, session
 
-      call :post, '/verify', json: { "sessionKey": @session || session, "qq": qq.to_i }
-      @session = session if session
+      call :post, '/bind', json: { "sessionKey": @session || session, "qq": qq.to_i }
+      @session ||= session
       @qq = qq
       nil
     end
@@ -42,13 +42,16 @@ module Rubirai
     # Log you in.
     #
     # @param qq [String, Integer] qq id
-    # @param auth_key [String] the auth key set in the settings file for mirai-api-http.
+    # @param verify_key [String] the auth key set in the settings file for mirai-api-http.
+    # @param single_mode [Boolean] if to skip binding (need to enable `singeMode` for
+    #                              mirai-http-api)
     # @return [void]
-    # @see #auth
+    # @see #bind
     # @see #verify
-    def login(qq, auth_key)
-      auth auth_key
-      verify qq
+    def login(qq, verify_key, single_mode: false)
+      verify verify_key
+      single_mode or bind(qq)
+      nil
     end
 
     alias connect login

data/lib/rubirai/events/event.rb

@@ -58,22 +58,7 @@ module Rubirai
           attr_keys.each do |k|
             k2 = k.to_s.snake_to_camel(lower: true)
             val = hash[k2]
-            val = case k2
-                  when 'group'
-                    Group.new val, bot
-                  when 'operator', 'member'
-                    GroupUser.new val, bot
-                  when 'sender'
-                    if val.key? 'group'
-                      GroupUser.new val, bot
-                    else
-                      User.new val, bot
-                    end
-                  when 'messageChain'
-                    MessageChain.new bot, val
-                  else
-                    val
-                  end
+            val = parse_val_from_key k2, val, bot
             instance_variable_set("@#{k}", val)
           end
         end
@@ -107,6 +92,27 @@ module Rubirai
       @raw = hash
       @bot = bot
     end
+
+    protected
+
+    def parse_val_from_key(key, val, bot)
+      case key
+      when 'group'
+        Group.new val, bot
+      when 'operator', 'member'
+        GroupUser.new val, bot
+      when 'sender'
+        if val.key? 'group'
+          GroupUser.new val, bot
+        else
+          User.new val, bot
+        end
+      when 'messageChain'
+        MessageChain.new bot, val
+      else
+        val
+      end
+    end
   end
 end
 

data/lib/rubirai/events/message_events.rb

@@ -15,7 +15,7 @@ module Rubirai
 
   # Friend message event
   class FriendMessageEvent < MessageEvent
-    # @!method initialize(hash, bot = nil)
+    # @!method initialize(hash, boxt = nil)
     #   @param hash [Hash]
     #   @param bot [Rubirai::Bot]
     # @!attribute [r] sender

data/lib/rubirai/listener.rb

@@ -7,7 +7,7 @@ module Rubirai
   class Bot
     # Start to listen for events
     #
-    # @param interval [Numeric] the interval to fetch events in seconds.
+    # @param interval [Integer, Float] the interval to fetch events in seconds.
     # @param is_blocking [Boolean] if the listen thread should block the current thread
     # @param ignore_error [Boolean] if errors should generate error events (see {RubiraiErrorEvent})
     # @return [void]

data/lib/rubirai/listing.rb

@@ -11,7 +11,7 @@ module Rubirai
       resp = call :get, '/friendList', params: {
         sessionKey: @session
       }
-      resp.map { |friend| User.new(friend, self) }
+      resp['data'].map { |friend| User.new(friend, self) }
     end
 
     # Get group list of the bot
@@ -20,7 +20,7 @@ module Rubirai
       resp = call :get, '/groupList', params: {
         sessionKey: @session
       }
-      resp.map { |group| Group.new(group, self) }
+      resp['data'].map { |group| Group.new(group, self) }
     end
 
     # Get member list of a group
@@ -31,7 +31,7 @@ module Rubirai
         sessionKey: @session,
         target: group_id
       }
-      resp.map { |member| GroupUser.new(member, self) }
+      resp['data'].map { |member| GroupUser.new(member, self) }
     end
   end
 end

data/lib/rubirai/message.rb

@@ -10,15 +10,17 @@ module Rubirai
     # @param target_qq [Integer] target qq id
     # @param group_id [Integer] group id
     # @param msgs [Array<Rubirai::Message, Hash, String, Object>] messages to form a chain, can be any type
+    # @param quote [NilClass, Integer] the message id to quote, nil for not quote
     # @return [Integer] message id
-    def send_temp_msg(target_qq, group_id, *msgs)
+    def send_temp_msg(target_qq, group_id, *msgs, quote: nil)
       chain = Rubirai::MessageChain.make(*msgs, bot: self)
       resp = call :post, '/sendTempMessage', json: {
         sessionKey: @session,
         qq: target_qq.to_i,
         group: group_id.to_i,
+        quote: quote,
         messageChain: chain.to_a
-      }
+      }.compact
       resp['messageId']
     end
 
@@ -27,15 +29,17 @@ module Rubirai
     # @param type [Symbol, String] options: [group, friend]
     # @param target_id [Integer] target qq/group id
     # @param msgs [Array<Rubirai::Message, Hash, String, Object>] messages to form a chain, can be any type
+    # @param quote [NilClass, Integer] the message id to quote, nil for not quote
     # @return [Integer] message id
-    def send_msg(type, target_id, *msgs)
+    def send_msg(type, target_id, *msgs, quote: nil)
       self.class.ensure_type_in type, 'group', 'friend'
       chain = Rubirai::MessageChain.make(*msgs, bot: self)
       resp = call :post, "/send#{type.to_s.snake_to_camel}Message", json: {
         sessionKey: @session,
         target: target_id.to_i,
+        quote: quote,
         messageChain: chain.to_a
-      }
+      }.compact
       resp['messageId']
     end
 
@@ -43,25 +47,28 @@ module Rubirai
     #
     # @param target_qq [Integer] target qq id
     # @param msgs [Array<Rubirai::Message, Hash, String, Object>] messages to form a chain, can be any type
+    # @param quote [NilClass, Integer] the message id to quote, nil for not quote
     # @return [Integer] message id
-    def send_friend_msg(target_qq, *msgs)
-      send_msg :friend, target_qq, *msgs
+    def send_friend_msg(target_qq, *msgs, quote: nil)
+      send_msg :friend, target_qq, *msgs, quote: quote
     end
 
     # Send group message
     #
     # @param target_group_id [Integer] group id
     # @param msgs [Array<Rubirai::Message, Hash, String, Object>] messages to form a chain, can be any type
+    # @param quote [NilClass, Integer] the message id to quote, nil for not quote
     # @return [Integer] message id
-    def send_group_msg(target_group_id, *msgs)
-      send_msg :group, target_group_id, *msgs
+    def send_group_msg(target_group_id, *msgs, quote: nil)
+      send_msg :group, target_group_id, *msgs, quote: quote
     end
 
     # Recall a message
     #
-    # @param msg_id [Integer] message id
+    # @param msg_id [Integer, Rubirai::MessageChain] message id
     # @return [void]
     def recall(msg_id)
+      msg_id = msg_id.id if msg_id.is_a? Rubirai::MessageChain
       call :post, '/recall', json: {
         sessionKey: @session,
         target: msg_id
@@ -114,34 +121,20 @@ module Rubirai
     #
     # @param msgs [Array<Rubirai::Message, Hash, String, Object>] messages to form a chain
     # @param quote [Boolean] if to quote the original message
-    # @return [void]
+    # @return [Integer] message id
     def respond(*msgs, quote: false)
       check_bot
-      msgs.prepend(gen_quote) if quote
+      quote_id = quote ? (@message_chain.id || nil) : nil
       case self
       when FriendMessageEvent
-        @bot.send_friend_msg(@sender.id, *msgs)
+        @bot.send_friend_msg(@sender.id, *msgs, quote: quote_id)
       when GroupMessageEvent
-        @bot.send_group_msg(@sender.group.id, *msgs)
+        @bot.send_group_msg(@sender.group.id, *msgs, quote: quote_id)
       when TempMessageEvent
-        @bot.send_temp_msg(@sender.id, @sender.group.id, *msgs)
+        @bot.send_temp_msg(@sender.id, @sender.group.id, *msgs, quote: quote_id)
       else
         raise 'undefined error'
       end
-      nil
-    end
-
-    # Generates a quote message from this event
-    #
-    # @return [QuoteMessage] the quote message
-    def gen_quote
-      QuoteMessage.from(
-        id: @message_chain.id,
-        group_id: @sender.is_a?(GroupUser) ? @sender.group.id : 0,
-        sender_id: @sender.id,
-        target_id: @sender.is_a?(GroupUser) ? @sender.group.id : @bot.qq,
-        origin: @message_chain
-      )
     end
 
     private

data/lib/rubirai/messages/interpolation.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+require 'rubirai/utils'
+
+module Rubirai
+  # @!attribute [r] has_interpolation
+  #   @return [Boolean] if this message chain has interpolation called by {#interpolated_str}
+  class MessageChain
+    attr_reader :has_interpolation
+
+    # Convert the message chain to an interpolated string.
+    #
+    # @return [String]
+    def interpolated_str
+      return @interpolated_str if @has_interpolation
+      @interpolated_str = _gen_interp_str
+      @has_interpolation = true
+      @interpolated_str
+    end
+
+    # Get the interpolated object by given id
+    #
+    # @param obj_id [String] the object id
+    # @return [Message, nil] the message. `nil` if `obj_id` is malformed or not found.
+    def get_object(obj_id)
+      _get_object(obj_id)
+    end
+
+    # Get a new chain from interpolated string generated from the original message chain.
+    # The given interpolated string can be a substring of original one so that elements
+    # can be extracted easily.
+    #
+    # @param str [String] the interpolated string
+    # @return [MessageChain] the message chain constructed
+    def chain_from_interpolated(str)
+      _interpolate_with_objects(str)
+    end
+
+    private
+
+    OBJ_INTERP_CHAR = '%'
+    OBJ_INTERP_LEN = 6
+
+    def _gen_interp_str
+      result = +''
+      @messages.each do |msg|
+        result << case msg
+                  when PlainMessage
+                    _transform_plain_txt(msg.text)
+                  else
+                    _transform_object(msg)
+                  end
+      end
+      result
+    end
+
+    def _transform_plain_txt(str)
+      str.gsub(OBJ_INTERP_CHAR, OBJ_INTERP_CHAR * 2)
+    end
+
+    def _transform_object(obj)
+      obj_id = Utils.random_str(OBJ_INTERP_LEN)
+      obj_id = Utils.random_str(OBJ_INTERP_LEN) while @ipl_objs_map.include?(obj_id)
+      @ipl_objs_map[obj_id] = obj
+      "#{OBJ_INTERP_CHAR}#{obj_id}#{OBJ_INTERP_CHAR}"
+    end
+
+    def _get_object(obj_id)
+      return nil if obj_id.length != OBJ_INTERP_LEN && obj_id.length != (OBJ_INTERP_LEN + 2)
+      return @ipl_objs_map[obj_id] if obj_id.length == OBJ_INTERP_LEN
+      return nil if obj_id[0] != OBJ_INTERP_CHAR || obj_id[-1] != OBJ_INTERP_CHAR
+
+      @ipl_objs_map[obj_id[1...-1]]
+    end
+
+    # @private
+    # @param str [String]
+    def _interpolate_with_objects(str)
+      sb = +''
+      result = MessageChain.new(bot)
+      i = 0
+      while i < str.length
+        if i == str.length - 1
+          sb << str[i]
+          break
+        end
+
+        if str[i] != OBJ_INTERP_CHAR
+          sb << str[i]
+          i += 1
+          next
+        end
+
+        if str[i + 1] == OBJ_INTERP_CHAR
+          sb << OBJ_INTERP_CHAR
+          i += 1
+        else
+          result.append PlainMessage.from(text: sb) unless sb.empty?
+          sb = str[i...i + OBJ_INTERP_LEN + 2]
+          obj = _get_object(sb)
+          i += OBJ_INTERP_LEN + 1
+          unless obj.nil?
+            result.append obj
+            sb = +''
+          end
+        end
+
+        i += 1
+      end
+
+      result.append PlainMessage.from(text: sb) unless sb.nil? || sb.empty?
+      result
+    end
+  end
+end

data/lib/rubirai/messages/message.rb

@@ -2,25 +2,75 @@
 
 require 'rubirai/utils'
 
+# @!method self.AtMessage(**kwargs)
+#   Form an {Rubirai::AtMessage}. The `display` option has no effect when
+#   sending at messages.
+#   @option kwargs [Integer] :target the target id
+#   @return [Rubirai::AtMessage] the message object
+#   @see Rubirai::AtMessage.from
+# @!method self.QuoteMessage(**kwargs)
+#   Form a {Rubirai::QuoteMessage}.
+#   @return [Rubirai::QuoteMessage] the message object
+#   @see Rubirai::QuoteMessage.from
+# @!method self.AtAllMessage()
+#   Form an {Rubirai::AtAllMessage}.
+#   @return [Rubirai::AtAllMessage] the message object
+#   @see Rubirai::AtAllMessage.from
+# @!method self.FaceMessage(**kwargs)
+#   Form a {Rubirai::FaceMessage}. Only needs to give one of the two arguments.
+#   @option kwargs [Integer] :face_id the face id (high priority)
+#   @option kwargs [String] :name the face's name (low priority)
+#   @return [Rubirai::FaceMessage] the message object
+#   @see Rubirai::FaceMessage.from
+# @!method self.PlainMessage(**kwargs)
+#   @option kwargs [String] :text the plain text
+#   @return [Rubirai::PlainMessage] the message object
+#   @see Rubirai::PlainMessage.from
+# @!method self.ImageMessage(**kwargs)
+#   Form an {Rubirai::ImageMessage}. Only needs to give one of the three arguments.
+#   @option kwargs [String] :image_id the image id
+#   @option kwargs [String] :url the url of the image
+#   @option kwargs [String] :path the local path of the image
+#   @return [Rubirai::ImageMessage] the message object
+#   @see Rubirai::ImageMessage.from
+# @!method self.FlashImageMessage(**kwargs)
+#   Form a {Rubirai::FlashImageMessage}. Only needs to give one of the three arguments.
+#   @option kwargs [String] :image_id the image id
+#   @option kwargs [String] :url the url of the image
+#   @option kwargs [String] :path the local path of the image
+#   @return [Rubirai::FlashImageMessage] the message object
+#   @see Rubirai::FlashImageMessage.from
+# @!method self.VoiceMessage(**kwargs)
+#   Form a {Rubirai::VoiceMessage}. Only needs to give one of the three arguments.
+#   @option kwargs [String] :voice_id the voice id
+#   @option kwargs [String] :url the url of the voice
+#   @option kwargs [String] :path the local path of the voice
+#   @return [Rubirai::VoiceMessage] the message object
+#   @see Rubirai::VoiceMessage.from
+# @!method self.XmlMessage(**kwargs)
+#   Form a {Rubirai::XmlMessage}.
+#   @option kwargs [String] :xml the xml body
+#   @return [Rubirai::XmlMessage] the message object
+#   @see Rubirai::XmlMessage.from
+# @!method self.JsonMessage(**kwargs)
+#   Form a {Rubirai::JsonMessage}.
+#   @option kwargs [String] :json the json body
+#   @return [Rubirai::JsonMessage] the message object
+#   @see Rubirai::JsonMessage.from
+# @!method self.AppMessage(**kwargs)
+#   Form an {Rubirai::AppMessage}.
+#   @option kwargs [String] :content the app body
+#   @return [Rubirai::AppMessage] the message object
+#   @see Rubirai::AppMessage.from
+# @!method self.PokeMessage(**kwargs)
+#   Form a {Rubirai::PokeMessage}.
+#   @option kwargs [String] :name the poke name
+#   @return [Rubirai::PokeMessage] the message object
+#   @see Rubirai::PokeMessage.from
 module Rubirai
   # The message abstract class.
   #
   # @abstract
-  # @!method self.AtMessage(**kwargs)
-  #   @param kwargs [Hash{Symbol => Object}] arguments
-  #   @return [Rubirai::AtMessage]
-  # @!method self.QuoteMessage(**kwargs)
-  #   @param kwargs [Hash{Symbol => Object}] arguments
-  #   @return [Rubirai::QuoteMessage]
-  # @!method self.AtAllMessage(**kwargs)
-  #   @param kwargs [Hash{Symbol => Object}] arguments
-  #   @return [Rubirai::AtAllMessage]
-  # @!method self.FaceMessage(**kwargs)
-  #   @param kwargs [Hash{Symbol => Object}] arguments
-  #   @return [Rubirai::FaceMessage]
-  # @!method self.PlainMessage(**kwargs)
-  #   @option text [String] the plain text
-  #   @return [Rubirai::PlainMessage]
   class Message
     # @!attribute [r] bot
     #   @return [Bot] the bot
@@ -30,7 +80,7 @@ module Rubirai
 
     # Objects to {Rubirai::Message}
     #
-    # @param msg [Rubirai::Message, Hash, Object] the object to transform to a message
+    # @param msg [Rubirai::Message, Hash{String => Object}, Object] the object to transform to a message
     # @return [Rubirai::Message] the message
     def self.to_message(msg, bot = nil)
       # noinspection RubyYardReturnMatch
@@ -150,6 +200,10 @@ module Rubirai
     end
   end
 
+  # {include:Rubirai::Message.to_message}
+  # @param obj [Message, Hash{String => Object}, Object] the object
+  # @return [Message] the message
+  # @see Rubirai::Message.to_message
   def self.Message(obj, bot = nil)
     Message.to_message obj, bot
   end
@@ -185,7 +239,9 @@ module Rubirai
     #   @return [Integer] the original receiver's (group or user) id
     # @!attribute [r] origin
     #   @return [MessageChain] the original message chain
-    set_message :Quote, :id, :group_id, :sender_id, :target_id, :origin
+    # @!method from(**kwargs)
+    #   Form a {QuoteMessage}.
+    set_message :Quote, :id, :group_id, :sender_id, :target_id, :origin, :origin_raw
 
     # @private
     def initialize(hash, bot = nil)
@@ -195,6 +251,18 @@ module Rubirai
       @sender_id = hash['senderId']
       @target_id = hash['targetId']
       @origin = MessageChain.make(*hash['origin'], bot: bot)
+      @origin_raw = hash['origin']
+    end
+
+    def to_h
+      {
+        'type' => 'Quote',
+        'id' => @id,
+        'groupId' => @group_id,
+        'senderId' => @sender_id,
+        'targetId' => @target_id,
+        'origin' => @origin_raw || @origin.to_a
+      }.compact
     end
   end
 
@@ -205,15 +273,16 @@ module Rubirai
     # @!attribute [r] display
     #   @return [String] the displayed name (not used when sending)
     # @!method from(**kwargs)
-    #   @param kwargs [Hash{Symbol => Object}] not used
+    #   Form an {AtMessage}. The `display` option has no effect when
+    #   sending at messages.
+    #   @option kwargs [Integer] :target the target id
     #   @return [AtMessage] the message object
     set_message :At, :target, :display
   end
 
   # The At All message type
   class AtAllMessage < Message
-    # @!method from(**kwargs)
-    #   @param kwargs [Hash{Symbol => Object}] the fields to set
+    # @!method from()
     #   @return [AtAllMessage] the message object
     set_message :AtAll
   end
@@ -224,6 +293,12 @@ module Rubirai
     #   @return [Integer] the face's id
     # @!attribute [r] name
     #   @return [String, nil] the face's name
+    # @!method from(**kwargs)
+    #   Form a {Rubirai::FaceMessage}. Only needs to give one of the two arguments.
+    #   @option kwargs [Integer] :face_id the face id (high priority)
+    #   @option kwargs [String] :name the face's name (low priority)
+    #   @return [Rubirai::FaceMessage] the message object
+    #   @!scope class
     set_message :Face, :face_id, :name
   end
 
@@ -231,6 +306,10 @@ module Rubirai
   class PlainMessage < Message
     # @!attribute [r] text
     #   @return [String] the text
+    # @!method from(**kwargs)
+    #   @option kwargs [String] :text the plain text
+    #   @return [PlainMessage] the message object
+    #   @!scope class
     set_message :Plain, :text
   end
 
@@ -238,21 +317,54 @@ module Rubirai
   # Only one out of the three fields is needed to form the message.
   class ImageMessage < Message
     # @!attribute [r] image_id
-    #   @return [Integer, nil] the image id from mirai
+    #   @return [String, nil] the image id from mirai
     # @!attribute [r] url
     #   @return [String, nil] the url of the image
     # @!attribute [r] path
     #   @return [String, nil] the local path of the image
+    # @!method from(**kwargs)
+    #   Form an {Rubirai::ImageMessage}. Only needs to give one of the three arguments.
+    #   @option kwargs [String] :image_id the image id
+    #   @option kwargs [String] :url the url of the image
+    #   @option kwargs [String] :path the local path of the image
+    #   @return [Rubirai::ImageMessage] the message object
+    #   @!scope class
     set_message :Image, :image_id, :url, :path
   end
 
   # The flash image message type
   class FlashImageMessage < Message
+    # @!attribute [r] image_id
+    #   @return [String, nil] the image id from mirai
+    # @!attribute [r] url
+    #   @return [String, nil] the url of the image
+    # @!attribute [r] path
+    #   @return [String, nil] the local path of the image
+    # @!method from(**kwargs)
+    #   Form a {Rubirai::FlashImageMessage}. Only needs to give one of the three arguments.
+    #   @option kwargs [String] :image_id the image id
+    #   @option kwargs [String] :url the url of the image
+    #   @option kwargs [String] :path the local path of the image
+    #   @return [Rubirai::FlashImageMessage] the message object
+    #   @!scope class
     set_message :FlashImage, :image_id, :url, :path
   end
 
   # The voice message type
   class VoiceMessage < Message
+    # @!attribute [r] voice_id
+    #   @return [String, nil] the voice id from mirai
+    # @!attribute [r] url
+    #   @return [String, nil] the url of the voice
+    # @!attribute [r] path
+    #   @return [String, nil] the local path of the voice
+    # @!method from(**kwargs)
+    #   Form a {Rubirai::VoiceMessage}. Only needs to give one of the three arguments.
+    #   @option kwargs [String] :voice_id the voice id
+    #   @option kwargs [String] :url the url of the voice
+    #   @option kwargs [String] :path the local path of the voice
+    #   @return [Rubirai::VoiceMessage] the message object
+    #   @!scope class
     set_message :Voice, :voice_id, :url, :path
   end
 
@@ -260,6 +372,11 @@ module Rubirai
   class XmlMessage < Message
     # @!attribute [r] xml
     #   @return [String] the xml content
+    # @!method from(**kwargs)
+    #   Form a {Rubirai::XmlMessage}.
+    #   @option kwargs [String] :xml the xml body
+    #   @return [Rubirai::XmlMessage] the message object
+    #   @!scope class
     set_message :Xml, :xml
   end
 
@@ -267,6 +384,11 @@ module Rubirai
   class JsonMessage < Message
     # @!attribute [r] json
     #   @return [String] the json content
+    # @!method from(**kwargs)
+    #   Form a {Rubirai::JsonMessage}.
+    #   @option kwargs [String] :json the json body
+    #   @return [Rubirai::JsonMessage] the message object
+    #   @!scope class
     set_message :Json, :json
   end
 
@@ -274,27 +396,72 @@ module Rubirai
   class AppMessage < Message
     # @!attribute [r] content
     #   @return [String] the app content
+    # @!method from(**kwargs)
+    #   Form an {Rubirai::AppMessage}.
+    #   @option kwargs [String] :content the app body
+    #   @return [Rubirai::AppMessage] the message object
+    #   @!scope class
     set_message :App, :content
   end
 
+  # The poke message type
   class PokeMessage < Message
+    # @!attribute [r] name
+    #   @return [String] type (name) of the poke
+    # @!method from(**kwargs)
+    #   Form an {Rubirai::PokeMessage}.
+    #   @option kwargs [String] :name the name (type) of poke
+    #   @return [Rubirai::PokeMessage] the message object
+    #   @!scope class
     set_message :Poke, :name
   end
 
+  # The forward message type
   class ForwardMessage < Message
+    # A message node in the forward message list
+    #
+    # @!attribute [r] sender_id
+    #   @return [Integer] sender id
+    # @!attribute [r] time
+    #   @return [Integer] send timestamp (second)
+    # @!attribute [r] sender_name
+    #   @return [String] the sender name
+    # @!attribute [r] message_chain
+    #   @return [MessageChain] the message chain
     class Node
       attr_reader :sender_id, :time, :sender_name, :message_chain
 
+      # @private
       def initialize(hash, bot = nil)
+        return unless hash
         @sender_id = hash['senderId']
         @time = hash['time']
         @sender_name = hash['senderName']
         @message_chain = MessageChain.make(*hash['messageChain'], bot: bot)
       end
+
+      def self.from(**kwargs)
+        n = new({})
+        %i[sender_id time sender_name message_chain].each do |attr|
+          n.instance_variable_set("@#{attr}", kwargs[attr])
+        end
+      end
     end
 
+    # @!attribute [r] title
+    #   @return [String] the title
+    # @!attribute [r] brief
+    #   @return [String] the brief text
+    # @!attribute [r] source
+    #   @return [String] the source text
+    # @!attribute [r] summary
+    #   @return [String] the summary text
+    # @!attribute [r] node_list
+    #   @return [Array<Node>] the node list
+    #   @see Node
     set_message :Forward, :title, :brief, :source, :summary, :node_list
 
+    # @private
     def initialize(hash, bot = nil)
       super :Forward, bot
       @title = hash['title']
@@ -307,15 +474,42 @@ module Rubirai
     end
   end
 
+  # The file message type
   class FileMessage < Message
+    # @!attribute [r] id
+    #   @return [String] the file id
+    # @!attribute [r] internal_id
+    #   @return [Integer] the internal id needed by server
+    # @!attribute [r] name
+    #   @return [String] the filename
+    # @!attribute [r] size
+    #   @return [Integer] the file size
     set_message :File, :id, :internal_id, :name, :size
   end
 
+  # The music share card message
   class MusicShareMessage < Message
+    # List all kinds of music providers
+    #
+    # @return [Array<String>] kinds
     def self.all_kinds
       %w[NeteaseCloudMusic QQMusic MiguMusic]
     end
 
+    # @!attribute [r] kind
+    #   @return [String] the kind of music provider
+    # @!attribute [r] title
+    #   @return [String] the music card title
+    # @!attribute [r] summary
+    #   @return [String] the music card summary
+    # @!attribute [r] jump_url
+    #   @return [String] the jump url
+    # @!attribute [r] picture_url
+    #   @return [String] the picture's url
+    # @!attribute [r] music_url
+    #   @return [String] the music's url
+    # @!attribute [r] brief
+    #   @return [String, nil] the brief message (optional)
     set_message :MusicShare, :kind, :title, :summary, :jump_url, :picture_url, :music_url, :brief do |hash|
       raise(RubiraiError, 'non valid music type') unless all_kinds.include? hash['kind']
     end

data/lib/rubirai/messages/message_chain.rb

@@ -5,18 +5,21 @@ require 'rubirai/messages/message'
 
 module Rubirai
   # Message chain
+  #
+  # @!attribute [r] bot
+  #   @return [Bot] the bot object
+  # @!attribute [r] id
+  #   @return [Integer, nil] the message id, may be `nil`
+  # @!attribute [r] raw
+  #   @return [Hash{String => Object}, nil] the raw message chain, may be `nil`
+  # @!attribute [r] send_time
+  #   @return [Integer, nil] the send time of the message chain, may be `nil`
+  # @!attribute [r] messages
+  #   @return [Array<Message>] the raw message array
   class MessageChain
     include Enumerable
 
-    # @!attribute [r] bot
-    #   @return [Bot] the bot object
-    # @!attribute [r] id
-    #   @return [Integer, nil] the message id, may be `nil`
-    # @!attribute [r] send_time
-    #   @return [Integer, nil] the send time of the message chain, may be `nil`
-    # @!attribute [r] messages
-    #   @return [Array<Message>] the raw message array
-    attr_reader :bot, :id, :send_time, :messages
+    attr_reader :bot, :id, :raw, :send_time, :messages
 
     # Makes a message chain from a list of messages
     #
@@ -87,10 +90,13 @@ module Rubirai
     # @private
     # @param bot [Rubirai::Bot, nil]
     # @param source [Array, nil]
-    # @param id [Integer, nil]
     def initialize(bot = nil, source = nil)
       @bot = bot
       @messages = []
+      @has_interpolation = false
+      @interpolated_str = nil
+      @ipl_objs_map = {}
+      @raw = source
       return unless source
       raise(MiraiError, 'source is not array') unless source.is_a? Array
       raise(MiraiError, 'length is zero') if source.empty?
@@ -130,7 +136,12 @@ module Rubirai
   end
 
   # Makes a message chain. See {MessageChain#make}.
+  #
+  # @return [MessageChain] the message chain made.
+  # @see MessageChain#make
   def self.MessageChain(*messages, bot: nil)
     MessageChain.make(*messages, bot: bot)
   end
 end
+
+require 'rubirai/messages/interpolation'

data/lib/rubirai/objects/group_info.rb

@@ -5,6 +5,11 @@ require 'rubirai/utils'
 module Rubirai
   # The abstract class for group information
   # @abstract
+  #
+  # @!attribute [r] raw
+  #   @return [Hash{String => Object}] the raw hash
+  # @!attribute [r] bot
+  #   @return [Bot] the bot
   class GroupInfo
     # @private
     def self.set_fields(*fields, **default_values)
@@ -34,10 +39,6 @@ module Rubirai
       attr_writer(*fields)
     end
 
-    # @!attribute [r] raw
-    #   @return [Hash{String => Object}] the raw hash
-    # @!attribute [r] bot
-    #   @return [Bot] the bot
     attr_reader :raw, :bot
 
     # @private

data/lib/rubirai/utils.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'securerandom'
+
 # @private
 class Hash
   def stringify_keys!
@@ -60,3 +62,11 @@ class Object
     end
   end
 end
+
+module Rubirai
+  module Utils
+    def self.random_str(len)
+      SecureRandom.alphanumeric len
+    end
+  end
+end

data/lib/rubirai/version.rb

@@ -2,8 +2,8 @@
 
 module Rubirai
   # Rubirai version
-  VERSION = '0.0.3-a1'
+  VERSION = '0.2.0'
 
   # mirai-api-http version
-  MIRAI_API_VERSION = '1.10.0'
+  MIRAI_API_VERSION = '2.5.0'
 end

data/lib/rubirai.rb

@@ -1,3 +1,11 @@
+# Copyright 2021 Rebuild.
+#
+# 此源代码的使用受 GNU AFFERO GENERAL PUBLIC LICENSE version 3 许可证的约束, 可以在以下链接找到该许可证.
+# Use of this source code is governed by the GNU AGPLv3 license that can be found through the following link.
+#
+# https://github.com/Shimogawa/rubirai/blob/master/LICENSE
+#
+
 # frozen_string_literal: true
 
 require 'rubirai/errors'
@@ -8,13 +16,14 @@ module Rubirai
   require 'http'
 
   # Bot represents a QQ bot at mirai side. All functions are API calls to the http plugin.
+  #
+  # @!attribute [r] base_uri
+  #   @return [String] the base uri of mirai-api-http which the bot will send messages to
+  # @!attribute [r] session
+  #   @return [String] the session key
+  # @!attribute [r] qq
+  #   @return [String, Integer] the qq of the bot
   class Bot
-    # @!attribute [r] base_uri
-    #   @return [String] the base uri of mirai-api-http which the bot will send messages to
-    # @!attribute [r] session
-    #   @return [String] the session key
-    # @!attribute [r] qq
-    #   @return [String, Integer] the qq of the bot
     attr_reader :base_uri, :session, :qq
 
     alias id qq
@@ -28,10 +37,12 @@ module Rubirai
       @listener_funcs = []
     end
 
+    # @private
     def gen_uri(path)
       URI.join(base_uri, path)
     end
 
+    # @private
     def self.ensure_type_in(type, *types)
       types = types.map { |x| x.to_s.downcase }
       type.to_s.downcase.must_be_one_of! types, RubiraiError, "not valid type: should be one of #{types}"
@@ -47,7 +58,7 @@ module Rubirai
 
       body = JSON.parse(resp.body)
       if (body.is_a? Hash) && (body.include? 'code') && (body['code'] != 0)
-        raise MiraiError.new(body['code'], body['msg'] || body['errorMessage'])
+        raise MiraiError.new(body['code'], body['msg'])
       end
 
       body

data/spec/auth_spec.rb

@@ -12,38 +12,38 @@ describe 'auth api' do
   end
 
   it 'should be able to authenticate' do
-    stub_request(:post, @mirai_bot.gen_uri('/auth'))
+    stub_request(:post, @mirai_bot.gen_uri('/verify'))
       .with(body: {
-        "authKey": @auth_key
+        "verifyKey": @verify_key
       })
       .to_return(status: 200, body: %({
           "code": 0,
           "session": "#{@session_key}"
       }))
-    res = @mirai_bot.auth @auth_key
+    res = @mirai_bot.verify @verify_key
     expect(res).to be_a_kind_of(String)
     expect(res).to eq(@session_key)
   end
 
   it 'should raise error if authenticate fails' do
     mirai_bot = new_bot
-    stub_request(:post, @mirai_bot.gen_uri('/auth'))
+    stub_request(:post, @mirai_bot.gen_uri('/verify'))
       .with(body: {
-        "authKey": @auth_key
+        "verifyKey": @verify_key
       })
       .to_return(status: 200, body: %({
           "code": 1,
           "session": ""
       }))
 
-    expect { mirai_bot.auth @auth_key }.to raise_error(
+    expect { mirai_bot.verify @verify_key }.to raise_error(
       Rubirai::MiraiError,
       'Mirai error: 1 - Wrong auth key'
     )
   end
 
   it 'should be able to verify' do
-    stub_request(:post, @mirai_bot.gen_uri('/verify'))
+    stub_request(:post, @mirai_bot.gen_uri('/bind'))
       .with(body: {
         "sessionKey": @session_key,
         "qq": @qq
@@ -53,11 +53,11 @@ describe 'auth api' do
           "session": "success"
       }))
 
-    expect { @mirai_bot.verify @qq }.not_to raise_error
-    expect(@mirai_bot.verify(@qq)).to be_nil
+    expect { @mirai_bot.bind @qq }.not_to raise_error
+    expect(@mirai_bot.bind(@qq)).to be_nil
 
-    expect { @mirai_bot.verify '1ab39cde' }.to raise_error(Rubirai::RubiraiError, 'Wrong format for qq')
-    expect { new_bot.verify @qq }.to raise_error(Rubirai::RubiraiError, 'No session provided')
+    expect { @mirai_bot.bind '1ab39cde' }.to raise_error(Rubirai::RubiraiError, 'Wrong format for qq')
+    expect { new_bot.bind @qq }.to raise_error(Rubirai::RubiraiError, 'No session provided')
   end
 
   it 'should be able to release' do
@@ -90,7 +90,7 @@ describe 'auth api' do
           "msg": "success"
       }))
     expect do
-      expect(mirai_bot.login(@qq, @auth_key)).to be_nil
+      expect(mirai_bot.login(@qq, @verify_key)).to be_nil
     end.not_to raise_error
     expect(mirai_bot.instance_variable_get('@session')).to eq(@session_key)
 

data/spec/events/event_spec.rb

@@ -76,6 +76,7 @@ describe Rubirai::Event do
     expect(e.class.type).to eq(:BotGroupPermissionChangeEvent)
     expect(e.origin).to eq(Rubirai::Group::Permission::MEMBER)
     expect(e.new).to eq(Rubirai::Group::Permission::ADMINISTRATOR)
+    expect(e.group).to be_a(Rubirai::Group)
     expect(e.group.id).to eq(123456789)
   end
 end

data/spec/message_spec.rb

@@ -6,7 +6,7 @@ describe 'message api' do
   before :all do
     @mirai_bot = new_bot
     stub_login
-    @mirai_bot.login @qq, @auth_key
+    @mirai_bot.login @qq, @verify_key
   end
 
   after do
@@ -84,4 +84,48 @@ describe 'message api' do
       expect(@mirai_bot.recall(123)).to be_nil
     end.not_to raise_error
   end
+
+  it 'should be able to respond to a message event' do
+    e = Rubirai::Event.parse({
+      "type": 'GroupMessage',
+      "messageChain": [
+        {
+          "type": 'Source',
+          "id": 123456,
+          "time": 123456789
+        }.stringify_keys,
+        {
+          "type": 'Plain',
+          "text": 'Miral牛逼'
+        }.stringify_keys
+      ],
+      "sender": {
+        "id": 123456789,
+        "memberName": '化腾',
+        "permission": 'MEMBER',
+        "group": {
+          "id": 1234567890,
+          "name": 'Miral Technology',
+          "permission": 'MEMBER'
+        }.stringify_keys
+      }.stringify_keys
+    }.stringify_keys, @mirai_bot)
+    stub_request(:post, @mirai_bot.gen_uri('/sendGroupMessage'))
+      .with(body: {
+        "sessionKey": 'test_session_key',
+        "target": 1234567890,
+        "quote": 123456,
+        "messageChain": [
+          { "text": 'hi', "type": 'Plain' }
+        ]
+      })
+      .to_return(status: 200, body: %({
+          "code": 0,
+          "msg": "success",
+          "messageId": 1234567890
+      }))
+    expect(e).to be_a(Rubirai::GroupMessageEvent)
+    msg_id = e.respond 'hi', quote: true
+    expect(msg_id).to eq(1234567890)
+  end
 end

data/spec/messages/interpolation_spec.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+describe Rubirai::MessageChain do
+  before do
+    hash = {
+      "type": 'Quote',
+      "id": 123456,
+      "groupId": 123456789,
+      "senderId": 987654321,
+      "targetId": 9876543210,
+      "origin": [
+        { "type": 'Plain', text: 'text' }.stringify_keys
+      ]
+    }.stringify_keys
+    @obj = Rubirai::AtMessage.from(target: 114514)
+    @chain = Rubirai::MessageChain.make(
+      'hi%', 2, @obj, 3, 'great %%,', :good, hash
+    )
+    @expect_pattern = /^hi%%2%[a-zA-Z0-9]{6}%3great %%%%,good%[a-zA-Z0-9]{6}%$/
+  end
+
+  after do
+  end
+
+  it 'should convert message chains to strings correctly' do
+    expect(@chain.has_interpolation).to be_falsey
+
+    str = @chain.interpolated_str
+    expect(@chain.has_interpolation).to be_truthy
+    objs_map = @chain.instance_variable_get('@ipl_objs_map')
+    expect(objs_map.length).to be(2)
+    objs_map.each_key do |k|
+      expect(str.include?(k)).to be_truthy
+    end
+    expect(@expect_pattern.match?(str)).to be_truthy
+    expect(@chain.interpolated_str).to eq(str)
+  end
+
+  it 'should get back the original object' do
+    str = @chain.interpolated_str
+    idx = 5
+    obj = @chain.get_object(str[idx...idx + 8])
+    expect(obj).to eq(@obj)
+    obj = @chain.get_object(str[idx + 1...idx + 7])
+    expect(obj).to eq(@obj)
+    expect(@chain.get_object(str[idx + 2...idx + 8])).to be_nil
+  end
+
+  it 'should construct new message chain for interpolated strings' do
+    str = @chain.interpolated_str[5...5 + 8 + 3]
+    chain = @chain.chain_from_interpolated(str)
+    expect(chain.length).to eq(2)
+    expect(chain[0]).to eq(@obj)
+    expect(chain[1]).to be_a(Rubirai::PlainMessage)
+    expect(chain[1].text).to eq('3gr')
+
+    chain = @chain.chain_from_interpolated(@chain.interpolated_str)
+    expect(chain.length).to eq(@chain.length)
+    expect(chain[0].text).to eq('hi%2')
+    expect(chain[1]).to eq(@obj)
+    expect(chain[2].text).to eq('3great %%,good')
+    expect(chain[3]).to be_a(Rubirai::QuoteMessage)
+  end
+end

data/spec/spec_helper.rb

@@ -24,22 +24,22 @@ WebMock.disable_net_connect!(allow_localhost: false)
 
 RSpec.configure do |config|
   config.before :all do
-    @auth_key = 'test_auth_key'
+    @verify_key = 'test_verify_key'
     @session_key = 'test_session_key'
     @qq = 1145141919
   end
 end
 
 def stub_login
-  stub_request(:post, @mirai_bot.gen_uri('/auth'))
+  stub_request(:post, @mirai_bot.gen_uri('/verify'))
     .with(body: {
-      "authKey": @auth_key
+      "verifyKey": @verify_key
     })
     .to_return(status: 200, body: %({
           "code": 0,
           "session": "#{@session_key}"
       }))
-  stub_request(:post, @mirai_bot.gen_uri('/verify'))
+  stub_request(:post, @mirai_bot.gen_uri('/bind'))
     .with(body: {
       "sessionKey": @session_key,
       "qq": @qq

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubirai
 version: !ruby/object:Gem::Version
-  version: 0.0.3.pre.a1
+  version: 0.2.0
 platform: ruby
 authors:
 - Rebuild
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-30 00:00:00.000000000 Z
+date: 2022-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -73,6 +73,7 @@ files:
 - lib/rubirai/listing.rb
 - lib/rubirai/management.rb
 - lib/rubirai/message.rb
+- lib/rubirai/messages/interpolation.rb
 - lib/rubirai/messages/message.rb
 - lib/rubirai/messages/message_chain.rb
 - lib/rubirai/multipart.rb
@@ -90,6 +91,7 @@ files:
 - spec/error_spec.rb
 - spec/events/event_spec.rb
 - spec/message_spec.rb
+- spec/messages/interpolation_spec.rb
 - spec/messages/message_chain_spec.rb
 - spec/messages/message_spec.rb
 - spec/plugin_info_spec.rb
@@ -111,9 +113,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.0.3.1
 signing_key: