slack-smart-bot 1.8.1 → 1.10.0

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*_.+_\s*$/i)
+                resf += "\n     Example: #{line.gsub(/^\s*>/,'')}"
+                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

@@ -1,11 +1,15 @@
 class SlackSmartBot
 
-  def create_routine_thread(name)
+  def create_routine_thread(name, hroutine)
     t = Thread.new do
       while @routines.key?(@channel_id) and @routines[@channel_id].key?(name)
         @routines[@channel_id][name][:thread] = Thread.current
         started = Time.now
         if @status == :on and @routines[@channel_id][name][:status] == :on
+          if !@routines[@channel_id][name].key?(:creator_id) or @routines[@channel_id][name][:creator_id].to_s == ''
+            user_info = @users.select{|u| u.name == @routines[@channel_id][name][:creator]}[-1]
+            @routines[@channel_id][name][:creator_id] = user_info.id unless user_info.nil? or user_info.empty?
+          end
           @logger.info "Routine: #{@routines[@channel_id][name].inspect}"
           if @routines[@channel_id][name][:file_path].match?(/\.rb$/i)
             ruby = "ruby "
@@ -16,45 +20,84 @@ class SlackSmartBot
           if @routines[@channel_id][name][:at] == "" or
              (@routines[@channel_id][name][:at] != "" and @routines[@channel_id][name][:running] and
               @routines[@channel_id][name][:next_run] != "" and Time.now.to_s >= @routines[@channel_id][name][:next_run])
-            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)
-
-              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/)))
-                respond "routine *`#{name}`*: #{@routines[@channel_id][name][:file_path]}", @routines[@channel_id][name][:dest]
-              end
-              if stderr == ""
-                unless stdout.match?(/\A\s*\z/)
-                  respond stdout, @routines[@channel_id][name][:dest]
+              
+            if !@routines[@channel_id][name].key?(:dayweek) or 
+              (@routines[@channel_id][name].key?(:dayweek) and @routines[@channel_id][name][:dayweek].to_s!='weekday' and @routines[@channel_id][name][:dayweek].to_s!='weekend') or
+              (@routines[@channel_id][name].key?(:dayweek) and @routines[@channel_id][name][:dayweek].to_s=='weekday' and Date.today.wday>=1 and Date.today.wday<=5) or
+              (@routines[@channel_id][name].key?(:dayweek) and @routines[@channel_id][name][:dayweek].to_s=='weekend' and (Date.today.wday==6 or Date.today.wday==0)) 
+              File.delete "#{config.path}/routines/#{@channel_id}/#{name}_output.txt" if File.exists?("#{config.path}/routines/#{@channel_id}/#{name}_output.txt")
+              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,
+                  routine_name: name,
+                  routine_type: hroutine[:routine_type]
+                }
+                save_stats(name, data: data)
+                stdout, stderr, status = Open3.capture3(process_to_run)
+                if !@routines[@channel_id][name][:silent]
+                  unless config.on_maintenance
+                    if @routines[@channel_id][name][:dest]!=@channel_id
+                      respond "routine from <##{@channel_id}> *`#{name}`*: #{@routines[@channel_id][name][:file_path]}", @routines[@channel_id][name][:dest]
+                    else
+                      respond "routine *`#{name}`*: #{@routines[@channel_id][name][:file_path]}", @routines[@channel_id][name][:dest]
+                    end
+                  end
                 end
-              else
-                respond "#{stdout} #{stderr}", @routines[@channel_id][name][:dest]
+                if hroutine[:routine_type].to_s!='bgroutine'
+                  if stderr == ""
+                    unless stdout.match?(/\A\s*\z/)
+                      respond stdout, @routines[@channel_id][name][:dest]
+                    end
+                  else
+                    respond "#{stdout} #{stderr}", @routines[@channel_id][name][:dest]
+                  end
+                else
+                  File.write("#{config.path}/routines/#{@channel_id}/#{name}_output.txt", stdout.to_s+stderr.to_s, mode: "a+")
+                end
+              else #command
+                if !@routines[@channel_id][name][:silent] and !config.on_maintenance
+                  if @routines[@channel_id][name][:dest]!=@channel_id
+                    respond "routine from <##{@channel_id}> *`#{name}`*: #{@routines[@channel_id][name][:command]}", @routines[@channel_id][name][:dest]
+                  else
+                    respond "routine *`#{name}`*: #{@routines[@channel_id][name][:command]}", @routines[@channel_id][name][:dest]
+                  end
+                end
+                started = Time.now
+                data = { channel: @channel_id,
+                  dest: @routines[@channel_id][name][:dest],
+                  user: @routines[@channel_id][name][:creator_id],
+                  text: @routines[@channel_id][name][:command],
+                  files: nil,
+                  routine: true,
+                  routine_name: name,
+                  routine_type: hroutine[:routine_type] }
+                treat_message(data)
               end
