slack-smart-bot 0.9.6 → 1.0.0

data/lib/slack-smart-bot_rules.rb

@@ -10,28 +10,17 @@ def git_project()
   ""
 end
 
-#for the case of testing, just run this file adding in the end a call to rules with the parameters you want
-if defined?(respond)
-  @testing = false
-else
-  @testing = true
-  @questions = Hash.new()
-
-  def respond(message, dest)
-    puts message
-  end
-
-  #context: previous message
-  #to: user that should answer
-  def ask(question, context, to, dest)
-    puts "Bot: #{question}"
-    @questions[to] = context
-  end
-end
-
-# from: Full name of the person sending the message
+# user: user slack object
 # command: command to run
 # processed: in case the command has been already processed on Bot class, by default false
+# dest: channel_id
+# files: files attached
+# rules_file: rules_file name
+#
+# About the Help:
+#   Add as a comment starting by "help:" the help you need to add to the `bot help` and `bot rules` commands.
+#   The command logic needs to be added with ``, and the parameters to supply need to be in capital for example: `echo SOMETHING`
+#
 # help: ===================================
 # help:
 # help: *These are specific commands for this bot on this Channel.*
@@ -42,18 +31,10 @@ end
 # help:       `@NAME_OF_BOT THE_COMMAND`
 # help:       `NAME_OF_BOT THE_COMMAND`
 # help:
-def rules(user, command, processed, dest, files=[])
+def rules(user, command, processed, dest, files = [], rules_file = "")
   from = user.name
   display_name = user.profile.display_name
 
-  if @testing
-    puts "#{from}: #{command}"
-    if @questions.keys.include?(from)
-      context = @questions[from]
-      @questions[from] = command
-      command = context
-    end
-  end
   begin
     case command
 
@@ -62,7 +43,7 @@ def rules(user, command, processed, dest, files=[])
     # help:     repeats SOMETHING
     # help:
     when /^echo\s(.+)/i
-      respond $1, dest
+      respond $1
 
       # help: ----------------------------------------------
       # help: `go to sleep`
@@ -70,20 +51,20 @@ def rules(user, command, processed, dest, files=[])
       # help:
     when /^go\sto\ssleep/i
       unless @questions.keys.include?(from)
-        ask("do you want me to take a siesta?", command, from, dest)
+        ask "do you want me to take a siesta?"
       else
         case @questions[from]
         when /yes/i, /yep/i, /sure/i
           @questions.delete(from)
-          respond "I'll be sleeping for 5 secs... just for you", dest
-          respond "zZzzzzzZZZZZZzzzzzzz!", dest
+          respond "I'll be sleeping for 5 secs... just for you"
+          respond "zZzzzzzZZZZZZzzzzzzz!"
           sleep 5
         when /no/i, /nope/i, /cancel/i
           @questions.delete(from)
-          respond "Thanks, I'm happy to be awake", dest
+          respond "Thanks, I'm happy to be awake"
         else
-          respond "I don't understand", dest
-          ask("are you sure do you want me to sleep? (yes or no)", "go to sleep", from, dest)
+          respond "I don't understand"
+          ask "are you sure do you want me to sleep? (yes or no)"
         end
       end
 
@@ -92,57 +73,57 @@ def rules(user, command, processed, dest, files=[])
       # help:   It will run the process and report the results when done
       # help:
     when /^run something/i
-      respond "Running", dest
+      respond "Running"
 
       process_to_run = "ruby -v"
       process_to_run = ("cd #{project_folder} &&" + process_to_run) if defined?(project_folder)
       stdout, stderr, status = Open3.capture3(process_to_run)
       if stderr == ""
         if stdout == ""
-          respond "#{display_name}: Nothing returned.", dest
+          respond "#{display_name}: Nothing returned."
         else
-          respond "#{display_name}: #{stdout}", dest
+          respond "#{display_name}: #{stdout}"
         end
       else
-        respond "#{display_name}: #{stderr}", dest
+        respond "#{display_name}: #{stdout} #{stderr}"
       end
 
