slack-smart-bot 0.9.6 → 1.0.0

data/lib/slack/smart-bot/commands/on_bot/admin/remove_routine.rb

@@ -0,0 +1,28 @@
+class SlackSmartBot
+
+  # helpadmin: ----------------------------------------------
+  # helpadmin: `kill routine NAME`
+  # helpadmin: `delete routine NAME`
+  # helpadmin: `remove routine NAME`
+  # helpadmin:    It will kill and remove the specified routine
+  # helpadmin:    You can use this command only if you are an admin user
+  # helpadmin:    NAME: one word to identify the routine
+  # helpadmin:    Examples:
+  # helpadmin:      _kill routine example_
+  # helpadmin:
+  def remove_routine(dest, from, name)
+    if ADMIN_USERS.include?(from) #admin user
+      if !ON_MASTER_BOT and dest[0] == "D"
+        respond "It's only possible to remove routines from MASTER channel from a direct message with the bot.", dest
+      elsif @routines.key?(@channel_id) and @routines[@channel_id].key?(name)
+        @routines[@channel_id].delete(name)
+        update_routines()
+        respond "The routine *`#{name}`* has been removed.", dest
+      else
+        respond "There isn't a routine with that name: *`#{name}`*.\nCall `see routines` to see added routines", dest
+      end
+    else
+      respond "Only admin users can delete routines", dest
+    end
+  end
+end

data/lib/slack/smart-bot/commands/on_bot/admin/run_routine.rb

@@ -0,0 +1,53 @@
+class SlackSmartBot
+
+  # helpadmin: ----------------------------------------------
+  # helpadmin: `run routine NAME`
+  # helpadmin: `execute routine NAME`
+  # helpadmin:    It will run the specified routine
+  # helpadmin:    You can use this command only if you are an admin user
+  # helpadmin:    NAME: one word to identify the routine
+  # helpadmin:    Examples:
+  # helpadmin:      _run routine example_
+  # helpadmin:
+
+  def run_routine(dest, from, name)
+    if ADMIN_USERS.include?(from) #admin user
+      if !ON_MASTER_BOT and dest[0] == "D"
+        respond "It's only possible to run routines from MASTER channel from a direct message with the bot.", dest
+      elsif @routines.key?(@channel_id) and @routines[@channel_id].key?(name)
+        if @routines[@channel_id][name][:file_path] != ""
+          if @routines[@channel_id][name][:file_path].match?(/\.rb$/i)
+            ruby = "ruby "
+          else
+            ruby = ""
+          end
+          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 stderr == ""
+            unless stdout.match?(/\A\s*\z/)
+              respond "routine *`#{name}`*: #{stdout}", @routines[@channel_id][name][:dest]
+            end
+          else
+            respond "routine *`#{name}`*: #{stdout} #{stderr}", @routines[@channel_id][name][:dest]
+          end
+        else #command
+          respond "routine *`#{name}`*: #{@routines[@channel_id][name][:command]}", @routines[@channel_id][name][:dest]
+          started = Time.now
+          treat_message({ channel: @routines[@channel_id][name][:dest],
+                         user: @routines[@channel_id][name][:creator_id],
+                         text: @routines[@channel_id][name][:command],
+                         files: nil })
+        end
+        @routines[@channel_id][name][:last_elapsed] = (Time.now - started)
+        @routines[@channel_id][name][:last_run] = started.to_s
+        update_routines()
+      else
+        respond "There isn't a routine with that name: `#{name}`.\nCall `see routines` to see added routines", dest
+      end
+    else
+      respond "Only admin users can run routines", dest
+    end
+  end
+end

data/lib/slack/smart-bot/commands/on_bot/admin/see_routines.rb

