slack-ruby-client 0.7.9 → 0.16.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (358) hide show
  1. checksums.yaml +5 -5
  2. data/.github/FUNDING.yml +1 -0
  3. data/.gitignore +2 -0
  4. data/.rubocop.yml +32 -1
  5. data/.rubocop_todo.yml +98 -49
  6. data/.travis.yml +10 -14
  7. data/CHANGELOG.md +172 -24
  8. data/CONTRIBUTING.md +17 -6
  9. data/Dangerfile +2 -0
  10. data/Gemfile +10 -4
  11. data/LICENSE.md +1 -1
  12. data/README.md +276 -54
  13. data/RELEASING.md +19 -11
  14. data/Rakefile +2 -1
  15. data/UPGRADING.md +84 -2
  16. data/bin/commands.rb +43 -1
  17. data/bin/commands/admin_analytics.rb +15 -0
  18. data/bin/commands/admin_apps.rb +40 -0
  19. data/bin/commands/admin_apps_approved.rb +17 -0
  20. data/bin/commands/admin_apps_requests.rb +16 -0
  21. data/bin/commands/admin_apps_restricted.rb +17 -0
  22. data/bin/commands/admin_barriers.rb +47 -0
  23. data/bin/commands/admin_conversations.rb +169 -0
  24. data/bin/commands/admin_conversations_ekm.rb +17 -0
  25. data/bin/commands/admin_conversations_restrictAccess.rb +37 -0
  26. data/bin/commands/admin_conversations_whitelist.rb +37 -0
  27. data/bin/commands/admin_emoji.rb +54 -0
  28. data/bin/commands/admin_inviteRequests.rb +36 -0
  29. data/bin/commands/admin_inviteRequests_approved.rb +16 -0
  30. data/bin/commands/admin_inviteRequests_denied.rb +16 -0
  31. data/bin/commands/admin_teams.rb +27 -0
  32. data/bin/commands/admin_teams_admins.rb +16 -0
  33. data/bin/commands/admin_teams_owners.rb +16 -0
  34. data/bin/commands/admin_teams_settings.rb +64 -0
  35. data/bin/commands/admin_usergroups.rb +48 -0
  36. data/bin/commands/admin_users.rb +97 -0
  37. data/bin/commands/admin_users_session.rb +38 -0
  38. data/bin/commands/api.rb +3 -3
  39. data/bin/commands/apps.rb +15 -0
  40. data/bin/commands/apps_connections.rb +13 -0
  41. data/bin/commands/apps_event_authorizations.rb +16 -0
  42. data/bin/commands/apps_permissions.rb +23 -0
  43. data/bin/commands/apps_permissions_resources.rb +15 -0
  44. data/bin/commands/apps_permissions_scopes.rb +13 -0
  45. data/bin/commands/apps_permissions_users.rb +26 -0
  46. data/bin/commands/auth.rb +5 -4
  47. data/bin/commands/auth_teams.rb +16 -0
  48. data/bin/commands/bots.rb +4 -2
  49. data/bin/commands/calls.rb +52 -0
  50. data/bin/commands/calls_participants.rb +25 -0
  51. data/bin/commands/channels.rb +64 -43
  52. data/bin/commands/chat.rb +114 -24
  53. data/bin/commands/chat_scheduledMessages.rb +19 -0
  54. data/bin/commands/conversations.rb +196 -0
  55. data/bin/commands/dialog.rb +15 -0
  56. data/bin/commands/dnd.rb +9 -8
  57. data/bin/commands/emoji.rb +3 -2
  58. data/bin/commands/files.rb +45 -30
  59. data/bin/commands/files_comments.rb +3 -24
  60. data/bin/commands/files_remote.rb +78 -0
  61. data/bin/commands/groups.rb +53 -53
  62. data/bin/commands/im.rb +17 -13
  63. data/bin/commands/migration.rb +16 -0
  64. data/bin/commands/mpim.rb +16 -13
  65. data/bin/commands/oauth.rb +17 -2
  66. data/bin/commands/oauth_v2.rb +17 -0
  67. data/bin/commands/pins.rb +7 -10
  68. data/bin/commands/reactions.rb +17 -15
  69. data/bin/commands/reminders.rb +11 -10
  70. data/bin/commands/rtm.rb +19 -4
  71. data/bin/commands/search.rb +15 -11
  72. data/bin/commands/stars.rb +11 -8
  73. data/bin/commands/team.rb +15 -10
  74. data/bin/commands/team_profile.rb +3 -2
  75. data/bin/commands/usergroups.rb +22 -16
  76. data/bin/commands/usergroups_users.rb +7 -4
  77. data/bin/commands/users.rb +65 -37
  78. data/bin/commands/users_admin.rb +29 -0
  79. data/bin/commands/users_prefs.rb +13 -0
  80. data/bin/commands/users_profile.rb +8 -7
  81. data/bin/commands/views.rb +48 -0
  82. data/bin/commands/workflows.rb +38 -0
  83. data/bin/slack +3 -4
  84. data/examples/hi_real_time_and_web/Gemfile +1 -0
  85. data/examples/hi_real_time_and_web/hi.rb +8 -4
  86. data/examples/{hi_real_time_async_eventmachine → hi_real_time_async_async}/Gemfile +2 -1
  87. data/examples/{hi_real_time_async_celluloid → hi_real_time_async_async}/Procfile +0 -0
  88. data/examples/{hi_real_time_async_celluloid → hi_real_time_async_async}/hi.rb +13 -8
  89. data/examples/hi_web/Gemfile +1 -0
  90. data/examples/hi_web/hi.rb +2 -1
  91. data/examples/new_ticket/Gemfile +1 -0
  92. data/examples/new_ticket/new_ticket.rb +2 -1
  93. data/lib/slack-ruby-client.rb +40 -26
  94. data/lib/slack.rb +1 -0
  95. data/lib/slack/config.rb +1 -0
  96. data/lib/slack/events/config.rb +32 -0
  97. data/lib/slack/events/request.rb +70 -0
  98. data/lib/slack/logger.rb +6 -5
  99. data/lib/slack/messages/formatting.rb +4 -4
  100. data/lib/slack/messages/message.rb +2 -6
  101. data/lib/slack/real_time/api/message.rb +3 -1
  102. data/lib/slack/real_time/api/message_id.rb +1 -0
  103. data/lib/slack/real_time/api/ping.rb +5 -2
  104. data/lib/slack/real_time/api/templates/event_handler.erb +1 -1
  105. data/lib/slack/real_time/api/typing.rb +3 -1
  106. data/lib/slack/real_time/client.rb +113 -32
  107. data/lib/slack/real_time/concurrency.rb +2 -2
  108. data/lib/slack/real_time/concurrency/async.rb +140 -0
  109. data/lib/slack/real_time/config.rb +20 -12
  110. data/lib/slack/real_time/models.rb +8 -7
  111. data/lib/slack/real_time/models/base.rb +2 -6
  112. data/lib/slack/real_time/models/bot.rb +1 -0
  113. data/lib/slack/real_time/models/channel.rb +1 -0
  114. data/lib/slack/real_time/models/group.rb +1 -0
  115. data/lib/slack/real_time/models/im.rb +1 -0
  116. data/lib/slack/real_time/models/team.rb +1 -0
  117. data/lib/slack/real_time/models/user.rb +1 -0
  118. data/lib/slack/real_time/socket.rb +46 -17
  119. data/lib/slack/real_time/stores.rb +4 -3
  120. data/lib/slack/real_time/stores/base.rb +5 -3
  121. data/lib/slack/real_time/stores/starter.rb +113 -72
  122. data/lib/slack/real_time/stores/store.rb +131 -88
  123. data/lib/slack/version.rb +2 -1
  124. data/lib/slack/web/api/endpoints.rb +110 -26
  125. data/lib/slack/web/api/endpoints/admin_analytics.rb +26 -0
  126. data/lib/slack/web/api/endpoints/admin_apps.rb +62 -0
  127. data/lib/slack/web/api/endpoints/admin_apps_approved.rb +35 -0
  128. data/lib/slack/web/api/endpoints/admin_apps_requests.rb +33 -0
  129. data/lib/slack/web/api/endpoints/admin_apps_restricted.rb +35 -0
  130. data/lib/slack/web/api/endpoints/admin_barriers.rb +82 -0
  131. data/lib/slack/web/api/endpoints/admin_conversations.rb +260 -0
  132. data/lib/slack/web/api/endpoints/admin_conversations_ekm.rb +35 -0
  133. data/lib/slack/web/api/endpoints/admin_conversations_restrictAccess.rb +61 -0
  134. data/lib/slack/web/api/endpoints/admin_conversations_whitelist.rb +64 -0
  135. data/lib/slack/web/api/endpoints/admin_emoji.rb +88 -0
  136. data/lib/slack/web/api/endpoints/admin_inviteRequests.rb +61 -0
  137. data/lib/slack/web/api/endpoints/admin_inviteRequests_approved.rb +33 -0
  138. data/lib/slack/web/api/endpoints/admin_inviteRequests_denied.rb +33 -0
  139. data/lib/slack/web/api/endpoints/admin_teams.rb +50 -0
  140. data/lib/slack/web/api/endpoints/admin_teams_admins.rb +34 -0
  141. data/lib/slack/web/api/endpoints/admin_teams_owners.rb +34 -0
  142. data/lib/slack/web/api/endpoints/admin_teams_settings.rb +99 -0
  143. data/lib/slack/web/api/endpoints/admin_usergroups.rb +77 -0
  144. data/lib/slack/web/api/endpoints/admin_users.rb +161 -0
  145. data/lib/slack/web/api/endpoints/admin_users_session.rb +66 -0
  146. data/lib/slack/web/api/endpoints/api.rb +3 -4
  147. data/lib/slack/web/api/endpoints/apps.rb +27 -0
  148. data/lib/slack/web/api/endpoints/apps_connections.rb +21 -0
  149. data/lib/slack/web/api/endpoints/apps_event_authorizations.rb +34 -0
  150. data/lib/slack/web/api/endpoints/apps_permissions.rb +36 -0
  151. data/lib/slack/web/api/endpoints/apps_permissions_resources.rb +31 -0
  152. data/lib/slack/web/api/endpoints/apps_permissions_scopes.rb +21 -0
  153. data/lib/slack/web/api/endpoints/apps_permissions_users.rb +50 -0
  154. data/lib/slack/web/api/endpoints/auth.rb +5 -4
  155. data/lib/slack/web/api/endpoints/auth_teams.rb +33 -0
  156. data/lib/slack/web/api/endpoints/bots.rb +5 -2
  157. data/lib/slack/web/api/endpoints/calls.rb +83 -0
  158. data/lib/slack/web/api/endpoints/calls_participants.rb +42 -0
  159. data/lib/slack/web/api/endpoints/channels.rb +105 -49
  160. data/lib/slack/web/api/endpoints/chat.rb +221 -40
  161. data/lib/slack/web/api/endpoints/chat_scheduledMessages.rb +40 -0
  162. data/lib/slack/web/api/endpoints/conversations.rb +332 -0
  163. data/lib/slack/web/api/endpoints/dialog.rb +33 -0
  164. data/lib/slack/web/api/endpoints/dnd.rb +11 -9
  165. data/lib/slack/web/api/endpoints/emoji.rb +3 -2
  166. data/lib/slack/web/api/endpoints/files.rb +75 -38
  167. data/lib/slack/web/api/endpoints/files_comments.rb +3 -38
  168. data/lib/slack/web/api/endpoints/files_remote.rb +127 -0
  169. data/lib/slack/web/api/endpoints/groups.rb +76 -53
  170. data/lib/slack/web/api/endpoints/im.rb +38 -21
  171. data/lib/slack/web/api/endpoints/migration.rb +28 -0
  172. data/lib/slack/web/api/endpoints/mpim.rb +37 -22
  173. data/lib/slack/web/api/endpoints/oauth.rb +25 -4
  174. data/lib/slack/web/api/endpoints/oauth_v2.rb +30 -0
  175. data/lib/slack/web/api/endpoints/pins.rb +10 -19
  176. data/lib/slack/web/api/endpoints/presence.rb +1 -1
  177. data/lib/slack/web/api/endpoints/reactions.rb +37 -28
  178. data/lib/slack/web/api/endpoints/reminders.rb +11 -10
  179. data/lib/slack/web/api/endpoints/rtm.rb +28 -7
  180. data/lib/slack/web/api/endpoints/search.rb +21 -14
  181. data/lib/slack/web/api/endpoints/stars.rb +24 -15
  182. data/lib/slack/web/api/endpoints/team.rb +21 -13
  183. data/lib/slack/web/api/endpoints/team_profile.rb +3 -2
  184. data/lib/slack/web/api/endpoints/usergroups.rb +33 -22
  185. data/lib/slack/web/api/endpoints/usergroups_users.rb +9 -4
  186. data/lib/slack/web/api/endpoints/users.rb +78 -29
  187. data/lib/slack/web/api/endpoints/users_admin.rb +49 -0
  188. data/lib/slack/web/api/endpoints/users_prefs.rb +21 -0
  189. data/lib/slack/web/api/endpoints/users_profile.rb +11 -10
  190. data/lib/slack/web/api/endpoints/views.rb +97 -0
  191. data/lib/slack/web/api/endpoints/workflows.rb +61 -0
  192. data/lib/slack/web/api/error.rb +2 -8
  193. data/lib/slack/web/api/errors.rb +850 -0
  194. data/lib/slack/web/api/errors/internal_error.rb +14 -0
  195. data/lib/slack/web/api/errors/slack_error.rb +29 -0
  196. data/lib/slack/web/api/errors/too_many_requests_error.rb +24 -0
  197. data/lib/slack/web/api/mixins.rb +6 -4
  198. data/lib/slack/web/api/mixins/channels.id.rb +6 -7
  199. data/lib/slack/web/api/mixins/conversations.id.rb +25 -0
  200. data/lib/slack/web/api/mixins/groups.id.rb +6 -7
  201. data/lib/slack/web/api/mixins/ids.id.rb +24 -0
  202. data/lib/slack/web/api/mixins/users.id.rb +6 -7
  203. data/lib/slack/web/api/mixins/users.search.rb +39 -36
  204. data/lib/slack/web/api/patches/chat.1.patch +72 -0
  205. data/lib/slack/web/api/patches/dialog.1.open-json-support.patch +17 -0
  206. data/lib/slack/web/api/patches/views.1.view-json.patch +40 -0
  207. data/lib/slack/web/api/patches/views.1.views-published.patch +16 -0
  208. data/lib/slack/web/api/templates/command.erb +5 -3
  209. data/lib/slack/web/api/templates/commands.erb +2 -1
  210. data/lib/slack/web/api/templates/endpoints.erb +5 -3
  211. data/lib/slack/web/api/templates/errors.erb +20 -0
  212. data/lib/slack/web/api/templates/method.erb +26 -4
  213. data/lib/slack/web/api/templates/method_spec.erb +3 -2
  214. data/lib/slack/web/client.rb +2 -1
  215. data/lib/slack/web/config.rb +21 -10
  216. data/lib/slack/web/faraday/connection.rb +25 -16
  217. data/lib/slack/web/faraday/request.rb +2 -0
  218. data/lib/slack/web/faraday/response/raise_error.rb +23 -1
  219. data/lib/slack/web/faraday/response/wrap_error.rb +18 -0
  220. data/lib/slack/web/pagination/cursor.rb +52 -0
  221. data/lib/slack_ruby_client.rb +1 -0
  222. data/lib/tasks/git.rake +2 -1
  223. data/lib/tasks/real_time.rake +16 -6
  224. data/lib/tasks/update.rake +1 -0
  225. data/lib/tasks/web.rake +38 -10
  226. data/screenshots/create-app.png +0 -0
  227. data/slack-ruby-client.gemspec +9 -6
  228. data/spec/fixtures/slack/web/429_error.yml +2 -0
  229. data/spec/fixtures/slack/web/503_error.yml +14 -0
  230. data/spec/fixtures/slack/web/channels_info.yml +108 -15
  231. data/spec/fixtures/slack/web/conversations_setTopic.yml +69 -0
  232. data/spec/fixtures/slack/web/conversations_setTopic_one_page.yml +142 -0
  233. data/spec/fixtures/slack/web/conversations_setTopic_paginated.yml +208 -0
  234. data/spec/fixtures/slack/web/paginated_users_list.yml +181 -0
  235. data/spec/fixtures/slack/web/rtm_connect.yml +70 -0
  236. data/spec/fixtures/slack/web/rtm_start.yml +1 -1
  237. data/spec/fixtures/slack/web/views_open_error.yml +76 -0
  238. data/spec/integration/integration_spec.rb +116 -48
  239. data/spec/slack/config_spec.rb +2 -0
  240. data/spec/slack/events/config_spec.rb +33 -0
  241. data/spec/slack/events/request_spec.rb +183 -0
  242. data/spec/slack/messages/formatting_spec.rb +25 -14
  243. data/spec/slack/real_time/api/message_spec.rb +6 -1
  244. data/spec/slack/real_time/api/ping_spec.rb +2 -0
  245. data/spec/slack/real_time/api/typing_spec.rb +5 -1
  246. data/spec/slack/real_time/client_spec.rb +462 -134
  247. data/spec/slack/real_time/concurrency/it_behaves_like_a_realtime_socket.rb +3 -1
  248. data/spec/slack/real_time/event_handlers/bot_spec.rb +6 -3
  249. data/spec/slack/real_time/event_handlers/channel_spec.rb +9 -6
  250. data/spec/slack/real_time/event_handlers/event_handlers_spec.rb +3 -2
  251. data/spec/slack/real_time/event_handlers/group_spec.rb +5 -4
  252. data/spec/slack/real_time/event_handlers/im_spec.rb +4 -3
  253. data/spec/slack/real_time/event_handlers/team_spec.rb +8 -4
  254. data/spec/slack/real_time/event_handlers/user_spec.rb +5 -2
  255. data/spec/slack/real_time/rtm_connect_spec.rb +14 -0
  256. data/spec/slack/real_time/rtm_start_spec.rb +1 -0
  257. data/spec/slack/real_time/store_spec.rb +2 -1
  258. data/spec/slack/slack_spec.rb +39 -7
  259. data/spec/slack/version_spec.rb +2 -1
  260. data/spec/slack/web/api/endpoints/admin_analytics_spec.rb +13 -0
  261. data/spec/slack/web/api/endpoints/admin_apps_approved_spec.rb +8 -0
  262. data/spec/slack/web/api/endpoints/admin_apps_requests_spec.rb +8 -0
  263. data/spec/slack/web/api/endpoints/admin_apps_restricted_spec.rb +8 -0
  264. data/spec/slack/web/api/endpoints/admin_apps_spec.rb +13 -0
  265. data/spec/slack/web/api/endpoints/admin_barriers_spec.rb +38 -0
  266. data/spec/slack/web/api/endpoints/admin_conversations_ekm_spec.rb +8 -0
  267. data/spec/slack/web/api/endpoints/admin_conversations_restrictAccess_spec.rb +32 -0
  268. data/spec/slack/web/api/endpoints/admin_conversations_spec.rb +98 -0
  269. data/spec/slack/web/api/endpoints/admin_conversations_whitelist_spec.rb +32 -0
  270. data/spec/slack/web/api/endpoints/admin_emoji_spec.rb +37 -0
  271. data/spec/slack/web/api/endpoints/admin_inviteRequests_approved_spec.rb +8 -0
  272. data/spec/slack/web/api/endpoints/admin_inviteRequests_denied_spec.rb +8 -0
  273. data/spec/slack/web/api/endpoints/admin_inviteRequests_spec.rb +18 -0
  274. data/spec/slack/web/api/endpoints/admin_teams_admins_spec.rb +13 -0
  275. data/spec/slack/web/api/endpoints/admin_teams_owners_spec.rb +13 -0
  276. data/spec/slack/web/api/endpoints/admin_teams_settings_spec.rb +53 -0
  277. data/spec/slack/web/api/endpoints/admin_teams_spec.rb +16 -0
  278. data/spec/slack/web/api/endpoints/admin_usergroups_spec.rb +37 -0
  279. data/spec/slack/web/api/endpoints/admin_users_session_spec.rb +21 -0
  280. data/spec/slack/web/api/endpoints/admin_users_spec.rb +67 -0
  281. data/spec/slack/web/api/endpoints/api_spec.rb +1 -0
  282. data/spec/slack/web/api/endpoints/apps_connections_spec.rb +8 -0
  283. data/spec/slack/web/api/endpoints/apps_event_authorizations_spec.rb +13 -0
  284. data/spec/slack/web/api/endpoints/apps_permissions_resources_spec.rb +8 -0
  285. data/spec/slack/web/api/endpoints/apps_permissions_scopes_spec.rb +8 -0
  286. data/spec/slack/web/api/endpoints/apps_permissions_spec.rb +16 -0
  287. data/spec/slack/web/api/endpoints/apps_permissions_users_spec.rb +19 -0
  288. data/spec/slack/web/api/endpoints/apps_spec.rb +16 -0
  289. data/spec/slack/web/api/endpoints/auth_teams_spec.rb +8 -0
  290. data/spec/slack/web/api/endpoints/bots_spec.rb +1 -0
  291. data/spec/slack/web/api/endpoints/calls_participants_spec.rb +24 -0
  292. data/spec/slack/web/api/endpoints/calls_spec.rb +31 -0
  293. data/spec/slack/web/api/endpoints/chat_scheduledMessages_spec.rb +8 -0
  294. data/spec/slack/web/api/endpoints/conversations_spec.rb +109 -0
  295. data/spec/slack/web/api/endpoints/custom_specs/auth_spec.rb +13 -4
  296. data/spec/slack/web/api/endpoints/custom_specs/channels_spec.rb +5 -3
  297. data/spec/slack/web/api/endpoints/custom_specs/chat_spec.rb +140 -24
  298. data/spec/slack/web/api/endpoints/custom_specs/dialog_spec.rb +36 -0
  299. data/spec/slack/web/api/endpoints/custom_specs/groups_spec.rb +2 -0
  300. data/spec/slack/web/api/endpoints/custom_specs/users_spec.rb +21 -6
  301. data/spec/slack/web/api/endpoints/custom_specs/views_spec.rb +95 -0
  302. data/spec/slack/web/api/endpoints/dnd_spec.rb +6 -0
  303. data/spec/slack/web/api/endpoints/emoji_spec.rb +1 -0
  304. data/spec/slack/web/api/endpoints/files_comments_spec.rb +3 -21
  305. data/spec/slack/web/api/endpoints/files_remote_spec.rb +24 -0
  306. data/spec/slack/web/api/endpoints/files_spec.rb +17 -5
  307. data/spec/slack/web/api/endpoints/im_spec.rb +5 -4
  308. data/spec/slack/web/api/endpoints/migration_spec.rb +13 -0
  309. data/spec/slack/web/api/endpoints/mpim_spec.rb +5 -4
  310. data/spec/slack/web/api/endpoints/oauth_spec.rb +5 -4
  311. data/spec/slack/web/api/endpoints/oauth_v2_spec.rb +13 -0
  312. data/spec/slack/web/api/endpoints/pins_spec.rb +1 -0
  313. data/spec/slack/web/api/endpoints/reactions_spec.rb +8 -1
  314. data/spec/slack/web/api/endpoints/reminders_spec.rb +3 -2
  315. data/spec/slack/web/api/endpoints/rtm_spec.rb +1 -0
  316. data/spec/slack/web/api/endpoints/search_spec.rb +1 -0
  317. data/spec/slack/web/api/endpoints/stars_spec.rb +1 -0
  318. data/spec/slack/web/api/endpoints/team_profile_spec.rb +1 -0
  319. data/spec/slack/web/api/endpoints/team_spec.rb +1 -0
  320. data/spec/slack/web/api/endpoints/usergroups_spec.rb +1 -0
  321. data/spec/slack/web/api/endpoints/usergroups_users_spec.rb +3 -2
  322. data/spec/slack/web/api/endpoints/users_admin_spec.rb +18 -0
  323. data/spec/slack/web/api/endpoints/users_prefs_spec.rb +8 -0
  324. data/spec/slack/web/api/endpoints/users_profile_spec.rb +1 -0
  325. data/spec/slack/web/api/endpoints/views_spec.rb +29 -0
  326. data/spec/slack/web/api/endpoints/workflows_spec.rb +26 -0
  327. data/spec/slack/web/api/error_spec.rb +5 -3
  328. data/spec/slack/web/api/errors/slack_error_spec.rb +38 -0
  329. data/spec/slack/web/api/mixins/channels_spec.rb +24 -12
  330. data/spec/slack/web/api/mixins/conversations_list_spec.rb +21 -0
  331. data/spec/slack/web/api/mixins/conversations_spec.rb +43 -0
  332. data/spec/slack/web/api/mixins/groups_spec.rb +24 -12
  333. data/spec/slack/web/api/mixins/users_spec.rb +30 -17
  334. data/spec/slack/web/api/pagination/cursor_spec.rb +100 -0
  335. data/spec/slack/web/client_spec.rb +215 -14
  336. data/spec/slack/web/faraday/response/raise_error_spec.rb +85 -0
  337. data/spec/spec_helper.rb +8 -1
  338. data/spec/support/queue_with_timeout.rb +6 -5
  339. data/spec/support/real_time/concurrency/mock.rb +2 -2
  340. data/spec/support/real_time/connected_client.rb +13 -2
  341. data/spec/support/real_time/event.rb +1 -0
  342. data/spec/support/token.rb +1 -0
  343. data/spec/support/vcr.rb +6 -1
  344. metadata +280 -55
  345. data/examples/hi_real_time/Gemfile +0 -5
  346. data/examples/hi_real_time/hi.gif +0 -0
  347. data/examples/hi_real_time/hi.rb +0 -37
  348. data/examples/hi_real_time_async_celluloid/Gemfile +0 -6
  349. data/examples/hi_real_time_async_eventmachine/Procfile +0 -2
  350. data/examples/hi_real_time_async_eventmachine/hi.rb +0 -36
  351. data/lib/slack/real_time/concurrency/celluloid.rb +0 -113
  352. data/lib/slack/real_time/concurrency/eventmachine.rb +0 -60
  353. data/lib/slack/web/api/patches/chat.1.text-attachments-required.patch +0 -13
  354. data/lib/slack/web/api/patches/chat.2.attachments-json.patch +0 -17
  355. data/lib/slack/web/api/patches/chat.3.update-attachments-support.patch +0 -20
  356. data/screenshots/register-bot.png +0 -0
  357. data/spec/slack/real_time/concurrency/celluloid_spec.rb +0 -31
  358. data/spec/slack/real_time/concurrency/eventmachine_spec.rb +0 -47
