immosquare-slack 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 30900d7e5d44acbfd25f87836eea3f8e95458e06977ad7dc48db9f2d327f4dcf
+  data.tar.gz: 0fd10ae542118b73b92fb943cb509feddc4fb42812e82b1d8707234dc446eb1c
+SHA512:
+  metadata.gz: f6d89e11d26a10f08515915260ef442a5ab6164c75761695e78d87258024f601c72ebe903ecc11870802bf0c60205fa5f88b0f5aae9fa174356afe6e6f9707be
+  data.tar.gz: e21b4091ab55defe1fa6c2924a98e52c287b4befbb7eada3607c50b9c7d82474d1ff4fbb8e414b727baceadf1a0c07b68a170eb15b8c0d57ed1eb8fecc24f6f8

data/lib/immosquare-slack/channel.rb

@@ -0,0 +1,63 @@
+module ImmosquareSlack
+  module Channel
+    extend SharedMethods
+    class << self
+
+
+      ##============================================================##
+      ## Pour récupérer la liste des channels
+      ##============================================================##
+      def list_channels
+        fetch_paginated_data("https://slack.com/api/conversations.list", "channels")
+      end
+
+      ##============================================================##
+      ## Pour poster un message dans un channel
+      ##============================================================##
+      def post_message(channel_name, text, notify: false, bot_name: nil)
+        channel_id = get_channel_id_by_name(channel_name)
+        raise("Channel not found") if channel_id.nil?
+
+
+        url  = "https://slack.com/api/chat.postMessage"
+        body = {
+          :channel  => channel_id,
+          :text     => "#{build_notification_text(channel_id) if notify}#{text}",
+          :username => bot_name.presence
+        }
+        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
+      ##============================================================##
+      def get_channel_id_by_name(channel_name)
+        channels = list_channels
+        channel = channels.find {|c| c["name"] == channel_name }
+        channel ? channel["id"] : nil
+      end
+
+      ##============================================================##
+      ## Pour récupérer la liste des membres d'un 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
+      ##============================================================##
+      def build_notification_text(channel_id, text = "Hello")
+        members = get_channel_members(channel_id)
+        members = member_mentions = members.map {|member_id| "<@#{member_id}>" }
+        "#{text} #{member_mentions.join(", ")}\n"
+      end
+
+    end
+  end
+end

data/lib/immosquare-slack/configuration.rb

@@ -0,0 +1,11 @@
+module ImmosquareSlack
+  class Configuration
+
+    attr_accessor :slack_api_token_bot, :openai_model
+
+    def initialize
+      @slack_api_token_bot = nil
+    end
+
+  end
+end

data/lib/immosquare-slack/shared_methods.rb

@@ -0,0 +1,55 @@
+module ImmosquareSlack
+  module SharedMethods
+    private
+
+    ##============================================================##
+    ## On récupère tous les résultats avec une loop sur le cursor
+    ##============================================================##
+    def fetch_paginated_data(url, data_key, extra_query = {})
+      items  = []
+      cursor = nil
+
+      loop do
+        query = cursor ? {:cursor => cursor}.merge(extra_query) : extra_query
+        response = make_slack_api_call(url, :query => query)
+
+
+        items.concat(response[data_key])
+        cursor = response.dig("response_metadata", "next_cursor")
+        break if cursor.nil? || cursor.empty?
+      end
+      items
+    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.
+    ##============================================================##
+    def make_slack_api_call(url, method: :get, query: {}, body: nil)
+      options = {
+        :headers => {
+          "Authorization" => "Bearer #{ImmosquareSlack.configuration.slack_api_token_bot}",
+          "Content-Type"  => "application/json"
+        }
+      }
+
+      ##============================================================##
+      ## On crée les options en fonction du cas de figure
+      ##============================================================##
+      options[:query] = query if query.any?
+      options[:body]  = body.to_json if body
+
+      ##============================================================##
+      ## On send la requête et on parse la réponse
+      ##============================================================##
+      response        = HTTParty.send(method, url, options)
+      parsed_response = JSON.parse(response.body)
+      raise(parsed_response.to_json) unless parsed_response["ok"]
+
+      parsed_response
+    rescue JSON::ParserError
+      raise("Invalid JSON response")
+    end
+  end
+end

data/lib/immosquare-slack/user.rb

@@ -0,0 +1,13 @@
+module ImmosquareSlack
+  module User
+    extend SharedMethods
+    class << self
+
+
+      def list_users
+        fetch_paginated_data("https://slack.com/api/users.list", "members")
+      end
+
+    end
+  end
+end

data/lib/immosquare-slack/version.rb

@@ -0,0 +1,3 @@
+module ImmosquareSlack
+  VERSION = "0.1.0".freeze
+end

data/lib/immosquare-slack.rb

@@ -0,0 +1,29 @@
+require_relative "immosquare-slack/configuration"
+require_relative "immosquare-slack/shared_methods"
+require_relative "immosquare-slack/channel"
+require_relative "immosquare-slack/user"
+
+
+##===========================================================================##
+##
+##===========================================================================##
+module ImmosquareSlack
+  class << self
+
+    ##===========================================================================##
+    ## Gem configuration
+    ##===========================================================================##
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def config
+      yield(configuration)
+    end
+
+
+
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: immosquare-slack
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- IMMO SQUARE
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ImmosquareSlack is a Ruby gem that provides an easy and efficient way
+  to integrate Ruby applications with Slack. It leverages the Slack API to enable
+  functionalities such as posting messages, managing channels, and other Slack-related
+  operations. Designed for simplicity and ease of use, this gem is ideal for developers
+  looking to enhance their Ruby applications with Slack's communication capabilities.
+email:
+- jules@immosquare.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/immosquare-slack.rb
+- lib/immosquare-slack/channel.rb
+- lib/immosquare-slack/configuration.rb
+- lib/immosquare-slack/shared_methods.rb
+- lib/immosquare-slack/user.rb
+- lib/immosquare-slack/version.rb
+homepage: https://github.com/IMMOSQUARE/immosquare-slack
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.13
+signing_key:
+specification_version: 4
+summary: A Ruby gem for integrating with Slack API to perform various actions like
+  posting messages.
+test_files: []