slack-smart-bot 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53175e003bbaf58181aecd71f350c0534f66541443bf486075197af040127e72
-  data.tar.gz: 7872fc51317b5501bb0ee7ec87595bafdcefbdcebbfa702159bbae282e24ee9b
+  metadata.gz: d3f64ad6c12b868d2d0111788ebe402eeae5f10a8b44be42f28969a38612c3e6
+  data.tar.gz: 310d7d62aff408f5973e955b7097113e4a02c7bc4ae7d92fb3f35d4b0fa23eb4
 SHA512:
-  metadata.gz: f11099c6edbc90ff63ee1f5bf01154997386614d5e201a981a223ef4e73208cf2615ba1492bc0ca34f5b0c0ba318083205e2668518104e2d382d656d03cf7241
-  data.tar.gz: 69041e01eff53c3157702a47ee45501541bafffde9e5d2c3e082ba36ac7f4b77e1c53f2ed116ee8616b76faffade6414350ff025bbeaff212ed769144af51b2a
+  metadata.gz: 9d431f88c4ad743df3278728830dfec7ba97d8dd9944e216231a7483039e0494b6e7ca10153d15c79ccf2f4bd7feebf71ffe96eb7c62ae4cb73ef7e16b03cc54
+  data.tar.gz: 1fc052a88c2b6a47230a1c08f7e8bfcb2dabaa392d897fae02ec3005ae33a91851dd476393bd6f69d74ccd2c2c73a9de63c58d9d11a7c5739e45e594ae70f2b5

data/README.md

@@ -47,7 +47,6 @@ settings = {
     # the channel that will act like the master channel, main channel
     master_channel: 'my_master_channel',
     masters: ["mario"], #names of the master users
-    nick: 'smart-bot', # the smart bot name
     token: 'xxxxxxxxxxxxxxxxxx' # the API Slack token
 }
 
@@ -286,13 +285,13 @@ Example:
 
 In case you want to use a shortcut as a inline shortcut inside a command you can do it by adding a $:
 Example:
->**_Peter>_** `!add shortcut cust1: 3488823-1233`
+>**_Peter>_** `!add shortcut cust1: 3488823-1233`  
 >**_Smart-Bot>_** `shortcut added`  
->**_Peter>_** `!add shortcut cust2: 1111555-6688`
+>**_Peter>_** `!add shortcut cust2: 1111555-6688`  
 >**_Smart-Bot>_** `shortcut added`  
 >**_Peter>_** `!run tests $cust1`  
 >**_Smart-Bot>_** `Running tests for customers 3488823-1233`  
->**_Peter>_** `!run tests $cust1 $cust2`
+>**_Peter>_** `!run tests $cust1 $cust2`  
 >**_Smart-Bot>_** `Running tests for customers 3488823-1233 1111555-6688`  
 
 To see available shortcuts: **_`see shortcuts`_** and to delete a particular shortcut: **_`delete shortcut NAME`_**

data/lib/slack-smart-bot.rb

@@ -14,6 +14,7 @@ require_relative "slack/smart-bot/comm"
 require_relative "slack/smart-bot/listen"
 require_relative "slack/smart-bot/treat_message"
 require_relative "slack/smart-bot/process_first"
+require_relative "slack/smart-bot/commands"
 require_relative "slack/smart-bot/process"
 require_relative "slack/smart-bot/utils"
 
@@ -163,17 +164,6 @@ class SlackSmartBot
 
     get_rules_imported()
 
-    begin
-      user_info = client.web_client.users_info(user: "#{"@" if config[:nick][0] != "@"}#{config[:nick]}")
-      config[:nick_id] = user_info.user.id
-    rescue Slack::Web::Api::Errors::TooManyRequestsError
-      @logger.fatal "TooManyRequestsError"
-      abort("TooManyRequestsError please re run the bot and be sure of executing first: killall ruby")
-    rescue Exception => stack
-      @logger.fatal stack
-      abort("The bot user specified on settings: #{config[:nick]}, doesn't exist on Slack. Execution aborted")
-    end
-
     begin
       @admin_users_id = []
       config.admins.each do |au|
@@ -191,6 +181,10 @@ class SlackSmartBot
       m = "Successfully connected, welcome '#{client.self.name}' to the '#{client.team.name}' team at https://#{client.team.domain}.slack.com."
       puts m
       @logger.info m
