slack-ruby-socket-mode-bot 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d9b476cbef5846c666a7ab994c514f998f870d2004b1d2b0f3ff6c053e4c8f0
-  data.tar.gz: 46d7af96360646c78325592dcf4e5d4ba26ec5f6f776948e387f1d907eb0b96b
+  metadata.gz: ad18066a5a94aeb5eafd67bd14a67fe3dc0f6220b1efeefbe46b755671205247
+  data.tar.gz: e2aba7056fc4ffe2180a4f3a8941313457adb87e055bd344f97f88a6b64f912c
 SHA512:
-  metadata.gz: c696e7a8826e208174474dbcdfa03a242e8828a9de4b50e1add4ee3604180bc5080dc0ed45058f7978a2dcf494c7ac96d031f32c65aba702c4d283c5b2aad3e4
-  data.tar.gz: a60f162cf935ede9f7f08474ec8a3401b3493843207855611acf60b46965f886ec0cb2fb169206a17daa7f6ba353af131a72a3eaf3f1353ee6bfde5bd3c5cf30
+  metadata.gz: 044e1076b5f27b68912fc6af4b08ee27edc3e45207c838d2594abe0c9305187d183dfbd96f6d86fb9dd3f0982811cbc256a75bef2c7834ea379d9600a99f7061
+  data.tar.gz: cc151aee374edf16b835f4c8b0167db94d68426f93c5319b731928a0df511b0dc720d06974b41e5de93ba8e8f09febcd4cc3f3eeb52b1a1a5811f13cb40c323d

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 3.3
+  TargetRubyVersion: 3.2
 
 Style/StringLiterals:
   EnforcedStyle: double_quotes

data/README.md

@@ -1,5 +1,8 @@
 # slack-ruby-socket-mode-bot
 
+[![Gem Version](https://badge.fury.io/rb/slack-ruby-socket-mode-bot.svg)](https://badge.fury.io/rb/slack-ruby-socket-mode-bot)
+[![Tests](https://github.com/guille/slack-socket-mode-bot/actions/workflows/main.yml/badge.svg)](https://github.com/guille/slack-socket-mode-bot/actions/workflows/main.yml)
+
 This gem allows users to create Slack bots that respond to mentions. This gem only supports events-based [socket mode](https://api.slack.com/apis/socket-mode) bots. The gem allows registering a number of callbacks that will be executed if the registered regular expression matches the mention text.
 
 See the [examples](https://github.com/guille/slack-socket-mode-bot/blob/master/examples) directory for some ideas on how to use the gem.

data/lib/bot/bot.rb

@@ -3,6 +3,8 @@
 module SlackSocketModeBot
   MentionHandler = Data.define(:match_regex, :callback)
 
+  # Entry class for the gem, allows registering callbacks that will be triggered
+  # when the bot is mentioned
   class Bot
     def initialize(bot_token:, app_token:, logger: nil)
       @bot_token = bot_token
@@ -27,10 +29,7 @@ module SlackSocketModeBot
     private
 
     def slack_web_client
-      client = Slack::Web::Client.new(
-        token: @bot_token,
-        logger: @logger
-      )
+      client = Slack::Web::Client.new(token: @bot_token)
       auth_response = client.auth_test
 
       raise auth_response unless auth_response[:ok]

data/lib/transport/socket_mode_client.rb

@@ -2,6 +2,8 @@
 
 module SlackSocketModeBot
   module Transport
+    # Client responsible for instantiating a WebSocket,
+    # as well as providing a connection URL and a callback method
     class SocketModeClient
       def initialize(app_token:, callback:, logger: nil)
         @app_token = app_token
@@ -20,9 +22,11 @@ module SlackSocketModeBot
 
         raise response unless response[:ok]
 
-        response[:url]
-        # debug only:
-        "#{response[:url]}&debug_reconnects=true"
+        if ENV.fetch("ENVIRONMENT", "production").casecmp?("development")
+          "#{response[:url]}&debug_reconnects=true"
+        else
+          response[:url]
+        end
       end
 
       def callback(*args)
@@ -32,10 +36,7 @@ module SlackSocketModeBot
       private
 
       def slack_web_client
-        client = Slack::Web::Client.new(
-          token: @app_token,
-          logger: @logger
-        )
+        client = Slack::Web::Client.new(token: @app_token)
         @slack_web_client ||= client
       end
     end

data/lib/transport/websocket.rb

@@ -2,6 +2,10 @@
 
 module SlackSocketModeBot
   module Transport
+    # This class heavily leverages async and async-websocket to keep a connection alive to the
+    # URL provided by the client
+    # It will perform as expected for a Slack Socket Mode client: acknowledge all events and refresh when needed
+    # Moreover it will use the client's callback for processing events
     class WebSocket
       attr_reader :client
 
@@ -13,6 +17,7 @@ module SlackSocketModeBot
         @ping_id = 1
       end
 
+      # rubocop:disable Metrics
       def connect!
         Async do |task|
           trap_sigterm(task)
@@ -51,6 +56,7 @@ module SlackSocketModeBot
         @ping_task&.stop
         @socket_task&.stop
       end
+      # rubocop:enable Metrics
 
       private
 

data/lib/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SlackSocketModeBot
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack-ruby-socket-mode-bot
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - guille
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-26 00:00:00.000000000 Z
+date: 2024-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: async-http
+  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'
 - !ruby/object:Gem::Dependency
   name: async-websocket
   requirement: !ruby/object:Gem::Requirement
@@ -52,10 +66,11 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: This gem allows users to create Slack bots that respond to mentions.
-  This gem only supports events-based socket mode bots. The gem allows registering
-  a number of callbacks that will be executed if the registered regular expression
-  matches the mention text.
+description: |
+  This gem allows users to create Slack bots that respond to mentions.
+  This gem only supports events-based socket mode bots.
+  The gem allows registering a number of callbacks that will be executed
+  if the registered regular expression matches the mention text.
 email:
 - guille@users.noreply.github.com
 executables: []
@@ -88,7 +103,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="