slack-ruby-client 0.11.1 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 488002a6ea8cb58f2aeb4e21d5008c47fae73f4d6c6d8d9930a324f1b24492dd
-  data.tar.gz: b05b1307ff8f64000eccecf83b7cf818bcebcace33c1e3232691680c109a562d
+  metadata.gz: cb40a47e675fcf0265b109933983e54e11b6c9df574d355debde7c8ec5430148
+  data.tar.gz: 3e32b46f06a4e0d28db8e2bcdd329b57b1d719adadc8e8fcc246f45e6128c59e
 SHA512:
-  metadata.gz: 4beafc46990017ebe15b2860f7f601968fc0df6cf195e3b5a79fa173e59b4d8f34dbc4fe29c969b3be545d7b1c15046589d4446560ce6d032aaaa6ecd6b0e3bc
-  data.tar.gz: e2acea4de6fe0d5517cc8294c6712f4bea8aa35aec9630b1a8c6f7c3144d78a36063a8ec59f91c0fbc73c0c7dd96be582a7ba656872298dc81ed1a03c1dc87fd
+  metadata.gz: 53da5f288963057384831ff33711031fa866aad91f3857eeaae312e303640a60316459ddd20f18940d145aa4b9cf57cd7c8fdff9dee82ecb912b809f85db49cd
+  data.tar.gz: f235bb2ea8e6b5e64d247e2727d50618d54e9af471a4fd73c0e02bf43d0d70dda712b5e973c8033ecebd20501843eb6eb11eaf57cd53c1f71b4b45fd411b03f5

data/.rubocop.yml

@@ -3,6 +3,15 @@ AllCops:
     - vendor/**/*
     - lib/slack/web/api/slack-api-ref/**/*
 
+Metrics:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 512
+
+Style/Documentation:
+  Enabled: false
+
 Naming/MethodName:
   Enabled: false
 

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2017-11-25 11:28:32 -0500 using RuboCop version 0.51.0.
+# on 2018-08-20 08:24:54 -0400 using RuboCop version 0.58.2.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -14,60 +14,40 @@ Lint/HandleExceptions:
     - 'spec/slack/real_time/concurrency/eventmachine_spec.rb'
 
 # Offense count: 1
-Lint/RescueWithoutErrorClass:
+# Configuration parameters: EnforcedStyleForLeadingUnderscores.
+# SupportedStylesForLeadingUnderscores: disallowed, required, optional
+Naming/MemoizedInstanceVariableName:
   Exclude:
-    - 'lib/slack/real_time/concurrency/celluloid.rb'
-
-# Offense count: 18
-Metrics/AbcSize:
-  Max: 44
-
-# Offense count: 81
-# Configuration parameters: CountComments, ExcludedMethods.
-Metrics/BlockLength:
-  Max: 421
+    - 'lib/slack/logger.rb'
 
 # Offense count: 2
-# Configuration parameters: CountComments.
-Metrics/ClassLength:
-  Max: 166
-
-# Offense count: 4
-Metrics/CyclomaticComplexity:
-  Max: 9
-
-# Offense count: 741
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
-# URISchemes: http, https
-Metrics/LineLength:
-  Max: 266
-
-# Offense count: 10
-# Configuration parameters: CountComments.
-Metrics/MethodLength:
-  Max: 42
+# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
+# AllowedNames: io, id, to, by, on, in, at, ip
+Naming/UncommunicativeMethodParamName:
+  Exclude:
+    - 'spec/support/queue_with_timeout.rb'
 
 # Offense count: 1
-# Configuration parameters: CountComments.
-Metrics/ModuleLength:
-  Max: 113
-
-# Offense count: 3
-Metrics/PerceivedComplexity:
-  Max: 11
+Security/Open:
+  Exclude:
+    - 'lib/slack/real_time/client.rb'
 
-# Offense count: 1
-# Configuration parameters: ExpectMatchingDefinition, Regex, IgnoreExecutableScripts, AllowedAcronyms.
-# AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
-Naming/FileName:
+# Offense count: 2
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: inline, group
+Style/AccessModifierDeclarations:
   Exclude:
-    - 'lib/slack-ruby-client.rb'
+    - 'lib/slack/real_time/concurrency/eventmachine.rb'
+    - 'lib/slack/real_time/socket.rb'
 
-# Offense count: 63
-Style/Documentation:
-  Enabled: false
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/ExpandPathArguments:
+  Exclude:
+    - 'bin/slack'
+    - 'slack-ruby-client.gemspec'
 
-# Offense count: 137
+# Offense count: 152
 # Configuration parameters: AllowedVariables.
 Style/GlobalVars:
   Enabled: false
@@ -79,8 +59,14 @@ Style/GuardClause:
     - 'lib/slack/real_time/stores/store.rb'
     - 'lib/slack/web/faraday/response/raise_error.rb'
 
+# Offense count: 1
+Style/MixinUsage:
+  Exclude:
+    - 'bin/slack'
+
 # Offense count: 3
-# Configuration parameters: EnforcedStyle, SupportedStyles.
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
 # SupportedStyles: module_function, extend_self
 Style/ModuleFunction:
   Exclude:
@@ -92,3 +78,9 @@ Style/ModuleFunction:
 Style/MultilineTernaryOperator:
   Exclude:
     - 'spec/support/real_time/connected_client.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/RandomWithOffset:
+  Exclude:
+    - 'spec/integration/integration_spec.rb'

data/.travis.yml

@@ -4,8 +4,8 @@ cache: bundler
 
 rvm:
   - 2.2
-  - 2.1
-  - 2.3.4
+  - 2.3
+  - 2.5
   - ruby-head
   - jruby-head
 

data/CHANGELOG.md