-            else #command
-              if !@routines[@channel_id][name][:silent]
-                respond "routine *`#{name}`*: #{@routines[@channel_id][name][:command]}", @routines[@channel_id][name][:dest]
+              # in case the routine was deleted while running the process
+              if !@routines.key?(@channel_id) or !@routines[@channel_id].key?(name)
+                Thread.exit
               end
-              started = Time.now
-              data = { channel: @routines[@channel_id][name][:dest],
-                user: @routines[@channel_id][name][:creator_id],
-                text: @routines[@channel_id][name][:command],
-                files: nil }
-              treat_message(data)
-            end
-            # in case the routine was deleted while running the process
-            if !@routines.key?(@channel_id) or !@routines[@channel_id].key?(name)
-              Thread.exit
+              @routines[@channel_id][name][:last_run] = started.to_s
+            elsif (@routines[@channel_id][name].key?(:dayweek) and @routines[@channel_id][name][:dayweek].to_s=='weekday' and (Date.today.wday==6 or Date.today.wday==0)) or
+              (@routines[@channel_id][name].key?(:dayweek) and @routines[@channel_id][name][:dayweek].to_s=='weekend' and Date.today.wday>=1 and Date.today.wday<=5) 
+              @routines[@channel_id][name][:last_run] = started.to_s
             end
-            @routines[@channel_id][name][:last_run] = started.to_s
           end
           if @routines[@channel_id][name][:last_run] == "" and @routines[@channel_id][name][:next_run] != "" #for the first create_routine of one routine with at
             elapsed = 0
             require "time"
             every_in_seconds = Time.parse(@routines[@channel_id][name][:next_run]) - Time.now
           elsif @routines[@channel_id][name][:at] != "" #coming from start after pause for 'at'
-            if @routines[@channel_id][name].key?(:dayweek) and @routines[@channel_id][name][:dayweek].to_s!=''
+            if @routines[@channel_id][name].key?(:dayweek) and @routines[@channel_id][name][:dayweek].to_s!=''and 
+              @routines[@channel_id][name][:dayweek].to_s!='weekend' and @routines[@channel_id][name][:dayweek].to_s!='weekday'
+              
               day = @routines[@channel_id][name][:dayweek]
               days = ['sunday','monday','tuesday','wednesday','thursday','friday','saturday']
               incr = days.index(day) - Time.now.wday
@@ -65,6 +108,16 @@ class SlackSmartBot
               end
               days = incr/(24*60*60)
               weekly = true
+            elsif @routines[@channel_id][name].key?(:dayweek) and @routines[@channel_id][name][:dayweek].to_s!='' and 
+              @routines[@channel_id][name][:dayweek].to_s=='weekend'
+              
+              weekly = false
+              days = 0
+            elsif @routines[@channel_id][name].key?(:dayweek) and @routines[@channel_id][name][:dayweek].to_s!='' and 
+              @routines[@channel_id][name][:dayweek].to_s=='weekday'
+              
+              weekly = false
+              days = 0
             else
               days = 0
               weekly = false

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

@@ -1,7 +1,9 @@
 class SlackSmartBot
   def get_bots_created
     if File.exist?(config.file_path.gsub(".rb", "_bots.rb"))
+      
       if !defined?(@datetime_bots_created) or @datetime_bots_created != File.mtime(config.file_path.gsub(".rb", "_bots.rb"))
+    
         file_conf = IO.readlines(config.file_path.gsub(".rb", "_bots.rb")).join
         if file_conf.to_s() == ""
           @bots_created = {}
@@ -16,8 +18,9 @@ class SlackSmartBot
             @extended_from[ch] = [] unless @extended_from.key?(ch)
             @extended_from[ch] << k
           end
+          v[:rules_file] ||= ''
           v[:rules_file].gsub!(/^\./, '')
-        end
+        end            
       end
     end
   end

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,19 +1,19 @@
 class SlackSmartBot
-  def get_help(rules_file, dest, from, only_rules = false)
+  def get_help(rules_file, dest, from, only_rules, expanded, descriptions: true, only_normal_user: false)
     order = {
-      general: [:hi_bot, :bye_bot, :bot_help, :bot_status, :use_rules, :stop_using_rules],
+      general: [:whats_new, :hi_bot, :bye_bot, :bot_help, :suggest_command, :bot_status, :use_rules, :stop_using_rules, :bot_stats, :leaderboard],
       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]
+        :see_routines, :start_routine, :pause_routine, :remove_routine, :see_result_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"
       channel_type = :direct
@@ -25,27 +25,58 @@ class SlackSmartBot
       channel_type = :bot
     end
 