@@ -0,0 +1,38 @@
1
+ # frozen_string_literal: true
2
+ # This file was auto-generated by lib/tasks/web.rake
3
+
4
+ desc 'AdminUsersSession methods.'
5
+ command 'admin_users_session' do |g|
6
+ g.desc 'Revoke a single session for a user. The user will be forced to login to Slack.'
7
+ g.long_desc %( Revoke a single session for a user. The user will be forced to login to Slack. )
8
+ g.command 'invalidate' do |c|
9
+ c.flag 'session_id', desc: 'ID of the session to invalidate.'
10
+ c.flag 'team_id', desc: 'ID of the workspace that the session belongs to.'
11
+ c.action do |_global_options, options, _args|
12
+ puts JSON.dump($client.admin_users_session_invalidate(options))
13
+ end
14
+ end
15
+
16
+ g.desc 'List active user sessions for an organization'
17
+ g.long_desc %( List active user sessions for an organization )
18
+ g.command 'list' do |c|
19
+ c.flag 'cursor', desc: 'Set cursor to next_cursor returned by the previous call to list items in the next page.'
20
+ c.flag 'limit', desc: 'The maximum number of items to return. Must be between 1 - 1000 both inclusive.'
21
+ c.flag 'team_id', desc: "The ID of the workspace you'd like active sessions for. If you pass a team_id, you'll need to pass a user_id as well."
22
+ c.flag 'user_id', desc: "The ID of user you'd like active sessions for. If you pass a user_id, you'll need to pass a team_id as well."
23
+ c.action do |_global_options, options, _args|
24
+ puts JSON.dump($client.admin_users_session_list(options))
25
+ end
26
+ end
27
+
28
+ g.desc 'Wipes all valid sessions on all devices for a given user'
29
+ g.long_desc %( Wipes all valid sessions on all devices for a given user )
30
+ g.command 'reset' do |c|
31
+ c.flag 'user_id', desc: 'The ID of the user to wipe sessions for.'
32
+ c.flag 'mobile_only', desc: 'Only expire mobile sessions (default: false).'
33
+ c.flag 'web_only', desc: 'Only expire web sessions (default: false).'
34
+ c.action do |_global_options, options, _args|
35
+ puts JSON.dump($client.admin_users_session_reset(options))
36
+ end
37
+ end
38
+ end
data/bin/commands/api.rb CHANGED
@@ -1,12 +1,12 @@
1
+ # frozen_string_literal: true
1
2
  # This file was auto-generated by lib/tasks/web.rake