@@ -0,0 +1,57 @@
+class SlackSmartBot
+  # helpadmin: ----------------------------------------------
+  # helpadmin: `see routines`
+  # helpadmin: `see all routines`
+  # helpadmin:    It will show the routines of the channel
+  # helpadmin:    In case of `all` and on the master channel, it will show all the routines from all channels
+  # helpadmin:    You can use this command only if you are an admin user
+  # helpadmin:
+  def see_routines(dest, from, user, all)
+    if ADMIN_USERS.include?(from) #admin user
+      if all
+        routines = {}
+        if ON_MASTER_BOT
+          Dir["./routines/routines_*.rb"].each do |rout|
+            file_conf = IO.readlines(rout).join
+            unless file_conf.to_s() == ""
+              routines.merge!(eval(file_conf))
+            end
+          end
+        else
+          respond "To see all routines on all channels you need to run the command on the master channel.\nI'll display only the routines on this channel.", dest
+          routines = @routines.deep_copy
+        end
+      else
+        if @rules_imported.key?(user.id) and @rules_imported[user.id].key?(user.id) and dest[0] == "D"
+          file_conf = IO.readlines("./routines/routines_#{@rules_imported[user.id][user.id]}").join
+          routines = eval(file_conf)
+        else
+          routines = @routines.deep_copy
+        end
+      end
+
+      if routines.get_values(:channel_name).size == 0
+        respond "There are no routines added.", dest
+      else
+        routines.each do |ch, rout_ch|
+          respond "Routines on channel *#{rout_ch.get_values(:channel_name).values.flatten.uniq[0]}*", dest
+          rout_ch.each do |k, v|
+            msg = []
+            ch != v[:dest] ? directm = " (*DM to #{v[:creator]}*)" : directm = ""
+            msg << "*`#{k}`*#{directm}"
+            msg << "\tCreator: #{v[:creator]}"
+            msg << "\tStatus: #{v[:status]}"
+            msg << "\tEvery: #{v[:every]}" unless v[:every] == ""
+            msg << "\tAt: #{v[:at]}" unless v[:at] == ""
+            msg << "\tNext Run: #{v[:next_run]}"
+            msg << "\tLast Run: #{v[:last_run]}"
+            msg << "\tTime consumed on last run: #{v[:last_elapsed]}"
+            respond msg.join("\n"), dest
+          end
+        end
+      end
+    else
+      respond "Only admin users can use this command", dest
+    end
+  end
+end

data/lib/slack/smart-bot/commands/on_bot/admin/start_bot.rb

@@ -0,0 +1,20 @@
+class SlackSmartBot
+
+  # helpadmin: ----------------------------------------------
+  # helpadmin: `start bot`
+  # helpadmin: `start this bot`
+  # helpadmin:    the bot will start to listen
+  # helpadmin:    You can use this command only if you are an admin user
+  # helpadmin:
+  def start_bot(dest, from)
+    if ADMIN_USERS.include?(from) #admin user
+      respond "This bot is running and listening from now on. You can pause again: pause this bot", dest
+      @status = :on
+      unless ON_MASTER_BOT
+        send_msg_channel MASTER_CHANNEL, "Changed status on #{CHANNEL} to :on"
+      end
+    else
+      respond "Only admin users can change my status", dest
+    end
+  end
+end

data/lib/slack/smart-bot/commands/on_bot/admin/start_routine.rb

@@ -0,0 +1,27 @@
+class SlackSmartBot
+
+  # helpadmin: ----------------------------------------------
+  # helpadmin: `start routine NAME`
+  # helpadmin:    It will start a paused routine
+  # helpadmin:    You can use this command only if you are an admin user
+  # helpadmin:    NAME: one word to identify the routine
+  # helpadmin:    Examples:
+  # helpadmin:      _start routine example_
+  # helpadmin:
+
+  def start_routine(dest, from, name)
+    if ADMIN_USERS.include?(from) #admin user
+      if !ON_MASTER_BOT and dest[0] == "D"
+        respond "It's only possible to start routines from MASTER channel from a direct message with the bot.", dest
+      elsif @routines.key?(@channel_id) and @routines[@channel_id].key?(name)
+        @routines[@channel_id][name][:status] = :on
+        update_routines()
+        respond "The routine *`#{name}`* has been started. The change will take effect in less than 30 secs.", dest
+      else
+        respond "There isn't a routine with that name: *`#{name}`*.\nCall `see routines` to see added routines", dest
+      end
+    else
+      respond "Only admin users can use this command", dest
+    end
+  end
+end

