slack-ruby-client 0.11.1 → 1.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (392) hide show
  1. checksums.yaml +4 -4
  2. data/.github/FUNDING.yml +1 -0
  3. data/.github/workflows/danger.yml +19 -0
  4. data/.github/workflows/integtest.yml +25 -0
  5. data/.github/workflows/rubocop.yml +13 -0
  6. data/.github/workflows/test.yml +34 -0
  7. data/.gitignore +6 -3
  8. data/.rubocop.yml +36 -2
  9. data/.rubocop_todo.yml +186 -54
  10. data/CHANGELOG.md +156 -31
  11. data/CONTRIBUTING.md +20 -9
  12. data/Dangerfile +2 -0
  13. data/Gemfile +27 -6
  14. data/Gemfile.danger +6 -0
  15. data/LICENSE.md +1 -1
  16. data/README.md +199 -52
  17. data/RELEASING.md +2 -2
  18. data/Rakefile +2 -1
  19. data/UPGRADING.md +89 -3
  20. data/bin/commands/admin_analytics.rb +16 -0
  21. data/bin/commands/admin_apps.rb +51 -0
  22. data/bin/commands/admin_apps_approved.rb +17 -0
  23. data/bin/commands/admin_apps_requests.rb +28 -0
  24. data/bin/commands/admin_apps_restricted.rb +17 -0
  25. data/bin/commands/admin_auth_policy.rb +39 -0
  26. data/bin/commands/admin_barriers.rb +47 -0
  27. data/bin/commands/admin_conversations.rb +170 -0
  28. data/bin/commands/admin_conversations_ekm.rb +17 -0
  29. data/bin/commands/admin_conversations_restrictAccess.rb +37 -0
  30. data/bin/commands/admin_conversations_whitelist.rb +37 -0
  31. data/bin/commands/admin_emoji.rb +54 -0
  32. data/bin/commands/admin_inviteRequests.rb +36 -0
  33. data/bin/commands/admin_inviteRequests_approved.rb +16 -0
  34. data/bin/commands/admin_inviteRequests_denied.rb +16 -0
  35. data/bin/commands/admin_teams.rb +27 -0
  36. data/bin/commands/admin_teams_admins.rb +16 -0
  37. data/bin/commands/admin_teams_owners.rb +16 -0
  38. data/bin/commands/admin_teams_settings.rb +64 -0
  39. data/bin/commands/admin_usergroups.rb +48 -0
  40. data/bin/commands/admin_users.rb +98 -0
  41. data/bin/commands/admin_users_session.rb +78 -0
  42. data/bin/commands/admin_users_unsupportedVersions.rb +15 -0
  43. data/bin/commands/api.rb +1 -1
  44. data/bin/commands/apps.rb +15 -0
  45. data/bin/commands/apps_connections.rb +13 -0
  46. data/bin/commands/apps_event_authorizations.rb +16 -0
  47. data/bin/commands/apps_manifest.rb +52 -0
  48. data/bin/commands/apps_permissions.rb +1 -0
  49. data/bin/commands/apps_permissions_resources.rb +15 -0
  50. data/bin/commands/apps_permissions_scopes.rb +13 -0
  51. data/bin/commands/apps_permissions_users.rb +26 -0
  52. data/bin/commands/auth.rb +1 -0
  53. data/bin/commands/auth_teams.rb +16 -0
  54. data/bin/commands/bookmarks.rb +52 -0
  55. data/bin/commands/bots.rb +2 -0
  56. data/bin/commands/calls.rb +52 -0
  57. data/bin/commands/calls_participants.rb +25 -0
  58. data/bin/commands/channels.rb +1 -153
  59. data/bin/commands/chat.rb +57 -12
  60. data/bin/commands/chat_scheduledMessages.rb +19 -0
  61. data/bin/commands/conversations.rb +75 -4
  62. data/bin/commands/dialog.rb +1 -0
  63. data/bin/commands/dnd.rb +6 -3
  64. data/bin/commands/emoji.rb +1 -0
  65. data/bin/commands/files.rb +14 -19
  66. data/bin/commands/files_comments.rb +1 -21
  67. data/bin/commands/files_remote.rb +78 -0
  68. data/bin/commands/groups.rb +1 -159
  69. data/bin/commands/im.rb +1 -62
  70. data/bin/commands/migration.rb +2 -0
  71. data/bin/commands/mpim.rb +1 -58
  72. data/bin/commands/oauth.rb +4 -15
  73. data/bin/commands/oauth_v2.rb +29 -0
  74. data/bin/commands/openid_connect.rb +27 -0
  75. data/bin/commands/pins.rb +3 -6
  76. data/bin/commands/reactions.rb +5 -3
  77. data/bin/commands/reminders.rb +7 -0
  78. data/bin/commands/rtm.rb +7 -4
  79. data/bin/commands/search.rb +8 -3
  80. data/bin/commands/stars.rb +10 -6
  81. data/bin/commands/team.rb +6 -0
  82. data/bin/commands/team_billing.rb +13 -0
  83. data/bin/commands/team_preferences.rb +13 -0
  84. data/bin/commands/team_profile.rb +1 -0
  85. data/bin/commands/tooling_tokens.rb +14 -0
  86. data/bin/commands/usergroups.rb +7 -1
  87. data/bin/commands/usergroups_users.rb +3 -0
  88. data/bin/commands/users.rb +21 -6
  89. data/bin/commands/users_admin.rb +1 -0
  90. data/bin/commands/users_prefs.rb +1 -0
  91. data/bin/commands/users_profile.rb +7 -6
  92. data/bin/commands/views.rb +48 -0
  93. data/bin/commands/workflows.rb +38 -0
  94. data/bin/commands.rb +40 -5
  95. data/bin/slack +2 -3
  96. data/examples/hi_real_time_and_web/Gemfile +1 -0
  97. data/examples/hi_real_time_and_web/hi.rb +7 -3
  98. data/examples/{hi_real_time_async_eventmachine → hi_real_time_async_async}/Gemfile +2 -1
  99. data/examples/{hi_real_time_async_celluloid → hi_real_time_async_async}/Procfile +0 -0
  100. data/examples/{hi_real_time_async_celluloid → hi_real_time_async_async}/hi.rb +12 -7
  101. data/examples/hi_web/Gemfile +1 -0
  102. data/examples/hi_web/hi.rb +1 -0
  103. data/examples/new_ticket/Gemfile +1 -0
  104. data/examples/new_ticket/new_ticket.rb +1 -0
  105. data/lib/slack/config.rb +2 -2
  106. data/lib/slack/events/config.rb +32 -0
  107. data/lib/slack/events/request.rb +72 -0
  108. data/lib/slack/logger.rb +6 -5
  109. data/lib/slack/messages/formatting.rb +1 -1
  110. data/lib/slack/messages/message.rb +1 -4
  111. data/lib/slack/real_time/api/message.rb +3 -1
  112. data/lib/slack/real_time/api/message_id.rb +1 -0
  113. data/lib/slack/real_time/api/ping.rb +5 -2
  114. data/lib/slack/real_time/api/typing.rb +3 -1
  115. data/lib/slack/real_time/client.rb +103 -34
  116. data/lib/slack/real_time/concurrency/async.rb +138 -0
  117. data/lib/slack/real_time/concurrency.rb +2 -2
  118. data/lib/slack/real_time/config.rb +6 -10
  119. data/lib/slack/real_time/models/base.rb +1 -4
  120. data/lib/slack/real_time/models/bot.rb +1 -0
  121. data/lib/slack/real_time/models/channel.rb +1 -0
  122. data/lib/slack/real_time/models/group.rb +1 -0
  123. data/lib/slack/real_time/models/im.rb +1 -0
  124. data/lib/slack/real_time/models/team.rb +1 -0
  125. data/lib/slack/real_time/models/user.rb +1 -0
  126. data/lib/slack/real_time/models.rb +1 -0
  127. data/lib/slack/real_time/socket.rb +45 -17
  128. data/lib/slack/real_time/stores/base.rb +5 -7
  129. data/lib/slack/real_time/stores/starter.rb +27 -3
  130. data/lib/slack/real_time/stores/store.rb +43 -25
  131. data/lib/slack/real_time/stores.rb +1 -0
  132. data/lib/slack/version.rb +2 -1
  133. data/lib/slack/web/api/endpoints/admin_analytics.rb +28 -0
  134. data/lib/slack/web/api/endpoints/admin_apps.rb +78 -0
  135. data/lib/slack/web/api/endpoints/admin_apps_approved.rb +35 -0
  136. data/lib/slack/web/api/endpoints/admin_apps_requests.rb +51 -0
  137. data/lib/slack/web/api/endpoints/admin_apps_restricted.rb +35 -0
  138. data/lib/slack/web/api/endpoints/admin_auth_policy.rb +72 -0
  139. data/lib/slack/web/api/endpoints/admin_barriers.rb +82 -0
  140. data/lib/slack/web/api/endpoints/admin_conversations.rb +262 -0
  141. data/lib/slack/web/api/endpoints/admin_conversations_ekm.rb +35 -0
  142. data/lib/slack/web/api/endpoints/admin_conversations_restrictAccess.rb +61 -0
  143. data/lib/slack/web/api/endpoints/admin_conversations_whitelist.rb +64 -0
  144. data/lib/slack/web/api/endpoints/admin_emoji.rb +88 -0
  145. data/lib/slack/web/api/endpoints/admin_inviteRequests.rb +61 -0
  146. data/lib/slack/web/api/endpoints/admin_inviteRequests_approved.rb +33 -0
  147. data/lib/slack/web/api/endpoints/admin_inviteRequests_denied.rb +33 -0
  148. data/lib/slack/web/api/endpoints/admin_teams.rb +50 -0
  149. data/lib/slack/web/api/endpoints/admin_teams_admins.rb +34 -0
  150. data/lib/slack/web/api/endpoints/admin_teams_owners.rb +34 -0
  151. data/lib/slack/web/api/endpoints/admin_teams_settings.rb +99 -0
  152. data/lib/slack/web/api/endpoints/admin_usergroups.rb +77 -0
  153. data/lib/slack/web/api/endpoints/admin_users.rb +163 -0
  154. data/lib/slack/web/api/endpoints/admin_users_session.rb +122 -0
  155. data/lib/slack/web/api/endpoints/admin_users_unsupportedVersions.rb +25 -0
  156. data/lib/slack/web/api/endpoints/api.rb +2 -3
  157. data/lib/slack/web/api/endpoints/apps.rb +27 -0
  158. data/lib/slack/web/api/endpoints/apps_connections.rb +21 -0
  159. data/lib/slack/web/api/endpoints/apps_event_authorizations.rb +34 -0
  160. data/lib/slack/web/api/endpoints/apps_manifest.rb +77 -0
  161. data/lib/slack/web/api/endpoints/apps_permissions.rb +1 -0
  162. data/lib/slack/web/api/endpoints/apps_permissions_resources.rb +31 -0
  163. data/lib/slack/web/api/endpoints/apps_permissions_scopes.rb +21 -0
  164. data/lib/slack/web/api/endpoints/apps_permissions_users.rb +50 -0
  165. data/lib/slack/web/api/endpoints/auth.rb +2 -1
  166. data/lib/slack/web/api/endpoints/auth_teams.rb +33 -0
  167. data/lib/slack/web/api/endpoints/bookmarks.rb +86 -0
  168. data/lib/slack/web/api/endpoints/bots.rb +4 -1
  169. data/lib/slack/web/api/endpoints/calls.rb +83 -0
  170. data/lib/slack/web/api/endpoints/calls_participants.rb +42 -0
  171. data/lib/slack/web/api/endpoints/channels.rb +2 -243
  172. data/lib/slack/web/api/endpoints/chat.rb +145 -46
  173. data/lib/slack/web/api/endpoints/chat_scheduledMessages.rb +40 -0
  174. data/lib/slack/web/api/endpoints/conversations.rb +152 -39
  175. data/lib/slack/web/api/endpoints/dialog.rb +3 -2
  176. data/lib/slack/web/api/endpoints/dnd.rb +9 -4
  177. data/lib/slack/web/api/endpoints/emoji.rb +1 -0
  178. data/lib/slack/web/api/endpoints/files.rb +35 -28
  179. data/lib/slack/web/api/endpoints/files_comments.rb +2 -34
  180. data/lib/slack/web/api/endpoints/files_remote.rb +127 -0
  181. data/lib/slack/web/api/endpoints/groups.rb +1 -243
  182. data/lib/slack/web/api/endpoints/im.rb +1 -101
  183. data/lib/slack/web/api/endpoints/migration.rb +5 -2
  184. data/lib/slack/web/api/endpoints/mpim.rb +1 -86
  185. data/lib/slack/web/api/endpoints/oauth.rb +8 -30
  186. data/lib/slack/web/api/endpoints/oauth_v2.rb +48 -0
  187. data/lib/slack/web/api/endpoints/openid_connect.rb +42 -0
  188. data/lib/slack/web/api/endpoints/pins.rb +8 -15
  189. data/lib/slack/web/api/endpoints/reactions.rb +29 -18
  190. data/lib/slack/web/api/endpoints/reminders.rb +18 -5
  191. data/lib/slack/web/api/endpoints/rtm.rb +14 -9
  192. data/lib/slack/web/api/endpoints/search.rb +30 -15
  193. data/lib/slack/web/api/endpoints/stars.rb +23 -10
  194. data/lib/slack/web/api/endpoints/team.rb +15 -4
  195. data/lib/slack/web/api/endpoints/team_billing.rb +21 -0
  196. data/lib/slack/web/api/endpoints/team_preferences.rb +21 -0
  197. data/lib/slack/web/api/endpoints/team_profile.rb +2 -1
  198. data/lib/slack/web/api/endpoints/tooling_tokens.rb +24 -0
  199. data/lib/slack/web/api/endpoints/usergroups.rb +27 -16
  200. data/lib/slack/web/api/endpoints/usergroups_users.rb +10 -5
  201. data/lib/slack/web/api/endpoints/users.rb +44 -17
  202. data/lib/slack/web/api/endpoints/users_admin.rb +1 -0
  203. data/lib/slack/web/api/endpoints/users_prefs.rb +1 -0
  204. data/lib/slack/web/api/endpoints/users_profile.rb +9 -8
  205. data/lib/slack/web/api/endpoints/views.rb +97 -0
  206. data/lib/slack/web/api/endpoints/workflows.rb +61 -0
  207. data/lib/slack/web/api/endpoints.rb +80 -12
  208. data/lib/slack/web/api/error.rb +1 -0
  209. data/lib/slack/web/api/errors/server_error.rb +37 -0
  210. data/lib/slack/web/api/errors/slack_error.rb +14 -1
  211. data/lib/slack/web/api/errors/too_many_requests_error.rb +2 -4
  212. data/lib/slack/web/api/errors.rb +1066 -0
  213. data/lib/slack/web/api/mixins/{channels.id.rb → conversations.id.rb} +4 -5
  214. data/lib/slack/web/api/mixins/ids.id.rb +3 -2
  215. data/lib/slack/web/api/mixins/users.id.rb +2 -3
  216. data/lib/slack/web/api/mixins/users.search.rb +1 -0
  217. data/lib/slack/web/api/mixins.rb +2 -2
  218. data/lib/slack/web/api/patches/chat.1.patch +70 -0
  219. data/lib/slack/web/api/patches/views.1.view-json.patch +40 -0
  220. data/lib/slack/web/api/patches/views.1.views-published.patch +16 -0
  221. data/lib/slack/web/api/templates/command.erb +1 -0
  222. data/lib/slack/web/api/templates/commands.erb +1 -0
  223. data/lib/slack/web/api/templates/endpoints.erb +2 -2
  224. data/lib/slack/web/api/templates/errors.erb +20 -0
  225. data/lib/slack/web/api/templates/method.erb +5 -1
  226. data/lib/slack/web/api/templates/method_spec.erb +2 -1
  227. data/lib/slack/web/client.rb +2 -1
  228. data/lib/slack/web/config.rb +3 -0
  229. data/lib/slack/web/faraday/connection.rb +24 -20
  230. data/lib/slack/web/faraday/request.rb +5 -1
  231. data/lib/slack/web/faraday/response/raise_error.rb +14 -7
  232. data/lib/slack/web/faraday/response/wrap_error.rb +24 -0
  233. data/lib/slack/web/pagination/cursor.rb +7 -7
  234. data/lib/slack-ruby-client.rb +12 -5
  235. data/lib/slack.rb +1 -0
  236. data/lib/slack_ruby_client.rb +1 -0
  237. data/lib/tasks/git.rake +1 -0
  238. data/lib/tasks/real_time.rake +16 -8
  239. data/lib/tasks/update.rake +1 -0
  240. data/lib/tasks/web.rake +39 -10
  241. data/screenshots/create-app.png +0 -0
  242. data/slack-ruby-client.gemspec +7 -12
  243. data/spec/fixtures/slack/web/429_error.yml +50 -54
  244. data/spec/fixtures/slack/web/auth_test_error.yml +51 -18
  245. data/spec/fixtures/slack/web/auth_test_success.yml +50 -26
  246. data/spec/fixtures/slack/web/conversations_info.yml +167 -0
  247. data/spec/fixtures/slack/web/conversations_setTopic.yml +84 -0
  248. data/spec/fixtures/slack/web/conversations_setTopic_one_page.yml +172 -0
  249. data/spec/fixtures/slack/web/conversations_setTopic_paginated.yml +253 -0
  250. data/spec/fixtures/slack/web/paginated_users_list.yml +501 -69
  251. data/spec/fixtures/slack/web/rtm_connect.yml +267 -30
  252. data/spec/fixtures/slack/web/rtm_start.yml +771 -60
  253. data/spec/fixtures/slack/web/users_info.yml +153 -69
  254. data/spec/fixtures/slack/web/users_list.yml +102 -41
  255. data/spec/fixtures/slack/web/views_open_error.yml +83 -0
  256. data/spec/integration/integration_spec.rb +116 -48
  257. data/spec/slack/config_spec.rb +2 -0
  258. data/spec/slack/events/config_spec.rb +33 -0
  259. data/spec/slack/events/request_spec.rb +184 -0
  260. data/spec/slack/messages/formatting_spec.rb +25 -14
  261. data/spec/slack/real_time/api/message_spec.rb +6 -1
  262. data/spec/slack/real_time/api/ping_spec.rb +2 -0
  263. data/spec/slack/real_time/api/typing_spec.rb +5 -1
  264. data/spec/slack/real_time/client_spec.rb +258 -62
  265. data/spec/slack/real_time/concurrency/it_behaves_like_a_realtime_socket.rb +2 -0
  266. data/spec/slack/real_time/concurrency/with_concurrency_spec.rb +10 -0
  267. data/spec/slack/real_time/concurrency/without_concurrency_spec.rb +10 -0
  268. data/spec/slack/real_time/event_handlers/bot_spec.rb +3 -2
  269. data/spec/slack/real_time/event_handlers/channel_spec.rb +14 -11
  270. data/spec/slack/real_time/event_handlers/event_handlers_spec.rb +2 -1
  271. data/spec/slack/real_time/event_handlers/group_spec.rb +6 -5
  272. data/spec/slack/real_time/event_handlers/im_spec.rb +10 -9
  273. data/spec/slack/real_time/event_handlers/team_spec.rb +3 -1
  274. data/spec/slack/real_time/event_handlers/user_spec.rb +3 -2
  275. data/spec/slack/real_time/rtm_connect_spec.rb +2 -1
  276. data/spec/slack/real_time/rtm_start_spec.rb +2 -1
  277. data/spec/slack/real_time/store_spec.rb +4 -3
  278. data/spec/slack/slack_spec.rb +42 -8
  279. data/spec/slack/version_spec.rb +2 -1
  280. data/spec/slack/web/api/endpoints/admin_analytics_spec.rb +13 -0
  281. data/spec/slack/web/api/endpoints/admin_apps_approved_spec.rb +8 -0
  282. data/spec/slack/web/api/endpoints/admin_apps_requests_spec.rb +13 -0
  283. data/spec/slack/web/api/endpoints/admin_apps_restricted_spec.rb +8 -0
  284. data/spec/slack/web/api/endpoints/admin_apps_spec.rb +18 -0
  285. data/spec/slack/web/api/endpoints/admin_auth_policy_spec.rb +35 -0
  286. data/spec/slack/web/api/endpoints/admin_barriers_spec.rb +38 -0
  287. data/spec/slack/web/api/endpoints/admin_conversations_ekm_spec.rb +8 -0
  288. data/spec/slack/web/api/endpoints/admin_conversations_restrictAccess_spec.rb +32 -0
  289. data/spec/slack/web/api/endpoints/admin_conversations_spec.rb +98 -0
  290. data/spec/slack/web/api/endpoints/admin_emoji_spec.rb +37 -0
  291. data/spec/slack/web/api/endpoints/admin_inviteRequests_approved_spec.rb +8 -0
  292. data/spec/slack/web/api/endpoints/admin_inviteRequests_denied_spec.rb +8 -0
  293. data/spec/slack/web/api/endpoints/admin_inviteRequests_spec.rb +18 -0
  294. data/spec/slack/web/api/endpoints/admin_teams_admins_spec.rb +13 -0
  295. data/spec/slack/web/api/endpoints/admin_teams_owners_spec.rb +13 -0
  296. data/spec/slack/web/api/endpoints/admin_teams_settings_spec.rb +53 -0
  297. data/spec/slack/web/api/endpoints/admin_teams_spec.rb +16 -0
  298. data/spec/slack/web/api/endpoints/admin_usergroups_spec.rb +37 -0
  299. data/spec/slack/web/api/endpoints/admin_users_session_spec.rb +41 -0
  300. data/spec/slack/web/api/endpoints/admin_users_spec.rb +67 -0
  301. data/spec/slack/web/api/endpoints/admin_users_unsupportedVersions_spec.rb +8 -0
  302. data/spec/slack/web/api/endpoints/api_spec.rb +1 -0
  303. data/spec/slack/web/api/endpoints/apps_connections_spec.rb +8 -0
  304. data/spec/slack/web/api/endpoints/apps_event_authorizations_spec.rb +13 -0
  305. data/spec/slack/web/api/endpoints/apps_manifest_spec.rb +36 -0
  306. data/spec/slack/web/api/endpoints/apps_spec.rb +16 -0
  307. data/spec/slack/web/api/endpoints/auth_teams_spec.rb +8 -0
  308. data/spec/slack/web/api/endpoints/bookmarks_spec.rb +40 -0
  309. data/spec/slack/web/api/endpoints/bots_spec.rb +1 -0
  310. data/spec/slack/web/api/endpoints/calls_participants_spec.rb +24 -0
  311. data/spec/slack/web/api/endpoints/calls_spec.rb +31 -0
  312. data/spec/slack/web/api/endpoints/chat_scheduledMessages_spec.rb +8 -0
  313. data/spec/slack/web/api/endpoints/custom_specs/auth_spec.rb +9 -7
  314. data/spec/slack/web/api/endpoints/custom_specs/chat_spec.rb +131 -39
  315. data/spec/slack/web/api/endpoints/custom_specs/conversations_spec.rb +13 -0
  316. data/spec/slack/web/api/endpoints/custom_specs/dialog_spec.rb +16 -6
  317. data/spec/slack/web/api/endpoints/custom_specs/users_spec.rb +8 -3
  318. data/spec/slack/web/api/endpoints/custom_specs/views_spec.rb +103 -0
  319. data/spec/slack/web/api/endpoints/dnd_spec.rb +4 -3
  320. data/spec/slack/web/api/endpoints/emoji_spec.rb +1 -0
  321. data/spec/slack/web/api/endpoints/files_comments_spec.rb +3 -21
  322. data/spec/slack/web/api/endpoints/files_remote_spec.rb +24 -0
  323. data/spec/slack/web/api/endpoints/files_spec.rb +5 -4
  324. data/spec/slack/web/api/endpoints/migration_spec.rb +1 -0
  325. data/spec/slack/web/api/endpoints/oauth_spec.rb +1 -22
  326. data/spec/slack/web/api/endpoints/oauth_v2_spec.rb +16 -0
  327. data/spec/slack/web/api/endpoints/openid_connect_spec.rb +8 -0
  328. data/spec/slack/web/api/endpoints/pins_spec.rb +1 -0
  329. data/spec/slack/web/api/endpoints/reactions_spec.rb +8 -1
  330. data/spec/slack/web/api/endpoints/reminders_spec.rb +3 -2
  331. data/spec/slack/web/api/endpoints/rtm_spec.rb +1 -0
  332. data/spec/slack/web/api/endpoints/search_spec.rb +1 -0
  333. data/spec/slack/web/api/endpoints/stars_spec.rb +1 -0
  334. data/spec/slack/web/api/endpoints/team_billing_spec.rb +8 -0
  335. data/spec/slack/web/api/endpoints/team_preferences_spec.rb +8 -0
  336. data/spec/slack/web/api/endpoints/team_profile_spec.rb +1 -0
  337. data/spec/slack/web/api/endpoints/team_spec.rb +1 -0
  338. data/spec/slack/web/api/endpoints/tooling_tokens_spec.rb +13 -0
  339. data/spec/slack/web/api/endpoints/usergroups_spec.rb +1 -0
  340. data/spec/slack/web/api/endpoints/usergroups_users_spec.rb +3 -2
  341. data/spec/slack/web/api/endpoints/users_admin_spec.rb +1 -0
  342. data/spec/slack/web/api/endpoints/users_prefs_spec.rb +1 -0
  343. data/spec/slack/web/api/endpoints/users_profile_spec.rb +1 -0
  344. data/spec/slack/web/api/endpoints/workflows_spec.rb +26 -0
  345. data/spec/slack/web/api/error_spec.rb +7 -7
  346. data/spec/slack/web/api/errors/slack_error_spec.rb +26 -7
  347. data/spec/slack/web/api/mixins/conversations_list_spec.rb +21 -0
  348. data/spec/slack/web/api/mixins/conversations_spec.rb +43 -0
  349. data/spec/slack/web/api/mixins/users_spec.rb +25 -14
  350. data/spec/slack/web/api/pagination/cursor_spec.rb +43 -15
  351. data/spec/slack/web/client_spec.rb +186 -19
  352. data/spec/slack/web/faraday/request_spec.rb +80 -0
  353. data/spec/slack/web/faraday/response/raise_error_spec.rb +48 -12
  354. data/spec/spec_helper.rb +9 -2
  355. data/spec/support/queue_with_timeout.rb +5 -4
  356. data/spec/support/real_time/concurrency/mock.rb +1 -0
  357. data/spec/support/real_time/connected_client.rb +6 -6
  358. data/spec/support/real_time/event.rb +1 -0
  359. data/spec/support/token.rb +1 -0
  360. data/spec/support/vcr.rb +37 -1
  361. metadata +177 -231
  362. data/.travis.yml +0 -30
  363. data/examples/hi_real_time/Gemfile +0 -5
  364. data/examples/hi_real_time/hi.gif +0 -0
  365. data/examples/hi_real_time/hi.rb +0 -37
  366. data/examples/hi_real_time_async_celluloid/Gemfile +0 -6
  367. data/examples/hi_real_time_async_eventmachine/Procfile +0 -2
  368. data/examples/hi_real_time_async_eventmachine/hi.rb +0 -36
  369. data/lib/slack/real_time/concurrency/celluloid.rb +0 -117
  370. data/lib/slack/real_time/concurrency/eventmachine.rb +0 -60
  371. data/lib/slack/web/api/mixins/channels.id.json +0 -20
  372. data/lib/slack/web/api/mixins/groups.id.json +0 -20
  373. data/lib/slack/web/api/mixins/groups.id.rb +0 -26
  374. data/lib/slack/web/api/patches/chat.1.text-attachments-required.patch +0 -13
  375. data/lib/slack/web/api/patches/chat.2.attachments-json.patch +0 -17
  376. data/lib/slack/web/api/patches/chat.3.update-attachments-support.patch +0 -21
  377. data/lib/slack/web/api/patches/chat.4.postEphemeral-attachments-support.patch +0 -17
  378. data/screenshots/register-bot.png +0 -0
  379. data/spec/fixtures/slack/web/503_error.yml +0 -14
  380. data/spec/fixtures/slack/web/channels_info.yml +0 -46
  381. data/spec/fixtures/slack/web/groups_info.yml +0 -43
  382. data/spec/slack/real_time/concurrency/celluloid_spec.rb +0 -62
  383. data/spec/slack/real_time/concurrency/eventmachine_spec.rb +0 -47
  384. data/spec/slack/web/api/endpoints/apps_permissions_spec.rb +0 -15
  385. data/spec/slack/web/api/endpoints/conversations_spec.rb +0 -100
  386. data/spec/slack/web/api/endpoints/custom_specs/channels_spec.rb +0 -11
  387. data/spec/slack/web/api/endpoints/custom_specs/groups_spec.rb +0 -11
  388. data/spec/slack/web/api/endpoints/im_spec.rb +0 -38
  389. data/spec/slack/web/api/endpoints/mpim_spec.rb +0 -38
  390. data/spec/slack/web/api/errors/service_unavailable_spec.rb +0 -14
  391. data/spec/slack/web/api/mixins/channels_spec.rb +0 -31
  392. data/spec/slack/web/api/mixins/groups_spec.rb +0 -31
