wechat-bot 0.1.0.alpha

data/lib/wechat/bot/message.rb

@@ -0,0 +1,262 @@
+require "wechat/bot/message_data/share_link"
+
+module WeChat::Bot
+  # 微信消息
+  class Message
+    # 消息类型
+    module Kind
+      Text = :text
+      Image = :image
+      Voice = :voice
+      ShortVideo = :short_video
+      Emoticon = :emoticon
+      ShareLink = :share_link
+      # RedPacage = :red_package
+      # BusinessCard = :business_card
+      # MusicLink = :music_link
+      System = :system
+      Unkown = :unkown
+    end
+
+    GROUP_MESSAGE_REGEX = /^(@\w+):<br\/>(.*)$/
+    AT_MESSAGE_REGEX = /@([^\s]+) (.*)/
+
+    # 原始消息
+    # @return [Hash<Object, Object>]
+    attr_reader :raw
+
+    # 事件列表
+    # @return [Array<Symbol>]
+    attr_reader :events
+
+    # @return [Core]
+    attr_reader :bot
+
+    # @return [Time]
+    attr_reader :time
+
+    # 消息类型
+    # @return [Message::Kind]
+    attr_reader :kind
+
+    # 消息来源
+    # @return [Contact::Kind]
+    attr_reader :source
+
+    # 消息发送者
+    #
+    # 用户或者群组
+    # @return [Contact]
+    attr_reader :from
+
+    # 消息正文
+    # @return [String]
+    attr_reader :message
+
+    attr_reader :media_id
+
+    attr_reader :meta_data
+
+    def initialize(raw, bot)
+      @raw = raw
+      @bot = bot
+
+      @events  = []
+      @time    = Time.now
+      @statusmsg_mode = nil
+
+      parse
+
+      @bot.logger.debug "Message Raw: #{@raw}"
+    end
+
+    # 回复消息
+    def reply(text, **args)
+      to_user = args[:username] || @from.username
+      to_user = @bot.contact_list.find(nickname: args[:nickname]) if args[:nickname]
+
+      message_type = args[:type] || :text
+      @bot.client.send(message_type, to_user, text)
+    end
+
+    # 解析微信消息
+    #
+    # @return [void]
+    def parse
+      parse_source
+      parse_kind
+
+      message = @raw["Content"].convert_emoji
+      message = CGI.unescape_html(message) if @kinde != Message::Kind::Text
+      if match = group_message(message)
+        from_username = match[0]
+        message = match[1]
+      end
+
+      @message = message
+      @from = @bot.contact_list.find(username: @raw["FromUserName"])
+      parse_emoticon if @kind == Message::Kind::Emoticon
+
+      case @kind
+      when Message::Kind::ShareLink
+        @meta_data = MessageData::ShareLink.parse(@message)
+      end
+
+      parse_events
+    end
+
+    # 消息匹配
+    #
+    # @param [String, Regex, Pattern] regexp 匹配规则
+    # @param [String, Symbol] type 消息类型
+    # @return [MatchData] 匹配结果
+    def match(regexp, type)
+      # text = ""
+      # case type
+      # when :ctcp
+      #   text = ctcp_message
+      # when :action
+      #   text = action_message
+      # else
+      #   text = message.to_s
+      #   type = :other
+      # end
+
+      # if strip_colors
+      #   text = Cinch::Formatting.unformat(text)
+      # end
+
+      @message.match(regexp)
+    end
+
+    # 解析消息来源
+    #
+    # 特殊账户/群聊/公众号/用户
+    #
+    # @return [void]
+    def parse_source
+      @source = if @bot.config.special_users.include?(@raw["FromUserName"])
+                  # 特殊账户
+                  Contact::Kind::Special
+                elsif @raw["FromUserName"].include?("@@")
+                  # 群聊
+                  Contact::Kind::Group
+                elsif (@raw["RecommendInfo"]["VerifyFlag"] & 8) != 0
+                  # 公众号
+                  Contact::Kind::MP
+                else
+                  # 普通用户
+                  Contact::Kind::User
+                end
+    end
+
+    # 解析消息类型
+    #
+    #  - 1: Text 文本消息
+    #  - 3: Image 图片消息
+    #  - 34: Voice 语言消息
+    #  - 42: BusinessCard 名片消息
+    #  - 47: Emoticon 微信表情
+    #  - 49: ShareLink 分享链接消息
+    #  - 62: ShortVideo 短视频消息
+    #  - 1000: System 系统消息
+    #  - Unkown 未知消息
+    #
+    # @return [void]
+    def parse_kind
+      @kind = case @raw["MsgType"]
+              when 1
+                Message::Kind::Text
+              when 3
+                Message::Kind::Image
+              when 34
+                Message::Kind::Voice
+              when 42
+                Message::Kind::BusinessCard
+              when 62
+                Message::Kind::ShortVideo
+              when 47
+                Message::Kind::Emoticon
+              when 49
+                Message::Kind::ShareLink
+              when 10000
+                Message::Kind::System
+              else
+                Message::Kind::Unkown
+              end
+    end
+
+    # 解析 Handler 的事件
+    #
+    #  - `:message` 用户消息
+    #    - `:text` 文本消息
+    #  - `:group` 群聊消息
+    #    - `:at_message` @ 消息
+    #
+    # @return [void]
+    def parse_events
+      @events << :message
+      @events << @kind
+      @events << @source
+
+      if @source == :group && @raw["Content"] =~ /@([^\s]+)\s+(.*)/
+        @events << :at_message
+      end
+    end
+
+    # 解析表情
+    #
+    # 表情分为两种：
+    #   1. 微信商店表情
+    #   1. 自定义表情
+    #
+    # @return [void]
+    def parse_emoticon
+      if @message.empty?
+        @media_id = @raw["MediaId"]
+        # TODO: 解决微信商店表情
+        # file = @bot.client.download_image(@raw["NewMsgId"])
+      else
+        data = MultiXml.parse(@message)
+        @media_id = data["msg"]["emoji"]["md5"]
+      end
+    end
+
+    def parse_share
+      data = MultiXml.parse(@message)
+
+    end
+
+    # 解析用户的群消息
+    #
+    # 群消息格式：
+    #     @FromUserName:<br>Message
+    #
+    # @param [String] message 原始消息
+    # @return [Array<Object>] 返回两个值的数组
+    #   - 0 from_username
+    #   - 1 message
+    def group_message(message)
+      if match = GROUP_MESSAGE_REGEX.match(message)
+        return [match[1], at_message(match[2])]
+      end
+
+      false
+    end
+
+    # 尝试解析群聊中的 @ 消息
+    #
+    # 群消息格式：
+    #     @ToNickNameUserName Message
+    #
+    # @param [String] message 原始消息
+    # @return [String] 文本消息，如果不是 @ 消息返回原始消息
+    def at_message(message)
+      if match = AT_MESSAGE_REGEX.match(message)
+        return match[2].strip
+      end
+
+      message
+    end
+  end
+end