-    @help_messages ||= build_help("#{__dir__}/../commands")
+    if Thread.current[:typem] == :on_pg or Thread.current[:typem] == :on_pub
+      channel_type = :external
+    end
+
+    if only_normal_user
+      user_type = :normal 
+      channel_type = :bot
+    end
+
+    @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[:general_commands_file] = build_help("#{__dir__}/../commands/general_bot_commands.rb", expanded)[user_type].values.join("\n") + "\n" unless only_rules
+    if File.exists?(config.path + '/rules/general_commands.rb') and !only_rules
+      help[:general_commands_file] += build_help(config.path+'/rules/general_commands.rb', expanded)[user_type].values.join("\n") + "\n"
     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 and descriptions
       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 +87,11 @@ class SlackSmartBot
             *^THE_COMMAND*
             *!!THE_COMMAND*\n"
     end
-    if channel_type == :direct
+    if channel_type == :direct and expanded and descriptions
       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 or !descriptions
       txt += "===================================
       *Commands from Channels without a bot:*
       ----------------------------------------------
@@ -69,16 +100,22 @@ class SlackSmartBot
         It will run the supplied command using the rules on the channel supplied.
         You need to join the specified channel to be able to use those rules.
         Also you can use this command to call another bot from a channel with a running bot.
-
+      \n"
+      txt +="
       The commands you will be able to use from a channel without a bot: 
       *bot rules*, *ruby CODE*, *add shortcut NAME: COMMAND*, *delete shortcut NAME*, *see shortcuts*, *shortcut NAME*
       *And all the specific rules of the Channel*\n"
     end
 
-    if help.key?(:general)
-      unless channel_type == :direct
-        txt += "===================================
-        *General commands even when the Smart Bot is not listening to you:*\n"
+    if help.key?(:general) and channel_type != :external and channel_type != :extended
+      if descriptions
+        if channel_type == :direct
+          txt += "===================================
+          *General commands:*\n"
+        else
+          txt += "===================================
+          *General commands even when the Smart Bot is not listening to you:*\n"
+        end
       end
       order.general.each do |o|
         txt += help.general[o]
@@ -88,19 +125,29 @@ class SlackSmartBot
       end
     end
 
-    if help.key?(:on_bot)
-      unless channel_type == :direct
-        txt += "===================================
-        *General commands only when the Smart Bot is listening to you or on demand:*\n"
+    if help.key?(:general_commands_file)
+      txt += "===================================
+        *General commands on any channel where the Smart Bot is a member:*\n" if descriptions
+      txt += help.general_commands_file
+    end
+
+    if help.key?(:on_bot) and channel_type != :external and channel_type != :extended
+      if descriptions
+        if channel_type == :direct
+          txt += "===================================
+          *General commands on bot, DM or on external call on demand:*\n"
+        else
+          txt += "===================================
+          *General commands only when the Smart Bot is listening to you or on demand:*\n"
+        end
       end
       order.on_bot.each do |o|
         txt += help.on_bot[o]
       end
     end
-    if help.key?(:on_bot) and help.on_bot.key?(:admin)
+    if help.key?(:on_bot) and help.on_bot.key?(:admin) and channel_type != :external and channel_type != :extended
       txt += "===================================
-        *Admin commands:*\n"
-      txt += "\n\n"
+        *Admin commands:*\n\n" if descriptions
       order.on_bot_admin.each do |o|
         txt += help.on_bot.admin[o]
       end
@@ -111,31 +158,36 @@ class SlackSmartBot
       end
     end
 
-    if help.key?(:on_bot) and help.on_bot.key?(:admin_master) and help.on_bot.admin_master.size > 0
+    if help.key?(:on_bot) and help.on_bot.key?(:admin_master) and help.on_bot.admin_master.size > 0 and channel_type != :external and channel_type != :extended
       txt += "===================================
-      *Master Admin commands:*\n"
+        *Master Admin commands:*\n" if descriptions
       help.on_bot.admin_master.each do |k, v|
         txt += v if v.is_a?(String)
       end
     end
 
-    if help.key?(:on_master) and help.on_master.key?(:admin_master) and help.on_master.admin_master.size > 0
+    if help.key?(:on_master) and help.on_master.key?(:admin_master) and help.on_master.admin_master.size > 0 and channel_type != :external and channel_type != :extended
       txt += "===================================
-      *Master Admin commands:*\n"
+        *Master Admin commands:*\n" unless txt.include?('*Master Admin commands*') or !descriptions
       help.on_master.admin_master.each do |k, v|
         txt += v if v.is_a?(String)
       end
     end
 
-    if help.key?(:rules_file)
+    if help.key?(:rules_file) and channel_type != :external
       @logger.info channel_type if config.testing
       if channel_type == :extended or channel_type == :direct
         @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
+
+      if !help.rules_file.to_s.include?('These are specific commands') and help.rules_file!=''
+        txt += "===================================
+         *Specific commands on this Channel, call them !THE_COMMAND or !!THE_COMMAND:*\n" if descriptions
+      end
+  
       txt += help.rules_file
     end
-
     return txt
   end
 end