rubirai 0.0.2 → 0.0.3.pre.a1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1e4f114e6246e5449ef45b0ffe65436287a13fb213675a831df0139e710f931
-  data.tar.gz: f65b3a647129a20ca95ac94536a9ac25c750f26afe0ccf1fbf690da0255b0c81
+  metadata.gz: 9af7ce359d2d64f6e7f1228870a74558fc3004b6b5f23257b951c13893ca4599
+  data.tar.gz: 421a1ecaa61dd1049501873197b01b22fe78bbdc7ef8c38766f20582ee598125
 SHA512:
-  metadata.gz: 98fee9c38a3ff90729799a97bd095dbe78f15fd96113528e151d23ef3ee1b6803c4225fd47104863b89d7a8b49d82c6a79af7720fc6ae2a9cb0dc15b2b24a3e3
-  data.tar.gz: ecca01ed496c19207979bb056aec2b3dc5f70e775156fb11108025c58adf560cdffec58a5075b53ec546c891bdd609f763e5c7e0f48a9bfb7c68a39f6f764f49
+  metadata.gz: ae1ada8f42c7d9c8df3422262782b2c2a5ee16a8611d104ccd53d78c156430d8e88e9d8bff1283b05bca3c7faf530ab8af71e3ea1cdf81dbfab9b296838bbbc5
+  data.tar.gz: 9621c881cd3812da59a2c1371c5ed56d87bd8971c6c472c056ce05b1159a37333f1d3701a0b3fe287278fe9e33b5de357baa7f8df4c7bbea554ab93a4c035224

data/.github/workflows/CI.yml

@@ -32,33 +32,3 @@ jobs:
           CI: "true"
           CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
         run: bundle exec rake
-  publish:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - name: Set up Ruby 2.6
-        uses: actions/setup-ruby@v1
-        with:
-          ruby-version: 2.6.x
-      - name: Publish to GPR
-        run: |
-          mkdir -p $HOME/.gem
-          touch $HOME/.gem/credentials
-          chmod 0600 $HOME/.gem/credentials
-          printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
-          gem build *.gemspec
-          gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
-        env:
-          GEM_HOST_API_KEY: "Bearer ${{secrets.GITHUB_TOKEN}}"
-          OWNER: ${{ github.repository_owner }}
-
-      - name: Publish to RubyGems
-        run: |
-          mkdir -p $HOME/.gem
-          touch $HOME/.gem/credentials
-          chmod 0600 $HOME/.gem/credentials
-          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
-          gem build *.gemspec
-          gem push *.gem
-        env:
-          GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.github/workflows/package.yml

@@ -0,0 +1,39 @@
+name: Package
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  publish:
+    if: github.event.base_ref == 'refs/heads/master'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby 2.6
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: 2.6.x
+      - name: Publish to GPR
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+        env:
+          GEM_HOST_API_KEY: "Bearer ${{secrets.GITHUB_TOKEN}}"
+          OWNER: ${{ github.repository_owner }}
+
+      - name: Publish to RubyGems
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push *.gem
+        env:
+          GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.rubocop.yml

@@ -39,3 +39,6 @@ Metrics/PerceivedComplexity:
 
 Naming/AccessorMethodName:
   Enabled: false
+
+Style/AsciiComments:
+  Enabled: false

data/README.md

@@ -1,15 +1,26 @@
 # Rubirai
