squab-bot 1.3.2

data/LICENSE.md

@@ -0,0 +1,13 @@
+Copyright 2013 Square Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,4 @@
+Squab IRC Bot
+=====
+
+This is the Squab IRC Bot directory.  Please see the root level directory for information on squab, using squab, and developing squab.

data/bin/squab-bot

@@ -0,0 +1,338 @@
+#!/usr/bin/ruby20
+require 'net/http'
+require 'yaml'
+require 'squab-client'
+
+# Global bot, but populate the namespace local
+# Needed to work with threads
+require 'isaac/bot'
+$bot = Isaac::Bot.new
+%w(configure helpers on).each do |method|
+  eval(<<-EOF)
+    def #{method}(*args, &block)
+      $bot.#{method}(*args, &block)
+    end
+  EOF
+end
+
+squab_confs = %w(/etc/squab/squab-bot.yaml /etc/squab-bot.yaml)
+local_squab_conf = File.join(File.dirname(__FILE__), 'squab-bot.yaml')
+squab_confs.push(local_squab_conf)
+
+$config = nil
+squab_confs.each do |cf|
+  begin
+    puts "Looking at " + cf
+    if File.exists?(cf)
+      $config = YAML.load_file(cf)
+      break
+    end
+  rescue
+    next
+  end
+end
+
+if $config.nil?
+  puts "No parsable config found"
+  exit()
+end
+
+def mainloop()
+  configure do |c|
+    c.nick = $config['irc_nick']
+    c.server = $config['irc_server']
+    c.port = $config['irc_port'].to_i
+    c.password = $config['irc_password']
+    c.ssl = $config['irc_ssl']
+    c.verbose = $config['irc_verbose']
+  end
+  
+  on :connect do
+    if not $config['sub_channels'].member?($config['home_channel'])
+      $config['sub_channels'][$config['home_channel']] = /.*/
+    end
+    for irc_chan in $config['sub_channels'].keys
+      $config['sub_channels'][irc_chan] = /#{$config['sub_channels'][irc_chan]}/
+      join irc_chan
+    end
+    for irc_chan in $config['join_channels']
+      join irc_chan
+    end
+  end
+  
+  on :channel, /^#{$config['irc_nick']}: help/i do
+    msg channel, "You can post things to Squab by typing:"
+    msg channel, ".sq <thing to say>"
+    msg channel, "Other commands:"
+    msg channel, "info -- state what channels and topics are being output"
+    msg channel, 'speak [on|off] -- Output messages from squab to the channel'
+    msg channel, 'filter <regex> -- Filter the output to this channel based'
+    msg channel, '  on a regex.  Use .* for everything'
+    msg channel, 'post <msg> -- Post a message to squab'
+    msg channel, 'search <thing> -- search for a thing in a squab message'
+    msg channel, 'join <channel> -- Join a channel'
+    msg channel, 'leave -- Leave this channel'
+  end
+
+  on :channel, /^#{$config['irc_nick']}: info/i do
+    if $config['sub_channels'].member?(channel)
+      msg channel, "Your filter is " + $config['sub_channels'][channel].source
+      sc = Squab::Client.new()
+      sources = JSON.parse(sc.list_sources)
+      source_list = []
+      sources.each do |s|
+        if $config['sub_channels'][channel].match(s)
+          source_list.push(s)
+        end
+      end
+      msg channel, "Based on the filter regex I will output the following sources to this channel:"
+      msg channel, source_list.join(', ')
+    else
+      msg channel, "I don't currently output anything to this channel"
+    end
+  end
+
+  on :channel, /^#{$config['irc_nick']}: speak (\S+)/i do
+    if match[0] =~ /^on$/i
+      if $config['sub_channels'].member?(channel)
+        msg channel, "I already speak in this channel."
+      else
+        $config['sub_channels'][channel] = /.*/
+        msg channel, "Ok, I'll start sending all squab output to this channel."
+        msg channel, "Use 'filter' if you'd like to limit what I output."
+      end
+    elsif match[0] =~ /^off$/i
+      if channel == $config['home_channel']
+        msg channel, "Sorry, I can't stop talking in my home channel"
+      else
+        $config['sub_channels'].delete(channel)
+        msg channel, "Ok, I'll stop talking"
+      end
+    else
+      msg channel, "I accept 'on' and 'off' for this command, you said '#{match[0]}'"
+    end
+  end
+
+  on :channel, /^#{$config['irc_nick']}: filter (.*)/i do
+    if channel == $config['home_channel']
+      msg channel, "#{channel} always outputs all sources"
+    else
+      filter_re = /#{match[0]}/
+      $config['sub_channels'][channel] = filter_re
+      msg channel, "Adding filter #{match[0]} to #{channel}"
+    end
+  end
+  
+  on :channel, /^(\.sq|#{$config['irc_nick']}: post)\s+(.*)$/i do
+    sc = Squab::Client.new()
+    sc.source = channel
+    sc.uid = nick
+    try_count = 0
+    begin
+      sc.send(match[1])
+      msg channel, "Posted to Squab"
+    rescue SendEventFailed
+      try_count += 1
+      if try_count > 3
+        msg channel, "Couldn't send event right now, please retry later"
+      else
+        sleep 1
+        retry
+      end
+    end
+  end
+
+  on :channel, /^#{$config['irc_nick']}: search\s+(.*)$/i do
+    sc = Squab::Client.new()
+    begin
+      res = JSON.parse(sc.simple_search(match[1]))
+      src = event['source']
+      usr = event['uid']
+      val = event['value'][0..255]
+      url = event['url']
+      res.each do |event|
+        msg channel, "[#{src}][#{usr}] #{value} #{url}"
+      end
+    rescue => e
+      msg channel, "Search failed: #{e}"
+    end
+  end
+
+  on :channel, /^#{$config['irc_nick']}: leave$/i do
+    if channel === $config['home_channel']
+      msg channel, "I can't leave this channel, it's where I say stuff"
+    else
+      msg channel, "Bye!"
+      part channel
+    end
+  end
+
+  on :private, /leave (\S+)/i do
+    if match[0] == $config['home_channel']
+      msg nick, "I can't leave that channel, that's my home!"
+    elsif match[0] =~ /^#/
+      msg match[0], "#{nick} asked me to leave, bye!"
+      msg nick, "Alright, leaving  #{match[0]}"
+      part match[0]
+    else
+      msg channel, "That doesn't seem like a channel name"
+    end
+  end
+
+  on :channel, /^#{$config['irc_nick']}: join (\S+)/ do
+    if match[0] =~ /^#/
+      msg channel, "Alright, heading over to #{match[0]}"
+      join match[0]
+    else
+      msg channel, "That doesn't seem like a channel name"
+    end
+  end
+
+  on :private, /^join (\S+)/ do
+    if match[0] =~ /^#/
+      msg nick, "Alright, heading over to #{match[0]}"
+      join match[0]
+    else
+      msg nick, "That doesn't seem like a channel name"
+    end
+  end
+
+  on :channel, /^#{$config['irc_nick']}:/ do
+    msg channel, "Hey, #{nick}, I'm a bot. You can ask me for 'help'"
+  end
+
+  # This will repeat everything said in the channel so you can see what
+  # squab-bot is actually matching on.  Be careful with this, it will ruin
+  # real channels, so use a test channel
+  on :channel, /^(.*)$/ do
+    if $config['debug']
+      msg channel, "DEBUG: " + match[0]
+    end
+  end
+
+  on :private do
+    msg nick, "Hi! I'm a bot! I live in #{$config['home_channel']}"
+    msg nick, "You can go there and ask me for 'help'"
+    msg nick, "I can also join another channel if you say 'join <channel>'"
+    msg nick, "I can also leave a channel if you say 'leave <channel>'"
+  end
+
+  on :extern_message do
+    msg channel, @message
+  end
+
+  $bot.start
+
+end
+
+# This is a parallel thread that calls to squab and gets recent messages
+# to play back into channels.  The home channel recieves everything and
+# subscribed channels may apply filters for what sources are output there
+def secondloop()
+  puts "Starting Squab Reader Loop"
+
+  sub_channels = $config['sub_channels']
+  message_file = $config['message_file']
+  api_url = $config['api_url']
+  strict_ssl = $config.fetch('strict_ssl', true)
+  squab_client = Squab::Client.new(:api => api_url)
+  latest_msg = 0
+  messages = []
+  if File.exists?(message_file)
+    File.open(message_file, 'r').each_line do |line|
+      latest_msg = line.strip.to_i
+    end
+  end
+
+  # Wait for the other thread to join irc
+  sleep 30
+  loop do
+    puts "Polling Squab..."
+    begin
+      if latest_msg == 0
+        # Replay the default number of messages if we don't have a latest
+        messages = squab_client.get
+      else
+        messages = squab_client.get_from_event(latest_msg)
+      end
+      messages = JSON.parse(messages)
+    rescue OpenSSL::SSL::SSLError => e
+      puts "SSL Error: #{e}"
+      if not strict_ssl
+        # Disable ssl if we're not being strict about it
+        puts "Disabling strict ssl verification"
+        squab_client.ssl_verify = false
+      else
+        sleep 10
+      end
+      retry
+    rescue => e
+      puts "Couldn't get messages from squab: #{e}"
+      sleep 10
+      retry
+    end
+
+    messages.reverse.each do |message|
+      if message.has_key?('id')
+        id = message['id']
+        if id.to_i >= latest_msg
+          latest_msg = id.to_i + 1
+        end
+        value = message['value']
+        source = message['source']
+        uid = message['uid']
+        url = message['url']
+
+        # Limit to Tweet sized
+        # IRC message size is usually 510 bytes, but you don't want
+        # giant messages in your channels.  Add a url if you need more
+        # details
+        if value.length > 140 
+          value = value[0,140] + ' [message too long]'
+        end
+
+        irc_m = nil
+
+        # Only print source if it's the same case-insensitive string as uid
+        id_tag = if uid =~ /^#{Regexp.escape(source)}$/i
+          "[#{source}]"
+        else
+          "[#{uid}][#{source}]"
+        end
+
+        irc_m = if url.nil?
+          "#{id_tag} #{value}"
+        else
+          "#{id_tag} #{value} (#{url})"
+        end
+
+        begin
+          sub_channels.each do |ch, filter|
+            if source =~ filter
+              m = Isaac::Message.new(":squab PRIVMSG " + ch + " :" + irc_m)
+              $bot.dispatch(:extern_message, m)
+              puts "Posting to #{ch}: #{message}"
+            end
+          end
+          # Don't flood the channel
+          sleep 1
+        rescue
+          puts "Can't send to bot"
+          sleep 10
+          retry
+        end
+      end
+    end
+    File.open('/tmp/squab.msg', 'w') {|fh| fh.write(latest_msg)}
+    sleep 10
+  end
+end
+
+
+t1 = Thread.new{mainloop()}
+t2 = Thread.new{secondloop()}
+
+t1.join
+t2.join
+
+puts "ok its done"

data/bin/squab-bot.yaml

@@ -0,0 +1,40 @@
+--- 
+# Subchannels will be joined, with bot notifications on.  The filters will
+# be applied as regex matches to the sources
+sub_channels: 
+  "#subchannel":
+    - "this|that"
+  "#subchannel2":
+    - "onlythis"
+  "#subchannel2":
+    - "com(pli|cat)ed.*regex"
+# The squab bot will join these channels, but not speak
+# This allows channels to post, but not have bot chatter in them
+join_channels:
+  - "#posthere"
+  - "#orhere"
+# The home channel is where the bot always lives.  The bot will not leave
+# this channel and always outputs all messages to here regardless of source
+home_channel: "#squab"
+# Where to save the most recently seen messages.  If this file is missing
+# the bot replays the last 5 messages (if the filter applies) and records
+# the latest ID
+message_file: /tmp/squab.msg
+# This should be the address of your squab web interface
+api_url: http://squab.example.com:8082/
+# If your IRC server has a password, put it here
+irc_password: secret_password
+# What the bot should call itself.  It makes sense to call it squab, but
+# if you hate that, don't!
+irc_nick: squab
+# If your IRC server is protected by SSL, use this
+irc_ssl: "true"
+# The port to your irc server
+irc_port: "6697"
+# The name of your IRC server
+irc_server: irc.example.com
+# If you should output all the IRC stuff that the bot sees to the console
+irc_verbose: "true"
+# If you want debug on... the bot will output everything it sees in a channel
+# you probably only want this for development purposes
+debug: "false"

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification 
+name: squab-bot
+version: !ruby/object:Gem::Version 
+  hash: 31
+  prerelease: 
+  segments: 
+  - 1
+  - 3
+  - 2
+  version: 1.3.2
+platform: ruby
+authors: 
+- Grier Johnson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-12-02 00:00:00 -05:00
+default_executable: squab-bot
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: isaac
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: squab-client
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rangeclient
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: An IRC bot that allows reading and posting to Squab
+email: 
+- github@squareup.com
+executables: 
+- squab-bot
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.md
+files: 
+- bin/squab-bot
+- bin/squab-bot.yaml
+- README.md
+- LICENSE.md
+has_rdoc: true
+homepage: http://github.com/square/squab
+licenses: 
+- Apache 2.0
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: An IRC interface to Squab
+test_files: []
+