wechat-bot2 0.1.1

data/lib/wechat/bot/http/session.rb

@@ -0,0 +1,117 @@
+require "http"
+
+module WeChat::Bot
+  module HTTP
+    # 可保存 Cookies 的 HTTP 请求类
+    #
+    # 简单实现 Python 版本 {http://docs.python-requests.org/zh_CN/latest/user/advanced.html#session-objects requests.Session()}
+    class Session
+      # @return [HTTP::CookieJar]
+      attr_reader :cookies
+
+      def initialize(bot)
+        @bot = bot
+
+        load_cookies(@bot.config.cookies)
+      end
+
+      # @return [HTTP::Response]
+      def get(url, options = {})
+        request(:get, url, options)
+      end
+
+      # @return [HTTP::Response]
+      def post(url, options = {})
+        request(:post, url, options)
+      end
+
+      # @return [HTTP::Response]
+      def put(url, options = {})
+        request(:put, url, options)
+      end
+
+      # @return [HTTP::Response]
+      def delete(url, options = {})
+        request(:delete, url, options)
+      end
+
+      # @return [HTTP::Response]
+      def request(verb, url, options = {})
+        prepare_request(url)
+
+        if options[:timeout]
+          connect_timeout, read_timeout = options.delete(:timeout)
+          @client = @client.timeout(connect: connect_timeout, read: read_timeout)
+        end
+
+        response = @client.request(verb, url, options)
+        update_cookies(response.cookies)
+
+        @bot.logger.verbose "[#{verb.upcase}] #{url}"
+        @bot.logger.verbose "Options: #{options}"
+        @bot.logger.verbose "Response: #{response.body}"
+
+        response
+      end
+
+      private
+
+      # 组装 request 基础请求参数
+      #
+      #  - 设置 User-Agent
+      #  - 设置 Cooklies
+      #
+      # @api private
+      # @param [String] url
+      # @return [HTTP::Request]
+      def prepare_request(url)
+        @client = ::HTTP.headers(user_agent: @bot.config.user_agent, "Range" => "bytes=0-")
+        return @client if @cookies.nil?
+        return @client = @client.cookies(@cookies)
+
+        # TODO: 优化处理同一顶级域名的 cookies
+        # uri = URI(url)
+        # unless @cookies.empty?(uri)
+        #   cookies = @cookies.clone
+        #   cookies.cookies.each do |cookie|
+        #     cookies.delete(cookie) if uri.host != cookie.domain
+        #   end
+
+        #   unless cookies.empty?(uri)
+        #     @client = @client.cookies(@cookies)
+        #   end
+        # end
+
+      end
+
+      # 加载外部的 Cookies 数据
+      #
+      # @api private
+      # @param [String, HTTP::CooieJar] cookies
+      # @return [void]
+      def load_cookies(cookies)
+        @cookies = ::HTTP::CookieJar.new
+        return if cookies.nil?
+
+        if cookies.is_a?(String)
+          @cookies.load(cookies) if File.exist?(cookies)
+        else
+          @cookies.add(cookies)
+        end
+      end
+
+      # 请求后更新存储的 Cookies 数据
+      #
+      # @api private
+      # @param [String, HTTP::CooieJar] cookies
+      # @return [void]
+      def update_cookies(cookies)
+        return @cookies = cookies if @cookies.nil? || @cookies.empty?
+
+        cookies.cookies.each do |cookie|
+          @cookies.add(cookie)
+        end
+      end
+    end
+  end
+end

data/lib/wechat/bot/logger.rb

