slack-smart-bot 1.8.1 → 1.10.0

data/lib/slack/smart-bot/utils/get_shares.rb

@@ -0,0 +1,12 @@
+class SlackSmartBot
+
+  def get_shares()
+    channel = @channels_name[@channel_id]
+    if File.exist?("#{config.path}/shares/#{channel}.csv")
+      "#{config.path}/shares/#{channel}.csv"
+      t = CSV.table("#{config.path}/shares/#{channel}.csv", headers: ['share_id', 'user_deleted', 'user_created', 'date', 'time', 'type', 'to_channel', 'condition'])
+      t.delete_if {|row| row[:user_deleted] != ''}
+      @shares[channel] = t
+    end
+  end
+end

data/lib/slack/smart-bot/utils/has_access.rb

@@ -0,0 +1,12 @@
+class SlackSmartBot
+    def has_access?(method, user=nil)
+        user = Thread.current[:user] if user.nil?
+        if config[:allow_access].key?(method) and !config[:allow_access][method].include?(user.name) and !config[:allow_access][method].include?(user.id) and 
+            (!user.key?(:enterprise_user) or ( user.key?(:enterprise_user) and !config[:allow_access][method].include?(user[:enterprise_user].id)))
+            respond "You don't have access to use this command, please contact an Admin to be able to use it: <@#{config.admins.join(">, <@")}>"
+            return false
+        else
+            return true
+        end      
+    end
+end

data/lib/slack/smart-bot/utils/save_stats.rb

@@ -1,6 +1,6 @@
 class SlackSmartBot
 
-    def save_stats(method)
+    def save_stats(method, data: {})
         if config.stats
             begin
               require 'csv'
@@ -9,18 +9,33 @@ class SlackSmartBot
                     csv << ['date','bot_channel', 'bot_channel_id', 'dest_channel', 'dest_channel_id', 'type_message', 'user_name', 'user_id', 'text', 'command', 'files']
                 end
               end
-              dest = Thread.current[:dest]
-              typem = Thread.current[:typem]
-              user = Thread.current[:user]
-              files = Thread.current[:files?]
-              if method.to_s == 'ruby_code' and files
+              if data.empty?
+                data = {
+                  dest: Thread.current[:dest],
+                  typem: Thread.current[:typem],
+                  user: Thread.current[:user],
+                  files: Thread.current[:files?],
+                  command: Thread.current[:command],
+                  routine: Thread.current[:routine]
+                }
+              end
+              if method.to_s == 'ruby_code' and data.files
                 command_txt = 'ruby'
               else
-                command_txt = Thread.current[:command]
+                command_txt = data.command
               end
+              command_txt.gsub!(/```.+```/m,'```CODE```')
+              command_txt = "#{command_txt[0..99]}..." if command_txt.size > 100
 
+              if data.routine
+                user_name = "routine/#{data.user.name}"
+                user_id = "routine/#{data.user.id}"
+              else
+                user_name = data.user.name
+                user_id = data.user.id
+              end
               CSV.open("#{config.stats_path}.#{Time.now.strftime("%Y-%m")}.log", "a+") do |csv|
-                csv << [Time.now, config.channel, @channel_id, @channels_name[dest], dest, typem, user.name, user.id, command_txt, method, files]
+                csv << [Time.now, config.channel, @channel_id, @channels_name[data.dest], data.dest, data.typem, user_name, user_id, command_txt, method, data.files]
               end
             rescue Exception => exception
               @logger.fatal "There was a problem on the stats"

data/lib/slack/smart-bot/utils/save_status.rb