2
3
 
3
4
  desc 'Api methods.'
4
5
  command 'api' do |g|
5
- g.desc 'This method helps you test your calling code.'
6
- g.long_desc %( This method helps you test your calling code. )
6
+ g.desc 'Checks API calling code.'
7
+ g.long_desc %( Checks API calling code. )
7
8
  g.command 'test' do |c|
8
9
  c.flag 'error', desc: 'Error response to return.'
9
- c.flag 'foo', desc: 'example property to return.'
10
10
  c.action do |_global_options, options, _args|
11
11
  puts JSON.dump($client.api_test(options))
12
12
  end
@@ -0,0 +1,15 @@
1
+ # frozen_string_literal: true
2
+ # This file was auto-generated by lib/tasks/web.rake
3
+
4
+ desc 'Apps methods.'
5
+ command 'apps' do |g|
6
+ g.desc 'Uninstalls your app from a workspace.'
7
+ g.long_desc %( Uninstalls your app from a workspace. )
8
+ g.command 'uninstall' do |c|
9
+ c.flag 'client_id', desc: 'Issued when you created your application.'
10
+ c.flag 'client_secret', desc: 'Issued when you created your application.'
11
+ c.action do |_global_options, options, _args|
12
+ puts JSON.dump($client.apps_uninstall(options))
13
+ end
14
+ end
15
+ end
@@ -0,0 +1,13 @@
1
+ # frozen_string_literal: true
2
+ # This file was auto-generated by lib/tasks/web.rake
3
+
4
+ desc 'AppsConnections methods.'
5
+ command 'apps_connections' do |g|
6
+ g.desc 'Generate a temporary Socket Mode WebSocket URL that your app can connect to in order to receive events and interactive payloads over,'
7
+ 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, )
8
+ g.command 'open' do |c|
9
+ c.action do |_global_options, options, _args|
10
+ puts JSON.dump($client.apps_connections_open(options))
11
+ end
12
+ end
13
+ end
@@ -0,0 +1,16 @@
1
+ # frozen_string_literal: true
2
+ # This file was auto-generated by lib/tasks/web.rake
3
+
4
+ desc 'AppsEventAuthorizations methods.'
5
+ command 'apps_event_authorizations' do |g|
6
+ g.desc 'Get a list of authorizations for the given event context. Each authorization represents an app installation that the event is visible to.'
7
+ g.long_desc %( Get a list of authorizations for the given event context. Each authorization represents an app installation that the event is visible to. )
8
+ g.command 'list' do |c|
9
+ c.flag 'event_context', desc: '.'
10
+ c.flag 'cursor', desc: '.'
11
+ c.flag 'limit', desc: '.'
12
+ c.action do |_global_options, options, _args|
13
+ puts JSON.dump($client.apps_event_authorizations_list(options))
14
+ end
15
+ end
16
+ end
@@ -0,0 +1,23 @@
1
+ # frozen_string_literal: true
2
+ # This file was auto-generated by lib/tasks/web.rake
3
+
4
+ desc 'AppsPermissions methods.'
5
+ command 'apps_permissions' do |g|
6
+ g.desc 'Returns list of permissions this app has on a team.'
7
+ g.long_desc %( Returns list of permissions this app has on a team. )
8
+ g.command 'info' do |c|
9
+ c.action do |_global_options, options, _args|
10
+ puts JSON.dump($client.apps_permissions_info(options))
11
+ end
12
+ end
13
+
14
+ g.desc 'Allows an app to request additional scopes'
15
+ g.long_desc %( Allows an app to request additional scopes )
16
+ g.command 'request' do |c|
17
+ c.flag 'scopes', desc: 'A comma separated list of scopes to request for.'
18
+ c.flag 'trigger_id', desc: 'Token used to trigger the permissions API.'
19
+ c.action do |_global_options, options, _args|
20
+ puts JSON.dump($client.apps_permissions_request(options))
21
+ end
22
+ end
23
+ end
@@ -0,0 +1,15 @@
1
+ # frozen_string_literal: true
2
+ # This file was auto-generated by lib/tasks/web.rake
3
+
4
+ desc 'AppsPermissionsResources methods.'
5
+ command 'apps_permissions_resources' do |g|
6
+ g.desc 'Returns list of resource grants this app has on a team.'
7
+ g.long_desc %( Returns list of resource grants this app has on a team. )
8
+ g.command 'list' do |c|
9
+ 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."
10
+ c.flag 'limit', desc: 'The maximum number of items to return.'
11
+ c.action do |_global_options, options, _args|
12
+ puts JSON.dump($client.apps_permissions_resources_list(options))
13
+ end
14
+ end
15
+ end
@@ -0,0 +1,13 @@
1
+ # frozen_string_literal: true
2
+ # This file was auto-generated by lib/tasks/web.rake
3
+
4
+ desc 'AppsPermissionsScopes methods.'
5
+ command 'apps_permissions_scopes' do |g|
6
+ g.desc 'Returns list of scopes this app has on a team.'
7
+ g.long_desc %( Returns list of scopes this app has on a team. )
8
+ g.command 'list' do |c|
9
+ c.action do |_global_options, options, _args|
10
+ puts JSON.dump($client.apps_permissions_scopes_list(options))
11
+ end
12
+ end
13
+ end
@@ -0,0 +1,26 @@
1
+ # frozen_string_literal: true
2
+ # This file was auto-generated by lib/tasks/web.rake
3
+
4
+ desc 'AppsPermissionsUsers methods.'
5
+ command 'apps_permissions_users' do |g|
6
+ g.desc 'Returns list of user grants and corresponding scopes this app has on a team.'
7
+ g.long_desc %( Returns list of user grants and corresponding scopes this app has on a team. )
8
+ g.command 'list' do |c|
9
+ 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."
10
+ c.flag 'limit', desc: 'The maximum number of items to return.'
11
+ c.action do |_global_options, options, _args|
12
+ puts JSON.dump($client.apps_permissions_users_list(options))
13
+ end
14
+ end
15
+
16
+ g.desc 'Enables an app to trigger a permissions modal to grant an app access to a user access scope.'
17
+ g.long_desc %( Enables an app to trigger a permissions modal to grant an app access to a user access scope. )
18
+ g.command 'request' do |c|
19
+ c.flag 'scopes', desc: 'A comma separated list of user scopes to request for.'
20
+ c.flag 'trigger_id', desc: 'Token used to trigger the request.'
21
+ c.flag 'user', desc: 'The user this scope is being requested for.'
22
+ c.action do |_global_options, options, _args|
23
+ puts JSON.dump($client.apps_permissions_users_request(options))
24
+ end
25
+ end
26
+ end
data/bin/commands/auth.rb CHANGED
@@ -1,9 +1,10 @@
1
+ # frozen_string_literal: true
1
2
  # This file was auto-generated by lib/tasks/web.rake
