rubirai 0.0.2

data/README.md

@@ -0,0 +1,24 @@
+# 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.
+
+## Usage
+
+```ruby
+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
+bot.login 1145141919, 'ikisugi_key'
+```
+
+
+## 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)

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = %w[
+    --force-color
+    --format progress
+    --require ./spec/spec_helper.rb
+  ]
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop)
+
+task default: %i[spec rubocop]

data/examples/helper.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('../lib', __dir__)

data/examples/listener_example.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative 'helper'
+require 'rubirai'
+
+bot = Rubirai::Bot.new '127.0.0.1', 8080
+
+puts 'Enter qq: '
+qq = gets.chomp
+puts 'Enter auth key: '
+auth = gets.chomp
+
+bot.login(qq, auth)
+puts 'Login successful.'
+
+bot.add_listener do |event|
+  puts "#{event.class} -> #{event.raw}"
+end
+
+begin
+  bot.start_listen 0.5, is_blocking: true, ignore_error: false
+rescue Interrupt
+  bot.logout
+  puts 'Bye'
+end

data/examples/simple_example.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative 'helper'
+require 'rubirai'
+
+bot = Rubirai::Bot.new '127.0.0.1', 8080
+
+puts 'Enter qq: '
+qq = gets.chomp
+puts 'Enter auth key: '
+auth = gets.chomp
+
+bot.login(qq, auth)
+
+puts 'Login successful. Enter qq to send message to:'
+target = gets.chomp
+
+bot.send_friend_msg(
+  target,
+  'hello', ' world!',
+  Rubirai::ImageMessage(url: 'https://i0.hdslb.com/bfs/album/67fc4e6b417d9c68ef98ba71d5e79505bbad97a1.png')
+)
+
+bot.logout

data/lib/rubirai.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'rubirai/errors'
+require 'rubirai/utils'
+
+# Rubirai is a library for connecting Mirai http api.
+module Rubirai
+  require 'http'
+
+  # Bot represents a QQ bot at mirai side. All functions are API calls to the http plugin.
+  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
+
+    # Initializes the bot
+    #
+    # @param host [String] the host (IP or domain)
+    # @param port [String, Integer, nil] the port number (default is 80 for http)
+    def initialize(host, port = nil)
+      @base_uri = "http://#{host}#{":#{port}" if port}"
+      @listener_funcs = []
+    end
+
+    def gen_uri(path)
+      URI.join(base_uri, path)
+    end
+
+    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}"
+    end
+
+    private
+
+    def call(method, path, **kwargs)
+      return unless %i[get post].include?(method) && HTTP.respond_to?(method)
+
+      resp = HTTP.send method, gen_uri(path), kwargs
+      raise(HttpResponseError, resp.code) unless resp.status.success?
+
+      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'])
+      end
+
+      body
+    end
+  end
+end
+
+require 'rubirai/auth'
+require 'rubirai/event_recv'
+require 'rubirai/listener'
+require 'rubirai/listing'
+require 'rubirai/management'
+require 'rubirai/message'
+require 'rubirai/multipart'
+require 'rubirai/plugin_info'
+require 'rubirai/retcode'
+require 'rubirai/session'
+require 'rubirai/version'

