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
data/bin/commands/chat.rb CHANGED
@@ -1,20 +1,53 @@
1
+ # frozen_string_literal: true
1
2
  # This file was auto-generated by lib/tasks/web.rake
2
3
 
3
4
  desc 'Post chat messages to Slack.'
4
5
  command 'chat' do |g|
5
- g.desc 'This method deletes a message from a channel.'
6
- g.long_desc %( This method deletes a message from a channel. )
6
+ g.desc 'Execute a slash command in a public channel (undocumented)'
7
+ g.long_desc %( Execute a slash command in a public channel )
8
+ g.command 'command' do |c|
9
+ c.flag 'channel', desc: 'Channel to execute the command in.'
10
+ c.flag 'command', desc: 'Slash command to be executed. Leading backslash is required.'
11
+ c.flag 'text', desc: 'Additional parameters provided to the slash command.'
12
+ c.action do |_global_options, options, _args|
13
+ puts JSON.dump($client.chat_command(options))
14
+ end
15
+ end
16
+
17
+ g.desc 'Deletes a message.'
18
+ g.long_desc %( Deletes a message. )
7
19
  g.command 'delete' do |c|
8
- c.flag 'ts', desc: 'Timestamp of the message to be deleted.'
9
20
  c.flag 'channel', desc: 'Channel containing the message to be deleted.'
10
- c.flag 'as_user', desc: 'Pass true to delete the message as the authed user. Bot users in this context are considered authed users.'
21
+ c.flag 'ts', desc: 'Timestamp of the message to be deleted.'
22
+ c.flag 'as_user', desc: 'Pass true to delete the message as the authed user with chat:write:user scope. Bot users in this context are considered authed users. If unused or false, the message will be deleted with chat:write:bot scope.'
11
23
  c.action do |_global_options, options, _args|
12
24
  puts JSON.dump($client.chat_delete(options))
13
25
  end
14
26
  end
15
27
 
16
- g.desc 'This method sends a me message to a channel from the calling user.'
17
- g.long_desc %( This method sends a me message to a channel from the calling user. )
28
+ g.desc 'Deletes a pending scheduled message from the queue.'
29
+ g.long_desc %( Deletes a pending scheduled message from the queue. )
30
+ g.command 'deleteScheduledMessage' do |c|
31
+ c.flag 'channel', desc: 'The channel the scheduled_message is posting to.'
32
+ c.flag 'scheduled_message_id', desc: 'scheduled_message_id returned from call to chat.scheduleMessage.'
33
+ c.flag 'as_user', desc: 'Pass true to delete the message as the authed user with chat:write:user scope. Bot users in this context are considered authed users. If unused or false, the message will be deleted with chat:write:bot scope.'
34
+ c.action do |_global_options, options, _args|
35
+ puts JSON.dump($client.chat_deleteScheduledMessage(options))
36
+ end
37
+ end
38
+
39
+ g.desc 'Retrieve a permalink URL for a specific extant message'
40
+ g.long_desc %( Retrieve a permalink URL for a specific extant message )
41
+ g.command 'getPermalink' do |c|
42
+ c.flag 'channel', desc: 'The ID of the conversation or channel containing the message.'
43
+ c.flag 'message_ts', desc: "A message's ts value, uniquely identifying it within a channel."
44
+ c.action do |_global_options, options, _args|
45
+ puts JSON.dump($client.chat_getPermalink(options))
46
+ end
47
+ end
48
+
49
+ g.desc 'Share a me message into a channel.'
50
+ g.long_desc %( Share a me message into a channel. )
18
51
  g.command 'meMessage' do |c|
19
52
  c.flag 'channel', desc: 'Channel to send message to. Can be a public channel, private group or IM channel. Can be an encoded ID, or a name.'
20
53
  c.flag 'text', desc: 'Text of the message to send.'
@@ -23,37 +56,94 @@ command 'chat' do |g|
23
56
  end
24
57
  end
25
58
 