-    # Example downloading a file from slack  
-    #  if !files.nil? and files.size == 1 and files[0].filetype == 'yaml'
-    #    require 'nice_http'
-    #    http = NiceHttp.new(host: "https://files.slack.com", headers: { "Authorization" => "Bearer #{config[:token]}" })
-    #    http.get(files[0].url_private_download, save_data: './tmp/')
-    #  end
+      # Examples for respond and respond_direct
+      #   # send 'the message' to the channel or direct message where the command was written
+      #   respond "the message"
+      #   # send 'the message' privately as a direct message to the user that sent the command
+      #   respond_direct "the message"
+      #   # send 'the message' to a specific channel name
+      #   respond "the message", 'my_channel'
+      #   # send 'the message' to a specific channel id
+      #   respond "the message", 'CSU34D33'
+      #   # send 'the message' to a specific user as direct message
+      #   respond "the message", '@theuser'
+      #   # send 'the message' to a specific user id as direct message
+      #   respond "the message", 'US3344D3'
+
+      # Example downloading a file from slack
+      #  if !files.nil? and files.size == 1 and files[0].filetype == 'yaml'
+      #    require 'nice_http'
+      #    http = NiceHttp.new(host: "https://files.slack.com", headers: { "Authorization" => "Bearer #{config[:token]}" })
+      #    http.get(files[0].url_private_download, save_data: './tmp/')
+      #  end
+
+      # Examples sending a file to slack:
+      #   send_file(to, msg, filepath, title, format, type = "text")
+      #   send_file(dest, 'the message', "#{project_folder}/temp/logs_ptBI.log", 'title', 'text/plain', "text")
+      #   send_file(dest, 'the message', "#{project_folder}/temp/example.jpeg", 'title', 'image/jpeg', "jpg")
 
-    # Examples sending a file to slack:
-    #   send_file(to, msg, filepath, title, format, type = "text")
-    #   send_file(dest, 'the message', "#{project_folder}/temp/logs_ptBI.log", 'title', 'text/plain', "text")
-    #   send_file(dest, 'the message', "#{project_folder}/temp/example.jpeg", 'title', 'image/jpeg', "jpg")
 
     else
       unless processed
-        if @channel_id == dest or dest[0]=="D" or dest[0] == "G" #not on extended channels
-          resp = %w{ what huh sorry }.sample
-          respond "#{display_name}: #{resp}?", dest
+        if @channel_id == dest or dest[0] == "D" or dest[0] == "G" #not on extended channels
+          dont_understand()
         end
       end
     end
-
   rescue => exception
-    if defined?(@logger)
-      @logger.fatal exception
-      respond "Unexpected error!! Please contact an admin to solve it: <@#{ADMIN_USERS.join('>, <@')}>", dest
-    else
-      puts exception
-    end
+    @logger.fatal exception
+    respond "Unexpected error!! Please contact an admin to solve it: <@#{ADMIN_USERS.join(">, <@")}>"
   end
 end
-
-#for the case of testing just running this file, write the dialogue in here:
-if @testing
-  require "nice_hash"
-  user = { name: "Peter Johnson", id: "Uxxxxxx" }
-
-  rules user, "go to sleep, you look tired", false, nil
-  rules user, "yes", false, nil
-end

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

