wechat-bot 0.1.0.alpha

data/lib/wechat/bot/ext/wechat_emoji_string.rb

@@ -0,0 +1,16 @@
+module WeChat::Bot
+  module WeChatEmojiString
+    def convert_emoji
+      emoji_regex = /<span class="emoji emoji(\w+)"><\/span>/
+      if match = self.match(emoji_regex)
+        return self.gsub(emoji_regex, [match[1].hex].pack("U"))
+      end
+
+      self
+    end
+  end
+end
+
+class String
+  include WeChat::Bot::WeChatEmojiString
+end

data/lib/wechat/bot/handler.rb

@@ -0,0 +1,92 @@
+module WeChat::Bot
+  # Handler
+  class Handler
+    # @return [Core]
+    attr_reader :bot
+
+    # @return [Symbol]
+    attr_reader :event
+
+    # @return [String]
+    attr_reader :pattern
+
+    # @return [Array]
+    attr_reader :args
+
+    # @return [Proc]
+    attr_reader :block
+
+    # @return [Symbol]
+    attr_reader :group
+
+    # @return [ThreadGroup]
+    # @api private
+    attr_reader :thread_group
+
+    def initialize(bot, event, pattern, options = {}, &block)
+      options              = {
+        :group => nil,
+        :execute_in_callback => false,
+        :strip_colors => false,
+        :args => []
+      }.merge(options)
+
+      @bot = bot
+      @event = event
+      @pattern = pattern
+      @block = block
+      @group = options[:group]
+      @execute_in_callback = options[:execute_in_callback]
+      @args = options[:args]
+
+      @thread_group = ThreadGroup.new
+    end
+
+    # 执行 Handler
+    #
+    # @param [Symbol] message
+    # @param [String] captures
+    # @param [Array] arguments
+    # @return [Thread]
+    def call(message, captures, arguments)
+      bargs = captures + arguments
+
+      thread = Thread.new {
+        @bot.logger.debug "[New thread] For #{self}: #{Thread.current} -- #{@thread_group.list.size} in total."
+        begin
+          if @execute_in_callback
+            @bot.callback.instance_exec(message, *@args, *bargs, &@block)
+          else
+            @block.call(message, *@args, *bargs)
+          end
+        rescue => e
+          @bot.logger.error "[Thread error] #{e.message} -> #{e.backtrace.join("\n")}"
+        ensure
+          @bot.logger.debug "[Thread done] For #{self}: #{Thread.current} -- #{@thread_group.list.size - 1} remaining."
+        end
+      }
+
+      @thread_group.add(thread)
+      thread
+    end
+
+    # @return [void]
+    def stop
+      @bot.logger.debug "[Stopping handler] Stopping all threads of handler #{self}: #{@thread_group.list.size} threads..."
+      @thread_group.list.each do |thread|
+        Thread.new do
+          @bot.logger.debug "[Ending thread] Waiting 10 seconds for #{thread} to finish..."
+          thread.join(10)
+          @bot.logger.debug "[Killing thread] Killing #{thread}"
+          thread.kill
+        end
+      end
+    end
+
+    # @return [String]
+    def to_s
+      # TODO maybe add the number of running threads to the output?
+      "#<Cinch::Handler @event=#{@event.inspect} pattern=#{@pattern.inspect}>"
+    end
+  end
+end

data/lib/wechat/bot/handler_list.rb

