slack-ruby-client 1.1.0 → 2.0.0

data/bin/commands/chat.rb

@@ -83,12 +83,13 @@ command 'chat' do |g|
     c.flag 'attachments', desc: 'A JSON-based array of structured attachments, presented as a URL-encoded string.'
     c.flag 'blocks', desc: 'A JSON-based array of structured blocks, presented as a URL-encoded string.'
     c.flag 'text', desc: 'The formatted text of the message to be published. If blocks are included, this will become the fallback text used in notifications.'
-    c.flag 'as_user', desc: 'Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See authorship below.'
+    c.flag 'as_user', desc: 'Set to true to post the message as the authed user, instead of as a bot. Defaults to false. Cannot be used by new Slack apps. See authorship below.'
     c.flag 'icon_emoji', desc: 'Emoji to use as the icon for this message. Overrides icon_url. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.'
     c.flag 'icon_url', desc: '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.'
-    c.flag 'link_names', desc: 'Find and link channel names and usernames.'
+    c.flag 'link_names', desc: 'Find and link user groups. No longer supports linking individual users; use syntax shown in Mentioning Users instead.'
+    c.flag 'metadata', desc: 'JSON object with event_type and event_payload fields, presented as a URL-encoded string. Metadata you post to Slack is accessible to any app or user who is a member of that workspace.'
     c.flag 'mrkdwn', desc: 'Disable Slack markup parsing by setting to false. Enabled by default.'
-    c.flag 'parse', desc: 'Change how messages are treated. Defaults to none. See below.'
+    c.flag 'parse', desc: 'Change how messages are treated. See below.'
     c.flag 'reply_broadcast', desc: 'Used in conjunction with thread_ts and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to false.'
     c.flag 'thread_ts', desc: "Provide another message's ts value to make this message a reply. Avoid using a reply's ts value; use its parent instead."
     c.flag 'unfurl_links', desc: 'Pass true to enable unfurling of primarily text-based content.'
@@ -105,11 +106,12 @@ command 'chat' do |g|
     c.flag 'channel', desc: 'Channel, private group, or DM channel to send message to. Can be an encoded ID, or a name. See below for more details.'
     c.flag 'post_at', desc: 'Unix EPOCH timestamp of time in future to send the message.'
     c.flag 'text', desc: 'How this field works and whether it is required depends on other fields you use in your API call. See below for more detail.'
-    c.flag 'as_user', desc: 'Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See chat.postMessage.'
+    c.flag 'as_user', desc: 'Set to true to post the message as the authed user, instead of as a bot. Defaults to false. Cannot be used by new Slack apps. See chat.postMessage.'
     c.flag 'attachments', desc: 'A JSON-based array of structured attachments, presented as a URL-encoded string.'
     c.flag 'blocks', desc: 'A JSON-based array of structured blocks, presented as a URL-encoded string.'
-    c.flag 'link_names', desc: 'Find and link channel names and usernames.'
-    c.flag 'parse', desc: 'Change how messages are treated. Defaults to none. See chat.postMessage.'
+    c.flag 'link_names', desc: 'Find and link user groups. No longer supports linking individual users; use syntax shown in Mentioning Users instead.'
+    c.flag 'metadata', desc: 'JSON object with event_type and event_payload fields, presented as a URL-encoded string. Metadata you post to Slack is accessible to any app or user who is a member of that workspace.'
+    c.flag 'parse', desc: 'Change how messages are treated. See chat.postMessage.'
     c.flag 'reply_broadcast', desc: 'Used in conjunction with thread_ts and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to false.'
     c.flag 'thread_ts', desc: "Provide another message's ts value to make this message a reply. Avoid using a reply's ts value; use its parent instead."
     c.flag 'unfurl_links', desc: 'Pass true to enable unfurling of primarily text-based content.'
@@ -146,6 +148,7 @@ command 'chat' do |g|
     c.flag 'blocks', desc: "A JSON-based array of structured blocks, presented as a URL-encoded string. If you don't include this field, the message's previous blocks will be retained. To remove previous blocks, include an empty array for this field."
     c.flag 'file_ids', desc: 'Array of new file ids that will be sent with this message.'
     c.flag 'link_names', desc: 'Find and link channel names and usernames. Defaults to none. If you do not specify a value for this field, the original value set for the message will be overwritten with the default, none.'