2
3
 
3
4
  desc 'Auth methods.'
4
5
  command 'auth' do |g|
5
- g.desc 'This method revokes an access token. Use it when you no longer need a token. For example, with a Sign In With Slack app, call this to log a user out.'
6
- g.long_desc %( This method revokes an access token. Use it when you no longer need a token. For example, with a Sign In With Slack app, call this to log a user out. )
6
+ g.desc 'Revokes a token.'
7
+ g.long_desc %( Revokes a token. )
7
8
  g.command 'revoke' do |c|
8
9
  c.flag 'test', desc: 'Setting this parameter to 1 triggers a testing mode where the specified token will not actually be revoked.'
9
10
  c.action do |_global_options, options, _args|
@@ -11,8 +12,8 @@ command 'auth' do |g|
11
12
  end
12
13
  end
13
14
 
14
- g.desc 'This method checks authentication and tells you who you are.'
15
- g.long_desc %( This method checks authentication and tells you who you are. )
15
+ g.desc 'Checks authentication & identity.'
16
+ g.long_desc %( Checks authentication & identity. )
16
17
  g.command 'test' do |c|
17
18
  c.action do |_global_options, options, _args|
18
19
  puts JSON.dump($client.auth_test(options))
@@ -0,0 +1,16 @@
1
+ # frozen_string_literal: true
2
+ # This file was auto-generated by lib/tasks/web.rake
3
+
4
+ desc 'AuthTeams methods.'
5
+ command 'auth_teams' do |g|
6
+ g.desc 'List the workspaces a token can access.'
7
+ g.long_desc %( List the workspaces a token can access. )
8
+ g.command 'list' do |c|
9
+ c.flag 'cursor', desc: 'Set cursor to next_cursor returned by the previous call to list items in the next page.'
10
+ c.flag 'include_icon', desc: 'Whether to return icon paths for each workspace. An icon path represents a URI pointing to the image signifying the workspace.'
11
+ c.flag 'limit', desc: 'The maximum number of workspaces to return. Must be a positive integer no larger than 1000.'
12
+ c.action do |_global_options, options, _args|
13
+ puts JSON.dump($client.auth_teams_list(options))
14
+ end
15
+ end
16
+ end
data/bin/commands/bots.rb CHANGED
@@ -1,11 +1,13 @@
1
+ # frozen_string_literal: true
1
2
  # This file was auto-generated by lib/tasks/web.rake