data/lib/wechat/bot/message_data/share_link.rb

@@ -0,0 +1,46 @@
+module WeChat::Bot::MessageData
+  class ShareLink
+    def self.parse(raw)
+      self.new(raw)
+    end
+
+    # @return [String]
+    attr_reader :title
+
+    # @return [String]
+    attr_reader :link
+
+    # @return [String]
+    attr_reader :description
+
+    # @return [String, Nil]
+    attr_reader :thumb_image
+
+    # @return [String]
+    attr_reader :from_user
+
+    # @return [String, Nil]
+    attr_reader :app
+
+    # @return [Hash<Symbol, String>, Hash<Symbol, Nil>]
+    attr_reader :mp
+
+    def initialize(raw)
+      @raw = MultiXml.parse(raw.gsub("<br/>", ""))
+      parse
+    end
+
+    def parse
+      @title = @raw["msg"]["appmsg"]["title"]
+      @link = @raw["msg"]["appmsg"]["url"]
+      @description = @raw["msg"]["appmsg"]["des"]
+      @thumb_image = @raw["msg"]["appmsg"]["thumb_url"]
+      @from_user = @raw["msg"]["fromusername"]
+      @app = @raw["msg"]["appname"]
+      @mp = {
+        username: @raw["msg"]["sourceusername"],
+        nickname: @raw["msg"]["sourcedisplayname"],
+      }
+    end
+  end
+end

data/lib/wechat/bot/pattern.rb