+    c.flag 'metadata', desc: "JSON object with event_type and event_payload fields, presented as a URL-encoded string. If you don't include this field, the message's previous metadata will be retained. To remove previous metadata, include an empty object for this field. Metadata you post to Slack is accessible to any app or user who is a member of that workspace."
     c.flag 'parse', desc: 'Change how messages are treated. Defaults to client, unlike chat.postMessage. Accepts either none or full. If you do not specify a value for this field, the original value set for the message will be overwritten with the default, client.'
     c.flag 'reply_broadcast', desc: 'Broadcast an existing thread reply to make it visible to everyone in the channel or conversation.'
     c.flag 'text', desc: "New text for the message, using the default formatting rules. It's not required when presenting blocks or attachments."

data/bin/commands/conversations.rb

@@ -71,10 +71,11 @@ command 'conversations' do |g|
   g.command 'history' do |c|
     c.flag 'channel', desc: 'Conversation ID to fetch history for.'
     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 'inclusive', desc: 'Include messages with latest or oldest timestamp in results only when either timestamp is specified.'
-    c.flag 'latest', desc: 'End of time range of messages to include in results. Default is the current time.'
+    c.flag 'include_all_metadata', desc: 'Return all metadata associated with this message.'
+    c.flag 'inclusive', desc: 'Include messages with oldest or latest timestamps in results. Ignored unless either timestamp is specified.'
+    c.flag 'latest', desc: 'Only messages before this Unix timestamp will be included in results. Default is the current time.'
     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 'oldest', desc: 'Start of time range of messages to include in results.'
+    c.flag 'oldest', desc: 'Only messages after this Unix timestamp will be included in results.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.conversations_history(options))
     end
@@ -213,10 +214,11 @@ command 'conversations' do |g|
     c.flag 'channel', desc: 'Conversation ID to fetch thread from.'
     c.flag 'ts', desc: "Unique identifier of either a thread's parent message or a message in the thread. ts must be the timestamp of an existing message with 0 or more replies. If there are no replies then just the single message referenced by ts will return - it is just an ordinary, unthreaded message."
     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 'inclusive', desc: 'Include messages with latest or oldest timestamp in results only when either timestamp is specified.'
-    c.flag 'latest', desc: 'End of time range of messages to include in results.'
+    c.flag 'include_all_metadata', desc: 'Return all metadata associated with this message.'
+    c.flag 'inclusive', desc: 'Include messages with oldest or latest timestamps in results. Ignored unless either timestamp is specified.'
+    c.flag 'latest', desc: 'Only messages before this Unix timestamp will be included in results.'
     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 'oldest', desc: 'Start of time range of messages to include in results.'
+    c.flag 'oldest', desc: 'Only messages after this Unix timestamp will be included in results.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.conversations_replies(options))
     end

data/bin/commands/files.rb

@@ -3,6 +3,18 @@
 
 desc 'Files methods.'
 command 'files' do |g|
+  g.desc 'Finishes an upload started with files.getUploadURLExternal'
+  g.long_desc %( Finishes an upload started with files.getUploadURLExternal )
+  g.command 'completeUploadExternal' do |c|
+    c.flag 'files', desc: 'Array of file ids and their corresponding (optional) titles.'
+    c.flag 'channel_id', desc: 'Channel ID where the file will be shared. If not specified the file will be private.'
+    c.flag 'initial_comment', desc: 'The message text introducing the file in specified channels.'
+    c.flag 'thread_ts', desc: "Provide another message's ts value to upload this file as a reply. Never use a reply's ts value; use its parent instead."
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.files_completeUploadExternal(options))
+    end
+  end
+
   g.desc 'Deletes a file.'
   g.long_desc %( Deletes a file. )
   g.command 'delete' do |c|
@@ -23,6 +35,18 @@ command 'files' do |g|
     end
   end
 
+  g.desc 'Gets a URL for an edge external file upload'
+  g.long_desc %( Gets a URL for an edge external file upload )
+  g.command 'getUploadURLExternal' do |c|
+    c.flag 'filename', desc: 'Name of the file being uploaded.'
+    c.flag 'length', desc: 'Size in bytes of the file being uploaded.'
+    c.flag 'alt_txt', desc: 'Description of image for screen-reader.'
+    c.flag 'snippet_type', desc: 'Syntax type of the snippet being uploaded.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.files_getUploadURLExternal(options))
+    end
+  end
+
   g.desc 'Gets information about a file.'
   g.long_desc %( Gets information about a file. )
   g.command 'info' do |c|

data/bin/commands/rtm.rb

@@ -12,19 +12,4 @@ command 'rtm' do |g|
       puts JSON.dump($client.rtm_connect(options))
     end
   end
