slackrb 0.17.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (64) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +5 -0
  3. data/.rspec +3 -0
  4. data/.rubocop.yml +29 -0
  5. data/.rubocop_todo.yml +49 -0
  6. data/CHANGELOG.md +219 -0
  7. data/Dangerfile +5 -0
  8. data/Gemfile +20 -0
  9. data/LICENSE.md +22 -0
  10. data/README.md +766 -0
  11. data/Rakefile +21 -0
  12. data/lib/config/application.rb +14 -0
  13. data/lib/config/boot.rb +8 -0
  14. data/lib/config/environment.rb +5 -0
  15. data/lib/slack-ruby-bot/about.rb +9 -0
  16. data/lib/slack-ruby-bot/app.rb +56 -0
  17. data/lib/slack-ruby-bot/bot.rb +19 -0
  18. data/lib/slack-ruby-bot/client.rb +65 -0
  19. data/lib/slack-ruby-bot/commands/about.rb +14 -0
  20. data/lib/slack-ruby-bot/commands/base.rb +158 -0
  21. data/lib/slack-ruby-bot/commands/help.rb +43 -0
  22. data/lib/slack-ruby-bot/commands/hi.rb +16 -0
  23. data/lib/slack-ruby-bot/commands/support/attrs.rb +36 -0
  24. data/lib/slack-ruby-bot/commands/support/help.rb +84 -0
  25. data/lib/slack-ruby-bot/commands/support/match.rb +23 -0
  26. data/lib/slack-ruby-bot/commands/unknown.rb +13 -0
  27. data/lib/slack-ruby-bot/commands.rb +7 -0
  28. data/lib/slack-ruby-bot/config.rb +38 -0
  29. data/lib/slack-ruby-bot/hooks/hello.rb +35 -0
  30. data/lib/slack-ruby-bot/hooks/hook_support.rb +45 -0
  31. data/lib/slack-ruby-bot/hooks/message.rb +56 -0
  32. data/lib/slack-ruby-bot/hooks/set.rb +45 -0
  33. data/lib/slack-ruby-bot/hooks.rb +6 -0
  34. data/lib/slack-ruby-bot/mvc/controller/base.rb +172 -0
  35. data/lib/slack-ruby-bot/mvc/model/base.rb +27 -0
  36. data/lib/slack-ruby-bot/mvc/mvc.rb +7 -0
  37. data/lib/slack-ruby-bot/mvc/view/base.rb +30 -0
  38. data/lib/slack-ruby-bot/mvc.rb +3 -0
  39. data/lib/slack-ruby-bot/rspec/support/bots_for_tests.rb +35 -0
  40. data/lib/slack-ruby-bot/rspec/support/slack-ruby-bot/it_behaves_like_a_slack_bot.rb +16 -0
  41. data/lib/slack-ruby-bot/rspec/support/slack-ruby-bot/not_respond.rb +25 -0
  42. data/lib/slack-ruby-bot/rspec/support/slack-ruby-bot/respond_with_error.rb +36 -0
  43. data/lib/slack-ruby-bot/rspec/support/slack-ruby-bot/respond_with_slack_message.rb +34 -0
  44. data/lib/slack-ruby-bot/rspec/support/slack-ruby-bot/respond_with_slack_messages.rb +45 -0
  45. data/lib/slack-ruby-bot/rspec/support/slack-ruby-bot/start_typing.rb +32 -0
  46. data/lib/slack-ruby-bot/rspec/support/slack_api_key.rb +10 -0
  47. data/lib/slack-ruby-bot/rspec/support/slack_ruby_bot_configure.rb +15 -0
  48. data/lib/slack-ruby-bot/rspec/support/spec_helpers.rb +14 -0
  49. data/lib/slack-ruby-bot/rspec.rb +14 -0
  50. data/lib/slack-ruby-bot/server.rb +88 -0
  51. data/lib/slack-ruby-bot/support/loggable.rb +25 -0
  52. data/lib/slack-ruby-bot/version.rb +5 -0
  53. data/lib/slack-ruby-bot.rb +29 -0
  54. data/lib/slack_ruby_bot.rb +3 -0
  55. data/screenshots/aliases.gif +0 -0
  56. data/screenshots/create-classic-app.png +0 -0
  57. data/screenshots/demo.gif +0 -0
  58. data/screenshots/dms.gif +0 -0
  59. data/screenshots/help.png +0 -0
  60. data/screenshots/market.gif +0 -0
  61. data/screenshots/weather.gif +0 -0
  62. data/slack-ruby-bot.gemspec +32 -0
  63. data/slack.png +0 -0
  64. metadata +244 -0