data/lib/slack/smart-bot/commands/on_bot/admin/stop_using_rules_on.rb

@@ -0,0 +1,30 @@
+class SlackSmartBot
+
+  # helpadmin: ----------------------------------------------
+  # helpadmin: `stop using rules on CHANNEL_NAME`
+  # helpadmin:    it will stop using the extended rules on the specified channel.
+  # helpadmin:
+
+  def stop_using_rules_on(dest, user, from, channel, typem)
+    unless typem == :on_extended
+      if !ADMIN_USERS.include?(from) #not admin
+        respond "Only admins can extend or stop using the rules. Admins on this channel: #{ADMIN_USERS}", dest
+      else
+        get_bots_created()
+        if @bots_created[@channel_id][:extended].include?(channel)
+          @bots_created[@channel_id][:extended].delete(channel)
+          update_bots_file()
+          respond "<@#{user.id}> removed the access to the rules of #{CHANNEL} from #{channel}.", @master_bot_id
+          if @channels_id[channel][0] == "G"
+            respond "The rules won't be accessible from *#{channel}* from now on.", dest
+          else
+            respond "The rules won't be accessible from *<##{@channels_id[channel]}>* from now on.", dest
+          end
+          respond "<@#{user.id}> removed the access to the rules of <##{@channel_id}> from this channel.", @channels_id[channel]
+        else
+          respond "The rules were not accessible from *#{channel}*", dest
+        end
+      end
+    end
+  end
+end

data/lib/slack/smart-bot/commands/on_bot/delete_shortcut.rb

@@ -0,0 +1,41 @@
+class SlackSmartBot
+  # help: ----------------------------------------------
+  # help: `delete shortcut NAME`
+  # help: `delete sc NAME`
+  # help:    It will delete the shortcut with the supplied name
+  # help:
+
+  def delete_shortcut(dest, from, shortcut, typem, command)
+    unless typem == :on_extended
+      deleted = false
+
+      if !ADMIN_USERS.include?(from) and @shortcuts[:all].include?(shortcut) and !@shortcuts[from].include?(shortcut)
+        respond "Only the creator of the shortcut or an admin user can delete it", dest
+      elsif (@shortcuts.keys.include?(from) and @shortcuts[from].keys.include?(shortcut)) or
+            (ADMIN_USERS.include?(from) and @shortcuts[:all].include?(shortcut))
+        #are you sure? to avoid deleting by mistake
+        unless @questions.keys.include?(from)
+          ask("are you sure you want to delete it?", command, from, dest)
+        else
+          case @questions[from]
+          when /^(yes|yep)/i
+            @questions.delete(from)
+            respond "shortcut deleted!", dest
+            respond("#{shortcut}: #{@shortcuts[from][shortcut]}", dest) if @shortcuts.key?(from) and @shortcuts[from].key?(shortcut)
+            respond("#{shortcut}: #{@shortcuts[:all][shortcut]}", dest) if @shortcuts.key?(:all) and @shortcuts[:all].key?(shortcut)
+            @shortcuts[from].delete(shortcut) if @shortcuts.key?(from) and @shortcuts[from].key?(shortcut)
+            @shortcuts[:all].delete(shortcut) if @shortcuts.key?(:all) and @shortcuts[:all].key?(shortcut)
+            update_shortcuts_file()
+          when /^no/i
+            @questions.delete(from)
+            respond "ok, I won't delete it", dest
+          else
+            ask("I don't understand, are you sure you want to delete it? (yes or no)", command, from, dest)
+          end
+        end
+      else
+        respond "shortcut not found", dest
+      end
+    end
+  end
+end

data/lib/slack/smart-bot/commands/on_bot/ruby_code.rb