+      config.nick = client.self.name
+      config.nick_id = client.self.id
+      @salutations = [config[:nick], "<@#{config[:nick_id]}>", "bot", "smart"]
+
       gems_remote = `gem list slack-smart-bot --remote`
       version_remote = gems_remote.to_s().scan(/slack-smart-bot \((\d+\.\d+\.\d+)/).join
       version_message = ""

data/lib/slack/smart-bot/comm.rb

@@ -1,253 +1,7 @@
-class SlackSmartBot
-  def respond(msg, dest = nil)
-    if dest.nil? and Thread.current.key?(:dest)
-      dest = Thread.current[:dest]
-    end
-    dest = @channels_id[dest] if @channels_id.key?(dest) #it is a name of channel
-
-    if dest.nil?
-      if config[:simulate]
-        open("#{config.path}/buffer_complete.log", "a") { |f|
-          f.puts "|#{@channel_id}|#{config[:nick_id]}|#{msg}$$$"
-        }
-      else  
-        client.message(channel: @channel_id, text: msg, as_user: true)
-      end
-      if config[:testing] and config.on_master_bot
-        open("#{config.path}/buffer.log", "a") { |f|
-          f.puts "|#{@channel_id}|#{config[:nick_id]}|#{msg}"
-        }
-      end
-    elsif dest[0] == "C" or dest[0] == "G" # channel
-      if config[:simulate]
-        open("#{config.path}/buffer_complete.log", "a") { |f|
-        f.puts "|#{dest}|#{config[:nick_id]}|#{msg}$$$"
-      }
-      else  
-        client.message(channel: dest, text: msg, as_user: true)
-      end
-      if config[:testing] and config.on_master_bot
-        open("#{config.path}/buffer.log", "a") { |f|
-          f.puts "|#{dest}|#{config[:nick_id]}|#{msg}"
-        }
-      end
-    elsif dest[0] == "D" or dest[0] == "U" # Direct message
-      send_msg_user(dest, msg)
-    elsif dest[0] == "@"
-      begin
-        user_info = client.web_client.users_info(user: dest)
-        send_msg_user(user_info.user.id, msg)
-      rescue Exception => stack
-        @logger.warn("user #{dest} not found.")
-        @logger.warn stack
-        if Thread.current.key?(:dest)
-          respond("User #{dest} not found.")
-        end
-      end
-    else
-      @logger.warn("method respond not treated correctly: msg:#{msg} dest:#{dest}")
-    end
-  end
-
-  def respond_direct(msg)
-    dest = Thread.current[:user].id
-    respond(msg, dest)
-  end
-
-  #context: previous message
-  #to: user that should answer
-  def ask(question, context = nil, to = nil, dest = nil)
-    if dest.nil? and Thread.current.key?(:dest)
-      dest = Thread.current[:dest]
-    end
-    if to.nil?
-      to = Thread.current[:user].name
-    end
-    if context.nil?
-      context = Thread.current[:command]
-    end
-    message = "#{to}: #{question}"
-    if dest.nil?
-      if config[:simulate]
-        open("#{config.path}/buffer_complete.log", "a") { |f|
-          f.puts "|#{@channel_id}|#{config[:nick_id]}|#{message}$$$"
-        }
-      else  
-        client.message(channel: @channel_id, text: message, as_user: true)
-      end
-      if config[:testing] and config.on_master_bot
-        open("#{config.path}/buffer.log", "a") { |f|
-          f.puts "|#{@channel_id}|#{config[:nick_id]}|#{message}"
-        }
-      end
-    elsif dest[0] == "C" or dest[0] == "G" # channel
-      if config[:simulate]
-        open("#{config.path}/buffer_complete.log", "a") { |f|
-          f.puts "|#{dest}|#{config[:nick_id]}|#{message}$$$"
-        }
-      else  
-        client.message(channel: dest, text: message, as_user: true)
-      end
-      if config[:testing] and config.on_master_bot
-        open("#{config.path}/buffer.log", "a") { |f|
-          f.puts "|#{dest}|#{config[:nick_id]}|#{message}"
-        }
-      end
-    elsif dest[0] == "D" #private message
-      send_msg_user(dest, message)
-    end
-    @questions[to] = context
-  end
-
-  # to: (String) Channel name or id
-  # msg: (String) message to send
-  def send_msg_channel(to, msg)
-    unless msg == ""
-      get_channels_name_and_id() unless @channels_name.key?(to) or @channels_id.key?(to)
-      if @channels_name.key?(to) #it is an id
-        channel_id = to
-      elsif @channels_id.key?(to) #it is a channel name
-        channel_id = @channels_id[to]
-      else
-        @logger.fatal "Channel: #{to} not found. Message: #{msg}"
-      end
-      if config[:simulate]
-        open("#{config.path}/buffer_complete.log", "a") { |f|
-          f.puts "|#{channel_id}|#{config[:nick_id]}|#{msg}$$$"
-        }
-      else  
-        client.message(channel: channel_id, text: msg, as_user: true)
-      end
-      if config[:testing] and config.on_master_bot
-        open("#{config.path}/buffer.log", "a") { |f|
-          f.puts "|#{channel_id}|#{config[:nick_id]}|#{msg}"
-        }
-      end
-    end
-  end
-
-  #to send messages without listening for a response to users
-  def send_msg_user(id_user, msg)
-    unless msg == ""
-      if id_user[0] == "D"
-        if config[:simulate]
-          open("#{config.path}/buffer_complete.log", "a") { |f|
-            f.puts "|#{id_user}|#{config[:nick_id]}|#{msg}$$$"
-          }
-        else  
-          client.message(channel: id_user, as_user: true, text: msg)
-        end
-        if config[:testing] and config.on_master_bot
-          open("#{config.path}/buffer.log", "a") { |f|
-            f.puts "|#{id_user}|#{config[:nick_id]}|#{msg}"
-          }
-        end
-      else
-        im = client.web_client.im_open(user: id_user)
-        if config[:simulate]
-          open("#{config.path}/buffer_complete.log", "a") { |f|
-            f.puts "|#{im["channel"]["id"]}|#{config[:nick_id]}|#{msg}$$$"
-          }
-        else  
-          client.message(channel: im["channel"]["id"], as_user: true, text: msg)
-        end
-        if config[:testing] and config.on_master_bot
-          open("#{config.path}/buffer.log", "a") { |f|
-            f.puts "|#{im["channel"]["id"]}|#{config[:nick_id]}|#{msg}"
-          }
-        end
-      end
-    end
-  end
-
-  #to send a file to an user or channel
-  #send_file(dest, 'the message', "#{project_folder}/temp/logs_ptBI.log", 'message to be sent', 'text/plain', "text")
-  #send_file(dest, 'the message', "#{project_folder}/temp/example.jpeg", 'message to be sent', 'image/jpeg', "jpg")
-  def send_file(to, msg, file, title, format, type = "text")
-    if to[0] == "U" #user
-      im = client.web_client.im_open(user: to)
-      channel = im["channel"]["id"]
-    else
-      channel = to
-    end
-
-    client.web_client.files_upload(
-      channels: channel,
-      as_user: true,
-      file: Faraday::UploadIO.new(file, format),
-      title: title,
-      filename: file,
-      filetype: type,
-      initial_comment: msg,
-    )
-  end
-
-  def dont_understand(rules_file = nil, command = nil, user = nil, dest = nil, answer = ["what?", "huh?", "sorry?", "what do you mean?", "I don't understand"], channel_rules: config.channel, typem: nil)
-    command = Thread.current[:command] if command.nil?
-    user = Thread.current[:user] if user.nil?
-    dest = Thread.current[:dest] if dest.nil?
-    rules_file = Thread.current[:rules_file] if rules_file.nil?
-    typem = Thread.current[:typem] if typem.nil?
-    if typem==:on_extended
-      get_bots_created()
-    end
-
-    if typem!=:on_extended or (typem==:on_extended and @extended_from[@channels_name[dest]][0]==@channel_id )
-      #only will be treated on the first extended channel in case more than one channel extended on DEST channel
-      text = get_help(rules_file, dest, user.name, typem==:on_extended)
-
-      ff = text.scan(/\s*`\s*([^`]+)\s*`\s*/i).flatten
-      ff.delete("!THE_COMMAND")
-      ff.delete("@NAME_OF_BOT THE_COMMAND")
-      ff.delete("NAME_OF_BOT THE_COMMAND")
-      ff.delete("@BOT_NAME on #CHANNEL_NAME COMMAND")
-
-      ff2 = {}
-      acommand = command.split(/\s+/)
-      ff.each do |f|
-        ff2[f] = ""
-        af = f.split(/\s+/)
-        af.each_with_index do |word, i|
-          if acommand.size >= (i - 1) and word.match?(/[A-Z_\-#@]+/)
-            ff2[f] += "#{acommand[i]} "
-          else
-            ff2[f] += "#{word} "
-          end
-        end
-        ff2[f].rstrip!
-      end
-
-      spell_checker = DidYouMean::SpellChecker.new(dictionary: ff2.values)
-      res = spell_checker.correct(command).uniq
-      res_final = []
-      res.each do |r|
-        res_final << (ff2.select { |k, v| v == r }).keys
-      end
-      res_final.flatten!
-
-      if typem==:on_extended and @extended_from[@channels_name[dest]][0]==@channel_id 
-        if rules_file == config.rules_file
-          respond "#{user.profile.display_name}, I don't understand.", dest
-        end
-        if @extended_from[@channels_name[dest]].size > 1 and rules_file == config.rules_file
-          @extended_from[@channels_name[dest]][1..-1].each do |ch|
-            rf = @bots_created[ch].rules_file
-            dont_understand(rf, command, nil, dest, answer, channel_rules: @channels_name[ch], typem: typem)
-          end
-        end
-        unless res_final.empty?
-          respond "Similar rules on : *#{channel_rules}*\n`#{res_final[0..4].join("`\n`")}`", dest
-        end
-      elsif typem!=:on_extended
-        message = ''
-        message = "\nTake in consideration when on external calls, not all the commands are availalbe." if typem==:on_call
-        if res_final.empty?
-          resp = answer.sample
-          respond "#{user.profile.display_name}, #{resp}#{message}", dest
-        else
-          respond "#{user.profile.display_name}, I don't understand. Maybe you are trying to say:\n`#{res_final[0..4].join("`\n`")}`#{message}", dest
-        end
-      end
-    end
-  end
-end
+require_relative 'comm/ask'
+require_relative 'comm/dont_understand'
+require_relative 'comm/respond_direct'
+require_relative 'comm/respond'
+require_relative 'comm/send_file'
+require_relative 'comm/send_msg_channel'
+require_relative 'comm/send_msg_user'

