slack-smart-bot 1.12.5 → 1.12.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36ca224f2a96256ac106440459efac5a513b0ebabac65494d6a070e1faa5abf3
-  data.tar.gz: 3aac3bb4b43dc458876c8bd12157bd9e428eb5d684d69861dc174898b8c5cf9e
+  metadata.gz: 5596e8869ae4c53cddb593dadcbde5aa6dc5e4a024d7301e7d2d45e1b03882d9
+  data.tar.gz: 2f4e295bd3881c7f2172b1abd39e40163f3cd244a8ee9f250b8c2e606e8137c5
 SHA512:
-  metadata.gz: f99650a5ee15bab2a367dbc3de6be5cf00e7e01cd083a0a6f5cc425e51893609dba819f31191da74ace36e03a64b13fa6dae346ab24bddbbfbb0883bad5eccc9
-  data.tar.gz: 8f6904c2f655f09a0bdad49e4fe6da578524ccd8b82c0a00c4574398d01e4c7c109aeeb62868469471baf17a26c7778170e707e7ab87f2fe9065df7614db0b93
+  metadata.gz: 24c6dc230c11db7075dee20b7a9f04202417ae443b3abe6b290668a965ef8778b3d211deb8c660bb869dbf54c7e2912b98a8e6b3b86722e8e88e5a832556596d
+  data.tar.gz: b075c60bbc5b632374328c8b8c65a1857454cba5b92ef4d8d0e168a4aefdc0b25e6ba5afdc04c6014c53cf5b35d24dceba5015df1c28491f8fd2d4a5604f56ef

data/README.md

@@ -307,7 +307,7 @@ To display a general message after every command use: `set general message MESSA
 
 To close the Master Bot, run on MASTER CHANNEL: **_`exit bot`_**
 
-If you are a Master Admin on a Direct Message with the Smart Bot you can call the **_`bot stats`_** and get use stats of the users. You need to set to `true` the `stats` settings when initializing the Smart Bot. As a normal user you will get your own stats when calling **_`bot stats`_**. Take a look at `bot help bot stats` for more info. Also you can call **_`leaderboard`_** to get some useful information about the use of the SmartBot.
+If you are a Master Admin on a Direct Message with the Smart Bot you can call the **_`bot stats`_** and get use stats of the users. You need to set to `true` the `stats` settings when initializing the Smart Bot. As a normal user you will get your own stats when calling **_`bot stats`_**. Take a look at `bot help bot stats` for more info. If you are a member of #smartbot-stats you can use the bot stats command on that channel. You can set a different channel by supplying it on the config key stats_channel. Also you can call **_`leaderboard`_** to get some useful information about the use of the SmartBot.
 
 You can also get the bot logs of the bot channel you are using by calling `get bot logs`. You need to be a Master Admin user on a DM with the Smart Bot.
 

data/lib/slack/smart-bot/commands/general_bot_commands.rb

@@ -582,6 +582,8 @@ def general_bot_commands(user, command, dest, files = [])
         # help: `add sick from YYYY/MM/DD to YYYY/MM/DD`
         # help: `add sick YYYY/MM/DD`
         # help: `add sick child YYYY/MM/DD`
+        # help: `I'm sick today`
+        # help: `I'm on vacation today`
         # help:     It will add the supplied period to your plan.
         # help:     Instead of YYYY/MM/DD you can use 'today' or 'tomorrow' or 'next week'
         # help:     To see your plan call `see my time off`
@@ -592,18 +594,21 @@ def general_bot_commands(user, command, dest, files = [])
         # help:     _add vacation from 2022/10/01 to 2022/10/22_
         # help:     _add sick 2022/08/22_
         # help:     _add vacation tomorrow_
+        # help:     _I'll be on vacation next week_
         # help:     _add sick baby today_
         # help:    <https://github.com/MarioRuiz/slack-smart-bot#time-off-management|more info>
         # help: command_id: :add_vacation
         # help: 