@@ -0,0 +1,48 @@
+class SlackSmartBot
+  # help: ----------------------------------------------
+  # help: `ruby RUBY_CODE`
+  # help: `code RUBY_CODE`
+  # help:     runs the code supplied and returns the output. Also you can send a Ruby file instead. Examples:
+  # help:       _code puts (34344/99)*(34+14)_
+  # help:       _ruby require 'json'; res=[]; 20.times {res<<rand(100)}; my_json={result: res}; puts my_json.to_json_
+  # help:
+
+  def ruby_code(dest, code, rules_file)
+    unless code.match?(/System/i) or code.match?(/Kernel/i) or code.include?("File") or
+           code.include?("`") or code.include?("exec") or code.include?("spawn") or code.include?("IO.") or
+           code.match?(/open3/i) or code.match?(/bundle/i) or code.match?(/gemfile/i) or code.include?("%x") or
+           code.include?("ENV") or code.match?(/=\s*IO/)
+      unless rules_file.empty?
+        begin
+          eval(File.new(rules_file).read) if File.exist?(rules_file)
+        end
+      end
+
+      respond "Running", dest if code.size > 100
+
+      begin
+        code.gsub!(/^\W*$/, "") #to remove special chars from slack when copy/pasting
+        ruby = "ruby -e \"#{code.gsub('"', '\"')}\""
+        if defined?(project_folder) and project_folder.to_s != "" and Dir.exist?(project_folder)
+          ruby = ("cd #{project_folder} &&" + ruby)
+        else
+          def project_folder() "" end
+        end
+        stdout, stderr, status = Open3.capture3(ruby)
+        if stderr == ""
+          if stdout == ""
+            respond "Nothing returned. Remember you need to use p or puts to print", dest
+          else
+            respond stdout, dest
+          end
+        else
+          respond stderr, dest
+        end
+      rescue Exception => exc
+        respond exc, dest
+      end
+    else
+      respond "Sorry I cannot run this due security reasons", dest
+    end
+  end
+end

data/lib/slack/smart-bot/commands/on_bot/see_shortcuts.rb

@@ -0,0 +1,32 @@
+class SlackSmartBot
+  # help: ----------------------------------------------
+  # help: `see shortcuts`
+  # help: `see sc`
+  # help:    It will display the shortcuts stored for the user and for :all
+  # help:
+  def see_shortcuts(dest, from, typem)
+    unless typem == :on_extended
+      msg = ""
+      if @shortcuts[:all].keys.size > 0
+        msg = "*Available shortcuts for all:*\n"
+        @shortcuts[:all].each { |name, value|
+          msg += "    _#{name}: #{value}_\n"
+        }
+        respond msg, dest
+      end
+
+      if @shortcuts.keys.include?(from) and @shortcuts[from].keys.size > 0
+        new_hash = @shortcuts[from].dup
+        @shortcuts[:all].keys.each { |k| new_hash.delete(k) }
+        if new_hash.keys.size > 0
+          msg = "*Available shortcuts for #{from}:*\n"
+          new_hash.each { |name, value|
+            msg += "    _#{name}: #{value}_\n"
+          }
+          respond msg, dest
+        end
+      end
+      respond "No shortcuts found", dest if msg == ""
+    end
+  end
+end

data/lib/slack/smart-bot/commands/on_extended/bot_rules.rb

