slack-ruby-client 0.15.1 → 0.16.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (149) hide show
  1. checksums.yaml +4 -4
  2. data/.rubocop.yml +1 -1
  3. data/.rubocop_todo.yml +0 -14
  4. data/.travis.yml +1 -4
  5. data/CHANGELOG.md +8 -0
  6. data/CONTRIBUTING.md +3 -10
  7. data/README.md +9 -27
  8. data/UPGRADING.md +14 -2
  9. data/bin/commands.rb +7 -0
  10. data/bin/commands/admin_analytics.rb +15 -0
  11. data/bin/commands/admin_apps.rb +15 -2
  12. data/bin/commands/admin_barriers.rb +47 -0
  13. data/bin/commands/admin_conversations.rb +154 -2
  14. data/bin/commands/admin_conversations_ekm.rb +17 -0
  15. data/bin/commands/admin_conversations_restrictAccess.rb +4 -4
  16. data/bin/commands/admin_conversations_whitelist.rb +1 -1
  17. data/bin/commands/admin_emoji.rb +1 -1
  18. data/bin/commands/admin_usergroups.rb +2 -2
  19. data/bin/commands/admin_users.rb +2 -2
  20. data/bin/commands/admin_users_session.rb +22 -0
  21. data/bin/commands/api.rb +0 -1
  22. data/bin/commands/apps_connections.rb +13 -0
  23. data/bin/commands/apps_event_authorizations.rb +16 -0
  24. data/bin/commands/auth_teams.rb +16 -0
  25. data/bin/commands/bots.rb +1 -0
  26. data/bin/commands/channels.rb +6 -3
  27. data/bin/commands/chat.rb +4 -4
  28. data/bin/commands/chat_scheduledMessages.rb +1 -0
  29. data/bin/commands/conversations.rb +14 -2
  30. data/bin/commands/dnd.rb +1 -1
  31. data/bin/commands/files.rb +6 -5
  32. data/bin/commands/files_remote.rb +2 -2
  33. data/bin/commands/groups.rb +5 -3
  34. data/bin/commands/im.rb +1 -1
  35. data/bin/commands/migration.rb +1 -0
  36. data/bin/commands/mpim.rb +3 -3
  37. data/bin/commands/pins.rb +0 -2
  38. data/bin/commands/reactions.rb +1 -0
  39. data/bin/commands/search.rb +4 -1
  40. data/bin/commands/team.rb +3 -0
  41. data/bin/commands/usergroups.rb +6 -1
  42. data/bin/commands/usergroups_users.rb +2 -0
  43. data/bin/commands/users.rb +5 -3
  44. data/bin/commands/users_profile.rb +5 -5
  45. data/bin/commands/views.rb +1 -1
  46. data/bin/commands/workflows.rb +38 -0
  47. data/lib/slack-ruby-client.rb +2 -0
  48. data/lib/slack/events/request.rb +5 -1
  49. data/lib/slack/real_time/client.rb +0 -1
  50. data/lib/slack/real_time/concurrency.rb +0 -2
  51. data/lib/slack/real_time/config.rb +5 -4
  52. data/lib/slack/version.rb +1 -1
  53. data/lib/slack/web/api/endpoints.rb +14 -0
  54. data/lib/slack/web/api/endpoints/admin_analytics.rb +26 -0
  55. data/lib/slack/web/api/endpoints/admin_apps.rb +22 -2
  56. data/lib/slack/web/api/endpoints/admin_barriers.rb +82 -0
  57. data/lib/slack/web/api/endpoints/admin_conversations.rb +231 -1
  58. data/lib/slack/web/api/endpoints/admin_conversations_ekm.rb +35 -0
  59. data/lib/slack/web/api/endpoints/admin_conversations_restrictAccess.rb +3 -3
  60. data/lib/slack/web/api/endpoints/admin_conversations_whitelist.rb +3 -3
  61. data/lib/slack/web/api/endpoints/admin_emoji.rb +1 -1
  62. data/lib/slack/web/api/endpoints/admin_usergroups.rb +1 -1
  63. data/lib/slack/web/api/endpoints/admin_users.rb +4 -6
  64. data/lib/slack/web/api/endpoints/admin_users_session.rb +38 -0
  65. data/lib/slack/web/api/endpoints/api.rb +0 -2
  66. data/lib/slack/web/api/endpoints/apps_connections.rb +21 -0
  67. data/lib/slack/web/api/endpoints/apps_event_authorizations.rb +34 -0
  68. data/lib/slack/web/api/endpoints/auth_teams.rb +33 -0
  69. data/lib/slack/web/api/endpoints/bots.rb +2 -0
  70. data/lib/slack/web/api/endpoints/channels.rb +9 -3
  71. data/lib/slack/web/api/endpoints/chat.rb +3 -3
  72. data/lib/slack/web/api/endpoints/chat_scheduledMessages.rb +2 -0
  73. data/lib/slack/web/api/endpoints/conversations.rb +21 -1
  74. data/lib/slack/web/api/endpoints/files.rb +4 -2
  75. data/lib/slack/web/api/endpoints/files_remote.rb +2 -2
  76. data/lib/slack/web/api/endpoints/groups.rb +7 -3
  77. data/lib/slack/web/api/endpoints/im.rb +1 -1
  78. data/lib/slack/web/api/endpoints/migration.rb +2 -0
  79. data/lib/slack/web/api/endpoints/mpim.rb +3 -3
  80. data/lib/slack/web/api/endpoints/pins.rb +0 -5
  81. data/lib/slack/web/api/endpoints/reactions.rb +2 -0
  82. data/lib/slack/web/api/endpoints/search.rb +6 -0
  83. data/lib/slack/web/api/endpoints/team.rb +6 -0
  84. data/lib/slack/web/api/endpoints/usergroups.rb +10 -0
  85. data/lib/slack/web/api/endpoints/usergroups_users.rb +4 -0
  86. data/lib/slack/web/api/endpoints/users.rb +7 -5
  87. data/lib/slack/web/api/endpoints/users_profile.rb +3 -3
  88. data/lib/slack/web/api/endpoints/views.rb +1 -1
  89. data/lib/slack/web/api/endpoints/workflows.rb +61 -0
  90. data/lib/slack/web/api/errors.rb +194 -0
  91. data/lib/slack/web/api/errors/internal_error.rb +14 -0
  92. data/lib/slack/web/api/templates/endpoints.erb +1 -0
  93. data/lib/slack/web/api/templates/method_spec.erb +1 -1
  94. data/lib/slack/web/faraday/connection.rb +1 -1
  95. data/lib/slack/web/faraday/response/raise_error.rb +16 -1
  96. data/lib/slack/web/faraday/response/wrap_error.rb +18 -0
  97. data/lib/tasks/web.rake +7 -3
  98. data/spec/slack/events/request_spec.rb +7 -3
  99. data/spec/slack/real_time/client_spec.rb +1 -1
  100. data/spec/slack/web/api/endpoints/admin_analytics_spec.rb +13 -0
  101. data/spec/slack/web/api/endpoints/admin_apps_spec.rb +5 -0
  102. data/spec/slack/web/api/endpoints/admin_barriers_spec.rb +38 -0
  103. data/spec/slack/web/api/endpoints/admin_conversations_ekm_spec.rb +8 -0
  104. data/spec/slack/web/api/endpoints/admin_conversations_restrictAccess_spec.rb +5 -5
  105. data/spec/slack/web/api/endpoints/admin_conversations_spec.rb +85 -0
  106. data/spec/slack/web/api/endpoints/admin_conversations_whitelist_spec.rb +5 -5
  107. data/spec/slack/web/api/endpoints/admin_emoji_spec.rb +6 -6
  108. data/spec/slack/web/api/endpoints/admin_teams_settings_spec.rb +10 -10
  109. data/spec/slack/web/api/endpoints/admin_teams_spec.rb +2 -2
  110. data/spec/slack/web/api/endpoints/admin_usergroups_spec.rb +6 -6
  111. data/spec/slack/web/api/endpoints/admin_users_session_spec.rb +8 -0
  112. data/spec/slack/web/api/endpoints/admin_users_spec.rb +15 -23
  113. data/spec/slack/web/api/endpoints/apps_connections_spec.rb +8 -0
  114. data/spec/slack/web/api/endpoints/apps_event_authorizations_spec.rb +13 -0
  115. data/spec/slack/web/api/endpoints/apps_permissions_spec.rb +2 -2
  116. data/spec/slack/web/api/endpoints/apps_permissions_users_spec.rb +3 -3
  117. data/spec/slack/web/api/endpoints/apps_spec.rb +2 -2
  118. data/spec/slack/web/api/endpoints/auth_teams_spec.rb +8 -0
  119. data/spec/slack/web/api/endpoints/calls_participants_spec.rb +4 -4
  120. data/spec/slack/web/api/endpoints/calls_spec.rb +2 -2
  121. data/spec/slack/web/api/endpoints/conversations_spec.rb +20 -12
  122. data/spec/slack/web/api/endpoints/files_comments_spec.rb +2 -2
  123. data/spec/slack/web/api/endpoints/files_remote_spec.rb +3 -3
  124. data/spec/slack/web/api/endpoints/files_spec.rb +4 -4
  125. data/spec/slack/web/api/endpoints/im_spec.rb +4 -4
  126. data/spec/slack/web/api/endpoints/mpim_spec.rb +4 -4
  127. data/spec/slack/web/api/endpoints/oauth_spec.rb +3 -3
  128. data/spec/slack/web/api/endpoints/pins_spec.rb +1 -4
  129. data/spec/slack/web/api/endpoints/reactions_spec.rb +3 -3
  130. data/spec/slack/web/api/endpoints/reminders_spec.rb +2 -2
  131. data/spec/slack/web/api/endpoints/usergroups_users_spec.rb +2 -2
  132. data/spec/slack/web/api/endpoints/workflows_spec.rb +26 -0
  133. data/spec/slack/web/client_spec.rb +56 -0
  134. data/spec/slack/web/faraday/response/raise_error_spec.rb +7 -6
  135. metadata +32 -19
  136. data/examples/hi_real_time/Gemfile +0 -6
  137. data/examples/hi_real_time/hi.gif +0 -0
  138. data/examples/hi_real_time/hi.rb +0 -41
  139. data/examples/hi_real_time_async_celluloid/Gemfile +0 -7
  140. data/examples/hi_real_time_async_celluloid/Procfile +0 -2
  141. data/examples/hi_real_time_async_celluloid/hi.rb +0 -39
  142. data/examples/hi_real_time_async_eventmachine/Gemfile +0 -7
  143. data/examples/hi_real_time_async_eventmachine/Procfile +0 -2
  144. data/examples/hi_real_time_async_eventmachine/hi.rb +0 -39
  145. data/lib/slack/real_time/concurrency/celluloid.rb +0 -142
  146. data/lib/slack/real_time/concurrency/eventmachine.rb +0 -85
  147. data/spec/slack/real_time/concurrency/celluloid_spec.rb +0 -116
  148. data/spec/slack/real_time/concurrency/eventmachine_spec.rb +0 -57
  149. data/spec/slack/web/api/errors/service_unavailable_spec.rb +0 -17