@@ -1,3 +1,4 @@
1
+ # frozen_string_literal: true
1
2
  # This file was auto-generated by lib/tasks/web.rake
2
3
 
3
4
  module Slack
@@ -5,33 +6,6 @@ module Slack
5
6
  module Api
6
7
  module Endpoints
7
8
  module Channels
8
- #
9
- # Archives a channel.
10
- #
11
- # @option options [channel] :channel
12
- # Channel to archive.
13
- # @see https://api.slack.com/methods/channels.archive
14
- # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/channels/channels.archive.json
15
- def channels_archive(options = {})
16
- throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
17
- options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
18
- post('channels.archive', options)
19
- end
20
-
21
- #
22
- # Creates a channel.
23
- #
24
- # @option options [Object] :name
25
- # Name of channel to create.
26
- # @option options [Object] :validate
27
- # Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria.
28
- # @see https://api.slack.com/methods/channels.create
29
- # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/channels/channels.create.json
30
- def channels_create(options = {})
31
- throw ArgumentError.new('Required arguments :name missing') if options[:name].nil?
32
- post('channels.create', options)
33
- end
34
-
35
9
  #
36
10
  # Delete a channel (undocumented)
37
11
  #
@@ -40,225 +14,10 @@ module Slack
40
14
  # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/undocumented/channels/channels.delete.json
