slack-smart-bot 1.9.2 → 1.10.0

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

@@ -24,6 +24,8 @@ class SlackSmartBot
               else
                 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}"

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.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'
@@ -15,4 +16,6 @@ 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

@@ -43,6 +43,9 @@ class SlackSmartBot
     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)
@@ -61,6 +64,8 @@ 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)
@@ -117,6 +122,7 @@ 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}"
 
     unless config.simulate and config.key?(:client)
       Slack.configure do |conf|
@@ -128,10 +134,18 @@ class SlackSmartBot
     while restarts < 200 and !created
       begin
         @logger.info "Connecting #{config_log.inspect}"
+        save_status :off, :connecting, "Connecting #{config_log.inspect}"
         if config.simulate and config.key?(:client)
           self.client = config.client
         else
-          self.client = Slack::RealTime::Client.new(start_method: :rtm_connect)
+          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
@@ -141,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!
@@ -158,6 +174,11 @@ class SlackSmartBot
     @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
@@ -180,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
@@ -191,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()
 
@@ -213,9 +247,11 @@ class SlackSmartBot
       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
 
@@ -231,6 +267,7 @@ class SlackSmartBot
     @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()
@@ -239,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
@@ -250,7 +289,7 @@ 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
@@ -259,12 +298,14 @@ class SlackSmartBot
         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
     self

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

data/lib/slack-smart-bot_general_rules.rb

@@ -13,7 +13,9 @@ def general_rules(user, command, processed, dest, files = [], rules_file = "")
         # help:  Examples:
         # help:     _echo I am the Smart Bot_
         # help:     _100 echo :heart:_
-      when /^(\d*)\s*echo\s(.+)/i
+        # help: command_id: :echo
+        # help:        
+      when /\A\s*(\d*)\s*echo\s(.+)/i
         save_stats :echo
         $1.to_s == '' ? times = 1 : times = $1.to_i
         respond ($2*times).to_s
@@ -25,9 +27,10 @@ def general_rules(user, command, processed, dest, files = [], rules_file = "")
     rescue => exception
       if defined?(@logger)
         @logger.fatal exception
-        respond "Unexpected error!! Please contact an admin to solve it: <@#{ADMIN_USERS.join(">, <@")}>"
+        respond "Unexpected error!! Please contact an admin to solve it: <@#{config.admins.join(">, <@")}>"
       else
         puts exception
       end
+      return false
     end
 end

data/lib/slack-smart-bot_rules.rb

@@ -40,15 +40,18 @@ def rules(user, command, processed, dest, files = [], rules_file = "")
 
   load "#{config.path}/rules/general_rules.rb"
   
-  unless general_rules(user, command, processed, dest, files, rules_file)
+  if general_rules(user, command, processed, dest, files, rules_file)
+    return true
+  else
     begin
       case command
 
         # help: ----------------------------------------------
         # help: `go to sleep`
         # help:   it will sleep the bot for 5 seconds
+        # help: command_id: :go_to_sleep
         # help:
-      when /^go\sto\ssleep/i
+      when /\A\s*go\sto\ssleep/i
         save_stats :go_to_sleep
         if answer.empty?
           ask "do you want me to take a siesta?"
@@ -74,32 +77,41 @@ def rules(user, command, processed, dest, files = [], rules_file = "")
         # help: ----------------------------------------------
         # help: `run something`
         # help:   It will run the process and report the results when done
+        # help: command_id: :run_something
         # help:
-      when /^run something/i
+      when /\Arun something/i
         save_stats :run_something
-        react :runner
+        if has_access?(:run_something, user)
+          react :runner
 
-        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)
-        unreact :runner
-        if stderr == ""
-          if stdout == ""
-            respond "#{display_name}: Nothing returned."
+          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)
+          unreact :runner
+          if stderr == ""
+            if stdout == ""
+              respond "#{display_name}: Nothing returned."
+            else
+              respond "#{display_name}: #{stdout}"
+            end
           else
-            respond "#{display_name}: #{stdout}"
+            respond "#{display_name}: #{stdout} #{stderr}"
           end
-        else
-          respond "#{display_name}: #{stdout} #{stderr}"
         end
         
         # Emoticons you can use with `react` command https://www.webfx.com/tools/emoji-cheat-sheet/
         
-        # Examples for respond and respond_direct
+        # Examples for respond, respond_thread 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"
+        #   # same thing can be done:
+        #   respond "the message", :direct
+        #   # send 'the message' opening a thread
+        #   respond_thread "the message"
+        #   # same thing can be done:
+        #   respond 'the message', :on_thread
         #   # send 'the message' to a specific channel name
         #   respond "the message", 'my_channel'
         #   # send 'the message' to a specific channel id
@@ -109,6 +121,19 @@ def rules(user, command, processed, dest, files = [], rules_file = "")
         #   # send 'the message' to a specific user id as direct message
         #   respond "the message", 'US3344D3'
 
+        # Example sending blocks https://api.slack.com/block-kit
+        # my_blocks = [
+        #   { type: "context",
+        #     elements:
+        #       [
+        #         { type: "plain_text", :text=>"\tInfo: " },
+        #         { type: "image", image_url: "https://avatars.slack-edge.com/2021-03-23/182815_e54abb1dd_24.jpg", alt_text: "mario" },
+        #         { type: "mrkdwn", text: " *Mario Ruiz* (marior)  " }
+        #       ]
+        #   }
+        # ]
+        # respond blocks: my_blocks
+
         # Example downloading a file from slack
         #  if !files.nil? and files.size == 1 and files[0].filetype == 'yaml'
         #    require 'nice_http'
