slack-smart-bot 0.9.6 → 1.0.0

data/lib/slack/smart-bot/commands/general/bot_status.rb

@@ -0,0 +1,41 @@
+class SlackSmartBot
+  # helpadmin: ----------------------------------------------
+  # helpadmin: `bot status`
+  # helpadmin:    Displays the status of the bot
+  # helpadmin:    If on master channel and admin user also it will display info about bots created
+  # helpadmin:
+  def bot_status(dest, from)
+    get_bots_created()
+    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
+    require "socket"
+    ip_address = Socket.ip_address_list.find { |ai| ai.ipv4? && !ai.ipv4_loopback? }.ip_address
+    respond "*#{Socket.gethostname} (#{ip_address})*\n\tStatus: #{@status}.\n\tVersion: #{VERSION}.#{version_message}\n\tRules file: #{File.basename RULES_FILE}\n\tExtended: #{@bots_created[@channel_id][:extended] unless ON_MASTER_BOT}\n\tAdmins: #{ADMIN_USERS}\n\tBot time: #{Time.now}", dest
+    if @status == :on
+      respond "I'm listening to [#{@listening.join(", ")}]", dest
+      if ON_MASTER_BOT and ADMIN_USERS.include?(from)
+        sleep 5
+        @bots_created.each do |k, v|
+          msg = []
+          msg << "`#{v[:channel_name]}` (#{k}):"
+          msg << "\tcreator: #{v[:creator_name]}"
+          msg << "\tadmins: #{v[:admins]}"
+          msg << "\tstatus: #{v[:status]} #{" *(not responded)*" unless @pings.include?(v[:channel_name])}"
+          msg << "\tcreated: #{v[:created]}"
+          msg << "\trules: #{v[:rules_file]}"
+          msg << "\textended: #{v[:extended]}"
+          msg << "\tcloud: #{v[:cloud]}"
+          if ON_MASTER_BOT and v.key?(:cloud) and v[:cloud]
+            msg << "\trunner: `ruby #{$0} \"#{v[:channel_name]}\" \"#{v[:admins]}\" \"#{v[:rules_file]}\" on&`"
+          end
+          respond msg.join("\n"), dest
+        end
+        @pings = []
+      end
+    end
+  end
+end

data/lib/slack/smart-bot/commands/general/bye_bot.rb

@@ -0,0 +1,17 @@
+class SlackSmartBot
+
+  # help: ----------------------------------------------
+  # help: `Bye Bot`
+  # help: `Bye Smart`
+  # help: `Bye NAME_OF_THE_BOT`
+  # help:    Also apart of Bye you can use _Bæ, Good Bye, Adiós, Ciao, Bless, Bless Bless, Adeu_
+  # help:    Bot stops listening to you
+  # help:
+  def bye_bot(dest, from, display_name)
+    if @status == :on
+      bye = ["Bye", "Bæ", "Good Bye", "Adiós", "Ciao", "Bless", "Bless bless", "Adeu"].sample
+      respond "#{bye} #{display_name}", dest
+      @listening.delete(from)
+    end
+  end
+end

data/lib/slack/smart-bot/commands/general/hi_bot.rb

@@ -0,0 +1,24 @@
+class SlackSmartBot
+
+  # help: ----------------------------------------------
+  # help: `Hi Bot`
+  # help: `Hi Smart`
+  # help: `Hello Bot` `Hola Bot` `Hallo Bot` `What's up Bot` `Hey Bot` `Hæ Bot`
+  # help: `Hello THE_NAME_OF_THE_BOT`
+  # help:    Also apart of Hello you can use _Hallo, Hi, Hola, What's up, Hey, Hæ_
+  # help:    Bot starts listening to you
+  # help:    After that if you want to avoid a single message to be treated by the smart bot, start the message by -
+  # help:
+  def hi_bot(user, dest, dchannel, from, display_name)
+    if @status == :on
+      greetings = ["Hello", "Hallo", "Hi", "Hola", "What's up", "Hey", "Hæ"].sample
+      respond "#{greetings} #{display_name}", dest
+      if @rules_imported.key?(user.id) and @rules_imported[user.id].key?(user.id) and dest[0] == "D"
+        respond "You are using specific rules for channel: <##{@rules_imported[user.id][user.id]}>", dest
+      elsif @rules_imported.key?(user.id) and @rules_imported[user.id].key?(dchannel) and (dest[0] == "C" or dest[0] == "G")
+        respond "You are using specific rules for channel: <##{@rules_imported[user.id][dchannel]}>", dest
+      end
+      @listening << from unless @listening.include?(from)
+    end
+  end
+end