41
15
  def channels_delete(options = {})
42
16
  throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
43
- options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
17
+ options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
44
18
  logger.warn('The channels.delete method is undocumented.')
45
19
  post('channels.delete', options)
46
20
  end
47
-
48
- #
49
- # Fetches history of messages and events from a channel.
50
- #
51
- # @option options [channel] :channel
52
- # Channel to fetch history for.
53
- # @option options [Object] :inclusive
54
- # Include messages with latest or oldest timestamp in results.
55
- # @option options [timestamp] :latest
56
- # End of time range of messages to include in results.
57
- # @option options [timestamp] :oldest
58
- # Start of time range of messages to include in results.
59
- # @option options [Object] :unreads
60
- # Include unread_count_display in the output?.
61
- # @see https://api.slack.com/methods/channels.history
62
- # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/channels/channels.history.json
63
- def channels_history(options = {})
64
- throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
65
- options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
66
- post('channels.history', options)
67
- end
68
-
69
- #
70
- # Gets information about a channel.
71
- #
72
- # @option options [channel] :channel
73
- # Channel to get info on.
74
- # @option options [Object] :include_locale
75
- # Set this to true to receive the locale for this channel. Defaults to false.
76
- # @see https://api.slack.com/methods/channels.info
77
- # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/channels/channels.info.json
78
- def channels_info(options = {})
79
- throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
80
- options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
81
- post('channels.info', options)
82
- end
83
-
84
- #
85
- # Invites a user to a channel.
86
- #
87
- # @option options [channel] :channel
88
- # Channel to invite user to.
89
- # @option options [user] :user
90
- # User to invite to channel.
91
- # @see https://api.slack.com/methods/channels.invite
92
- # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/channels/channels.invite.json
93
- def channels_invite(options = {})
94
- throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
95
- throw ArgumentError.new('Required arguments :user missing') if options[:user].nil?
96
- options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
97
- options = options.merge(user: users_id(options)['user']['id']) if options[:user]
98
- post('channels.invite', options)
99
- end
100
-
101
- #
102
- # Joins a channel, creating it if needed.
103
- #
104
- # @option options [Object] :name
105
- # Name of channel to join.
106
- # @option options [Object] :validate
107
- # Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria.
108
- # @see https://api.slack.com/methods/channels.join
109
- # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/channels/channels.join.json
110
- def channels_join(options = {})
111
- throw ArgumentError.new('Required arguments :name missing') if options[:name].nil?
112
- post('channels.join', options)
113
- end
114
-
115
- #
116
- # Removes a user from a channel.
117
- #
118
- # @option options [channel] :channel
119
- # Channel to remove user from.
120
- # @option options [user] :user
121
- # User to remove from channel.
122
- # @see https://api.slack.com/methods/channels.kick
123
- # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/channels/channels.kick.json
124
- def channels_kick(options = {})
125
- throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
126
- throw ArgumentError.new('Required arguments :user missing') if options[:user].nil?
127
- options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
128
- options = options.merge(user: users_id(options)['user']['id']) if options[:user]
129
- post('channels.kick', options)
130
- end
131
-
132
- #
133
- # Leaves a channel.
134
- #
135
- # @option options [channel] :channel
136
- # Channel to leave.
137
- # @see https://api.slack.com/methods/channels.leave
138
- # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/channels/channels.leave.json
139
- def channels_leave(options = {})
140
- throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
141
- options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
142
- post('channels.leave', options)
143
- end
144
-
145
- #
146
- # Lists all channels in a Slack team.
147
- #
148
- # @option options [Object] :cursor
149
- # 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.
150
- # @option options [Object] :exclude_archived
151
- # Exclude archived channels from the list.
152
- # @option options [Object] :exclude_members
153
- # Exclude the members collection from each channel.
154
- # @option options [Object] :limit
155
- # 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.
156
- # @see https://api.slack.com/methods/channels.list
157
- # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/channels/channels.list.json
158
- def channels_list(options = {})
159
- if block_given?
160
- Pagination::Cursor.new(self, :channels_list, options).each do |page|
161
- yield page
162
- end
163
- else
164
- post('channels.list', options)
165
- end
166
- end
167
-
168
- #
169
- # Sets the read cursor in a channel.
170
- #
171
- # @option options [channel] :channel
172
- # Channel to set reading cursor in.
173
- # @option options [timestamp] :ts
174
- # Timestamp of the most recently seen message.
175
- # @see https://api.slack.com/methods/channels.mark
176
- # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/channels/channels.mark.json
177
- def channels_mark(options = {})
178
- throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
179
- throw ArgumentError.new('Required arguments :ts missing') if options[:ts].nil?
180
- options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
181
- post('channels.mark', options)
182
- end
183
-
184
- #
185
- # Renames a channel.
186
- #
187
- # @option options [channel] :channel
188
- # Channel to rename.
189
- # @option options [Object] :name
190
- # New name for channel.
191
- # @option options [Object] :validate
192
- # Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria.
193
- # @see https://api.slack.com/methods/channels.rename
194
- # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/channels/channels.rename.json
195
- def channels_rename(options = {})
196
- throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
197
- throw ArgumentError.new('Required arguments :name missing') if options[:name].nil?
198
- options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
199
- post('channels.rename', options)
200
- end
201
-
202
- #
203
- # Retrieve a thread of messages posted to a channel
204
- #
205
- # @option options [channel] :channel
206
- # Channel to fetch thread from.
207
- # @option options [Object] :thread_ts
208
- # Unique identifier of a thread's parent message.
209
- # @see https://api.slack.com/methods/channels.replies
210
- # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/channels/channels.replies.json
211
- def channels_replies(options = {})
212
- throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
213
- throw ArgumentError.new('Required arguments :thread_ts missing') if options[:thread_ts].nil?
214
- options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
215
- post('channels.replies', options)
216
- end
217
-
218
- #
219
- # Sets the purpose for a channel.
220
- #
221
- # @option options [channel] :channel
222
- # Channel to set the purpose of.
223
- # @option options [Object] :purpose
224
- # The new purpose.
225
- # @see https://api.slack.com/methods/channels.setPurpose
226
- # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/channels/channels.setPurpose.json
227
- def channels_setPurpose(options = {})
228
- throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
229
- throw ArgumentError.new('Required arguments :purpose missing') if options[:purpose].nil?
230
- options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
231
- post('channels.setPurpose', options)
232
- end
233
-
234
- #
235
- # Sets the topic for a channel.
236
- #
237
- # @option options [channel] :channel
238
- # Channel to set the topic of.
239
- # @option options [Object] :topic
240
- # The new topic.
241
- # @see https://api.slack.com/methods/channels.setTopic
242
- # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/channels/channels.setTopic.json
243
- def channels_setTopic(options = {})
244
- throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
245
- throw ArgumentError.new('Required arguments :topic missing') if options[:topic].nil?
246
- options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
247
- post('channels.setTopic', options)
248
- end
249
-
250
- #
251
- # Unarchives a channel.
252
- #
253
- # @option options [channel] :channel
254
- # Channel to unarchive.
255
- # @see https://api.slack.com/methods/channels.unarchive
256
- # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/channels/channels.unarchive.json
257
- def channels_unarchive(options = {})
258
- throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
259
- options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
260
- post('channels.unarchive', options)
261
- end
262
21
  end
