slack-smart-bot 1.8.2 → 1.9.1

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

@@ -13,4 +13,6 @@ 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'
 

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

@@ -0,0 +1,18 @@
+class SlackSmartBot
+    def answer(from = Thread.current[:user].name, dest = Thread.current[:dest])
+        if @answer.key?(from)
+            if Thread.current[:on_thread]
+                dest = Thread.current[:thread_ts]
+            end
+            if @answer[from].key?(dest)
+                return @answer[from][dest]
+            else
+                return ''
+            end
+        else
+            return ''
+        end
+    end
+  
+  end
+  

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

@@ -0,0 +1,15 @@
+class SlackSmartBot
+    def answer_delete(from = Thread.current[:user].name, dest = Thread.current[:dest])
+        if @answer.key?(from)
+            if Thread.current[:on_thread]
+                dest = Thread.current[:thread_ts]
+            end
+            if @answer[from].key?(dest)
+                @answer[from].delete(dest)
+            end
+            @questions.delete(from) # to be backwards compatible #todo: remove when 2.0
+        end
+    end
+  
+  end
+  

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

@@ -1,12 +1,64 @@
 class SlackSmartBot
 
-  def build_help(path)
-    help_message = {}
-    Dir["#{path}/*"].each do |t|
+  def build_help(path, expanded)
+    help_message = {normal: {}, admin: {}, master: {}}
+    if Dir.exist?(path)
+      files = Dir["#{path}/*"]
+    elsif File.exist?(path)
+      files = [path]
+    else
+      return help_message
+    end
+
+    files.each do |t|
       if Dir.exist?(t)
-        help_message[t.scan(/\/(\w+)$/).join.to_sym] = build_help(t)
+        res = build_help(t, expanded)
+        help_message[:master][t.scan(/\/(\w+)$/).join.to_sym] = res[:master]
+        help_message[:admin][t.scan(/\/(\w+)$/).join.to_sym] = res[:admin]
+        help_message[:normal][t.scan(/\/(\w+)$/).join.to_sym] = res[:normal]
       else