data/lib/slack/smart-bot/commands/general/stop_using_rules.rb

@@ -0,0 +1,44 @@
+class SlackSmartBot
+  # help: ----------------------------------------------
+  # help: `stop using rules from CHANNEL`
+  # help:    it will stop using the rules from the specified channel.
+  # help:
+  def stop_using_rules(dest, channel, user, dchannel)
+    if @channels_id.key?(channel)
+      channel_id = @channels_id[channel]
+    else
+      channel_id = channel
+    end
+    if dest[0] == "C" or dest[0] == "G" #channel
+      if @rules_imported.key?(user.id) and @rules_imported[user.id].key?(dchannel)
+        if @rules_imported[user.id][dchannel] != channel_id
+          respond "You are not using those rules.", dest
+        else
+          @rules_imported[user.id].delete(dchannel)
+          update_rules_imported() if ON_MASTER_BOT
+          respond "You won't be using those rules from now on.", dest
+
+          def git_project() "" end
+          def project_folder() "" end
+        end
+      else
+        respond "You were not using those rules.", dest
+      end
+    else #direct message
+      if @rules_imported.key?(user.id) and @rules_imported[user.id].key?(user.id)
+        if @rules_imported[user.id][user.id] != channel_id
+          respond "You are not using those rules.", dest
+        else
+          @rules_imported[user.id].delete(user.id)
+          update_rules_imported() if ON_MASTER_BOT
+          respond "You won't be using those rules from now on.", dest
+
+          def git_project() "" end
+          def project_folder() "" end
+        end
+      else
+        respond "You were not using those rules.", dest
+      end
+    end
+  end
+end

data/lib/slack/smart-bot/commands/general/use_rules.rb