26
- g.desc 'This method posts a message to a public channel, private channel, or direct message/IM channel.'
27
- g.long_desc %( This method posts a message to a public channel, private channel, or direct message/IM channel. )
59
+ g.desc 'Sends an ephemeral message to a user in a channel.'
60
+ g.long_desc %( Sends an ephemeral message to a user in a channel. )
61
+ g.command 'postEphemeral' do |c|
62
+ c.flag 'attachments', desc: 'A JSON-based array of structured attachments, presented as a URL-encoded string.'
63
+ c.flag 'channel', desc: 'Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name.'
64
+ c.flag 'text', desc: 'How this field works and whether it is required depends on other fields you use in your API call. See below for more detail.'
65
+ c.flag 'user', desc: 'id of the user who will receive the ephemeral message. The user should be in the channel specified by the channel argument.'
66
+ c.flag 'as_user', desc: 'Pass true to post the message as the authed user. Defaults to true if the chat:write:bot scope is not included. Otherwise, defaults to false.'
67
+ c.flag 'blocks', desc: 'A JSON-based array of structured blocks, presented as a URL-encoded string.'
68
+ c.flag 'icon_emoji', desc: 'Emoji to use as the icon for this message. Overrides icon_url. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.'
69
+ c.flag 'icon_url', desc: 'URL to an image to use as the icon for this message. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.'
70
+ c.flag 'link_names', desc: 'Find and link channel names and usernames.'
71
+ c.flag 'parse', desc: 'Change how messages are treated. Defaults to none. See below.'
72
+ c.flag 'thread_ts', desc: "Provide another message's ts value to post this message in a thread. Avoid using a reply's ts value; use its parent's value instead. Ephemeral messages in threads are only shown if there is already an active thread."
73
+ c.flag 'username', desc: "Set your bot's user name. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below."
74
+ c.action do |_global_options, options, _args|
75
+ puts JSON.dump($client.chat_postEphemeral(options))
76
+ end
77
+ end
78
+
79
+ g.desc 'Sends a message to a channel.'
80
+ g.long_desc %( Sends a message to a channel. )
28
81
  g.command 'postMessage' do |c|
29
82
  c.flag 'channel', desc: 'Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name. See below for more details.'
30
- c.flag 'text', desc: "Text of the message to send. See below for an explanation of formatting. This field is usually required, unless you're providing only attachments instead."
31
- c.flag 'parse', desc: 'Change how messages are treated. Defaults to none. See below.'
83
+ c.flag 'text', desc: 'How this field works and whether it is required depends on other fields you use in your API call. See below for more detail.'
84
+ c.flag 'as_user', desc: 'Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See authorship below. This argument may not be used with newer bot tokens.'
85
+ c.flag 'attachments', desc: 'A JSON-based array of structured attachments, presented as a URL-encoded string.'
86
+ c.flag 'blocks', desc: 'A JSON-based array of structured blocks, presented as a URL-encoded string.'
87
+ c.flag 'icon_emoji', desc: 'Emoji to use as the icon for this message. Overrides icon_url. See authorship below. Use with bot tokens requires chat:write.customize.'
88
+ c.flag 'icon_url', desc: 'URL to an image to use as the icon for this message. See authorship below. Use with bot tokens requires chat:write.customize.'
32
89
  c.flag 'link_names', desc: 'Find and link channel names and usernames.'
33
- c.flag 'attachments', desc: 'Structured message attachments.'
90
+ c.flag 'mrkdwn', desc: 'Disable Slack markup parsing by setting to false. Enabled by default.'
91
+ c.flag 'parse', desc: 'Change how messages are treated. Defaults to none. See below.'
92
+ c.flag 'reply_broadcast', desc: 'Used in conjunction with thread_ts and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to false.'
93
+ c.flag 'thread_ts', desc: "Provide another message's ts value to make this message a reply. Avoid using a reply's ts value; use its parent instead."
34
94
  c.flag 'unfurl_links', desc: 'Pass true to enable unfurling of primarily text-based content.'
35
95
  c.flag 'unfurl_media', desc: 'Pass false to disable unfurling of media content.'