@@ -0,0 +1,88 @@
1
+ # frozen_string_literal: true
2
+
3
+ module SlackRubyBot
4
+ class Server
5
+ include Loggable
6
+
7
+ attr_accessor :token, :aliases
8
+
9
+ include SlackRubyBot::Hooks::HookSupport
10
+
11
+ TRAPPED_SIGNALS = %w[INT TERM].freeze
12
+
13
+ def initialize(options = {})
14
+ @token = options[:token]
15
+ @aliases = options[:aliases]
16
+
17
+ # Hook Handling
18
+ flush_hook_blocks
19
+
20
+ add_hook_handlers options[:hook_handlers] || {
21
+ hello: SlackRubyBot::Hooks::Hello.new(logger),
22
+ message: SlackRubyBot::Hooks::Message.new
23
+ }
24
+ end
25
+
26
+ def run
27
+ loop do
28
+ handle_exceptions do
29
+ handle_signals
30
+ start!
31
+ end
32
+ end
33
+ end
34
+
35
+ def start!
36
+ client.start!
37
+ end
38
+
39
+ def start_async
40
+ client.start_async
41
+ end
42
+
43
+ def stop!
44
+ client.stop! if @client
45
+ end
46
+
47
+ private
48
+
49
+ def handle_exceptions
50
+ yield
51
+ rescue Slack::Web::Api::Error => e
52
+ logger.error e
53
+ case e.message
54
+ when 'migration_in_progress'
55
+ sleep 1 # ignore, try again
56
+ else
57
+ raise e
58
+ end
59
+ rescue Faraday::TimeoutError, Faraday::ConnectionFailed, Faraday::SSLError => e
60
+ logger.error e
61
+ sleep 1 # ignore, try again
62
+ rescue StandardError => e
63
+ logger.error e.message
64
+ logger.error e.backtrace.join("\n")
65
+ raise e
66
+ ensure
67
+ @client = nil
68
+ end
69
+
70
+ def handle_signals
71
+ TRAPPED_SIGNALS.each do |signal|
72
+ Signal.trap(signal) do
73
+ stop!
74
+ exit
75
+ end
76
+ end
77
+ end
78
+
79
+ def client
80
+ @client ||= begin
81
+ client = SlackRubyBot::Client.new(aliases: aliases, token: token)
82
+ _hooks.client = client
83
+
84
+ client
85
+ end
86
+ end
87
+ end
88
+ end
@@ -0,0 +1,25 @@
1
+ # frozen_string_literal: true
2
+
3
+ module SlackRubyBot
4
+ module Loggable
5
+ def self.included(base)
6
+ base.send :include, InstanceMethods
7
+ base.extend(ClassMethods)
8
+ end
9
+
10
+ module ClassMethods
11
+ def logger
12
+ @logger ||= SlackRubyBot::Config.logger || begin
13
+ $stdout.sync = true
14
+ Logger.new($stdout)
15
+ end
16
+ end
17
+ end
18
+
19
+ module InstanceMethods
20
+ def logger
21
+ self.class.logger
22
+ end
23
+ end
24
+ end
25
+ end
@@ -0,0 +1,5 @@
1
+ # frozen_string_literal: true
2
+
3
+ module SlackRubyBot
4
+ VERSION = '0.17.0'
5
+ end
@@ -0,0 +1,29 @@
1
+ # frozen_string_literal: true
2
+
3
+ require File.expand_path('config/environment', __dir__)
4
+
5
+ require 'slack-ruby-bot/version'
6
+ require 'slack-ruby-bot/support/loggable'
7
+ require 'slack-ruby-bot/about'
8
+ require 'slack-ruby-bot/config'
9
+ require 'slack-ruby-bot/hooks'
10
+
11
+ module SlackRubyBot
12
+ class << self
13
+ def configure
14
+ block_given? ? yield(Config) : Config
15
+ end
16
+
17
+ def config
18
+ Config
19
+ end
20
+ end
21
+ end
22
+
23
+ require 'slack-ruby-client'
24
+ require 'slack-ruby-bot/commands'
25
+ require 'slack-ruby-bot/client'
26
+ require 'slack-ruby-bot/server'
27
+ require 'slack-ruby-bot/app'
28
+ require 'slack-ruby-bot/bot'
29
+ require 'slack-ruby-bot/mvc'
@@ -0,0 +1,3 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'slack-ruby-bot'
Binary file
Binary file
Binary file
Binary file
Binary file
Binary file
Binary file
@@ -0,0 +1,32 @@
1
+ # frozen_string_literal: true
2
+
3
+ $LOAD_PATH.push File.expand_path('lib', __dir__)
4
+ require 'slack-ruby-bot/version'
5
+
6
+ Gem::Specification.new do |s|
7
+ s.name = 'slackrb'
8
+ s.version = SlackRubyBot::VERSION
9
+ s.authors = ['Daniel Doubrovkine']
10
+ s.email = 'dblock@dblock.org'
11
+
12
+ s.platform = Gem::Platform::RUBY
13
+ s.required_rubygems_version = '>= 1.3.6'
14
+ s.files = `git ls-files`.split("\n")
15
+ s.test_files = `git ls-files -- spec/*`.split("\n")
16
+ s.require_paths = ['lib']
17
+ s.homepage = 'https://github.com/slack-ruby/slack-ruby-bot'
18
+ s.licenses = ['MIT']
19
+ s.summary = 'The easiest way to write a Slack bot in Ruby.'
20
+ s.required_ruby_version = '>= 2.3'
21
+
22
+ s.add_dependency 'botwayrb'
23
+ s.add_dependency 'activesupport'
24
+ s.add_dependency 'hashie'
25
+ s.add_dependency 'slack-ruby-client', '>= 0.14.0'
26
+ s.add_development_dependency 'rack-test'
27
+ s.add_development_dependency 'rake'
28
+ s.add_development_dependency 'rspec'
29
+ s.add_development_dependency 'rubocop', '0.80.1'
30
+ s.add_development_dependency 'vcr'
31
+ s.add_development_dependency 'webmock'
32
+ end
data/slack.png ADDED
Binary file
metadata ADDED
@@ -0,0 +1,244 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: slackrb
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.17.0
5
+ platform: ruby
6
+ authors:
7
+ - Daniel Doubrovkine
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2022-05-20 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: botwayrb
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: '0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: activesupport
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: '0'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ">="
39
+ - !ruby/object:Gem::Version
40
+ version: '0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: hashie
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - ">="
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
48
+ type: :runtime
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - ">="
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: slack-ruby-client
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: 0.14.0
62
+ type: :runtime
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: 0.14.0
69
+ - !ruby/object:Gem::Dependency
70
+ name: rack-test
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: '0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - ">="
81
+ - !ruby/object:Gem::Version
82
+ version: '0'
83
+ - !ruby/object:Gem::Dependency
84
+ name: rake
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - ">="
88
+ - !ruby/object:Gem::Version
89
+ version: '0'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - ">="
95
+ - !ruby/object:Gem::Version
96
+ version: '0'
97
+ - !ruby/object:Gem::Dependency
98
+ name: rspec
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - ">="
102
+ - !ruby/object:Gem::Version
103
+ version: '0'
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - ">="
109
+ - !ruby/object:Gem::Version
110
+ version: '0'
111
+ - !ruby/object:Gem::Dependency
112
+ name: rubocop
113
+ requirement: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - '='
116
+ - !ruby/object:Gem::Version
117
+ version: 0.80.1
118
+ type: :development
119
+ prerelease: false
120
+ version_requirements: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - '='
123
+ - !ruby/object:Gem::Version
124
+ version: 0.80.1
125
+ - !ruby/object:Gem::Dependency
126
+ name: vcr
127
+ requirement: !ruby/object:Gem::Requirement
128
+ requirements:
129
+ - - ">="
130
+ - !ruby/object:Gem::Version
131
+ version: '0'
132
+ type: :development
133
+ prerelease: false
134
+ version_requirements: !ruby/object:Gem::Requirement
135
+ requirements:
136
+ - - ">="
137
+ - !ruby/object:Gem::Version
138
+ version: '0'
139
+ - !ruby/object:Gem::Dependency
140
+ name: webmock
141
+ requirement: !ruby/object:Gem::Requirement
142
+ requirements:
143
+ - - ">="
144
+ - !ruby/object:Gem::Version
145
+ version: '0'
146
+ type: :development
147
+ prerelease: false
148
+ version_requirements: !ruby/object:Gem::Requirement
149
+ requirements:
150
+ - - ">="
151
+ - !ruby/object:Gem::Version
152
+ version: '0'
153
+ description:
154
+ email: dblock@dblock.org
155
+ executables: []
156
+ extensions: []
157
+ extra_rdoc_files: []
158
+ files:
159
+ - ".gitignore"
160
+ - ".rspec"
161
+ - ".rubocop.yml"
162
+ - ".rubocop_todo.yml"
163
+ - CHANGELOG.md
164
+ - Dangerfile
165
+ - Gemfile
166
+ - LICENSE.md
167
+ - README.md
168
+ - Rakefile
169
+ - lib/config/application.rb
170
+ - lib/config/boot.rb
171
+ - lib/config/environment.rb
172
+ - lib/slack-ruby-bot.rb
173
+ - lib/slack-ruby-bot/about.rb
174
+ - lib/slack-ruby-bot/app.rb
175
+ - lib/slack-ruby-bot/bot.rb
176
+ - lib/slack-ruby-bot/client.rb
177
+ - lib/slack-ruby-bot/commands.rb
178
+ - lib/slack-ruby-bot/commands/about.rb
179
+ - lib/slack-ruby-bot/commands/base.rb
180
+ - lib/slack-ruby-bot/commands/help.rb
181
+ - lib/slack-ruby-bot/commands/hi.rb
182
+ - lib/slack-ruby-bot/commands/support/attrs.rb
183
+ - lib/slack-ruby-bot/commands/support/help.rb
184
+ - lib/slack-ruby-bot/commands/support/match.rb
185
+ - lib/slack-ruby-bot/commands/unknown.rb
186
+ - lib/slack-ruby-bot/config.rb
187
+ - lib/slack-ruby-bot/hooks.rb
188
+ - lib/slack-ruby-bot/hooks/hello.rb
189
+ - lib/slack-ruby-bot/hooks/hook_support.rb
190
+ - lib/slack-ruby-bot/hooks/message.rb
191
+ - lib/slack-ruby-bot/hooks/set.rb
192
+ - lib/slack-ruby-bot/mvc.rb
193
+ - lib/slack-ruby-bot/mvc/controller/base.rb
194
+ - lib/slack-ruby-bot/mvc/model/base.rb
195
+ - lib/slack-ruby-bot/mvc/mvc.rb
196
+ - lib/slack-ruby-bot/mvc/view/base.rb
197
+ - lib/slack-ruby-bot/rspec.rb
198
+ - lib/slack-ruby-bot/rspec/support/bots_for_tests.rb
199
+ - lib/slack-ruby-bot/rspec/support/slack-ruby-bot/it_behaves_like_a_slack_bot.rb
200
+ - lib/slack-ruby-bot/rspec/support/slack-ruby-bot/not_respond.rb
201
+ - lib/slack-ruby-bot/rspec/support/slack-ruby-bot/respond_with_error.rb
202
+ - lib/slack-ruby-bot/rspec/support/slack-ruby-bot/respond_with_slack_message.rb
203
+ - lib/slack-ruby-bot/rspec/support/slack-ruby-bot/respond_with_slack_messages.rb
204
+ - lib/slack-ruby-bot/rspec/support/slack-ruby-bot/start_typing.rb
205
+ - lib/slack-ruby-bot/rspec/support/slack_api_key.rb
206
+ - lib/slack-ruby-bot/rspec/support/slack_ruby_bot_configure.rb
207
+ - lib/slack-ruby-bot/rspec/support/spec_helpers.rb
208
+ - lib/slack-ruby-bot/server.rb
209
+ - lib/slack-ruby-bot/support/loggable.rb
210
+ - lib/slack-ruby-bot/version.rb
211
+ - lib/slack_ruby_bot.rb
212
+ - screenshots/aliases.gif
213
+ - screenshots/create-classic-app.png
214
+ - screenshots/demo.gif
215
+ - screenshots/dms.gif
216
+ - screenshots/help.png
217
+ - screenshots/market.gif
218
+ - screenshots/weather.gif
219
+ - slack-ruby-bot.gemspec
220
+ - slack.png
221
+ homepage: https://github.com/slack-ruby/slack-ruby-bot
222
+ licenses:
223
+ - MIT
224
+ metadata: {}
225
+ post_install_message:
226
+ rdoc_options: []
227
+ require_paths:
228
+ - lib
229
+ required_ruby_version: !ruby/object:Gem::Requirement
230
+ requirements:
231
+ - - ">="
232
+ - !ruby/object:Gem::Version
233
+ version: '2.3'
234
+ required_rubygems_version: !ruby/object:Gem::Requirement
235
+ requirements:
236
+ - - ">="
237
+ - !ruby/object:Gem::Version
238
+ version: 1.3.6
239
+ requirements: []
240
+ rubygems_version: 3.1.2
241
+ signing_key:
242
+ specification_version: 4
243
+ summary: The easiest way to write a Slack bot in Ruby.
244
+ test_files: []