-        help_message[t.scan(/\/(\w+)\.rb$/).join.to_sym] = IO.readlines(t).join.scan(/#\s*help\s*\w*:(.*)/).join("\n")
+        lines = IO.readlines(t)
+        data = {master:{}, admin:{}, normal:{}}
+        data.master = lines.join #normal user help
+        data.admin = lines.reject {|l| l.match?(/^\s*#\s*help\s*master\s*:.+$/i)}.join #not master help
+        data.normal = lines.reject {|l| l.match?(/^\s*#\s*help\s*(admin|master)\s*:.+$/i)}.join #not admin or master help
+        if expanded
+          help_message[:master][t.scan(/\/(\w+)\.rb$/).join.to_sym] = data.master.scan(/#\s*help\s*\w*:(.*)/i).join("\n")
+          help_message[:admin][t.scan(/\/(\w+)\.rb$/).join.to_sym] = data.admin.scan(/#\s*help\s*\w*:(.*)/i).join("\n")
+          help_message[:normal][t.scan(/\/(\w+)\.rb$/).join.to_sym] = data.normal.scan(/#\s*help\s*\w*:(.*)/i).join("\n") 
+        else
+          data.keys.each do |key|
+            res = data[key].scan(/#\s*help\s*\w*:(.*)/i).join("\n")
+            resf = ""
+            command_done = false
+            explanation_done = false
+            example_done = false
+            
+            res.split("\n").each do |line|
+              if line.match?(/^\s*======+$/)
+                command_done = true
+                explanation_done = true
+                example_done = true
+              elsif line.match?(/^\s*\-\-\-\-+\s*$/i)
+                resf += "\n#{line}"
+                command_done = false
+                explanation_done = false
+                example_done = false
+              elsif !command_done and line.match?(/^\s*`.+`\s*/i)
+                resf += "\n#{line}"
+                command_done = true
+              elsif !explanation_done and line.match?(/^\s+[^`].+\s*/i)
+                resf += "\n#{line}"
+                explanation_done = true
+              elsif !example_done and line.match?(/^\s*_.+_\s*/i)
+                resf += "\n     Example: #{line}"
+                example_done = true
+              end
+            end
+            resf += "\n\n"
+            help_message[key][t.scan(/\/(\w+)\.rb$/).join.to_sym] = resf
+          end
+        end
       end
     end
     return help_message

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

@@ -19,7 +19,15 @@ class SlackSmartBot
             if @routines[@channel_id][name][:file_path] != ""
               process_to_run = "#{ruby}#{Dir.pwd}#{@routines[@channel_id][name][:file_path][1..-1]}"
               process_to_run = ("cd #{project_folder} &&" + process_to_run) if defined?(project_folder)
-
+              data = {
+                dest: @routines[@channel_id][name][:dest],
+                typem: 'routine_file',
+                user: {id: @routines[@channel_id][name][:creator_id], name: @routines[@channel_id][name][:creator]},
+                files: false,
+                command: @routines[@channel_id][name][:file_path],
+                routine: true
+              }            
+              save_stats(name, data: data)
               stdout, stderr, status = Open3.capture3(process_to_run)
               if !@routines[@channel_id][name][:silent] or (@routines[@channel_id][name][:silent] and 
                 (!stderr.match?(/\A\s*\z/) or !stdout.match?(/\A\s*\z/)))
@@ -49,7 +57,8 @@ class SlackSmartBot
                 dest: @routines[@channel_id][name][:dest],
                 user: @routines[@channel_id][name][:creator_id],
                 text: @routines[@channel_id][name][:command],
-                files: nil }
+                files: nil,
+                routine: true }
               treat_message(data)
             end
             # in case the routine was deleted while running the process

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

@@ -1,13 +1,7 @@
 class SlackSmartBot
 
   def get_channels_name_and_id
-    #todo: add pagination for case more than 1000 channels on the workspace
-    channels = client.web_client.conversations_list(
-      types: "private_channel,public_channel",
-      limit: "1000",
-      exclude_archived: "true",
-    ).channels
-
+    channels = get_channels()
     @channels_id = Hash.new()
     @channels_name = Hash.new()
     channels.each do |ch|

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

@@ -1,18 +1,17 @@
 class SlackSmartBot
-  def get_help(rules_file, dest, from, only_rules = false)
+  def get_help(rules_file, dest, from, only_rules, expanded)
     order = {
-      general: [:hi_bot, :bye_bot, :bot_help, :bot_status, :use_rules, :stop_using_rules],
+      general: [:whats_new, :hi_bot, :bye_bot, :bot_help, :bot_status, :use_rules, :stop_using_rules, :bot_stats],
       on_bot: [:ruby_code, :repl, :get_repl, :run_repl, :delete_repl, :see_repls, :add_shortcut, :delete_shortcut, :see_shortcuts],
       on_bot_admin: [:extend_rules, :stop_using_rules_on, :start_bot, :pause_bot, :add_routine,
         :see_routines, :start_routine, :pause_routine, :remove_routine, :run_routine]
     }
-    # user_type: :admin, :user, :admin_master
     if config.masters.include?(from)
-      user_type = :admin_master
+      user_type = :master # master admin
     elsif config.admins.include?(from)
       user_type = :admin
     else
-      user_type = :user
+      user_type = :normal #normal user
     end
     # channel_type: :bot, :master_bot, :direct, :extended, :external
     if dest[0] == "D"
@@ -25,27 +24,45 @@ class SlackSmartBot
       channel_type = :bot
     end
 
-    @help_messages ||= build_help("#{__dir__}/../commands")
+    @help_messages_expanded ||= build_help("#{__dir__}/../commands", true)
+    @help_messages_not_expanded ||= build_help("#{__dir__}/../commands", false)
     if only_rules
       help = {}
+    elsif expanded
+      help = @help_messages_expanded.deep_copy[user_type]
     else
-      help = @help_messages.deep_copy
+      help = @help_messages_not_expanded.deep_copy[user_type]
     end
+
     if rules_file != ""
-      help[:rules_file] = ''
-      help[:rules_file] += IO.readlines(config.path+rules_file).join.scan(/#\s*help\s*\w*:(.*)/i).join("\n") + "\n"
-      if File.exist?(config.path+'/rules/general_rules.rb')
-        help[:rules_file] += IO.readlines(config.path+'/rules/general_rules.rb').join.scan(/#\s*help\s*\w*:(.*)/i).join("\n")
+      help[:rules_file] = build_help(config.path+rules_file, expanded)[user_type].values.join("\n") + "\n"
+     
+      # to get all the help from other rules files added to the main rules file by using require or load. For example general_rules.rb
+      res = IO.readlines(config.path+rules_file).join.scan(/$\s*(load|require)\s("|')(.+)("|')/)
+      rules_help = []
+      txt = ''
+      if res.size>0
+        res.each do |r|
+          begin
+            eval("txt = \"#{r[2]}\"")
+            rules_help << txt if File.exist?(txt)
+          rescue
+          end
+        end
+      end
+      rules_help.each do |rh|
+        rhelp = build_help(rh, expanded)
+        help[:rules_file] += rhelp[user_type].values.join("\n") + "\n"
       end
     end
-    help = remove_hash_keys(help, :admin_master) unless user_type == :admin_master
-    help = remove_hash_keys(help, :admin) unless user_type == :admin or user_type == :admin_master
+    help = remove_hash_keys(help, :admin_master) unless user_type == :master
+    help = remove_hash_keys(help, :admin) unless user_type == :admin or user_type == :master
     help = remove_hash_keys(help, :on_master) unless channel_type == :master_bot
     help = remove_hash_keys(help, :on_extended) unless channel_type == :extended
     help = remove_hash_keys(help, :on_dm) unless channel_type == :direct
     txt = ""
 
-    if channel_type == :bot or channel_type == :master_bot
+    if (channel_type == :bot or channel_type == :master_bot) and expanded
       txt += "===================================
       For the Smart Bot start listening to you say *hi bot*
       To run a command on demand even when the Smart Bot is not listening to you:
@@ -56,11 +73,11 @@ class SlackSmartBot
             *^THE_COMMAND*
             *!!THE_COMMAND*\n"
     end
-    if channel_type == :direct
+    if channel_type == :direct and expanded
       txt += "===================================
       When on a private conversation with the Smart Bot, I'm always listening to you.\n"
     end
-    unless channel_type == :master_bot or channel_type == :extended
+    unless channel_type == :master_bot or channel_type == :extended or !expanded
       txt += "===================================
       *Commands from Channels without a bot:*
       ----------------------------------------------
@@ -121,7 +138,7 @@ class SlackSmartBot
 
     if help.key?(:on_master) and help.on_master.key?(:admin_master) and help.on_master.admin_master.size > 0
       txt += "===================================
-      *Master Admin commands:*\n"
+      *Master Admin commands:*\n" unless txt.include?('*Master Admin commands*')
       help.on_master.admin_master.each do |k, v|
         txt += v if v.is_a?(String)
       end
@@ -133,6 +150,51 @@ class SlackSmartBot
         @logger.info help.rules_file if config.testing
         help.rules_file = help.rules_file.gsub(/^\s*\*These are specific commands.+NAME_OF_BOT THE_COMMAND`\s*$/im, "")
       end
+
+      unless expanded
+        resf = ''
+        help.rules_file.split(/^\s*\-+\s*$/).each do |rule|
+          command_done = false
+          explanation_done = false
+          example_done = false
+          if rule.match?(/These are specific commands for this/i)
+            resf += rule
+            resf += "-"*50
+            resf += "\n"
+          elsif rule.match?(/To run a command on demand and add the respond on a thread/i)
+            resf += rule
+            resf += "-"*50
+            resf += "\n"
+          else
+            rule.split("\n").each do |line|
+              if line.match?(/^\s*\-+\s*/i)
+                resf += line
+              elsif !command_done and line.match?(/^\s*`.+`\s*/i)
+                resf += "\n#{line}"
+                command_done = true
+              elsif !explanation_done and line.match?(/^\s+[^`].+\s*/i)
+                resf += "\n#{line}"
+                explanation_done = true
+              elsif !example_done and line.match?(/^\s*_.+_\s*/i)
+                resf += "\n     Example: #{line}"
+                example_done = true
+              end
+            end
+            resf += "\n\n"
+          end
+        end
+        unless resf.match?(/These are specific commands for this bot on this Channel/i)
+          if resf.match?(/\A\s*[=\-]+$/)
+            pre = ''
+            post = ''
+          else
+            pre = ('='*50) + "\n"
+            post = ('-'*50) + "\n"
+          end
+          resf = "#{pre}*These are specific commands for this bot on this Channel:*\n#{post}" + resf
+        end
+        help.rules_file = resf
+      end
       txt += help.rules_file
     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,31 @@ 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
 
+              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/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/whats_new.txt

@@ -0,0 +1,18 @@
+*Version 1.9.1* Released 2021-Mar-18
+
+*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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack-smart-bot
 version: !ruby/object:Gem::Version
-  version: 1.8.2
+  version: 1.9.1
 platform: ruby
 authors:
 - Mario Ruiz
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-16 00:00:00.000000000 Z
+date: 2021-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: slack-ruby-client
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '0.17'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.15.1
+        version: 0.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '0.17'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.15.1
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
   name: nice_http
   requirement: !ruby/object:Gem::Requirement
@@ -81,7 +81,7 @@ dependencies:
         version: '1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: 1.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -91,7 +91,7 @@ dependencies:
         version: '1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -130,6 +130,10 @@ files:
 - lib/slack/smart-bot/comm.rb
 - lib/slack/smart-bot/comm/ask.rb
 - lib/slack/smart-bot/comm/dont_understand.rb
+- lib/slack/smart-bot/comm/event_hello.rb
+- lib/slack/smart-bot/comm/get_channel_members.rb
+- lib/slack/smart-bot/comm/get_channels.rb
+- lib/slack/smart-bot/comm/get_user_info.rb
 - lib/slack/smart-bot/comm/react.rb
 - lib/slack/smart-bot/comm/respond.rb
 - lib/slack/smart-bot/comm/respond_direct.rb
@@ -139,11 +143,13 @@ files:
 - lib/slack/smart-bot/comm/unreact.rb
 - lib/slack/smart-bot/commands.rb
 - lib/slack/smart-bot/commands/general/bot_help.rb
+- lib/slack/smart-bot/commands/general/bot_stats.rb
 - lib/slack/smart-bot/commands/general/bot_status.rb
 - lib/slack/smart-bot/commands/general/bye_bot.rb
 - lib/slack/smart-bot/commands/general/hi_bot.rb
 - lib/slack/smart-bot/commands/general/stop_using_rules.rb
 - lib/slack/smart-bot/commands/general/use_rules.rb
+- lib/slack/smart-bot/commands/general/whats_new.rb
 - lib/slack/smart-bot/commands/on_bot/add_shortcut.rb
 - lib/slack/smart-bot/commands/on_bot/admin/add_routine.rb
 - lib/slack/smart-bot/commands/on_bot/admin/extend_rules.rb
@@ -155,7 +161,6 @@ files:
 - lib/slack/smart-bot/commands/on_bot/admin/start_bot.rb
 - lib/slack/smart-bot/commands/on_bot/admin/start_routine.rb
 - lib/slack/smart-bot/commands/on_bot/admin/stop_using_rules_on.rb
-- lib/slack/smart-bot/commands/on_bot/admin_master/bot_stats.rb
 - lib/slack/smart-bot/commands/on_bot/admin_master/get_bot_logs.rb
 - lib/slack/smart-bot/commands/on_bot/delete_repl.rb
 - lib/slack/smart-bot/commands/on_bot/delete_shortcut.rb
@@ -169,12 +174,15 @@ files:
 - lib/slack/smart-bot/commands/on_master/admin/kill_bot_on_channel.rb
 - lib/slack/smart-bot/commands/on_master/admin_master/exit_bot.rb
 - lib/slack/smart-bot/commands/on_master/admin_master/notify_message.rb
+- lib/slack/smart-bot/commands/on_master/admin_master/set_maintenance.rb
 - lib/slack/smart-bot/commands/on_master/create_bot.rb
 - lib/slack/smart-bot/listen.rb
 - lib/slack/smart-bot/process.rb
 - lib/slack/smart-bot/process_first.rb
 - lib/slack/smart-bot/treat_message.rb
 - lib/slack/smart-bot/utils.rb
+- lib/slack/smart-bot/utils/answer.rb
+- lib/slack/smart-bot/utils/answer_delete.rb
 - lib/slack/smart-bot/utils/build_help.rb
 - lib/slack/smart-bot/utils/create_routine_thread.rb
 - lib/slack/smart-bot/utils/get_bots_created.rb
@@ -190,6 +198,7 @@ files:
 - lib/slack/smart-bot/utils/update_routines.rb
 - lib/slack/smart-bot/utils/update_rules_imported.rb
 - lib/slack/smart-bot/utils/update_shortcuts_file.rb
+- whats_new.txt
 homepage: https://github.com/MarioRuiz/slack-smart-bot
 licenses:
 - MIT
@@ -209,8 +218,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Create a Slack bot that is smart and so easy to expand, create new bots on
   demand, run ruby code on chat, create shortcuts...