qbot 0.1.3 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 96175e44e35b00efdc98a08f7dc482c75358a2fa
-  data.tar.gz: f56a2d9a7e9d7634d8c8f1dcbe8a443cad455b05
+SHA256:
+  metadata.gz: 4c0dd3c3d9a34d8eae7415eb10ddefa307ebca4bd200321e18fee452de9de157
+  data.tar.gz: 3a4f94dda22cd3aa76a83efd0c6c664ab365ed18946bec7b3e3bd7862728a421
 SHA512:
-  metadata.gz: b03726403afaad4534f48644c27184b7a7df7fa562bbcdae9bd87a67004b816594f5c15d6726e204438793bff9cf0d3b6a27dfa715465168a4194a6bab6f6600
-  data.tar.gz: 0a33dbf259131511157139fefbe1faf4d790a40fc9962a77f8f4ddd962ae5b0a71de90f97748d29cc31219c2168c6f8c7b4d9d77e3b725c72d008f4070c668c6
+  metadata.gz: cf435067c01baa076842a9ce672291897668eeef96b4e33fb216c7149feb6481139b79944725ba0c4816223925648521c7ebedd64ad909601e9b3a89e2d8c502
+  data.tar.gz: b61c2f73b417f4d6eb08dbef13386385d7a221847ef9a7c52607f1f29fb519d11eb7e227fe91b0beb35d3055de81c0082664eee0a42080b3fcce7308c6e7892a

data/lib/qbot.rb

@@ -1,4 +1,5 @@
 require 'qbot/base'
+require 'qbot/embed/help'
 require 'qbot/autorun'
 
 module Qbot

data/lib/qbot/adapter.rb

@@ -1,6 +1,6 @@
-module Qbot
+require 'qbot/message'
 
-  Message = Struct.new(:text, :data, :matched)
+module Qbot
 
   module Adapter
 
@@ -20,7 +20,7 @@ module Qbot
 
       def run(bots)
         listen do |message|
-          bots.each { |bot| bot.call(message.dup) }
+          bots.each { |bot| bot.listen(message.dup) }
         end
       end
 
@@ -32,10 +32,6 @@ module Qbot
         raise 'Not implemented'
       end
 
-      def reply_to(message, text, **options)
-        raise 'Not implemented'
-      end
-
     end
 
   end

data/lib/qbot/adapter/mattermost.rb

@@ -20,6 +20,8 @@ module Qbot
 
         access_token(resp.headers['token'])
         raise 'Login failed' unless @token
+
+        @bot_id = me['username']
       end
 
       def access_token(token)
@@ -35,22 +37,19 @@ module Qbot
       end
 
       def post(text, **options)
-        resp = api_call(:post, "/posts", body: options.merge(message: text))
-        Qbot.app.logger.info("#{self.class} - Post message: #{resp.status} - '#{text}'")
-      end
-
-      def reply_to(message, text, **options)
         if options[:channel_id]
-          channel_id = options[:channel_id]
+          # do nothing
         elsif options[:channel_name]
-          channel = channel(options[:channel_name])
-          channel_id = channel['id'] if channel
+          channel = channel(options.delete(:channel_name))
+          options[:channel_id] = channel['id'] if channel
+        elsif options[:reply_to]
+          message = options.delete(:reply_to)
+          options[:channel_id] = message.data['channel_id']
         end
 
-        channel_id ||= message.data['channel_id'] if message
-        return unless channel_id
-
-        post(text, **options.merge(channel_id: channel_id))
+        return unless options[:channel_id]
+        Qbot.app.logger.info("#{self.class} - Post message: '#{text}'")
+        api_call(:post, "/posts", body: options.merge(message: text))
       end
 
       private
@@ -59,10 +58,9 @@ module Qbot
       end
 
       def start_connection(&block)
-        running = true
         ws_url  = URI.join(@server.gsub(/^http(s?):/, 'ws\1:'), endpoint('/websocket')).to_s
 
-        ws = Faye::WebSocket::Client.new(ws_url)
+        ws = Faye::WebSocket::Client.new(ws_url, nil, {ping: 60})
         ws.send({seq: 1, action: 'authentication_challenge', data: {token: @token}}.to_json)
 
         ws.on :message do |e|
@@ -76,12 +74,12 @@ module Qbot
 
         ws.on :close do |e|
           Qbot.app.logger.info("#{self.class} - Websocket connection closed: #{e.code} #{e.reason}")