data/lib/slack/smart-bot/comm/ask.rb

@@ -0,0 +1,48 @@
+class SlackSmartBot
+
+  #context: previous message
+  #to: user that should answer
+  def ask(question, context = nil, to = nil, dest = nil)
+    if dest.nil? and Thread.current.key?(:dest)
+      dest = Thread.current[:dest]
+    end
+    if to.nil?
+      to = Thread.current[:user].name
+    end
+    if context.nil?
+      context = Thread.current[:command]
+    end
+    message = "#{to}: #{question}"
+    if dest.nil?
+      if config[:simulate]
+        open("#{config.path}/buffer_complete.log", "a") { |f|
+          f.puts "|#{@channel_id}|#{config[:nick_id]}|#{message}~~~"
+        }
+      else  
+        client.message(channel: @channel_id, text: message, as_user: true)
+      end
+      if config[:testing] and config.on_master_bot
+        open("#{config.path}/buffer.log", "a") { |f|
+          f.puts "|#{@channel_id}|#{config[:nick_id]}|#{message}"
+        }
+      end
+    elsif dest[0] == "C" or dest[0] == "G" # channel
+      if config[:simulate]
+        open("#{config.path}/buffer_complete.log", "a") { |f|
+          f.puts "|#{dest}|#{config[:nick_id]}|#{message}~~~"
+        }
+      else  
+        client.message(channel: dest, text: message, as_user: true)
+      end
+      if config[:testing] and config.on_master_bot
+        open("#{config.path}/buffer.log", "a") { |f|
+          f.puts "|#{dest}|#{config[:nick_id]}|#{message}"
+        }
+      end
+    elsif dest[0] == "D" #private message
+      send_msg_user(dest, message)
+    end
+    @questions[to] = context
+  end
+
+end