@@ -1,4 +1,16 @@
-### 0.11.1 (1/23/2017)
+### 0.12.0 (8/20/2018)
+
+* [#216](https://github.com/slack-ruby/slack-ruby-client/pull/216): Handle `Errno::ECONNRESET` and empty buffer reads with celluloid-io - [@dblock](https://github.com/dblock).
+* [#215](https://github.com/slack-ruby/slack-ruby-client/pull/215): Web API `groups_list`, `files_info`, `mpim_list`, `reactions_list` and `stars_list` now support cursor pagination - [@hotwatermorning](https://github.com/hotwatermorning).
+* [#215](https://github.com/slack-ruby/slack-ruby-client/pull/215): Added `apps_permissions_users_list` and `apps_permissions_users_request` - [@hotwatermorning](https://github.com/hotwatermorning).
+* [#209](https://github.com/slack-ruby/slack-ruby-client/pull/209): Changed `chat_postEphemeral`to check for existence of either `text` or `attachments` - [@peterzhu2118](https://github.com/peterzhu2118).
+* [#207](https://github.com/slack-ruby/slack-ruby-client/pull/207): Added `apps_permissions_resources_list` and `apps_permissions_scopes_list` - [@jmanian](https://github.com/jmanian).
+* [#207](https://github.com/slack-ruby/slack-ruby-client/pull/207): Added `users_conversations` - [@jmanian](https://github.com/jmanian).
+* [#206](https://github.com/slack-ruby/slack-ruby-client/pull/206): Fix 100% cpu usage in async examples - [@felixbuenemann](https://github.com/felixbuenemann).
+* [#217](https://github.com/slack-ruby/slack-ruby-client/pull/217): Upgraded RuboCop to 0.58.2 - [@dblock](https://github.com/dblock).
+* [#217](https://github.com/slack-ruby/slack-ruby-client/pull/217): No longer tested with Ruby 2.1, added 2.5 - [@dblock](https://github.com/dblock).
+
+### 0.11.1 (1/23/2018)
 
 * [#187](https://github.com/slack-ruby/slack-ruby-client/pull/187): Concatenate error message when multiple errors present - [@chrislopresto](https://github.com/chrislopresto).
 * [#188](https://github.com/slack-ruby/slack-ruby-client/pull/188): Fixed `NoMethodError` when Slack is unavailable - [@sonicdoe](https://github.com/sonicdoe).

data/Gemfile

@@ -3,7 +3,6 @@ source 'http://rubygems.org'
 gemspec
 
 gem ENV['CONCURRENCY'], require: false if ENV.key?('CONCURRENCY')
-# rubocop:enable Bundler/OrderedGems
 
 gem 'activesupport', '~> 4.0'
 gem 'picky' unless RUBY_PLATFORM == 'java'

data/README.md

@@ -18,7 +18,7 @@ A Ruby client for the Slack [Web](https://api.slack.com/web) and [RealTime Messa
 
 ## Stable Release
 
-You're reading the documentation for the **next** release of slack-ruby-client. Please see the documentation for the [last stable release, v0.11.1](https://github.com/slack-ruby/slack-ruby-client/blob/v0.11.1/README.md) unless you're integrating with HEAD. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
+You're reading the documentation for the **stable** release of slack-ruby-client, 0.12.0. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
 
 ## Installation
 
@@ -153,7 +153,7 @@ Refer to the [Slack Web API Method Reference](https://api.slack.com/methods) for
 You can configure the Web client either globally or via the initializer.
 
 ```ruby
-Slack::Web::Client.config do |config|
+Slack::Web::Client.configure do |config|
   config.user_agent = 'Slack Ruby Client/1.0'
 end
 ```
@@ -295,7 +295,7 @@ A smaller store that only stores and tracks information about the bot user, but
 You can configure the RealTime client either globally or via the initializer.
 
 ```ruby
-Slack::RealTime::Client.config do |config|
+Slack::RealTime::Client.configure do |config|
   config.websocket_ping = 42
 end
 ```
@@ -327,7 +327,7 @@ See a fully working example in [examples/hi_real_time](examples/hi_real_time/hi.
 The RealTime client uses either [rtm.start](https://api.slack.com/methods/rtm.start) or [rtm.connect](https://api.slack.com/methods/rtm.connect) to open a connection. The former retrieves a lot of team information while the latter only serves connection purposes and is preferred. You should let the library choose the right method for you based on the `store_class` used and override this behavior with `start_method` when necessary.
 
 ```ruby
-Slack::RealTime::Client.config do |config|
+Slack::RealTime::Client.configure do |config|
   config.start_method = :rtm_start
 end
 ```
@@ -360,7 +360,7 @@ See a fully working example in [examples/hi_real_time_and_web](examples/hi_real_
 The `rtm.start` call downloads a large amount of data. For large teams, consider reducing the amount of unnecessary data downloaded with `start_options`. You may also want to increase the default timeout of 180 seconds.
 
 ```ruby
-Slack::RealTime::Client.config do |config|
+Slack::RealTime::Client.configure do |config|
   # Return timestamp only for latest message object of each channel.
   config.start_options[:simple_latest] = true
   # Skip unread counts for each channel.

data/RELEASING.md

@@ -21,7 +21,7 @@ Change "Next" in [CHANGELOG.md](CHANGELOG.md) to the current date.
 
 Remove the line with "Your contribution here.", since there will be no more contributions to this release.
 
-Change `**next**` in the "Stable Release" section in README that warns users that they are reading the documentation for an unreleased version with `**stable**`.
+In the "Stable Release" section of the README, change `**next**` to `**stable**` so users know that they are reading the documentation for a released version.
 
 ```
 ## Stable Release

data/bin/commands.rb

@@ -2,6 +2,9 @@
 
 require 'commands/api'
 require 'commands/apps_permissions'
+require 'commands/apps_permissions_resources'
+require 'commands/apps_permissions_scopes'
+require 'commands/apps_permissions_users'
 require 'commands/auth'
 require 'commands/bots'
 require 'commands/channels'

data/bin/commands/apps_permissions_resources.rb

@@ -0,0 +1,14 @@
+# This file was auto-generated by lib/tasks/web.rake
+
+desc 'AppsPermissionsResources methods.'
+command 'apps_permissions_resources' do |g|
+  g.desc 'Returns list of resource grants this app has on a team.'
+  g.long_desc %( Returns list of resource grants this app has on a team. )
+  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 'limit', desc: 'The maximum number of items to return.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.apps_permissions_resources_list(options))
+    end
+  end
+end

data/bin/commands/apps_permissions_scopes.rb

@@ -0,0 +1,12 @@
+# This file was auto-generated by lib/tasks/web.rake
+
+desc 'AppsPermissionsScopes methods.'
+command 'apps_permissions_scopes' do |g|
+  g.desc 'Returns list of scopes this app has on a team.'
+  g.long_desc %( Returns list of scopes this app has on a team. )
+  g.command 'list' do |c|
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.apps_permissions_scopes_list(options))
+    end
+  end
+end

data/bin/commands/apps_permissions_users.rb

@@ -0,0 +1,25 @@
+# This file was auto-generated by lib/tasks/web.rake
+
+desc 'AppsPermissionsUsers methods.'
+command 'apps_permissions_users' do |g|
+  g.desc 'Returns list of user grants and corresponding scopes this app has on a team.'
+  g.long_desc %( Returns list of user grants and corresponding scopes this app has on a team. )
+  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 'limit', desc: 'The maximum number of items to return.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.apps_permissions_users_list(options))
+    end
+  end
+
+  g.desc 'Enables an app to trigger a permissions modal to grant an app access to a user access scope.'
+  g.long_desc %( Enables an app to trigger a permissions modal to grant an app access to a user access scope. )
+  g.command 'request' do |c|
+    c.flag 'scopes', desc: 'A comma separated list of user scopes to request for.'
+    c.flag 'trigger_id', desc: 'Token used to trigger the request.'
+    c.flag 'user', desc: 'The user this scope is being requested for.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.apps_permissions_users_request(options))
+    end
+  end
+end

data/bin/commands/chat.rb

@@ -63,12 +63,13 @@ command 'chat' do |g|
   g.long_desc %( Sends a message to a channel. )
   g.command 'postMessage' do |c|
     c.flag 'channel', desc: 'Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name. See below for more details.'
-    c.flag 'text', desc: "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."
+    c.flag 'text', desc: "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."
     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 'attachments', desc: 'A JSON-based array of structured attachments, presented as a URL-encoded string.'
     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 '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 '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."
@@ -102,7 +103,7 @@ command 'chat' do |g|
     c.flag 'ts', desc: 'Timestamp of the message to be updated.'
     c.flag 'as_user', desc: 'Pass true to update the message as the authed user. Bot users in this context are considered authed users.'
     c.flag 'attachments', desc: 'A JSON-based array of structured attachments, presented as a URL-encoded string. This field is required when not presenting text.'
-    c.flag 'link_names', desc: '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.'
+    c.flag 'link_names', desc: 'Find and link channel names and usernames. Defaults to none. See below.'
     c.flag 'parse', desc: 'Change how messages are treated. Defaults to client, unlike chat.postMessage. See below.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.chat_update(options))

data/bin/commands/conversations.rb

@@ -25,6 +25,7 @@ command 'conversations' do |g|
   g.command 'create' do |c|
     c.flag 'name', desc: 'Name of the public or private channel to create.'
     c.flag 'is_private', desc: 'Create a private channel instead of a public one.'
+    c.flag 'user_ids', desc: '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.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.conversations_create(options))
     end

data/bin/commands/files.rb

@@ -26,6 +26,8 @@ command 'files' do |g|
   g.long_desc %( Gets information about a team file. )
   g.command 'info' do |c|
     c.flag 'file', desc: 'Specify a file by providing its ID.'
+    c.flag 'cursor', desc: "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."
+    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.files_info(options))
     end
@@ -92,7 +94,8 @@ You can pass multiple values in the types argument, like types=spaces,snippets.T
     c.flag 'file', desc: 'File contents via multipart/form-data. If omitting this parameter, you must submit content.'
     c.flag 'filename', desc: 'Filename of file.'
     c.flag 'filetype', desc: 'A file type identifier.'
-    c.flag 'initial_comment', desc: 'Initial comment to add to file.'
+    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.flag 'title', desc: 'Title of file.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.files_upload(options))

data/bin/commands/groups.rb

@@ -94,8 +94,10 @@ command 'groups' do |g|
   g.desc 'Lists private channels that the calling user has access to.'
   g.long_desc %( Lists private channels that the calling user has access to. )
   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 'exclude_archived', desc: "Don't return archived private channels."
     c.flag 'exclude_members', desc: 'Exclude the members from each group.'
+    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.groups_list(options))
     end

data/bin/commands/mpim.rb

@@ -27,6 +27,8 @@ command 'mpim' do |g|
   g.desc 'Lists multiparty direct message channels for the calling user.'
   g.long_desc %( Lists multiparty direct message channels for the calling 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.mpim_list(options))
     end

data/bin/commands/oauth.rb

@@ -2,13 +2,14 @@
 
 desc 'Oauth methods.'
 command 'oauth' do |g|
-  g.desc 'Exchanges a temporary OAuth code for an API token.'
-  g.long_desc %( Exchanges a temporary OAuth code for an API token. )
+  g.desc 'Exchanges a temporary OAuth verifier code for an access token.'
+  g.long_desc %( Exchanges a temporary OAuth verifier code for an access token. )
   g.command 'access' do |c|
     c.flag 'client_id', desc: 'Issued when you created your application.'
     c.flag 'client_secret', desc: 'Issued when you created your application.'
     c.flag 'code', desc: 'The code param returned via the OAuth callback.'
     c.flag 'redirect_uri', desc: 'This must match the originally submitted URI (if one was sent).'
+    c.flag 'single_channel', desc: 'Request the user to add your app only to a single channel.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.oauth_access(options))
     end

data/bin/commands/reactions.rb

@@ -31,7 +31,9 @@ command 'reactions' do |g|
   g.desc 'Lists reactions made by a user.'
   g.long_desc %( Lists reactions made by 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 'full', desc: 'If true always return the complete reaction 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."
     c.flag 'user', desc: 'Show reactions made by this user. Defaults to the authed user.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.reactions_list(options))

data/bin/commands/rtm.rb

@@ -5,7 +5,8 @@ command 'rtm' do |g|
   g.desc 'Starts a Real Time Messaging session.'
   g.long_desc %( Starts a Real Time Messaging session. )
   g.command 'connect' do |c|
-    c.flag 'batch_presence_aware', desc: 'Only deliver presence events when requested by subscription. See presence subscriptions.'
+    c.flag 'batch_presence_aware', desc: 'Batch presence deliveries via subscription. Enabling changes the shape of presence_change events. See batch presence.'
+    c.flag 'presence_sub', desc: 'Only deliver presence events when requested by subscription. See presence subscriptions.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.rtm_connect(options))
     end
@@ -14,11 +15,12 @@ command 'rtm' do |g|
   g.desc 'Starts a Real Time Messaging session.'
   g.long_desc %( Starts a Real Time Messaging session. )
   g.command 'start' do |c|
-    c.flag 'batch_presence_aware', desc: 'Only deliver presence events when requested by subscription. See presence subscriptions.'
+    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))

data/bin/commands/search.rb

@@ -17,7 +17,7 @@ command 'search' do |g|
   g.desc 'Searches for files matching a query.'
   g.long_desc %( Searches for files matching a query. )
   g.command 'files' do |c|
-    c.flag 'query', desc: 'Search query. May contain booleans, etc.'
+    c.flag 'query', desc: 'Search query.'
     c.flag 'highlight', desc: 'Pass a value of true to enable query highlight markers (see below).'
     c.flag 'sort', desc: 'Return matches sorted by either score or timestamp.'
     c.flag 'sort_dir', desc: 'Change sort direction to ascending (asc) or descending (desc).'
@@ -29,7 +29,7 @@ command 'search' do |g|
   g.desc 'Searches for messages matching a query.'
   g.long_desc %( Searches for messages matching a query. )
   g.command 'messages' do |c|
-    c.flag 'query', desc: 'Search query. May contains booleans, etc.'
+    c.flag 'query', desc: 'Search query.'
     c.flag 'highlight', desc: 'Pass a value of true to enable query highlight markers (see below).'
     c.flag 'sort', desc: 'Return matches sorted by either score or timestamp.'
     c.flag 'sort_dir', desc: 'Change sort direction to ascending (asc) or descending (desc).'