immosquare-slack 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 382c2959d5d7d3869803f78d02a7247288a194045513777288caff5c2fa7abae
-  data.tar.gz: 403787e3740082733bb3966bd58bde6ccb45d4e3768e8f06027c1470e66872d3
+  metadata.gz: 8ee55a9d9a3ffafa9f99139fbe4931f30bff4138ea4e77ff1ba8d5e1b005f55a
+  data.tar.gz: 1e2c4c73dc40c6caf741b983317e878204b9f1e42a865fdb7ca8ede4c2921510
 SHA512:
-  metadata.gz: c93db1d79831bfbaab04b9e00b8fba3236c5e0e5bd040207498d573c05897575de36ef6ec38ecfadfc35481c4469e0a1fd8dce97c674d846ec57ee9606f3c78d
-  data.tar.gz: 233f3fe54d124c757f3c07369ca7a9d1e615d42b6c09d98d86e931d5dd98e22d7cd9abd9d042375d1a70b2c2aa9878ed79719ce11864a91ecf32e333b92d1c22
+  metadata.gz: cc6d87db38e715bb3804a6f86755d9a055d55753bac17d5799bd99462d1e4b61e65a177af45c57da4777ddeb61e9689972e51b212debca92723d5bcbba015502
+  data.tar.gz: 3bec4651abf9eafeec9aecbc40581ed4f54733c614a3e370bedd7f2b6161f391f1b79acf88c8d2b5d466168a58a65e442f1b81437dfc1019803a9ac41c287773

data/lib/immosquare-slack/channel.rb

@@ -40,6 +40,13 @@ module ImmosquareSlack
       ## If no channel can be resolved after fallback, raises an
       ## ArgumentError immediately (clearer than the cryptic error
       ## returned by the Slack API).
+      ##
+      ## Slack only notifies a mention to members of the channel the
+      ## message lands in. When `notify` is an Array of emails, the
+      ## mentioned users outside that channel (all of them when the
+      ## message falls back to the general channel) also receive it
+      ## as a direct message from the bot, unless
+      ## `direct_message_unreachable_mentions` is disabled.
       ##============================================================##
       def post_message(text, channel_name: nil, notify: nil, notify_text: nil, bot_name: nil, notify_general_if_invalid_channel: true)
         channel_name ||= ImmosquareSlack.configuration.default_channel
@@ -52,28 +59,22 @@ module ImmosquareSlack
         ## the memoized list predates its creation. Retry once on a
         ## freshly fetched list before declaring it missing.
         ##============================================================##
-        channel_id = get_channel_id_by_name(channel_name)
-        channel_id = get_channel_id_by_name(channel_name, :force => true) if channel_id.nil?
+        channel_id        = get_channel_id_by_name(channel_name)
+        channel_id        = get_channel_id_by_name(channel_name, :force => true) if channel_id.nil?
+        mentioned_members = notify.is_a?(Array) ? members_with_emails(notify) : []
 
         if channel_id.nil?
-          text = "immosquare-slack missing channel *#{channel_name}*\nmessage:\n#{text}"
-          return post_message(text, :channel_name => GENERAL_CHANNEL, :notify => :channel, :notify_text => "", :bot_name => bot_name, :notify_general_if_invalid_channel => false) if channel_name != GENERAL_CHANNEL && notify_general_if_invalid_channel
+          raise("channel '#{channel_name}' not found on slack") if channel_name == GENERAL_CHANNEL || !notify_general_if_invalid_channel
 
-          raise("channel '#{channel_name}' not found on slack")
+          direct_message_unreachable_members(mentioned_members, nil, "Mentioned in *##{channel_name}* (channel not found):\n#{text}", bot_name)
+          text = "immosquare-slack missing channel *#{channel_name}*\nmessage:\n#{text}"
+          return post_message(text, :channel_name => GENERAL_CHANNEL, :notify => :channel, :notify_text => "", :bot_name => bot_name, :notify_general_if_invalid_channel => false)
         end
 
-        url               = "https://slack.com/api/chat.postMessage"
-        notification_text = notify ? build_notification_text(channel_id, notify, *notify_text) : nil
-        text              = "#{notification_text}#{text}"
-
-        body = {
-          :channel => channel_id,
-          :text    => text
-        }
-
-        body[:username] = bot_name if bot_name
-
-        make_slack_api_call(url, :method => :post, :body => body)
+        notification_text = notify ? build_notification_text(channel_id, notify, mentioned_members, *notify_text) : nil
+        response          = send_message(channel_id, "#{notification_text}#{text}", bot_name)
+        direct_message_unreachable_members(mentioned_members, channel_id, "Mentioned in <##{channel_id}>:\n#{text}", bot_name)
+        response
       end
 
       private
@@ -102,6 +103,54 @@ module ImmosquareSlack
         fetch_paginated_data("https://slack.com/api/conversations.members", "members", {:channel => channel_id})
       end
 