data/lib/slack/smart-bot/comm/dont_understand.rb

@@ -0,0 +1,61 @@
+class SlackSmartBot
+
+  def dont_understand(rules_file = nil, command = nil, user = nil, dest = nil, answer = ["what?", "huh?", "sorry?", "what do you mean?", "I don't understand"], channel_rules: config.channel, typem: nil)
+    command = Thread.current[:command] if command.nil?
+    user = Thread.current[:user] if user.nil?
+    dest = Thread.current[:dest] if dest.nil?
+    rules_file = Thread.current[:rules_file] if rules_file.nil?
+    typem = Thread.current[:typem] if typem.nil?
+    if typem==:on_extended
+      get_bots_created()
+    end
+    text = get_help(rules_file, dest, user.name, typem==:on_extended)
+
+    ff = text.scan(/\s*`\s*([^`]+)\s*`\s*/i).flatten
+    ff.delete("!THE_COMMAND")
+    ff.delete("@NAME_OF_BOT THE_COMMAND")
+    ff.delete("NAME_OF_BOT THE_COMMAND")
+    ff.delete("@BOT_NAME on #CHANNEL_NAME COMMAND")
+
+    ff2 = {}
+    acommand = command.split(/\s+/)
+    ff.each do |f|
+      ff2[f] = ""
+      af = f.split(/\s+/)
+      af.each_with_index do |word, i|
+        if acommand.size >= (i - 1) and word.match?(/[A-Z_\-#@]+/)
+          ff2[f] += "#{acommand[i]} "
+        else
+          ff2[f] += "#{word} "
+        end
+      end
+      ff2[f].rstrip!
+    end
+
+    spell_checker = DidYouMean::SpellChecker.new(dictionary: ff2.values)
+    res = spell_checker.correct(command).uniq
+    res_final = []
+    res.each do |r|
+      res_final << (ff2.select { |k, v| v == r }).keys
+    end
+    res_final.flatten!
+
+    if typem==:on_extended
+      if @extended_from[@channels_name[dest]].size == 1
+        respond "#{user.profile.display_name}, I don't understand.", dest
+      end
+      unless res_final.empty?
+        respond "Similar rules on : *#{channel_rules}*\n`#{res_final[0..4].join("`\n`")}`", dest
+      end
+    else
+      message = ''
+      message = "\nTake in consideration when on external calls, not all the commands are availalbe." if typem==:on_call
+      if res_final.empty?
+        resp = answer.sample
+        respond "#{user.profile.display_name}, #{resp}#{message}", dest
+      else
+        respond "#{user.profile.display_name}, I don't understand. Maybe you are trying to say:\n`#{res_final[0..4].join("`\n`")}`#{message}", dest
+      end
+    end
+  end
+end

