rubirai 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b91aff486d51f20061c25e988fabfb4adcf34b765f30bdd6f118858faafcb693
-  data.tar.gz: 2508fa6974b69f487098972e89ba2fe04f32fe566f5e04a14aadb595653cabcd
+  metadata.gz: 5f41f579f9ae1486c4a8f5af2e12e7e98e2aab20b880b9d2b1781eb57f480c3b
+  data.tar.gz: 2044c0aabd41caba57890b30b1951e0440046201e1b4eaa1f91fc766ae404e1a
 SHA512:
-  metadata.gz: 9676cbb324b9aed4abaca4d69f1f58791d0edb11434cb90ebc0bb9f1677d18c61d82d3b0709c9b0fca0eda176e2bd924dcaf5bb894f992ed77b27d06385f818a
-  data.tar.gz: 92e5e0e168ec5b6834beb81d1398c64e5521b15adc869b95f12ea8e3e54e65f9f33f41e6e789377c710ad695357890da2b71a8ccc110327f956dd7195a177c87
+  metadata.gz: c34f19d099e6f2d85e403e93d9c03b82b5ad9325f26f7de0714e517b73d0ec041de372bf534bbffa34aef342394411012dd1cbf78da2a3afac87409006a547b7
+  data.tar.gz: 8392b2ea57dc0eb3df290a4e2b357bc184102879904fb38bbd5e9ce60bd7071b9be686fad559aff5b9ef4b8711e93bf205949fc9605991c661429425d3b31ebb

data/README.md

@@ -23,6 +23,16 @@ 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
@@ -38,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
@@ -65,7 +75,6 @@ gem install rubirai
 - [中文 Wiki][wiki]
 - [Docs][rubydocs]
 
-
 ## License
 
 [AGPL-3.0 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/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
@@ -117,33 +124,19 @@ module Rubirai
     # @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
     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.raw,
-        bot: @bot
-      )
-    end
-
     private
 
     def check_bot

data/lib/rubirai/version.rb

@@ -2,8 +2,8 @@
 
 module Rubirai
   # Rubirai version
-  VERSION = '0.1.1'
+  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

@@ -58,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/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
@@ -114,22 +114,8 @@ describe 'message api' do
       .with(body: {
         "sessionKey": 'test_session_key',
         "target": 1234567890,
+        "quote": 123456,
         "messageChain": [
-          {
-            "id": 123456,
-            "groupId": 1234567890,
-            "senderId": 123456789,
-            "targetId": 1234567890,
-            "origin": [
-              {
-                "type": 'Source',
-                "id": 123456,
-                "time": 123456789
-              },
-              { "text": 'Miral牛逼', "type": 'Plain' }
-            ],
-            "type": 'Quote'
-          },
           { "text": 'hi', "type": 'Plain' }
         ]
       })

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.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Rebuild
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-05 00:00:00.000000000 Z
+date: 2022-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby