slack-ruby-client 0.14.1 → 0.14.2

data/bin/commands/usergroups_users.rb

@@ -2,8 +2,8 @@
 
 desc 'UsergroupsUsers methods.'
 command 'usergroups_users' do |g|
-  g.desc 'List all users in a User Group'
-  g.long_desc %( List all users in a User Group )
+  g.desc 'This method returns a list of all users within a User Group.'
+  g.long_desc %( This method returns a list of all users within a User Group. )
   g.command 'list' do |c|
     c.flag 'usergroup', desc: 'The encoded ID of the User Group to update.'
     c.flag 'include_disabled', desc: 'Allow results that involve disabled User Groups.'
@@ -12,8 +12,8 @@ command 'usergroups_users' do |g|
     end
   end
 
-  g.desc 'Update the list of users for a User Group'
-  g.long_desc %( Update the list of users for a User Group )
+  g.desc 'This method updates the list of users that belong to a User Group. This method replaces all users in a User Group with the list of users provided in the users parameter.'
+  g.long_desc %( This method updates the list of users that belong to a User Group. This method replaces all users in a User Group with the list of users provided in the users parameter. )
   g.command 'update' do |c|
     c.flag 'usergroup', desc: 'The encoded ID of the User Group to update.'
     c.flag 'users', desc: 'A comma separated string of encoded user IDs that represent the entire list of users for the User Group.'

data/bin/commands/users.rb

@@ -1,9 +1,9 @@
 # This file was auto-generated by lib/tasks/web.rake
 
-desc 'Get info on members of your Slack team.'
+desc 'Users methods.'
 command 'users' do |g|
-  g.desc 'List conversations the calling user may access.'
-  g.long_desc %( List conversations the calling user may access. )
+  g.desc "As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed."
+  g.long_desc %( As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed. )
   g.command 'conversations' do |c|
     c.flag 'cursor', desc: "Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first 'page' of the collection. See pagination for more detail."
     c.flag 'exclude_archived', desc: 'Set to true to exclude archived channels from the list.'
@@ -15,16 +15,16 @@ command 'users' do |g|
     end
   end
 
-  g.desc 'Delete the user profile photo'
-  g.long_desc %( Delete the user profile photo )
+  g.desc 'This method allows the user to delete their profile image. It will clear whatever image is currently set.'
+  g.long_desc %( This method allows the user to delete their profile image. It will clear whatever image is currently set. )
   g.command 'deletePhoto' do |c|
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.users_deletePhoto(options))
     end
   end
 