@@ -0,0 +1,102 @@
+require "colorize"
+
+module WeChat::Bot
+  class Logger
+    LEVELS = [:verbose, :debug, :info, :warn, :error, :fatal]
+
+    # @return [Symbol]
+    attr_accessor :level
+
+    # @return [Mutex]
+    attr_reader :mutex
+
+    # @return [IO]
+    attr_reader :output
+
+    def initialize(output, bot)
+      @output = output
+      @bot = bot
+      @mutex = Mutex.new
+      @level = :info
+    end
+
+    def verbose(message)
+      log(:verbose, message)
+    end
+
+    def debug(message)
+      log(:debug, message)
+    end
+
+    def info(message)
+      log(:info, message)
+    end
+
+    def warn(message)
+      log(:warn, message)
+    end
+
+    def error(message)
+      log(:error, message)
+    end
+
+    def fatal(exception)
+      message = ["#{exception.backtrace.first}: #{exception.message} (#{exception.class})"]
+      message.concat(exception.backtrace[1..-1].map {|s| "\t" + s})
+      log(:fatal, message.join("\n"))
+    end
+
+    def log(level, message)
+      return unless can_log?(level)
+      return if message.to_s.empty?
+
+      @mutex.synchronize do
+        message = format_message(format_general(message), level)
+        @output.puts message
+      end
+    end
+
+    private
+
+    def can_log?(level)
+      @level = :verbose if @bot.config.verbose
+      LEVELS.index(level) >= LEVELS.index(@level)
+    end
+
+    def format_general(message)
+      message
+    end
+
+    def format_message(message, level)
+      send("format_#{level}", message)
+    end
+
+    def format_verbose(message)
+      "VERBOSE [#{timestamp}] #{message.colorize(:light_black)}"
+    end
+
+    def format_debug(message)
+      "DEBUG   [#{timestamp}] #{message.colorize(:light_black)}"
+    end
+
+    def format_info(message)
+      "INFO    [#{timestamp}] #{message}"
+    end
+
+    def format_warn(message)
+      "WRAN    [#{timestamp}] #{message.colorize(:yellow)}"
+    end
+
+    def format_error(message)
+      "ERROR   [#{timestamp}] #{message.colorize(:light_red)}"
+    end
+
+    def format_fatal(message)
+      "FATAL   [#{timestamp}] #{message.colorize(:red)}"
+    end
+
+    def timestamp
+      Time.now.strftime("%Y-%m-%d %H:%M:%S.%2N")
+    end
+  end
+end

data/lib/wechat/bot/message.rb

@@ -0,0 +1,282 @@
+require "wechat/bot/message_data/share_card"
+
+module WeChat::Bot
+  # 微信消息
+  class Message
+    # 消息类型
+    module Kind
+      Text = :text
+      Image = :image
+      Voice = :voice
+      ShortVideo = :short_video
+      Emoticon = :emoticon
+      ShareCard = :share_link
+      # RedPacage = :red_package
+      # BusinessCard = :business_card
+      # MusicLink = :music_link
+      Verify = :verify
+      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.verbose "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
+
+      # if @bot.config.special_users.include?(to_user) && to_user != 'filehelper'
+      #   @bot.logger.error "特殊账户无法回复: #{to_user}"
+      #   raise NoReplyException, "特殊账户无法回复: #{to_user}"
+      # end
+
+      @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
+      # TODO: 来自于特殊账户无法获取联系人信息，需要单独处理
+      @from = @bot.contact_list.find(username: @raw["FromUserName"])
+      parse_emoticon if @kind == Message::Kind::Emoticon
+
+      case @kind
+      when Message::Kind::ShareCard
+        @meta_data = MessageData::ShareCard.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
+
+    def at_message?
+      @at_mesage == true
+    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 语言消息
+    #  - 37: 验证消息
+    #  - 42: BusinessCard 名片消息
+    #  - 47: Emoticon 微信表情
+    #  - 49: ShareCard 分享链接消息
+    #  - 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 37
+                Message::Kind::Verify
+              when 42
+                Message::Kind::BusinessCard
+              when 62
+                Message::Kind::ShortVideo
+              when 47
+                Message::Kind::Emoticon
+              when 49
+                Message::Kind::ShareCard
+              when 10000
+                Message::Kind::System
+              else
+                Message::Kind::Unkown
+              end
+    end
+
+    # 解析 Handler 的事件
+    #
+    #  - `:message` 用户消息
+    #    - `:text` 文本消息
+    #    - `:image` 图片消息
+    #    - `:voice` 语音消息
+    #    - `:short_video` 短视频消息
+    #  - `:group` 群聊消息
+    #    - `:at_message` @ 消息
+    #
+    # @return [void]
+    def parse_events
+      @events << :message
+      @events << @kind
+      @events << @source
+
+      @at_mesage = false
+      if @source == :group && @raw["Content"] =~ /@([^\s]+)\s+(.*)/
+        @events << :at_message
+        @at_mesage = true
+      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
+      # TODO: 完成解析
+      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_card.rb

@@ -0,0 +1,46 @@
+module WeChat::Bot::MessageData
+  class ShareCard
+    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.1"
+  end
+end

data/lib/wechat/bot.rb

@@ -0,0 +1,12 @@
+require "wechat/bot/version"
+require "wechat/bot/ext/wechat_emoji_string"
+
+require "wechat/bot/core"
+require "wechat/bot/client"
+require "wechat/bot/exception"
+
+module WeChat::Bot
+  def self.new(&block)
+    WeChat::Bot::Core.new(&block)
+  end
+end

data/lib/wechat-bot.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'wechat/bot'

data/lib/wechat_bot.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'wechat/bot'

data/wechat-bot.gemspec

@@ -0,0 +1,40 @@
+# 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-bot2"
+  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.required_ruby_version = ">= 2.1.0"
+
+  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 "rubocop", "~> 0.53.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