263
22
  end
264
23
  end
@@ -1,3 +1,4 @@
1
+ # frozen_string_literal: true
1
2
  # This file was auto-generated by lib/tasks/web.rake
2
3
 
3
4
  module Slack
@@ -18,7 +19,7 @@ module Slack
18
19
  def chat_command(options = {})
19
20
  throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
20
21
  throw ArgumentError.new('Required arguments :command missing') if options[:command].nil?
21
- options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
22
+ options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
22
23
  logger.warn('The chat.command method is undocumented.')
23
24
  post('chat.command', options)
24
25
  end
@@ -30,30 +31,48 @@ module Slack
30
31
  # Channel containing the message to be deleted.
31
32
  # @option options [timestamp] :ts
32
33
  # Timestamp of the message to be deleted.
33
- # @option options [Object] :as_user
34
+ # @option options [boolean] :as_user
34
35
  # 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.
35
36
  # @see https://api.slack.com/methods/chat.delete
36
37
  # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/chat/chat.delete.json
37
38
  def chat_delete(options = {})
38
39
  throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
39
40
  throw ArgumentError.new('Required arguments :ts missing') if options[:ts].nil?
40
- options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
41
+ options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
41
42
  post('chat.delete', options)
42
43
  end
43
44
 
45
+ #
46
+ # Deletes a pending scheduled message from the queue.
47
+ #
48
+ # @option options [channel] :channel
49
+ # The channel the scheduled_message is posting to.
50
+ # @option options [string] :scheduled_message_id
51
+ # scheduled_message_id returned from call to chat.scheduleMessage.
52
+ # @option options [boolean] :as_user
53
+ # 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.
54
+ # @see https://api.slack.com/methods/chat.deleteScheduledMessage
55
+ # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/chat/chat.deleteScheduledMessage.json
56
+ def chat_deleteScheduledMessage(options = {})
57
+ throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
58
+ throw ArgumentError.new('Required arguments :scheduled_message_id missing') if options[:scheduled_message_id].nil?
59
+ options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
60
+ post('chat.deleteScheduledMessage', options)
61
+ end
62
+
44
63
  #
