Class: SlackRubyBot::Commands::Base

Inherits:
Object
  • Object
show all
Includes:
Loggable
Defined in:
lib/slack-ruby-bot/commands/base.rb

Direct Known Subclasses

Bot, Default, Help, Hi, Unknown

Class Method Summary collapse

Class Method Details

.command(*values, &block) ⇒ Object



37
38
39
40
41
42
43
# File 'lib/slack-ruby-bot/commands/base.rb', line 37

def command(*values, &block)
  values.each do |value|
    escaped = Regexp.escape(value)
    match Regexp.new("^(?<bot>[[:alnum:][:punct:]@<>]*)[\\s]+(?<command>#{escaped})$", Regexp::IGNORECASE), &block
    match Regexp.new("^(?<bot>[[:alnum:][:punct:]@<>]*)[\\s]+(?<command>#{escaped})[\\s]+(?<expression>.*)$", Regexp::IGNORECASE), &block
  end
end

.default_command_nameObject



27
28
29
# File 'lib/slack-ruby-bot/commands/base.rb', line 27

def default_command_name
  name && name.split(':').last.downcase
end

.invoke(client, data) ⇒ Object



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
# File 'lib/slack-ruby-bot/commands/base.rb', line 45

def invoke(client, data)
  finalize_routes!
  expression, text = parse(client, data)
  called = false
  routes.each_pair do |route, method|
    match = route.match(expression)
    match ||= route.match(text) if text
    next unless match
    next if match.names.include?('bot') && !client.name?(match['bot'])
    called = true
    if method
      method.call(client, data, match)
    elsif respond_to?(:call)
      send(:call, client, data, match)
    else
      fail NotImplementedError, data.text
    end
    break
  end
  called
end

.match(match, &block) ⇒ Object



67
68
69
70
# File 'lib/slack-ruby-bot/commands/base.rb', line 67

def match(match, &block)
  self.routes ||= {}
  self.routes[match] = block
end

.operator(*values, &block) ⇒ Object



31
32
33
34
35
# File 'lib/slack-ruby-bot/commands/base.rb', line 31

def operator(*values, &block)
  values.each do |value|
    match Regexp.new("^(?<operator>\\#{value})(?<expression>.*)$", Regexp::IGNORECASE), &block
  end
end

.send_gif(client, channel, keywords, options = {}) ⇒ Object



22
23
24
25
# File 'lib/slack-ruby-bot/commands/base.rb', line 22

def send_gif(client, channel, keywords, options = {})
  logger.warn '[DEPRECATION] `send_gif` is deprecated.  Please use `client.say` instead.'
  client.say(options.merge(channel: channel, text: '', gif: keywords))
end

.send_message(client, channel, text, options = {}) ⇒ Object



8
9
10
11
12
13
14
15
# File 'lib/slack-ruby-bot/commands/base.rb', line 8

def send_message(client, channel, text, options = {})
  logger.warn '[DEPRECATION] `send_message` is deprecated.  Please use `client.say` instead.'
  if text && text.length > 0
    client.say(options.merge(channel: channel, text: text))
  else
    client.say(options.merge(channel: channel, text: 'Nothing to see here.', gif: 'nothing'))
  end
end

.send_message_with_gif(client, channel, text, keywords, options = {}) ⇒ Object



17
18
19
20
# File 'lib/slack-ruby-bot/commands/base.rb', line 17

def send_message_with_gif(client, channel, text, keywords, options = {})
  logger.warn '[DEPRECATION] `send_message_with_gif` is deprecated.  Please use `client.say` instead.'
  client.say(options.merge(channel: channel, text: text, gif: keywords))
end