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/im.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 'Get info on your direct messages.'
4
5
  command 'im' do |g|
5
- g.desc 'This method closes a direct message channel.'
6
- g.long_desc %( This method closes a direct message channel. )
6
+ g.desc 'Close a direct message channel.'
7
+ g.long_desc %( Close a direct message channel. )
7
8
  g.command 'close' do |c|
8
9
  c.flag 'channel', desc: 'Direct message channel to close.'
9
10
  c.action do |_global_options, options, _args|
@@ -11,29 +12,31 @@ command 'im' do |g|
11
12
  end
12
13
  end
13
14
 
14
- g.desc 'This method returns a portion of messages/events from the specified direct message channel.'
15
- g.long_desc %( This method returns a portion of messages/events from the specified direct message channel. To read the entire history for a direct message channel, call the method with no latest or oldest arguments, and then continue paging using the instructions below. )
15
+ g.desc 'Fetches history of messages and events from direct message channel.'
16
+ g.long_desc %( Fetches history of messages and events from direct message channel. )
16
17
  g.command 'history' do |c|
17
18
  c.flag 'channel', desc: 'Direct message channel to fetch history for.'
19
+ c.flag 'inclusive', desc: 'Include messages with latest or oldest timestamp in results.'
18
20
  c.flag 'latest', desc: 'End of time range of messages to include in results.'
19
21
  c.flag 'oldest', desc: 'Start of time range of messages to include in results.'
20
- c.flag 'inclusive', desc: 'Include messages with latest or oldest timestamp in results.'
21
22
  c.flag 'unreads', desc: 'Include unread_count_display in the output?.'
22
23
  c.action do |_global_options, options, _args|
23
24
  puts JSON.dump($client.im_history(options))
24
25
  end
25
26
  end
26
27
 
27
- g.desc 'This method returns a list of all im channels that the user has.'
28
- g.long_desc %( This method returns a list of all im channels that the user has. )
28
+ g.desc 'Lists direct message channels for the calling user.'
29
+ g.long_desc %( Lists direct message channels for the calling user. )
29
30
  g.command 'list' do |c|
31
+ 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."
32
+ 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."
30
33
  c.action do |_global_options, options, _args|
31
34
  puts JSON.dump($client.im_list(options))
32
35
  end
33
36
  end
34
37
 
35
- g.desc 'This method moves the read cursor in a direct message channel.'
36
- g.long_desc %( This method moves the read cursor in a direct message channel. )
38
+ g.desc 'Sets the read cursor in a direct message channel.'
39
+ g.long_desc %( Sets the read cursor in a direct message channel. )
37
40
  g.command 'mark' do |c|
38
41
  c.flag 'channel', desc: 'Direct message channel to set reading cursor in.'
39
42
  c.flag 'ts', desc: 'Timestamp of the most recently seen message.'
@@ -42,18 +45,19 @@ command 'im' do |g|
42
45
  end
43
46
  end
44
47
 
45
- g.desc 'This method opens a direct message channel with another member of your Slack team.'
46
- g.long_desc %( This method opens a direct message channel with another member of your Slack team. )
48
+ g.desc 'Opens a direct message channel.'
49
+ g.long_desc %( Opens a direct message channel. )
47
50
  g.command 'open' do |c|
48
51
  c.flag 'user', desc: 'User to open a direct message channel with.'
52
+ c.flag 'include_locale', desc: 'Set this to true to receive the locale for this im. Defaults to false.'
49
53
  c.flag 'return_im', desc: 'Boolean, indicates you want the full IM channel definition in the response.'
50
54
  c.action do |_global_options, options, _args|
51
55
  puts JSON.dump($client.im_open(options))
52
56
  end
53
57
  end
54
58
 
55
- g.desc 'This method returns an entire thread (a message plus all the messages in reply to it).'
56
- g.long_desc %( This method returns an entire thread (a message plus all the messages in reply to it). )
59
+ g.desc 'Retrieve a thread of messages posted to a direct message conversation'
60
+ g.long_desc %( Retrieve a thread of messages posted to a direct message conversation )
57
61
  g.command 'replies' do |c|