@@ -0,0 +1,52 @@
+class SlackSmartBot
+
+    def save_status(status, status_id, message)
+      require 'csv'
+      Dir.mkdir("#{config.path}/status") unless Dir.exist?("#{config.path}/status")
+
+      CSV.open("#{config.path}/status/#{config.channel}_status.csv", "a+") do |csv|
+        csv << [Time.now.strftime("%Y/%m/%d"), Time.now.strftime("%H:%M:%S"), status, status_id, message]
+      end
+      if status_id == :disconnected
+        Thread.new do
+          sleep 50
+          @logger.info "check disconnection 50 scs later #{@last_notified_status_id}"
+          unless @last_notified_status_id == :connected
+            respond ":red_circle: The *SmartBot* on *<##{@channel_id}|#{config.channel}>* is down. An admin will take a look. <@#{config.admins.join(">, <@")}>", config.status_channel
+          end
+        end
+      end
+      if @channels_id.is_a?(Hash) and @channels_id.keys.include?(config.status_channel)
+        is_back = false
+        m = ''
+        if (Time.now-@last_status_change) > 20 or !defined?(@last_notified_status_id)
+          if status_id == :connected
+            if defined?(@last_notified_status_id)
+              m = ":exclamation: :large_green_circle: The *SmartBot* on *<##{@channel_id}|#{config.channel}>* was not available for #{(Time.now-@last_status_change).round(0)} secs. *Now it is up and running again.*" 
+            else
+              m = ":large_green_circle: The *SmartBot* on *<##{@channel_id}|#{config.channel}>* is up and running again." 
+            end
+          end
+        end
+        if status_id == :paused
+          m = ":red_circle: #{message} *<##{@channel_id}|#{config.channel}>*"
+        elsif status_id == :started
+          m = ":large_green_circle: #{message} *<##{@channel_id}|#{config.channel}>*"            
+        elsif status_id == :killed or status_id == :exited
+          m = ":red_circle: #{message}"
+        elsif config.on_master_bot and status_id == :maintenance_on
+          m = ":red_circle: The *SmartBot* is on maintenance so not possible to attend any request."
+        elsif config.on_master_bot and status_id == :maintenance_off
+          m = ":large_green_circle: The *SmartBot* is up and running again."
+        end
+        @last_status_change = Time.now
+        @last_notified_status_id = status_id
+        unless m == ''
+          respond m, config.status_channel
+        end
+      end
+
+
+    end
+
+end  

data/lib/slack/smart-bot/utils/update_shortcuts_file.rb

@@ -3,5 +3,11 @@ class SlackSmartBot
     file = File.open("#{config.path}/shortcuts/#{config.shortcuts_file}", "w")
     file.write @shortcuts.inspect
     file.close
+
+    if config.on_master_bot
+      file = File.open("#{config.path}/shortcuts/shortcuts_global.rb", "w")
+      file.write @shortcuts_global.inspect
+      file.close
+    end
   end
 end

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

@@ -4,6 +4,7 @@ require_relative 'utils/get_bots_created'
 require_relative 'utils/get_channels_name_and_id'
 require_relative 'utils/get_help'
 require_relative 'utils/get_routines'
+require_relative 'utils/get_shares'
 require_relative 'utils/get_rules_imported'
 require_relative 'utils/remove_hash_keys'
 require_relative 'utils/update_bots_file'
@@ -13,4 +14,8 @@ require_relative 'utils/update_shortcuts_file'
 require_relative 'utils/save_stats'
 require_relative 'utils/get_repls'
 require_relative 'utils/update_repls'
+require_relative 'utils/answer'
+require_relative 'utils/answer_delete'
+require_relative 'utils/has_access'
+require_relative 'utils/save_status'
 

data/lib/slack-smart-bot.rb

@@ -41,6 +41,11 @@ class SlackSmartBot
     config[:simulate] = false unless config.key?(:simulate)
     config[:stats] = false unless config.key?(:stats)
     config[:allow_access] = Hash.new unless config.key?(:allow_access)
+    config[:on_maintenance] = false unless config.key?(:on_maintenance)
+    config[:on_maintenance_message] = "Sorry I'm on maintenance so I cannot attend your request." unless config.key?(:on_maintenance_message)
+    config[:general_message] = "" unless config.key?(:general_message)
+    config[:logrtm] = false unless config.key?(:logrtm)
+    config[:status_channel] = 'smartbot-status' unless config.key?(:status_channel)
 
     if config.path.to_s!='' and config.file.to_s==''
       config.file = File.basename($0)
@@ -59,6 +64,9 @@ class SlackSmartBot
     Dir.mkdir("#{config.path}/logs") unless Dir.exist?("#{config.path}/logs")
     Dir.mkdir("#{config.path}/shortcuts") unless Dir.exist?("#{config.path}/shortcuts")
     Dir.mkdir("#{config.path}/routines") unless Dir.exist?("#{config.path}/routines")
