slack-ruby-client 0.15.1 → 0.16.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.rubocop.yml +1 -1
- data/.rubocop_todo.yml +0 -14
- data/.travis.yml +1 -4
- data/CHANGELOG.md +8 -0
- data/CONTRIBUTING.md +3 -10
- data/README.md +9 -27
- data/UPGRADING.md +14 -2
- data/bin/commands.rb +7 -0
- data/bin/commands/admin_analytics.rb +15 -0
- data/bin/commands/admin_apps.rb +15 -2
- data/bin/commands/admin_barriers.rb +47 -0
- data/bin/commands/admin_conversations.rb +154 -2
- data/bin/commands/admin_conversations_ekm.rb +17 -0
- data/bin/commands/admin_conversations_restrictAccess.rb +4 -4
- data/bin/commands/admin_conversations_whitelist.rb +1 -1
- data/bin/commands/admin_emoji.rb +1 -1
- data/bin/commands/admin_usergroups.rb +2 -2
- data/bin/commands/admin_users.rb +2 -2
- data/bin/commands/admin_users_session.rb +22 -0
- data/bin/commands/api.rb +0 -1
- data/bin/commands/apps_connections.rb +13 -0
- data/bin/commands/apps_event_authorizations.rb +16 -0
- data/bin/commands/auth_teams.rb +16 -0
- data/bin/commands/bots.rb +1 -0
- data/bin/commands/channels.rb +6 -3
- data/bin/commands/chat.rb +4 -4
- data/bin/commands/chat_scheduledMessages.rb +1 -0
- data/bin/commands/conversations.rb +14 -2
- data/bin/commands/dnd.rb +1 -1
- data/bin/commands/files.rb +6 -5
- data/bin/commands/files_remote.rb +2 -2
- data/bin/commands/groups.rb +5 -3
- data/bin/commands/im.rb +1 -1
- data/bin/commands/migration.rb +1 -0
- data/bin/commands/mpim.rb +3 -3
- data/bin/commands/pins.rb +0 -2
- data/bin/commands/reactions.rb +1 -0
- data/bin/commands/search.rb +4 -1
- data/bin/commands/team.rb +3 -0
- data/bin/commands/usergroups.rb +6 -1
- data/bin/commands/usergroups_users.rb +2 -0
- data/bin/commands/users.rb +5 -3
- data/bin/commands/users_profile.rb +5 -5
- data/bin/commands/views.rb +1 -1
- data/bin/commands/workflows.rb +38 -0
- data/lib/slack-ruby-client.rb +2 -0
- data/lib/slack/events/request.rb +5 -1
- data/lib/slack/real_time/client.rb +0 -1
- data/lib/slack/real_time/concurrency.rb +0 -2
- data/lib/slack/real_time/config.rb +5 -4
- data/lib/slack/version.rb +1 -1
- data/lib/slack/web/api/endpoints.rb +14 -0
- data/lib/slack/web/api/endpoints/admin_analytics.rb +26 -0
- data/lib/slack/web/api/endpoints/admin_apps.rb +22 -2
- data/lib/slack/web/api/endpoints/admin_barriers.rb +82 -0
- data/lib/slack/web/api/endpoints/admin_conversations.rb +231 -1
- data/lib/slack/web/api/endpoints/admin_conversations_ekm.rb +35 -0
- data/lib/slack/web/api/endpoints/admin_conversations_restrictAccess.rb +3 -3
- data/lib/slack/web/api/endpoints/admin_conversations_whitelist.rb +3 -3
- data/lib/slack/web/api/endpoints/admin_emoji.rb +1 -1
- data/lib/slack/web/api/endpoints/admin_usergroups.rb +1 -1
- data/lib/slack/web/api/endpoints/admin_users.rb +4 -6
- data/lib/slack/web/api/endpoints/admin_users_session.rb +38 -0
- data/lib/slack/web/api/endpoints/api.rb +0 -2
- data/lib/slack/web/api/endpoints/apps_connections.rb +21 -0
- data/lib/slack/web/api/endpoints/apps_event_authorizations.rb +34 -0
- data/lib/slack/web/api/endpoints/auth_teams.rb +33 -0
- data/lib/slack/web/api/endpoints/bots.rb +2 -0
- data/lib/slack/web/api/endpoints/channels.rb +9 -3
- data/lib/slack/web/api/endpoints/chat.rb +3 -3
- data/lib/slack/web/api/endpoints/chat_scheduledMessages.rb +2 -0
- data/lib/slack/web/api/endpoints/conversations.rb +21 -1
- data/lib/slack/web/api/endpoints/files.rb +4 -2
- data/lib/slack/web/api/endpoints/files_remote.rb +2 -2
- data/lib/slack/web/api/endpoints/groups.rb +7 -3
- data/lib/slack/web/api/endpoints/im.rb +1 -1
- data/lib/slack/web/api/endpoints/migration.rb +2 -0
- data/lib/slack/web/api/endpoints/mpim.rb +3 -3
- data/lib/slack/web/api/endpoints/pins.rb +0 -5
- data/lib/slack/web/api/endpoints/reactions.rb +2 -0
- data/lib/slack/web/api/endpoints/search.rb +6 -0
- data/lib/slack/web/api/endpoints/team.rb +6 -0
- data/lib/slack/web/api/endpoints/usergroups.rb +10 -0
- data/lib/slack/web/api/endpoints/usergroups_users.rb +4 -0
- data/lib/slack/web/api/endpoints/users.rb +7 -5
- data/lib/slack/web/api/endpoints/users_profile.rb +3 -3
- data/lib/slack/web/api/endpoints/views.rb +1 -1
- data/lib/slack/web/api/endpoints/workflows.rb +61 -0
- data/lib/slack/web/api/errors.rb +194 -0
- data/lib/slack/web/api/errors/internal_error.rb +14 -0
- data/lib/slack/web/api/templates/endpoints.erb +1 -0
- data/lib/slack/web/api/templates/method_spec.erb +1 -1
- data/lib/slack/web/faraday/connection.rb +1 -1
- data/lib/slack/web/faraday/response/raise_error.rb +16 -1
- data/lib/slack/web/faraday/response/wrap_error.rb +18 -0
- data/lib/tasks/web.rake +7 -3
- data/spec/slack/events/request_spec.rb +7 -3
- data/spec/slack/real_time/client_spec.rb +1 -1
- data/spec/slack/web/api/endpoints/admin_analytics_spec.rb +13 -0
- data/spec/slack/web/api/endpoints/admin_apps_spec.rb +5 -0
- data/spec/slack/web/api/endpoints/admin_barriers_spec.rb +38 -0
- data/spec/slack/web/api/endpoints/admin_conversations_ekm_spec.rb +8 -0
- data/spec/slack/web/api/endpoints/admin_conversations_restrictAccess_spec.rb +5 -5
- data/spec/slack/web/api/endpoints/admin_conversations_spec.rb +85 -0
- data/spec/slack/web/api/endpoints/admin_conversations_whitelist_spec.rb +5 -5
- data/spec/slack/web/api/endpoints/admin_emoji_spec.rb +6 -6
- data/spec/slack/web/api/endpoints/admin_teams_settings_spec.rb +10 -10
- data/spec/slack/web/api/endpoints/admin_teams_spec.rb +2 -2
- data/spec/slack/web/api/endpoints/admin_usergroups_spec.rb +6 -6
- data/spec/slack/web/api/endpoints/admin_users_session_spec.rb +8 -0
- data/spec/slack/web/api/endpoints/admin_users_spec.rb +15 -23
- data/spec/slack/web/api/endpoints/apps_connections_spec.rb +8 -0
- data/spec/slack/web/api/endpoints/apps_event_authorizations_spec.rb +13 -0
- data/spec/slack/web/api/endpoints/apps_permissions_spec.rb +2 -2
- data/spec/slack/web/api/endpoints/apps_permissions_users_spec.rb +3 -3
- data/spec/slack/web/api/endpoints/apps_spec.rb +2 -2
- data/spec/slack/web/api/endpoints/auth_teams_spec.rb +8 -0
- data/spec/slack/web/api/endpoints/calls_participants_spec.rb +4 -4
- data/spec/slack/web/api/endpoints/calls_spec.rb +2 -2
- data/spec/slack/web/api/endpoints/conversations_spec.rb +20 -12
- data/spec/slack/web/api/endpoints/files_comments_spec.rb +2 -2
- data/spec/slack/web/api/endpoints/files_remote_spec.rb +3 -3
- data/spec/slack/web/api/endpoints/files_spec.rb +4 -4
- data/spec/slack/web/api/endpoints/im_spec.rb +4 -4
- data/spec/slack/web/api/endpoints/mpim_spec.rb +4 -4
- data/spec/slack/web/api/endpoints/oauth_spec.rb +3 -3
- data/spec/slack/web/api/endpoints/pins_spec.rb +1 -4
- data/spec/slack/web/api/endpoints/reactions_spec.rb +3 -3
- data/spec/slack/web/api/endpoints/reminders_spec.rb +2 -2
- data/spec/slack/web/api/endpoints/usergroups_users_spec.rb +2 -2
- data/spec/slack/web/api/endpoints/workflows_spec.rb +26 -0
- data/spec/slack/web/client_spec.rb +56 -0
- data/spec/slack/web/faraday/response/raise_error_spec.rb +7 -6
- metadata +32 -19
- data/examples/hi_real_time/Gemfile +0 -6
- data/examples/hi_real_time/hi.gif +0 -0
- data/examples/hi_real_time/hi.rb +0 -41
- data/examples/hi_real_time_async_celluloid/Gemfile +0 -7
- data/examples/hi_real_time_async_celluloid/Procfile +0 -2
- data/examples/hi_real_time_async_celluloid/hi.rb +0 -39
- data/examples/hi_real_time_async_eventmachine/Gemfile +0 -7
- data/examples/hi_real_time_async_eventmachine/Procfile +0 -2
- data/examples/hi_real_time_async_eventmachine/hi.rb +0 -39
- data/lib/slack/real_time/concurrency/celluloid.rb +0 -142
- data/lib/slack/real_time/concurrency/eventmachine.rb +0 -85
- data/spec/slack/real_time/concurrency/celluloid_spec.rb +0 -116
- data/spec/slack/real_time/concurrency/eventmachine_spec.rb +0 -57
- data/spec/slack/web/api/errors/service_unavailable_spec.rb +0 -17
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 46bfdecfe74d4f64a551519516ce706fbd50d7e8f512df2f10cf991f4c3d153a
|
4
|
+
data.tar.gz: 8f8330671c68f4937026b7bf211eb623a5a4f03ac704fb2465c5ad70833ce610
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: b4eca0d30990e29c93ec5e2063cdfb7c9cbc9e0f4c23fe566b64af1c23dd2bc3dc2690937b43f9fb771035425fde4d023c29180592b01513a2d8a3ac4731511b
|
7
|
+
data.tar.gz: ca8c4a73812d77fe3b8bef823b2b7b1fa890c8efdab14a0bfa9094b5c171632f0ce33fb79493fc8444a21605397b63a38f4e890b1736afd74cfd14117a4dddcb
|
data/.rubocop.yml
CHANGED
data/.rubocop_todo.yml
CHANGED
@@ -18,13 +18,6 @@ Lint/RedundantCopDisableDirective:
|
|
18
18
|
Exclude:
|
19
19
|
- 'lib/slack-ruby-client.rb'
|
20
20
|
|
21
|
-
# Offense count: 2
|
22
|
-
# Configuration parameters: AllowComments.
|
23
|
-
Lint/SuppressedException:
|
24
|
-
Exclude:
|
25
|
-
- 'spec/slack/real_time/concurrency/celluloid_spec.rb'
|
26
|
-
- 'spec/slack/real_time/concurrency/eventmachine_spec.rb'
|
27
|
-
|
28
21
|
# Offense count: 11
|
29
22
|
# Configuration parameters: IgnoredMethods.
|
30
23
|
Metrics/AbcSize:
|
@@ -56,11 +49,6 @@ Performance/RegexpMatch:
|
|
56
49
|
Exclude:
|
57
50
|
- 'lib/tasks/web.rake'
|
58
51
|
|
59
|
-
# Offense count: 1
|
60
|
-
RSpec/AnyInstance:
|
61
|
-
Exclude:
|
62
|
-
- 'spec/slack/real_time/concurrency/celluloid_spec.rb'
|
63
|
-
|
64
52
|
# Offense count: 5
|
65
53
|
# Cop supports --auto-correct.
|
66
54
|
RSpec/ContextMethod:
|
@@ -134,8 +122,6 @@ RSpec/VerifiedDoubles:
|
|
134
122
|
Exclude:
|
135
123
|
- 'spec/slack/events/request_spec.rb'
|
136
124
|
- 'spec/slack/real_time/client_spec.rb'
|
137
|
-
- 'spec/slack/real_time/concurrency/celluloid_spec.rb'
|
138
|
-
- 'spec/slack/real_time/concurrency/eventmachine_spec.rb'
|
139
125
|
- 'spec/slack/web/faraday/response/raise_error_spec.rb'
|
140
126
|
- 'spec/support/real_time/connected_client.rb'
|
141
127
|
|
data/.travis.yml
CHANGED
@@ -5,6 +5,7 @@ cache: bundler
|
|
5
5
|
rvm:
|
6
6
|
- 2.5.3
|
7
7
|
- 2.6.0
|
8
|
+
- 2.7.1
|
8
9
|
- ruby-head
|
9
10
|
- jruby-head
|
10
11
|
|
@@ -13,10 +14,6 @@ matrix:
|
|
13
14
|
- rvm: 2.4.1
|
14
15
|
script:
|
15
16
|
- bundle exec danger
|
16
|
-
- rvm: 2.4.1
|
17
|
-
env: CONCURRENCY=celluloid-io
|
18
|
-
- rvm: 2.4.1
|
19
|
-
env: CONCURRENCY=faye-websocket
|
20
17
|
- rvm: 2.5.3
|
21
18
|
env: CONCURRENCY=async-websocket
|
22
19
|
allow_failures:
|
data/CHANGELOG.md
CHANGED
@@ -1,3 +1,11 @@
|
|
1
|
+
### 0.16.0 (2021/01/24)
|
2
|
+
|
3
|
+
* [#350](https://github.com/slack-ruby/slack-ruby-client/pull/350): Handle server errors such as timouts & non-json responses (see [Upgrading to 0.16.0](UPGRADING.md#upgrading-to--0160)) - [@ojab](https://github.com/ojab).
|
4
|
+
* [#354](https://github.com/slack-ruby/slack-ruby-client/pull/354): Rewind body after checking request signature - [@sunny](https://github.com/sunny).
|
5
|
+
* [#355](https://github.com/slack-ruby/slack-ruby-client/pull/355), [#357](https://github.com/slack-ruby/slack-ruby-client/pull/357): Removed celluloid and faye-websocket support - [@wasabigeek](https://github.com/wasabigeek).
|
6
|
+
* [#356](https://github.com/slack-ruby/slack-ruby-client/pull/356): Added `admin_apps_clearResolution`, `admin_conversations_getCustomRetention`, `admin_conversations_removeCustomRetention`, `admin_conversations_setCustomRetention` and `admin_users_session_list` endpoints - [@dblock](https://github.com/dblock).
|
7
|
+
* [#348](https://github.com/slack-ruby/slack-ruby-client/pull/348): Added `admin_conversations_archive`, `admin_conversations_convertToPrivate`, `admin_conversations_create`, `admin_conversations_delete`, `admin_conversations_disconnectShared`, `admin_conversations_getConversationPrefs`, `admin_conversations_getTeams`, `admin_conversations_invite`, `admin_conversations_rename`, `admin_conversations_search`, `admin_conversations_setConversationPrefs`, `admin_conversations_unarchive`, `admin_conversations_ekm_listOriginalConnectedChannelInfo`, `admin_users_session_invalidate`, `apps_event_authorizations_list`, `conversations_mark`, `workflows_stepCompleted`, `workflows_stepFailed` and `workflows_updateStep` endpoints - [@wasabigeek](https://github.com/wasabigeek).
|
8
|
+
|
1
9
|
### 0.15.1 (2020/9/3)
|
2
10
|
|
3
11
|
* [#336](https://github.com/slack-ruby/slack-ruby-client/pull/336): Fix: handle nil events - [@pyama86](https://github.com/pyama86).
|
data/CONTRIBUTING.md
CHANGED
@@ -89,16 +89,9 @@ The broad steps are:
|
|
89
89
|
##### Resolving Patch Errors
|
90
90
|
|
91
91
|
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:
|
92
|
-
1.
|
93
|
-
|
94
|
-
|
95
|
-
# puts "- patching #{patch}"
|
96
|
-
# system("git apply #{patch}") || raise('failed to apply patch')
|
97
|
-
# end
|
98
|
-
```
|
99
|
-
2. Run `rake slack:api:update` to create the raw auto-generated files. Commit the files that you are updating, so we can run `git diff` later.
|
100
|
-
3. 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.
|
101
|
-
4. Continue with Step 2 [above](#patching-slack-web-api).
|
92
|
+
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.
|
93
|
+
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.
|
94
|
+
3. Continue with Step 2 [above](#patching-slack-web-api).
|
102
95
|
|
103
96
|
|
104
97
|
### Write Documentation
|
data/README.md
CHANGED
@@ -47,8 +47,6 @@ A Ruby client for the Slack [Web](https://api.slack.com/web), [RealTime Messagin
|
|
47
47
|
- [Large Team Considerations](#large-team-considerations)
|
48
48
|
- [Concurrency](#concurrency)
|
49
49
|
- [Async](#async)
|
50
|
-
- [Faye::Websocket with Eventmachine](#fayewebsocket-with-eventmachine)
|
51
|
-
- [Celluloid](#celluloid)
|
52
50
|
- [Events API](#events-api)
|
53
51
|
- [Configuring Slack::Events](#configuring-slackevents)
|
54
52
|
- [Verifying the Request Signature](#verifying-the-request-signature)
|
@@ -72,7 +70,7 @@ A Ruby client for the Slack [Web](https://api.slack.com/web), [RealTime Messagin
|
|
72
70
|
|
73
71
|
## Stable Release
|
74
72
|
|
75
|
-
You're reading the documentation for the **stable** release of slack-ruby-client,
|
73
|
+
You're reading the documentation for the **stable** release of slack-ruby-client, 0.16.0. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
|
76
74
|
|
77
75
|
## Installation
|
78
76
|
|
@@ -82,7 +80,7 @@ Add to Gemfile.
|
|
82
80
|
gem 'slack-ruby-client'
|
83
81
|
```
|
84
82
|
|
85
|
-
If you're going to be using the RealTime client, add
|
83
|
+
If you're going to be using the RealTime client, add `async-websocket`. See below for more information about concurrency.
|
86
84
|
|
87
85
|
```
|
88
86
|
gem 'async-websocket', '~> 0.8.0'
|
@@ -326,7 +324,11 @@ If you exceed [Slack’s rate limits](https://api.slack.com/docs/rate-limits), a
|
|
326
324
|
|
327
325
|
##### Other Errors
|
328
326
|
|
329
|
-
In
|
327
|
+
In case of Slack temporarily unavailability a `Slack::Web::Api::Errors::ServerError` (`Slack::Web::Api::Errors::SlackError` subclass) subclasses will be raised and original `Faraday::Error` will be accesible via `exception.cause`.
|
328
|
+
|
329
|
+
Specifically `Slack::Web::Api::Errors::ParsingError` will be raised on non-json response (i. e. 200 OK with `Slack unavailable` HTML page) and `Slack::Web::Api::Errors::HttpRequestError` subclasses for connection failures (`Slack::Web::Api::Errors::TimeoutError` for read/open timeouts & `Slack::Web::Api::Errors::UnavailableError` for 5xx HTTP responses).
|
330
|
+
|
331
|
+
In any other case, a `Faraday::ClientError` will be raised.
|
330
332
|
|
331
333
|
### RealTime Client
|
332
334
|
|
@@ -491,7 +493,7 @@ See [#134](https://github.com/slack-ruby/slack-ruby-client/issues/134) for a dis
|
|
491
493
|
|
492
494
|
#### Concurrency
|
493
495
|
|
494
|
-
`Slack::RealTime::Client` needs help from a concurrency library and supports [Async](https://github.com/socketry/async)
|
496
|
+
`Slack::RealTime::Client` needs help from a concurrency library and supports [Async](https://github.com/socketry/async).
|
495
497
|
|
496
498
|
```ruby
|
497
499
|
Slack::RealTime.configure do |config|
|
@@ -509,7 +511,7 @@ client.start_async
|
|
509
511
|
|
510
512
|
##### Async
|
511
513
|
|
512
|
-
|
514
|
+
Add `async-websocket` to your Gemfile.
|
513
515
|
|
514
516
|
```
|
515
517
|
gem 'async-websocket'
|
@@ -517,26 +519,6 @@ gem 'async-websocket'
|
|
517
519
|
|
518
520
|
See a fully working example in [examples/hi_real_time_async_async](examples/hi_real_time_async_async/hi.rb).
|
519
521
|
|
520
|
-
##### Faye::Websocket with Eventmachine
|
521
|
-
|
522
|
-
Add the following to your Gemfile.
|
523
|
-
|
524
|
-
```
|
525
|
-
gem 'faye-websocket'
|
526
|
-
```
|
527
|
-
|
528
|
-
See a fully working example in [examples/hi_real_time_async_eventmachine](examples/hi_real_time_async_eventmachine/hi.rb).
|
529
|
-
|
530
|
-
##### Celluloid
|
531
|
-
|
532
|
-
Add the following to your Gemfile.
|
533
|
-
|
534
|
-
```
|
535
|
-
gem 'celluloid-io', require: ['celluloid/current', 'celluloid/io']
|
536
|
-
```
|
537
|
-
|
538
|
-
See a fully working example in [examples/hi_real_time_async_celluloid](examples/hi_real_time_async_celluloid/hi.rb).
|
539
|
-
|
540
522
|
### Events API
|
541
523
|
|
542
524
|
This library provides limited support for the [Slack Events API](https://api.slack.com/events-api).
|
data/UPGRADING.md
CHANGED
@@ -1,6 +1,20 @@
|
|
1
1
|
Upgrading Slack-Ruby-Client
|
2
2
|
===========================
|
3
3
|
|
4
|
+
### Upgrading to >= 0.16.0
|
5
|
+
|
6
|
+
#### Removed Celluloid and Faye-Websocket Concurrency Support
|
7
|
+
|
8
|
+
Concurrency support for `celluloid-io` and `faye-websocket` has been removed. If you are running a RealTime bot on Celluloid or Faye, you must upgrade to `async-websocket`. Please note that RealTime bots are deprecated by Slack, and we generally recommend you [migrate your classic, RealTime bot, to granular permissions](https://code.dblock.org/2020/11/30/migrating-classic-slack-ruby-bots-to-granular-permissions.html).
|
9
|
+
|
10
|
+
See [#338](https://github.com/slack-ruby/slack-ruby-client/issues/338) for more information.
|
11
|
+
|
12
|
+
#### Error Handling
|
13
|
+
|
14
|
+
As of 0.16.0 `Faraday::Error` exceptions sans `Faraday::ClientError` are wrapped into `Slack::Web::Api::Errors::ServerError`, so if you're rescuing `Faraday::Error` — you should adjust your code to use `Slack::Web::Api::Errors::ServerError` and use `exception.cause` if underlying `Faraday::Error` is needed.
|
15
|
+
|
16
|
+
See [README#other-errors](README.md#other-errors) and [#350](https://github.com/slack-ruby/slack-ruby-client/pull/350) for more information.
|
17
|
+
|
4
18
|
### Upgrading to >= 0.15.0
|
5
19
|
|
6
20
|
As of 0.15.0, `activesupport` is no longer required. Add `gem 'activesupport'` to your Gemfile if you required ActiveSupport via this library.
|
@@ -130,5 +144,3 @@ gem 'celluloid-io'
|
|
130
144
|
When in doubt, use `faye-websocket`.
|
131
145
|
|
132
146
|
See [#5](https://github.com/slack-ruby/slack-ruby-client/issues/5) for more information.
|
133
|
-
|
134
|
-
|
data/bin/commands.rb
CHANGED
@@ -1,11 +1,14 @@
|
|
1
1
|
# frozen_string_literal: true
|
2
2
|
# This file was auto-generated by lib/tasks/web.rake
|
3
3
|
|
4
|
+
require 'commands/admin_analytics'
|
4
5
|
require 'commands/admin_apps'
|
5
6
|
require 'commands/admin_apps_approved'
|
6
7
|
require 'commands/admin_apps_requests'
|
7
8
|
require 'commands/admin_apps_restricted'
|
9
|
+
require 'commands/admin_barriers'
|
8
10
|
require 'commands/admin_conversations'
|
11
|
+
require 'commands/admin_conversations_ekm'
|
9
12
|
require 'commands/admin_conversations_restrictAccess'
|
10
13
|
require 'commands/admin_conversations_whitelist'
|
11
14
|
require 'commands/admin_emoji'
|
@@ -21,11 +24,14 @@ require 'commands/admin_users'
|
|
21
24
|
require 'commands/admin_users_session'
|
22
25
|
require 'commands/api'
|
23
26
|
require 'commands/apps'
|
27
|
+
require 'commands/apps_connections'
|
28
|
+
require 'commands/apps_event_authorizations'
|
24
29
|
require 'commands/apps_permissions'
|
25
30
|
require 'commands/apps_permissions_resources'
|
26
31
|
require 'commands/apps_permissions_scopes'
|
27
32
|
require 'commands/apps_permissions_users'
|
28
33
|
require 'commands/auth'
|
34
|
+
require 'commands/auth_teams'
|
29
35
|
require 'commands/bots'
|
30
36
|
require 'commands/calls'
|
31
37
|
require 'commands/calls_participants'
|
@@ -60,3 +66,4 @@ require 'commands/users_admin'
|
|
60
66
|
require 'commands/users_prefs'
|
61
67
|
require 'commands/users_profile'
|
62
68
|
require 'commands/views'
|
69
|
+
require 'commands/workflows'
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
# This file was auto-generated by lib/tasks/web.rake
|
3
|
+
|
4
|
+
desc 'AdminAnalytics methods.'
|
5
|
+
command 'admin_analytics' do |g|
|
6
|
+
g.desc 'Retrieve analytics data for a given date, presented as a compressed JSON file'
|
7
|
+
g.long_desc %( Retrieve analytics data for a given date, presented as a compressed JSON file )
|
8
|
+
g.command 'getFile' do |c|
|
9
|
+
c.flag 'type', desc: 'The type of analytics to retrieve. The options are currently limited to member.'
|
10
|
+
c.flag 'date', desc: 'Date to retrieve the analytics data for, expressed as YYYY-MM-DD in UTC.'
|
11
|
+
c.action do |_global_options, options, _args|
|
12
|
+
puts JSON.dump($client.admin_analytics_getFile(options))
|
13
|
+
end
|
14
|
+
end
|
15
|
+
end
|
data/bin/commands/admin_apps.rb
CHANGED
@@ -7,19 +7,32 @@ command 'admin_apps' do |g|
|
|
7
7
|
g.long_desc %( Approve an app for installation on a workspace. )
|
8
8
|
g.command 'approve' do |c|
|
9
9
|
c.flag 'app_id', desc: 'The id of the app to approve.'
|
10
|
+
c.flag 'enterprise_id', desc: 'The ID of the enterprise to approve the app on.'
|
10
11
|
c.flag 'request_id', desc: 'The id of the request to approve.'
|
11
|
-
c.flag 'team_id', desc: '.'
|
12
|
+
c.flag 'team_id', desc: 'The ID of the workspace to approve the app on.'
|
12
13
|
c.action do |_global_options, options, _args|
|
13
14
|
puts JSON.dump($client.admin_apps_approve(options))
|
14
15
|
end
|
15
16
|
end
|
16
17
|
|
18
|
+
g.desc 'Clear an app resolution'
|
19
|
+
g.long_desc %( Clear an app resolution )
|
20
|
+
g.command 'clearResolution' do |c|
|
21
|
+
c.flag 'app_id', desc: 'The id of the app whose resolution you want to clear/undo.'
|
22
|
+
c.flag 'enterprise_id', desc: 'The enterprise to clear the app resolution from.'
|
23
|
+
c.flag 'team_id', desc: 'The workspace to clear the app resolution from.'
|
24
|
+
c.action do |_global_options, options, _args|
|
25
|
+
puts JSON.dump($client.admin_apps_clearResolution(options))
|
26
|
+
end
|
27
|
+
end
|
28
|
+
|
17
29
|
g.desc 'Restrict an app for installation on a workspace.'
|
18
30
|
g.long_desc %( Restrict an app for installation on a workspace. )
|
19
31
|
g.command 'restrict' do |c|
|
20
32
|
c.flag 'app_id', desc: 'The id of the app to restrict.'
|
33
|
+
c.flag 'enterprise_id', desc: 'The ID of the enterprise to approve the app on.'
|
21
34
|
c.flag 'request_id', desc: 'The id of the request to restrict.'
|
22
|
-
c.flag 'team_id', desc: '.'
|
35
|
+
c.flag 'team_id', desc: 'The ID of the workspace to approve the app on.'
|
23
36
|
c.action do |_global_options, options, _args|
|
24
37
|
puts JSON.dump($client.admin_apps_restrict(options))
|
25
38
|
end
|
@@ -0,0 +1,47 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
# This file was auto-generated by lib/tasks/web.rake
|
3
|
+
|
4
|
+
desc 'AdminBarriers methods.'
|
5
|
+
command 'admin_barriers' do |g|
|
6
|
+
g.desc 'Create an Information Barrier'
|
7
|
+
g.long_desc %( Create an Information Barrier )
|
8
|
+
g.command 'create' do |c|
|
9
|
+
c.flag 'barriered_from_usergroup_ids', desc: 'A list of IDP Groups ids that the primary usergroup is to be barriered from.'
|
10
|
+
c.flag 'primary_usergroup_id', desc: 'The id of the primary IDP Group.'
|
11
|
+
c.flag 'restricted_subjects', desc: 'What kind of interactions are blocked by this barrier? For v1, we only support a list of all 3, eg im, mpim, call.'
|
12
|
+
c.action do |_global_options, options, _args|
|
13
|
+
puts JSON.dump($client.admin_barriers_create(options))
|
14
|
+
end
|
15
|
+
end
|
16
|
+
|
17
|
+
g.desc 'Delete an existing Information Barrier'
|
18
|
+
g.long_desc %( Delete an existing Information Barrier )
|
19
|
+
g.command 'delete' do |c|
|
20
|
+
c.flag 'barrier_id', desc: "The ID of the barrier you're trying to delete."
|
21
|
+
c.action do |_global_options, options, _args|
|
22
|
+
puts JSON.dump($client.admin_barriers_delete(options))
|
23
|
+
end
|
24
|
+
end
|
25
|
+
|
26
|
+
g.desc 'Get all Information Barriers for your organization'
|
27
|
+
g.long_desc %( Get all Information Barriers for your organization )
|
28
|
+
g.command 'list' do |c|
|
29
|
+
c.flag 'cursor', desc: 'Set cursor to next_cursor returned by the previous call to list items in the next page.'
|
30
|
+
c.flag 'limit', desc: 'The maximum number of items to return. Must be between 1 - 1000 both inclusive.'
|
31
|
+
c.action do |_global_options, options, _args|
|
32
|
+
puts JSON.dump($client.admin_barriers_list(options))
|
33
|
+
end
|
34
|
+
end
|
35
|
+
|
36
|
+
g.desc 'Update an existing Information Barrier'
|
37
|
+
g.long_desc %( Update an existing Information Barrier )
|
38
|
+
g.command 'update' do |c|
|
39
|
+
c.flag 'barrier_id', desc: "The ID of the barrier you're trying to modify."
|
40
|
+
c.flag 'barriered_from_usergroup_ids', desc: 'A list of IDP Groups ids that the primary usergroup is to be barriered from.'
|
41
|
+
c.flag 'primary_usergroup_id', desc: 'The id of the primary IDP Group.'
|
42
|
+
c.flag 'restricted_subjects', desc: 'What kind of interactions are blocked by this barrier? For v1, we only support a list of all 3, eg im, mpim, call.'
|
43
|
+
c.action do |_global_options, options, _args|
|
44
|
+
puts JSON.dump($client.admin_barriers_update(options))
|
45
|
+
end
|
46
|
+
end
|
47
|
+
end
|
@@ -3,8 +3,151 @@
|
|
3
3
|
|
4
4
|
desc 'AdminConversations methods.'
|
5
5
|
command 'admin_conversations' do |g|
|
6
|
-
g.desc '
|
7
|
-
g.long_desc %(
|
6
|
+
g.desc 'Archive a public or private channel.'
|
7
|
+
g.long_desc %( Archive a public or private channel. )
|
8
|
+
g.command 'archive' do |c|
|
9
|
+
c.flag 'channel_id', desc: 'The channel to archive.'
|
10
|
+
c.action do |_global_options, options, _args|
|
11
|
+
puts JSON.dump($client.admin_conversations_archive(options))
|
12
|
+
end
|
13
|
+
end
|
14
|
+
|
15
|
+
g.desc 'Convert a public channel to a private channel.'
|
16
|
+
g.long_desc %( Convert a public channel to a private channel. )
|
17
|
+
g.command 'convertToPrivate' do |c|
|
18
|
+
c.flag 'channel_id', desc: 'The channel to convert to private.'
|
19
|
+
c.action do |_global_options, options, _args|
|
20
|
+
puts JSON.dump($client.admin_conversations_convertToPrivate(options))
|
21
|
+
end
|
22
|
+
end
|
23
|
+
|
24
|
+
g.desc 'Create a public or private channel-based conversation.'
|
25
|
+
g.long_desc %( Create a public or private channel-based conversation. )
|
26
|
+
g.command 'create' do |c|
|
27
|
+
c.flag 'is_private', desc: 'When true, creates a private channel instead of a public channel.'
|
28
|
+
c.flag 'name', desc: 'Name of the public or private channel to create.'
|
29
|
+
c.flag 'description', desc: 'Description of the public or private channel to create.'
|
30
|
+
c.flag 'org_wide', desc: 'When true, the channel will be available org-wide. Note: if the channel is not org_wide=true, you must specify a team_id for this channel.'
|
31
|
+
c.flag 'team_id', desc: 'The workspace to create the channel in. Note: this argument is required unless you set org_wide=true.'
|
32
|
+
c.action do |_global_options, options, _args|
|
33
|
+
puts JSON.dump($client.admin_conversations_create(options))
|
34
|
+
end
|
35
|
+
end
|
36
|
+
|
37
|
+
g.desc 'Delete a public or private channel.'
|
38
|
+
g.long_desc %( Delete a public or private channel. )
|
39
|
+
g.command 'delete' do |c|
|
40
|
+
c.flag 'channel_id', desc: 'The channel to delete.'
|
41
|
+
c.action do |_global_options, options, _args|
|
42
|
+
puts JSON.dump($client.admin_conversations_delete(options))
|
43
|
+
end
|
44
|
+
end
|
45
|
+
|
46
|
+
g.desc 'Disconnect a connected channel from one or more workspaces.'
|
47
|
+
g.long_desc %( Disconnect a connected channel from one or more workspaces. )
|
48
|
+
g.command 'disconnectShared' do |c|
|
49
|
+
c.flag 'channel_id', desc: 'The channel to be disconnected from some workspaces.'
|
50
|
+
c.flag 'leaving_team_ids', desc: 'The team to be removed from the channel. Currently only a single team id can be specified.'
|
51
|
+
c.action do |_global_options, options, _args|
|
52
|
+
puts JSON.dump($client.admin_conversations_disconnectShared(options))
|
53
|
+
end
|
54
|
+
end
|
55
|
+
|
56
|
+
g.desc 'Get conversation preferences for a public or private channel.'
|
57
|
+
g.long_desc %( Get conversation preferences for a public or private channel. )
|
58
|
+
g.command 'getConversationPrefs' do |c|
|
59
|
+
c.flag 'channel_id', desc: 'The channel to get preferences for.'
|
60
|
+
c.action do |_global_options, options, _args|
|
61
|
+
puts JSON.dump($client.admin_conversations_getConversationPrefs(options))
|
62
|
+
end
|
63
|
+
end
|
64
|
+
|
65
|
+
g.desc "This API endpoint can be used by any admin to get a channel's retention policy."
|
66
|
+
g.long_desc %( This API endpoint can be used by any admin to get a channel's retention policy. )
|
67
|
+
g.command 'getCustomRetention' do |c|
|
68
|
+
c.flag 'channel_id', desc: 'The channel to get the retention policy for.'
|
69
|
+
c.action do |_global_options, options, _args|
|
70
|
+
puts JSON.dump($client.admin_conversations_getCustomRetention(options))
|
71
|
+
end
|
72
|
+
end
|
73
|
+
|
74
|
+
g.desc 'Get all the workspaces a given public or private channel is connected to within this Enterprise org.'
|
75
|
+
g.long_desc %( Get all the workspaces a given public or private channel is connected to within this Enterprise org. )
|
76
|
+
g.command 'getTeams' do |c|
|
77
|
+
c.flag 'channel_id', desc: 'The channel to determine connected workspaces within the organization for.'
|
78
|
+
c.flag 'cursor', desc: 'Set cursor to next_cursor returned by the previous call to list items in the next page.'
|
79
|
+
c.flag 'limit', desc: 'The maximum number of items to return. Must be between 1 - 1000 both inclusive.'
|
80
|
+
c.action do |_global_options, options, _args|
|
81
|
+
puts JSON.dump($client.admin_conversations_getTeams(options))
|
82
|
+
end
|
83
|
+
end
|
84
|
+
|
85
|
+
g.desc 'Invite a user to a public or private channel.'
|
86
|
+
g.long_desc %( Invite a user to a public or private channel. )
|
87
|
+
g.command 'invite' do |c|
|
88
|
+
c.flag 'channel_id', desc: 'The channel that the users will be invited to.'
|
89
|
+
c.flag 'user_ids', desc: 'The users to invite.'
|
90
|
+
c.action do |_global_options, options, _args|
|
91
|
+
puts JSON.dump($client.admin_conversations_invite(options))
|
92
|
+
end
|
93
|
+
end
|
94
|
+
|
95
|
+
g.desc "This API endpoint can be used by any admin to remove a channel's retention policy."
|
96
|
+
g.long_desc %( This API endpoint can be used by any admin to remove a channel's retention policy. )
|
97
|
+
g.command 'removeCustomRetention' do |c|
|
98
|
+
c.flag 'channel_id', desc: 'The channel to set the retention policy for.'
|
99
|
+
c.action do |_global_options, options, _args|
|
100
|
+
puts JSON.dump($client.admin_conversations_removeCustomRetention(options))
|
101
|
+
end
|
102
|
+
end
|
103
|
+
|
104
|
+
g.desc 'Rename a public or private channel.'
|
105
|
+
g.long_desc %( Rename a public or private channel. )
|
106
|
+
g.command 'rename' do |c|
|
107
|
+
c.flag 'channel_id', desc: 'The channel to rename.'
|
108
|
+
c.flag 'name', desc: '.'
|
109
|
+
c.action do |_global_options, options, _args|
|
110
|
+
puts JSON.dump($client.admin_conversations_rename(options))
|
111
|
+
end
|
112
|
+
end
|
113
|
+
|
114
|
+
g.desc 'Search for public or private channels in an Enterprise organization.'
|
115
|
+
g.long_desc %( Search for public or private channels in an Enterprise organization. )
|
116
|
+
g.command 'search' do |c|
|
117
|
+
c.flag 'cursor', desc: 'Set cursor to next_cursor returned by the previous call to list items in the next page.'
|
118
|
+
c.flag 'limit', desc: 'Maximum number of items to be returned. Must be between 1 - 20 both inclusive. Default is 10.'
|
119
|
+
c.flag 'query', desc: 'Name of the the channel to query by.'
|
120
|
+
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.'
|
121
|
+
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.'
|
122
|
+
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).'
|
123
|
+
c.flag 'team_ids', desc: 'Comma separated string of team IDs, signifying the workspaces to search through.'
|
124
|
+
c.action do |_global_options, options, _args|
|
125
|
+
puts JSON.dump($client.admin_conversations_search(options))
|
126
|
+
end
|
127
|
+
end
|
128
|
+
|
129
|
+
g.desc 'Set the posting permissions for a public or private channel.'
|
130
|
+
g.long_desc %( Set the posting permissions for a public or private channel. )
|
131
|
+
g.command 'setConversationPrefs' do |c|
|
132
|
+
c.flag 'channel_id', desc: 'The channel to set the prefs for.'
|
133
|
+
c.flag 'prefs', desc: 'The prefs for this channel in a stringified JSON format.'
|
134
|
+
c.action do |_global_options, options, _args|
|
135
|
+
puts JSON.dump($client.admin_conversations_setConversationPrefs(options))
|
136
|
+
end
|
137
|
+
end
|
138
|
+
|
139
|
+
g.desc "This API endpoint can be used by any admin to set a channel's retention policy."
|
140
|
+
g.long_desc %( This API endpoint can be used by any admin to set a channel's retention policy. )
|
141
|
+
g.command 'setCustomRetention' do |c|
|
142
|
+
c.flag 'channel_id', desc: 'The channel to set the retention policy for.'
|
143
|
+
c.flag 'duration_days', desc: 'The message retention duration in days to set for this channel.'
|
144
|
+
c.action do |_global_options, options, _args|
|
145
|
+
puts JSON.dump($client.admin_conversations_setCustomRetention(options))
|
146
|
+
end
|
147
|
+
end
|
148
|
+
|
149
|
+
g.desc 'Set the workspaces in an Enterprise grid org that connect to a public or private channel.'
|
150
|
+
g.long_desc %( Set the workspaces in an Enterprise grid org that connect to a public or private channel. )
|
8
151
|
g.command 'setTeams' do |c|
|
9
152
|
c.flag 'channel_id', desc: 'The encoded channel_id to add or remove to workspaces.'
|
10
153
|
c.flag 'org_channel', desc: 'True if channel has to be converted to an org channel.'
|
@@ -14,4 +157,13 @@ command 'admin_conversations' do |g|
|
|
14
157
|
puts JSON.dump($client.admin_conversations_setTeams(options))
|
15
158
|
end
|
16
159
|
end
|
160
|
+
|
161
|
+
g.desc 'Unarchive a public or private channel.'
|
162
|
+
g.long_desc %( Unarchive a public or private channel. )
|
163
|
+
g.command 'unarchive' do |c|
|
164
|
+
c.flag 'channel_id', desc: 'The channel to unarchive.'
|
165
|
+
c.action do |_global_options, options, _args|
|
166
|
+
puts JSON.dump($client.admin_conversations_unarchive(options))
|
167
|
+
end
|
168
|
+
end
|
17
169
|
end
|