58
62
  c.flag 'channel', desc: 'Direct message channel to fetch thread from.'
59
63
  c.flag 'thread_ts', desc: "Unique identifier of a thread's parent message."
@@ -0,0 +1,16 @@
1
+ # frozen_string_literal: true
2
+ # This file was auto-generated by lib/tasks/web.rake
3
+
4
+ desc 'Migration methods.'
5
+ command 'migration' do |g|
6
+ g.desc 'For Enterprise Grid workspaces, map local user IDs to global user IDs'
7
+ g.long_desc %( For Enterprise Grid workspaces, map local user IDs to global user IDs )
8
+ g.command 'exchange' do |c|
9
+ c.flag 'users', desc: 'A comma-separated list of user ids, up to 400 per request.'
10
+ c.flag 'team_id', desc: 'Specify team_id starts with T in case of Org Token.'
11
+ c.flag 'to_old', desc: 'Specify true to convert W global user IDs to workspace-specific U IDs. Defaults to false.'
12
+ c.action do |_global_options, options, _args|
13
+ puts JSON.dump($client.migration_exchange(options))
14
+ end
15
+ end
16
+ end
data/bin/commands/mpim.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 'Get info on your multiparty direct messages.'
4
5
  command 'mpim' do |g|
5
- g.desc 'This method closes a multiparty direct message channel.'
6
- g.long_desc %( This method closes a multiparty direct message channel. )
6
+ g.desc 'Closes a multiparty direct message channel.'
7
+ g.long_desc %( Closes a multiparty direct message channel. )
7
8
  g.command 'close' do |c|
8
9
  c.flag 'channel', desc: 'MPIM to close.'
9
10
  c.action do |_global_options, options, _args|
@@ -11,32 +12,34 @@ command 'mpim' do |g|
11
12
  end
12
13
  end
13
14
 
14
- g.desc 'This method returns a portion of messages/events from the specified multiparty direct message channel.'
15
- g.long_desc %( This method returns a portion of messages/events from the specified multiparty direct message channel. To read the entire history for a multiparty direct message, call the method with no latest or oldest arguments, and then continue paging using the instructions below. )
15
+ g.desc 'Fetches history of messages and events from a multiparty direct message.'
16
+ g.long_desc %( Fetches history of messages and events from a multiparty direct message. )
16
17
  g.command 'history' do |c|
17
18
  c.flag 'channel', desc: 'Multiparty direct message to fetch history for.'
19
+ c.flag 'inclusive', desc: 'Include messages with latest or oldest timestamp in results.'
18
20
  c.flag 'latest', desc: 'End of time range of messages to include in results.'
19
21
  c.flag 'oldest', desc: 'Start of time range of messages to include in results.'
20
- c.flag 'inclusive', desc: 'Include messages with latest or oldest timestamp in results.'
21
22
  c.flag 'unreads', desc: 'Include unread_count_display in the output?.'
22
23
  c.action do |_global_options, options, _args|
23
24
  puts JSON.dump($client.mpim_history(options))
24
25
  end
25
26
  end
26
27
 
27
- g.desc 'This method returns a list of all multiparty direct message channels that the user has.'
28
- g.long_desc %( This method returns a list of all multiparty direct message channels that the user has. )
28
+ g.desc 'Lists multiparty direct message channels for the calling user.'
29
+ g.long_desc %( Lists multiparty direct message channels for the calling user. )
29
30
  g.command 'list' do |c|
31
+ c.flag 'cursor', desc: "Parameter for pagination. Set cursor equal to the next_cursor attribute returned by the previous request's response_metadata. This parameter is optional, but pagination is mandatory: the default value simply fetches the first 'page' of the collection. See pagination for more details."
32
+ 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."
30
33
  c.action do |_global_options, options, _args|
31
34
  puts JSON.dump($client.mpim_list(options))
32
35
  end
33
36
  end
34
37
 
35
- g.desc 'This method moves the read cursor in a multiparty direct message channel.'
36
- g.long_desc %( This method moves the read cursor in a multiparty direct message channel. )
38
+ g.desc 'Sets the read cursor in a multiparty direct message channel.'
39
+ g.long_desc %( Sets the read cursor in a multiparty direct message channel. )
37
40
  g.command 'mark' do |c|
38
- c.flag 'channel', desc: 'multiparty direct message channel to set reading cursor in.'
39
- c.flag 'ts', desc: 'Timestamp of the most recently seen message.'
41
+ c.flag 'channel', desc: 'Channel or conversation to set the read cursor for.'
42
+ c.flag 'ts', desc: 'Unique identifier of message you want marked as most recently seen in this conversation.'
40
43
  c.action do |_global_options, options, _args|
41
44
  puts JSON.dump($client.mpim_mark(options))
42
45
  end
@@ -51,8 +54,8 @@ command 'mpim' do |g|
51
54
  end
52
55
  end
53
56
 
54
- g.desc 'This method returns an entire thread (a message plus all the messages in reply to it).'
55
- g.long_desc %( This method returns an entire thread (a message plus all the messages in reply to it). )
57
+ g.desc 'Retrieve a thread of messages posted to a direct message conversation from a multiparty direct message.'
58
+ g.long_desc %( Retrieve a thread of messages posted to a direct message conversation from a multiparty direct message. )
56
59
  g.command 'replies' do |c|
57
60
  c.flag 'channel', desc: 'Multiparty direct message channel to fetch thread from.'
58
61
  c.flag 'thread_ts', desc: "Unique identifier of a thread's parent message."
@@ -1,16 +1,31 @@
1
+ # frozen_string_literal: true
1
2
  # This file was auto-generated by lib/tasks/web.rake
2
3
 
3
4
  desc 'Oauth methods.'
4
5
  command 'oauth' do |g|
5
- g.desc 'This method allows you to exchange a temporary OAuth code for an API access token.'
6
- g.long_desc %( This method allows you to exchange a temporary OAuth code for an API access token. This is used as part of the OAuth authentication flow. )
6
+ g.desc 'Exchanges a temporary OAuth verifier code for an access token.'
7
+ g.long_desc %( Exchanges a temporary OAuth verifier code for an access token. )
7
8
  g.command 'access' do |c|
8
9
  c.flag 'client_id', desc: 'Issued when you created your application.'
9
10
  c.flag 'client_secret', desc: 'Issued when you created your application.'
10
11
  c.flag 'code', desc: 'The code param returned via the OAuth callback.'
11
12
  c.flag 'redirect_uri', desc: 'This must match the originally submitted URI (if one was sent).'
13
+ c.flag 'single_channel', desc: 'Request the user to add your app only to a single channel. Only valid with a legacy workspace app.'
12
14
  c.action do |_global_options, options, _args|
13
15
  puts JSON.dump($client.oauth_access(options))
14
16
  end
15
17
  end
18
+
19
+ g.desc 'Exchanges a temporary OAuth verifier code for a workspace token.'
20
+ g.long_desc %( Exchanges a temporary OAuth verifier code for a workspace token. )
21
+ g.command 'token' do |c|
22
+ c.flag 'client_id', desc: 'Issued when you created your application.'
23
+ c.flag 'client_secret', desc: 'Issued when you created your application.'
24
+ c.flag 'code', desc: 'The code param returned via the OAuth callback.'
25
+ c.flag 'redirect_uri', desc: 'This must match the originally submitted URI (if one was sent).'
26
+ c.flag 'single_channel', desc: 'Request the user to add your app only to a single channel.'
27
+ c.action do |_global_options, options, _args|
28
+ puts JSON.dump($client.oauth_token(options))
29
+ end
30
+ end
16
31
  end
@@ -0,0 +1,17 @@
1
+ # frozen_string_literal: true
2
+ # This file was auto-generated by lib/tasks/web.rake
3
+
4
+ desc 'OauthV2 methods.'
5
+ command 'oauth_v2' do |g|
6
+ g.desc 'Exchanges a temporary OAuth verifier code for an access token.'
7
+ g.long_desc %( Exchanges a temporary OAuth verifier code for an access token. )
8
+ g.command 'access' do |c|
9
+ c.flag 'code', desc: 'The code param returned via the OAuth callback.'
10
+ c.flag 'client_id', desc: 'Issued when you created your application.'
11
+ c.flag 'client_secret', desc: 'Issued when you created your application.'
12
+ c.flag 'redirect_uri', desc: 'This must match the originally submitted URI (if one was sent).'
13
+ c.action do |_global_options, options, _args|
14
+ puts JSON.dump($client.oauth_v2_access(options))
15
+ end
16
+ end
17
+ end
data/bin/commands/pins.rb CHANGED
@@ -1,21 +1,20 @@
1
+ # frozen_string_literal: true
1
2
  # This file was auto-generated by lib/tasks/web.rake
2
3
 
3
4
  desc 'Pins methods.'
4
5
  command 'pins' do |g|
5
- g.desc 'This method pins an item (file, file comment, channel message, or group message) to a particular channel.'
6
- g.long_desc %( This method pins an item (file, file comment, channel message, or group message) to a particular channel. The channel argument is required and one of file, file_comment, or timestamp must also be specified. )
6
+ g.desc 'Pins an item to a channel.'
7
+ g.long_desc %( Pins an item to a channel. )
7
8
  g.command 'add' do |c|
8
9
  c.flag 'channel', desc: 'Channel to pin the item in.'
9
- c.flag 'file', desc: 'File to pin.'
10
- c.flag 'file_comment', desc: 'File comment to pin.'
11
10
  c.flag 'timestamp', desc: 'Timestamp of the message to pin.'
12
11
  c.action do |_global_options, options, _args|
13
12
  puts JSON.dump($client.pins_add(options))
14
13
  end
15
14
  end
16
15
 
17
- g.desc 'This method lists the items pinned to a channel.'
18
- g.long_desc %( This method lists the items pinned to a channel. )
16
+ g.desc 'Lists items pinned to a channel.'
17
+ g.long_desc %( Lists items pinned to a channel. )
19
18
  g.command 'list' do |c|
20
19
  c.flag 'channel', desc: 'Channel to get pinned items for.'
21
20
  c.action do |_global_options, options, _args|
@@ -23,12 +22,10 @@ command 'pins' do |g|
23
22
  end
24
23
  end
25
24
 
26
- g.desc 'This method un-pins an item (file, file comment, channel message, or group message) from a channel.'
27
- g.long_desc %( This method un-pins an item (file, file comment, channel message, or group message) from a channel. The channel argument is required and one of file, file_comment, or timestamp must also be specified. )
25
+ g.desc 'Un-pins an item from a channel.'
26
+ g.long_desc %( Un-pins an item from a channel. )
28
27
  g.command 'remove' do |c|
29
28
  c.flag 'channel', desc: 'Channel where the item is pinned to.'
30
- c.flag 'file', desc: 'File to un-pin.'
31
- c.flag 'file_comment', desc: 'File comment to un-pin.'
32
29
  c.flag 'timestamp', desc: 'Timestamp of the message to un-pin.'
33
30
  c.action do |_global_options, options, _args|
34
31
  puts JSON.dump($client.pins_remove(options))
@@ -1,50 +1,52 @@
1
+ # frozen_string_literal: true
1
2
  # This file was auto-generated by lib/tasks/web.rake
2
3
 
3
4
  desc 'Reactions methods.'
4
5
  command 'reactions' do |g|
5
- g.desc 'This method adds a reaction (emoji) to an item (file, file comment, channel message, group message, or direct message).'
6
- g.long_desc %( This method adds a reaction (emoji) to an item (file, file comment, channel message, group message, or direct message). One of file, file_comment, or the combination of channel and timestamp must be specified. )
6
+ g.desc 'Adds a reaction to an item.'
7
+ g.long_desc %( Adds a reaction to an item. )
7
8
  g.command 'add' do |c|
8
- c.flag 'name', desc: 'Reaction (emoji) name.'
9
- c.flag 'file', desc: 'File to add reaction to.'
10
- c.flag 'file_comment', desc: 'File comment to add reaction to.'
11
9
  c.flag 'channel', desc: 'Channel where the message to add reaction to was posted.'
10
+ c.flag 'name', desc: 'Reaction (emoji) name.'
12
11
  c.flag 'timestamp', desc: 'Timestamp of the message to add reaction to.'
13
12
  c.action do |_global_options, options, _args|
14
13
  puts JSON.dump($client.reactions_add(options))
15
14
  end
16
15
  end
17
16
 
18
- g.desc 'This method returns a list of all reactions for a single item (file, file comment, channel message, group message, or direct message).'
19
- g.long_desc %( This method returns a list of all reactions for a single item (file, file comment, channel message, group message, or direct message). )
17
+ g.desc 'Gets reactions for an item.'
18
+ g.long_desc %( Gets reactions for an item. )
20
19
  g.command 'get' do |c|
20
+ c.flag 'channel', desc: 'Channel where the message to get reactions for was posted.'
21
21
  c.flag 'file', desc: 'File to get reactions for.'
22
22
  c.flag 'file_comment', desc: 'File comment to get reactions for.'
23
- c.flag 'channel', desc: 'Channel where the message to get reactions for was posted.'
24
- c.flag 'timestamp', desc: 'Timestamp of the message to get reactions for.'
25
23
  c.flag 'full', desc: 'If true always return the complete reaction list.'
24
+ c.flag 'timestamp', desc: 'Timestamp of the message to get reactions for.'
26
25
  c.action do |_global_options, options, _args|
27
26
  puts JSON.dump($client.reactions_get(options))
28
27
  end
29
28
  end
30
29
 
31
- g.desc 'This method returns a list of all items (file, file comment, channel message, group message, or direct message) reacted to by a user.'
32
- g.long_desc %( This method returns a list of all items (file, file comment, channel message, group message, or direct message) reacted to by a user. )
30
+ g.desc 'Lists reactions made by a user.'
31
+ g.long_desc %( Lists reactions made by a user. )
33
32
  g.command 'list' do |c|
34
- c.flag 'user', desc: 'Show reactions made by this user. Defaults to the authed user.'
33
+ c.flag 'cursor', desc: "Parameter for pagination. Set cursor equal to the next_cursor attribute returned by the previous request's response_metadata. This parameter is optional, but pagination is mandatory: the default value simply fetches the first 'page' of the collection. See pagination for more details."
35
34
  c.flag 'full', desc: 'If true always return the complete reaction list.'
35
+ 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."
36
+ c.flag 'team_id', desc: 'encoded team id to list reactions in, required if org token is used.'
37
+ c.flag 'user', desc: 'Show reactions made by this user. Defaults to the authed user.'
36
38
  c.action do |_global_options, options, _args|
37
39
  puts JSON.dump($client.reactions_list(options))
38
40
  end
39
41
  end
40
42
 
41
- g.desc 'This method removes a reaction (emoji) from an item (file, file comment, channel message, group message, or direct message).'
42
- g.long_desc %( This method removes a reaction (emoji) from an item (file, file comment, channel message, group message, or direct message). One of file, file_comment, or the combination of channel and timestamp must be specified. )
43
+ g.desc 'Removes a reaction from an item.'
44
+ g.long_desc %( Removes a reaction from an item. )
43
45
  g.command 'remove' do |c|
44
46
  c.flag 'name', desc: 'Reaction (emoji) name.'
47
+ c.flag 'channel', desc: 'Channel where the message to remove reaction from was posted.'
45
48
  c.flag 'file', desc: 'File to remove reaction from.'
46
49
  c.flag 'file_comment', desc: 'File comment to remove reaction from.'
47
- c.flag 'channel', desc: 'Channel where the message to remove reaction from was posted.'
48
50
  c.flag 'timestamp', desc: 'Timestamp of the message to remove reaction from.'
49
51
  c.action do |_global_options, options, _args|
50
52
  puts JSON.dump($client.reactions_remove(options))
@@ -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 'Reminders methods.'
4
5
  command 'reminders' do |g|
5
- g.desc 'This method creates a reminder.'
6
- g.long_desc %( This method creates a reminder. )
6
+ g.desc 'Creates a reminder.'
7
+ g.long_desc %( Creates a reminder. )
7
8
  g.command 'add' do |c|
8
9
  c.flag 'text', desc: 'The content of the reminder.'