45
64
  # Retrieve a permalink URL for a specific extant message
46
65
  #
47
66
  # @option options [channel] :channel
48
67
  # The ID of the conversation or channel containing the message.
49
- # @option options [Object] :message_ts
68
+ # @option options [string] :message_ts
50
69
  # A message's ts value, uniquely identifying it within a channel.
51
70
  # @see https://api.slack.com/methods/chat.getPermalink
52
71
  # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/chat/chat.getPermalink.json
53
72
  def chat_getPermalink(options = {})
54
73
  throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
55
74
  throw ArgumentError.new('Required arguments :message_ts missing') if options[:message_ts].nil?
56
- options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
75
+ options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
57
76
  post('chat.getPermalink', options)
58
77
  end
59
78
 
@@ -62,7 +81,7 @@ module Slack
62
81
  #
63
82
  # @option options [channel] :channel
64
83
  # Channel to send message to. Can be a public channel, private group or IM channel. Can be an encoded ID, or a name.
65
- # @option options [Object] :text
84
+ # @option options [string] :text
66
85
  # Text of the message to send.
67
86
  # @see https://api.slack.com/methods/chat.meMessage
68
87
  # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/chat/chat.meMessage.json
@@ -77,23 +96,33 @@ module Slack
77
96
  #
78
97
  # @option options [channel] :channel