data/lib/slack/smart-bot/comm/respond.rb

@@ -0,0 +1,51 @@
+class SlackSmartBot
+  def respond(msg, dest = nil)
+    if dest.nil? and Thread.current.key?(:dest)
+      dest = Thread.current[:dest]
+    end
+    dest = @channels_id[dest] if @channels_id.key?(dest) #it is a name of channel
+    if dest.nil?
+      if config[:simulate]
+        open("#{config.path}/buffer_complete.log", "a") { |f|
+          f.puts "|#{@channel_id}|#{config[:nick_id]}|#{msg}~~~"
+        }
+      else  
+        client.message(channel: @channel_id, text: msg, as_user: true)
+      end
+      if config[:testing] and config.on_master_bot
+        open("#{config.path}/buffer.log", "a") { |f|
+          f.puts "|#{@channel_id}|#{config[:nick_id]}|#{msg}"
+        }
+      end
+    elsif dest[0] == "C" or dest[0] == "G" # channel
+      if config[:simulate]
+        open("#{config.path}/buffer_complete.log", "a") { |f|
+        f.puts "|#{dest}|#{config[:nick_id]}|#{msg}~~~"
+      }
+      else  
+        client.message(channel: dest, text: msg, as_user: true)
+      end
+      if config[:testing] and config.on_master_bot
+        open("#{config.path}/buffer.log", "a") { |f|
+          f.puts "|#{dest}|#{config[:nick_id]}|#{msg}"
+        }
+      end
+    elsif dest[0] == "D" or dest[0] == "U" # Direct message
+      send_msg_user(dest, msg)
+    elsif dest[0] == "@"
+      begin
+        user_info = client.web_client.users_info(user: dest)
+        send_msg_user(user_info.user.id, msg)
+      rescue Exception => stack
+        @logger.warn("user #{dest} not found.")
+        @logger.warn stack
+        if Thread.current.key?(:dest)
+          respond("User #{dest} not found.")
+        end
+      end
+    else
+      @logger.warn("method respond not treated correctly: msg:#{msg} dest:#{dest}")
+    end
+  end
+
+end