-      when /\A\s*add\s+(sick|vacation|sick\s+baby|sick\s+child)\s+from\s+(\d\d\d\d\/\d\d\/\d\d)\s+to\s+(\d\d\d\d\/\d\d\/\d\d)\s*\z/i,
-        /\A\s*add\s+(sick|vacation|sick\s+baby|sick\s+child)\s+from\s+(\d\d\d\d-\d\d-\d\d)\s+to\s+(\d\d\d\d-\d\d-\d\d)\s*\z/i,
-        /\A\s*add\s+(sick|vacation|sick\s+baby|sick\s+child)\s+(\d\d\d\d-\d\d-\d\d)()\s*\z/i,
-        /\A\s*add\s+(sick|vacation|sick\s+baby|sick\s+child)\s+(\d\d\d\d\/\d\d\/\d\d)()\s*\z/i,
-        /\A\s*add\s+(sick|vacation|sick\s+baby|sick\s+child)\s+(today|tomorrow|next\sweek)()\s*\z/i
-        type = $1
-        from = $2.downcase
-        to = $3
+      when /\A\s*(add)\s+(sick|vacation|sick\s+baby|sick\s+child)\s+from\s+(\d\d\d\d\/\d\d\/\d\d)\s+to\s+(\d\d\d\d\/\d\d\/\d\d)\s*\z/i,
+        /\A\s*(add)\s+(sick|vacation|sick\s+baby|sick\s+child)\s+from\s+(\d\d\d\d-\d\d-\d\d)\s+to\s+(\d\d\d\d-\d\d-\d\d)\s*\z/i,
+        /\A\s*(add)\s+(sick|vacation|sick\s+baby|sick\s+child)\s+(\d\d\d\d-\d\d-\d\d)()\s*\z/i,
+        /\A\s*(add)\s+(sick|vacation|sick\s+baby|sick\s+child)\s+(\d\d\d\d\/\d\d\/\d\d)()\s*\z/i,
+        /\A\s*(add)\s+(sick|vacation|sick\s+baby|sick\s+child)\s+(today|tomorrow|next\sweek)()\s*\z/i,
+        /\A\s*(I'm|I\s+am|I'll\s+be|I\s+will\s+be)\s+(sick|on\s+vacation)\s+(today|tomorrow|next\sweek)()\s*\z/i
+        type = $2
+        from = $3.downcase
+        to = $4
+        type = 'vacation' if type.match?(/vacation/)
         add_vacation(user, type, from, to)
 
         # help: ----------------------------------------------

data/lib/slack/smart-bot/commands/on_bot/general/bot_stats.rb

@@ -16,11 +16,16 @@ class SlackSmartBot
     # help: `bot stats members #CHANNEL`
     # help: `bot stats exclude members #CHANNEL`
     # help: `bot stats today`
+    # help: `bot stats yesterday`
+    # help: `bot stats last month`
+    # help: `bot stats this month`
+    # help: `bot stats last week`
+    # help: `bot stats this week`
     # help: `bot stats exclude COMMAND_ID`
     # help: `bot stats monthly`
     # help: `bot stats alldata`
     # help:    To see the bot stats
-    # helpmaster:    You can use this command only if you are a Master admin user and if you are in a private conversation with the bot
+    # helpmaster:    You can use this command only if you are a Master admin user and if you are in a private conversation with the bot, or you are on the Smartbot-stats channel
     # helpmaster:    You need to set stats to true to generate the stats when running the bot instance.
     # help:    members #CHANNEL will return stats for only members of the channel supplied
     # help:    exclude members #CHANNEL will return stats for only members that are not members of the channel supplied
@@ -44,7 +49,15 @@ class SlackSmartBot
             message = ["You need to set stats to true to generate the stats when running the bot instance."]
         end
         save_stats(__method__)