-  g.desc 'Gets user presence information.'
-  g.long_desc %( Gets user presence information. )
+  g.desc "This method lets you find out information about a user's presence."
+  g.long_desc %( This method lets you find out information about a user's presence. Consult the presence documentation for more details. )
   g.command 'getPresence' do |c|
     c.flag 'user', desc: 'User to get presence info on. Defaults to the authed user.'
     c.action do |_global_options, options, _args|
@@ -41,16 +41,16 @@ command 'users' do |g|
     end
   end
 
-  g.desc "Get a user's identity."
-  g.long_desc %( Get a user's identity. )
+  g.desc "After your Slack app is awarded an identity token through Sign in with Slack, use this method to retrieve a user's identity."
+  g.long_desc %( After your Slack app is awarded an identity token through Sign in with Slack, use this method to retrieve a user's identity. )
   g.command 'identity' do |c|
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.users_identity(options))
     end
   end
 
-  g.desc 'Gets information about a user.'
-  g.long_desc %( Gets information about a user. )
+  g.desc 'This method returns information about a member of a workspace.'
+  g.long_desc %( This method returns information about a member of a workspace. )
   g.command 'info' do |c|
     c.flag 'user', desc: 'User to get info on.'
     c.flag 'include_locale', desc: 'Set this to true to receive the locale for this user. Defaults to false.'
@@ -59,20 +59,19 @@ command 'users' do |g|
     end
   end
 
-  g.desc 'Lists all users in a Slack team.'
-  g.long_desc %( Lists all users in a Slack team. )
+  g.desc 'This method returns a list of all users in the workspace. This includes deleted/deactivated users.'
+  g.long_desc %( This method returns a list of all users in the workspace. This includes deleted/deactivated users. )
   g.command 'list' do |c|
     c.flag 'cursor', desc: "Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first 'page' of the collection. See pagination for more detail."
     c.flag 'include_locale', desc: 'Set this to true to receive the locale for users. Defaults to false.'
     c.flag 'limit', desc: "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached."
-    c.flag 'presence', desc: 'Deprecated. Whether to include presence data in the output. Defaults to false. Setting this to true reduces performance, especially with large teams.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.users_list(options))
     end
   end
 
-  g.desc 'Find a user with an email address.'
-  g.long_desc %( Find a user with an email address. )
+  g.desc 'Retrieve a single user by looking them up by their registered email address. Requires users:read.email.'
+  g.long_desc %( Retrieve a single user by looking them up by their registered email address. Requires users:read.email. )
   g.command 'lookupByEmail' do |c|
     c.flag 'email', desc: 'An email address belonging to a user in the workspace.'
     c.action do |_global_options, options, _args|
@@ -89,16 +88,16 @@ command 'users' do |g|
     end
   end
 
-  g.desc 'Marked a user as active. Deprecated and non-functional.'
-  g.long_desc %( Marked a user as active. Deprecated and non-functional. )
+  g.desc 'This method is no longer functional and the behavior it controlled is no longer offered. The method will no longer exist beginning May 8, 2018.'
+  g.long_desc %( This method is no longer functional and the behavior it controlled is no longer offered. The method will no longer exist beginning May 8, 2018. )
   g.command 'setActive' do |c|
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.users_setActive(options))
     end
   end
 
-  g.desc 'Set the user profile photo'
-  g.long_desc %( Set the user profile photo )
+  g.desc 'This method allows the user to set their profile image. The caller can pass image data via image.'
+  g.long_desc %( This method allows the user to set their profile image. The caller can pass image data via image. )
   g.command 'setPhoto' do |c|
     c.flag 'image', desc: 'File contents via multipart/form-data.'
     c.flag 'crop_w', desc: 'Width/height of crop box (always square).'
@@ -109,8 +108,8 @@ command 'users' do |g|
     end
   end
 
-  g.desc 'Manually sets user presence.'
-  g.long_desc %( Manually sets user presence. )
+  g.desc "This method lets you set the calling user's manual presence."
+  g.long_desc %( This method lets you set the calling user's manual presence. Consult the presence documentation for more details. )
   g.command 'setPresence' do |c|
     c.flag 'presence', desc: 'Either auto or away.'
     c.action do |_global_options, options, _args|

data/bin/commands/users_profile.rb

@@ -2,8 +2,8 @@
 
 desc 'UsersProfile methods.'
 command 'users_profile' do |g|
-  g.desc "Retrieves a user's profile information."
-  g.long_desc %( Retrieves a user's profile information. )
+  g.desc "Use this method to retrieve a user's profile information."
+  g.long_desc %( Use this method to retrieve a user's profile information. )
   g.command 'get' do |c|
     c.flag 'include_labels', desc: 'Include labels for each ID in custom profile fields.'
     c.flag 'user', desc: 'User to retrieve profile info for.'
@@ -12,8 +12,8 @@ command 'users_profile' do |g|
     end
   end
 
-  g.desc 'Set the profile information for a user.'
-  g.long_desc %( Set the profile information for a user. )
+  g.desc "Use this method to set a user's profile information, including name, email, current status, and other attributes."
+  g.long_desc %( Use this method to set a user's profile information, including name, email, current status, and other attributes. )
   g.command 'set' do |c|
     c.flag 'name', desc: 'Name of a single key to set. Usable only if profile is not passed.'
     c.flag 'profile', desc: 'Collection of key:value pairs presented as a URL-encoded JSON hash. At most 50 fields may be set. Each field name is limited to 255 characters.'

data/lib/slack/events/request.rb

@@ -5,10 +5,14 @@ module Slack
       class TimestampExpired < StandardError; end
       class InvalidSignature < StandardError; end
 
-      attr_reader :http_request
+      attr_reader :http_request,
+                  :signing_secret,
+                  :signature_expires_in
 
-      def initialize(http_request)
+      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
       end
 
       # Request timestamp.
@@ -34,16 +38,16 @@ module Slack
 
       # Returns true if the signature coming from Slack has expired.
       def expired?
-        timestamp.nil? || (Time.now.to_i - timestamp.to_i).abs > Slack::Events.config.signature_expires_in
+        timestamp.nil? || (Time.now.to_i - timestamp.to_i).abs > signature_expires_in
       end
 
       # Returns true if the signature coming from Slack is valid.
       def valid?
-        raise MissingSigningSecret unless Slack::Events.config.signing_secret
+        raise MissingSigningSecret unless signing_secret
 
         digest = OpenSSL::Digest::SHA256.new
         signature_basestring = [version, timestamp, body].join(':')
-        hex_hash = OpenSSL::HMAC.hexdigest(digest, Slack::Events.config.signing_secret, signature_basestring)
+        hex_hash = OpenSSL::HMAC.hexdigest(digest, signing_secret, signature_basestring)
         computed_signature = [version, hex_hash].join('=')
         computed_signature == signature
       end

data/lib/slack/real_time/client.rb

@@ -81,8 +81,6 @@ module Slack
 
       def run_loop
         @socket.connect! do |driver|
-          @callback.call(driver) if @callback
-
           driver.on :open do |event|
             logger.debug("#{self.class}##{__method__}") { event.class.name }
             open(event)
@@ -100,16 +98,35 @@ module Slack
             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
         end
       end
 
-      def run_ping!
+      # Ensure the server is running, and ping the remote server if no other messages were sent.
+      def keep_alive?
+        # We can't ping the remote server if we aren't connected.
+        return false if @socket.nil? || !@socket.connected?
+
         time_since_last_message = @socket.time_since_last_message
-        return if time_since_last_message < websocket_ping
-        raise Slack::RealTime::Client::ClientNotStartedError if !@socket.connected? || time_since_last_message > (websocket_ping * 2)
 
+        # If the server responded within the specified time, we are okay:
+        return true if time_since_last_message < websocket_ping
+
+        # If the server has not responded for a while:
+        return false if time_since_last_message > (websocket_ping * 2)
+
+        # Kick off the next ping message:
         ping
-      rescue Slack::RealTime::Client::ClientNotStartedError
+
+        true
+      end
+
+      # Check if the remote server is responsive, and if not, restart the connection.
+      def run_ping!
+        return if keep_alive?
+
         restart_async
       end
 

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

@@ -1,14 +1,11 @@
 require 'async/websocket'
+require 'async/notification'
 require 'async/clock'
 
 module Slack
   module RealTime
     module Concurrency
       module Async
-        class Reactor < ::Async::Reactor
-          def_delegators :@timers, :cancel
-        end
-
         class Client < ::Async::WebSocket::Client
           extend ::Forwardable
           def_delegators :@driver, :on, :text, :binary, :emit
@@ -17,35 +14,57 @@ module Slack
         class Socket < Slack::RealTime::Socket
           attr_reader :client
 
+          def start_sync(client)
+            start_reactor(client).wait
+          end
+
           def start_async(client)
-            @reactor = Reactor.new
             Thread.new do
+              start_reactor(client)
+            end
+          end
+
+          def start_reactor(client)
+            Async do |task|
+              @restart = ::Async::Notification.new
+
               if client.run_ping?
-                @reactor.every(client.websocket_ping) do
-                  client.run_ping!
+                @ping_task = task.async do |subtask|
+                  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
+                    client.run_ping! if @restart
+                  end
                 end
               end
-              @reactor.run do |task|
-                task.async do
-                  client.run_loop
+
+              while @restart
+                @client_task.stop if @client_task
+
+                @client_task = task.async do |subtask|
+                  begin
+                    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 }
+                  end
                 end
+
+                @restart.wait
               end
+
+              @ping_task.stop if @ping_task
             end
           end
 
-          def restart_async(client, new_url)
+          def restart_async(_client, new_url)
             @url = new_url
             @last_message_at = current_time
-            return unless @reactor
 
-            @reactor.async do
-              client.run_loop
-            end
-          end
-
-          def disconnect!
-            super
-            @reactor.cancel
+            @restart.signal if @restart
           end
 
           def current_time
@@ -57,14 +76,27 @@ module Slack
             run_loop
           end
 
+          # Kill the restart/ping loop.
+          def disconnect!
+            super
+          ensure
+            if restart = @restart
+              @restart = nil
+              restart.signal
+            end
+          end
+
+          # Close the socket.
           def close
-            @closing = true
-            @driver.close if @driver
             super
+          ensure
+            if @socket
+              @socket.close
+              @socket = nil
+            end
           end
 
           def run_loop
-            @closing = false
             while @driver && @driver.next_event
               # $stderr.puts event.inspect
             end

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

@@ -46,7 +46,6 @@ module Slack
 
           def close
             @closing = true
-            driver.close if driver
             super
           end
 

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

@@ -56,11 +56,6 @@ module Slack
             @thread = nil
           end
 
-          def close
-            driver.close if driver
-            super
-          end
-
           def send_data(message)
             logger.debug("#{self.class}##{__method__}") { message }
             driver.send(message)

data/lib/slack/real_time/socket.rb

@@ -18,9 +18,9 @@ module Slack
       def send_data(message)
         logger.debug("#{self.class}##{__method__}") { message }
         case message
-        when Numeric then driver.text(message.to_s)
-        when String  then driver.text(message)
-        when Array   then driver.binary(message)
+        when Numeric then @driver.text(message.to_s)
+        when String  then @driver.text(message)
+        when Array   then @driver.binary(message)
         else false
         end
       end
@@ -29,21 +29,24 @@ module Slack
         return if connected?
 
         connect
-        logger.debug("#{self.class}##{__method__}") { driver.class }
+        logger.debug("#{self.class}##{__method__}") { @driver.class }
 
-        driver.on :message do
+        @driver.on :message do
           @last_message_at = current_time
         end
 
-        yield driver if block_given?
+        yield @driver if block_given?
       end
 
+      # Gracefully shut down the connection.
       def disconnect!
-        driver.close
+        @driver.close
+      ensure
+        close
       end
 
       def connected?
-        !driver.nil?
+        !@driver.nil?
       end
 
       def start_sync(client)
@@ -73,7 +76,11 @@ module Slack
       end
 
       def close
-        @driver = nil
+        # When you call `driver.emit(:close)`, it will typically end up calling `client.close` which will call `@socket.close` and end up back here. In order to break this infinite recursion, we check and set `@driver = nil` before invoking `client.close`.
+        if driver = @driver
+          @driver = nil
+          driver.emit(:close)
+        end
       end
 
       protected

data/lib/slack/version.rb

@@ -1,3 +1,3 @@
 module Slack
-  VERSION = '0.14.1'.freeze
+  VERSION = '0.14.2'.freeze
 end

data/lib/slack/web/api/endpoints.rb

@@ -10,6 +10,7 @@ require_relative 'endpoints/auth'
 require_relative 'endpoints/bots'
 require_relative 'endpoints/channels'
 require_relative 'endpoints/chat'
+require_relative 'endpoints/chat_scheduledMessages'
 require_relative 'endpoints/conversations'
 require_relative 'endpoints/dialog'
 require_relative 'endpoints/dnd'
@@ -54,6 +55,7 @@ module Slack
         include Bots
         include Channels
         include Chat
+        include ChatScheduledmessages
         include Conversations
         include Dialog
         include Dnd