@@ -0,0 +1,48 @@
+class SlackSmartBot
+
+  # help: ----------------------------------------------
+  # help: `use rules from CHANNEL`
+  # help: `use rules CHANNEL`
+  # help: `use CHANNEL`
+  # help:    it will use the rules from the specified channel.
+  # help:    you need to be part of that channel to be able to use the rules.
+  # help:
+  def use_rules(dest, channel, user, dchannel)
+
+    #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
+
+    channel_found = channels.detect { |c| c.name == channel }
+    members = client.web_client.conversations_members(channel: @channels_id[channel]).members unless channel_found.nil?
+
+    if channel_found.nil?
+      respond "The channel you are trying to use doesn't exist", dest
+    elsif channel_found.name == MASTER_CHANNEL
+      respond "You cannot use the rules from Master Channel on any other channel.", dest
+    elsif !@bots_created.key?(@channels_id[channel])
+      respond "There is no bot running on that channel.", dest
+    elsif @bots_created.key?(@channels_id[channel]) and @bots_created[@channels_id[channel]][:status] != :on
+      respond "The bot in that channel is not :on", dest
+    else
+      if user.id == channel_found.creator or members.include?(user.id)
+        @rules_imported[user.id] = {} unless @rules_imported.key?(user.id)
+        if dest[0] == "C" or dest[0] == "G" #todo: take in consideration bots that are not master
+          @rules_imported[user.id][dchannel] = channel_found.id
+        else
+          @rules_imported[user.id][user.id] = channel_found.id
+        end
+        update_rules_imported() if ON_MASTER_BOT
+        respond "I'm using now the rules from <##{channel_found.id}>", dest
+
+        def git_project() "" end
+        def project_folder() "" end
+      else
+        respond "You need to join the channel <##{channel_found.id}> to be able to use the rules.", dest
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+class SlackSmartBot
+
+  # help: ----------------------------------------------
+  # help: `add shortcut NAME: COMMAND`
+  # help: `add sc NAME: COMMAND`
+  # help: `add shortcut for all NAME: COMMAND`
+  # help: `add sc for all NAME: COMMAND`
+  # help: `shortcut NAME: COMMAND`
+  # help: `shortcut for all NAME: COMMAND`
+  # help:    It will add a shortcut that will execute the command we supply.
+  # help:    In case we supply 'for all' then the shorcut will be available for everybody
+  # help:    Example:
+  # help:        _add shortcut for all Spanish account: code require 'iso/iban'; 10.times {puts ISO::IBAN.random('ES')}_
+  # help:    Then to call this shortcut:
+  # help:        _sc spanish account_
+  # help:        _shortcut Spanish Account_
+  # help:        _Spanish Account_
+  # help:
+  def add_shortcut(dest, from, typem, for_all, shortcut_name, command, command_to_run)
+    unless typem == :on_extended
+      @shortcuts[from] = Hash.new() unless @shortcuts.keys.include?(from)
+
+      found_other = false
+      if for_all.to_s != ""
+        @shortcuts.each { |sck, scv|
+          if sck != :all and sck != from and scv.key?(shortcut_name)
+            found_other = true
+          end
+        }
+      end
+      if !ADMIN_USERS.include?(from) and @shortcuts[:all].include?(shortcut_name) and !@shortcuts[from].include?(shortcut_name)
+        respond "Only the creator of the shortcut can modify it", dest
+      elsif found_other
+        respond "You cannot create a shortcut for all with the same name than other user is using", dest
+      elsif !@shortcuts[from].include?(shortcut_name)
+        #new shortcut
+        @shortcuts[from][shortcut_name] = command_to_run
+        @shortcuts[:all][shortcut_name] = command_to_run if for_all.to_s != ""
+        update_shortcuts_file()
+        respond "shortcut added", dest
+      else
+
+        #are you sure? to avoid overwriting existing
+        unless @questions.keys.include?(from)
+          ask("The shortcut already exists, are you sure you want to overwrite it?", command, from, dest)
+        else
+          case @questions[from]
+          when /^(yes|yep)/i
+            @shortcuts[from][shortcut_name] = command_to_run
+            @shortcuts[:all][shortcut_name] = command_to_run if for_all.to_s != ""
+            update_shortcuts_file()
+            respond "shortcut added", dest
+            @questions.delete(from)
+          when /^no/i
+            respond "ok, I won't add it", dest
+            @questions.delete(from)
+          else
+            ask "I don't understand, yes or no?", command, from, dest
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,87 @@
+class SlackSmartBot
+  # helpadmin: ----------------------------------------------
+  # helpadmin: `add routine NAME every NUMBER PERIOD COMMAND`
+  # helpadmin: `add routine NAME every NUMBER PERIOD`
+  # helpadmin: `create routine NAME every NUMBER PERIOD`
+  # helpadmin: `add routine NAME at TIME COMMAND`
+  # helpadmin: `add routine NAME at TIME`
+  # helpadmin: `create routine NAME at TIME`
+  # helpadmin:    It will execute the command supplied. Only for Admin and Master Admins.
+  # helpadmin:    If no COMMAND supplied, then it will be necessary to attach a file with the code to be run and add this command as message to the file. ONLY for MASTER ADMINS.
+  # helpadmin:    NAME: one word to identify the routine
+  # helpadmin:    NUMBER: Integer
+  # helpadmin:    PERIOD: days, d, hours, h, minutes, mins, min, m, seconds, secs, sec, s
+  # helpadmin:    TIME: time at format HH:MM:SS
+  # helpadmin:    COMMAND: any valid smart bot command or rule
+  # helpadmin:    Examples:
+  # helpadmin:      _add routine example every 30s ruby puts 'a'_
+  # helpadmin:      _add routine example every 3 days ruby puts 'a'_
+  # helpadmin:      _add routine example at 17:05 ruby puts 'a'_
+  # helpadmin:
+  def add_routine(dest, from, user, name, type, number_time, period, command_to_run, files)
+    if files.nil? or files.size == 0 or (files.size > 0 and MASTER_USERS.include?(from))
+      if ADMIN_USERS.include?(from)
+        if @routines.key?(@channel_id) && @routines[@channel_id].key?(name)
+          respond "I'm sorry but there is already a routine with that name.\nCall `see routines` to see added routines", dest
+        else
+          number_time += ":00" if number_time.split(":").size == 2
+          if (type == "at") && !number_time.match?(/^[01][0-9]:[0-5][0-9]:[0-5][0-9]$/) &&
+             !number_time.match?(/^2[0-3]:[0-5][0-9]:[0-5][0-9]$/)
+            respond "Wrong time specified: *#{number_time}*"
+          else
+            file_path = ""
+            every = ""
+            at = ""
+            next_run = Time.now
+            case period.downcase
+            when "days", "d"
+              every = "#{number_time} days"
+              every_in_seconds = number_time.to_i * 24 * 60 * 60
+            when "hours", "h"
+              every = "#{number_time} hours"
+              every_in_seconds = number_time.to_i * 60 * 60
+            when "minutes", "mins", "min", "m"
+              every = "#{number_time} minutes"
+              every_in_seconds = number_time.to_i * 60
+            when "seconds", "secs", "sec", "s"
+              every = "#{number_time} seconds"
+              every_in_seconds = number_time.to_i
+            else # time
+              at = number_time
+              if next_run.strftime("%k:%M:%S") < number_time
+                nt = number_time.split(":")
+                next_run = Time.new(next_run.year, next_run.month, next_run.day, nt[0], nt[1], nt[2])
+              else
+                next_run += (24 * 60 * 60) # one more day
+                nt = number_time.split(":")
+                next_run = Time.new(next_run.year, next_run.month, next_run.day, nt[0], nt[1], nt[2])
+              end
+              every_in_seconds = 24 * 60 * 60
+            end
+            Dir.mkdir("./routines/#{@channel_id}") unless Dir.exist?("./routines/#{@channel_id}")
+
+            if !files.nil? && (files.size == 1)
+              @logger.info files[0].inspect
+              file_path = "./routines/#{@channel_id}/#{name}#{files[0].name.scan(/[^\.]+(\.\w+$)/).join}"
+              http = NiceHttp.new(host: "https://files.slack.com", headers: { "Authorization" => "Bearer #{config[:token]}" }, log_headers: :partial)
+              http.get(files[0].url_private_download, save_data: file_path)
+              system("chmod +x #{file_path}")
+            end
+
+            @routines[@channel_id] = {} unless @routines.key?(@channel_id)
+            @routines[@channel_id][name] = { channel_name: CHANNEL, creator: from, creator_id: user.id, status: :on,
+                                             every: every, every_in_seconds: every_in_seconds, at: at, file_path: file_path, command: command_to_run.to_s.strip,
+                                             next_run: next_run.to_s, dest: dest, last_run: "", last_elapsed: "", running: false }
+            update_routines
+            respond "Added routine *`#{name}`* to the channel", dest
+            create_routine_thread(name)
+          end
+        end
+      else
+        respond "Only admin users can use this command", dest
+      end
+    else
+      respond "Only master admin users can add files to routines", dest
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+class SlackSmartBot
+
+  # helpadmin: ----------------------------------------------
+  # helpadmin: `extend rules to CHANNEL_NAME`
+  # helpadmin: `use rules on CHANNEL_NAME`
+  # helpadmin:    It will allow to use the specific rules from this channel on the CHANNEL_NAME
+  # helpadmin:
+  def extend_rules(dest, user, from, channel, typem)
+    unless typem == :on_extended
+      if ON_MASTER_BOT
+        respond "You cannot use the rules from Master Channel on any other channel.", dest
+      elsif !ADMIN_USERS.include?(from) #not admin
+        respond "Only admins can extend the rules. Admins on this channel: #{ADMIN_USERS}", dest
+      else
+        #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
+
+        channel_found = channels.detect { |c| c.name == channel }
+        get_channels_name_and_id()
+        members = client.web_client.conversations_members(channel: @channels_id[channel]).members unless channel_found.nil?
+        get_bots_created()
+        channels_in_use = []
+        @bots_created.each do |k, v|
+          if v.key?(:extended) and v[:extended].include?(channel)
+            channels_in_use << v[:channel_name]
+          end
+        end
+
+        if channel_found.nil?
+          respond "The channel you specified doesn't exist", dest
+        elsif @bots_created.key?(@channels_id[channel])
+          respond "There is a bot already running on that channel.", dest
+        elsif @bots_created[@channel_id][:extended].include?(channel)
+          respond "The rules are already extended to that channel.", dest
+        elsif !members.include?(user.id)
+          respond "You need to join that channel first", dest
+        elsif !members.include?(config[:nick_id])
+          respond "You need to add first to the channel the smart bot user: #{config[:nick]}", dest
+        else
+          channels_in_use.each do |channel_in_use|
+            respond "The rules from channel <##{@channels_id[channel_in_use]}> are already in use on that channel", dest
+          end
+          @bots_created[@channel_id][:extended] = [] unless @bots_created[@channel_id].key?(:extended)
+          @bots_created[@channel_id][:extended] << channel
+          update_bots_file()
+          respond "<@#{user.id}> extended the rules from #{CHANNEL} to be used on #{channel}.", @master_bot_id
+          if @channels_id[channel][0] == "G"
+            respond "Now the rules from <##{@channel_id}> are available on *#{channel}*", dest
+          else
+            respond "Now the rules from <##{@channel_id}> are available on *<##{@channels_id[channel]}>*", dest
+          end
+          respond "<@#{user.id}> extended the rules from <##{@channel_id}> to this channel so now you can talk to the Smart Bot on demand using those rules.", @channels_id[channel]
+          respond "Use `!` before the command you want to run", @channels_id[channel]
+          respond "To see the specific rules for this bot on this channel: `!bot rules` or `!bot rules COMMAND`", @channels_id[channel]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+class SlackSmartBot
+
+  # helpadmin: ----------------------------------------------
+  # helpadmin: `pause bot`
+  # helpadmin: `pause this bot`
+  # helpadmin:    the bot will pause so it will listen only to admin commands
+  # helpadmin:    You can use this command only if you are an admin user
+  # helpadmin:
+  def pause_bot(dest, from)
+    if ADMIN_USERS.include?(from) #admin user
+      respond "This bot is paused from now on. You can start it again: start this bot", dest
+      respond "zZzzzzZzzzzZZZZZZzzzzzzzz", dest
+      @status = :paused
+      unless ON_MASTER_BOT
+        send_msg_channel MASTER_CHANNEL, "Changed status on #{CHANNEL} to :paused"
+      end
+    else
+      respond "Only admin users can put me on pause", dest
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+class SlackSmartBot
+  # helpadmin: ----------------------------------------------
+  # helpadmin: `pause routine NAME`
+  # helpadmin:    It will pause 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:      _pause routine example_
+  # helpadmin:
+  def pause_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 pause 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] = :paused
+        @routines[@channel_id][name][:next_run] = ""
+        update_routines()
+        respond "The routine *`#{name}`* has been paused.", 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