@@ -0,0 +1,92 @@
+module WeChat::Bot
+  # Handler 列表
+  class HandlerList
+    include Enumerable
+
+    def initialize
+      @handlers = Hash.new {|h,k| h[k] = []}
+      @mutex = Mutex.new
+    end
+
+    # 注册 Handler
+    #
+    # @param [Handler] handler
+    # @return [void]
+    def register(handler)
+      @mutex.synchronize do
+        handler.bot.logger.debug "[on handler] Registering handler with pattern `#{handler.pattern}`, reacting on `#{handler.event}`"
+        @handlers[handler.event].push(handler)
+      end
+    end
+
+    # 取消注册 Handler
+    #
+    # @param [Array<Handler>] handlers
+    # @return [void]
+    def unregister(*handlers)
+      @mutex.synchronize do
+        handlers.each do |handler|
+          @handlers[handler.event].delete(handler)
+        end
+      end
+    end
+
+    # 分派执行 Handler
+    #
+    # @param [Symbol] event
+    # @param [String] message
+    # @param [Array<Object>] args
+    # @return [Array<Thread>]
+    def dispatch(event, message = nil, *args)
+      threads = []
+
+      if handlers = find(event, message)
+        already_run = Set.new
+        handlers.each do |handler|
+          next if already_run.include?(handler.block)
+          already_run.add(handler.block)
+
+          if message
+            captures = message.match(handler.pattern.to_r(message), event).captures
+          else
+            captures = []
+          end
+
+          threads.push(handler.call(message, captures, args))
+        end
+      end
+
+      threads
+    end
+
+    # 查找匹配 Handler
+    #
+    # @param [Symbol] type
+    # @param [String] message
+    # @return [Hander]
+    def find(type, message = nil)
+      if handlers = @handlers[type]
+        if message.nil?
+          return handlers
+        end
+
+        handlers = handlers.select { |handler|
+          message.match(handler.pattern.to_r(message), type)
+        }.group_by {|handler| handler.group}
+
+        handlers.values_at(*(handlers.keys - [nil])).map(&:first) + (handlers[nil] || [])
+      end
+    end
+
+    def each(&block)
+      @handlers.values.flatten.each(&block)
+    end
+
+    # 停止运行所有 Handler
+    #
+    # @return [void]
+    def stop_all
+      each { |h| h.stop }
+    end
+  end
+end

data/lib/wechat/bot/helper.rb

@@ -0,0 +1,2 @@
+module WeChat::Bot
+end

data/lib/wechat/bot/http/adapter/js.rb

@@ -0,0 +1,33 @@
+require "http/mime_type"
+require "http/mime_type/adapter"
+
+module WeChat::Bot
+  module HTTP
+    module MimeType
+      # Javascript 代码解析
+      # 用于解析微信 API 返回的部分 JS 代码，
+      # 提示：不可逆转
+      class JS < ::HTTP::MimeType::Adapter
+        # Encodes object to js
+        def encode(obj)
+          "" # NO NEED encode
+        end
+
+        # 转换 JS 代码为 Hash
+        #
+        # @return [Hash]
+        def decode(str)
+          str.split("window.").each_with_object({}) do |item, obj|
+            key, value = item.split(/\s*=\s*/, 2)
+            next unless key || value
+            key = key.split(".")[-1]
+            obj[key] = eval(value)
+          end
+        end
+      end
+    end
+  end
+
+  ::HTTP::MimeType.register_adapter "text/javascript", WeChat::Bot::HTTP::MimeType::JS
+  ::HTTP::MimeType.register_alias   "text/javascript", :js
+end

data/lib/wechat/bot/http/adapter/xml.rb

@@ -0,0 +1,29 @@
+require "http/mime_type"
+require "http/mime_type/adapter"
+require "multi_xml"
+# require "roxml"
+
+module WeChat::Bot
+  module HTTP
+    module MimeType
+      # XML 代码解析
+      # 提示：不可逆转
+      class XML < ::HTTP::MimeType::Adapter
+        # Encodes object to js
+        def encode(obj)
+          "" # NO NEED encode
+        end
+
+        # 转换 XML 代码为 Hash
+        #
+        # @return [Hash]
+        def decode(str)
+          MultiXml.parse(str)
+        end
+      end
+    end
+  end
+
+  ::HTTP::MimeType.register_adapter "text/xml", WeChat::Bot::HTTP::MimeType::XML
+  ::HTTP::MimeType.register_alias   "text/xml", :xml
+end

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