@@ -120,16 +145,17 @@ def rules(user, command, processed, dest, files = [], rules_file = "")
         #   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
           dont_understand()
         end
+        return false
       end
+      return true
     rescue => exception
       @logger.fatal exception
       respond "Unexpected error!! Please contact an admin to solve it: <@#{config.admins.join(">, <@")}>"
+      return false
     end
   end
 end

data/whats_new.txt

@@ -1,24 +1,36 @@
-*Version 1.9.2* Released 2021-Apr-27
+*Version 1.10.0* Released 2021-Sep-17
 
-- Bugfixing and small improvements
-
-------------------------------
+*For General users*
+- When on a private conversation with the SmartBot (DM) and not using any channels rule on the conversation, the general_rules will be available.
+- On DM with the SmartBot if you want to use a rule from a specific channel you can use also: `#CHANNEL RULE` or `on #CHANNEL RULE`. For example: `#sales get report for India` 
+- Now when using general commands, the SmartBot will be responding on any channel where is a member, even though is not listening to you. For example: `clear screen`
+- Added command `suggest command` that will return the help content for a random command.
+- New command `leaderboard` returns useful information about the use of the SmartBot.
+- `add COLOR announcement MESSAGE`, `add EMOJI announcement MESSAGE` command stores the message on the announcement list labeled with the color/emoji specified, white by default. Aliases for announcement: statement, declaration, message. Related: `see announcements`, `delete announcement id`
+- `hi bot` and `bye bot` can be called from any channel where the SmartBot is a member.
+- Added general command `see statuses`, `who is on vacation?`, `who is not on vacation?`
+- New general command `see favorite commands`. It will display the favorite commands in that channel. 
+- Now when running the `ruby` command it can be supplied a code block.
+- New general command `share messages /REGEXP/ on #CHANNEL`, `share messages "TEXT" on #CHANNEL`, `see shares', `delete share ID`. It will automatically share new messages published that meet the specified criteria.
 
-*Version 1.9.0* Released 2021-Mar-18
+*For Admin users*
+- respond_thread method will send the respond creating a thread if necessary. It can be used also `respond 'msg', :on_thread`
+- `respond 'msg', :direct` will send a direct message to the person that is executing the rule.
+- You can add general commands that will be responding on any channel where the Smart Bot is a member even though is not 'listening to you'. Add them to '/rules/general_commands.rb
+- when using `respond` you can supply two options: unfurl_links and unfurl_media. By default is a boolean: true
+- added option 'weekdays' and 'weekends' for `create routine` command, for example: `add silent routine suggestions on weekdays at 09:00 suggest command`
+- Added a new config for the SmartBot to log all RTM communication, admits `true` or `false`, by default `false`: `logrtm`
+- Use the command `send message to` and `react to` to impersonate the SmartBot. Only accessible for Master Admins on a DM with the SmartBot.
+- New command to see the result of the last run of a routine: `see result routine NAME`
+- Now it is possible to create *bgroutine* then the results of the routine run won't be published.
+- To display a general message after every command use: `set general message MESSAGE`. Use `set general message off` to stop displaying it.
+- When adding a general message is possible to use interpolation
+- If you are a master admin and you are on master channel then you can call `publish announcements` that will publish the announcements on all channels. The messages stored on a DM won't be published. This is very convenient to be called from a *Routine* for example every weekday at 09:00.
+- Now it is possible to send blocks `respond blocks: my_blocks`. More info about blocks: https://api.slack.com/block-kit
+- When using bgroutines if we want to avoid a file to be sent: 
+        send_file(dest, 'description', "file_path", 'desc', 'text/plain', "text") unless Thread.current[:routine_type] == 'bgroutine'
+- SmartBot will notify about SmartBot status changes if defined the status_channel in config file and the channel exists. By default: smartbot-status
 
-*For General users*
-- Added command `what's new` that will show this.
-- `bot stats` will return detailed statistics using the SmartBot. If you call it from a DM with the SmartBot you will see all stats for all Bot channels.
-- Possible to create 'global' shortcuts that will be available on any SmartBot Channel.
-- Added option to start a `repl` without pre-executing '.smart-bot-repl' source code in case exists. Just add `clean` before the `repl` command. For example: `clean repl Example`
-- When using `Ruby` command in case the process doesn't finish in 20 seconds will be aborted.
-- When creating rules/commands and asking a question now you can use 'answer' instead of '@questions'. Take a look at README.md for an example.
-- Using external calls, it is possible to send to more than one bot channel the same rule: `@smart-bot on #channel1 #channel2 #channel3 echo Lala`
-- `bot help` and `bot rules` return by default a short version of the commands. Call `bot help expanded` or `bot rules expanded` to get a full desciption of the commands.
-- It is possible to exclude routines from results when using `bot stats`
 ------------------------------
-*For Admin users*
-- `Bot stats` now shows the top 10 users and attaches the full list of users and commands.
-- Bot Stats. Now the routines are displayed as routine/USER
-- When creating routines now it is possible to publish in a different channel: `add routine run_tests at 17:05 #thechannel !run api tests`
-- `Turn maintenance on/off` command available
+
+*Previous*: <https://github.com/MarioRuiz/slack-smart-bot/blob/dd23939f93ee95aca3c04d33cd1ce197d6efbd37/whats_new.txt|1.9.0>