+    Dir.mkdir("#{config.path}/announcements") unless Dir.exist?("#{config.path}/announcements")
+    Dir.mkdir("#{config.path}/shares") unless Dir.exist?("#{config.path}/shares")
+    File.delete("#{config.path}/config_tmp.status") if File.exist?("#{config.path}/config_tmp.status")
 
     config.masters = MASTER_USERS if config.masters.to_s=='' and defined?(MASTER_USERS)
     config.master_channel = MASTER_CHANNEL if config.master_channel.to_s=='' and defined?(MASTER_CHANNEL)
@@ -89,7 +97,7 @@ class SlackSmartBot
       config.on_master_bot = false
     end
 
-    if !config.key?(:token) or config.token.to_s == ''
+    if (!config.key?(:token) or config.token.to_s == '') and !config.simulate
       abort "You need to supply a valid token key on the settings. key: :token"
     elsif !config.key?(:masters) or !config.masters.is_a?(Array) or config.masters.size == 0
       abort "You need to supply a masters array on the settings containing the user names of the master admins. key: :masters"
@@ -104,7 +112,8 @@ class SlackSmartBot
     logfile = File.basename(config.rules_file.gsub("_rules_", "_logs_"), ".rb") + ".log"
     config.log_file = logfile
     @logger = Logger.new("#{config.path}/logs/#{logfile}")
-
+    @last_respond = Time.now
+    
     config_log = config.dup
     config_log.delete(:token)
     @logger.info "Initializing bot: #{config_log.inspect}"
@@ -113,16 +122,31 @@ class SlackSmartBot
     File.new("#{config.path}/buffer_complete.log", "w") if config[:simulate] and config.on_master_bot
 
     self.config = config
+    save_status :off, :initializing, "Initializing bot: #{config_log.inspect}"
 
-    Slack.configure do |conf|
-      conf.token = config[:token]
+    unless config.simulate and config.key?(:client)
+      Slack.configure do |conf|
+        conf.token = config[:token]
+      end
     end
     restarts = 0
     created = false
     while restarts < 200 and !created
       begin
         @logger.info "Connecting #{config_log.inspect}"
-        self.client = Slack::RealTime::Client.new(start_method: :rtm_connect)
+        save_status :off, :connecting, "Connecting #{config_log.inspect}"
+        if config.simulate and config.key?(:client)
+          self.client = config.client
+        else
+          if config.logrtm
+            logrtmname = "#{config.path}/logs/rtm_#{config.channel}.log"
+            File.delete(logrtmname) if File.exists?(logrtmname)
+            @logrtm = Logger.new(logrtmname)
+            self.client = Slack::RealTime::Client.new(start_method: :rtm_connect, logger: @logrtm)
+          else
+            self.client = Slack::RealTime::Client.new(start_method: :rtm_connect)
+          end
+        end
         created = true
       rescue Exception => e
         restarts += 1
@@ -131,6 +155,8 @@ class SlackSmartBot
           @logger.fatal "Rescued on creation: #{e.inspect}"
           @logger.info "Waiting 60 seconds to retry. restarts: #{restarts}"
           puts "#{Time.now}: Not able to create client. Waiting 60 seconds to retry: #{config_log.inspect}"
+          save_status :off, :waiting, "Not able to create client. Waiting 60 seconds to retry: #{config_log.inspect}"
+
           sleep 60
         else
           exit!
@@ -143,9 +169,16 @@ class SlackSmartBot
     @bots_created = Hash.new()
     @shortcuts = Hash.new()
     @shortcuts[:all] = Hash.new()
+    @shortcuts_global = Hash.new()
+    @shortcuts_global[:all] = Hash.new()
     @rules_imported = Hash.new()
     @routines = Hash.new()
     @repls = Hash.new()
+    @users = Hash.new()
+    @announcements = Hash.new()
+    @shares = Hash.new()
+    @last_status_change = Time.now
+
 
     if File.exist?("#{config.path}/shortcuts/#{config.shortcuts_file}")
       file_sc = IO.readlines("#{config.path}/shortcuts/#{config.shortcuts_file}").join
@@ -153,6 +186,12 @@ class SlackSmartBot
         @shortcuts = eval(file_sc)
       end
     end
+    if File.exist?("#{config.path}/shortcuts/shortcuts_global.rb")
+      file_sc = IO.readlines("#{config.path}/shortcuts/shortcuts_global.rb").join
+      unless file_sc.to_s() == ""
+        @shortcuts_global = eval(file_sc)
+      end
+    end
 
     get_routines()
     get_repls()