data/lib/rubirai/auth.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Rubirai
+  class Bot
+    # Start authentication. Will store the session.
+    # @param auth_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 }
+      @session = v['session']
+    end
+
+    # Verify and start a session. Also bind the session to a bot with the qq id.
+    # @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)
+      check qq, session
+
+      call :post, '/verify', json: { "sessionKey": @session || session, "qq": qq.to_i }
+      @session = session if session
+      @qq = qq
+      nil
+    end
+
+    # Release a session.
+    # Only fill in the arguments when you want to control another bot on the same Mirai process.
+    # @param qq [String, Integer, nil] qq id. Set to `nil` will use the logged in bot id.
+    # @param session [String, nil] the session key. Set to `nil` will use the logged in credentials.
+    # @return [void]
+    def release(qq = nil, session = nil)
+      qq ||= @qq
+      raise RubiraiError, "not same qq: #{qq} and #{@qq}" if qq != @qq
+      check qq, session
+
+      call :post, '/release', json: { "sessionKey": @session || session, "qq": qq.to_i }
+      @session = nil
+      @qq = nil
+      nil
+    end
+
+    # 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.
+    # @return [void]
+    # @see #auth
+    # @see #verify
+    def login(qq, auth_key)
+      auth auth_key
+      verify qq
+    end
+
+    alias connect login
+
+    # Log you out.
+    #
+    # @return [void]
+    # @see #release
+    def logout
+      release
+    end
+
+    alias disconnect logout
+
+    private
+
+    def check(qq, session = nil)
+      raise RubiraiError, 'Wrong format for qq' unless qq.to_i.to_s == qq.to_s
+      raise RubiraiError, 'No session provided' unless @session || session
+    end
+  end
+end

data/lib/rubirai/errors.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'rubirai/retcode'
+
+module Rubirai
+  # Represent all Rubirai errors
+  class RubiraiError < RuntimeError
+  end
+
+  # Http response error
+  class HttpResponseError < RubiraiError
+    def initialize(code)
+      super "Http Error: #{code}"
+    end
+  end
+
+  # Mirai error
+  class MiraiError < RubiraiError
+    def initialize(code, msg = nil)
+      raise(RubiraiError, 'invalid mirai error code') unless Rubirai::RETURN_CODE.key? code
+      str = +"Mirai error: #{code} - #{Rubirai::RETURN_CODE[code]}"
+      str << "\n#{msg}" if msg
+      super str
+    end
+  end
+end

data/lib/rubirai/event_recv.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require 'rubirai/events/event'
+
+module Rubirai
+  class Bot
+    # Fetch `count` number of oldest events.
+    # @param count [Integer] the number of events to fetch
+    # @return [Array<Event>] the event objects.
+    def fetch_message(count = 10)
+      get_events '/fetchMessage', count
+    end
+
+    alias fetch_messages fetch_message
+    alias fetch_event fetch_message
+    alias fetch_events fetch_message
+
+    # Fetch `count` number of latest events.
+    # @param count [Integer] the number of events to fetch
+    # @return [Array<Event>] the event objects
+    def fetch_latest_message(count = 10)
+      get_events '/fetchLatestMessage', count
+    end
+
+    alias fetch_latest_messages fetch_latest_message
+    alias fetch_latest_event fetch_latest_message
+    alias fetch_latest_events fetch_latest_message
+
+    # Peek `count` number of oldest events. (Will not delete from cache)
+    # @param count [Integer] the number of events to peek
+    # @return [Array<Event>] the event objects
+    def peek_message(count = 10)
+      get_events '/peekMessage', count
+    end
+
+    alias peek_messages peek_message
+    alias peek_event peek_message
+    alias peek_events peek_message
+
+    # Peek `count` number of latest events. (Will not delete from cache)
+    # @param count [Integer] the number of events to peek
+    # @return [Array<Event>] the event objects
+    def peek_latest_message(count = 10)
+      get_events '/peekLatestMessage', count
+    end
+
+    alias peek_latest_messages peek_latest_message
+    alias peek_latest_event peek_latest_message
+    alias peek_latest_events peek_latest_message
+
+    # Get a message event from message id
+    # @param msg_id [Integer] message id
+    # @return [Event] the event object
+    def message_from_id(msg_id)
+      resp = call :get, '/messageFromId', params: {
+        sessionKey: @session,
+        id: msg_id
+      }
+      Event.parse resp['data'], self
+    end
+
+    # Get the number of cached messages in mirai-http-api
+    # @return [Integer] the number of cached messages
+    def count_cached_message
+      resp = call :get, '/countMessage', params: {
+        sessionKey: @session
+      }
+      resp['data']
+    end
+
+    private
+
+    def get_events(path, count)
+      resp = call :get, path, params: {
+        sessionKey: @session,
+        count: count
+      }
+      resp['data'].map do |event|
+        Event.parse event, self
+      end
+    end
+  end
+end