@@ -1,7 +0,0 @@
1
- # frozen_string_literal: true
2
- source 'http://rubygems.org'
3
-
4
- gem 'slack-ruby-client', path: '../..'
5
-
6
- gem 'celluloid-io', require: ['celluloid/current', 'celluloid/io']
7
- gem 'foreman'
@@ -1,2 +0,0 @@
1
- console: bundle exec ruby hi.rb
2
-
@@ -1,39 +0,0 @@
1
- # frozen_string_literal: true
2
- require 'slack-ruby-client'
3
-
4
- raise 'Missing ENV[SLACK_API_TOKENS]!' unless ENV.key?('SLACK_API_TOKENS')
5
-
6
- $stdout.sync = true
7
- logger = Logger.new($stdout)
8
- logger.level = Logger::DEBUG
9
- threads = []
10
-
11
- ENV['SLACK_API_TOKENS'].split.each do |token|
12
- logger.info "Starting #{token[0..12]} ..."
13
-
14
- client = Slack::RealTime::Client.new(token: token)
15
-
16
- client.on :hello do
17
- logger.info(
18
- "Successfully connected, welcome '#{client.self.name}' to " \
19
- "the '#{client.team.name}' team at https://#{client.team.domain}.slack.com."
20
- )
21
- end
22
-
23
- client.on :message do |data|
24
- logger.info data
25
-
26
- client.typing channel: data.channel
27
-
28
- case data.text
29
- when 'bot hi'
30
- client.message channel: data.channel, text: "Hi <@#{data.user}>!"
31
- when /^bot/
32
- client.message channel: data.channel, text: "Sorry <@#{data.user}>, what?"
33
- end
34
- end
35
-
36
- threads << client.start_async
37
- end
38
-
39
- threads.each(&:join)
@@ -1,7 +0,0 @@
1
- # frozen_string_literal: true
2
- source 'http://rubygems.org'
3
-
4
- gem 'slack-ruby-client', path: '../..'
5
-
6
- gem 'faye-websocket'
7
- gem 'foreman'
@@ -1,2 +0,0 @@
1
- console: bundle exec ruby hi.rb
2
-
@@ -1,39 +0,0 @@
1
- # frozen_string_literal: true
2
- require 'slack-ruby-client'
3
-
4
- raise 'Missing ENV[SLACK_API_TOKENS]!' unless ENV.key?('SLACK_API_TOKENS')
5
-
6
- $stdout.sync = true
7
- logger = Logger.new($stdout)
8
- logger.level = Logger::DEBUG
9
- threads = []
10
-
11
- ENV['SLACK_API_TOKENS'].split.each do |token|
12
- logger.info "Starting #{token[0..12]} ..."
13
-
14
- client = Slack::RealTime::Client.new(token: token)
15
-
16
- client.on :hello do
17
- logger.info(
18
- "Successfully connected, welcome '#{client.self.name}' to " \
19
- "the '#{client.team.name}' team at https://#{client.team.domain}.slack.com."
20
- )
21
- end
22
-
23
- client.on :message do |data|
24
- logger.info data
25
-
26
- client.typing channel: data.channel
27
-
28
- case data.text
29
- when 'bot hi'
30
- client.message channel: data.channel, text: "Hi <@#{data.user}>!"
31
- when /^bot/
32
- client.message channel: data.channel, text: "Sorry <@#{data.user}>, what?"
33
- end
34
- end
35
-
36
- threads << client.start_async
37
- end
38
-
39
- threads.each(&:join)
@@ -1,142 +0,0 @@
1
- # frozen_string_literal: true
2
- require 'websocket/driver'
3
- require 'socket'
4
- require 'forwardable'
5
- require 'celluloid/current'
6
- require 'celluloid/io'
7
-
8
- module Slack
9
- module RealTime
10
- module Concurrency
11
- module Celluloid
12
- class Socket < Slack::RealTime::Socket
13
- include ::Celluloid::IO
14
- include ::Celluloid::Internals::Logger
15
-
16
- BLOCK_SIZE = 4096
17
-
18
- extend ::Forwardable
19
- def_delegators :driver, :text, :binary
20
-
21
- attr_reader :socket
22
-
23
- def initialize(*args)
24
- super
25
- end
26
-
27
- def connect!
28
- super
29
- run_loop
30
- end
31
-
32
- def run_loop
33
- @closing = false
34
- @socket = build_socket
35
- @connected = @socket.connect
36
- driver.start
37
- loop { read } if socket
38
- rescue EOFError, Errno::ECONNRESET, Errno::EPIPE => e
39
- logger.debug("#{self.class}##{__method__}") { e }
40
- unless @closing
41
- driver.emit(
42
- :close,
43
- WebSocket::Driver::CloseEvent.new(1001, 'server closed connection')
44
- )
45
- end
46
- end
47
-
48
- def disconnect!
49
- super
50
- @ping_timer&.cancel
51
- end
52
-
53
- def close
54
- @closing = true
55
- super
56
- end
57
-
58
- def read
59
- buffer = socket.readpartial(BLOCK_SIZE)
60
- raise EOFError unless buffer && !buffer.empty?
61
-
62
- async.handle_read(buffer)
63
- end
64
-
65
- def handle_read(buffer)
66
- logger.debug("#{self.class}##{__method__}") { buffer }
67
- driver&.parse buffer
68
- end
69
-
70
- def write(data)
71
- logger.debug("#{self.class}##{__method__}") { data }
72
- socket.write(data)
73
- end
74
-
75
- def start_async(client)
76
- @client = client
77
- Actor.new(future.run_ping_loop)
78
- Actor.new(future.run_client_loop)
79
- end
80
-
81
- def run_client_loop
82
- @client.run_loop
83
- rescue StandardError => e
84
- logger.debug("#{self.class}##{__method__}") { e }
85
- raise e
86
- end
87
-
88
- def run_ping_loop
89
- return unless @client.run_ping?
90
-
91
- @ping_timer = every @client.websocket_ping_timer do
92
- @client.run_ping!
93
- end
94
- end
95
-
96
- def restart_async(client, new_url)
97
- @last_message_at = current_time
98
- @url = new_url
99
- @client = client
100
- Actor.new(future.run_client_loop)
101
- end
102
-
103
- def connected?
104
- !@connected.nil? && !@driver.nil?
105
- end
106
-
107
- protected
108
-
109
- class Actor
110
- attr_reader :future
111
-
112
- def initialize(future)
113
- @future = future
114
- end
115
-
116
- def join
117
- @future.value
118
- end
119
- end
120
-
121
- def build_socket
122
- socket = ::Celluloid::IO::TCPSocket.new(addr, port)
123
- socket = ::Celluloid::IO::SSLSocket.new(socket, build_ssl_context) if secure?
124
- socket
125
- end
126
-
127
- def build_ssl_context
128
- OpenSSL::SSL::SSLContext.new(:TLSv1_2_client)
129
- end
130
-
131
- def build_driver
132
- ::WebSocket::Driver.client(self)
133
- end
134
-
135
- def connect
136
- @driver = build_driver
137
- end
138
- end
139
- end
140
- end
141
- end
142
- end
@@ -1,85 +0,0 @@
1
- # frozen_string_literal: true
2
- require 'faye/websocket'
3
- require 'eventmachine'
4
-
5
- module Slack
6
- module RealTime
7
- module Concurrency
8
- module Eventmachine
9
- class Client < Faye::WebSocket::Client
10
- def initialize(url, protocols = nil, options = {})
11
- options = options.dup
12
- @logger = options.delete(:logger) || Slack::RealTime::Config.logger || Slack::Config.logger
13
- super url, protocols, options
14
- end
15
-
16
- def parse(data)
17
- logger.debug("#{self.class}##{__method__}") { data }
18
- super data
19
- end
20
-
21
- def write(data)
22
- logger.debug("#{self.class}##{__method__}") { data }
23
- super data
24
- end
25
-
26
- protected
27
-
28
- attr_reader :logger
29
- end
30
-
31
- class Socket < Slack::RealTime::Socket
32
- def start_async(client)
33
- @thread = ensure_reactor_running
34
-
35
- if client.run_ping?
36
- EventMachine.add_periodic_timer client.websocket_ping_timer do
37
- client.run_ping!
38
- end
39
- end
40
-
41
- client.run_loop
42
-
43
- @thread
44
- end
45
-
46
- def restart_async(client, new_url)
47
- @url = new_url
48
- @last_message_at = current_time
49
- @thread = ensure_reactor_running
50
-
51
- client.run_loop
52
-
53
- @thread
54
- end
55
-
56
- def disconnect!
57
- super
58
- EventMachine.stop_event_loop if EventMachine.reactor_running?
59
- @thread = nil
60
- end
61
-
62
- def send_data(message)
63
- logger.debug("#{self.class}##{__method__}") { message }
64
- driver.send(message)
65
- end
66
-
67
- protected
68
-
69
- # @return [Thread]
70
- def ensure_reactor_running
71
- return if EventMachine.reactor_running?
72
-
73
- reactor = Thread.new { EventMachine.run }
74
- Thread.pass until EventMachine.reactor_running?
75
- reactor
76
- end
77
-
78
- def connect
79
- @driver = Client.new(url, nil, options.merge(logger: logger))
80
- end
81
- end
82
- end
83
- end
84
- end
85
- end
@@ -1,116 +0,0 @@
1
- # frozen_string_literal: true
2
- require 'spec_helper'
3
- require_relative './it_behaves_like_a_realtime_socket'
4
-
5
- begin
6
- RSpec.describe Slack::RealTime::Concurrency::Celluloid::Socket do
7
- subject { socket }
8
-
9
- let(:driver) { WebSocket::Driver::Client }
10
- let(:logger) { ::Logger.new(STDOUT) }
11
- let(:ws) { double(driver) }
12
- let(:url) { 'wss://echo.websocket.org/websocket/xyz' }
13
-
14
- it_behaves_like 'a realtime socket'
15
-
16
- ['', nil].each do |data|
17
- context "finishing run_loop with #{data ? 'empty' : 'nil'} read" do
18
- let(:ssl_socket) do
19
- Class.new(Celluloid::IO::SSLSocket) do
20
- def initialize(data)
21
- @data = data
22
- end
23
-
24
- def connect; end
25
-
26
- def readpartial(_size)
27
- @data
28
- end
29
- end
30
- end
31
-
32
- let(:test_socket) do
33
- Class.new(described_class) do
34
- def build_socket
35
- options[:ssl_socket].new(options[:data])
36
- end
37
- end
38
- end
39
-
40
- let(:socket) do
41
- test_socket.new(url, logger: logger, data: data, ssl_socket: ssl_socket)
42
- end
43
-
44
- context 'with a driver' do
45
- before do
46
- socket.instance_variable_set('@driver', ws)
47
- end
48
-
49
- context 'consumes data' do
50
- it 'runs' do
51
- expect(ws).to receive(:emit)
52
- expect(ws).to receive(:start)
53
- expect(logger).to receive(:debug).with("#{test_socket}#run_loop")
54
- socket.run_loop
55
- end
56
- end
57
- end
58
- end
59
- end
60
-
61
- [EOFError, Errno::ECONNRESET, Errno::EPIPE].each do |err|
62
- context "finishing run_loop with #{err}" do
63
- let(:test_socket) do
64
- Class.new(described_class) do
65
- def read
66
- raise options[:err]
67
- end
68
- end
69
- end
70
-
71
- let(:socket) do
72
- test_socket.new(url, logger: logger, err: err)
73
- end
74
-
75
- context 'with a driver' do
76
- before do
77
- socket.instance_variable_set('@driver', ws)
78
- end
79
-
80
- describe '#disconnect!' do
81
- it 'closes and nils the websocket' do
82
- expect(ws).to receive(:emit)
83
- expect(ws).to receive(:close)
84
- socket.disconnect!
85
- end
86
- end
87
-
88
- context 'consumes data' do
89
- let(:tcp_socket) { double(::Celluloid::IO::SSLSocket, connect: true) }
90
-
91
- before do
92
- allow_any_instance_of(described_class).to(
93
- receive(:build_socket).and_return(tcp_socket)
94
- )
95
- end
96
-
97
- it 'runs' do
98
- expect(ws).to receive(:emit)
99
- expect(ws).to receive(:start)
100
- expect(logger).to receive(:debug).with("#{test_socket}#run_loop")
101
- socket.run_loop
102
- end
103
- end
104
- end
105
- end
106
- end
107
-
108
- describe '#connect!' do
109
- pending 'connects'
110
- pending 'pings every 30s'
111
- end
112
-
113
- pending 'send_data'
114
- end
115
- rescue LoadError
116
- end