@@ -162,10 +201,17 @@ class SlackSmartBot
       if @bots_created.kind_of?(Hash) and config.start_bots
         @bots_created.each { |key, value|
           if !value.key?(:cloud) or (value.key?(:cloud) and value[:cloud] == false)
-            @logger.info "ruby #{config.file_path} \"#{value[:channel_name]}\" \"#{value[:admins]}\" \"#{value[:rules_file]}\" #{value[:status].to_sym}"
+            if value.key?(:silent) and value.silent!=config.silent
+              silent = value.silent
+            else
+              silent = config.silent
+            end
+            @logger.info "BOT_SILENT=#{silent} ruby #{config.file_path} \"#{value[:channel_name]}\" \"#{value[:admins]}\" \"#{value[:rules_file]}\" #{value[:status].to_sym}"
             puts "Starting #{value[:channel_name]} Smart Bot"
+            save_status :off, :starting, "Starting #{value[:channel_name]} Smart Bot"
+
             t = Thread.new do
-              `ruby #{config.file_path} \"#{value[:channel_name]}\" \"#{value[:admins]}\" \"#{value[:rules_file]}\" #{value[:status].to_sym}`
+              `BOT_SILENT=#{silent} ruby #{config.file_path} \"#{value[:channel_name]}\" \"#{value[:admins]}\" \"#{value[:rules_file]}\" #{value[:status].to_sym}`
             end
             value[:thread] = t
             sleep value[:admins].size
@@ -173,6 +219,12 @@ class SlackSmartBot
         }
       end
     end
+    general_rules_file = "/rules/general_rules.rb"
+    general_commands_file = "/rules/general_commands.rb"
+    default_general_rules = (__FILE__).gsub(/\/slack-smart-bot\.rb$/, "/slack-smart-bot_general_rules.rb")
+    default_general_commands = (__FILE__).gsub(/\/slack-smart-bot\.rb$/, "/slack-smart-bot_general_commands.rb")
+    FileUtils.copy_file(default_general_rules, config.path + general_rules_file) unless File.exist?(config.path + general_rules_file)
+    FileUtils.copy_file(default_general_commands, config.path + general_commands_file) unless File.exist?(config.path + general_commands_file)
 
     get_rules_imported()
 
@@ -181,7 +233,7 @@ class SlackSmartBot
       @admin_users_id = []
       @master_admin_users_id = []
       config.admins.each do |au|
-        user_info = client.web_client.users_info(user: "@#{au}")
+        user_info = get_user_info("@#{au}")
         @admin_users_id << user_info.user.id
         if config.masters.include?(au)
           @master_admin_users_id << user_info.user.id
@@ -189,47 +241,33 @@ class SlackSmartBot
         sleep 1
       end
       (config.masters-config.admins).each do |au|
-        user_info = client.web_client.users_info(user: "@#{au}")
+        user_info = get_user_info("@#{au}")
         @master_admin_users_id << user_info.user.id
         sleep 1
       end
     rescue Slack::Web::Api::Errors::TooManyRequestsError
       @logger.fatal "TooManyRequestsError"
+      save_status :off, :TooManyRequestsError, "TooManyRequestsError please re run the bot and be sure of executing first: killall ruby"
       abort("TooManyRequestsError please re run the bot and be sure of executing first: killall ruby")
     rescue Exception => stack
+      pp stack if config.testing
+      save_status :off, :wrong_admin_user, "The admin user specified on settings: #{config.admins.join(", ")}, doesn't exist on Slack. Execution aborted"
       abort("The admin user specified on settings: #{config.admins.join(", ")}, doesn't exist on Slack. Execution aborted")
     end
 
-    client.on :hello do
-      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 = ""
-      if version_remote != VERSION
-        version_message = ". There is a new available version: #{version_remote}."
-      end
-      if !config[:silent] or ENV['BOT_SILENT'].to_s == 'false'
-        ENV['BOT_SILENT'] = 'true' if config[:silent] == 'true' and ENV['BOT_SILENT'].to_s != 'true'
-        respond "Smart Bot started v#{VERSION}#{version_message}\nIf you want to know what I can do for you: `bot help`.\n`bot rules` if you want to display just the specific rules of this channel.\nYou can talk to me privately if you prefer it."
-      end
-      @routines.each do |ch, rout|
-        rout.each do |k, v|
-          if !v[:running] and v[:channel_name] == config.channel
-            create_routine_thread(k)
-          end
-        end
+    if config.simulate and config.key?(:client)
+      event_hello()
+    else
+      client.on :hello do
+        event_hello()
       end
     end
 
     @status = config.status_init
     @questions = Hash.new()