2
3
 
3
4
  desc 'Bots methods.'
4
5
  command 'bots' do |g|
5
- g.desc 'This method returns information about a bot user.'
6
- g.long_desc %( This method returns information about a bot user. )
6
+ g.desc 'Gets information about a bot user.'
7
+ g.long_desc %( Gets information about a bot user. )
7
8
  g.command 'info' do |c|
8
9
  c.flag 'bot', desc: 'Bot user to get info on.'
10
+ c.flag 'team_id', desc: 'encoded team id or enterprise id where the bot exists, required if org token is used.'
9
11
  c.action do |_global_options, options, _args|
10
12
  puts JSON.dump($client.bots_info(options))
11
13
  end
@@ -0,0 +1,52 @@
1
+ # frozen_string_literal: true
2
+ # This file was auto-generated by lib/tasks/web.rake
3
+
4
+ desc 'Calls methods.'
5
+ command 'calls' do |g|
6
+ g.desc 'Registers a new Call.'
7
+ g.long_desc %( Registers a new Call. )
8
+ g.command 'add' do |c|
9
+ c.flag 'external_unique_id', desc: 'An ID supplied by the 3rd-party Call provider. It must be unique across all Calls from that service.'
10
+ c.flag 'join_url', desc: 'The URL required for a client to join the Call.'
11
+ c.flag 'created_by', desc: 'The valid Slack user ID of the user who created this Call. When this method is called with a user token, the created_by field is optional and defaults to the authed user of the token. Otherwise, the field is required.'
12
+ c.flag 'date_start', desc: 'Call start time in UTC UNIX timestamp format.'
13
+ c.flag 'desktop_app_join_url', desc: 'When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL.'
14
+ c.flag 'external_display_id', desc: 'An optional, human-readable ID supplied by the 3rd-party Call provider. If supplied, this ID will be displayed in the Call object.'
15
+ c.flag 'title', desc: 'The name of the Call.'
16
+ c.flag 'users', desc: 'The list of users to register as participants in the Call. Read more on how to specify users here.'
17
+ c.action do |_global_options, options, _args|
18
+ puts JSON.dump($client.calls_add(options))
19
+ end
20
+ end
21
+
22
+ g.desc 'Ends a Call.'
23
+ g.long_desc %( Ends a Call. )
24
+ g.command 'end' do |c|
25
+ c.flag 'id', desc: 'id returned when registering the call using the calls.add method.'
26
+ c.flag 'duration', desc: 'Call duration in seconds.'
27
+ c.action do |_global_options, options, _args|
28
+ puts JSON.dump($client.calls_end(options))
29
+ end
30
+ end
31
+
32
+ g.desc 'Returns information about a Call.'
33
+ g.long_desc %( Returns information about a Call. )
34
+ g.command 'info' do |c|
35
+ c.flag 'id', desc: 'id of the Call returned by the calls.add method.'
36
+ c.action do |_global_options, options, _args|
37
+ puts JSON.dump($client.calls_info(options))
38
+ end
39
+ end
40
+
41
+ g.desc 'Updates information about a Call.'
42
+ g.long_desc %( Updates information about a Call. )
43
+ g.command 'update' do |c|
44
+ c.flag 'id', desc: 'id returned by the calls.add method.'
45
+ c.flag 'desktop_app_join_url', desc: 'When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL.'
46
+ c.flag 'join_url', desc: 'The URL required for a client to join the Call.'
47
+ c.flag 'title', desc: 'The name of the Call.'
48
+ c.action do |_global_options, options, _args|
49
+ puts JSON.dump($client.calls_update(options))
50
+ end
51
+ end
52
+ end
@@ -0,0 +1,25 @@
1
+ # frozen_string_literal: true
2
+ # This file was auto-generated by lib/tasks/web.rake
3
+
4
+ desc 'CallsParticipants methods.'
5
+ command 'calls_participants' do |g|
6
+ g.desc 'Registers new participants added to a Call.'
7
+ g.long_desc %( Registers new participants added to a Call. )
8
+ g.command 'add' do |c|
9
+ c.flag 'id', desc: 'id returned by the calls.add method.'
10
+ c.flag 'users', desc: 'The list of users to add as participants in the Call. Read more on how to specify users here.'
11
+ c.action do |_global_options, options, _args|
12
+ puts JSON.dump($client.calls_participants_add(options))
13
+ end
14
+ end
15
+
16
+ g.desc 'Registers participants removed from a Call.'
17
+ g.long_desc %( Registers participants removed from a Call. )
18
+ g.command 'remove' do |c|
19
+ c.flag 'id', desc: 'id returned by the calls.add method.'
20
+ c.flag 'users', desc: 'The list of users to remove as participants in the Call. Read more on how to specify users here.'
21
+ c.action do |_global_options, options, _args|
22
+ puts JSON.dump($client.calls_participants_remove(options))
23
+ end
24
+ end
25
+ end
@@ -1,9 +1,10 @@
1
+ # frozen_string_literal: true
1
2
  # This file was auto-generated by lib/tasks/web.rake