36
- c.flag 'username', desc: "Set your bot's user name. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below."
37
- c.flag 'as_user', desc: 'Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See authorship below.'
38
- c.flag 'icon_url', desc: 'URL to an image to use as the icon for this message. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.'
39
- c.flag 'icon_emoji', desc: 'Emoji to use as the icon for this message. Overrides icon_url. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.'
40
- c.flag 'thread_ts', desc: "Provide another message's ts value to make this message a reply. Avoid using a reply's ts value; use its parent instead."
41
- c.flag 'reply_broadcast', desc: 'Used in conjunction with thread_ts and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to false.'
96
+ c.flag 'username', desc: "Set your bot's user name. See authorship below. Use with bot tokens requires chat:write.customize."
42
97
  c.action do |_global_options, options, _args|
43
98
  puts JSON.dump($client.chat_postMessage(options))
44
99
  end
45
100
  end
46
101
 
47
- g.desc 'This method updates a message in a channel. Though related to chat.postMessage, some parameters of chat.update are handled differently.'
48
- g.long_desc %( This method updates a message in a channel. Though related to chat.postMessage, some parameters of chat.update are handled differently. )
102
+ g.desc 'Schedules a message to be sent to a channel.'
103
+ g.long_desc %( Schedules a message to be sent to a channel. )
104
+ g.command 'scheduleMessage' do |c|
105
+ c.flag 'channel', desc: 'Channel, private group, or DM channel to send message to. Can be an encoded ID, or a name. See below for more details.'
106
+ c.flag 'post_at', desc: 'Unix EPOCH timestamp of time in future to send the message.'
107
+ c.flag 'text', desc: 'How this field works and whether it is required depends on other fields you use in your API call. See below for more detail.'
108
+ c.flag 'as_user', desc: 'Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See chat.postMessage.'
109
+ c.flag 'attachments', desc: 'A JSON-based array of structured attachments, presented as a URL-encoded string.'
110
+ c.flag 'blocks', desc: 'A JSON-based array of structured blocks, presented as a URL-encoded string.'
111
+ c.flag 'link_names', desc: 'Find and link channel names and usernames.'
112
+ c.flag 'parse', desc: 'Change how messages are treated. Defaults to none. See chat.postMessage.'
113
+ c.flag 'reply_broadcast', desc: 'Used in conjunction with thread_ts and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to false.'
114
+ c.flag 'thread_ts', desc: "Provide another message's ts value to make this message a reply. Avoid using a reply's ts value; use its parent instead."
115
+ c.flag 'unfurl_links', desc: 'Pass true to enable unfurling of primarily text-based content.'
116
+ c.flag 'unfurl_media', desc: 'Pass false to disable unfurling of media content.'
117
+ c.action do |_global_options, options, _args|
118
+ puts JSON.dump($client.chat_scheduleMessage(options))
119
+ end
120
+ end
121
+
122
+ g.desc 'Provide custom unfurl behavior for user-posted URLs'
123
+ g.long_desc %( Provide custom unfurl behavior for user-posted URLs )
124
+ g.command 'unfurl' do |c|
125
+ c.flag 'channel', desc: 'Channel ID of the message.'
126
+ c.flag 'ts', desc: 'Timestamp of the message to add unfurl behavior to.'
127
+ c.flag 'unfurls', desc: 'URL-encoded JSON map with keys set to URLs featured in the the message, pointing to their unfurl blocks or message attachments.'
128
+ c.flag 'user_auth_message', desc: 'Provide a simply-formatted string to send as an ephemeral message to the user as invitation to authenticate further and enable full unfurling behavior.'
129
+ c.flag 'user_auth_required', desc: 'Set to true or 1 to indicate the user must install your Slack app to trigger unfurls for this domain.'
130
+ c.flag 'user_auth_url', desc: 'Send users to this custom URL where they will complete authentication in your app to fully trigger unfurling. Value should be properly URL-encoded.'
131
+ c.action do |_global_options, options, _args|
132
+ puts JSON.dump($client.chat_unfurl(options))
133
+ end
134
+ end
135
+
136
+ g.desc 'Updates a message.'
137
+ g.long_desc %( Updates a message. )
49
138
  g.command 'update' do |c|
50
- c.flag 'ts', desc: 'Timestamp of the message to be updated.'
51
139
  c.flag 'channel', desc: 'Channel containing the message to be updated.'