+
+[![Gem Version](https://badge.fury.io/rb/rubirai.svg)](https://rubygems.org/gems/rubirai)
 [![CI](https://github.com/Shimogawa/rubirai/actions/workflows/CI.yml/badge.svg?branch=master)](https://github.com/Shimogawa/rubirai/actions/workflows/CI.yml)
 [![codecov](https://codecov.io/gh/Shimogawa/rubirai/branch/master/graph/badge.svg?token=OVUVEWFPKY)](https://codecov.io/gh/Shimogawa/rubirai)
 [![Maintainability](https://api.codeclimate.com/v1/badges/9a9d8c887e5deb601e1e/maintainability)](https://codeclimate.com/github/Shimogawa/rubirai/maintainability)
 [![Inline docs](http://inch-ci.org/github/shimogawa/rubirai.svg?branch=master)](http://inch-ci.org/github/shimogawa/rubirai)
 [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FShimogawa%2Frubirai.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2FShimogawa%2Frubirai?ref=badge_shield)
 
-
 A light-weight Mirai QQ bot http interface lib for Ruby.
 
+[中文][wiki] | [Rubydocs][rubydocs]
+
 ## Usage
 
+First, download the package using `gem`. In your `Gemfile`, add
+
+```ruby
+gem 'rubirai'
+```
+
+Then, start to write code (no matter if it's a rails application or something else):
+
 ```ruby
 require 'rubirai'
 # assuming your mirai http api address and port
@@ -17,8 +28,35 @@ require 'rubirai'
 bot = Rubirai::Bot.new('127.0.0.1', '8080')
 # qq and auth key
 bot.login 1145141919, 'ikisugi_key'
+
+# Add a listener function
+bot.add_listener do |event|
+  puts event.inspect
+  if event.is_a?(Rubirai::MessageEvent)
+    event.respond("Hello, world!")
+  end
+end
+
+# Listen to message every 0.5 seconds
+# And blocks the current thread
+bot.start_listen 0.5, is_blocking: true
+```
+
+> If you want to install globally with `gem`, use
+
+```bash
+gem install rubirai 
 ```
 
+## Wiki and Documentation
+
+- [中文 Wiki][wiki]
+- [Docs][rubydocs]
+
 
 ## 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)
+[![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/

data/lib/rubirai.rb

@@ -17,6 +17,8 @@ module Rubirai
     #   @return [String, Integer] the qq of the bot
     attr_reader :base_uri, :session, :qq
 
+    alias id qq
+
     # Initializes the bot
     #
     # @param host [String] the host (IP or domain)

data/lib/rubirai/event_resp.rb

@@ -19,17 +19,29 @@ module Rubirai
   # Operations for responding to group join requests.
   # Only use the values defined in this module to respond to group join requests.
   module JoinGroupRequestOperation
+    # Approve the request
     APPROVE = 0
+
+    # Deny the request
     DENY = 1
+
+    # Ignore the request
     IGNORE = 2
+
+    # Deny and blacklist the sender of the request
     DENY_AND_BLACKLIST = 3
+
+    # Ignore and blacklist the sender of the request
     IGNORE_AND_BLACKLIST = 4
   end
 
   # Operations for responding to group invite requests.
   # Only use the values defined in this module to respond to group invite requests.
   module GroupInviteRequestOperation
+    # Approve the request
     APPROVE = 0
+
+    # Deny the request
     DENY = 1
   end
 
@@ -74,6 +86,14 @@ module Rubirai
       nil
     end
 
+    # Respond to group invitations (raw)
+    #
+    # @param event_id [Integer] the event id
+    # @param from_id [Integer] id of the sender
+    # @param group_id [Integer] the group id
+    # @param operation [Integer] see {GroupInviteRequestOperation}
+    # @param message [String] the message to reply
+    # @return [void]
     def respond_to_group_invite(event_id, from_id, group_id, operation, message = '')
       call :post, '/resp/botInvitedJoinGroupRequestEvent', json: {
         sessionKey: @session,

data/lib/rubirai/events/bot_events.rb

@@ -3,7 +3,11 @@
 require 'rubirai/events/event'
 
 module Rubirai
+  # Bot event
+  # @abstract
   class BotEvent < Event
+    # @!attribute [r] qq
+    #   @return [Integer] qq id of the event's bot
     set_event nil, :qq
   end
 

data/lib/rubirai/events/event.rb

@@ -102,6 +102,7 @@ module Rubirai
     #   @return [Hash]
     attr_reader :bot, :raw
 
+    # @private
     def initialize(hash, bot = nil)
       @raw = hash
       @bot = bot

data/lib/rubirai/events/message_events.rb

@@ -8,6 +8,8 @@ module Rubirai
   class MessageEvent < Event
     # @!attribute [r] message_chain
     #   @return [MessageChain] the message chain
+    # @!attribute [r] sender
+    #   @return [User] the sender
     set_event nil, :message_chain, :sender
   end
 

data/lib/rubirai/events/request_events.rb

@@ -3,6 +3,8 @@
 require 'rubirai/events/event'
 
 module Rubirai
+  # Request events
+  # @abstract
   class RequestEvent < Event
     # @!attribute [r] event_id
     #   @return [Integer] the event id
@@ -17,16 +19,19 @@ module Rubirai
     set_event nil, :event_id, :from_id, :group_id, :nick, :message
   end
 
+  # New friend request event
   class NewFriendRequestEvent < RequestEvent
     set_event :NewFriendRequestEvent
   end
 
+  # Join group request event
   class JoinGroupRequestEvent < RequestEvent
     # @!attribute [r] group_name
     #   @return [String] the group name
     set_event :MemberJoinRequestEvent, :group_name
   end
 
+  # Event that the bot is invited to a group
   class BotInvitedToGroupEvent < RequestEvent
     # @!attribute [r] group_name
     #   @return [String] the group name

data/lib/rubirai/events/rubirai_events.rb

@@ -3,7 +3,10 @@
 require 'rubirai/events/event'
 
 module Rubirai
+  # Error events thrown when errors happened in event listeners
   class RubiraiErrorEvent < Event
+    # @!attribute [r] err
+    #   @return [RuntimeError] the error
     attr_reader :err
 
     # An error event just for internal use

data/lib/rubirai/listener.rb

@@ -5,6 +5,12 @@ require 'rubirai/events/rubirai_events'
 
 module Rubirai
   class Bot
+    # Start to listen for events
+    #
+    # @param interval [Numeric] 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]
     def start_listen(interval, is_blocking: false, ignore_error: false)
       raise RubiraiError, 'listener is already running' if @listener&.running?
       @listener_stop_event = Concurrent::Event.new if is_blocking
@@ -27,14 +33,24 @@ module Rubirai
       @listener_stop_event.wait if is_blocking
     end
 
+    # Add a listener
+    #
+    # @return [void]
     def add_listener(&listener_block)
       @listener_funcs << listener_block
     end
 
+    # Clear all listeners
+    #
+    # @return [void]
     def clear_listener
       @listener_funcs.clear
     end
 
+    # Stop listening to events. Will unblock the thread if
+    # `is_blocking` is `true` when calling {#start_listen}
+    #
+    # @return [void]
     def stop_listen
       @listener.shutdown
       @listener_stop_event&.set

data/lib/rubirai/management.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'rubirai/objects/info'
+require 'rubirai/objects/group_info'
 
 module Rubirai
   class Bot
@@ -62,7 +62,7 @@ module Rubirai
       nil
     end
 
-    # Mute all group
+    # Mute all in a group
     #
     # @param group_id [Integer] group id
     # @return [void]
@@ -74,6 +74,10 @@ module Rubirai
       nil
     end
 
+    # Unmute all in a group
+    #
+    # @param group_id [Integer] group id
+    # @return [void]
     def unmute_all(group_id)
       call :post, '/unmuteAll', json: {
         sessionKey: @session,
@@ -82,6 +86,10 @@ module Rubirai
       nil
     end
 
+    # Get group config
+    #
+    # @param group_id [Integer] group id
+    # @return [GroupConfig] the config
     def get_group_config(group_id)
       resp = call :get, '/groupConfig', params: {
         sessionKey: @session,
@@ -93,7 +101,9 @@ module Rubirai
     # Set group config
     #
     # @param group_id [Integer] group id
-    # @param config [GroupConfig, Hash{String => Object}] the configuration
+    # @param config [GroupConfig, Hash{String, Symbol => Object}] the configuration. If given as
+    #               a hash, then it should be exactly named the same as given in `mirai-api-http`
+    #               docs.
     # @return [void]
     def set_group_config(group_id, config)
       config.must_be! [GroupConfig, Hash], RubiraiError, 'must be GroupConfig or Hash'
@@ -107,6 +117,11 @@ module Rubirai
       nil
     end
 
+    # Get member info
+    #
+    # @param group_id [Integer] group id
+    # @param member_id [Integer] the member's qq id
+    # @return [MemberInfo] the member's info
     def get_member_info(group_id, member_id)
       resp = call :get, '/memberInfo', params: {
         sessionKey: @session,
@@ -116,6 +131,14 @@ module Rubirai
       MemberInfo.new resp, self
     end
 
+    # Set member info
+    #
+    # @param group_id [Integer] group id
+    # @param member_id [Integer] the member's qq id
+    # @param info [MemberInfo, Hash{String,Symbol => Object}] the info to set. If given as
+    #             a hash, then it should be exactly named the same as given in `mirai-api-http`
+    #             docs.
+    # @return [void]
     def set_member_info(group_id, member_id, info)
       info.must_be! [MemberInfo, Hash], RubiraiError, 'must be MemberInfo or Hash'
       info.stringify_keys! if info.is_a? Hash
@@ -129,6 +152,11 @@ module Rubirai
       nil
     end
 
+    # Get the group files as a list
+    #
+    # @param group_id [Integer] the group id
+    # @param dir [String, nil] the directory to get. If `nil`, then the root directory is asserted.
+    # @return [Array<GroupFileSimple>] the list of files
     def get_group_file_list(group_id, dir = nil)
       resp = call :get, '/groupFileList', params: {
         sessionKey: @session,
@@ -141,12 +169,18 @@ module Rubirai
 
     # Get the info about a group file
     # @param group_id [Integer] the group id
-    # @param file_id [String] the file id, e.g. `/xxx-xxx-xxx-xxx`
-    def get_group_file_info(group_id, file_id)
+    # @param file_or_id [GroupFileSimple, String] the file id, e.g. `/xxx-xxx-xxx-xxx`
+    #
+    # @return [GroupFile] the info about the file
+    def get_group_file_info(group_id, file_or_id)
+      file_or_id.must_be! [GroupFileSimple, String], RubiraiError, 'must be GroupFileSimple or String'
+      raise RubiraiError, "#{file_or_id} is not a file" if file_or_id.is_a?(GroupFileSimple) && !file_or_id.is_file?
+      id = file_or_id.is_a? String ? file_or_id : file_or_id.id
+
       resp = call :get, '/groupFileInfo', params: {
         sessionKey: @session,
         target: group_id,
-        id: file_id
+        id: id
       }
       GroupFile.new resp, self
     end

data/lib/rubirai/message.rb

@@ -22,6 +22,12 @@ module Rubirai
       resp['messageId']
     end
 
+    # Send friend or group message
+    #
+    # @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
+    # @return [Integer] message id
     def send_msg(type, target_id, *msgs)
       self.class.ensure_type_in type, 'group', 'friend'
       chain = Rubirai::MessageChain.make(*msgs, bot: self)
@@ -33,14 +39,28 @@ module Rubirai
       resp['messageId']
     end
 
+    # Send friend message
+    #
+    # @param target_qq [Integer] target qq id
+    # @param msgs [Array<Rubirai::Message, Hash, String, Object>] messages to form a chain, can be any type
+    # @return [Integer] message id
     def send_friend_msg(target_qq, *msgs)
       send_msg :friend, target_qq, *msgs
     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
+    # @return [Integer] message id
     def send_group_msg(target_group_id, *msgs)
       send_msg :group, target_group_id, *msgs
     end
 
+    # Recall a message
+    #
+    # @param msg_id [Integer] message id
+    # @return [void]
     def recall(msg_id)
       call :post, '/recall', json: {
         sessionKey: @session,
@@ -70,6 +90,13 @@ module Rubirai
       call :post, '/sendImageMessage', json: res
     end
 
+    # Send nudge
+    #
+    # @param target_id [Integer] target id
+    # @param subject_id [Integer] the id of the place where the nudge will be seen.
+    #                   Should be a group id or a friend's id
+    # @param kind [String, Symbol] options: `[Group, Friend]`
+    # @return [void]
     def send_nudge(target_id, subject_id, kind)
       kind.to_s.downcase.must_be_one_of! %w[group friend], RubiraiError, 'kind must be one of group or friend'
       call :post, '/sendNudge', json: {
@@ -81,4 +108,46 @@ module Rubirai
       nil
     end
   end
+
+  class MessageEvent
+    # Respond to a message event
+    #
+    # @param msgs [Array<Rubirai::Message, Hash, String, Object>] messages to form a chain
+    # @param quote [Boolean] if to quote the original message
+    # @return [void]
+    def respond(*msgs, quote: false)
+      check_bot
+      msgs.prepend(gen_quote) if quote
+      case self
+      when FriendMessageEvent
+        @bot.send_friend_msg(@sender.id, *msgs)
+      when GroupMessageEvent
+        @bot.send_group_msg(@sender.group.id, *msgs)
+      when TempMessageEvent
+        @bot.send_temp_msg(@sender.id, @sender.group.id, *msgs)
+      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
+
+    def check_bot
+      raise RubiraiError, 'no bot found in event' unless @bot
+    end
+  end
 end

data/lib/rubirai/messages/message.rb

@@ -22,6 +22,10 @@ module Rubirai
   #   @option text [String] the plain text
   #   @return [Rubirai::PlainMessage]
   class Message
+    # @!attribute [r] bot
+    #   @return [Bot] the bot
+    # @!attribute [r] type
+    #   @return [Symbol] the type
     attr_reader :bot, :type
 
     # Objects to {Rubirai::Message}
@@ -58,10 +62,12 @@ module Rubirai
       raise(RubiraiError, 'type not in all message types') unless Message.all_types.include? type
     end
 
+    # @private
     def self.get_msg_klass(type)
       Object.const_get "Rubirai::#{type}Message"
     end
 
+    # @private
     def self.build_from(hash, bot = nil)
       hash = hash.stringify_keys
       raise(RubiraiError, 'not a valid message') unless hash.key? 'type'
@@ -72,6 +78,7 @@ module Rubirai
       klass.new hash, bot
     end
 
+    # @private
     def self.set_message(type, *attr_keys, &initialize_block)
       attr_reader(*attr_keys)
 
@@ -109,12 +116,16 @@ module Rubirai
       end
     end
 
+    # @private
     def initialize(type, bot = nil)
       Message.check_type type
       @bot = bot
       @type = type
     end
 
+    # Convert the message to a hash
+    #
+    # @return [Hash{String => Object}]
     def to_h
       res = self.class.keys.to_h do |k|
         v = instance_variable_get("@#{k}")
@@ -131,6 +142,7 @@ module Rubirai
       res.compact.stringify_keys
     end
 
+    # @private
     def self.metaclass
       class << self
         self
@@ -154,15 +166,19 @@ module Rubirai
     #   @return [Integer] the message (chain) id
     # @!attribute [r] time
     #   @return [Integer] the timestamp
+    # @!method from(**kwargs)
+    #   @option kwargs [Integer] :id the id
+    #   @option kwargs [Integer] :time the timestamp
+    #   @!scope class
     set_message :Source, :id, :time
   end
 
   # The quote message type
   class QuoteMessage < Message
     # @!attribute [r] id
-    #   @return [Integer] the original (quoted) message (chain) id
+    #   @return [Integer] the original (quoted) message chain id
     # @!attribute [r] group_id
-    #   @return [Integer] the group id
+    #   @return [Integer] the group id. `0` if from friend.
     # @!attribute [r] sender_id
     #   @return [Integer] the original sender's id
     # @!attribute [r] target_id
@@ -171,13 +187,14 @@ module Rubirai
     #   @return [MessageChain] the original message chain
     set_message :Quote, :id, :group_id, :sender_id, :target_id, :origin
 
+    # @private
     def initialize(hash, bot = nil)
       super :Quote, bot
       @id = hash['id']
       @group_id = hash['groupId']
       @sender_id = hash['senderId']
       @target_id = hash['targetId']
-      @origin = MessageChain.make(*hash['origin'], sender_id: @sender_id, bot: bot)
+      @origin = MessageChain.make(*hash['origin'], bot: bot)
     end
   end
 
@@ -272,7 +289,7 @@ module Rubirai
         @sender_id = hash['senderId']
         @time = hash['time']
         @sender_name = hash['senderName']
-        @message_chain = MessageChain.make(*hash['messageChain'], sender_id: hash['senderId'], bot: bot)
+        @message_chain = MessageChain.make(*hash['messageChain'], bot: bot)
       end
     end
 

data/lib/rubirai/messages/message_chain.rb

@@ -4,19 +4,27 @@ require 'rubirai/utils'
 require 'rubirai/messages/message'
 
 module Rubirai
+  # Message chain
   class MessageChain
     include Enumerable
 
-    attr_reader :bot, :sender_id, :send_time, :messages, :read_only
+    # @!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
 
     # Makes a message chain from a list of messages
     #
     # @param messages [Array<Rubirai::Message, Rubirai::MessageChain, Hash, String, Object>] a list of messages
-    # @param sender_id [Integer, nil]
     # @param bot [Rubirai::Bot, nil]
     # @return [Rubirai::MessageChain] the message chain
-    def self.make(*messages, sender_id: nil, bot: nil)
-      chain = new(bot, sender_id: sender_id)
+    def self.make(*messages, bot: nil)
+      chain = new(bot)
       result = []
       messages.map { |msg| Message.to_message(msg, bot) }.each do |msg|
         if !result.empty? && result[-1].is_a?(PlainMessage) && msg.is_a?(PlainMessage)
@@ -43,8 +51,12 @@ module Rubirai
     alias << extend
     alias append extend
 
-    def concat(msg_chain)
-      msg_chain.to_a.each do |msg|
+    # Concats this message chain with another one
+    #
+    # @param msg_chain [MessageChain] another message chain
+    # @return [MessageChain] self
+    def concat!(msg_chain)
+      msg_chain.messages.each do |msg|
         internal_append msg
       end
       self
@@ -70,19 +82,21 @@ module Rubirai
       @messages.empty?
     end
 
+    # Don't use the constructor. Use {.make}.
+    #
+    # @private
     # @param bot [Rubirai::Bot, nil]
     # @param source [Array, nil]
-    # @param sender_id [Integer, nil]
-    def initialize(bot = nil, source = nil, sender_id: nil)
+    # @param id [Integer, nil]
+    def initialize(bot = nil, source = nil)
       @bot = bot
-      @sender_id = sender_id
       @messages = []
       return unless source
       raise(MiraiError, 'source is not array') unless source.is_a? Array
       raise(MiraiError, 'length is zero') if source.empty?
 
       if source[0]['type'] == 'Source'
-        @sender_id = source[0]['id']
+        @id = source[0]['id']
         @send_time = source[0]['time']
         extend(*source.drop(1))
       else
@@ -90,6 +104,9 @@ module Rubirai
       end
     end
 
+    # Convert the message chain to an array of hashes.
+    #
+    # @return [Array<Hash{String => Object}>]
     def to_a
       @messages.map(&:to_h)
     end
@@ -113,7 +130,7 @@ module Rubirai
   end
 
   # Makes a message chain. See {MessageChain#make}.
-  def self.MessageChain(*messages, sender_id: nil, bot: nil)
-    MessageChain.make(*messages, sender_id: sender_id, bot: bot)
+  def self.MessageChain(*messages, bot: nil)
+    MessageChain.make(*messages, bot: bot)
   end
 end

data/lib/rubirai/objects/group.rb

@@ -1,6 +1,16 @@
 # frozen_string_literal: true
 
 module Rubirai
+  # The group
+  #
+  # @!attribute [r] bot
+  #   @return [Bot] the bot
+  # @!attribute [r] id
+  #   @return [Integer] group id
+  # @!attribute [r] name
+  #   @return [String] group name
+  # @!attribute [r] permission
+  #   @return [String] the group permission of the bot. See {Permission}
   class Group
     attr_reader :bot, :id, :name, :permission
 
@@ -14,9 +24,15 @@ module Rubirai
       @permission = hash['permission']
     end
 
+    # Group permissions
     class Permission
+      # Owner
       OWNER = 'OWNER'
+
+      # Administrator
       ADMINISTRATOR = 'ADMINISTRATOR'
+
+      # Member
       MEMBER = 'MEMBER'
     end
   end

data/lib/rubirai/objects/group_info.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+require 'rubirai/utils'
+
+module Rubirai
+  # The abstract class for group information
+  # @abstract
+  class GroupInfo
+    # @private
+    def self.set_fields(*fields, **default_values)
+      attr_reader(*fields)
+
+      class_eval do
+        define_method(:initialize) do |hash, bot = nil|
+          # noinspection RubySuperCallWithoutSuperclassInspection
+          super hash, bot
+          fields.each do |field|
+            value = hash[field.to_s.snake_to_camel(lower: true)] || default_values[field]
+            instance_variable_set("@#{field}", value)
+          end
+        end
+
+        define_method(:to_h) do
+          fields.to_h do |field|
+            [field.to_s.snake_to_camel(lower: true), instance_variable_get(field)]
+          end.compact
+        end
+      end
+    end
+
+    # @private
+    def self.set_modifiable_fields(*fields)
+      set_fields(*fields)
+      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
+    def initialize(hash, bot = nil)
+      @raw = hash
+      @bot = bot
+    end
+  end
+
+  # Group config
+  class GroupConfig < GroupInfo
+    # @!method initialize(hash, bot = nil)
+    #   @param hash [Hash{String => Object}]
+    #   @param bot [Rubirai::Bot, nil]
+    # @!method to_h
+    #   @return [Hash{String => Object}]
+    # @!attribute [rw] name
+    #   @return [String]
+    # @!attribute [rw] announcement
+    #   @return [String]
+    # @!attribute [rw] confess_talk
+    #   @return [Boolean] is confess talk enabled
+    # @!attribute [rw] allow_member_invite
+    #   @return [Boolean]
+    # @!attribute [rw] auto_approve
+    #   @return [Boolean]
+    # @!attribute [rw] anonymous_chat
+    #   @return [Boolean] is anonymous chat enabled
+    set_modifiable_fields :name, :announcement, :confess_talk, :allow_member_invite, :auto_approve, :anonymous_chat
+  end
+
+  # Member info
+  class MemberInfo < GroupInfo
+    # @!method initialize(hash, bot = nil)
+    #   @param hash [Hash{String => Object}]
+    #   @param bot [Rubirai::Bot, nil]
+    # @!method to_h
+    #   @return [Hash{String => Object}]
+    # @!attribute [rw] name
+    #   @return [String] member's name in the group
+    # @!attribute [r] nick
+    #   @return [String] member's personal nickname
+    # @!attribute [rw] special_title
+    #   @return [String] member's special title in the group
+    set_fields :name, :nick, :special_title
+    attr_writer :name, :special_title
+  end
+
+  # Group file with less information
+  class GroupFileSimple < GroupInfo
+    # @!method initialize(hash, bot = nil)
+    #   @param hash [Hash{String => Object}]
+    #   @param bot [Rubirai::Bot, nil]
+    # @!method to_h
+    #   @return [Hash{String => Object}]
+    # @!attribute [r] name
+    #   @return [String]
+    # @!attribute [r] id
+    #   @return [Integer]
+    # @!attribute [r] is_file
+    #   @return [Boolean]
+    set_fields :name, :id, :path, :is_file, is_file: true
+
+    alias is_file? is_file
+  end
+
+  # Group file with detailed information
+  class GroupFile < GroupFileSimple
+    # @!method initialize(hash, bot = nil)
+    #   @param hash [Hash{String => Object}]
+    #   @param bot [Rubirai::Bot, nil]
+    # @!method to_h
+    #   @return [Hash{String => Object}]
+    # @!attribute [r] length
+    #   @return [Integer]
+    # @!attribute [r] download_times
+    #   @return [Integer]
+    # @!attribute [r] uploader_id
+    #   @return [Integer]
+    # @!attribute [r] upload_time
+    #   @return [Integer]
+    # @!attribute [r] last_modify_time
+    #   @return [Integer]
+    # @!attribute [r] download_url
+    #   @return [String]
+    # @!attribute [r] sha1
+    #   @return [String]
+    # @!attribute [r] md5
+    #   @return [String]
+    set_fields :length,
+               :download_times,
+               :uploader_id,
+               :upload_time,
+               :last_modify_time,
+               :download_url,
+               :sha1,
+               :md5
+  end
+end

data/lib/rubirai/plugin_info.rb

@@ -2,8 +2,9 @@
 
 module Rubirai
   class Bot
-    # Get Mirai API plugin information such as
+    # Get Mirai API plugin information.
     #
+    # The information is like
     # ```ruby
     # {
     #   'version' => '1.0.0'

data/lib/rubirai/version.rb

@@ -2,7 +2,7 @@
 
 module Rubirai
   # Rubirai version
-  VERSION = '0.0.2'
+  VERSION = '0.0.3-a1'
 
   # mirai-api-http version
   MIRAI_API_VERSION = '1.10.0'

data/misc/common.css

@@ -7,5 +7,5 @@ h1, h2, h3, h4, h5, h6, h3.signature .aliases {
 
 pre, code, tt, dt code, table tr td dt code, ul.summary, h3.signature .aliases .names,
 p.signature, h3.signature, .tags ul .name, p.inherited a {
-    font-family: 'Menlo', 'Roboto Mono', monospace !important;
+    font-family: 'Roboto Mono', monospace !important;
 }

data/rubirai.gemspec

@@ -10,7 +10,6 @@ Gem::Specification.new do |s|
   s.description = 'A Mirai QQ bot http interface lib for Ruby.'
   s.authors = ['Rebuild']
   s.email = 'admin@rebuild.moe'
-  s.licenses = ['AGPLv3']
   s.files = `git ls-files`.split("\n")
   s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.require_paths = ['lib']
@@ -20,5 +19,5 @@ Gem::Specification.new do |s|
   s.add_dependency 'concurrent-ruby', '~> 1.1.8'
   s.add_dependency 'http', '~> 5.0'
   s.homepage = 'https://github.com/Shimogawa/rubirai'
-  s.license = 'AGPLv3'
+  s.license = 'AGPL-3.0'
 end

data/spec/auth_spec.rb

@@ -79,23 +79,7 @@ describe 'auth api' do
 
   it 'should be able to login and logout' do
     mirai_bot = Rubirai::Bot.new 'test'
-    stub_request(:post, @mirai_bot.gen_uri('/auth'))
-      .with(body: {
-        "authKey": @auth_key
-      })
-      .to_return(status: 200, body: %({
-          "code": 0,
-          "session": "#{@session_key}"
-      }))
-    stub_request(:post, @mirai_bot.gen_uri('/verify'))
-      .with(body: {
-        "sessionKey": @session_key,
-        "qq": @qq
-      })
-      .to_return(status: 200, body: %({
-          "code": 0,
-          "session": "success"
-      }))
+    stub_login
     stub_request(:post, @mirai_bot.gen_uri('/release'))
       .with(body: {
         "sessionKey": @session_key,

data/spec/events/event_spec.rb

@@ -73,6 +73,9 @@ describe Rubirai::Event do
     }
     e = Rubirai::Event.parse hash
     expect(e).to be_a(Rubirai::BotGroupPermissionChangedEvent)
-    expect(e.class.type)
+    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.id).to eq(123456789)
   end
 end

data/spec/message_spec.rb

@@ -5,8 +5,83 @@ require 'spec_helper'
 describe 'message api' do
   before :all do
     @mirai_bot = new_bot
+    stub_login
+    @mirai_bot.login @qq, @auth_key
   end
 
   after do
   end
+
+  it 'should be able to send friend message' do
+    stub_request(:post, @mirai_bot.gen_uri('/sendFriendMessage'))
+      .with(body: {
+        "sessionKey": @session_key,
+        "target": 987654321,
+        "messageChain": [
+          { "type": 'Plain', "text": "hello\nworld" },
+          { "type": 'Image', "url": 'a' }
+        ]
+      })
+      .to_return(status: 200, body: %({
+          "code": 0,
+          "msg": "success",
+          "messageId": 1234567890
+      }))
+    res = @mirai_bot.send_friend_msg 987654321, "hello\nworld", Rubirai::ImageMessage(url: 'a')
+    expect(res).to eq(1234567890)
+  end
+
+  it 'should be able to send temp message' do
+    stub_request(:post, @mirai_bot.gen_uri('/sendTempMessage'))
+      .with(body: {
+        "sessionKey": @session_key,
+        "qq": 123,
+        "group": 456,
+        "messageChain": [
+          { "type": 'Plain', "text": "hello\nworld" },
+          { "type": 'Image', "url": 'a' }
+        ]
+      })
+      .to_return(status: 200, body: %({
+          "code": 0,
+          "msg": "success",
+          "messageId": 1234567890
+      }))
+    res = @mirai_bot.send_temp_msg 123, 456, "hello\nworld", Rubirai::ImageMessage(url: 'a')
+    expect(res).to eq(1234567890)
+  end
+
+  it 'should be able to send group message' do
+    stub_request(:post, @mirai_bot.gen_uri('/sendGroupMessage'))
+      .with(body: {
+        "sessionKey": @session_key,
+        "target": 456,
+        "messageChain": [
+          { "type": 'Plain', "text": "hello\nworld" },
+          { "type": 'Image', "url": 'a' }
+        ]
+      })
+      .to_return(status: 200, body: %({
+          "code": 0,
+          "msg": "success",
+          "messageId": 1234567890
+      }))
+    res = @mirai_bot.send_group_msg 456, "hello\nworld", Rubirai::ImageMessage(url: 'a')
+    expect(res).to eq(1234567890)
+  end
+
+  it 'should be able to recall a message' do
+    stub_request(:post, @mirai_bot.gen_uri('/recall'))
+      .with(body: {
+        "sessionKey": @session_key,
+        "target": 123
+      })
+      .to_return(status: 200, body: %({
+          "code": 0,
+          "msg": "success"
+      }))
+    expect do
+      expect(@mirai_bot.recall(123)).to be_nil
+    end.not_to raise_error
+  end
 end

data/spec/messages/message_spec.rb

@@ -37,7 +37,7 @@ describe Rubirai::Message do
     qm = Rubirai::QuoteMessage.new hash
     expect(qm.id).to eq(123456)
     expect(qm.origin).to be_a(Rubirai::MessageChain)
-    expect(qm.origin.sender_id).to eq(987654321)
+    expect(qm.origin.id).to be_nil
     expect(qm.origin.messages).to be_a(Array)
     expect(qm.origin.messages.length).to eq(1)
     expect(qm.origin.messages[0]).to be_a(Rubirai::Message)

data/spec/spec_helper.rb

@@ -29,3 +29,23 @@ RSpec.configure do |config|
     @qq = 1145141919
   end
 end
+
+def stub_login
+  stub_request(:post, @mirai_bot.gen_uri('/auth'))
+    .with(body: {
+      "authKey": @auth_key
+    })
+    .to_return(status: 200, body: %({
+          "code": 0,
+          "session": "#{@session_key}"
+      }))
+  stub_request(:post, @mirai_bot.gen_uri('/verify'))
+    .with(body: {
+      "sessionKey": @session_key,
+      "qq": @qq
+    })
+    .to_return(status: 200, body: %({
+          "code": 0,
+          "session": "success"
+      }))
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubirai
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3.pre.a1
 platform: ruby
 authors:
 - Rebuild
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-28 00:00:00.000000000 Z
+date: 2021-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -47,6 +47,7 @@ files:
 - ".github/dependabot.yml"
 - ".github/workflows/CI.yml"
 - ".github/workflows/docs.yml"
+- ".github/workflows/package.yml"
 - ".github/workflows/pull_request.yml"
 - ".gitignore"
 - ".rubocop.yml"
@@ -76,7 +77,7 @@ files:
 - lib/rubirai/messages/message_chain.rb
 - lib/rubirai/multipart.rb
 - lib/rubirai/objects/group.rb
-- lib/rubirai/objects/info.rb
+- lib/rubirai/objects/group_info.rb
 - lib/rubirai/objects/user.rb
 - lib/rubirai/plugin_info.rb
 - lib/rubirai/retcode.rb
@@ -97,7 +98,7 @@ files:
 - spec/utils_spec.rb
 homepage: https://github.com/Shimogawa/rubirai
 licenses:
-- AGPLv3
+- AGPL-3.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -110,9 +111,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.3.1
 signing_key: 

data/lib/rubirai/objects/info.rb

@@ -1,71 +0,0 @@
-# frozen_string_literal: true
-
-require 'rubirai/utils'
-
-module Rubirai
-  # @abstract
-  class Info
-    # @!method initialize(hash, bot = nil)
-    #   @param hash [Hash{String => Object}]
-    #   @param bot [Rubirai::Bot, nil]
-    # @!method to_h
-    #   @return [Hash{String => Object}]
-    def self.set_fields(*fields, **default_values)
-      attr_reader(*fields)
-
-      class_eval do
-        define_method(:initialize) do |hash, bot = nil|
-          # noinspection RubySuperCallWithoutSuperclassInspection
-          super hash, bot
-          fields.each do |field|
-            value = hash[field.to_s.snake_to_camel(lower: true)] || default_values[field]
-            instance_variable_set("@#{field}", value)
-          end
-        end
-
-        define_method(:to_h) do
-          fields.to_h do |field|
-            [field.to_s.snake_to_camel(lower: true), instance_variable_get(field)]
-          end.compact
-        end
-      end
-    end
-
-    def self.set_modifiable_fields(*fields)
-      set_fields(*fields)
-      attr_writer(*fields)
-    end
-
-    attr_reader :raw, :bot
-
-    def initialize(hash, bot = nil)
-      @raw = hash
-      @bot = bot
-    end
-  end
-
-  class GroupConfig < Info
-    set_modifiable_fields :name, :announcement, :confess_talk, :allow_member_invite, :auto_approve, :anonymous_chat
-  end
-
-  class MemberInfo < Info
-    set_fields :name, :nick, :special_title
-    attr_writer :name, :special_title
-  end
-
-  class GroupFileSimple < Info
-    set_fields :name, :id, :path, :is_file, is_file: true
-  end
-
-  class GroupFile < GroupFileSimple
-    set_fields :length,
-               :download_times,
-               :uploader_id,
-               :upload_time,
-               :last_modify_time,
-               :download_url,
-               :sha1,
-               :md5,
-               call_super: true
-  end
-end