immosquare-slack 0.1.6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f225c081bd5414be15eb18de6283012de0a0763266aa7ad69df66bb42a09104
-  data.tar.gz: 576e4573f9cd77b62ee364231f21e1ba38e00367d7f2bd4da567fa36b1ffb4f2
+  metadata.gz: 622166a109e7d56741e24a45e19fb139940e467aaa93713fdbf9ee57800f8d00
+  data.tar.gz: a7603ceee1e8467dd39b48441b201a5fea6938a3a5a3308bf7855066cdce8059
 SHA512:
-  metadata.gz: 180c9241ecb12c5784a9d287087f37ef22fc58f1126e48107d51dcbeb92dc17efe769fdab3d1fae19f083d1c6e88bc26bab4712d09e3650543933eb14adf0714
-  data.tar.gz: 6b3cbd7e068f7d0cc3575c3403104c739e18a167d02549be2c11c2f0a9daa770a4df218671b3f0edb527237ee49d2faee46cfd7892536ad42257fd90269743a9
+  metadata.gz: cd8138d1bca5e66c75777ccdee7752c8530fa38ae5aa0e8c737679a25994927274fe6eb87c5840ca936c77d5a562c5d74836f86b665e233a6a66b50fd901e495
+  data.tar.gz: 3db28b76da6504ef0b8ee7f99309342b860071430ec32843fc886063cf59ffaa117fe4fedfffc252c010a62607a40580dd4f4688784fecb120973155cc790120

data/lib/immosquare-slack/channel.rb

@@ -1,10 +1,15 @@
 module ImmosquareSlack
   module Channel
     extend SharedMethods
+
+    GENERAL_CHANNEL = "general".freeze
+
     class << self
 
       ##============================================================##
-      ## Pour récupérer la liste des channels
+      ## Fetches the list of channels (public + private, including
+      ## archived). Memoized per process — call sites that need a
+      ## fresh list should reset @list_channels explicitly.
       ##============================================================##
       def list_channels
         @list_channels ||= begin
@@ -17,14 +22,29 @@ module ImmosquareSlack
       end
 
       ##============================================================##
-      ## Pour poster un message dans un channel
+      ## Posts a message to a channel.
+      ##
+      ## `channel_name` and `bot_name` are optional keyword args:
+      ## if nil, they fall back to the global config
+      ## `ImmosquareSlack.configuration.default_channel` and
+      ## `default_bot_name`. Lets apps that always notify the same
+      ## channel avoid repeating the value at every call site.
+      ##
+      ## If no channel can be resolved after fallback, raises an
+      ## ArgumentError immediately (clearer than the cryptic error
+      ## returned by the Slack API).
       ##============================================================##
-      def post_message(channel_name, text, notify: nil, notify_text: nil, bot_name: nil, notify_general_if_invalid_channel: true)
+      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
+        bot_name     ||= ImmosquareSlack.configuration.default_bot_name
+
+        raise(ArgumentError, "channel_name is required (or set ImmosquareSlack.configuration.default_channel)") if channel_name.nil?
+
         channel_id = get_channel_id_by_name(channel_name)
 
         if channel_id.nil?
           text = "immosquare-slack missing channel *#{channel_name}*\nmessage:\n#{text}"
-          return post_message("general", text, :notify => :channel, :notify_text => "", :bot_name => bot_name, :notify_general_if_invalid_channel => false) if channel_name != "general" && notify_general_if_invalid_channel
+          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")
         end
@@ -43,32 +63,41 @@ module ImmosquareSlack
         make_slack_api_call(url, :method => :post, :body => body)
       end
 
-
-
       private
 
       ##============================================================##
-      ## Pour récupérer l'id d'un channel en fonction de son nom
+      ## Resolves a channel id from its name. "general" is matched
+      ## via the `is_general` flag because workspaces can rename
+      ## their general channel.
       ##============================================================##
       def get_channel_id_by_name(channel_name)
         channels = list_channels
