slack-ruby-client 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 243d21fccb29fbddcaac69727c60a1a947e5b7e3a53136f96953099539141ae6
-  data.tar.gz: dcfeabe229a37247b94e4e030a5abf675792835b061a7917afdfcbd9827f4228
+  metadata.gz: 491089e27b5eab6a2d3a2834956a830ccbad387deb0c9fb848db739966b61ed8
+  data.tar.gz: 53a923e845941a2efea21daa5031c73011f55ac580e96a3694f88f3baa28f638
 SHA512:
-  metadata.gz: 5891098e3cb0bb938241157c779c0a8cdac0e18edac21d0251dd80949c5d70f21cc3429773138fc0092e29937f4f525d51f9975a4aa0f059a7cfbcb78a3c3723
-  data.tar.gz: 05a88513dad67cf2dc50dd2580a50588d99413801498fc959c495234955c419b5a861c86b8c98bef49ea50dfabb346aa26356c406a521f084555cece9249d364
+  metadata.gz: 185c57136e5100100c4f9fc2dbeb82de7a4f5e6fe4bcfad9c9a90c6c68a79c48ddbe50b3a9bebf7aeb211580933a8e5de6678359583a88aa39f236ea24dd2d10
+  data.tar.gz: bf2c43b27722ad5d7eabeabd1596437e662089ac1a4bc72e534719a6092c43b7e629a219da9e2af26f3795755c2acc6cff1dd378d49b1e408bde61a293196bf6

data/.github/workflows/{integtest.yml → integration_test.yml}

@@ -1,19 +1,21 @@
 name: Integration Tests
-on: [push]
+on: push
 jobs:
   test:
     runs-on: ubuntu-latest
     strategy:
       matrix:
         entry:
-          - { ruby: 2.7.1, concurrency: async-websocket }
+          - { ruby: 2.7, concurrency: async-websocket }
     name: test (ruby=${{ matrix.entry.ruby }}, concurrency=${{ matrix.entry.concurrency || 'none' }})
     steps:
-      - uses: actions/checkout@v2
-      - name: Install Ruby
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.entry.ruby }}
+          bundler-cache: true
       - name: Run Tests
         env:
           CONCURRENCY: ${{ matrix.entry.concurrency }}
@@ -22,4 +24,3 @@ jobs:
         run: |
           bundle install
           bundle exec rake
-        

data/.github/workflows/{rubocop.yml → lint.yml}

@@ -1,13 +1,14 @@
-name: Rubocop
+name: Lint
 on: [push, pull_request]
 jobs:
-  lint:
+  rubocop:
+    name: RuboCop
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - name: Checkout
+        uses: actions/checkout@v3
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.7
           bundler-cache: true
       - run: bundle exec rubocop

data/.github/workflows/{danger.yml → pr_lint.yml}

@@ -1,19 +1,21 @@
-name: PR Linter
-on: [pull_request]
+name: PR Lint
+on: pull_request
 jobs:
   danger:
+    name: Dangerfile
     runs-on: ubuntu-latest
     env:
       BUNDLE_GEMFILE: ${{ github.workspace }}/Gemfile.danger
     steps:
-      - uses: actions/checkout@v2
+      - name: Checkout
+        uses: actions/checkout@v3
         with:
           fetch-depth: 0
-      - uses: ruby/setup-ruby@v1
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.6
           bundler-cache: true
       - run: |
-          # the personal token is public, this is ok, base64 encode to avoid tripping Github
+          # Personal access token for dangerpr-bot - public, but base64 encoded to avoid tripping up GitHub
           TOKEN=$(echo -n NWY1ZmM5MzEyMzNlYWY4OTZiOGU3MmI3MWQ3Mzk0MzgxMWE4OGVmYwo= | base64 --decode)
           DANGER_GITHUB_API_TOKEN=$TOKEN bundle exec danger --verbose

data/.github/workflows/test.yml

@@ -14,11 +14,13 @@ jobs:
           - { ruby: jruby-head, ignore: true }
     name: test (ruby=${{ matrix.entry.ruby }}, concurrency=${{ matrix.entry.concurrency || 'none' }})
     steps:
-      - uses: actions/checkout@v2
-      - name: Install Ruby
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.entry.ruby }}
+          bundler-cache: true
       - name: Set Concurrency
         run: |
           if [[ ! -z "${{ matrix.entry.concurrency }}" ]]; then

data/.gitignore

@@ -4,6 +4,5 @@
 .env
 .idea
 .rspec_status
-.ruby-version
 Gemfile.lock
 pkg

data/.rubocop.yml

@@ -35,6 +35,10 @@ Style/Documentation:
 Style/ModuleFunction:
   Enabled: false
 
+Style/NumericLiterals:
+  Exclude:
+    - 'spec/**/*'
+
 RSpec/InstanceVariable:
   Enabled: false
 

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2022-05-04 06:11:49 UTC using RuboCop version 1.26.1.
+# on 2022-10-02 05:05:29 UTC using RuboCop version 1.26.1.
 # 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
@@ -93,19 +93,13 @@ RSpec/ContextMethod:
     - 'spec/slack/messages/formatting_spec.rb'
     - 'spec/slack/web/api/mixins/users_spec.rb'
 
-# Offense count: 77
+# Offense count: 74
 # Configuration parameters: Prefixes.
 # Prefixes: when, with, without
 RSpec/ContextWording:
   Enabled: false
 
-# Offense count: 127
-# This cop supports safe auto-correction (--auto-correct).
-# Configuration parameters: AllowConsecutiveOneLiners.
-RSpec/EmptyLineAfterExample:
-  Enabled: false
-
-# Offense count: 64
+# Offense count: 63
 # Configuration parameters: CountAsOne.
 RSpec/ExampleLength:
   Max: 18
@@ -116,13 +110,13 @@ RSpec/ExampleLength:
 RSpec/FilePath:
   Enabled: false
 
-# Offense count: 65
+# Offense count: 63
 # Configuration parameters: .
 # SupportedStyles: have_received, receive
 RSpec/MessageSpies:
   EnforcedStyle: receive
 
-# Offense count: 96
+# Offense count: 92
 RSpec/MultipleExpectations:
   Max: 5
 
@@ -137,11 +131,11 @@ RSpec/NamedSubject:
   Exclude:
     - 'spec/slack/web/api/mixins/conversations_list_spec.rb'
 
-# Offense count: 50
+# Offense count: 44
 RSpec/NestedGroups:
   Max: 6
 
-# Offense count: 6
+# Offense count: 5
 RSpec/StubbedMock:
   Exclude:
     - 'spec/slack/real_time/client_spec.rb'
@@ -162,7 +156,7 @@ RSpec/SubjectStub:
 RSpec/VerifiedDoubleReference:
   EnforcedStyle: string
 
-# Offense count: 12
+# Offense count: 10
 # Configuration parameters: IgnoreNameless, IgnoreSymbolicNames.
 RSpec/VerifiedDoubles:
   Exclude:

data/.ruby-version