@@ -0,0 +1,37 @@
+class SlackSmartBot
+  def bot_rules(dest, help_command, typem, rules_file, from)
+    if typem == :on_extended or typem == :on_call #for the other cases above.
+      help_filtered = get_help(rules_file, dest, from, true)
+
+      if help_command.to_s != ""
+        help_found = false
+        help_filtered.split(/^\s*-------*$/).each do |h|
+          if h.match?(/[`_]#{help_command}/i)
+            respond h, dest
+            help_found = true
+          end
+        end
+        respond("I didn't find any command starting by `#{help_command}`", dest) unless help_found
+      else
+        message = "-\n\n\n===================================\n*Rules from channel #{CHANNEL}*\n"
+        if typem == :on_extended
+          message += "To run the commands on this extended channel, add `!` before the command.\n"
+        end
+        message += help_filtered
+        respond message, dest
+      end
+
+      unless rules_file.empty?
+        begin
+          eval(File.new(rules_file).read) if File.exist?(rules_file)
+        end
+      end
+      if defined?(git_project) and git_project.to_s != "" and help_message_rules != "" and help_command.to_s == ""
+        respond "Git project: #{git_project}", dest
+      else
+        def git_project() "" end
+        def project_folder() "" end
+      end
+    end
+  end
+end

data/lib/slack/smart-bot/commands/on_master/admin/kill_bot_on_channel.rb

@@ -0,0 +1,38 @@
+class SlackSmartBot
+  # helpmaster: ----------------------------------------------
+  # helpmaster: `kill bot on CHANNEL_NAME`
+  # helpmaster:    kills the bot on the specified channel
+  # helpmaster:    Only works if you are on Master channel and you created that bot or you are an admin user
+  # helpmaster:
+  def kill_bot_on_channel(dest, from, channel)
+    if ON_MASTER_BOT
+      get_channels_name_and_id() unless @channels_name.keys.include?(channel) or @channels_id.keys.include?(channel)
+      channel_id = nil
+      if @channels_name.key?(channel) #it is an id
+        channel_id = channel
+        channel = @channels_name[channel_id]
+      elsif @channels_id.key?(channel) #it is a channel name
+        channel_id = @channels_id[channel]
+      end
+      if channel_id.nil?
+        respond "There is no channel with that name: #{channel}, please be sure is written exactly the same", dest
+      elsif @bots_created.keys.include?(channel_id)
+        if @bots_created[channel_id][:admins].split(",").include?(from)
+          if @bots_created[channel_id][:thread].kind_of?(Thread) and @bots_created[channel_id][:thread].alive?
+            @bots_created[channel_id][:thread].kill
+          end
+          @bots_created.delete(channel_id)
+          update_bots_file()
+          respond "Bot on channel: #{channel}, has been killed and deleted.", dest
+          send_msg_channel(channel, "Bot has been killed by #{from}")
+        else
+          respond "You need to be the creator or an admin of that bot channel", dest
+        end
+      else
+        respond "There is no bot in this channel: #{channel}", dest
+      end
+    else
+      respond "Sorry I cannot kill bots from this channel, please visit the master channel: <##{@master_bot_id}>", dest
+    end
+  end
+end

data/lib/slack/smart-bot/commands/on_master/admin_master/exit_bot.rb

@@ -0,0 +1,42 @@
+class SlackSmartBot
+
+  # helpadmin: ----------------------------------------------
+  # helpadmin: `exit bot`
+  # helpadmin: `quit bot`
+  # helpadmin: `close bot`
+  # helpadmin:    The bot stops running and also stops all the bots created from this master channel
+  # helpadmin:    You can use this command only if you are an admin user and you are on the master channel
+  # helpadmin:
+  def exit_bot(command, from, dest, display_name)
+    if ON_MASTER_BOT
+      if ADMIN_USERS.include?(from) #admin user
+        unless @questions.keys.include?(from)
+          ask("are you sure?", command, from, dest)
+        else
+          case @questions[from]
+          when /yes/i, /yep/i, /sure/i
+            respond "Game over!", dest
+            respond "Ciao #{display_name}!", dest
+            @bots_created.each { |key, value|
+              value[:thread] = ""
+              send_msg_channel(key, "Bot has been closed by #{from}")
+              sleep 0.5
+            }
+            update_bots_file()
+            sleep 0.5
+            exit!
+          when /no/i, /nope/i, /cancel/i
+            @questions.delete(from)
+            respond "Thanks, I'm happy to be alive", dest
+          else
+            ask("I don't understand, are you sure do you want me to close? (yes or no)", command, from, dest)
+          end
+        end
+      else
+        respond "Only admin users can kill me", dest
+      end
+    else
+      respond "To do this you need to be an admin user in the master channel: <##{@master_bot_id}>", dest
+    end
+  end
+end