52
- c.flag 'text', desc: 'New text for the message, using the default formatting rules.'
53
- c.flag 'attachments', desc: 'Structured message attachments.'
54
- c.flag 'parse', desc: 'Change how messages are treated. Defaults to client, unlike chat.postMessage. See below.'
55
- c.flag 'link_names', desc: 'Find and link channel names and usernames. Defaults to none. This parameter should be used in conjunction with parse. To set link_names to 1, specify a parse mode of full.'
140
+ c.flag 'ts', desc: 'Timestamp of the message to be updated.'
56
141
  c.flag 'as_user', desc: 'Pass true to update the message as the authed user. Bot users in this context are considered authed users.'
142
+ c.flag 'attachments', desc: "A JSON-based array of structured attachments, presented as a URL-encoded string. This field is required when not presenting text. If you don't include this field, the message's previous attachments will be retained. To remove previous attachments, include an empty array for this field."
143
+ c.flag 'blocks', desc: "A JSON-based array of structured blocks, presented as a URL-encoded string. If you don't include this field, the message's previous blocks will be retained. To remove previous blocks, include an empty array for this field."
144
+ c.flag 'link_names', desc: 'Find and link channel names and usernames. Defaults to none. If you do not specify a value for this field, the original value set for the message will be overwritten with the default, none.'
145
+ c.flag 'parse', desc: 'Change how messages are treated. Defaults to client, unlike chat.postMessage. Accepts either none or full. If you do not specify a value for this field, the original value set for the message will be overwritten with the default, client.'
146
+ c.flag 'text', desc: "New text for the message, using the default formatting rules. It's not required when presenting blocks or attachments."
57
147
  c.action do |_global_options, options, _args|
58
148
  puts JSON.dump($client.chat_update(options))
59
149
  end