9
10
  c.flag 'time', desc: 'When this reminder should happen: the Unix timestamp (up to five years from now), the number of seconds until the reminder (if within 24 hours), or a natural language description (Ex. "in 15 minutes," or "every Thursday").'
@@ -13,8 +14,8 @@ command 'reminders' do |g|
13
14
  end
14
15
  end
15
16
 
16
- g.desc 'This method completes a reminder.'
17
- g.long_desc %( This method completes a reminder. )
17
+ g.desc 'Marks a reminder as complete.'
18
+ g.long_desc %( Marks a reminder as complete. )
18
19
  g.command 'complete' do |c|
19
20
  c.flag 'reminder', desc: 'The ID of the reminder to be marked as complete.'
20
21
  c.action do |_global_options, options, _args|
@@ -22,8 +23,8 @@ command 'reminders' do |g|
22
23
  end
23
24
  end
24
25
 
25
- g.desc 'This method deletes a reminder.'
26
- g.long_desc %( This method deletes a reminder. )
26
+ g.desc 'Deletes a reminder.'
27
+ g.long_desc %( Deletes a reminder. )
27
28
  g.command 'delete' do |c|
28
29
  c.flag 'reminder', desc: 'The ID of the reminder.'
29
30
  c.action do |_global_options, options, _args|
@@ -31,8 +32,8 @@ command 'reminders' do |g|
31
32
  end
32
33
  end
33
34
 
34
- g.desc 'This method returns information about a reminder.'
35
- g.long_desc %( This method returns information about a reminder. )
35
+ g.desc 'Gets information about a reminder.'
36
+ g.long_desc %( Gets information about a reminder. )
36
37
  g.command 'info' do |c|
37
38
  c.flag 'reminder', desc: 'The ID of the reminder.'
38
39
  c.action do |_global_options, options, _args|
@@ -40,8 +41,8 @@ command 'reminders' do |g|
40
41
  end
41
42
  end
42
43
 
43
- g.desc 'This method lists all reminders created by or for a given user.'
44
- g.long_desc %( This method lists all reminders created by or for a given user. )
44
+ g.desc 'Lists all reminders created by or for a given user.'
45
+ g.long_desc %( Lists all reminders created by or for a given user. )
45
46
  g.command 'list' do |c|
46
47
  c.action do |_global_options, options, _args|
47
48
  puts JSON.dump($client.reminders_list(options))
data/bin/commands/rtm.rb CHANGED
@@ -1,13 +1,28 @@
1
+ # frozen_string_literal: true
1
2
  # This file was auto-generated by lib/tasks/web.rake
2
3
 
3
4
  desc 'Rtm methods.'
4
5
  command 'rtm' do |g|
5
- g.desc 'This method starts a Real Time Messaging API session. Refer to the'
6
- g.long_desc %( This method starts a Real Time Messaging API session. Refer to the RTM API documentation for full details on how to use the RTM API. )
6
+ g.desc 'Starts a Real Time Messaging session.'
7
+ g.long_desc %( Starts a Real Time Messaging session. )
8
+ g.command 'connect' do |c|
9
+ c.flag 'batch_presence_aware', desc: 'Batch presence deliveries via subscription. Enabling changes the shape of presence_change events. See batch presence.'
10
+ c.flag 'presence_sub', desc: 'Only deliver presence events when requested by subscription. See presence subscriptions.'
11
+ c.action do |_global_options, options, _args|
12
+ puts JSON.dump($client.rtm_connect(options))
13
+ end
14
+ end
15
+
16
+ g.desc 'Starts a Real Time Messaging session.'
17
+ g.long_desc %( Starts a Real Time Messaging session. )
7
18
  g.command 'start' do |c|
8
- c.flag 'simple_latest', desc: 'Return timestamp only for latest message object of each channel (improves performance).'
9
- c.flag 'no_unreads', desc: 'Skip unread counts for each channel (improves performance).'
19
+ c.flag 'batch_presence_aware', desc: 'Batch presence deliveries via subscription. Enabling changes the shape of presence_change events. See batch presence.'
20
+ c.flag 'include_locale', desc: 'Set this to true to receive the locale for users and channels. Defaults to false.'
10
21
  c.flag 'mpim_aware', desc: 'Returns MPIMs to the client in the API response.'
