rubirai 0.0.2

data/lib/rubirai/multipart.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Rubirai
+  class Bot
+    # Uploads an image to QQ server
+    # @return [Hash] hash string keys are: `{ imageId, url, path }`
+    def upload_image(path_or_io, type = :friend)
+      self.class.ensure_type_in type, 'friend', 'group', 'temp'
+      call :post, '/uploadImage', form: {
+        sessionKey: @session,
+        type: type.to_s.downcase,
+        img: HTTP::FormData::File.new(path_or_io)
+      }, headers: { content_type: 'multipart/form-data' }
+    end
+
+    # Uploads a voice file to QQ server
+    # Only group uploads available currently.
+    # @param path_or_io [String, Pathname, IO] path to voice file
+    # @return [Hash] hash string keys are: `{ voiceId, url, path }`
+    def upload_voice(path_or_io)
+      call :post, '/uploadVoice', form: {
+        sessionKey: @session,
+        type: 'group',
+        img: HTTP::FormData::File.new(path_or_io)
+      }, headers: { content_type: 'multipart/form-data' }
+    end
+
+    # Uploads a file to a group (currently only groups supported)
+    # @param path_or_io [String, Pathname, IO] path to file
+    # @param target [Integer] group id
+    # @param group_path [String] path to file in group files
+    # @return [String] the string id of the mirai file
+    def upload_file_and_send(path_or_io, target, group_path)
+      res = call :post, '/uploadFileAndSend', form: {
+        sessionKey: @session,
+        type: 'Group',
+        target: target,
+        path: group_path,
+        file: HTTP::FormData::File.new(path_or_io)
+      }, headers: { content_type: 'multipart/form-data' }
+      res['id']
+    end
+  end
+end

data/lib/rubirai/objects/group.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Rubirai
+  class Group
+    attr_reader :bot, :id, :name, :permission
+
+    # @param hash [Hash{String => Object}]
+    # @param bot [Rubirai::Bot, nil]
+    def initialize(hash, bot = nil)
+      hash = hash.stringify_keys
+      @bot = bot
+      @id = hash['id']
+      @name = hash['name']
+      @permission = hash['permission']
+    end
+
+    class Permission
+      OWNER = 'OWNER'
+      ADMINISTRATOR = 'ADMINISTRATOR'
+      MEMBER = 'MEMBER'
+    end
+  end
+end

data/lib/rubirai/objects/info.rb

@@ -0,0 +1,71 @@
+# 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

data/lib/rubirai/objects/user.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative 'group'
+require 'rubirai/errors'
+
+module Rubirai
+  class User
+    attr_reader :bot, :id, :name, :remark
+
+    def initialize(hash, bot = nil)
+      hash = hash.stringify_keys
+      @bot = bot
+      @id = hash['id']
+      @name = hash['name'] || hash['nickname']
+      @remark = hash['remark']
+    end
+  end
+
+  class GroupUser < User
+    attr_reader :member_name, :permission, :group
+
+    def initialize(hash, bot = nil)
+      raise(RubiraiError, 'not a group user') unless hash.key? 'group'
+      super(hash, bot)
+      @member_name = hash['memberName']
+      @permission = hash['permission']
+      @group = Group.new(hash['group'], bot)
+    end
+  end
+end

data/lib/rubirai/plugin_info.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Rubirai
+  class Bot
+    # Get Mirai API plugin information such as
+    #
+    # ```ruby
+    # {
+    #   'version' => '1.0.0'
+    # }
+    # ```
+    #
+    # @return [Hash{String => Object}] plugin data
+    def about
+      v = call :get, '/about'
+      v['data']
+    end
+  end
+end

data/lib/rubirai/retcode.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Rubirai
+  # The return codes and their explanations
+  RETURN_CODE = {
+    0 => 'OK',
+    1 => 'Wrong auth key',
+    2 => 'No such bot',
+    3 => 'Session disappeared',
+    4 => 'Session not verified',
+    5 => 'No such receiver',
+    6 => 'No such file',
+    10 => 'No permission',
+    20 => 'Bot muted',
+    30 => 'Message too long',
+    400 => 'Bad request'
+  }.freeze
+end

data/lib/rubirai/session.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Rubirai
+  class Bot
+    # Get the config related to this session
+    # @return [Hash{String => Object}] the config
+    def get_session_cfg
+      call :get, '/config', params: {
+        sessionKey: @session
+      }
+    end
+
+    # Set the config related to this session
+    # @param cache_size [Integer, nil] the cache size
+    # @param enable_websocket [Boolean, nil] if to enable websocket
+    # @return [void]
+    def set_session_cfg(cache_size: nil, enable_websocket: nil)
+      call :post, '/config', json: {
+        sessionKey: @session,
+        cacheSize: cache_size,
+        enableWebsocket: enable_websocket
+      }.compact
+      nil
+    end
+  end
+end

