slack-ruby-client 0.11.1 → 0.12.0

data/bin/commands/stars.rb

@@ -17,6 +17,8 @@ command 'stars' do |g|
   g.desc 'Lists stars for a user.'
   g.long_desc %( Lists stars for a user. )
   g.command 'list' do |c|
+    c.flag 'cursor', desc: "Parameter for pagination. Set cursor equal to the next_cursor attribute returned by the previous request's response_metadata. This parameter is optional, but pagination is mandatory: the default value simply fetches the first 'page' of the collection. See pagination for more details."
+    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 list hasn't been reached."
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.stars_list(options))
     end

data/bin/commands/users.rb

@@ -2,6 +2,19 @@
 
 desc 'Get info on members of your Slack team.'
 command 'users' do |g|
+  g.desc 'List conversations the calling user may access.'
+  g.long_desc %( List conversations the calling user may access. )
+  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.'
+    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 list hasn't been reached. Must be an integer no larger than 1000."
+    c.flag 'types', desc: 'Mix and match channel types by providing a comma-separated list of any combination of public_channel, private_channel, mpim, im.'
+    c.flag 'user', desc: "Browse conversations by a specific user ID's membership. Non-public channels are restricted to those where the calling user shares membership."
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.users_conversations(options))
+    end
+  end
+
   g.desc 'Delete the user profile photo'
   g.long_desc %( Delete the user profile photo )
   g.command 'deletePhoto' do |c|
@@ -52,7 +65,7 @@ command 'users' do |g|
     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: 'Whether to include presence data in the output. Defaults to false. Setting this to true reduces performance, especially with large teams.'
+    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
@@ -76,8 +89,8 @@ command 'users' do |g|
     end
   end
 
-  g.desc 'Marks a user as active.'
-  g.long_desc %( Marks a user as active. )
+  g.desc 'Marked a user as active. Deprecated and non-functional.'
+  g.long_desc %( Marked a user as active. Deprecated and non-functional. )
   g.command 'setActive' do |c|
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.users_setActive(options))

data/bin/commands/users_profile.rb

@@ -16,7 +16,7 @@ command 'users_profile' do |g|
   g.long_desc %( Set the profile information for a user. )
   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.'
+    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.'
     c.flag 'user', desc: 'ID of user to change. This argument may only be specified by team admins on paid teams.'
     c.flag 'value', desc: 'Value to set a single key to. Usable only if profile is not passed.'
     c.action do |_global_options, options, _args|

data/examples/hi_real_time_async_celluloid/hi.rb

@@ -5,6 +5,7 @@ raise 'Missing ENV[SLACK_API_TOKENS]!' unless ENV.key?('SLACK_API_TOKENS')
 $stdout.sync = true
 logger = Logger.new($stdout)
 logger.level = Logger::DEBUG
+threads = []
 
 ENV['SLACK_API_TOKENS'].split.each do |token|
   logger.info "Starting #{token[0..12]} ..."
@@ -28,9 +29,7 @@ ENV['SLACK_API_TOKENS'].split.each do |token|
     end
   end
 
-  client.start_async
+  threads << client.start_async
 end
 
-loop do
-  Thread.pass
-end
+threads.each(&:join)

data/examples/hi_real_time_async_eventmachine/hi.rb

@@ -5,6 +5,7 @@ raise 'Missing ENV[SLACK_API_TOKENS]!' unless ENV.key?('SLACK_API_TOKENS')
 $stdout.sync = true
 logger = Logger.new($stdout)
 logger.level = Logger::DEBUG
+threads = []
 
 ENV['SLACK_API_TOKENS'].split.each do |token|
   logger.info "Starting #{token[0..12]} ..."
@@ -28,9 +29,7 @@ ENV['SLACK_API_TOKENS'].split.each do |token|
     end
   end
 
-  client.start_async
+  threads << client.start_async
 end
 
-loop do
-  Thread.pass
-end
+threads.each(&:join)

data/lib/slack/messages/formatting.rb

@@ -1,4 +1,3 @@
-
 module Slack
   module Messages
     module Formatting

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

@@ -34,13 +34,13 @@ module Slack
             @connected = @socket.connect
             driver.start
             loop { read } if socket
-          rescue EOFError, Errno::EPIPE => e
+          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
           ensure
             begin
               current_actor.terminate if current_actor.alive?