data/lib/rubirai/event_resp.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+require 'rubirai/events/event'
+
+module Rubirai
+  # Operations for responding to friend requests.
+  # Only use the values defined in this module to respond to friend requests.
+  module FriendRequestOperation
+    # Approve the request
+    APPROVE = 0
+
+    # Deny the request
+    DENY = 1
+
+    # Deny and blacklist the sender of the request
+    DENY_AND_BLACKLIST = 2
+  end
+
+  # Operations for responding to group join requests.
+  # Only use the values defined in this module to respond to group join requests.
+  module JoinGroupRequestOperation
+    APPROVE = 0
+    DENY = 1
+    IGNORE = 2
+    DENY_AND_BLACKLIST = 3
+    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 = 0
+    DENY = 1
+  end
+
+  class Bot
+    # Respond to new friend request (raw)
+    #
+    # @param event_id [Integer] the event id
+    # @param from_id [Integer] id of the requester
+    # @param operation [Integer] see {FriendRequestOperation}.
+    # @param group_id [Integer] the group where the request is from. 0 if not from group.
+    # @param message [String] the message to reply
+    # @return [void]
+    def respond_to_new_friend_request(event_id, from_id, operation, group_id = 0, message = '')
+      call :post, '/resp/newFriendRequestEvent', json: {
+        sessionKey: @session,
+        eventId: event_id,
+        fromId: from_id,
+        groupId: group_id,
+        operate: operation,
+        message: message
+      }
+      nil
+    end
+
+    # Respond to join group request (raw)
+    #
+    # @param event_id [Integer] the event id
+    # @param from_id [Integer] id of the requester
+    # @param operation [Integer] see {JoinGroupRequestOperation}
+    # @param group_id [Integer] the group where the request is from. 0 if not from group.
+    # @param message [String] the message to reply
+    # @return [void]
+    def respond_to_member_join(event_id, from_id, group_id, operation, message = '')
+      call :post, '/resp/memberJoinRequestEvent', json: {
+        sessionKey: @session,
+        eventId: event_id,
+        fromId: from_id,
+        groupId: group_id,
+        operate: operation,
+        message: message
+      }
+      nil
+    end
+
+    def respond_to_group_invite(event_id, from_id, group_id, operation, message = '')
+      call :post, '/resp/botInvitedJoinGroupRequestEvent', json: {
+        sessionKey: @session,
+        eventId: event_id,
+        fromId: from_id,
+        groupId: group_id,
+        operate: operation,
+        message: message
+      }
+      nil
+    end
+  end
+
+  class RequestEvent
+    # @abstract
+    def respond(operation, message)
+      raise NotImplementedError
+    end
+  end
+
+  class NewFriendRequestEvent
+    # Respond to the friend request.
+    #
+    # @param operation [Integer] see {FriendRequestOperation}
+    # @param message [String] the message to reply
+    # @return [void]
+    def respond(operation, message = '')
+      @bot.respond_to_new_friend_request @event_id, @from_id, operation, @group_id, message
+    end
+  end
+
+  class JoinGroupRequestEvent
+    # Respond to the friend request.
+    #
+    # @param operation [Integer] see {JoinGroupRequestOperation}
+    # @param message [String] the message to reply
+    # @return [void]
+    def respond(operation, message = '')
+      @bot.respond_to_member_join @event_id, @from_id, @group_id, operation, message
+    end
+  end
+
+  class BotInvitedToGroupEvent
+    # Respond to the group invitation.
+    #
+    # @param operation [Integer] see {GroupInviteRequestOperation}
+    # @param message [String] the message to reply
+    # @return [void]
+    def respond(operation, message = '')
+      @bot.respond_to_group_invite @event_id, @from_id, @group_id, operation, message
+    end
+  end
+end