slack-smart-bot 1.11.0 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e5ea9ccfc9d1c52925f5bdd6ef89c35158c19f8fafad8f5af99d9a6b8456b43
-  data.tar.gz: 6c3853c8977a29f85cba5013b06b8178ca6f0b4783ff323fd0fa96d7ad92ad5b
+  metadata.gz: 1b862b6537e267ad0582f3ca4e60eefa63ef9513a6e2b4d0bf0dd05ac5689ef4
+  data.tar.gz: 1f08183c3eb4e33f63f1b1b4a1fc1e078ceb4835655d03435eca27aa2491f749
 SHA512:
-  metadata.gz: 8d795ac13cfe68983064894f6fff8e7667cb939a78c9e2a044630aca021a4bd11c2be8a8cf6944fceebe8ea1b4ff5ca2d7455c4eb121edcd28ad8b89605ad4dc
-  data.tar.gz: e81573197080798f5cae34521b44744de6912895ba55049611f806059b171f69c5fe2d3bb30e790d1d158b2a06b71c449afcb61f96602fcdd070c240a9298f89
+  metadata.gz: 286cc08cac4c0f4cc7dbb32583a2d1f27d7b41bfa2e53330a407850ed80ce993ec63c036c0b1c88a6113b4261701315bd8b2a34eac91e1a9d156eadd029e50de
+  data.tar.gz: a7b84c3d33cb1eda1a59d2d677b091f3b7aab488824d7ee7ba62af1eaa71a2311bb9decd3f7844baedf2fc569bc9f72b9baad023d50393627d70e40c8ba7be6e

data/README.md