-            rescue
+            rescue StandardError
               nil
             end
           end
@@ -53,6 +53,7 @@ module Slack
 
           def read
             buffer = socket.readpartial(BLOCK_SIZE)
+            raise EOFError unless buffer && !buffer.empty?
             async.handle_read(buffer)
           end
 

data/lib/slack/real_time/stores/starter.rb

@@ -14,6 +14,16 @@ module Slack
 
         ### RealTime Events
 
+        # A private channel was deleted.
+        # @see https://api.slack.com/events/group_deleted
+        # @see https://github.com/slack-ruby/slack-api-ref/blob/master/events/group_deleted.json
+        # on :group_deleted do |data|
+
+        # Determine the current presence status for a list of users.
+        # @see https://api.slack.com/events/presence_query
+        # @see https://github.com/slack-ruby/slack-api-ref/blob/master/events/presence_query.json
+        # on :presence_query do |data|
+
         # The membership of an existing User Group has changed.
         # @see https://api.slack.com/events/subteam_members_changed
         # @see https://github.com/slack-ruby/slack-api-ref/blob/master/events/subteam_members_changed.json

data/lib/slack/real_time/stores/store.rb

@@ -64,6 +64,16 @@ module Slack
 
         ### RealTime Events
 
+        # A private channel was deleted.
+        # @see https://api.slack.com/events/group_deleted
+        # @see https://github.com/slack-ruby/slack-api-ref/blob/master/events/group_deleted.json
+        # on :group_deleted do |data|
+
+        # Determine the current presence status for a list of users.
+        # @see https://api.slack.com/events/presence_query
+        # @see https://github.com/slack-ruby/slack-api-ref/blob/master/events/presence_query.json
+        # on :presence_query do |data|
+
         # The membership of an existing User Group has changed.
         # @see https://api.slack.com/events/subteam_members_changed
         # @see https://github.com/slack-ruby/slack-api-ref/blob/master/events/subteam_members_changed.json

data/lib/slack/version.rb

@@ -1,3 +1,3 @@
 module Slack
-  VERSION = '0.11.1'.freeze
+  VERSION = '0.12.0'.freeze
 end

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

@@ -2,6 +2,9 @@
 
 require_relative 'endpoints/api'
 require_relative 'endpoints/apps_permissions'
+require_relative 'endpoints/apps_permissions_resources'
+require_relative 'endpoints/apps_permissions_scopes'
+require_relative 'endpoints/apps_permissions_users'
 require_relative 'endpoints/auth'
 require_relative 'endpoints/bots'
 require_relative 'endpoints/channels'
@@ -42,6 +45,9 @@ module Slack
 
         include Api
         include AppsPermissions
+        include AppsPermissionsResources
+        include AppsPermissionsScopes
+        include AppsPermissionsUsers
         include Auth
         include Bots
         include Channels

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

