slack-ruby-client 0.14.2 → 0.15.0

data/lib/slack.rb

@@ -1 +1,2 @@
+# frozen_string_literal: true
 require 'slack-ruby-client'

data/lib/slack/config.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Slack
   module Config
     extend self

data/lib/slack/events/config.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Slack
   module Events
     module Config

data/lib/slack/events/request.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Slack
   module Events
     class Request
@@ -12,7 +13,8 @@ module Slack
       def initialize(http_request, options = {})
         @http_request = http_request
         @signing_secret = options[:signing_secret] || Slack::Events.config.signing_secret
-        @signature_expires_in = options[:signature_expires_in] || Slack::Events.config.signature_expires_in
+        @signature_expires_in =
+          options[:signature_expires_in] || Slack::Events.config.signature_expires_in
       end
 
       # Request timestamp.

data/lib/slack/logger.rb

@@ -1,13 +1,14 @@
+# frozen_string_literal: true
 require 'logger'
 
 module Slack
   class Logger < ::Logger
     def self.default
-      @logger ||= begin
-        logger = new STDOUT
-        logger.level = Logger::WARN
-        logger
-      end
+      return @default if @default
+
+      logger = new STDOUT
+      logger.level = Logger::WARN
+      @default = logger
     end
   end
 end

data/lib/slack/messages/formatting.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Slack
   module Messages
     module Formatting

data/lib/slack/messages/message.rb

@@ -1,10 +1,7 @@
+# frozen_string_literal: true
 module Slack
   module Messages
     class Message < Hashie::Mash
-      def presence
-        super['presence']
-      end
-
       def to_s
         keys.sort_by(&:to_s).map do |key|
           "#{key}=#{self[key]}"

data/lib/slack/real_time/api/message.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Slack
   module RealTime
     module Api
@@ -6,7 +7,8 @@ module Slack
         # Sends a message to a channel.
         #
         # @option options [channel] :channel
-        #   Channel to send message to. Can be a public channel, private group or IM channel. Can be an encoded ID, or a name.
+        #   Channel to send message to. Can be a public channel, private group or IM channel.
+        #   Can be an encoded ID, or a name.
         # @option options [Object] :text
         #   Text of the message to send. See below for an explanation of formatting.
         def message(options = {})

data/lib/slack/real_time/api/message_id.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Slack
   module RealTime
     module Api

data/lib/slack/real_time/api/ping.rb

@@ -1,10 +1,13 @@
+# frozen_string_literal: true
 module Slack
   module RealTime
     module Api
       module Ping
         #
-        # Clients should try to quickly detect disconnections, even in idle periods, so that users can easily tell the
-        # difference between being disconnected and everyone being quiet. Not all web browsers support the WebSocket
+        # Clients should try to quickly detect disconnections, even in idle periods, so that users
+        # can easily tell the
+        # difference between being disconnected and everyone being quiet. Not all web browsers
+        # support the WebSocket
         # ping spec, so the RTM protocol also supports ping/pong messages.
         #
         def ping(options = {})

data/lib/slack/real_time/api/typing.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Slack
   module RealTime
     module Api
@@ -6,7 +7,8 @@ module Slack
         # Send a typing indicator to indicate that the user is currently writing a message.
         #
         # @option options [channel] :channel
-        #   Channel to send message to. Can be a public channel, private group or IM channel. Can be an encoded ID, or a name.
+        #   Channel to send message to. Can be a public channel, private group or IM channel.
+        #   Can be an encoded ID, or a name.
         def typing(options = {})
           throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
           send_json({ type: 'typing', id: next_id }.merge(options))

data/lib/slack/real_time/client.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Slack
   module RealTime
     class Client
@@ -19,8 +20,8 @@ module Slack
       attr_accessor :store
       attr_accessor :url
       attr_accessor(*Config::ATTRIBUTES)
+      attr_accessor :logger
 
-      protected :logger, :logger=
       protected :store_class, :store_class=
 
       def initialize(options = {})
@@ -35,7 +36,7 @@ module Slack
 
       %i[users self channels team teams groups ims bots].each do |store_method|
         define_method store_method do
-          store.send(store_method) if store
+          store&.send(store_method)
         end
       end
 
@@ -62,11 +63,11 @@ module Slack
       def stop!
         raise ClientNotStartedError unless started?
 
-        @socket.disconnect! if @socket
+        @socket&.disconnect!
       end
 
       def started?