@@ -34,6 +34,7 @@ slack-smart-bot can create bots on demand, create shortcuts, run ruby code... ju
   * [Control who has access to a command](#control-who-has-access-to-a-command)
   * [See favorite commands](#see-favorite-commands)
   * [Teams](#teams)
+  * [Time off management](#time-off-management)
   * [Tips](#tips)
     + [Send a file](#send-a-file)
     + [Download a file](#download-a-file)
@@ -377,7 +378,7 @@ Running Example:
 >**_Smart-Bot>_** `Session name: *Create10RandomUsers*`  
 >**_Peter>_** `http = NiceHttp.new("https://reqres.in/")`  
 >**_Smart-Bot>_** `#<NiceHttp:0x00007fc6e216e328 @host="reqres.in", @port=443...>`  
->**_Peter>_** `request = { path: '/api/users' }`  
+>**_Peter>_** `request ||= { path: '/api/users' }`  
 >**_Smart-Bot>_** `{ :path => "/api/users" }`  
 >**_Peter>_** `request.data = { name: '1-10:L', job: 'leader|worker' }`  
 >**_Smart-Bot>_** `{ :name => "1-10:L", :job => "leader|worker" }`  
@@ -395,8 +396,11 @@ Running Example:
 >**_Smart-Bot>_** `Running REPL Create10RandomUsers`  
 >**_Smart-Bot>_** `Create10RandomUsers: 10 Random Users Created`  
 
+You can run repls and supply parameters to the repl that will be executed on the same session just before the repl. [More info](https://github.com/MarioRuiz/slack-smart-bot/issues/60)  
+Example:
+>**_Peter>_** ``run repl Create10RandomUsers `request = {path: '/api-dev/users/'}` ``  
 
-Other REPL commands: `see repls`, `run repl SESSION_NAME ENV_VAR=value`, `get repl SESSION_NAME`, `delete repl SESSION_NAME`
+Other REPL commands: `see repls`, `run repl SESSION_NAME ENV_VAR=value`, `get repl SESSION_NAME`, `delete repl SESSION_NAME`, `kill repl RUN_REPL_ID`
 
 ### Sending notifications
 You can send notifications from MASTER CHANNEL by using **_`notify MESSAGE`_**. All Bot Channels will be notified.
@@ -607,8 +611,45 @@ Examples:
 >**_`ping team sales development What's the status  on last deployment?`_**  
 >**_`contact team sales qa Please finish testing of dev02 feature before noon`_**  
 
-Other team commands: **_`delete team TEAM_NAME`_**  
+It is also possible to add notes for the team, even you can specify if those notes are private so only the members of the team can see them or even personal so only you will. You can use different types of notes: memo, note, issue, task, feature, bug, jira, github. Also you can indicate the topic of the note. To be able to add or delete notes you need to be a member of that team.   
+In case of 'jira' type then you can supply an URL or a JQL and it will show all the JIRA issues as memos. To be able to use it you need to specify on the SmartBot settings the credentials for the Basic Authentication on JIRA:
+`jira: {host: HOST, user: USER, password: PASSWORD}`  
+In case of 'github' type then you can supply an URL filtering the Github issues you want to add as memos. To be able to use it you need to specify on the SmartBot settings the Github token:
+`github: {token: GITHUB_TOKEN}`  
+
+If you want to change the memo status use the command `set STATUS on memo ID TEAM_NAME team`. For example: `set :runner: on memo 7 Sales team`  
+
+Examples:  
+>**_`add memo to sales team : Add tests for Michigan feature`_**  
+>**_`add private note to sales team : Bills will need to be deployed before Friday`_**  
+>**_`add memo to dev team web : Check last version`_**  
+>**_`add private bug to dev team SRE : Logs should not be accessible from outside VPN`_**  
+>**_`add memo sales team : Add tests for Michigan feature`_**  
+>**_`add memo team sales: Add tests for Michigan feature`_**  
+>**_`add jira to sales team : labels = SalesT AND status != Done`_**  
+>**_`add github to sales team : https://github.com/PeterBale/SalesBoom/issues?q=is%3Aissue+is%3Aopen+`_**  
+>**_`set :runner: on memo 7 team Sales`_**  
+
+Other team commands: **_`delete team TEAM_NAME`_**, **_`delete memo ID from team TEAM_NAME`_**, **_`set STATUS on memo ID TEAM_NAME team`_**  
+
+### Time off management
+
+You will be able to add or remove vacation and sick periods by using `add vacation/sick from YYYY/MM/DD to YYYY/MM/DD`. The SmartBot will automatically set the users status to 🌴 or 🤒 and the expiration date when the user is on vacation or sick. The SmartBot won't be allowed to change the status of workspace admins or owners.  
+
+The vacation plan will be displayed also with the team when calling `see team NAME` for all team members.  
+
+Also, you can see the vacation plan for the team for a specific period: `vacations team NAME YYYY/MM/DD`  
+
+To be able to use this command you need to allow the 'users.profile:write' scope on your Slack App and an admin user of the workspace needs to install the app. Set the user token on the SmartBot settings:  
+
+```ruby
+settings = {
+  token: ENV["SLACK_BOT_TOKEN"],
+  user_token: ENV['SLACK_USER_TOKEN']
+}
+```
 
+Other 'time off' commands: **_`remove time off ID`_**, **_`see my time off`_**, **_`see vacations @USER`_**, **_`time off team NAME`_**  
 
 ### Tips
 

data/lib/slack/smart-bot/comm/respond.rb

@@ -49,14 +49,20 @@ class SlackSmartBot
             txt = ""
             msg.split("\n").each do |m|
               if (m + txt).size > max_chars_per_message
-                msgs << txt.chars.each_slice(max_chars_per_message).map(&:join) unless txt == ""
-                txt = ""
+                unless txt == ""
+                  txt[0] = '.' if txt.match?(/\A\s\s\s/) #first line of message in slack don't show spaces at the begining so we force it by changing first char
+                  t = txt.chars.each_slice(max_chars_per_message).map(&:join)
+                  msgs << t
+                  txt = ""
+                end
               end
               txt += (m + "\n")
+              txt[0] = '.' if txt.match?(/\A\s\s\s/) #first line of message in slack don't show spaces at the begining so we force it by changing first char
             end
           end
           msgs << txt
           msgs.flatten!
+          msgs.delete_if{|e| e.match?(/\A\s*\z/)}
           if dest.nil?
             if config[:simulate]
               open("#{config.path}/buffer_complete.log", "a") { |f|

data/lib/slack/smart-bot/comm/set_status.rb

@@ -0,0 +1,21 @@
+class SlackSmartBot
+    def set_status(user_id, status: nil, message: nil, expiration: nil)
+      unless client_user.nil?
+        if expiration.is_a?(String) and expiration.match?(/^\d\d\d\d\/\d\d\/\d\d$/)
+          expiration = Date.parse(expiration, '%Y/%m/%d').to_time.to_i
+        elsif expiration.is_a?(Date)
+          expiration = expiration.to_time.to_i
+        end
+        params = []
+        params << "'status_emoji': '#{status}'" unless status.nil?
+        params << "'status_text': '#{message}'" unless message.nil?
+        params << "'status_expiration':  '#{expiration}'" unless expiration.nil?
+        begin
+          resp = client_user.users_profile_set(user: user_id, profile: "{ #{params.join(', ')} }")
+        rescue Exception => exc
+          @logger.fatal exc.inspect
+        end
+      end
+    end
+  end
+  

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

@@ -15,3 +15,4 @@ require_relative 'comm/get_channel_members'
 require_relative 'comm/get_channels'
 require_relative 'comm/delete'
 require_relative 'comm/get_presence'
+require_relative 'comm/set_status'

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

@@ -0,0 +1,117 @@
+class SlackSmartBot
+  def add_memo_team(user, privacy, team_name, topic, type, message)
+    save_stats(__method__)
+
+    get_teams()
+    if @teams.key?(team_name.to_sym)
+      assigned_members = @teams[team_name.to_sym].members.values.flatten
+      assigned_members.uniq!
+      all_team_members = assigned_members.dup
+      team_members = []
+      if @teams[team_name.to_sym].channels.key?("members")
+        @teams[team_name.to_sym].channels["members"].each do |ch|
+          get_channels_name_and_id() unless @channels_id.key?(ch)
+          tm = get_channel_members(@channels_id[ch])
+          tm.each do |m|
+            user_info = @users.select { |u| u.id == m or (u.key?(:enterprise_user) and u.enterprise_user.id == m) }[-1]
+            team_members << user_info.name unless user_info.is_app_user or user_info.is_bot
+          end
+        end
+      end
+      team_members.flatten!
+      team_members.uniq!
+      all_team_members += team_members
+      all_team_members.uniq!
+    end
+    if type == "jira"
+      able_to_connect_jira = false
+      begin
+        http = NiceHttp.new(config.jira.host)
+        http.headers.authorization = NiceHttpUtils.basic_authentication(user: config.jira.user, password: config.jira.password)
+        message.gsub!(/^\s*</, "")
+        message.gsub!(/\>$/, "")
+        message.gsub!(/\|.+$/, "")
+        message.gsub!(/^#{config.jira.host}/, "")
+        if message.include?("/browse/")
+          message = message.scan(/\/browse\/(.+)/).join
+          resp = http.get("/rest/api/latest/issue/#{message}")
+        else
+          message.gsub!(/^\/issues\/\?jql=/, "")
+          message.gsub!(" ", "%20")
+          resp = http.get("/rest/api/latest/search/?jql=#{message}")
+        end
+        if resp.code == 200
+          able_to_connect_jira = true
+        else
+          error_code = resp.code
+          if resp.code == 400
+            error_message = resp.data.json(:errorMessages)[-1]
+          else
+            error_message = ""
+          end
+        end
+        http.close
+      rescue => exception
+        @logger.fatal exception
+      end
+    elsif type == "github"
+      able_to_connect_github = false
+      begin
+        http = NiceHttp.new(config.github.host)
+        http.headers.authorization = "token #{config.github.token}"
+        message.gsub!(/^\s*</, "")
+        message.gsub!(/\>$/, "")
+        message.gsub!(/\|.+$/, "")
+        message.gsub!(/^#{config.github.host}/, "")
+        message.gsub!("https://github.com", "")
+        message.slice!(0) if message[0] == "/"
+        resp = http.get("/repos#{message}")
+        if resp.code == 200
+          able_to_connect_github = true
+        else
+          error_code = resp.code
+          if resp.code == 401
+            error_message = resp.data.json(:message)[-1]
+          else
+            error_message = ""
+          end
+        end
+        http.close
+      rescue => exception
+        @logger.fatal exception
+      end
+    end
+
+    if !@teams.key?(team_name.to_sym)
+      respond "It seems like the team *#{team_name}* doesn't exist\nRelated commands `add team TEAM_NAME PROPERTIES`, `see team TEAM_NAME`, `see teams`"
+    elsif !(all_team_members + config.masters).flatten.include?(user.name)
+      respond "You have to be a member of the team or a Master admin to be able to add a memo to the team."
+    elsif type == "jira" and !able_to_connect_jira
+      if error_message == ""
+        respond "You need to supply the correct credentials for JIRA on the SmartBot settings: `jira: { host: HOST, user: USER, password: PASSWORD }` and a correct JQL string or JQL url"
+      else
+        respond "You need to supply a correct JQL string or JQL url: #{error_message}"
+      end
+    else
+      topic = :no_topic if topic == ""
+      @teams[team_name.to_sym][:memos] ||= []
+      if @teams[team_name.to_sym][:memos].empty?
+        memo_id = 1
+      else
+        memo_id = @teams[team_name.to_sym][:memos].memo_id.flatten.max + 1
+      end
+      @teams[team_name.to_sym][:memos] << {
+        memo_id: memo_id,
+        topic: topic,
+        type: type,
+        privacy: privacy,
+        user: user.name,
+        date: Time.now.strftime("%Y-%m-%dT%H:%M:%S.000Z")[0..18],
+        message: message,
+        status: ':new: '
+      }
+      update_teams()
+      respond "The memo has been added to *#{team_name}* team."
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+class SlackSmartBot
+
+  def add_vacation(user, type, from, to)
+    save_stats(__method__)
+    get_vacations()
+    from.gsub!('-','/')
+    to.gsub!('-','/')
+    if type.match?(/sick\s+baby/i) or type.match?(/sick\s+child/i)
+      type = 'sick child'
+    end
+
+    if from=='today'
+      from = Date.today.strftime("%Y/%m/%d")
+    elsif from =='tomorrow'
+      from = (Date.today+1).strftime("%Y/%m/%d")
+    elsif from.match?(/next\s+week/)
+      from = Date.today + ((1 - Date.today.wday) % 7)
+      to = (from + 6).strftime("%Y/%m/%d")
+      from = from.strftime("%Y/%m/%d")
+    end
+
+    to = from if to.empty?
+    wrong = false
+    begin
+      from_date = Date.parse(from)
+      to_date = Date.parse(to)
+    rescue
+      wrong = true
+      respond "It seems like the date is not in the correct format: YYYY/MM/DD or is a wrong date."      
+    end
+    unless wrong
+      if Date.parse(from).strftime("%Y/%m/%d") != from
+        respond "It seems like the date #{from} is not in the correct format: YYYY/MM/DD or is a wrong date."
+      elsif Date.parse(to).strftime("%Y/%m/%d") != to
+        respond "It seems like the date #{to} is not in the correct format: YYYY/MM/DD or is a wrong date."
+      else
+        vacations = @vacations.deep_copy
+        vacations[user.name] ||= { user_id: user.id, periods: [] }
+        if vacations[user.name].periods.empty?
+          vacation_id = 1
+        else
+          vacation_id = vacations[user.name].periods[-1].vacation_id + 1
+        end
+        vacations[user.name].periods << { vacation_id: vacation_id, type: type.downcase, from: from, to: to }
+        update_vacations({user.name => vacations[user.name]})
+        respond "Period has been added   ##{vacation_id}"
+        check_vacations(date: Date.today, user: user.name, set_status: true, only_first_day: false)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,69 @@
+class SlackSmartBot
+  def delete_memo_team(user, team_name, memo_id)
+    save_stats(__method__) if answer.empty?
+
+    get_teams()
+    if @teams.key?(team_name.to_sym)
+      assigned_members = @teams[team_name.to_sym].members.values.flatten
+      assigned_members.uniq!
+      all_team_members = assigned_members.dup
+      team_members = []
+      if @teams[team_name.to_sym].channels.key?("members")
+        @teams[team_name.to_sym].channels["members"].each do |ch|
+          get_channels_name_and_id() unless @channels_id.key?(ch)
+          tm = get_channel_members(@channels_id[ch])
+          tm.each do |m|
+            user_info = @users.select { |u| u.id == m or (u.key?(:enterprise_user) and u.enterprise_user.id == m) }[-1]
+            team_members << user_info.name unless user_info.is_app_user or user_info.is_bot
+          end
+        end
+      end
+      team_members.flatten!
+      team_members.uniq!
+      all_team_members += team_members
+      all_team_members.uniq!
+    end
+
+    if !@teams.key?(team_name.to_sym)
+      respond "It seems like the team *#{team_name}* doesn't exist.\nRelated commands `add team TEAM_NAME PROPERTIES`, `see team TEAM_NAME`, `see teams`"
+    elsif !(all_team_members + config.masters).flatten.include?(user.name)
+      respond "You have to be a member of the team or a Master admin to be able to delete a memo of the team."
+    elsif !@teams[team_name.to_sym].key?(:memos) or @teams[team_name.to_sym][:memos].empty? or !@teams[team_name.to_sym][:memos].memo_id.include?(memo_id.to_i)
+      respond "It seems like there is no memo with id #{memo_id}"
+    elsif @teams[team_name.to_sym][:memos].memo_id.include?(memo_id.to_i)
+      memo_selected = @teams[team_name.to_sym][:memos].select { |m| m.memo_id == memo_id.to_i }[-1]
+      if memo_selected.privacy == 'personal' and memo_selected.user != user.name
+        respond "Only the creator can delete a personal memo."
+      else
+        if answer.empty?
+          message = @teams[team_name.to_sym][:memos].select { |memo| memo.memo_id == memo_id.to_i }.message.join
+          ask "do you really want to delete the memo #{memo_id} (#{message}) from #{team_name} team? (yes/no)"
+        else
+          case answer
+          when /yes/i, /yep/i, /sure/i
+            answer_delete
+            memos = []
+            message = ""
+            get_teams()
+            @teams[team_name.to_sym][:memos].each do |memo|
+              if memo.memo_id != memo_id.to_i
+                memos << memo
+              else
+                message = memo.message
+              end
+            end
+            @teams[team_name.to_sym][:memos] = memos
+            update_teams()
+            respond "The memo has been deleted from team #{team_name}: #{message}"
+          when /no/i, /nope/i, /cancel/i
+            answer_delete
+            respond "Ok, the memo was not deleted"
+          else
+            respond "I don't understand"
+            ask "do you really want to delete the memo from #{team_name} team? (yes/no)"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -6,9 +6,29 @@ class SlackSmartBot
       respond "This command cannot be called from a DM"
     else
       get_teams()
+      if @teams.key?(team_name.to_sym)
+        assigned_members = @teams[team_name.to_sym].members.values.flatten
+        assigned_members.uniq!
+        all_team_members = assigned_members.dup
+        team_members = []
+        if @teams[team_name.to_sym].channels.key?("members")
+          @teams[team_name.to_sym].channels["members"].each do |ch|
+            get_channels_name_and_id() unless @channels_id.key?(ch)
+            tm = get_channel_members(@channels_id[ch])
+            tm.each do |m|
+              user_info = @users.select { |u| u.id == m or (u.key?(:enterprise_user) and u.enterprise_user.id == m) }[-1]
+              team_members << user_info.name unless user_info.is_app_user or user_info.is_bot
+            end
+          end
+        end
+        team_members.flatten!
+        team_members.uniq!
+        all_team_members += team_members
+        all_team_members.uniq!
+      end
       if !@teams.key?(team_name.to_sym)
         respond "It seems like the team *#{team_name}* doesn't exist.\nRelated commands `add team TEAM_NAME PROPERTIES`, `see team TEAM_NAME`, `see teams`"
-      elsif !(@teams[team_name.to_sym].members.values + [@teams[team_name.to_sym].creator] + config.masters).flatten.include?(user.name)
+      elsif !(all_team_members + [@teams[team_name.to_sym].creator] + config.masters).flatten.include?(user.name)
         respond "You have to be a member of the team, the creator or a Master admin to be able to delete this team."
       else
         if answer.empty?

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

@@ -0,0 +1,27 @@
+class SlackSmartBot
+  def remove_vacation(user, vacation_id)
+    save_stats(__method__)
+
+    get_vacations()
+    if !@vacations.key?(user.name)
+      respond "It seems like you don't have any time off added."
+    elsif @vacations[user.name].periods.empty? or !@vacations[user.name].periods.vacation_id.include?(vacation_id)
+      respond "It seems like the ID supplied doesn't exist. Please call `see my time off` and check the ID."
+    else
+      vacations = @vacations[user.name].deep_copy
+      vacation = vacations.periods.select {|v| v.vacation_id == vacation_id }[-1]
+      vacations.periods.delete_if {|v| v.vacation_id == vacation_id }
+      update_vacations({user.name => vacations})
+      respond "Your time off has been removed."
+      if vacation.from <= Date.today.strftime("%Y/%m/%d") and vacation.to >= Date.today.strftime("%Y/%m/%d")
+        info = get_user_info(vacations.user_id)
+        emoji = info.user.profile.status_emoji
+        if (vacation.type == 'vacation' and emoji == ':palm_tree:') or (vacation.type == 'sick' and emoji == ':face_with_thermometer:') or
+           (vacation.type == 'sick child' and emoji == ':baby:')
+          set_status(vacations.user_id, status: '', expiration: '', message: '')
+        end
+        check_vacations(date: Date.today, user: user.name, set_status: true, only_first_day: false)
+      end
+    end
+  end
+end

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

@@ -59,7 +59,7 @@ class SlackSmartBot
             message = []
             @announcements[channel_id].each do |m|
               if m[:user_deleted] == '' and (type == 'all' or type == '' or type==m[:type])
-                if m[:type].match?(/:\w+:/)
+                if m[:type].match?(/:[\w\-]+:/)
                   emoji = m[:type]
                 elsif m[:type] == 'white'
                   emoji = ':white_square:'

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

@@ -26,7 +26,7 @@ class SlackSmartBot
       if types == ['available']
         only_active = true
         not_on = true
-        types = [':palm_tree:', ':spiral_calendar_pad:', ':face_with_thermometer:']
+        types = [':palm_tree:', ':spiral_calendar_pad:', ':face_with_thermometer:', ':baby:']
       end
       members.each do |member|
         info = get_user_info(member)