-
-  g.desc 'Deprecated: Starts a Real Time Messaging session. Use rtm.connect instead.'
-  g.long_desc %( Deprecated: Starts a Real Time Messaging session. Use rtm.connect instead. )
-  g.command 'start' do |c|
-    c.flag 'batch_presence_aware', desc: 'Batch presence deliveries via subscription. Enabling changes the shape of presence_change events. See batch presence.'
-    c.flag 'include_locale', desc: 'Set this to true to receive the locale for users and channels. Defaults to false.'
-    c.flag 'mpim_aware', desc: 'Returns MPIMs to the client in the API response.'
-    c.flag 'no_latest', desc: 'Exclude latest timestamps for channels, groups, mpims, and ims. Automatically sets no_unreads to 1.'
-    c.flag 'no_unreads', desc: 'Skip unread counts for each channel (improves performance).'
-    c.flag 'presence_sub', desc: 'Only deliver presence events when requested by subscription. See presence subscriptions.'
-    c.flag 'simple_latest', desc: 'Return timestamp only for latest message object of each channel (improves performance).'
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.rtm_start(options))
-    end
-  end
 end

data/bin/commands/views.rb

@@ -6,8 +6,9 @@ command 'views' do |g|
   g.desc 'Open a view for a user.'
   g.long_desc %( Open a view for a user. )
   g.command 'open' do |c|
-    c.flag 'trigger_id', desc: 'Exchange a trigger to post to the user.'
     c.flag 'view', desc: 'A view payload. This must be a JSON-encoded string.'
+    c.flag 'trigger_id', desc: 'Exchange a trigger to post to the user.'
+    c.flag 'interactivity_pointer', desc: 'Exchange an interactivity pointer to post to the user.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.views_open(options))
     end
@@ -27,8 +28,9 @@ command 'views' do |g|
   g.desc 'Push a view onto the stack of a root view.'
   g.long_desc %( Push a view onto the stack of a root view. )
   g.command 'push' do |c|
-    c.flag 'trigger_id', desc: 'Exchange a trigger to post to the user.'
     c.flag 'view', desc: 'A view payload. This must be a JSON-encoded string.'
+    c.flag 'trigger_id', desc: 'Exchange a trigger to post to the user.'
+    c.flag 'interactivity_pointer', desc: 'Exchange an interactivity pointer to post to the user.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.views_push(options))
     end

data/bin/commands.rb

@@ -6,6 +6,7 @@ require 'commands/admin_apps'
 require 'commands/admin_apps_approved'
 require 'commands/admin_apps_requests'
 require 'commands/admin_apps_restricted'
+require 'commands/admin_audit_anomaly_allow'
 require 'commands/admin_auth_policy'
 require 'commands/admin_barriers'
 require 'commands/admin_conversations'

data/bin/slack

@@ -40,7 +40,7 @@ pre do |global_options, _command, options, _args|
   end
 
   # remove any nil values from options
-  options.select! { |_k, v| v }
+  options.compact!
 
   true
 end

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

@@ -12,8 +12,9 @@ module Slack
         # @option options [Object] :text
         #   Text of the message to send. See below for an explanation of formatting.
         def message(options = {})
-          throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
-          throw ArgumentError.new('Required arguments :text missing') if options[:text].nil?
+          raise ArgumentError, 'Required arguments :channel missing' if options[:channel].nil?
+          raise ArgumentError, 'Required arguments :text missing' if options[:text].nil?
+
           send_json({ type: 'message', id: next_id }.merge(options))
         end
       end

data/lib/slack/real_time/api/templates/event_handler.erb

@@ -1,4 +1,8 @@
         # <%= desc %>
         # @see https://api.slack.com/events/<%= name %>
         # @see https://github.com/slack-ruby/slack-api-ref/blob/master/events/<%= name %>.json
-        # on :<%= name %> do |data|
+<% if hook %>
+<%= hook %>
+<% else %>
+          # on :<%= name %> do |data|
+<% end %>

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

@@ -10,7 +10,8 @@ module Slack
         #   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?
+          raise ArgumentError, 'Required arguments :channel missing' if options[:channel].nil?
+
           send_json({ type: 'typing', id: next_id }.merge(options))
         end
       end

data/lib/slack/real_time/client.rb

@@ -11,15 +11,9 @@ module Slack
       include Api::Message
       include Api::Typing
 
-      @events = {}
-
-      class << self
-        attr_accessor :events
-      end
-
       attr_accessor :web_client, :store, :url, *Config::ATTRIBUTES
 
-      protected :store_class, :store_class=
+      protected :store_class, :store_class=, :store_options, :store_options=
 
       def initialize(options = {})
         @callbacks = Hash.new { |h, k| h[k] = [] }
@@ -31,7 +25,7 @@ module Slack
         @web_client = Slack::Web::Client.new(token: token, logger: logger)
       end
 