@@ -0,0 +1,30 @@
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module AppsPermissionsResources
+          #
+          # Returns list of resource grants this app has on a team.
+          #
+          # @option options [Object] :cursor
+          #   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.
+          # @option options [Object] :limit
+          #   The maximum number of items to return.
+          # @see https://api.slack.com/methods/apps.permissions.resources.list
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/apps.permissions.resources/apps.permissions.resources.list.json
+          def apps_permissions_resources_list(options = {})
+            if block_given?
+              Pagination::Cursor.new(self, :apps_permissions_resources_list, options).each do |page|
+                yield page
+              end
+            else
+              post('apps.permissions.resources.list', options)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module AppsPermissionsScopes
+          #
+          # Returns list of scopes this app has on a team.
+          #
+          # @see https://api.slack.com/methods/apps.permissions.scopes.list
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/apps.permissions.scopes/apps.permissions.scopes.list.json
+          def apps_permissions_scopes_list(options = {})
+            post('apps.permissions.scopes.list', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module AppsPermissionsUsers
+          #
+          # Returns list of user grants and corresponding scopes this app has on a team.
+          #
+          # @option options [Object] :cursor
+          #   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.
+          # @option options [Object] :limit
+          #   The maximum number of items to return.
+          # @see https://api.slack.com/methods/apps.permissions.users.list
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/apps.permissions.users/apps.permissions.users.list.json
+          def apps_permissions_users_list(options = {})
+            if block_given?
+              Pagination::Cursor.new(self, :apps_permissions_users_list, options).each do |page|
+                yield page
+              end
+            else
+              post('apps.permissions.users.list', options)
+            end
+          end
+
+          #
+          # Enables an app to trigger a permissions modal to grant an app access to a user access scope.
+          #
+          # @option options [Object] :scopes
+          #   A comma separated list of user scopes to request for.
+          # @option options [Object] :trigger_id
+          #   Token used to trigger the request.
+          # @option options [user] :user
+          #   The user this scope is being requested for.
+          # @see https://api.slack.com/methods/apps.permissions.users.request
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/apps.permissions.users/apps.permissions.users.request.json
+          def apps_permissions_users_request(options = {})
+            throw ArgumentError.new('Required arguments :scopes missing') if options[:scopes].nil?
+            throw ArgumentError.new('Required arguments :trigger_id missing') if options[:trigger_id].nil?
+            throw ArgumentError.new('Required arguments :user missing') if options[:user].nil?
+            options = options.merge(user: users_id(options)['user']['id']) if options[:user]
+            post('apps.permissions.users.request', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -93,7 +93,7 @@ module Slack
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/chat/chat.postEphemeral.json
           def chat_postEphemeral(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
-            throw ArgumentError.new('Required arguments :text missing') if options[:text].nil?
+            throw ArgumentError.new('Required arguments :text or :attachments missing') if options[:text].nil? && options[:attachments].nil?
             throw ArgumentError.new('Required arguments :user missing') if options[:user].nil?
             options = options.merge(user: users_id(options)['user']['id']) if options[:user]
             # attachments must be passed as an encoded JSON string
@@ -111,7 +111,7 @@ module Slack
           # @option options [channel] :channel
           #   Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name. See below for more details.
           # @option options [Object] :text
-          #   Text of the message to send. See below for an explanation of formatting. This field is usually required, unless you're providing only attachments instead.
+          #   Text of the message to send. See below for an explanation of formatting. This field is usually required, unless you're providing only attachments instead. Provide no more than 40,000 characters or risk truncation.
           # @option options [Object] :as_user
           #   Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See authorship below.
           # @option options [Object] :attachments
@@ -122,6 +122,8 @@ module Slack
           #   URL to an image to use as the icon for this message. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.
           # @option options [Object] :link_names
           #   Find and link channel names and usernames.
+          # @option options [Object] :mrkdwn
+          #   Disable Slack markup parsing by setting to false. Enabled by default.
           # @option options [Object] :parse
           #   Change how messages are treated. Defaults to none. See below.
           # @option options [Object] :reply_broadcast
@@ -187,7 +189,7 @@ module Slack
           # @option options [Object] :attachments
           #   A JSON-based array of structured attachments, presented as a URL-encoded string. This field is required when not presenting text.
           # @option options [Object] :link_names
-          #   Find and link channel names and usernames. Defaults to none. This parameter should be used in conjunction with parse. To set link_names to 1, specify a parse mode of full.
+          #   Find and link channel names and usernames. Defaults to none. See below.
           # @option options [Object] :parse
           #   Change how messages are treated. Defaults to client, unlike chat.postMessage. See below.
           # @see https://api.slack.com/methods/chat.update

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

@@ -38,6 +38,8 @@ module Slack
           #   Name of the public or private channel to create.
           # @option options [Object] :is_private
           #   Create a private channel instead of a public one.
+          # @option options [Object] :user_ids
+          #   Required for workspace apps. A list of between 1 and 30 human users that will be added to the newly-created conversation. This argument has no effect when used by classic Slack apps.
           # @see https://api.slack.com/methods/conversations.create
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.create.json
           def conversations_create(options = {})

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

@@ -39,11 +39,21 @@ module Slack
           #
           # @option options [file] :file
           #   Specify a file by providing its ID.
+          # @option options [Object] :cursor
+          #   Parameter for pagination. File comments are paginated for a single file. Set cursor equal to the next_cursor attribute returned by the previous request's response_metadata. This parameter is optional, but pagination is mandatory: the default value simply fetches the first "page" of the collection of comments. See pagination for more details.
+          # @option options [Object] :limit
+          #   The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached.
           # @see https://api.slack.com/methods/files.info
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/files/files.info.json
           def files_info(options = {})
             throw ArgumentError.new('Required arguments :file missing') if options[:file].nil?
-            post('files.info', options)
+            if block_given?
+              Pagination::Cursor.new(self, :files_info, options).each do |page|
+                yield page
+              end
+            else
+              post('files.info', options)
+            end
           end
 
           #
@@ -133,7 +143,9 @@ module Slack
           # @option options [Object] :filetype
           #   A file type identifier.
           # @option options [Object] :initial_comment
-          #   Initial comment to add to file.
+          #   The message text introducing the file in specified channels.
+          # @option options [Object] :thread_ts
+          #   Provide another message's ts value to upload this file as a reply. Never use a reply's ts value; use its parent instead.
           # @option options [Object] :title
           #   Title of file.
           # @see https://api.slack.com/methods/files.upload

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

@@ -131,14 +131,24 @@ module Slack
           #
           # Lists private channels that the calling user has access to.
           #
+          # @option options [Object] :cursor
+          #   Parameter for pagination. Set cursor equal to the next_cursor attribute returned by the previous request's response_metadata. This parameter is optional, but pagination is mandatory: the default value simply fetches the first "page" of the collection. See pagination for more details.
           # @option options [Object] :exclude_archived
           #   Don't return archived private channels.
           # @option options [Object] :exclude_members
           #   Exclude the members from each group.
+          # @option options [Object] :limit
+          #   The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached.
           # @see https://api.slack.com/methods/groups.list
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/groups/groups.list.json
           def groups_list(options = {})
-            post('groups.list', options)
+            if block_given?
+              Pagination::Cursor.new(self, :groups_list, options).each do |page|
+                yield page
+              end
+            else
+              post('groups.list', options)
+            end
           end
 
           #

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

@@ -42,10 +42,20 @@ module Slack
           #
           # Lists multiparty direct message channels for the calling user.
           #
+          # @option options [Object] :cursor
+          #   Parameter for pagination. Set cursor equal to the next_cursor attribute returned by the previous request's response_metadata. This parameter is optional, but pagination is mandatory: the default value simply fetches the first "page" of the collection. See pagination for more details.
+          # @option options [Object] :limit
+          #   The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached.
           # @see https://api.slack.com/methods/mpim.list
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/mpim/mpim.list.json
           def mpim_list(options = {})
-            post('mpim.list', options)
+            if block_given?
+              Pagination::Cursor.new(self, :mpim_list, options).each do |page|
+                yield page
+              end
+            else
+              post('mpim.list', options)
+            end
           end
 
           #

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

@@ -6,7 +6,7 @@ module Slack
       module Endpoints
         module Oauth
           #
-          # Exchanges a temporary OAuth code for an API token.
+          # Exchanges a temporary OAuth verifier code for an access token.
           #
           # @option options [Object] :client_id
           #   Issued when you created your application.
@@ -16,6 +16,8 @@ module Slack
           #   The code param returned via the OAuth callback.
           # @option options [Object] :redirect_uri
           #   This must match the originally submitted URI (if one was sent).
+          # @option options [Object] :single_channel
+          #   Request the user to add your app only to a single channel.
           # @see https://api.slack.com/methods/oauth.access
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/oauth/oauth.access.json
           def oauth_access(options = {})

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

@@ -49,15 +49,25 @@ module Slack
           #
           # Lists reactions made by a user.
           #
+          # @option options [Object] :cursor
+          #   Parameter for pagination. Set cursor equal to the next_cursor attribute returned by the previous request's response_metadata. This parameter is optional, but pagination is mandatory: the default value simply fetches the first "page" of the collection. See pagination for more details.
           # @option options [Object] :full
           #   If true always return the complete reaction list.
+          # @option options [Object] :limit
+          #   The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached.
           # @option options [user] :user
           #   Show reactions made by this user. Defaults to the authed user.
           # @see https://api.slack.com/methods/reactions.list
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/reactions/reactions.list.json
           def reactions_list(options = {})
             options = options.merge(user: users_id(options)['user']['id']) if options[:user]
-            post('reactions.list', options)
+            if block_given?
+              Pagination::Cursor.new(self, :reactions_list, options).each do |page|
+                yield page
+              end
+            else
+              post('reactions.list', options)
+            end
           end
 
           #