+    @answer = Hash.new()
     @repl_sessions = Hash.new()
+    @datetime_general_commands = 0
     @channels_id = Hash.new()
     @channels_name = Hash.new()
     get_channels_name_and_id()
@@ -238,6 +276,8 @@ class SlackSmartBot
 
     get_routines()
     get_repls()
+    get_shares()
+
     if @routines.key?(@channel_id)
       @routines[@channel_id].each do |k, v|
         @routines[@channel_id][k][:running] = false
@@ -249,24 +289,25 @@ class SlackSmartBot
       @routines.each do |ch, rout|
         rout.each do |k, v|
           if !v[:running] and v[:channel_name] == config.channel
-            create_routine_thread(k)
+            create_routine_thread(k, v)
           end
         end
       end
+    else
+      client.on :close do |_data|
+        m = "Connection closing, exiting. #{Time.now}"
+        @logger.info m
+        @logger.info _data
+        #save_status :off, :closing, "Connection closing, exiting." #todo: don't notify for the moment, remove when checked
+      end
+  
+      client.on :closed do |_data|
+        m = "Connection has been disconnected. #{Time.now}"
+        @logger.info m
+        @logger.info _data
+        save_status :off, :disconnected, "Connection has been disconnected."
+      end
     end
-
-    client.on :close do |_data|
-      m = "Connection closing, exiting. #{Time.now}"
-      @logger.info m
-      @logger.info _data
-    end
-
-    client.on :closed do |_data|
-      m = "Connection has been disconnected. #{Time.now}"
-      @logger.info m
-      @logger.info _data
-    end
-
     self
   end
 

data/lib/slack-smart-bot_general_commands.rb

@@ -0,0 +1,46 @@
+# add here the general commands you will be using in any channel where The SmartBot is part of. Not necessary to use ! or ^, it will answer directly.
+def general_commands(user, command, dest, files = [])
+    
+  begin
+    case command
+
+        # help: ----------------------------------------------
+        # help: `cls`
+        # help: `clear`
+        # help: `clear screen`
+        # help: `NUMBER cls`
+        # help:     It will send a big empty message.
+        # help:        NUMBER (optional): number of lines. Default 100. Max 200.
+        # help: command_id: :cls
+        # help: 
+    when /\A\s*(\d*)\s*(clear|cls|clear\s+screen)\s*\z/i
+      save_stats :cls
+      $1.to_s == '' ? lines = 100 : lines = $1.to_i
+      lines = 200 if lines > 200
+      respond (">#{"\n"*lines}<")
+
+
+      # this is a hidden command that it is not listed when calling bot help
+    when /\A\s*(that's\s+)?(thanks|thank\s+you|I\s+love\s+you|nice|cool)\s+(#{@salutations.join("|")})\s*!*\s*$/i
+      save_stats :thanks
+      reactions = [:heart, :heart_eyes, :blush, :relaxed, :simple_smile, :smiley, :two_hearts, :heartbeat, :green_heart ]
+      reactions.sample(rand(3)+1).each {|rt| react rt }
+      responses = ['Thank YOU', "You're welcome", "You're very welcome", 'No problem', 'No worries', "Don't mention it", 'My pleasure', 
+        'Anytime', 'It was the least I could do', 'Glad to help', 'Sure', 'Pleasure', 'The pleasure is mine', 'It was nothing', 'Much obliged', "I'm happy to help",
+        'Það var ekkert', 'De nada', 'No hay de qué', 'De rien',  'Bitte', 'Prego', 'मेरा सौभाग्य है', '不客氣', 'Παρακαλώ']
+      respond "#{responses.sample}#{'!'*rand(4)}"
+
+    else
+      return false
+    end
+    return true
+  rescue => exception
+    if defined?(@logger)
+      @logger.fatal exception
+      respond "Unexpected error!! Please contact an admin to solve it: <@#{config.admins.join(">, <@")}>"
+    else
+      puts exception
+    end
+    return false
+  end
+end