slack-smart-bot 0.9.6 → 1.0.0

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

@@ -0,0 +1,139 @@
+class SlackSmartBot
+  def treat_message(data)
+    if config[:testing] and ON_MASTER_BOT
+      open("./buffer.log", "a") { |f|
+        f.puts "|#{data.channel}|#{data.user}|#{data.text}"
+      }
+    end
+    if data.channel[0] == "D" or data.channel[0] == "C" or data.channel[0] == "G" #Direct message or Channel or Private Channel
+      dest = data.channel
+    else # not treated
+      dest = nil
+    end
+    #todo: sometimes data.user is nil, check the problem.
+    @logger.warn "!dest is nil. user: #{data.user}, channel: #{data.channel}, message: #{data.text}" if dest.nil?
+    if !data.files.nil? and data.files.size == 1 and data.text.to_s == "" and data.files[0].filetype == "ruby"
+      data.text = "ruby"
+    end
+    if !dest.nil? and ON_MASTER_BOT and !data.text.nil? and data.text.match(/^ping from (.+)\s*$/) and data.user == config[:nick_id]
+      @pings << $1
+    end
+    typem = :dont_treat
+    if !dest.nil? and !data.text.nil? and !data.text.to_s.match?(/^\s*$/)
+      if data.text.match(/^<@#{config[:nick_id]}>\s(on\s)?<#(\w+)\|([^>]+)>\s*:?\s*(.*)/im)
+        channel_rules = $2
+        channel_rules_name = $3
+        # to be treated only on the bot of the requested channel
+        if @channel_id == channel_rules
+          data.text = $4
+          typem = :on_call
+        end
+      elsif dest == @master_bot_id
+        if ON_MASTER_BOT #only to be treated on master mot channel
+          typem = :on_master
+        end
+      elsif @bots_created.key?(dest)
+        if @channel_id == dest #only to be treated by the bot on the channel
+          typem = :on_bot
+        end
+      elsif dest[0] == "D" #Direct message
+        if ON_MASTER_BOT #only to be treated by master bot
+          typem = :on_dm
+        end
+      elsif dest[0] == "C" or dest[0] == "G"
+        #only to be treated on the channel of the bot. excluding running ruby
+        if !ON_MASTER_BOT and @bots_created[@channel_id][:extended].include?(@channels_name[dest]) and
+           !data.text.match?(/^!?\s*(ruby|code)\s+/)
+          typem = :on_extended
+        elsif ON_MASTER_BOT and data.text.match?(/^!?\s*(ruby|code)\s+/) #or in case of running ruby, the master bot
+          @bots_created.each do |k, v|
+            if v.key?(:extended) and v[:extended].include?(@channels_name[dest])
+              typem = :on_extended
+              break
+            end
+          end
+        end
+        if dest[0] == "G" and ON_MASTER_BOT and typem != :on_extended #private group
+          typem = :on_pg
+        end
+      end
+    end
+
+    unless typem == :dont_treat
+      begin
+        #todo: when changed @questions user_id then move user_info inside the ifs to avoid calling it when not necessary
+        user_info = client.web_client.users_info(user: data.user)
+
+        if @questions.key?(user_info.user.name)
+          if data.text.match?(/^\s*(Bye|Bæ|Good\sBye|Adiós|Ciao|Bless|Bless\sBless|Adeu)\s(#{@salutations.join("|")})\s*$/i)
+            @questions.delete(user_info.user.name)
+            command = data.text
+          else
+            command = @questions[user_info.user.name]
+            @questions[user_info.user.name] = data.text
+          end
+        else
+          command = data.text
+        end
+
+        #when added special characters on the message
+        if command.size >= 2 and
+           ((command[0] == "`" and command[-1] == "`") or (command[0] == "*" and command[-1] == "*") or (command[0] == "_" and command[-1] == "_"))
+          command = command[1..-2]
+        end
+
+        #ruby file attached
+        if !data.files.nil? and data.files.size == 1 and
+           (command.match?(/^(ruby|code)\s*$/) or (command.match?(/^\s*$/) and data.files[0].filetype == "ruby") or
+            (typem == :on_call and data.files[0].filetype == "ruby"))
+          res = Faraday.new("https://files.slack.com", headers: { "Authorization" => "Bearer #{config[:token]}" }).get(data.files[0].url_private)
+          command += " ruby" if command != "ruby"
+          command = "#{command} #{res.body.to_s.force_encoding("UTF-8")}"
+        end
+
+        if typem == :on_call
+          command = "!" + command unless command[0] == "!" or command.match?(/^\s*$/)
+
+          #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_rules_name }
+          members = client.web_client.conversations_members(channel: @channels_id[channel_rules_name]).members unless channel_found.nil?
+          if channel_found.nil?
+            @logger.fatal "Not possible to find the channel #{channel_rules_name}"
+          elsif channel_found.name == MASTER_CHANNEL
+            respond "You cannot use the rules from Master Channel on any other channel.", dest
+          elsif @status != :on
+            respond "The bot in that channel is not :on", dest
+          elsif data.user == channel_found.creator or members.include?(data.user)
+            res = process_first(user_info.user, command, dest, channel_rules, typem, data.files)
+          else
+            respond "You need to join the channel <##{channel_found.id}> to be able to use the rules.", dest
+          end
+        elsif ON_MASTER_BOT and typem == :on_extended and
+              command.size > 0 and command[0] != "-"
+          # to run ruby only from the master bot for the case more than one extended
+          res = process_first(user_info.user, command, dest, @channel_id, typem, data.files)
+        elsif !ON_MASTER_BOT and @bots_created[@channel_id].key?(:extended) and
+              @bots_created[@channel_id][:extended].include?(@channels_name[data.channel]) and
+              command.size > 0 and command[0] != "-"
+          res = process_first(user_info.user, command, dest, @channel_id, typem, data.files)
+        elsif (dest[0] == "D" or @channel_id == data.channel or data.user == config[:nick_id]) and
+              command.size > 0 and command[0] != "-"
+          res = process_first(user_info.user, command, dest, data.channel, typem, data.files)
+          # if @botname on #channel_rules: do something
+        end
+      rescue Exception => stack
+        @logger.fatal stack
+      end
+    else
+      if !ON_MASTER_BOT and (dest == @master_bot_id or dest[0] == "D") and
+         data.text.match?(/^\s*bot\s+status\s*$/i) and @admin_users_id.include?(data.user)
+        respond "ping from #{CHANNEL}", dest
+      end
+    end
+  end
+end

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

@@ -0,0 +1,299 @@
+class SlackSmartBot
+  def update_bots_file
+    file = File.open($0.gsub(".rb", "_bots.rb"), "w")
+    bots_created = @bots_created.dup
+    bots_created.each { |k, v| v[:thread] = "" }
+    file.write bots_created.inspect
+    file.close
+  end
+
+  def get_bots_created
+    if File.exist?($0.gsub(".rb", "_bots.rb"))
+      if !defined?(@datetime_bots_created) or @datetime_bots_created != File.mtime($0.gsub(".rb", "_bots.rb"))
+        file_conf = IO.readlines($0.gsub(".rb", "_bots.rb")).join
+        if file_conf.to_s() == ""
+          @bots_created = {}
+        else
+          @bots_created = eval(file_conf)
+        end
+        @datetime_bots_created = File.mtime($0.gsub(".rb", "_bots.rb"))
+        @bots_created.each do |k, v| # to be compatible with old versions
+          v[:extended] = [] unless v.key?(:extended)
+        end
+      end
+    end
+  end
+
+  def update_shortcuts_file
+    file = File.open("./shortcuts/#{SHORTCUTS_FILE}", "w")
+    file.write @shortcuts.inspect
+    file.close
+  end
+
+  def update_rules_imported
+    file = File.open("./rules/rules_imported.rb", "w")
+    file.write @rules_imported.inspect
+    file.close
+  end
+
+  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_id = Hash.new()
+    @channels_name = Hash.new()
+    channels.each do |ch|
+      unless ch.is_archived
+        @channels_id[ch.name] = ch.id
+        @channels_name[ch.id] = ch.name
+      end
+    end
+  end
+
+  def get_routines(channel = @channel_id)
+    if File.exist?("./routines/routines_#{channel}.rb")
+      file_conf = IO.readlines("./routines/routines_#{channel}.rb").join
+      unless file_conf.to_s() == ""
+        @routines = eval(file_conf)
+      end
+    end
+  end
+
+  def update_routines(channel = @channel_id)
+    file = File.open("./routines/routines_#{channel}.rb", "w")
+    file.write (@routines.inspect)
+    file.close
+  end
+
+  def create_routine_thread(name)
+    t = Thread.new do
+      while @routines.key?(@channel_id) and @routines[@channel_id].key?(name)
+        started = Time.now
+        if @status == :on and @routines[@channel_id][name][:status] == :on
+          if @routines[@channel_id][name][:file_path].match?(/\.rb$/i)
+            ruby = "ruby "
+          else
+            ruby = ""
+          end
+          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 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
+            # in case the routine was deleted while running the process
+            if !@routines.key?(@channel_id) or !@routines[@channel_id].key?(name)
+              Thread.exit
+            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][:next_run] == "" and @routines[@channel_id][name][:at] != "" #coming from start after pause for 'at'
+            if started.strftime("%k:%M:%S") < @routines[@channel_id][name][:at]
+              nt = @routines[@channel_id][name][:at].split(":")
+              next_run = Time.new(started.year, started.month, started.day, nt[0], nt[1], nt[2])
+            else
+              next_run = started + (24 * 60 * 60) # one more day
+              nt = @routines[@channel_id][name][:at].split(":")
+              next_run = Time.new(next_run.year, next_run.month, next_run.day, nt[0], nt[1], nt[2])
+            end
+            @routines[@channel_id][name][:next_run] = next_run.to_s
+            elapsed = 0
+            every_in_seconds = next_run - started
+          else
+            every_in_seconds = @routines[@channel_id][name][:every_in_seconds]
+            elapsed = Time.now - started
+            @routines[@channel_id][name][:last_elapsed] = elapsed
+            @routines[@channel_id][name][:next_run] = (started + every_in_seconds).to_s
+          end
+          @routines[@channel_id][name][:running] = true
+          @routines[@channel_id][name][:sleeping] = every_in_seconds - elapsed
+          update_routines()
+          sleep(every_in_seconds - elapsed) unless elapsed > every_in_seconds
+        else
+          sleep 30
+        end
+      end
+    end
+  end
+
+  def build_help(path)
+    help_message = {}
+    Dir["#{path}/*"].each do |t|
+      if Dir.exist?(t)
+        help_message[t.scan(/\/(\w+)$/).join.to_sym] = build_help(t)
+      else
+        help_message[t.scan(/\/(\w+)\.rb$/).join.to_sym] = IO.readlines(t).join.scan(/#\s*help\s*\w*:(.*)/).join("\n")
+      end
+    end
+    return help_message
+  end
+
+  def remove_hash_keys(hash, key)
+    newh = Hash.new
+    hash.each do |k, v|
+      unless k == key
+        if v.is_a?(String)
+          newh[k] = v
+        else
+          newh[k] = remove_hash_keys(v, key)
+        end
+      end
+    end
+    return newh
+  end
+
+  def get_help(rules_file, dest, from, only_rules = false)
+    order = {
+      general: [:hi_bot, :bye_bot, :bot_help, :bot_status, :use_rules, :stop_using_rules],
+      on_bot: [:ruby_code, :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 MASTER_USERS.include?(from)
+      user_type = :admin_master
+    elsif ADMIN_USERS.include?(from)
+      user_type = :admin
+    else
+      user_type = :user
+    end
+    # channel_type: :bot, :master_bot, :direct, :extended, :external
+    if dest[0] == "D"
+      channel_type = :direct
+    elsif ON_MASTER_BOT
+      channel_type = :master_bot
+    elsif @channel_id != dest
+      channel_type = :extended
+    else
+      channel_type = :bot
+    end
+
+    @help_messages ||= build_help("#{__dir__}/commands")
+    if only_rules
+      help = {}
+    else
+      help = @help_messages.deep_copy
+    end
+    if rules_file != ""
+      help[:rules_file] = IO.readlines(rules_file).join.scan(/#\s*help\s*\w*:(.*)/i).join("\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, :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
+      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:
+            *!THE_COMMAND*
+            *@NAME_OF_BOT THE_COMMAND*
+            *NAME_OF_BOT THE_COMMAND*\n"
+    end
+    if channel_type == :direct
+      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
+      txt += "===================================
+      *Commands from Channels without a bot:*
+      ----------------------------------------------
+      `@BOT_NAME on #CHANNEL_NAME COMMAND`
+      `@BOT_NAME #CHANNEL_NAME COMMAND`
+        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.
+
+      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"
+      end
+      order.general.each do |o|
+        txt += help.general[o]
+      end
+      if channel_type == :master_bot
+        txt += help.on_master.create_bot
+      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"
+      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)
+      txt += "===================================
+        *Admin commands:*\n"
+      txt += "\n\n"
+      order.on_bot_admin.each do |o|
+        txt += help.on_bot.admin[o]
+      end
+      if help.key?(:on_master) and help.on_master.key?(:admin)
+        help.on_master.admin.each do |k, v|
+          txt += v if v.is_a?(String)
+        end
+      end
+    end
+
+    if help.key?(:on_master) and help.on_master.key?(:admin_master)
+      txt += "===================================
+      *Master Admin commands:*\n"
+      help.on_master.admin_master.each do |k, v|
+        txt += v if v.is_a?(String)
+      end
+    end
+
+    if help.key?(:on_bot) and help.on_bot.key?(:admin_master) and help.on_bot.admin_master.size > 0
+      txt += "===================================
+      *Master Admin commands:*\n"
+    end
+
+    if help.key?(:rules_file)
+      @logger.info channel_type
+      if channel_type == :extended or channel_type == :direct
+        @logger.info help.rules_file
+        help.rules_file = help.rules_file.gsub(/^\s*\*These are specific commands.+NAME_OF_BOT THE_COMMAND`\s*$/im, "")
+      end
+      txt += help.rules_file
+    end
+    return txt
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack-smart-bot
 version: !ruby/object:Gem::Version
-  version: 0.9.6
+  version: 1.0.0
 platform: ruby
 authors:
 - Mario Ruiz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-04 00:00:00.000000000 Z
+date: 2019-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: slack-ruby-client
@@ -39,7 +39,7 @@ dependencies:
         version: '1.7'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.19
+        version: 1.7.21
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -49,7 +49,21 @@ dependencies:
         version: '1.7'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.19
+        version: 1.7.21
+- !ruby/object:Gem::Dependency
+  name: nice_hash
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: async-websocket
   requirement: !ruby/object:Gem::Requirement
@@ -64,6 +78,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.8.0
 description: "Create a Slack bot that is smart and so easy to expand, create new bots
   on demand, run ruby code on chat, create shortcuts... \n  The main scope of this
   gem is to be used internally in the company so teams can create team channels with
@@ -84,6 +118,37 @@ files:
 - README.md
 - lib/slack-smart-bot.rb
 - lib/slack-smart-bot_rules.rb
+- lib/slack/smart-bot/comm.rb
+- lib/slack/smart-bot/commands/general/bot_help.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/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
+- lib/slack/smart-bot/commands/on_bot/admin/pause_bot.rb
+- lib/slack/smart-bot/commands/on_bot/admin/pause_routine.rb
+- lib/slack/smart-bot/commands/on_bot/admin/remove_routine.rb
+- lib/slack/smart-bot/commands/on_bot/admin/run_routine.rb
+- lib/slack/smart-bot/commands/on_bot/admin/see_routines.rb
+- 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/delete_shortcut.rb
+- lib/slack/smart-bot/commands/on_bot/ruby_code.rb
+- lib/slack/smart-bot/commands/on_bot/see_shortcuts.rb
+- lib/slack/smart-bot/commands/on_extended/bot_rules.rb
+- 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/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
 homepage: https://github.com/MarioRuiz/slack-smart-bot
 licenses:
 - MIT
@@ -103,7 +168,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Create a Slack bot that is smart and so easy to expand, create new bots on