79
98
  # Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name.
80
- # @option options [Object] :text
81
- # 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.
99
+ # @option options [string] :text
100
+ # How this field works and whether it is required depends on other fields you use in your API call. See below for more detail.
82
101
  # @option options [user] :user
83
102
  # id of the user who will receive the ephemeral message. The user should be in the channel specified by the channel argument.
84
- # @option options [Object] :as_user
85
- # Pass true to post the message as the authed bot. Defaults to false.
86
- # @option options [Object] :attachments
103
+ # @option options [boolean] :as_user
104
+ # 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.
105
+ # @option options [string] :attachments
87
106
  # A JSON-based array of structured attachments, presented as a URL-encoded string.
88
- # @option options [Object] :link_names
107
+ # @option options [blocks[] as string] :blocks
108
+ # A JSON-based array of structured blocks, presented as a URL-encoded string.
109
+ # @option options [string] :icon_emoji
110
+ # 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.
111
+ # @option options [string] :icon_url
112
+ # 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.
113
+ # @option options [boolean] :link_names
89
114
  # Find and link channel names and usernames.
90
- # @option options [Object] :parse
115
+ # @option options [string] :parse
91
116
  # Change how messages are treated. Defaults to none. See below.
117
+ # @option options [string] :thread_ts
118
+ # 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.
119
+ # @option options [string] :username
120
+ # Set your bot's user name. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.
92
121
  # @see https://api.slack.com/methods/chat.postEphemeral