@@ -0,0 +1,197 @@
+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?
+      client.message(channel: @channel_id, text: msg, as_user: true)
+      if config[:testing] and ON_MASTER_BOT
+        open("./buffer.log", "a") { |f|
+          f.puts "|#{@channel_id}|#{config[:nick_id]}|#{msg}"
+        }
+      end
+    elsif dest[0] == "C" or dest[0] == "G" # channel
+      client.message(channel: dest, text: msg, as_user: true)
+      if config[:testing] and ON_MASTER_BOT
+        open("./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?
+      client.message(channel: @channel_id, text: message, as_user: true)
+      if config[:testing] and ON_MASTER_BOT
+        open("./buffer.log", "a") { |f|
+          f.puts "|#{@channel_id}|#{config[:nick_id]}|#{message}"
+        }
+      end
+    elsif dest[0] == "C" or dest[0] == "G" # channel
+      client.message(channel: dest, text: message, as_user: true)
+      if config[:testing] and ON_MASTER_BOT
+        open("./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
+      client.message(channel: channel_id, text: msg, as_user: true)
+      if config[:testing] and ON_MASTER_BOT
+        open("./buffer.log", "a") { |f|
+          f.puts "|#{to}|#{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"
+        client.message(channel: id_user, as_user: true, text: msg)
+        if config[:testing] and ON_MASTER_BOT
+          open("./buffer.log", "a") { |f|
+            f.puts "|#{id_user}|#{config[:nick_id]}|#{msg}"
+          }
+        end
+      else
+        im = client.web_client.im_open(user: id_user)
+        client.message(channel: im["channel"]["id"], as_user: true, text: msg)
+        if config[:testing] and ON_MASTER_BOT
+          open("./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"])
+    if command.nil?
+      command = Thread.current[:command]
+    end
+    if user.nil?
+      user = Thread.current[:user]
+    end
+    if dest.nil?
+      dest = Thread.current[:dest]
+    end
+    if rules_file.nil?
+      rules_file = Thread.current[:rules_file]
+    end
+
+    if rules_file == ""
+      res_final = []
+    else
+      text = get_help(rules_file, dest, user.name)
+
+      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")
+
+      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!
+    end
+    if res_final.empty?
+      resp = answer.sample
+      respond "#{user.profile.display_name}, #{resp}", dest
+    else
+      respond "#{user.profile.display_name}, I don't understand. Maybe you are trying to say:\n`#{res_final[0..4].join("`\n`")}`", dest
+    end
+  end
+end

data/lib/slack/smart-bot/commands/general/bot_help.rb

@@ -0,0 +1,74 @@
+class SlackSmartBot
+
+  # help: ----------------------------------------------
+  # help: `bot help`
+  # help: `bot help COMMAND`
+  # help: `bot rules`
+  # help: `bot rules COMMAND`
+  # help: `bot what can I do?`
+  # help:    it will display this help
+  # help:    if COMMAND supplied just help for that command
+  # help:    `bot rules` will show only the specific rules for this channel.
+  # help:
+  def bot_help(user, from, dest, dchannel, specific, help_command, rules_file)
+    help_message_rules = ""
+    help_found = false
+
+    message = ""
+
+    help_message = get_help(rules_file, dest, from, specific)
+
+    if help_command.to_s != ""
+      help_message.split(/^\s*-------*$/).each do |h|
+        if h.match?(/[`_]#{help_command}/i)
+          respond h, dest
+          help_found = true
+        end
+      end
+    else
+      if (dest[0] == "C") || (dest[0] == "G") and @rules_imported.key?(user.id) &&
+                                                  @rules_imported[user.id].key?(dchannel) && @bots_created.key?(@rules_imported[user.id][dchannel])
+        message = "*You are using rules from another channel: <##{@rules_imported[user.id][dchannel]}>. These are the specific commands for that channel:*"
+      elsif dest[0] == "D" && @rules_imported.key?(user.id) && @rules_imported[user.id].key?(user.id) and
+            @bots_created.key?(@rules_imported[user.id][user.id])
+        message = "*You are using rules from another channel: <##{@rules_imported[user.id][user.id]}>. These are the specific commands for that channel:*"
+      end
+      respond message, dest
+    end
+
+    if (help_command.to_s == "")
+      help_message.split(/^\s*=========*$/).each do |h|
+        respond("#{"=" * 35}\n#{h}", dest) unless h.match?(/\A\s*\z/)
+      end
+    else
+      unless help_found
+        if specific
+          respond("I didn't find any rule starting by `#{help_command}`", dest)
+        else
+          respond("I didn't find any command starting by `#{help_command}`", dest)
+        end
+      end
+    end
+
+    if specific
+      unless rules_file.empty?
+        begin
+          eval(File.new(rules_file).read) if File.exist?(rules_file)
+        end
+      end
+      if defined?(git_project) && (git_project.to_s != "") && (help_message_rules != "") && (help_command.to_s == "")
+        respond "Git project: #{git_project}", dest
+      else
+        def git_project
+          ""
+        end
+
+        def project_folder
+          ""
+        end
+      end
+    elsif help_command.to_s == ""
+      respond "Slack Smart Bot Github project: https://github.com/MarioRuiz/slack-smart-bot", dest
+    end
+  end
+end