-        @socket && @socket.connected?
+        @socket&.connected?
       end
 
       class << self
@@ -82,25 +83,25 @@ module Slack
       def run_loop
         @socket.connect! do |driver|
           driver.on :open do |event|
-            logger.debug("#{self.class}##{__method__}") { event.class.name }
-            open(event)
+            logger.debug("#{self}##{__method__}") { event.class.name }
+            open_event(event)
             callback(event, :open)
           end
 
           driver.on :message do |event|
-            logger.debug("#{self.class}##{__method__}") { "#{event.class}, #{event.data}" }
+            logger.debug("#{self}##{__method__}") { "#{event.class}, #{event.data}" }
             dispatch(event)
           end
 
           driver.on :close do |event|
-            logger.debug("#{self.class}##{__method__}") { event.class.name }
+            logger.debug("#{self}##{__method__}") { event.class.name }
             callback(event, :close)
             close(event)
             callback(event, :closed)
           end
 
           # This must be called last to ensure any events are registered before invoking user code.
-          @callback.call(driver) if @callback
+          @callback&.call(driver)
         end
       end
 
@@ -127,17 +128,42 @@ module Slack
       def run_ping!
         return if keep_alive?
 
+        logger.warn(to_s) { 'is offline' }
+
         restart_async
+      rescue Slack::Web::Api::Errors::SlackError => e
+        # stop pinging if bot was uninstalled
+        case e.message
+        when 'account_inactive', 'invalid_auth' then
+          logger.warn(to_s) { e.message }
+          raise e
+        end
+        logger.debug("#{self}##{__method__}") { e }
+      rescue StandardError => e
+        # disregard all ping worker failures, keep pinging
+        logger.debug("#{self}##{__method__}") { e }
       end
 
       def run_ping?
-        !websocket_ping.nil? && websocket_ping > 0
+        !websocket_ping.nil? && websocket_ping.positive?
+      end
+
+      def websocket_ping_timer
+        websocket_ping / 2
+      end
+
+      def to_s
+        if store&.team
+          "id=#{store.team.id}, name=#{store.team.name}, domain=#{store.team.domain}"
+        else
+          super
+        end
       end
 
       protected
 
       def restart_async
-        logger.debug("#{self.class}##{__method__}")
+        logger.debug("#{self}##{__method__}")
         @socket.close
         start = web_client.send(rtm_start_method, start_options)
         data = Slack::Messages::Message.new(start)
@@ -183,11 +209,11 @@ module Slack
       def send_json(data)
         raise ClientNotStartedError unless started?
 
-        logger.debug("#{self.class}##{__method__}") { data }
+        logger.debug("#{self}##{__method__}") { data }
         @socket.send_data(data.to_json)
       end
 
-      def open(_event); end
+      def open_event(_event); end
 
       def close(_event)
         [@socket, socket_class].each do |s|
@@ -204,7 +230,7 @@ module Slack
         end
         true
       rescue StandardError => e
-        logger.error e
+        logger.error("#{self}##{__method__}") { e }
         false
       end
 
@@ -216,23 +242,21 @@ module Slack
         return false unless type
 
         type = type.to_s
-        logger.debug("#{self.class}##{__method__}") { data.to_s }
+        logger.debug("#{self}##{__method__}") { data.to_s }
         run_handlers(type, data) if @store
         run_callbacks(type, data)
       rescue StandardError => e
-        logger.error e
+        logger.error("#{self}##{__method__}") { e }
         false
       end
 
       def run_handlers(type, data)
         handlers = store.class.events[type.to_s]
-        if handlers
-          handlers.each do |handler|
-            store.instance_exec(data, &handler)
-          end
+        handlers&.each do |handler|
+          store.instance_exec(data, &handler)
         end
       rescue StandardError => e
-        logger.error e
+        logger.error("#{self}##{__method__}") { e }
         false
       end
 
@@ -245,7 +269,7 @@ module Slack
         end
         true
       rescue StandardError => e
-        logger.error e
+        logger.error("#{self}##{__method__}") { e }
         false
       end
     end

data/lib/slack/real_time/concurrency.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Slack
   module RealTime
     module Concurrency

data/lib/slack/real_time/concurrency/async.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'async/websocket'
 require 'async/notification'
 require 'async/clock'
@@ -30,33 +31,34 @@ module Slack
 
               if client.run_ping?
                 @ping_task = task.async do |subtask|
-                  subtask.annotate 'client keep-alive'
+                  subtask.annotate "#{client} keep-alive"
 
                   # The timer task will naturally exit after the driver is set to nil.
                   while @restart