93
122
  # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/chat/chat.postEphemeral.json
94
123
  def chat_postEphemeral(options = {})
95
124
  throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
96
- throw ArgumentError.new('Required arguments :text missing') if options[:text].nil?
125
+ throw ArgumentError.new('Required arguments :text, :attachments or :blocks missing') if options[:text].nil? && options[:attachments].nil? && options[:blocks].nil?
97
126
  throw ArgumentError.new('Required arguments :user missing') if options[:user].nil?
98
127
  options = options.merge(user: users_id(options)['user']['id']) if options[:user]
99
128
  # attachments must be passed as an encoded JSON string
@@ -102,6 +131,12 @@ module Slack
102
131
  attachments = JSON.dump(attachments) unless attachments.is_a?(String)
103
132
  options = options.merge(attachments: attachments)
104
133
  end
134
+ # blocks must be passed as an encoded JSON string
135
+ if options.key?(:blocks)
136
+ blocks = options[:blocks]
137
+ blocks = JSON.dump(blocks) unless blocks.is_a?(String)
138
+ options = options.merge(blocks: blocks)
139
+ end
105
140
  post('chat.postEphemeral', options)
106
141
  end
107
142
 
@@ -110,56 +145,108 @@ module Slack
110
145
  #
111
146
  # @option options [channel] :channel
112
147
  # Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name. See below for more details.
113
- # @option options [Object] :text
114
- # 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.
115
- # @option options [Object] :as_user
116
- # Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See authorship below.
117
- # @option options [Object] :attachments
148
+ # @option options [string] :attachments
118
149
  # A JSON-based array of structured attachments, presented as a URL-encoded string.
119
- # @option options [Object] :icon_emoji
150
+ # @option options [blocks[] as string] :blocks
151
+ # A JSON-based array of structured blocks, presented as a URL-encoded string.
152
+ # @option options [string] :text
153
+ # The formatted text of the message to be published. If blocks are included, this will become the fallback text used in notifications.
154
+ # @option options [boolean] :as_user
155
+ # Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See authorship below.
156
+ # @option options [string] :icon_emoji
120
157
  # 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.
121
- # @option options [Object] :icon_url
158
+ # @option options [string] :icon_url
122
159
  # 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.
123
- # @option options [Object] :link_names
160
+ # @option options [boolean] :link_names
124
161
  # Find and link channel names and usernames.
125
- # @option options [Object] :parse
162
+ # @option options [boolean] :mrkdwn
163
+ # Disable Slack markup parsing by setting to false. Enabled by default.
164
+ # @option options [string] :parse
126
165
  # Change how messages are treated. Defaults to none. See below.
127
- # @option options [Object] :reply_broadcast
166
+ # @option options [boolean] :reply_broadcast
128
167
  # Used in conjunction with thread_ts and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to false.
129
- # @option options [Object] :thread_ts
168
+ # @option options [string] :thread_ts
130
169
  # Provide another message's ts value to make this message a reply. Avoid using a reply's ts value; use its parent instead.
131
- # @option options [Object] :unfurl_links
170
+ # @option options [boolean] :unfurl_links
132
171
  # Pass true to enable unfurling of primarily text-based content.
133
- # @option options [Object] :unfurl_media
172
+ # @option options [boolean] :unfurl_media
134
173
  # Pass false to disable unfurling of media content.
135
- # @option options [Object] :username
174
+ # @option options [string] :username
136
175
  # Set your bot's user name. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.
137
176
  # @see https://api.slack.com/methods/chat.postMessage
138
177
  # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/chat/chat.postMessage.json
139
178
  def chat_postMessage(options = {})
140
179
  throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
141
- throw ArgumentError.new('Required arguments :text or :attachments missing') if options[:text].nil? && options[:attachments].nil?
180
+ throw ArgumentError.new('Required arguments :text, :attachments or :blocks missing') if options[:text].nil? && options[:attachments].nil? && options[:blocks].nil?
142
181
  # attachments must be passed as an encoded JSON string
143
182
  if options.key?(:attachments)
144
183
  attachments = options[:attachments]
145
184
  attachments = JSON.dump(attachments) unless attachments.is_a?(String)
146
185
  options = options.merge(attachments: attachments)
147
186
  end
187
+ # blocks must be passed as an encoded JSON string
188
+ if options.key?(:blocks)
189
+ blocks = options[:blocks]
190
+ blocks = JSON.dump(blocks) unless blocks.is_a?(String)
191
+ options = options.merge(blocks: blocks)
192
+ end
148
193
  post('chat.postMessage', options)
149
194
  end
150
195
 
196
+ #
197
+ # Schedules a message to be sent to a channel.
198
+ #
199
+ # @option options [channel] :channel
200
+ # Channel, private group, or DM channel to send message to. Can be an encoded ID, or a name. See below for more details.
201
+ # @option options [integer] :post_at
202
+ # Unix EPOCH timestamp of time in future to send the message.
203
+ # @option options [string] :text
204
+ # How this field works and whether it is required depends on other fields you use in your API call. See below for more detail.
205
+ # @option options [boolean] :as_user
206
+ # Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See chat.postMessage.
207
+ # @option options [string] :attachments
208
+ # A JSON-based array of structured attachments, presented as a URL-encoded string.
209
+ # @option options [blocks[] as string] :blocks
210
+ # A JSON-based array of structured blocks, presented as a URL-encoded string.
211
+ # @option options [boolean] :link_names
212
+ # Find and link channel names and usernames.
213
+ # @option options [string] :parse
214
+ # Change how messages are treated. Defaults to none. See chat.postMessage.
215
+ # @option options [boolean] :reply_broadcast
216
+ # Used in conjunction with thread_ts and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to false.
217
+ # @option options [string] :thread_ts
218
+ # Provide another message's ts value to make this message a reply. Avoid using a reply's ts value; use its parent instead.
219
+ # @option options [boolean] :unfurl_links
220
+ # Pass true to enable unfurling of primarily text-based content.
221
+ # @option options [boolean] :unfurl_media
222
+ # Pass false to disable unfurling of media content.
223
+ # @see https://api.slack.com/methods/chat.scheduleMessage
224
+ # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/chat/chat.scheduleMessage.json
225
+ def chat_scheduleMessage(options = {})
226
+ throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
227
+ throw ArgumentError.new('Required arguments :post_at missing') if options[:post_at].nil?
228
+ throw ArgumentError.new('Required arguments :text missing') if options[:text].nil?
229
+ post('chat.scheduleMessage', options)
230
+ end
231
+
151
232
  #