2
3
 
3
4
  desc "Get info on your team's Slack channels, create or archive channels, invite users, set the topic and purpose, and mark a channel as read."
4
5
  command 'channels' do |g|
5
- g.desc 'This method archives a channel.'
6
- g.long_desc %( This method archives a channel. )
6
+ g.desc 'Archives a channel.'
7
+ g.long_desc %( Archives a channel. )
7
8
  g.command 'archive' do |c|
8
9
  c.flag 'channel', desc: 'Channel to archive.'
9
10
  c.action do |_global_options, options, _args|
@@ -11,39 +12,60 @@ command 'channels' do |g|
11
12
  end
12
13
  end
13
14
 
14
- g.desc 'This method is used to create a channel.'
15
- g.long_desc %( This method is used to create a channel. )
15
+ g.desc 'Creates a channel.'
16
+ g.long_desc %( Creates a channel. )
16
17
  g.command 'create' do |c|
17
18
  c.flag 'name', desc: 'Name of channel to create.'
19
+ c.flag 'team_id', desc: 'encoded team id to create the channel in, required if org token is used.'
20
+ c.flag 'validate', desc: 'Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria.'
18
21
  c.action do |_global_options, options, _args|
19
22
  puts JSON.dump($client.channels_create(options))
20
23
  end
21
24
  end