-        if (from_user.id != user and (config.masters.include?(from_user.name) or @master_admin_users_id.include?(from_user.id)) and (typem==:on_dm or dest[0]=='D'))
+        get_channels_name_and_id() unless @channels_name.keys.include?(dest)
+        master_admin_users_id = @master_admin_users_id.dup
+        if dest == @channels_id[config.stats_channel]
+            #master_admin_users_id << user
+            user = '' # for the case we are on the stats channel
+        end
+        if (from_user.id != user and 
+            (config.masters.include?(from_user.name) or master_admin_users_id.include?(from_user.id) or dest == @channels_id[config.stats_channel]) and #Jal
+                (typem==:on_dm or dest[0]=='D' or dest == @channels_id[config.stats_channel] ))
             on_dm_master = true #master admin user
         else
             on_dm_master = false
@@ -164,7 +177,7 @@ class SlackSmartBot
                                     end
                                     if !exclude_masters or (exclude_masters and !master_admins.include?(row[:user_name]) and 
                                                             !master_admins.include?(row[:user_id]) and
-                                                            !@master_admin_users_id.include?(row[:user_id]))
+                                                            !master_admin_users_id.include?(row[:user_id]))
                                         if !exclude_routines or (exclude_routines and !row[:user_name].match?(/^routine\//) )
                                             if exclude_command == '' or (exclude_command!='' and row[:command]!=exclude_command)
                                                 if st_command == '' or (st_command != '' and row[:command] == st_command)
@@ -322,29 +335,28 @@ class SlackSmartBot
                             end
                             if rows[0].key?(:job_title) #then save_stats is saving the job title already
                                 rows.job_title.each_with_index do |job_title, idx|
-                                    unless job_title == ''
-                                        job_title_users[job_title] ||= 0
-                                        job_title_users[job_title] += 1
-                                        users_by_job_title[job_title] ||= []
-                                        users_by_job_title[job_title] << rows.user_name[idx]
-                                    end
+                                    job_title = job_title.to_s.split.map(&:capitalize).join(' ')
+                                    job_title_users[job_title] ||= 0
+                                    job_title_users[job_title] += 1
+                                    users_by_job_title[job_title] ||= []
+                                    users_by_job_title[job_title] << rows.user_name[idx]
                                 end
                             else
                                 rows.user_id.each_with_index do |usr, i|
                                     if rows[i].values.size >= 13 #then save_stats is saving the job_title already but not all the data
-                                        unless rows[i].values[12] == ''
-                                            job_title_users[rows[i].values[12]] ||= 0
-                                            job_title_users[rows[i].values[12]] += 1    
-                                            users_by_job_title[rows[i].values[12]] ||= []
-                                            users_by_job_title[rows[i].values[12]] << rows.user_name[i]
-                                        end
+                                        job_title = rows[i].values[12].to_s.split.map(&:capitalize).join(' ')                                               
+                                        job_title_users[job_title] ||= 0
+                                        job_title_users[job_title] += 1    
+                                        users_by_job_title[job_title] ||= []
+                                        users_by_job_title[job_title] << rows.user_name[i]
                                     else
                                         user_info = @users.select { |u| u.id == usr or (u.key?(:enterprise_user) and u.enterprise_user.id == usr) }[-1]
                                         unless user_info.nil? or user_info.is_app_user or user_info.is_bot
-                                            job_title_users[user_info.profile.title] ||= 0
-                                            job_title_users[user_info.profile.title] += 1
-                                            users_by_job_title[user_info.profile.title] ||= []
-                                            users_by_job_title[user_info.profile.title] << rows.user_name[i]
+                                            job_title = user_info.profile.title.split.map(&:capitalize).join(' ')
+                                            job_title_users[job_title] ||= 0
+                                            job_title_users[job_title] += 1
+                                            users_by_job_title[job_title] ||= []
+                                            users_by_job_title[job_title] << rows.user_name[i]
                                         end
                                     end
                                 end

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

@@ -37,7 +37,8 @@ class SlackSmartBot
     end
     if !config.on_maintenance or (config.on_maintenance and command.match?(/\A(set|turn)\s+maintenance\s+off\s*\z/))
       #todo: check :on_pg in this case
-      if typem == :on_master or typem == :on_bot or typem == :on_pg or typem == :on_dm
+      if typem == :on_master or typem == :on_bot or typem == :on_pg or typem == :on_dm or 
+        (command.match?(/\A\s*bot\s+stats\s*(.*)\s*$/i) and dest==@channels_id[config.stats_channel])
     
         case command
 
@@ -102,14 +103,11 @@ class SlackSmartBot
         when /\A\s*(where\s+is|which\s+channels|where\s+is\s+a\s+member)\s+(#{@salutations.join("|")})\??\s*$/i
           where_smartbot(user)
         when /\A\s*(add|create)\s+(silent\s+)?(bgroutine|routine)\s+([\w\.]+)\s+(every)\s+(\d+)\s*(days|hours|minutes|seconds|mins|min|secs|sec|d|h|m|s)\s*(\s#(\w+)\s*)(\s.+)?\s*\z/im,
-          /\A\s*(add|create)\s+(silent\s+)?(bgroutine|routine)\s+([\w\.]+)\s+(every)\s+(\d+)\s*(days|hours|minutes|seconds|mins|min|secs|sec|d|h|m|s)\s*(\s<#(C\w+)\|.+>\s*)?(\s.+)?\s*\z/im,
-          /\A\s*(add|create)\s+(silent\s+)?(bgroutine|routine)\s+([\w\.]+)\s+(every)\s+(\d+)\s*(days|hours|minutes|seconds|mins|min|secs|sec|d|h|m|s)\s*(\s<#(\w+)\|>\s*)?(\s.+)?\s*\z/im,
+          /\A\s*(add|create)\s+(silent\s+)?(bgroutine|routine)\s+([\w\.]+)\s+(every)\s+(\d+)\s*(days|hours|minutes|seconds|mins|min|secs|sec|d|h|m|s)\s*(\s<#(C\w+)\|.*>\s*)?(\s.+)?\s*\z/im,
           /\A\s*(add|create)\s+(silent\s+)?(bgroutine|routine)\s+([\w\.]+)\s+on\s+(monday|tuesday|wednesday|thursday|friday|saturday|sunday|weekend|weekday)s?\s+at\s+(\d+:\d+:?\d+?)\s*()(\s#(\w+)\s*)(\s.+)?\s*\z/im,
-          /\A\s*(add|create)\s+(silent\s+)?(bgroutine|routine)\s+([\w\.]+)\s+on\s+(monday|tuesday|wednesday|thursday|friday|saturday|sunday|weekend|weekday)s?\s+at\s+(\d+:\d+:?\d+?)\s*()(\s<#(C\w+)\|.+>\s*)?(\s.+)?\s*\z/im,
-          /\A\s*(add|create)\s+(silent\s+)?(bgroutine|routine)\s+([\w\.]+)\s+on\s+(monday|tuesday|wednesday|thursday|friday|saturday|sunday|weekend|weekday)s?\s+at\s+(\d+:\d+:?\d+?)\s*()(\s<#(\w+)\|>\s*)?(\s.+)?\s*\z/im,
+          /\A\s*(add|create)\s+(silent\s+)?(bgroutine|routine)\s+([\w\.]+)\s+on\s+(monday|tuesday|wednesday|thursday|friday|saturday|sunday|weekend|weekday)s?\s+at\s+(\d+:\d+:?\d+?)\s*()(\s<#(C\w+)\|.*>\s*)?(\s.+)?\s*\z/im,
           /\A\s*(add|create)\s+(silent\s+)?(bgroutine|routine)\s+([\w\.]+)\s+(at)\s+(\d+:\d+:?\d+?)\s*()(\s#(\w+)\s*)(\s.+)?\s*\z/im,
-          /\A\s*(add|create)\s+(silent\s+)?(bgroutine|routine)\s+([\w\.]+)\s+(at)\s+(\d+:\d+:?\d+?)\s*()(\s<#(C\w+)\|.+>\s*)?(\s.+)?\s*\z/im,
-          /\A\s*(add|create)\s+(silent\s+)?(bgroutine|routine)\s+([\w\.]+)\s+(at)\s+(\d+:\d+:?\d+?)\s*()(\s<#(\w+)\|>\s*)?(\s.+)?\s*\z/im          
+          /\A\s*(add|create)\s+(silent\s+)?(bgroutine|routine)\s+([\w\.]+)\s+(at)\s+(\d+:\d+:?\d+?)\s*()(\s<#(C\w+)\|.*>\s*)?(\s.+)?\s*\z/im
           silent = $2.to_s!=''
           routine_type = $3.downcase
           name = $4.downcase
@@ -272,6 +270,12 @@ class SlackSmartBot
           opts.gsub!(/exclude\s+members\s+<#\w+\|.*>/,'')
           members_channel =  opts.scan(/members\s+<#(\w+)\|.*>/i).join #todo: add test
           opts.gsub!(/members\s+<#\w+\|.*>/,'')
+          this_month = opts.match?(/this\s+month/i)
+          last_month = opts.match?(/last\s+month/i)
+          this_year = opts.match?(/this\s+year/i)
+          last_year = opts.match?(/last\s+year/i)
+          this_week = opts.match?(/this\s+week/i)
+          last_week = opts.match?(/last\s+week/i)
           all_opts = opts.downcase.split(' ')
           all_data = all_opts.include?('alldata')
           st_channel = opts.scan(/<#(\w+)\|.*>/).join
@@ -296,14 +300,46 @@ class SlackSmartBot
           monthly = false
           if all_opts.include?('today')
             st_from = st_to = "#{Time.now.strftime("%Y-%m-%d")}"
+          elsif all_opts.include?('yesterday')
+            st_from = st_to = "#{(Time.now-86400).strftime("%Y-%m-%d")}"
           elsif all_opts.include?('monthly')
             monthly = true
           end
+          if this_month
+            st_from = "#{Date.today.strftime("%Y-%m-01")}"
+            st_to = "#{Date.today.strftime("%Y-%m-%d")}"          
+          elsif last_month
+            date = Date.today<<1
+            st_from = "#{date.strftime("%Y-%m-01")}"
+            st_to = "#{(Date.new(date.year, date.month, -1)).strftime("%Y-%m-%d")}"
+          elsif this_year
+            st_from = "#{Date.today.strftime("%Y-01-01")}"
+            st_to = "#{Date.today.strftime("%Y-%m-%d")}"
+          elsif last_year
+            date = Date.today.prev_year
+            st_from = "#{date.strftime("%Y-01-01")}"
+            st_to = "#{(Date.new(date.year, 12, 31)).strftime("%Y-%m-%d")}"
+          elsif this_week
+            date = Date.today
+            wday = date.wday
+            wday = 7 if wday==0
+            wday-=1
+            st_from = "#{(date-wday).strftime("%Y-%m-%d")}"
+            st_to = "#{date.strftime("%Y-%m-%d")}"
+          elsif last_week
+            date = Date.today
+            wday = date.wday
+            wday = 7 if wday==0
+            wday-=1
+            st_from = "#{(date-wday-7).strftime("%Y-%m-%d")}"
+            st_to = "#{(date-wday-1).strftime("%Y-%m-%d")}"
+          end
+
           exclude_command = opts.scan(/exclude\s+([^\s]+)/i).join
           unless @master_admin_users_id.include?(user.id)
             st_user = user.id
           end
-          if (typem == :on_master or typem == :on_bot) and dest[0]!='D' #routine bot stats to be published on DM
+          if (typem == :on_master or typem == :on_bot) and dest[0]!='D' and dest!=@channels_id[config.stats_channel] #routine bot stats to be published on DM
             st_channel = dchannel
           end
           bot_stats(dest, user, typem, st_channel, st_from, st_to, st_user, st_command, exclude_masters, exclude_routines, exclude_command, monthly, all_data, members_channel, exclude_members_channel)

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

@@ -212,12 +212,11 @@ class SlackSmartBot
           else
               Thread.current[:using_channel] = ''
           end
-          if typem == :on_pub or typem == :on_pg
+          if (typem == :on_pub or typem == :on_pg) and (!command.match?(/\A\s*bot\s+stats\s*(.*)\s*$/i) or dest!=@channels_id[config.stats_channel])
             processed = false
           else
             processed = process(user, command, dest, dchannel, rules_file, typem, files, Thread.current[:thread_ts])
           end
-          @logger.info "command: #{nick}> #{command}" if processed
           on_demand = false
           if command.match(/\A@?(#{config[:nick]}):*\s+(.+)/im) or
             command.match(/\A()!!(.+)/im) or

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

@@ -250,6 +250,7 @@ class SlackSmartBot
             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*$/) or command[0] == "^"
 
@@ -283,6 +284,7 @@ class SlackSmartBot
           elsif typem == :on_pub or typem == :on_pg
             process_first(user_info, command, dest, channel_rules, typem, data.files, data.ts, data.thread_ts, data.routine, data.routine_name, data.routine_type, command_orig)
           end
+
         rescue Exception => stack
           @logger.fatal stack
         end

data/lib/slack-smart-bot.rb

@@ -47,6 +47,8 @@ class SlackSmartBot
     config[:general_message] = "" unless config.key?(:general_message)
     config[:logrtm] = false unless config.key?(:logrtm)
     config[:status_channel] = 'smartbot-status' unless config.key?(:status_channel)
+    config[:stats_channel] = 'smartbot-stats' unless config.key?(:stats_channel)
+
     config[:jira] = { host: '', user: '', password: '' } unless config.key?(:jira) and config[:jira].key?(:host) and config[:jira].key?(:user) and config[:jira].key?(:password)
     config[:jira][:host] = "https://#{config[:jira][:host]}" unless config[:jira][:host] == '' or config[:jira][:host].match?(/^http/)
     config[:github] = {token: '' } unless config.key?(:github) and config[:github].key?(:token)

data/whats_new.txt

@@ -1,4 +1,4 @@
-*Version 1.12.5* Released 2022-Nov-01
+*Version 1.12.6* Released 2022-Nov-08
 
 *For General users*
 - `run repl` accepts local parameters and precode to be supplied (<https://github.com/MarioRuiz/slack-smart-bot/issues/60|#60>).
@@ -9,11 +9,14 @@
 - Now you can add a GitHub url to the issues you want to add as memos for teams. (<https://github.com/MarioRuiz/slack-smart-bot/issues/71|#71>)
 - It is possible to add the status of a memo on teams feature. (<https://github.com/MarioRuiz/slack-smart-bot/issues/72|#72>)
 - Added 'Time off' (Vacation/Sick/Sick Child) management. The SmartBot will automatically set your status on the periods specified. It will be possible to see the 'Time off' plan for a specific team and period. (<https://github.com/MarioRuiz/slack-smart-bot/issues/73|#73>)
+- More natural language for 'Time off' command: (<https://github.com/MarioRuiz/slack-smart-bot/issues/80|#80>)
 
 *For Admin users*
 - Bot Stats is now saving the time_zone of the user (<https://github.com/MarioRuiz/slack-smart-bot/issues/66|#66>)
 - Announcements won't be published if no activity on channel. (<https://github.com/MarioRuiz/slack-smart-bot/issues/74|#74>)
 - Bot Stats is now saving the job title of the user (<https://github.com/MarioRuiz/slack-smart-bot/issues/77|#77>)
+- Any member of smartbot-stats channel can use the `bot stats` command on the channel (<https://github.com/MarioRuiz/slack-smart-bot/issues/78|#78>)
+- Added options for `bot stats` command: today, yesterday, this week, last week, this year, last year (<https://github.com/MarioRuiz/slack-smart-bot/issues/79|#79>)
 ------------------------------
 
 *Previous*: <https://github.com/MarioRuiz/slack-smart-bot/blob/b1a368c3342094e886f53d96dc4d12ecd81ab04b/whats_new.txt|1.11.0>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack-smart-bot
 version: !ruby/object:Gem::Version
-  version: 1.12.5
+  version: 1.12.6
 platform: ruby
 authors:
 - Mario Ruiz
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-03 00:00:00.000000000 Z
+date: 2022-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: slack-ruby-client
@@ -297,7 +297,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
 summary: Create a Slack bot that is smart and so easy to expand, create new bots on