152
233
  # Provide custom unfurl behavior for user-posted URLs
153
234
  #
154
235
  # @option options [channel] :channel
155
- # Channel ID of the message.
236
+ # Channel ID of the message. Both channel and ts must be provided together, or unfurl_id and source must be provided together.
156
237
  # @option options [timestamp] :ts
157
238
  # Timestamp of the message to add unfurl behavior to.
158
- # @option options [Object] :unfurls
159
- # URL-encoded JSON map with keys set to URLs featured in the the message, pointing to their unfurl message attachments.
239
+ # @option options [string] :unfurls
240
+ # URL-encoded JSON map with keys set to URLs featured in the the message, pointing to their unfurl blocks or message attachments.
241
+ # @option options [string] :source
242
+ # The source of the link to unfurl. The source may either be composer, when the link is inside the message composer, or conversations_history, when the link has been posted to a conversation.
243
+ # @option options [string] :unfurl_id
244
+ # The ID of the link to unfurl. Both unfurl_id and source must be provided together, or channel and ts must be provided together.
245
+ # @option options [Object] :user_auth_blocks
246
+ # Provide a JSON based array of structured blocks presented as URL-encoded string to send as an ephemeral message to the user as invitation to authenticate further and enable full unfurling behavior.
160
247
  # @option options [Object] :user_auth_message
161
- # Provide a simply-formatted string to send as an ephemeral message to the user as invitation to authenticate further and enable full unfurling behavior.
162
- # @option options [Object] :user_auth_required
248
+ # Provide a simply-formatted string to send as an ephemeral message to the user as invitation to authenticate further and enable full unfurling behavior. Provides two buttons, Not now or Never ask me again.
249
+ # @option options [boolean] :user_auth_required
163
250
  # Set to true or 1 to indicate the user must install your Slack app to trigger unfurls for this domain.
164
251
  # @option options [Object] :user_auth_url
165
252
  # Send users to this custom URL where they will complete authentication in your app to fully trigger unfurling. Value should be properly URL-encoded.
@@ -169,7 +256,7 @@ module Slack
169
256
  throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
170
257
  throw ArgumentError.new('Required arguments :ts missing') if options[:ts].nil?
171
258
  throw ArgumentError.new('Required arguments :unfurls missing') if options[:unfurls].nil?
172
- options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
259
+ options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
173
260
  post('chat.unfurl', options)
174
261
  end
175
262
 
@@ -178,31 +265,43 @@ module Slack
178
265
  #
179
266
  # @option options [channel] :channel
180
267
  # Channel containing the message to be updated.
181
- # @option options [Object] :text
182
- # New text for the message, using the default formatting rules. It's not required when presenting attachments.
183
268
  # @option options [timestamp] :ts
184
269
  # Timestamp of the message to be updated.
185
- # @option options [Object] :as_user
270
+ # @option options [boolean] :as_user
186
271
  # Pass true to update the message as the authed user. Bot users in this context are considered authed users.
187
- # @option options [Object] :attachments
188
- # A JSON-based array of structured attachments, presented as a URL-encoded string. This field is required when not presenting text.
189
- # @option options [Object] :link_names
190
- # 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.
191
- # @option options [Object] :parse
192
- # Change how messages are treated. Defaults to client, unlike chat.postMessage. See below.
272
+ # @option options [string] :attachments
273
+ # 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.
274
+ # @option options [blocks[] as string] :blocks
275
+ # 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.
276
+ # @option options [array] :file_ids
277
+ # Array of new file ids that will be sent with this message.
278
+ # @option options [boolean] :link_names
279
+ # 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.
280
+ # @option options [string] :parse
281
+ # 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.
282
+ # @option options [boolean] :reply_broadcast
283
+ # Broadcast an existing thread reply to make it visible to everyone in the channel or conversation.
284
+ # @option options [string] :text
285
+ # New text for the message, using the default formatting rules. It's not required when presenting blocks or attachments.
193
286
  # @see https://api.slack.com/methods/chat.update
194
287
  # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/chat/chat.update.json
195
288
  def chat_update(options = {})
196
289
  throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
197
- throw ArgumentError.new('Required arguments :text or :attachments missing') if options[:text].nil? && options[:attachments].nil?
290
+ throw ArgumentError.new('Required arguments :text, :attachments, :blocks or :reply_broadcast missing') if options[:text].nil? && options[:attachments].nil? && options[:blocks].nil? && options[:reply_broadcast].nil?
198
291
  throw ArgumentError.new('Required arguments :ts missing') if options[:ts].nil?
199
- options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
292
+ options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
200
293
  # attachments must be passed as an encoded JSON string
201
294
  if options.key?(:attachments)
202
295
  attachments = options[:attachments]
203
296
  attachments = JSON.dump(attachments) unless attachments.is_a?(String)
204
297
  options = options.merge(attachments: attachments)
205
298
  end
299
+ # blocks must be passed as an encoded JSON string
300
+ if options.key?(:blocks)
301
+ blocks = options[:blocks]
302
+ blocks = JSON.dump(blocks) unless blocks.is_a?(String)
303
+ options = options.merge(blocks: blocks)
304
+ end
206
305
  post('chat.update', options)
207
306
  end
208
307
  end
@@ -0,0 +1,40 @@
1
+ # frozen_string_literal: true
2
+ # This file was auto-generated by lib/tasks/web.rake
3
+
4
+ module Slack
5
+ module Web
6
+ module Api
7
+ module Endpoints
8
+ module ChatScheduledmessages
9
+ #
10
+ # Returns a list of scheduled messages.
11
+ #
12
+ # @option options [channel] :channel
13
+ # The channel of the scheduled messages.
14
+ # @option options [string] :cursor
15
+ # 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.
16
+ # @option options [timestamp] :latest
17
+ # A UNIX timestamp of the latest value in the time range.
18
+ # @option options [integer] :limit
19
+ # Maximum number of original entries to return.
20
+ # @option options [timestamp] :oldest
21
+ # A UNIX timestamp of the oldest value in the time range.
22
+ # @option options [string] :team_id
23
+ # encoded team id to list channels in, required if org token is used.
24
+ # @see https://api.slack.com/methods/chat.scheduledMessages.list
25
+ # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/chat.scheduledMessages/chat.scheduledMessages.list.json
26
+ def chat_scheduledMessages_list(options = {})
27
+ options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
28
+ if block_given?
29
+ Pagination::Cursor.new(self, :chat_scheduledMessages_list, options).each do |page|
30
+ yield page
31
+ end
32
+ else
33
+ post('chat.scheduledMessages.list', options)
34
+ end
35
+ end
36
+ end
37
+ end
38
+ end
39
+ end
40
+ end