@@ -0,0 +1,19 @@
1
+ # frozen_string_literal: true
2
+ # This file was auto-generated by lib/tasks/web.rake
3
+
4
+ desc 'ChatScheduledmessages methods.'
5
+ command 'chat_scheduledMessages' do |g|
6
+ g.desc 'Returns a list of scheduled messages.'
7
+ g.long_desc %( Returns a list of scheduled messages. )
8
+ g.command 'list' do |c|
9
+ c.flag 'channel', desc: 'The channel of the scheduled messages.'
10
+ c.flag 'cursor', desc: 'For pagination purposes, this is the cursor value returned from a previous call to chat.scheduledmessages.list indicating where you want to start this call from.'
11
+ c.flag 'latest', desc: 'A UNIX timestamp of the latest value in the time range.'
12
+ c.flag 'limit', desc: 'Maximum number of original entries to return.'
13
+ c.flag 'oldest', desc: 'A UNIX timestamp of the oldest value in the time range.'
14
+ c.flag 'team_id', desc: 'encoded team id to list channels in, required if org token is used.'
15
+ c.action do |_global_options, options, _args|
16
+ puts JSON.dump($client.chat_scheduledMessages_list(options))
17
+ end
18
+ end
19
+ end
@@ -0,0 +1,196 @@
1
+ # frozen_string_literal: true
2
+ # This file was auto-generated by lib/tasks/web.rake
3
+
4
+ desc "Interface with all kinds of conversations the same way, whether they're public or private channels, direct messages, or otherwise."
5
+ command 'conversations' do |g|
6
+ g.desc 'Archives a conversation.'
7
+ g.long_desc %( Archives a conversation. )
8
+ g.command 'archive' do |c|
9
+ c.flag 'channel', desc: 'ID of conversation to archive.'
10
+ c.action do |_global_options, options, _args|
11
+ puts JSON.dump($client.conversations_archive(options))
12
+ end
13
+ end
14
+
15
+ g.desc 'Closes a direct message or multi-person direct message.'
16
+ g.long_desc %( Closes a direct message or multi-person direct message. )
17
+ g.command 'close' do |c|
18
+ c.flag 'channel', desc: 'Conversation to close.'
19
+ c.action do |_global_options, options, _args|
20
+ puts JSON.dump($client.conversations_close(options))
21
+ end
22
+ end
23
+
24
+ g.desc 'Initiates a public or private channel-based conversation'
25
+ g.long_desc %( Initiates a public or private channel-based conversation )
26
+ g.command 'create' do |c|
27
+ c.flag 'name', desc: 'Name of the public or private channel to create.'
28
+ c.flag 'is_private', desc: 'Create a private channel instead of a public one.'
29
+ c.flag 'team_id', desc: 'encoded team id to create the channel in, required if org token is used.'
30
+ c.action do |_global_options, options, _args|
31
+ puts JSON.dump($client.conversations_create(options))
32
+ end
33
+ end
34
+
35
+ g.desc "Fetches a conversation's history of messages and events."
36
+ g.long_desc %( Fetches a conversation's history of messages and events. )
37
+ g.command 'history' do |c|
38
+ c.flag 'channel', desc: 'Conversation ID to fetch history for.'
39
+ 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."
40
+ c.flag 'inclusive', desc: 'Include messages with latest or oldest timestamp in results only when either timestamp is specified.'
41
+ c.flag 'latest', desc: 'End of time range of messages to include in results.'
42
+ 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."
43
+ c.flag 'oldest', desc: 'Start of time range of messages to include in results.'
44
+ c.action do |_global_options, options, _args|
45
+ puts JSON.dump($client.conversations_history(options))
46
+ end
47
+ end
48
+
49
+ g.desc 'Retrieve information about a conversation.'
50
+ g.long_desc %( Retrieve information about a conversation. )
51
+ g.command 'info' do |c|
52
+ c.flag 'channel', desc: 'Conversation ID to learn more about.'
53
+ c.flag 'include_locale', desc: 'Set this to true to receive the locale for this conversation. Defaults to false.'
54
+ c.flag 'include_num_members', desc: 'Set to true to include the member count for the specified conversation. Defaults to false.'
55
+ c.action do |_global_options, options, _args|
56
+ puts JSON.dump($client.conversations_info(options))
57
+ end
58
+ end
59
+
60
+ g.desc 'Invites users to a channel.'
61
+ g.long_desc %( Invites users to a channel. )
62
+ g.command 'invite' do |c|
63
+ c.flag 'channel', desc: 'The ID of the public or private channel to invite user(s) to.'
64
+ c.flag 'users', desc: 'A comma separated list of user IDs. Up to 1000 users may be listed.'
65
+ c.action do |_global_options, options, _args|
66
+ puts JSON.dump($client.conversations_invite(options))
67
+ end
68
+ end
69
+
70
+ g.desc 'Joins an existing conversation.'
71
+ g.long_desc %( Joins an existing conversation. )
72
+ g.command 'join' do |c|
73
+ c.flag 'channel', desc: 'ID of conversation to join.'
74
+ c.action do |_global_options, options, _args|
75
+ puts JSON.dump($client.conversations_join(options))
76
+ end
77
+ end
78
+
79
+ g.desc 'Removes a user from a conversation.'
80
+ g.long_desc %( Removes a user from a conversation. )
81
+ g.command 'kick' do |c|
82
+ c.flag 'channel', desc: 'ID of conversation to remove user from.'
83
+ c.flag 'user', desc: 'User ID to be removed.'
84
+ c.action do |_global_options, options, _args|
85
+ puts JSON.dump($client.conversations_kick(options))
86
+ end
87
+ end
88
+
89
+ g.desc 'Leaves a conversation.'
90
+ g.long_desc %( Leaves a conversation. )
91
+ g.command 'leave' do |c|
92
+ c.flag 'channel', desc: 'Conversation to leave.'
93
+ c.action do |_global_options, options, _args|
94
+ puts JSON.dump($client.conversations_leave(options))
95
+ end
96
+ end
97
+
98
+ g.desc 'Lists all channels in a Slack team.'
99
+ g.long_desc %( Lists all channels in a Slack team. )
100
+ g.command 'list' do |c|
101
+ 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."
102
+ c.flag 'exclude_archived', desc: 'Set to true to exclude archived channels from the list.'
103
+ c.flag 'limit', desc: "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached. Must be an integer no larger than 1000."
104
+ c.flag 'team_id', desc: 'encoded team id to list channels in, required if org token is used.'
105
+ c.flag 'types', desc: 'Mix and match channel types by providing a comma-separated list of any combination of public_channel, private_channel, mpim, im.'
106
+ c.action do |_global_options, options, _args|
107
+ puts JSON.dump($client.conversations_list(options))
108
+ end
109
+ end
110
+
111
+ g.desc 'Sets the read cursor in a channel.'
112
+ g.long_desc %( Sets the read cursor in a channel. )
113
+ g.command 'mark' do |c|
114
+ c.flag 'channel', desc: 'Channel or conversation to set the read cursor for.'
115
+ c.flag 'ts', desc: 'Unique identifier of message you want marked as most recently seen in this conversation.'
116
+ c.action do |_global_options, options, _args|
117
+ puts JSON.dump($client.conversations_mark(options))
118
+ end
119
+ end
120
+
121
+ g.desc 'Retrieve members of a conversation.'
122
+ g.long_desc %( Retrieve members of a conversation. )
123
+ g.command 'members' do |c|
124
+ c.flag 'channel', desc: 'ID of the conversation to retrieve members for.'
125
+ 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."
126
+ 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."
127
+ c.action do |_global_options, options, _args|
128
+ puts JSON.dump($client.conversations_members(options))
129
+ end
130
+ end
131
+
132
+ g.desc 'Opens or resumes a direct message or multi-person direct message.'
133
+ g.long_desc %( Opens or resumes a direct message or multi-person direct message. )
134
+ g.command 'open' do |c|
135
+ c.flag 'channel', desc: "Resume a conversation by supplying an im or mpim's ID. Or provide the users field instead."
136
+ c.flag 'return_im', desc: 'Boolean, indicates you want the full IM channel definition in the response.'
137
+ c.flag 'users', desc: 'Comma separated lists of users. If only one user is included, this creates a 1:1 DM. The ordering of the users is preserved whenever a multi-person direct message is returned. Supply a channel when not supplying users.'
138
+ c.action do |_global_options, options, _args|
139
+ puts JSON.dump($client.conversations_open(options))
140
+ end
141
+ end
142
+
143
+ g.desc 'Renames a conversation.'
144
+ g.long_desc %( Renames a conversation. )
145
+ g.command 'rename' do |c|
146
+ c.flag 'channel', desc: 'ID of conversation to rename.'
147
+ c.flag 'name', desc: 'New name for conversation.'
148
+ c.action do |_global_options, options, _args|
149
+ puts JSON.dump($client.conversations_rename(options))
150
+ end
151
+ end
152
+
153
+ g.desc 'Retrieve a thread of messages posted to a conversation'
154
+ g.long_desc %( Retrieve a thread of messages posted to a conversation )
155
+ g.command 'replies' do |c|
156
+ c.flag 'channel', desc: 'Conversation ID to fetch thread from.'
157
+ c.flag 'ts', desc: "Unique identifier of a thread's parent message. ts must be the timestamp of an existing message with 0 or more replies. If there are no replies then just the single message referenced by ts will return - it is just an ordinary, unthreaded message."
158
+ 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."
159
+ c.flag 'inclusive', desc: 'Include messages with latest or oldest timestamp in results only when either timestamp is specified.'
160
+ c.flag 'latest', desc: 'End of time range of messages to include in results.'
161
+ 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."
162
+ c.flag 'oldest', desc: 'Start of time range of messages to include in results.'
163
+ c.action do |_global_options, options, _args|
164
+ puts JSON.dump($client.conversations_replies(options))
165
+ end
166
+ end
167
+
168
+ g.desc 'Sets the purpose for a conversation.'
169
+ g.long_desc %( Sets the purpose for a conversation. )
170
+ g.command 'setPurpose' do |c|
171
+ c.flag 'channel', desc: 'Conversation to set the purpose of.'
172
+ c.flag 'purpose', desc: 'A new, specialer purpose.'
173
+ c.action do |_global_options, options, _args|
174
+ puts JSON.dump($client.conversations_setPurpose(options))
175
+ end
176
+ end
177
+
178
+ g.desc 'Sets the topic for a conversation.'
179
+ g.long_desc %( Sets the topic for a conversation. )
180
+ g.command 'setTopic' do |c|
181
+ c.flag 'channel', desc: 'Conversation to set the topic of.'
182
+ c.flag 'topic', desc: 'The new topic string. Does not support formatting or linkification.'
183
+ c.action do |_global_options, options, _args|
184
+ puts JSON.dump($client.conversations_setTopic(options))
185
+ end
186
+ end
187
+
188
+ g.desc 'Reverses conversation archival.'
189
+ g.long_desc %( Reverses conversation archival. )
190
+ g.command 'unarchive' do |c|
191
+ c.flag 'channel', desc: 'ID of conversation to unarchive.'
192
+ c.action do |_global_options, options, _args|
193
+ puts JSON.dump($client.conversations_unarchive(options))
194
+ end
195
+ end
196
+ end
@@ -0,0 +1,15 @@
1
+ # frozen_string_literal: true
2
+ # This file was auto-generated by lib/tasks/web.rake
3
+
4
+ desc 'Dialog methods.'
5
+ command 'dialog' do |g|
6
+ g.desc 'Open a dialog with a user'
7
+ g.long_desc %( Open a dialog with a user )
8
+ g.command 'open' do |c|
9
+ c.flag 'dialog', desc: 'The dialog definition. This must be a JSON-encoded string.'
10
+ c.flag 'trigger_id', desc: 'Exchange a trigger to post to the user.'
11
+ c.action do |_global_options, options, _args|
12
+ puts JSON.dump($client.dialog_open(options))
13
+ end
14
+ end
15
+ end
data/bin/commands/dnd.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 'Adjust and view Do Not Disturb settings for team members.'
4
5
  command 'dnd' do |g|
5
- g.desc "Ends the user's currently scheduled Do Not Disturb session immediately."
6
- g.long_desc %( Ends the user's currently scheduled Do Not Disturb session immediately. )
6
+ g.desc "Ends the current user's Do Not Disturb session immediately."
7
+ g.long_desc %( Ends the current user's Do Not Disturb session immediately. )
7
8
  g.command 'endDnd' do |c|
8
9
  c.action do |_global_options, options, _args|
9
10
  puts JSON.dump($client.dnd_endDnd(options))
@@ -18,8 +19,8 @@ command 'dnd' do |g|
18
19
  end
19
20
  end
20
21
 
21
- g.desc "Provides information about a user's current Do Not Disturb settings."
22
- g.long_desc %( Provides information about a user's current Do Not Disturb settings. )
22
+ g.desc "Retrieves a user's current Do Not Disturb status."
23
+ g.long_desc %( Retrieves a user's current Do Not Disturb status. )
23
24
  g.command 'info' do |c|
24
25
  c.flag 'user', desc: 'User to fetch status for (defaults to current user).'
25
26
  c.action do |_global_options, options, _args|
@@ -27,8 +28,8 @@ command 'dnd' do |g|
27
28
  end
28
29
  end
29
30
 
30
- g.desc "Adjusts the snooze duration for a user's Do Not Disturb settings. If a snooze session is not already active for the user, invoking this method will begin one for the specified duration."
31
- g.long_desc %( Adjusts the snooze duration for a user's Do Not Disturb settings. If a snooze session is not already active for the user, invoking this method will begin one for the specified duration. )
31
+ g.desc 'Turns on Do Not Disturb mode for the current user, or changes its duration.'
32
+ g.long_desc %( Turns on Do Not Disturb mode for the current user, or changes its duration. )
32
33
  g.command 'setSnooze' do |c|
33
34
  c.flag 'num_minutes', desc: 'Number of minutes, from now, to snooze until.'
34
35
  c.action do |_global_options, options, _args|
@@ -36,8 +37,8 @@ command 'dnd' do |g|
36
37
  end
37
38
  end
38
39
 
39
- g.desc 'Provides information about the current Do Not Disturb settings for users of a Slack team.'
40
- g.long_desc %( Provides information about the current Do Not Disturb settings for users of a Slack team. )
40
+ g.desc 'Retrieves the Do Not Disturb status for up to 50 users on a team.'
41
+ g.long_desc %( Retrieves the Do Not Disturb status for up to 50 users on a team. )
41
42
  g.command 'teamInfo' do |c|
42
43
  c.flag 'users', desc: 'Comma-separated list of users to fetch Do Not Disturb status for.'
43
44
  c.action do |_global_options, options, _args|