22
25
 
23
- g.desc 'This method returns a portion of message events from the specified channel.'
24
- g.long_desc %( This method returns a portion of message events from the specified channel. )
26
+ g.desc 'Delete a channel (undocumented)'
27
+ g.long_desc %( Delete a channel )
28
+ g.command 'delete' do |c|
29
+ c.flag 'channel', desc: 'Channel to delete.'
30
+ c.action do |_global_options, options, _args|
31
+ puts JSON.dump($client.channels_delete(options))
32
+ end
33
+ end
34
+
35
+ g.desc 'Fetches history of messages and events from a channel.'
36
+ g.long_desc %( Fetches history of messages and events from a channel. )
25
37
  g.command 'history' do |c|
26
38
  c.flag 'channel', desc: 'Channel to fetch history for.'
39
+ c.flag 'inclusive', desc: 'Include messages with latest or oldest timestamp in results.'
27
40
  c.flag 'latest', desc: 'End of time range of messages to include in results.'
28
41
  c.flag 'oldest', desc: 'Start of time range of messages to include in results.'
29
- c.flag 'inclusive', desc: 'Include messages with latest or oldest timestamp in results.'
30
42
  c.flag 'unreads', desc: 'Include unread_count_display in the output?.'
31
43
  c.action do |_global_options, options, _args|
32
44
  puts JSON.dump($client.channels_history(options))
33
45
  end
34
46
  end
35
47
 
36
- g.desc 'This method returns information about a team channel.'
37
- g.long_desc %( This method returns information about a team channel. )
48
+ g.desc 'This method returns the ID of a team channel.'
49
+ g.long_desc %( This method returns the ID of a team channel. )
50
+ g.command 'id' do |c|
51
+ c.flag 'channel', desc: 'Channel to get ID for, prefixed with #.'
52
+ c.action do |_global_options, options, _args|
53
+ puts JSON.dump($client.channels_id(options))
54
+ end
55
+ end
56
+
57
+ g.desc 'Gets information about a channel.'
58
+ g.long_desc %( Gets information about a channel. )
38
59
  g.command 'info' do |c|
39
60
  c.flag 'channel', desc: 'Channel to get info on.'
61
+ c.flag 'include_locale', desc: 'Set this to true to receive the locale for this channel. Defaults to false.'
40
62
  c.action do |_global_options, options, _args|
41
63
  puts JSON.dump($client.channels_info(options))
42
64
  end
43
65
  end
44
66
 
45
- g.desc 'This method is used to invite a user to a channel. The calling user must be a member of the channel.'
46
- g.long_desc %( This method is used to invite a user to a channel. The calling user must be a member of the channel. )
67
+ g.desc 'Invites a user to a channel.'
68
+ g.long_desc %( Invites a user to a channel. )
47
69
  g.command 'invite' do |c|
48
70
  c.flag 'channel', desc: 'Channel to invite user to.'
49
71
  c.flag 'user', desc: 'User to invite to channel.'
@@ -52,17 +74,19 @@ command 'channels' do |g|
52
74
  end
53
75
  end
54
76
 
55
- g.desc 'This method is used to join a channel. If the channel does not exist, it is'
56
- g.long_desc %( This method is used to join a channel. If the channel does not exist, it is created. )
77
+ g.desc 'Joins a channel, creating it if needed.'
78
+ g.long_desc %( Joins a channel, creating it if needed. )
57
79
  g.command 'join' do |c|
58
80
  c.flag 'name', desc: 'Name of channel to join.'