+      ##============================================================##
+      ## Posts `text` to a conversation: a channel id, or a user id
+      ## for a direct message from the bot.
+      ##============================================================##
+      def send_message(conversation_id, text, bot_name)
+        body = {
+          :channel => conversation_id,
+          :text    => text
+        }
+
+        body[:username] = bot_name if bot_name
+
+        make_slack_api_call("https://slack.com/api/chat.postMessage", :method => :post, :body => body)
+      end
+
+      ##============================================================##
+      ## Active workspace members whose `profile.email` is in
+      ## `emails`. Without the `users:read.email` scope no profile
+      ## carries an email, so nobody matches.
+      ##
+      ## Piège : `users.list` renvoie aussi les comptes désactivés,
+      ## qui gardent leur email mais ne peuvent recevoir aucun DM.
+      ##============================================================##
+      def members_with_emails(emails)
+        ImmosquareSlack::User.list_users.select {|m| !m["deleted"] && emails.include?(m.dig("profile", "email")) }
+      end
+
+      ##============================================================##
+      ## Sends `text` as a direct message to the mentioned members who
+      ## are not in the channel (`channel_id` nil: none of them is
+      ## reachable), since Slack would not notify them.
+      ##
+      ## Best effort : un DM refusé par Slack est ignoré. Le laisser
+      ## remonter ferait échouer `post_message` après le post dans le
+      ## channel (doublon au retry de l'appelant) ou avant le repli
+      ## sur general (message perdu).
+      ##============================================================##
+      def direct_message_unreachable_members(mentioned_members, channel_id, text, bot_name)
+        return if mentioned_members.empty? || !ImmosquareSlack.configuration.direct_message_unreachable_mentions
+
+        channel_member_ids = channel_id ? get_channel_members(channel_id) : []
+        mentioned_members.reject {|m| channel_member_ids.include?(m["id"]) }.each do |member|
+          send_message(member["id"], text, bot_name)
+        rescue RuntimeError
+          next
+        end
+      end
+
       ##============================================================##
       ## Builds the notification prefix prepended to the message
       ## body. `notify` may be:
@@ -112,12 +161,10 @@ module ImmosquareSlack
       ## Note: avoids `in?` and `present?` so the gem stays usable
       ## from plain Ruby (no Rails / ActiveSupport required).
       ##============================================================##
-      def build_notification_text(channel_id, notify, text = "Hello")
+      def build_notification_text(channel_id, notify, mentioned_members, text = "Hello")
         final =
           if notify.is_a?(Array)
-            members = ImmosquareSlack::User.list_users
-            members = members.select {|m| notify.include?(m["profile"]["email"]) }
-            members.map {|m| "<@#{m["id"]}>" }.join(", ")
+            mentioned_members.map {|m| "<@#{m["id"]}>" }.join(", ")
           elsif notify.to_sym == :all
             members = get_channel_members(channel_id)
             members.map {|m| "<@#{m}>" }.join(", ")

data/lib/immosquare-slack/configuration.rb

@@ -1,12 +1,13 @@
 module ImmosquareSlack
   class Configuration
 
-    attr_accessor :slack_api_token_bot, :default_channel, :default_bot_name
+    attr_accessor :slack_api_token_bot, :default_channel, :default_bot_name, :direct_message_unreachable_mentions
 
     def initialize
-      @slack_api_token_bot = nil
-      @default_channel     = nil
-      @default_bot_name    = nil
+      @slack_api_token_bot                 = nil
+      @default_channel                     = nil
+      @default_bot_name                    = nil
+      @direct_message_unreachable_mentions = true
     end
 
   end

data/lib/immosquare-slack/user.rb

@@ -1,6 +1,7 @@
 module ImmosquareSlack
   module User
     extend SharedMethods
+
     class << self
 
 

data/lib/immosquare-slack/version.rb

@@ -1,3 +1,3 @@
 module ImmosquareSlack
-  VERSION = "0.2.1".freeze
+  VERSION = "0.2.2".freeze
 end

data/lib/immosquare-slack.rb

@@ -4,15 +4,15 @@ require_relative "immosquare-slack/channel"
 require_relative "immosquare-slack/user"
 
 
-##===========================================================================##
-##
-##===========================================================================##
+##============================================================##
+## ...
+##============================================================##
 module ImmosquareSlack
   class << self
 
-    ##===========================================================================##
+    ##============================================================##
     ## Gem configuration
-    ##===========================================================================##
+    ##============================================================##
     attr_writer :configuration
 
     def configuration

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: immosquare-slack
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - immosquare
@@ -58,7 +58,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.12
+rubygems_version: 4.0.23
 specification_version: 4
 summary: A Ruby gem for integrating with Slack API to perform various actions like
   posting messages.