@@ -0,0 +1 @@
+2.7.6

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+### 2.0.0 (2022/10/19)
+
+* [#416](https://github.com/slack-ruby/slack-ruby-client/pull/416): Removes default values for Faraday's SSL settings `ca_file` and `ca_path` - [@irphilli](https://github.com/irphilli).
+* [#417](https://github.com/slack-ruby/slack-ruby-client/pull/417): Raise rescuable errors - [@zachahn](https://github.com/zachahn).
+* [#419](https://github.com/slack-ruby/slack-ruby-client/pull/419): Use `rtm.connect` instead of `rtm.start` - [@kstole](https://github.com/kstole).
+* [#420](https://github.com/slack-ruby/slack-ruby-client/pull/420): Fix default store missing event hooks - [@kstole](https://github.com/kstole).
+* [#421](https://github.com/slack-ruby/slack-ruby-client/pull/421): Added `admin_audit_anomaly_allow_getItem`, `admin_audit_anomaly_allow_updateItem`, `files_completeUploadExternal`, `files_getUploadURLExternal` - [@kstole](https://github.com/kstole).
+* [#421](https://github.com/slack-ruby/slack-ruby-client/pull/421): Raise error for mutually exclusive required options in views methods - [@kstole](https://github.com/kstole).
+* [#424](https://github.com/slack-ruby/slack-ruby-client/pull/424): Updated real_time.rake to remove outdated event hooks and organize alphabetically - [@kstole](https://github.com/kstole).
+* [#423](https://github.com/slack-ruby/slack-ruby-client/pull/423): Changed default store to `Slack::RealTime::Stores::Starter` and removed `Slack::RealTime::Store` - [@kstole](https://github.com/kstole).
+* [#423](https://github.com/slack-ruby/slack-ruby-client/pull/423): Replaced `channels` and `groups` caches with `public_channels` and `private_channels` - [@kstole](https://github.com/kstole).
+* [#423](https://github.com/slack-ruby/slack-ruby-client/pull/423): Added configurable `hello` hook to initialize `Slack::RealTime::Stores::Store` upon successful connection - [@kstole](https://github.com/kstole).
+* [#425](https://github.com/slack-ruby/slack-ruby-client/pull/425): Updated web.rake to remove outdated endpoints and commands - [@kstole](https://github.com/kstole).
+
 ### 1.1.0 (2022/06/05)
 
 * [#400](https://github.com/slack-ruby/slack-ruby-client/pull/400): Replace Travis-CI with GitHub Actions - [@dblock](https://github.com/dblock).

data/CONTRIBUTING.md

@@ -35,7 +35,7 @@ Create a new App under [https://api.slack.com/apps](https://api.slack.com/apps).
 
 On the next screen, note the API token.
 
-To run [the example in examples/hi_real_time](examples/hi_real_time/hi.rb), open a terminal, cd into _examples/hi_real_time_, run `bundle install`, followed by `SLACK_API_TOKEN=<your API token> bundle exec ruby hi.rb`.
+To run [the example in examples/hi_real_time_and_web](examples/hi_real_time_and_web/hi.rb), open a terminal, cd into _examples/hi_real_time_and_web_, run `bundle install`, followed by `SLACK_API_TOKEN=<your API token> bundle exec ruby hi.rb`.
 
 ## Contribute Code
 
@@ -59,7 +59,7 @@ We definitely appreciate pull requests that highlight or reproduce a problem, ev
 
 Implement your feature or bug fix.
 
-Ruby style is enforced with [Rubocop](https://github.com/bbatsov/rubocop). Run `bundle exec rubocop` and fix any style issues highlighted, auto-correct issues when possible with `bundle exec rubocop -a`. To silence generally ingored issues, including line lengths or code complexity metrics, run `bundle exec rubocop --auto-gen-config`.
+Ruby style is enforced with [Rubocop](https://github.com/bbatsov/rubocop). Run `bundle exec rubocop` and fix any style issues highlighted, auto-correct issues when possible with `bundle exec rubocop -a`. To silence generally ignored issues, including line lengths or code complexity metrics, run `bundle exec rubocop --auto-gen-config`.
 
 Make sure that `bundle exec rake` completes without errors.
 
@@ -82,7 +82,7 @@ The broad steps are:
 2. Make a change to a generated file, for example `lib/slack/web/api/endpoints/chat.rb`.
 3. Generate a patch:
     ```
-    git diff --no-color HEAD lib/slack/web/api/endpoints/chat.rb > lib/slack/web/api/patches/chat.1.patch
+    git diff --no-color HEAD lib/slack/web/api/endpoints/chat.rb > lib/slack/web/api/patches/chat.added-support.patch
     ```
 4. Run `rake slack:api:update` to ensure that the patch is cleanly applied. Implement a test for the added or modified functionality and commit the patch file.
 
@@ -90,7 +90,8 @@ The broad steps are:
 
 The auto-generated method files may drift overtime e.g. new arguments may be added or descriptions changed. Since previous patches were based on the older auto-generated files, git may be unable to apply them to the new files. Resolving them requires some good ol' splicing:
 1. Run `rake slack:api:update SKIP_PATCH=true` to create the raw auto-generated files. Commit the files that you are updating, so we can run `git diff` later.
-2. Go through the old patches for the files (e.g. in `lib/slack/web/api/patches/chat.1.patch`), copying code into the new files.
+2. Go through the old patches for the files (e.g. in `lib/slack/web/api/patches/chat.added-support.patch`), copying code into the new files.
+    - Run `git apply --reject path/to/patch-file.patch` to see hunks that couldn't be applied.
 3. Continue with Step 2 [above](#patching-slack-web-api).
 
 

data/Gemfile

@@ -24,11 +24,6 @@ group :test do
   gem 'rubocop-rake'
   gem 'rubocop-rspec'
   gem 'timecop'
-  if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('3.0.0')
-    # https://github.com/vcr/vcr/pull/907
-    gem 'vcr', github: 'vcr/vcr', ref: '7ac8292c'
-  else
-    gem 'vcr'
-  end
+  gem 'vcr'
   gem 'webmock'
 end

data/README.md

@@ -38,14 +38,13 @@ A Ruby client for the Slack [Web](https://api.slack.com/web), [RealTime Messagin
       - [Rate Limiting](#rate-limiting)
       - [Other Errors](#other-errors)
   - [RealTime Client](#realtime-client)
-    - [Slack::RealTime::Stores::Store](#slackrealtimestoresstore)
-    - [Slack::RealTime::Stores::Starter](#slackrealtimestoresstarter)
-  - [Configuring Slack::RealTime::Client](#configuring-slackrealtimeclient)
-    - [Caveats](#caveats)
-      - [websocket_ping](#websocket_ping)
-  - [Connection Methods](#connection-methods)
+    - [Configuring Slack::RealTime::Client](#configuring-slackrealtimeclient)
+      - [Caveats](#caveats)
+        - [websocket_ping](#websocket_ping)
+    - [RealTime Store](#realtime-store)
+      - [Slack::RealTime::Stores::Starter](#slackrealtimestoresstarter)
+      - [Slack::RealTime::Stores::Store](#slackrealtimestoresstore)
   - [Combining RealTime and Web Clients](#combining-realtime-and-web-clients)
-  - [Large Team Considerations](#large-team-considerations)
     - [Concurrency](#concurrency)
       - [Async](#async)
   - [Events API](#events-api)
@@ -71,7 +70,7 @@ A Ruby client for the Slack [Web](https://api.slack.com/web), [RealTime Messagin
 
 ## Stable Release
 
-You're reading the documentation for the **stable** release of slack-ruby-client, 1.1.0. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
+You're reading the documentation for the **stable** release of slack-ruby-client, 2.0.0. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
 
 ## Installation
 
@@ -176,7 +175,7 @@ client.files_upload(
 
 ##### Get Channel Info
 
-You can use a channel ID or name (prefixed with `#`) in all functions that take a `:channel` argument. Lookup by name is not supported by the Slack API and the `channels_id` method called invokes `conversations_list` in order to locate the channel ID.
+You can use a channel ID or name (prefixed with `#`) in all functions that take a `:channel` argument. Lookup by name is not supported by the Slack API and the `channels_id` method called invokes `conversations_list` in order to locate the channel ID. This invocation can have a cost if you have many Slack channels. In this scenario, we encourage you to use channel id.
 
 ```ruby
 client.conversations_info(channel: 'C04KB5X4D') # calls conversations_info
@@ -374,32 +373,7 @@ You can send a ping with `ping`.
 client.ping
 ```
 
-By default, the RealTime client exposes and maintains a local store with the properties of [rtm.start](https://api.slack.com/methods/rtm.start) upon a successful connection.
-
-property | description
----------|-------------------------------------------------------------------------------------------------
-url      | A WebSocket Message Server URL.
-self     | The authenticated bot user.
-team     | Details on the authenticated user's team.
-users    | A hash of user objects by user ID.
-channels | A hash of channel objects, one for every channel visible to the authenticated user.
-groups   | A hash of group objects, one for every group the authenticated user is in.
-ims      | A hash of IM objects, one for every direct message channel visible to the authenticated user.
-bots     | Details of the integrations set up on this team.
-
-It also tracks changes, such as users being renamed, added or deleted, therefore `client.users` is always up-to-date.
-
-Tracking with a local store can be disabled with `Slack::RealTime::Client.new(store_class: nil)`. Other stores are also available.
-
-#### Slack::RealTime::Stores::Store
-
-The default store that tracks all changes. By default the client will be connected using `rtm_start`.
-
-#### Slack::RealTime::Stores::Starter
-
-A smaller store that only stores and tracks information about the bot user, but not channels, users, groups, ims or bots. By default the client will be connected using `rtm_connect`.
-
-### Configuring Slack::RealTime::Client
+#### Configuring Slack::RealTime::Client
 
 You can configure the RealTime client either globally or via the initializer.
 
@@ -420,20 +394,21 @@ setting         | description
 token           | Slack API token.
 websocket_ping  | How long the socket can be idle before sending a ping message to confirm it's still connected, default is 30.
 websocket_proxy | Connect via proxy, include `:origin` and `:headers`.
-store_class     | Local store class name, default is an in-memory `Slack::RealTime::Stores::Store`.
-start_method    | Optional start method, either `:rtm_start` or `:rtm_connect`.
-start_options   | Options to pass into `rtm.start` or `rtm.connect`, default is `{ request: { timeout: 180 } }`.
+start_options   | Options to pass to `rtm.connect`, default is `{ request: { timeout: 180 } }`.
+store_class     | Local store class, default is an in-memory `Slack::RealTime::Stores::Starter`.
+store_options   | Options to initialize the store, default is `{}`.
 logger          | Optional `Logger` instance that logs RealTime requests and socket data.
 
-Note that the RealTime client uses a Web client to obtain the WebSocket URL via [rtm.start](https://api.slack.com/methods/rtm.start) or [rtm.connect](https://api.slack.com/methods/rtm.connect). While `token` and `logger` options are passed down from the RealTime client, you may also configure Web client options via `Slack::Web::Client.configure` as described above.
+Note that the RealTime client uses a Web client to obtain the WebSocket URL via [rtm.connect](https://api.slack.com/methods/rtm.connect). While `token` and `logger` options are passed down from the RealTime client, you may also configure Web client options via `Slack::Web::Client.configure` as described above.
 
-See a fully working example in [examples/hi_real_time](examples/hi_real_time/hi.rb).
+See a fully working example in [examples/hi_real_time_and_web](examples/hi_real_time_and_web/hi.rb).
+
+![](examples/hi_real_time_and_web/hi.gif)
 
-![](examples/hi_real_time/hi.gif)
+##### Caveats
 
-#### Caveats
+###### `websocket_ping`
 
-##### `websocket_ping`
 This setting determines how long the socket can be idle before sending a ping message to confirm it's still connected.
 
 It's important to note that if a ping message was sent and no response was received within the amount of time specified in `websocket_ping` the client will attempt to reestablish it's connection to the message server.
@@ -442,16 +417,55 @@ Note that the ping may take between `websocket_ping` and `websocket_ping * 3/2`
 
 To disable this feature set `websocket_ping` to 0.
 
-### Connection Methods
+#### RealTime Store
+
+The RealTime client exposes and maintains a local store upon successful connection.
+Event hooks keep the store's cached data up-to-date.
+
+Tracking with a local store can be disabled with `Slack::RealTime::Client.new(store_class: nil)`.
+
+##### `Slack::RealTime::Stores::Starter`
+
+A small store that only caches and tracks data returned in the [rtm.connect](https://api.slack.com/methods/rtm.connect#examples) response.
+This store provides `self` and `team` for accessing the limited data about the authenticated user and its workspace, but does not cache other users or bots, channels, or direct messages.
+
+##### `Slack::RealTime::Stores::Store`
 
-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.
+A more complete store that tracks most changes visible to the authenticated user.
 
+You can see all of the cache types in the table below (each is a hash indexed by its objects' `id`).
+
+Cache              | Description
+-------------------|-------------------------------------------------------------------------------------------------
+`teams`            | Workspaces (teams). Will likely contain only one `team`.
+`users`            | All [user](https://api.slack.com/types/user) objects, including `self`.
+`bots`             | All [bot users](https://api.slack.com/bot-users) (from Slack Apps and legacy custom integrations).
+`public_channels`  | Public [conversation](https://api.slack.com/types/conversation) objects.
+`private_channels` | Private [conversation](https://api.slack.com/types/conversation) and [group](https://api.slack.com/types/group) objects with the authenticated user as a member.
+`ims`              | Visible [im](https://api.slack.com/types/im) objects, direct message channels with the authenticated user.
+`mpims`            | Visible [mpim](https://api.slack.com/types/mpim) objects, multiparty direct message channels that include the authenticated user.
+
+By default, none of these caches are initialized with data beyond what is returned from [rtm.connect](https://api.slack.com/methods/rtm.connect#examples), same as [Slack::RealTime::Stores::Starter](#slackrealtimestoresstarter).
+When configured, this store initializes its caches by making additional calls to Web API methods upon successful connection to the RTM API (i.e. "hello" message).
+
+Configure by specifying which caches to fetch:
+```ruby
+Slack::RealTime::Client.configure do |config|
+  config.store_class = Slack::RealTime::Stores::Store
+  config.store_options = { caches: %i[teams users public_channels private_channels ims] }
+end
+```
+or with the `:all` option:
 ```ruby
 Slack::RealTime::Client.configure do |config|
-  config.start_method = :rtm_start
+  config.store_class = Slack::RealTime::Stores::Store
+  config.store_options = { caches: :all }
 end
 ```
 
+Note: For `teams`, this makes a single call to `team.info`, while for `users` and all conversation-like types, this makes paginated calls to `users.list` and `conversations.list` respectively.
+Only `bots` requires a separate call for every bot user, so may be slow if your workplace has a lot of bot users.
+
 ### Combining RealTime and Web Clients
 
 Since the Web client is used to obtain the RealTime client's WebSocket URL, you can continue using the Web client in combination with the RealTime client.
@@ -475,23 +489,6 @@ See a fully working example in [examples/hi_real_time_and_web](examples/hi_real_
 
 ![](examples/hi_real_time_and_web/hi.gif)
 
-### Large Team Considerations
-
-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.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.
-  config.start_options[:no_unreads] = true
-  # Increase request timeout to 6 minutes.
-  config.start_options[:request][:timeout] = 360
-end
-```
-
-See [#134](https://github.com/slack-ruby/slack-ruby-client/issues/134) for a discussion on this topic.
-
 #### Concurrency
 
 `Slack::RealTime::Client` needs help from a concurrency library and supports [Async](https://github.com/socketry/async).

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.
 
-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.
+In the "Stable Release" section of the README, change `**next**` to `**stable**` and add the version number so users know that they are reading the documentation for a released version.
 
 ```
 ## Stable Release

data/UPGRADING.md

@@ -1,6 +1,34 @@
 Upgrading Slack-Ruby-Client
 ===========================
 
+### Upgrading to >= 2.0.0
+
+[#416](https://github.com/slack-ruby/slack-ruby-client/pull/416) Removes default values for Faraday's SSL settings `ca_file` and `ca_path`.
+
+If you previously relied on `OpenSSL::X509::DEFAULT_CERT_FILE` or `OpenSSL::X509::DEFAULT_CERT_DIR` to set these values you must now do so explicitly. E.g.:
+
+```ruby
+Slack::Web::Client.configure do |config|
+  config.ca_file = OpenSSL::X509::DEFAULT_CERT_FILE
+  config.ca_path = OpenSSL::X509::DEFAULT_CERT_DIR
+end
+```
+
+or
+
+```ruby
+client = Slack::Web::Client.new(ca_file: OpenSSL::X509::DEFAULT_CERT_FILE, ca_path: OpenSSL::X509::DEFAULT_CERT_DIR)
+```
+
+#### RealTime Stores
+
+Slack has deprecated the `rtm.start` method and [replaced its response](https://api.slack.com/changelog/2021-10-rtm-start-to-stop) with that of `rtm.connect`, so it has been removed from the library along with the `start_method` configuration ([#419](https://github.com/slack-ruby/slack-ruby-client/pull/419)) and `Slack::RealTime::Stores::Starter` is now the default store.
+If your app still relies on the old `rtm.start` behavior, you can achieve a similar result with `Slack::RealTime::Stores::Store`, which initializes itself using Web API methods (see [README](README.md#slackrealtimestoresstore)).
+
+The names of the Store caches `channels` and `groups` have been changed to `public_channels` and `private_channels` to reflect their true meaning.
+This is consistent with the [Slack Web API](https://api.slack.com/methods/conversations.list#arg_types), although [event types for private channels](https://api.slack.com/events?query=group) still use the term `group`.
+In both cases, private channels consist of both [conversation types](https://api.slack.com/types/conversation) (`id: 'C...'', is_channel: true, is_group: false, is_private: true`) and [group types](https://api.slack.com/types/group) (`id: 'G...', is_channel: false, is_group: true, is_private: true`) depending whether the object was created before or after March 2021.
+
 ### Upgrading to >= 1.0.0
 
 #### Deprecated Methods

data/bin/commands/admin_audit_anomaly_allow.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+desc 'AdminAuditAnomalyAllow methods.'
+command 'admin_audit_anomaly_allow' do |g|
+  g.desc 'API to allow enterprise grid admins to read the allow list of IP blocks and ASNs from the enterprise configuration.'
+  g.long_desc %( API to allow enterprise grid admins to read the allow list of IP blocks and ASNs from the enterprise configuration. )
+  g.command 'getItem' do |c|
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_audit_anomaly_allow_getItem(options))
+    end
+  end
+
+  g.desc 'API to allow enterprise grid admins to write/overwrite the allow list of IP blocks and ASNs from the enterprise configuration.'
+  g.long_desc %( API to allow enterprise grid admins to write/overwrite the allow list of IP blocks and ASNs from the enterprise configuration. )
+  g.command 'updateItem' do |c|
+    c.flag 'trusted_asns', desc: 'allow list of Autonomous System Numbers (ASN) in the enterprise grid configuarion.'
+    c.flag 'trusted_cidr', desc: 'allow list of IPv4 addressses using cidr notation in the enterprise grid configuarion.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_audit_anomaly_allow_updateItem(options))
+    end
+  end
+end

data/bin/commands/admin_conversations.rb

@@ -63,10 +63,10 @@ command 'admin_conversations' do |g|
     end
   end
 
-  g.desc "This API endpoint can be used by any admin to get a channel's retention policy."
-  g.long_desc %( This API endpoint can be used by any admin to get a channel's retention policy. )
+  g.desc "This API endpoint can be used by any admin to get a conversation's retention policy."
+  g.long_desc %( This API endpoint can be used by any admin to get a conversation's retention policy. )
   g.command 'getCustomRetention' do |c|
-    c.flag 'channel_id', desc: 'The channel to get the retention policy for.'
+    c.flag 'channel_id', desc: 'The conversation to get the retention policy for.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.admin_conversations_getCustomRetention(options))
     end
@@ -93,10 +93,10 @@ command 'admin_conversations' do |g|
     end
   end
 
-  g.desc "This API endpoint can be used by any admin to remove a channel's retention policy."
-  g.long_desc %( This API endpoint can be used by any admin to remove a channel's retention policy. )
+  g.desc "This API endpoint can be used by any admin to remove a conversation's retention policy."
+  g.long_desc %( This API endpoint can be used by any admin to remove a conversation's retention policy. )
   g.command 'removeCustomRetention' do |c|
-    c.flag 'channel_id', desc: 'The channel to set the retention policy for.'
+    c.flag 'channel_id', desc: 'The conversation to set the retention policy for.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.admin_conversations_removeCustomRetention(options))
     end
@@ -115,13 +115,14 @@ command 'admin_conversations' do |g|
   g.desc 'Search for public or private channels in an Enterprise organization.'
   g.long_desc %( Search for public or private channels in an Enterprise organization. )
   g.command 'search' do |c|
+    c.flag 'connected_team_ids', desc: 'Array of encoded team IDs, signifying the external orgs to search through.'
     c.flag 'cursor', desc: 'Set cursor to next_cursor returned by the previous call to list items in the next page.'
     c.flag 'limit', desc: 'Maximum number of items to be returned. Must be between 1 - 20 both inclusive. Default is 10.'
     c.flag 'query', desc: 'Name of the the channel to query by.'
     c.flag 'search_channel_types', desc: 'The type of channel to include or exclude in the search. For example private will search private channels, while private_exclude will exclude them. For a full list of types, check the Types section.'
     c.flag 'sort', desc: 'Possible values are relevant (search ranking based on what we think is closest), name (alphabetical), member_count (number of users in the channel), and created (date channel was created). You can optionally pair this with the sort_dir arg to change how it is sorted.'
     c.flag 'sort_dir', desc: 'Sort direction. Possible values are asc for ascending order like (1, 2, 3) or (a, b, c), and desc for descending order like (3, 2, 1) or (c, b, a).'
-    c.flag 'team_ids', desc: 'Comma separated string of team IDs, signifying the workspaces to search through.'
+    c.flag 'team_ids', desc: 'Comma separated string of team IDs, signifying the internal workspaces to search through.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.admin_conversations_search(options))
     end
@@ -137,11 +138,11 @@ command 'admin_conversations' do |g|
     end
   end
 
-  g.desc "This API endpoint can be used by any admin to set a channel's retention policy."
-  g.long_desc %( This API endpoint can be used by any admin to set a channel's retention policy. )
+  g.desc "This API endpoint can be used by any admin to set a conversation's retention policy."
+  g.long_desc %( This API endpoint can be used by any admin to set a conversation's retention policy. )
   g.command 'setCustomRetention' do |c|
-    c.flag 'channel_id', desc: 'The channel to set the retention policy for.'
-    c.flag 'duration_days', desc: 'The message retention duration in days to set for this channel.'
+    c.flag 'channel_id', desc: 'The conversation to set the retention policy for.'
+    c.flag 'duration_days', desc: 'The message retention duration in days to set for this conversation.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.admin_conversations_setCustomRetention(options))
     end

data/bin/commands/admin_users.rb

@@ -39,7 +39,7 @@ command 'admin_users' do |g|
   g.command 'list' do |c|
     c.flag 'cursor', desc: 'Set cursor to next_cursor returned by the previous call to list items in the next page.'
     c.flag 'limit', desc: 'Limit for how many users to be retrieved per page.'
-    c.flag 'team_id', desc: 'The ID (T1234) of the workspace.'
+    c.flag 'team_id', desc: 'The ID (T1234) of the workspace. The team_id is required if you use an org-level token.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.admin_users_list(options))
     end

data/bin/commands/admin_users_session.rb

@@ -68,7 +68,7 @@ command 'admin_users_session' do |g|
   g.desc 'Configure the user-level session settings—the session duration and what happens when the client closes—for one or more users.'
   g.long_desc %( Configure the user-level session settings—the session duration and what happens when the client closes—for one or more users. )
   g.command 'setSettings' do |c|
-    c.flag 'user_ids', desc: 'The list of user IDs to apply the session settings for.'
+    c.flag 'user_ids', desc: 'The list of up to 1,000 user IDs to apply the session settings for.'
     c.flag 'desktop_app_browser_quit', desc: 'Terminate the session when the client—either the desktop app or a browser window—is closed.'
     c.flag 'duration', desc: "The session duration, in seconds. The minimum value is 28800, which represents 8 hours; the max value is 315569520 or 10 years (that's a long Slack session)."
     c.action do |_global_options, options, _args|

data/bin/commands/apps_connections.rb

@@ -3,8 +3,8 @@
 
 desc 'AppsConnections methods.'
 command 'apps_connections' do |g|
-  g.desc 'Generate a temporary Socket Mode WebSocket URL that your app can connect to in order to receive events and interactive payloads over,'
-  g.long_desc %( Generate a temporary Socket Mode WebSocket URL that your app can connect to in order to receive events and interactive payloads over, )
+  g.desc 'Generate a temporary Socket Mode WebSocket URL that your app can connect to in order to receive events and interactive payloads over.'
+  g.long_desc %( Generate a temporary Socket Mode WebSocket URL that your app can connect to in order to receive events and interactive payloads over. )
   g.command 'open' do |c|
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.apps_connections_open(options))

data/bin/commands/bookmarks.rb

@@ -45,6 +45,7 @@ command 'bookmarks' do |g|
   g.command 'remove' do |c|
     c.flag 'bookmark_id', desc: 'Bookmark to remove.'
     c.flag 'channel_id', desc: 'Channel to remove bookmark.'
+    c.flag 'quip_section_id', desc: 'Quip section ID to unbookmark.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.bookmarks_remove(options))
     end