81
+ c.flag 'team_id', desc: 'encoded team id to list channels in, required if org token is used.'
82
+ c.flag 'validate', desc: 'Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria.'
59
83
  c.action do |_global_options, options, _args|
60
84
  puts JSON.dump($client.channels_join(options))
61
85
  end
62
86
  end
63
87
 
64
- g.desc 'This method allows a user to remove another member from a team channel.'
65
- g.long_desc %( This method allows a user to remove another member from a team channel. )
88
+ g.desc 'Removes a user from a channel.'
89
+ g.long_desc %( Removes a user from a channel. )
66
90
  g.command 'kick' do |c|
67
91
  c.flag 'channel', desc: 'Channel to remove user from.'
68
92
  c.flag 'user', desc: 'User to remove from channel.'
@@ -71,8 +95,8 @@ command 'channels' do |g|
71
95
  end
72
96
  end
73
97
 
74
- g.desc 'This method is used to leave a channel.'
75
- g.long_desc %( This method is used to leave a channel. )
98
+ g.desc 'Leaves a channel.'
99
+ g.long_desc %( Leaves a channel. )
76
100
  g.command 'leave' do |c|
77
101
  c.flag 'channel', desc: 'Channel to leave.'
78
102
  c.action do |_global_options, options, _args|
@@ -80,37 +104,42 @@ command 'channels' do |g|
80
104
  end
81
105
  end
82
106
 
83
- g.desc 'This method returns a list of all channels in the team. This includes channels the caller is in, channels they are not currently in, and archived channels but does not include private channels. The number of (non-deactivated) members in each channel is also returned.'
84
- g.long_desc %( This method returns a list of all channels in the team. This includes channels the caller is in, channels they are not currently in, and archived channels but does not include private channels. The number of (non-deactivated) members in each channel is also returned. )
107
+ g.desc 'Lists all channels in a Slack team.'
108
+ g.long_desc %( Lists all channels in a Slack team. )
85
109
  g.command 'list' do |c|
86
- c.flag 'exclude_archived', desc: "Don't return archived channels."
110
+ 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."
111
+ c.flag 'exclude_archived', desc: 'Exclude archived channels from the list.'
112
+ c.flag 'exclude_members', desc: 'Exclude the members collection from each channel.'
113
+ c.flag 'limit', desc: "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached."
114
+ c.flag 'team_id', desc: 'encoded team id to list channels in, required if org token is used.'
87
115
  c.action do |_global_options, options, _args|
88
116
  puts JSON.dump($client.channels_list(options))
89
117
  end
90
118
  end
91
119
 
92
- g.desc 'This method moves the read cursor in a channel.'
93
- g.long_desc %( This method moves the read cursor in a channel. )
120
+ g.desc 'Sets the read cursor in a channel.'
121
+ g.long_desc %( Sets the read cursor in a channel. )
94
122
  g.command 'mark' do |c|
95
- c.flag 'channel', desc: 'Channel to set reading cursor in.'
96
- c.flag 'ts', desc: 'Timestamp of the most recently seen message.'
123
+ c.flag 'channel', desc: 'Channel or conversation to set the read cursor for.'
124
+ c.flag 'ts', desc: 'Unique identifier of message you want marked as most recently seen in this conversation.'
97
125
  c.action do |_global_options, options, _args|
98
126
  puts JSON.dump($client.channels_mark(options))
99
127
  end
100
128
  end
101
129
 
102
- g.desc 'This method renames a team channel.'
103
- g.long_desc %( This method renames a team channel. )
130
+ g.desc 'Renames a channel.'
131
+ g.long_desc %( Renames a channel. )
104
132
  g.command 'rename' do |c|
105
133
  c.flag 'channel', desc: 'Channel to rename.'
106
134
  c.flag 'name', desc: 'New name for channel.'
135
+ c.flag 'validate', desc: 'Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria.'
107
136
  c.action do |_global_options, options, _args|
108
137
  puts JSON.dump($client.channels_rename(options))
109
138
  end
110
139
  end
111
140
 
112
- g.desc 'This method returns an entire thread (a message plus all the messages in reply to it).'
113
- g.long_desc %( This method returns an entire thread (a message plus all the messages in reply to it). )
141
+ g.desc 'Retrieve a thread of messages posted to a channel'
142
+ g.long_desc %( Retrieve a thread of messages posted to a channel )
114
143
  g.command 'replies' do |c|
115
144
  c.flag 'channel', desc: 'Channel to fetch thread from.'
116
145
  c.flag 'thread_ts', desc: "Unique identifier of a thread's parent message."
@@ -119,18 +148,19 @@ command 'channels' do |g|
119
148
  end
120
149
  end
121
150
 
122
- g.desc 'This method is used to change the purpose of a channel. The calling user must be a member of the channel.'
123
- g.long_desc %( This method is used to change the purpose of a channel. The calling user must be a member of the channel. )
151
+ g.desc 'Sets the purpose for a channel.'
152
+ g.long_desc %( Sets the purpose for a channel. )
124
153
  g.command 'setPurpose' do |c|
125
154
  c.flag 'channel', desc: 'Channel to set the purpose of.'
126
155
  c.flag 'purpose', desc: 'The new purpose.'
156
+ c.flag 'name_tagging', desc: 'if it is true, treat this like a message and not an unescaped thing.'
127
157
  c.action do |_global_options, options, _args|
128
158
  puts JSON.dump($client.channels_setPurpose(options))
129
159
  end
130
160
  end
131
161
 
132
- g.desc 'This method is used to change the topic of a channel. The calling user must be a member of the channel.'
133
- g.long_desc %( This method is used to change the topic of a channel. The calling user must be a member of the channel. )
162
+ g.desc 'Sets the topic for a channel.'
163
+ g.long_desc %( Sets the topic for a channel. )
134
164
  g.command 'setTopic' do |c|
135
165
  c.flag 'channel', desc: 'Channel to set the topic of.'
136
166
  c.flag 'topic', desc: 'The new topic.'
@@ -139,21 +169,12 @@ command 'channels' do |g|
139
169
  end
140
170
  end
141
171
 
142
- g.desc 'This method unarchives a channel. The calling user is added to the channel.'
143
- g.long_desc %( This method unarchives a channel. The calling user is added to the channel. )
172
+ g.desc 'Unarchives a channel.'
173
+ g.long_desc %( Unarchives a channel. )
144
174
  g.command 'unarchive' do |c|
145
175
  c.flag 'channel', desc: 'Channel to unarchive.'
146
176
  c.action do |_global_options, options, _args|
147
177
  puts JSON.dump($client.channels_unarchive(options))
148
178
  end
149
179
  end
150
-
151
- g.desc 'This method returns the ID of a team channel.'
152
- g.long_desc %( This method returns the ID of a team channel. )
153
- g.command 'id' do |c|
154
- c.flag 'channel', desc: 'Channel to get ID for, prefixed with #.'
155
- c.action do |_global_options, options, _args|
156
- puts JSON.dump($client.channels_id(options))
157
- end
158
- end
159
180
  end