-          if running then start_connection(&block) else Qbot.app.stop end
+          sleep 30
+          start_connection(&block)
         end
 
         ws.on :error do |e|
           Qbot.app.logger.error("#{self.class} - Websocket encountered error: #{e.message}")
-          running = false
         end
       end
 
@@ -91,16 +89,16 @@ module Qbot
 
         case type
         when 'posted'
-          post = JSON.parse(data['data']['post'])
+          data = JSON.parse(data['data']['post'])
 
-          message = Qbot::Message.new
-          message.data = post
-          message.text = post['message']
+          message = Qbot::Message.new(data)
+          message.text = data['message']
+          message.mention(/^\s*@#{@bot_id}\b/)
 
           callback.call(message)
         end
       rescue => err
-        Qbot.app.logger.error("#{self.class} - ERROR! #{err}")
+        Qbot.app.logger.error("#{self.class} - ERROR: #{err}")
       end
 
       def api_call(method, path, **options, &block)

data/lib/qbot/adapter/shell.rb

@@ -18,9 +18,9 @@ module Qbot
         def receive_line(text)
           exit 0 if text.strip == 'exit'
 
-          message = Qbot::Message.new
-          message.data = text
+          message = Qbot::Message.new(text)
           message.text = text
+          message.mention(/^\s*bot\b/)
 
           @callback.call(message)
           $stdout.print ">> "
@@ -39,10 +39,6 @@ module Qbot
         $stdout.puts text
       end
 
-      def reply_to(message, text, **options)
-        post(text, **options)
-      end
-
     end
 
   end

data/lib/qbot/adapter/slack.rb

@@ -12,9 +12,9 @@ module Qbot
       SLACK_API_URL = 'https://slack.com/api'
 
       def initialize(api_token: nil)
-        @server = URI.join(SLACK_API_URL, '/').to_s
-
         access_token(api_token || ENV['QBOT_SLACK_API_TOKEN'])
+        @server = URI.join(SLACK_API_URL, '/').to_s
+        @bot_id = me['user_id']
       end
 
       def access_token(token)
@@ -26,26 +26,23 @@ module Qbot
       end
 
       def close
-        EM.stop
+        EM.stop_event_loop
       end
 
       def post(text, **options)
-        resp = api_call(:post, "/chat.postMessage", options.merge(text: text))
-        Qbot.app.logger.info("#{self.class} - Post message: #{resp.status} - '#{text}'")
-      end
-
-      def reply_to(message, text, **options)
         if options[:channel_id]
-          channel_id = options[:channel_id]
+          options[:channel] = options.delete(:channel_id)
         elsif options[:channel_name]
-          channel = channel(options[:channel_name])
-          channel_id = channel['id'] if channel
+          channel = channel(options.delete(:channel_name))
+          options[:channel] = channel['id'] if channel
+        elsif options[:reply_to]
+          message = options.delete(:reply_to)
+          options[:channel] = message.data['channel']
         end
 
-        channel_id ||= message.data['channel'] if message
-        return unless channel_id
-
-        post(text, **options.merge(channel: channel_id))
+        return unless options[:channel]
+        Qbot.app.logger.info("#{self.class} - Post message: '#{text}'")
+        api_call(:post, "/chat.postMessage", options.merge(text: text))
       end
 
       private
@@ -57,7 +54,6 @@ module Qbot
         resp = api_call(:get, '/rtm.start')
         data = JSON.parse(resp.body)
 
-        running = true
         ws_url  = data['url']
         ws = Faye::WebSocket::Client.new(ws_url, nil, {ping: 60})
 
@@ -72,26 +68,26 @@ module Qbot
 
         ws.on :close do |e|
           Qbot.app.logger.info("#{self.class} - Websocket connection closed: #{e.code} #{e.reason}")
-          if running then start_connection(&block) else Qbot.app.stop end
+          sleep 30
+          start_connection(&block)
         end
 
         ws.on :error do |e|
           Qbot.app.logger.error("#{self.class} - Websocket encountered error: #{e.message}")
-          running = false
         end
       end
 
       def emit_event(data, callback)
-        return unless type = data['event']
+        return unless type = data['type']
         Qbot.app.logger.debug("#{self.class} - Event '#{type}' recieved")
 
         case type
         when 'message'
           return if data['subtype']
 
-          message = Qbot::Message.new
-          message.data = data
+          message = Qbot::Message.new(data)
           message.text = data['text']
+          message.mention(/^\s*<@#{@bot_id}>/)
 
           callback.call(message)
         end

data/lib/qbot/app.rb

@@ -26,24 +26,25 @@ module Qbot
 
     def initialize
       @bots    = []
+      @help    = {}
       @threads = []
       @timers  = Timers::Group.new
       @logger  = Logger.new(STDOUT)
     end
 
-    def add(bot)
+    def add_bot(bot)
       @bots << bot
     end
 
-    def bots
-      @bots.map { |bot| bot.class.name }.uniq
+    def help_text(usages = {})
+      @help.update(usages)
     end
 
     def start
       @logger.info("Booting #{self.class}.")
       @logger.info("#{storage.class} - Storage driver loaded.")
       @logger.info("#{adapter.class} - Adapter driver loaded.")
-      bots.each { |bot| @logger.info("Loading #{bot}.") }
+      @bots.map { |bot| bot.class.name }.uniq.each { |bot| @logger.info("#{bot} loaded.") }
 
       Thread.abort_on_exception = true
       @threads << Thread.start { loop { @timers.wait } }

data/lib/qbot/autorun.rb

@@ -5,7 +5,10 @@ module Qbot
       exit if $!
 
       %i{INT TERM}.each do |signal|
-        Signal.trap(signal) { exit }
+        Signal.trap(signal) do
+          Qbot.app.stop
+          exit
+        end
       end
 
       Qbot.run!(ARGV)

data/lib/qbot/base.rb

@@ -13,15 +13,20 @@ module Qbot
 
     class << self
 
-      def on(pattern, &block)
-        pattern = Regexp.new(pattern.to_s) unless Regexp === pattern
-        Qbot.app.add(new(pattern, &block))
+      def on(pattern, **options, &block)
+        pattern  = Regexp.new("\b#{pattern}\b") unless Regexp === pattern
+        instance = new(pattern, **options, &block)
+        Qbot.app.add_bot(instance)
       end
 
       def cron(pattern, &block)
         schedule(pattern, &block)
       end
 
+      def help(usages)
+        Qbot.app.help_text(usages)
+      end
+
       private
       def schedule(pattern, &block)
         parser  = CronParser.new(pattern)
@@ -29,32 +34,43 @@ module Qbot
         delay   = parser.next(current) - current
 
         Qbot.app.timers.after(delay) do
-          new(pattern).instance_eval(&block)
+          begin
+            instance = new(pattern)
+            instance.instance_eval(&block)
+          rescue => e
+            Qbot.app.logger.error("#{instance.class} - Error: #{e}")
+          end
+
           schedule(pattern, &block)
         end
       end
 
     end
 
-    def initialize(pattern, &block)
+    def initialize(pattern, **options, &block)
       @pattern  = pattern
+      @options  = options
       @callback = block
     end
 
-    def call(message)
-      @message = message
-      return unless @pattern =~ @message.text.to_s.strip
-
-      begin
-        Qbot.app.logger.debug("#{self.class} - Recieve message: '#{message.text}'")
-        instance_exec($~, &@callback)
-      rescue => e
-        Qbot.app.logger.error("#{self.class} - Error: #{e}")
+    def listen(message)
+      if @options[:global]
+        return unless message.match(@pattern)
+      else
+        return unless message.mentioned?
+        return unless message.match(@pattern, prefix: message.mention)
       end
+
+      Qbot.app.logger.debug("#{self.class} - Recieve message: '#{message.text}'")
+
+      @message = message
+      instance_exec(@message, &@callback)
+    rescue => e
+      Qbot.app.logger.error("#{self.class} - Error: #{e}")
     end
 
     def post(text, **options)
-      Qbot.app.adapter.reply_to(@message, text, **options)
+      Qbot.app.adapter.post(text, reply_to: @message, **options)
     end
 
     def cache

data/lib/qbot/embed/cron.rb

@@ -2,25 +2,22 @@ module Qbot
 
   class Cron < Qbot::Base
 
+    help "cron add <pattern> <message>" => "Add a cron task."
     on /^cron add (\S+ \S+ \S+ \S+ \S+) (.+)$/ do |msg|
-      post start(unique_id, msg[1], msg[2])
+      post start(unique_id, msg.captures[1], msg.captures[2])
     end
 
+    help "cron del <cron-id>" => "Remove a cron task."
     on /^cron del (\d+)/ do |msg|
-      post stop(msg[1].to_i)
+      post stop(msg.captures[1].to_i)
     end
 
+    help "cron list" => "List all cron tasks."
     on /^cron list\b/ do |msg|
       post list_all
     end
 
-    usage <<~EOL
-    Usage:
-      `cron add <pattern> <message>` - add a cron task.
-      `cron del <cron-id>`           - remove a cron task.
-      `cron list`                    - list all cron tasks.
-    EOL
-
+    private
     def self.timers
       @timers ||= {}
     end
@@ -29,26 +26,25 @@ module Qbot
       schedule(id, cron, text) rescue return
 
       cache[id] = [cron, text]
-      "ADD " + dump_line(id, cron, text)
+      "ADD #{format(id, cron, text)}"
     end
 
     def stop(id)
       Cron.timers[id].cancel if Cron.timers[id]
       cron, text = cache[id]
-      return unless cron && text
 
-      cache[id]  = nil
-      "DEL " + dump_line(id, cron, text)
+      cache[id] = nil
+      "DEL #{format(id, cron, text)}"
     end
 
     def list_all
       resp = StringIO.new
       cache.each do |id, (cron, text)|
         next unless cron && text
-        resp.puts dump_line(id, cron, text)
+        resp.puts format(id, cron, text)
       end
 
-      resp.string
+      resp.string.chomp
     end
 
     private
@@ -63,7 +59,7 @@ module Qbot
       end
     end
 
-    def dump_line(id, cron, text)
+    def format(id, cron, text)
       "#{id.to_s.rjust(3, '0')}: #{cron} #{text}"
     end
 

data/lib/qbot/embed/echo.rb

@@ -2,15 +2,11 @@ module Qbot
 
   class Echo < Qbot::Base
 
+    help "echo <text>" => "Echo back the given <text>."
     on /^echo( .+)$/ do |msg|
-      post msg[1].strip
+      post msg.captures[1].strip
     end
 
-    usage <<~EOL
-    Usage:
-      `echo <text>` - Reflect the given <text>.
-    EOL
-
   end
 
 end

data/lib/qbot/embed/help.rb

@@ -0,0 +1,18 @@
+require 'stringio'
+
+module Qbot
+
+  class Help < Qbot::Base
+
+    on /^help\b/i do |msg|
+      usage = Qbot.app.help_text
+
+      text = StringIO.new
+      text.puts 'Usage:'
+      text.puts usage.map { |key, val| "`#{key}` - #{usage[key]}" }
+      post text.string.chomp
+    end
+
+  end
+
+end

data/lib/qbot/embed/ping.rb

@@ -2,8 +2,8 @@ module Qbot
 
   class Ping < Qbot::Base
 
-    on /^ping\b/i do |msg|
-      post msg[0].tr('iI', 'oO')
+    on /\bping\b/i, global: true do |msg|
+      post msg.captures[0].tr('iI', 'oO')
     end
 
   end

data/lib/qbot/message.rb

@@ -0,0 +1,29 @@
+module Qbot
+
+  class Message
+
+    attr_accessor :text
+    attr_reader :data, :captures
+
+    def initialize(data, text = '')
+      @data = data
+      @text = text
+    end
+
+    def match(regexp, prefix: nil)
+      text = @text.dup
+      text.sub!(/^#{prefix}/, '') if prefix
+      @captures = text.strip.match(regexp)
+    end
+
+    def mention(regexp = nil)
+      @mention = text.slice(regexp) if regexp
+      @mention
+    end
+
+    def mentioned?
+      !!mention
+    end
+  end
+
+end

data/lib/qbot/storage/memory.rb

@@ -9,7 +9,7 @@ module Qbot
       end
 
       def namespace(ns)
-        @db[ns]
+        @db[ns] ||= {}
       end
 
     end

data/lib/qbot/version.rb

@@ -1,3 +1,3 @@
 module Qbot
-  VERSION = "0.1.3"
+  VERSION = "0.1.10"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qbot
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.10
 platform: ruby
 authors:
 - haccht
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-14 00:00:00.000000000 Z
+date: 2019-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -175,7 +175,9 @@ files:
 - lib/qbot/base.rb
 - lib/qbot/embed/cron.rb
 - lib/qbot/embed/echo.rb
+- lib/qbot/embed/help.rb
 - lib/qbot/embed/ping.rb
+- lib/qbot/message.rb
 - lib/qbot/storage.rb
 - lib/qbot/storage/leveldb.rb
 - lib/qbot/storage/memory.rb
@@ -201,7 +203,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Tiny chatbot flamework.