22
+ c.flag 'no_latest', desc: 'Exclude latest timestamps for channels, groups, mpims, and ims. Automatically sets no_unreads to 1.'
23
+ c.flag 'no_unreads', desc: 'Skip unread counts for each channel (improves performance).'
24
+ c.flag 'presence_sub', desc: 'Only deliver presence events when requested by subscription. See presence subscriptions.'
25
+ c.flag 'simple_latest', desc: 'Return timestamp only for latest message object of each channel (improves performance).'
11
26
  c.action do |_global_options, options, _args|
12
27
  puts JSON.dump($client.rtm_start(options))
13
28
  end
@@ -1,38 +1,42 @@
1
+ # frozen_string_literal: true
1
2
  # This file was auto-generated by lib/tasks/web.rake
2
3
 
3
4
  desc "Search your team's files and messages."
4
5
  command 'search' do |g|
5
- g.desc 'This method allows users and applications to search both messages and files in a single call.'
6
- g.long_desc %( This method allows users and applications to search both messages and files in a single call. )
6
+ g.desc 'Searches for messages and files matching a query.'
7
+ g.long_desc %( Searches for messages and files matching a query. )
7
8
  g.command 'all' do |c|
8
9
  c.flag 'query', desc: 'Search query. May contains booleans, etc.'
10
+ c.flag 'highlight', desc: 'Pass a value of true to enable query highlight markers (see below).'
9
11
  c.flag 'sort', desc: 'Return matches sorted by either score or timestamp.'
10
12
  c.flag 'sort_dir', desc: 'Change sort direction to ascending (asc) or descending (desc).'
11
- c.flag 'highlight', desc: 'Pass a value of 1 to enable query highlight markers (see below).'
13
+ c.flag 'team_id', desc: 'encoded team id to search in, required if org token is used.'
12
14
  c.action do |_global_options, options, _args|
13
15
  puts JSON.dump($client.search_all(options))
14
16
  end
15
17
  end
16
18
 
17
- g.desc 'This method returns files matching a search query.'
18
- g.long_desc %( This method returns files matching a search query. )
19
+ g.desc 'Searches for files matching a query.'
20
+ g.long_desc %( Searches for files matching a query. )
19
21
  g.command 'files' do |c|
20
- c.flag 'query', desc: 'Search query. May contain booleans, etc.'
22
+ c.flag 'query', desc: 'Search query.'
23
+ c.flag 'highlight', desc: 'Pass a value of true to enable query highlight markers (see below).'
21
24
  c.flag 'sort', desc: 'Return matches sorted by either score or timestamp.'
22
25
  c.flag 'sort_dir', desc: 'Change sort direction to ascending (asc) or descending (desc).'
23
- c.flag 'highlight', desc: 'Pass a value of 1 to enable query highlight markers (see below).'
26
+ c.flag 'team_id', desc: 'encoded team id to search in, required if org token is used.'
24
27
  c.action do |_global_options, options, _args|
25
28
  puts JSON.dump($client.search_files(options))
26
29
  end
27
30
  end
28
31
 
29
- g.desc 'This method returns messages matching a search query.'
30
- g.long_desc %( This method returns messages matching a search query. )
32
+ g.desc 'Searches for messages matching a query.'
33
+ g.long_desc %( Searches for messages matching a query. )
31
34
  g.command 'messages' do |c|
32
- c.flag 'query', desc: 'Search query. May contains booleans, etc.'
35
+ c.flag 'query', desc: 'Search query.'
36
+ c.flag 'highlight', desc: 'Pass a value of true to enable query highlight markers (see below).'
33
37
  c.flag 'sort', desc: 'Return matches sorted by either score or timestamp.'
34
38
  c.flag 'sort_dir', desc: 'Change sort direction to ascending (asc) or descending (desc).'
35
- c.flag 'highlight', desc: 'Pass a value of 1 to enable query highlight markers (see below).'
39
+ c.flag 'team_id', desc: 'encoded team id to search in, required if org token is used.'
36
40
  c.action do |_global_options, options, _args|
37
41
  puts JSON.dump($client.search_messages(options))
38
42
  end