-                    subtask.sleep client.websocket_ping
+                    subtask.sleep client.websocket_ping_timer
                     client.run_ping! if @restart
                   end
                 end
               end
 
               while @restart
-                @client_task.stop if @client_task
+                @client_task&.stop
 
                 @client_task = task.async do |subtask|
                   begin
-                    subtask.annotate 'client run-loop'
+                    subtask.annotate "#{client} run-loop"
                     client.run_loop
                   rescue ::Async::Wrapper::Cancelled => e
                     # Will get restarted by ping worker.
-                    client.logger.warn(subtask.to_s) { e.message }
+                  rescue StandardError => e
+                    client.logger.error(subtask.to_s) { e.message }
                   end
                 end
 
                 @restart.wait
               end
 
-              @ping_task.stop if @ping_task
+              @ping_task&.stop
             end
           end
 
@@ -64,7 +66,7 @@ module Slack
             @url = new_url
             @last_message_at = current_time
 
-            @restart.signal if @restart
+            @restart&.signal
           end
 
           def current_time
@@ -80,7 +82,7 @@ module Slack
           def disconnect!
             super
           ensure
-            if restart = @restart
+            if (restart = @restart)
               @restart = nil
               restart.signal
             end
@@ -97,7 +99,7 @@ module Slack
           end
 
           def run_loop
-            while @driver && @driver.next_event
+            while @driver&.next_event
               # $stderr.puts event.inspect
             end
           end
@@ -129,3 +131,10 @@ module Slack
     end
   end
 end
+
+if Gem::Version.new(Async::WebSocket::VERSION) >= Gem::Version.new('0.9.0')
+  raise(
+    "Incompatible version of async-websocket, #{Async::WebSocket::VERSION}, " \
+    "use \"gem 'async-websocket', '~> 0.8.0'\"."
+  )
+end

data/lib/slack/real_time/concurrency/celluloid.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'websocket/driver'
 require 'socket'
 require 'forwardable'
@@ -36,12 +37,17 @@ module Slack
             loop { read } if socket
           rescue EOFError, Errno::ECONNRESET, Errno::EPIPE => e
             logger.debug("#{self.class}##{__method__}") { e }
-            driver.emit(:close, WebSocket::Driver::CloseEvent.new(1001, 'server closed connection')) unless @closing
+            unless @closing
+              driver.emit(
+                :close,
+                WebSocket::Driver::CloseEvent.new(1001, 'server closed connection')
+              )
+            end
           end
 
           def disconnect!
             super
-            @ping_timer.cancel if @ping_timer
+            @ping_timer&.cancel
           end
 
           def close
@@ -58,7 +64,7 @@ module Slack
 
           def handle_read(buffer)
             logger.debug("#{self.class}##{__method__}") { buffer }
-            driver.parse buffer if driver
+            driver&.parse buffer
           end
 
           def write(data)
@@ -82,7 +88,7 @@ module Slack
           def run_ping_loop
             return unless @client.run_ping?
 
-            @ping_timer = every @client.websocket_ping do
+            @ping_timer = every @client.websocket_ping_timer do
               @client.run_ping!
             end
           end

data/lib/slack/real_time/concurrency/eventmachine.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'faye/websocket'
 require 'eventmachine'
 
@@ -6,12 +7,10 @@ module Slack
     module Concurrency
       module Eventmachine
         class Client < Faye::WebSocket::Client
-          attr_reader :logger
-          protected :logger
-
           def initialize(url, protocols = nil, options = {})
-            @logger = options.fetch(:logger) || Slack::RealTime::Config.logger || Slack::Config.logger
-            super url, protocols, options.except(:logger)
+            options = options.dup
+            @logger = options.delete(:logger) || Slack::RealTime::Config.logger || Slack::Config.logger
+            super url, protocols, options
           end
 
           def parse(data)
@@ -23,6 +22,10 @@ module Slack
             logger.debug("#{self.class}##{__method__}") { data }
             super data
           end
+
+          protected
+
+          attr_reader :logger
         end
 
         class Socket < Slack::RealTime::Socket
@@ -30,7 +33,7 @@ module Slack
             @thread = ensure_reactor_running
 
             if client.run_ping?
-              EventMachine.add_periodic_timer(client.websocket_ping) do
+              EventMachine.add_periodic_timer client.websocket_ping_timer do
                 client.run_ping!
               end
             end