@@ -0,0 +1,63 @@
+module WeChat::Bot
+  # 消息匹配
+  class Pattern
+    # @param [String, Regexp, NilClass, Proc, #to_s] obj 匹配规则
+    # @return [Regexp, nil]
+    def self.obj_to_r(obj, anchor = nil)
+      case obj
+      when Regexp, NilClass
+        return obj
+      else
+        escaped = Regexp.escape(obj.to_s)
+        case anchor
+        when :start
+          return Regexp.new("^" + escaped)
+        when :end
+          return Regexp.new(escaped + "$")
+        when nil
+          return Regexp.new(Regexp.escape(obj.to_s))
+        end
+      end
+    end
+
+    def self.resolve_proc(obj, msg = nil)
+      if obj.is_a?(Proc)
+        return resolve_proc(obj.call(msg), msg)
+      else
+        return obj
+      end
+    end
+
+    def self.generate(type, argument)
+      case type
+      when :ctcp
+        Pattern.new(/^/, /#{Regexp.escape(argument.to_s)}(?:$| .+)/, nil)
+      else
+        raise ArgumentError, "Unsupported type: #{type.inspect}"
+      end
+    end
+
+    attr_reader :prefix
+    attr_reader :suffix
+    attr_reader :pattern
+
+    def initialize(prefix, pattern, suffix)
+      @prefix, @pattern, @suffix = prefix, pattern, suffix
+    end
+
+    def to_r(msg = nil)
+      pattern = Pattern.resolve_proc(@pattern, msg)
+
+      case pattern
+      when Regexp, NilClass
+        prefix  = Pattern.obj_to_r(Pattern.resolve_proc(@prefix, msg), :start)
+        suffix  = Pattern.obj_to_r(Pattern.resolve_proc(@suffix, msg), :end)
+        /#{prefix}#{pattern}#{suffix}/
+      else
+        prefix  = Pattern.obj_to_r(Pattern.resolve_proc(@prefix, msg))
+        suffix  = Pattern.obj_to_r(Pattern.resolve_proc(@suffix, msg))
+        /^#{prefix}#{Pattern.obj_to_r(pattern)}#{suffix}$/
+      end
+    end
+  end
+end

data/lib/wechat/bot/version.rb

@@ -0,0 +1,5 @@
+module WeChat
+  module Bot
+    VERSION = "0.1.0.alpha"
+  end
+end

data/lib/wechat_bot.rb

@@ -0,0 +1 @@
+require "wechat/bot"

data/wechat-bot.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wechat/bot/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "wechat-bot"
+  spec.version       = WeChat::Bot::VERSION
+  spec.authors       = ["icyleaf"]
+  spec.email         = ["icyleaf.cn@gmail.com"]
+
+  spec.summary       = "WeChat Bot for Ruby"
+  spec.description   = "WeChat Bot for Ruby with personal account"
+  spec.homepage      = "https://github.com/icyleaf/wechat-bot"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "awesome_print"
+
+  spec.add_dependency "colorize", "~> 0.8.1"
+  spec.add_dependency "http", "~> 2.2.2"
+  spec.add_dependency "rqrcode", "~> 0.10.1"
+  spec.add_dependency "multi_xml", "~> 0.6.0"
+  # spec.add_dependency "representable", "~> 3.0.4"
+  # spec.add_dependency "roxml", "~> 3.3.1"
+  # spec.add_dependency "gemoji"
+end

metadata

@@ -0,0 +1,206 @@
+--- !ruby/object:Gem::Specification
+name: wechat-bot
+version: !ruby/object:Gem::Version
+  version: 0.1.0.alpha
+platform: ruby
+authors:
+- icyleaf
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+- !ruby/object:Gem::Dependency
+  name: rqrcode
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+- !ruby/object:Gem::Dependency
+  name: multi_xml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+description: WeChat Bot for Ruby with personal account
+email:
+- icyleaf.cn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- ".vscode/launch.json"
+- ".yardopts"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/wechat-bot.rb
+- lib/wechat/bot.rb
+- lib/wechat/bot/cached_list.rb
+- lib/wechat/bot/callback.rb
+- lib/wechat/bot/client.rb
+- lib/wechat/bot/configuration.rb
+- lib/wechat/bot/contact.rb
+- lib/wechat/bot/contact_list.rb
+- lib/wechat/bot/core.rb
+- lib/wechat/bot/ext/wechat_emoji_string.rb
+- lib/wechat/bot/handler.rb
+- lib/wechat/bot/handler_list.rb
+- lib/wechat/bot/helper.rb
+- lib/wechat/bot/http/adapter/js.rb
+- lib/wechat/bot/http/adapter/xml.rb
+- lib/wechat/bot/http/session.rb
+- lib/wechat/bot/logger.rb
+- lib/wechat/bot/message.rb
+- lib/wechat/bot/message_data/share_link.rb
+- lib/wechat/bot/pattern.rb
+- lib/wechat/bot/version.rb
+- lib/wechat_bot.rb
+- wechat-bot.gemspec
+homepage: https://github.com/icyleaf/wechat-bot
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: WeChat Bot for Ruby
+test_files: []