-        channel  = channels.find {|c| channel_name == "general" ? c["is_general"] == true : (c["name"] == channel_name && c["is_archived"] == false) }
-        channel.present? ? channel["id"] : nil
+        channel  = channels.find do |c|
+          if channel_name == GENERAL_CHANNEL
+            c["is_general"]
+          else
+            c["name"] == channel_name && c["is_archived"] == false
+          end
+        end
+        channel.nil? ? nil : channel["id"]
       end
 
       ##============================================================##
-      ## Pour récupérer la liste des membres d'un channel
+      ## Fetches the list of members of a channel.
       ##============================================================##
       def get_channel_members(channel_id)
         fetch_paginated_data("https://slack.com/api/conversations.members", "members", {:channel => channel_id})
       end
 
       ##============================================================##
-      ## Méthode récupérant les membres d'un channel et les notifier
-      ## sur le message
-      ## on ne peut pas utilser in? si on veut que la gem soit
-      ## compatible avec ruby (sans rails)
-      ## pareil pour present?
+      ## Builds the notification prefix prepended to the message
+      ## body. `notify` may be:
+      ##   - an Array of emails: mentions matching workspace members
+      ##   - :all                : mentions every member of the channel
+      ##   - :channel/:here/:everyone : Slack-wide broadcast tokens
+      ##
+      ## 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")
         final =
@@ -87,8 +116,9 @@ module ImmosquareSlack
             "<!everyone>"
           end
 
+        return nil if final.to_s.empty?
 
-        "#{text} #{final}\n" if !final.to_s.empty?
+        text.empty? ? "#{final}\n" : "#{text} #{final}\n"
       end
 
     end

data/lib/immosquare-slack/configuration.rb

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

data/lib/immosquare-slack/shared_methods.rb

@@ -6,7 +6,7 @@ module ImmosquareSlack
     private
 
     ##============================================================##
-    ## On récupère tous les résultats avec une loop sur le cursor
+    ## Fetches all results by looping on the Slack API cursor.
     ##============================================================##
     def fetch_paginated_data(url, data_key, extra_query = {})
       items  = []
@@ -24,9 +24,9 @@ module ImmosquareSlack
     end
 
     ##============================================================##
-    ## On fait le call à l'API Slack. On raise le message entier
-    ## en string si la réponse n'est pas "ok" ou si la réponse
-    ## n'est pas un JSON valide.
+    ## Calls the Slack API. Raises the full response body as a
+    ## string if the response is not "ok" or if the body is not
+    ## valid JSON.
     ##============================================================##
     def make_slack_api_call(url, method: :get, query: {}, body: nil)
       options = {
@@ -37,15 +37,15 @@ module ImmosquareSlack
       }
 
       ##============================================================##
-      ## On crée les options en fonction du cas de figure
+      ## Builds the request options based on the call type.
       ##============================================================##
       options[:query] = query        if query.any?
       options[:body]  = body.to_json if body
 
       ##============================================================##
-      ## On send la requête et on parse la réponse
+      ## Sends the request and parses the response.
       ##============================================================##
-      response        = HTTParty.send(method, url, options)
+      response        = HTTParty.public_send(method, url, options)
       parsed_response = JSON.parse(response.body)
       raise(parsed_response.to_json) if !parsed_response["ok"]
 

data/lib/immosquare-slack/version.rb

@@ -1,3 +1,3 @@
 module ImmosquareSlack
-  VERSION = "0.1.6".freeze
+  VERSION = "0.2.0".freeze
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: immosquare-slack
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
 platform: ruby
 authors:
 - immosquare
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-11 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -45,7 +44,6 @@ homepage: https://github.com/immosquare/immosquare-slack
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -53,15 +51,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.2
+      version: 3.2.6
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 4.0.12
 specification_version: 4
 summary: A Ruby gem for integrating with Slack API to perform various actions like
   posting messages.