data/lib/rubirai/utils.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+# @private
+class Hash
+  def stringify_keys!
+    transform_keys!(&:to_s)
+  end
+
+  def symbolize_keys!
+    transform_keys!(&:to_sym)
+  end
+
+  def stringify_keys
+    transform_keys(&:to_s)
+  end
+
+  def symbolize_keys
+    transform_keys(&:to_sym)
+  end
+end
+
+# @private
+class String
+  def snake_to_camel(lower: false)
+    s = split('_').collect(&:capitalize).join
+    return s unless lower
+    # noinspection RubyNilAnalysis
+    s[0] = s[0].downcase
+    s
+  end
+end
+
+# @private
+class Object
+  def must_be!(types, exc_type = nil, *args)
+    ok = case types
+         when Array
+           types.any? { |type| is_a? type }
+         else
+           is_a? types
+         end
+    self.class.raise_or_default exc_type, "assert failed: `#{self}' must be of type #{types}", *args unless ok
+  end
+
+  def must_be_one_of!(things, exc_type = nil, *args)
+    ok = case things
+         when Array
+           things.include? self
+         else
+           self == things
+         end
+    self.class.raise_or_default exc_type, "assert failed: `#{self}' must be one of: #{things}", *args unless ok
+  end
+
+  def self.raise_or_default(exc_type, msg, *args)
+    if exc_type.nil?
+      raise(msg)
+    else
+      raise(exc_type, *args)
+    end
+  end
+end

data/lib/rubirai/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Rubirai
+  # Rubirai version
+  VERSION = '0.0.2'
+
+  # mirai-api-http version
+  MIRAI_API_VERSION = '1.10.0'
+end

data/misc/common.css

@@ -0,0 +1,11 @@
+@import url('https://fonts.googleapis.com/css2?family=Noto+Sans+SC:wght@400;500;700&family=Noto+Sans:ital,wght@0,400;0,700;1,400&family=Roboto+Mono:ital,wght@0,400;0,500;1,400&display=swap');
+
+body, .summary_desc, .note.title, p.signature .extras, h3.signature .extras,
+h1, h2, h3, h4, h5, h6, h3.signature .aliases {
+    font-family: 'SF Pro', 'Noto Sans', 'Noto Sans SC', Arial, Helvetica, -apple-system, sans-serif !important;
+}
+
+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;
+}

data/rubirai.gemspec

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('lib', __dir__)
+require 'rubirai/version'
+
+Gem::Specification.new do |s|
+  s.name = 'rubirai'
+  s.version = Rubirai::VERSION
+  s.summary = 'A Mirai QQ bot http interface lib for Ruby.'
+  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']
+
+  s.required_ruby_version = '>= 2.6'
+
+  s.add_dependency 'concurrent-ruby', '~> 1.1.8'
+  s.add_dependency 'http', '~> 5.0'
+  s.homepage = 'https://github.com/Shimogawa/rubirai'
+  s.license = 'AGPLv3'
+end

data/spec/auth_spec.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'auth api' do
+  before :all do
+    @mirai_bot = new_bot
+  end
+
+  after do
+    # Do nothing
+  end
+
+  it 'should be able to authenticate' do
+    stub_request(:post, @mirai_bot.gen_uri('/auth'))
+      .with(body: {
+        "authKey": @auth_key
+      })
+      .to_return(status: 200, body: %({
+          "code": 0,
+          "session": "#{@session_key}"
+      }))
+    res = @mirai_bot.auth @auth_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'))
+      .with(body: {
+        "authKey": @auth_key
+      })
+      .to_return(status: 200, body: %({
+          "code": 1,
+          "session": ""
+      }))
+
+    expect { mirai_bot.auth @auth_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'))
+      .with(body: {
+        "sessionKey": @session_key,
+        "qq": @qq
+      })
+      .to_return(status: 200, body: %({
+          "code": 0,
+          "session": "success"
+      }))
+
+    expect { @mirai_bot.verify @qq }.not_to raise_error
+    expect(@mirai_bot.verify(@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')
+  end
+
+  it 'should be able to release' do
+    stub_request(:post, @mirai_bot.gen_uri('/release'))
+      .with(body: {
+        "sessionKey": @session_key,
+        "qq": @qq
+      })
+      .to_return(status: 200, body: %({
+          "code": 0,
+          "msg": "success"
+      }))
+
+    expect do
+      expect(@mirai_bot.release(@qq)).to be_nil
+    end.not_to raise_error
+    expect(@mirai_bot.session).to be_nil
+  end
+
+  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_request(:post, @mirai_bot.gen_uri('/release'))
+      .with(body: {
+        "sessionKey": @session_key,
+        "qq": @qq
+      })
+      .to_return(status: 200, body: %({
+          "code": 0,
+          "msg": "success"
+      }))
+    expect do
+      expect(mirai_bot.login(@qq, @auth_key)).to be_nil
+    end.not_to raise_error
+    expect(mirai_bot.instance_variable_get('@session')).to eq(@session_key)
+
+    expect do
+      expect(mirai_bot.logout).to be_nil
+    end.not_to raise_error
+    expect(mirai_bot.instance_variable_get('@session')).to be_nil
+  end
+end