-      %i[users self channels team teams groups ims bots].each do |store_method|
+      [:self, :team, *Stores::Base::CACHES].each do |store_method|
         define_method store_method do
           store&.send(store_method)
         end
@@ -162,10 +156,10 @@ module Slack
       def restart_async
         logger.debug("#{self}##{__method__}")
         @socket.close
-        start = web_client.send(rtm_start_method, start_options)
+        start = web_client.rtm_connect(start_options)
         data = Slack::Messages::Message.new(start)
         @url = data.url
-        @store = @store_class.new(data) if @store_class
+        @store = store_class.new(data, store_options.to_h) if store_class
         @socket.restart_async(self, @url)
       end
 
@@ -173,23 +167,13 @@ module Slack
       def build_socket
         raise ClientAlreadyStartedError if started?
 
-        start = web_client.send(rtm_start_method, start_options)
+        start = web_client.rtm_connect(start_options)
         data = Slack::Messages::Message.new(start)
         @url = data.url
-        @store = @store_class.new(data) if @store_class
+        @store = store_class.new(data, store_options.to_h) if store_class
         @socket = socket_class.new(@url, socket_options)
       end
 
-      def rtm_start_method
-        if start_method
-          start_method
-        elsif @store_class && @store_class <= Slack::RealTime::Stores::Store
-          :rtm_start
-        else
-          :rtm_connect
-        end
-      end
-
       def socket_options
         socket_options = {}
         socket_options[:ping] = websocket_ping if websocket_ping
@@ -249,11 +233,9 @@ module Slack
       end
 
       def run_handlers(type, data)
-        return unless store.class.events
-
         handlers = store.class.events[type.to_s]
-        handlers&.each do |handler|
-          store.instance_exec(data, &handler)
+        handlers.each do |handler|
+          store.instance_exec(data, self, &handler)
         end
       rescue StandardError => e
         logger.error("#{self}##{__method__}") { e }

data/lib/slack/real_time/config.rb

@@ -11,9 +11,9 @@ module Slack
         websocket_ping
         websocket_proxy
         concurrency
-        start_method
         start_options
         store_class
+        store_options
         logger
       ].freeze
 
@@ -25,9 +25,9 @@ module Slack
         self.websocket_proxy = nil
         self.token = nil
         self.concurrency = method(:detect_concurrency)
-        self.start_method = nil
         self.start_options = { request: { timeout: 180 } }
-        self.store_class = Slack::RealTime::Store
+        self.store_class = Slack::RealTime::Stores::Starter
+        self.store_options = {}
         self.logger = nil
       end
 

data/lib/slack/real_time/models/channel.rb

@@ -1,8 +1,12 @@
 # frozen_string_literal: true
+
 module Slack
   module RealTime
     module Models
       class Channel < Base
+        def is_public? # rubocop:disable Naming/PredicateName
+          !is_private?
+        end
       end
     end
   end

data/lib/slack/real_time/models/{group.rb → mpim.rb}

@@ -2,7 +2,7 @@
 module Slack
   module RealTime
     module Models
-      class Group < Base
+      class Mpim < Base
       end
     end
   end

data/lib/slack/real_time/models.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
+
 require_relative 'models/base'
 require_relative 'models/user'
 require_relative 'models/bot'
 require_relative 'models/channel'
-require_relative 'models/group'
 require_relative 'models/team'
 require_relative 'models/im'
+require_relative 'models/mpim'

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

@@ -1,14 +1,36 @@
 # frozen_string_literal: true
+
 module Slack
   module RealTime
     module Stores
       # Doesn't store anything.
       class Base
+        CACHES = %i[
+          teams
+          users
+          bots
+          public_channels
+          private_channels
+          ims
+          mpims
+        ].freeze
+
+        @events = Hash.new { |h, k| h[k] = [] }
+
         class << self
-          attr_accessor :events
+          attr_reader :events
+
+          def inherited(subclass)
+            super
+            subclass.instance_variable_set :@events, events.dup
+          end
+
+          def on(event, &handler)
+            events[event.to_s] << handler
+          end
         end
 
-        attr_accessor :users, :bots, :channels, :groups, :teams, :ims
+        attr_accessor(*CACHES)
 
         def self
           nil
@@ -18,13 +40,7 @@ module Slack
           nil
         end
 
-        def initialize(_attrs); end
-
-        def self.on(event, &block)
-          self.events ||= {}
-          self.events[event.to_s] ||= []
-          self.events[event.to_s] << block
-        end
+        def initialize(_attrs, _options = {}); end
       end
     end
   end