Class: Slackbotsy::Bot

Inherits:
Object
  • Object
show all
Defined in:
lib/slackbotsy/bot.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options, &block) ⇒ Bot

Returns a new instance of Bot.



13
14
15
16
17
18
19
20
21
 
# File 'lib/slackbotsy/bot.rb', line 13

def initialize(options, &block)
  @options = options

  ## use set of tokens for (more or less) O(1) lookup on multiple channels
  @options['outgoing_token'] = Array(@options['outgoing_token']).to_set
  @listeners = []
  setup_incoming_webhook                # http connection for async replies
  instance_eval(&block) if block_given? # run any hear statements in block
end

Instance Attribute Details

#last_description ⇒ Object

Returns the value of attribute last_description.



11
12
13
 
# File 'lib/slackbotsy/bot.rb', line 11

def last_description
  @last_description
end

#listeners ⇒ Object

Returns the value of attribute listeners.



11
12
13
 
# File 'lib/slackbotsy/bot.rb', line 11

def listeners
  @listeners
end

Instance Method Details

#attach(ary, options = {}) ⇒ Object

simple wrapper on post to send attachment(s)



50
51
52
53
 
# File 'lib/slackbotsy/bot.rb', line 50

def attach(ary, options = {})
  attachments = ary.is_a?(Array) ? ary : [ ary ] #force first arg to array
  post({ attachments: attachments }.merge(options))
end

#desc(command, description = nil) ⇒ Object

record a description of the next hear block, for use in help



56
57
58
 
# File 'lib/slackbotsy/bot.rb', line 56

def desc(command, description = nil)
  @last_desc = [ command, description ]
end

#eval_scripts(*files) ⇒ Object

pass list of files containing hear statements, to be opened and evaled



67
68
69
70
71
 
# File 'lib/slackbotsy/bot.rb', line 67

def eval_scripts(*files)
  files.flatten.each do |file|
    self.instance_eval File.open(file).read
  end
end

#handle_item(msg) ⇒ Object

check message and run blocks for any matches



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/slackbotsy/bot.rb', line 74

def handle_item(msg)
  return nil unless @options['outgoing_token'].include? msg[:token] # ensure messages are for us from slack
  return nil if msg[:user_name] == 'slackbot'  # do not reply to self
  return nil unless msg[:text].is_a?(String) # skip empty messages

  ## loop things to look for and collect immediate responses
  ## rescue everything here so the bot keeps running even with a broken script
  responses = @listeners.map do |hear|
    if mdata = msg[:text].strip.match(hear.regex)
      begin
        Slackbotsy::Message.new(self, msg).instance_exec(mdata, &hear.proc)
      rescue => err
        err
      end
    end
  end

  ## format any replies for http response
  if responses
    { text: responses.compact.join("\n") }.to_json
  end
end

#hear(regex, &block) ⇒ Object

add regex to things to hear



61
62
63
64
 
# File 'lib/slackbotsy/bot.rb', line 61

def hear(regex, &block)
  @listeners << OpenStruct.new(regex: regex, desc: @last_desc, proc: block)
  @last_desc = nil
end

#post(options) ⇒ Object

raw post of hash to slack



32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/slackbotsy/bot.rb', line 32

def post(options)
  payload = {
    username: @options['name'],
    channel:  @options['channel']
  }.merge(options)
  payload[:channel] = payload[:channel].gsub(/^#?/, '#') #slack api needs leading # on channel
  request = Net::HTTP::Post.new(@uri.request_uri)
  request.set_form_data(payload: payload.to_json)
  @http.request(request)
  return nil # so as not to trigger text in outgoing webhook reply
end

#say(text, options = {}) ⇒ Object

simple wrapper on post to send text



45
46
47
 
# File 'lib/slackbotsy/bot.rb', line 45

def say(text, options = {})
  post({ text: text }.merge(options))
end

#setup_incoming_webhook ⇒ Object

setup http connection for sending async incoming webhook messages to slack



24
25
26
27
28
29
 
# File 'lib/slackbotsy/bot.rb', line 24

def setup_incoming_webhook
  @uri  = URI.parse "https://#{@options['team']}.slack.com/services/hooks/incoming-webhook?token=#{@options['incoming_token']}"
  @http = Net::HTTP.new(@uri.host, @uri.port)
  @http.use_ssl = true
  @http.verify_mode = OpenSSL::SSL::VERIFY_PEER
end