dog-bot 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gem_spec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (3.2.7)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    blather (0.8.0)
+      activesupport (>= 2.3.11)
+      eventmachine (>= 0.12.6)
+      girl_friday
+      niceogiri (~> 1.0)
+      nokogiri (~> 1.5.5)
+    connection_pool (0.1.0)
+    eventmachine (0.12.10)
+    girl_friday (0.9.7)
+      connection_pool (~> 0.1.0)
+    google_image_api (0.0.1)
+    i18n (0.6.0)
+    multi_json (1.3.6)
+    niceogiri (1.0.2)
+      nokogiri (~> 1.4)
+    nokogiri (1.5.5)
+    rake (0.9.2.2)
+    rufus-scheduler (2.0.17)
+      tzinfo (>= 0.3.23)
+    tzinfo (0.3.33)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  blather (~> 0.8.0)
+  google_image_api
+  rake
+  rufus-scheduler

data/README.md

@@ -0,0 +1,4 @@
+Dog [![Build Status](https://secure.travis-ci.org/benmills/dog.png)](http://travis-ci.org/benmills/dog)
+===
+
+A man's best chat bot

data/Rakefile

@@ -0,0 +1,7 @@
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.pattern = "spec/**/*_spec.rb"
+end
+
+task :default => :test

data/bin/dog

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+require "dog"
+
+unless ARGV.count == 3
+  puts "Usage: dog [USER] [PASSWORD] [CONFIG PATH]"
+  exit 1
+end
+
+user, password, config_path = ARGV
+
+xmpp_client = Blather::Client.setup user, password
+xmpp_connection = Dog::Connection.new xmpp_client
+
+@bot = Dog::Bot.new xmpp_connection, config_path
+
+xmpp_client.register_handler(:ready) { @bot.config }
+xmpp_client.register_handler(:message, :chat?, :body) { |m| @bot.process_chat_message m }
+xmpp_client.register_handler(:message, :groupchat?, :body) { |m| @bot.process_group_chat_message m }
+
+EM.run { xmpp_client.run }

data/dog_config_example.rb

@@ -0,0 +1,62 @@
+task "say hi" do |t|
+  t.every "10min"
+  t.action { "Hello world!" }
+end
+
+command "get body of tweet" do |c|
+  c.matches /twitter\.com/
+  c.action do |message|
+    id = message.split("/").last
+    uri = URI.parse "https://api.twitter.com/1/statuses/show.json?id=#{id}"
+    tweet = JSON.parse uri.open.read
+
+    "#{tweet["text"]} - @#{tweet["user"]["screen_name"]}"
+  end
+end
+
+command "dog" do |c|
+  c.matches "dog"
+  c.action { "bark!" }
+
+  c.subcommand "xkcd" do |sc|
+    sc.matches "xkcd"
+    sc.action do
+      uri = URI.parse "http://xkcd.com/info.0.json"
+      comic = JSON.parse uri.open.read
+      "#{comic["img"]}\n#{comic["alt"]}"
+    end
+  end
+
+  c.subcommand "fetch image" do |sc|
+    sc.matches "fetch", "image"
+    sc.action do |message|
+      query = message.split(" ")[2..-1].join(" ")
+      GoogleImageApi.find(query).images.first["url"]
+    end
+  end
+
+  c.subcommand "ruby gems" do |sc|
+    sc.matches "gem"
+    sc.action do |message|
+      begin
+        gem_name = message.split(" ").last
+        uri = URI.parse "http://rubygems.org/api/v1/gems/#{gem_name}.json"
+        gem = JSON.parse uri.open.read
+
+        "'#{gem["name"]}' version: #{gem["version"]} downloads: #{gem["downloads"]}"
+      rescue
+        "gem not found"
+      end
+    end
+  end
+
+  c.subcommand "join channel" do |sc|
+    sc.matches "join"
+    sc.action { :join }
+  end
+
+  c.subcommand "reload config" do |sc|
+    sc.matches "reload"
+    sc.action { :reload }
+  end
+end

data/lib/dog.rb

@@ -0,0 +1,14 @@
+require "rubygems"
+require "blather/client/client"
+require "rufus/scheduler"
+require "uri"
+require "open-uri"
+require "json"
+require "google_image_api"
+
+$LOAD_PATH.unshift(File.expand_path('../lib', __FILE__))
+
+require "dog/bot"
+require "dog/configure"
+require "dog/connection"
+require "dog/command"

data/lib/dog/bot.rb

@@ -0,0 +1,106 @@
+require 'rubygems'
+require 'rufus/scheduler'
+
+module Dog
+  class Bot
+    def initialize connection, config_path
+      @config_path = config_path
+      @connection = connection
+      @commands = []
+      @rooms = []
+      @data = {}
+      @data.default = {}
+    end
+
+    def process_chat_message message
+      response = process message.body
+      @connection.say message.from, response unless response.nil?
+    end
+
+    def process_group_chat_message message
+      return if _from_self(message) || message.delayed?
+
+      response = process message.body
+      @connection.say_to_chat message.from.node, response unless response.nil?
+    end
+
+    def process message
+      response = respond_to message
+
+      if response.is_a? Symbol
+        respond_to_action message, response
+      else
+        response
+      end
+    end
+
+    def respond_to text
+      @commands.each do |command|
+        response = command.respond_to text
+        return response unless response.nil?
+      end
+
+      nil
+    end
+
+    def respond_to_action message, kind
+      case kind
+      when :join then
+        room_name = message.split.last
+        join room_name
+        "joined #{room_name}"
+      when :reload then
+        config
+        "config reloaded"
+      else "invalid action"
+      end
+    end
+
+    def join room_name
+      @connection.join room_name
+      @rooms << room_name
+    end
+
+    def config
+      config_string = File.read @config_path
+      config = Configure.parse config_string
+
+      @commands = config.commands
+      @scheduled_tasks = config.scheduled_tasks
+
+      schedule_tasks
+    end
+
+    def schedule_tasks
+      @scheduler.stop unless @scheduler.nil?
+
+      @scheduler = Rufus::Scheduler.start_new
+
+      @scheduled_tasks.each do |task|
+        @scheduler.every task.frequency do
+          response = task.run self
+          next if response.nil?
+
+          @rooms.each do |room|
+            @connection.say_to_chat room, response
+          end
+        end
+      end
+    end
+
+    def save_data key, val
+      @data[key] = val
+    end
+
+    def get_data key
+      @data[key]
+    end
+
+    def _from_self message
+      @rooms.each do |room|
+        return true if "#{room}@conference.#{@connection.jid.domain}/#{@connection.jid.node}" == message.from
+      end
+      false
+    end
+  end
+end

data/lib/dog/command.rb

@@ -0,0 +1,50 @@
+module Dog
+  class Command
+    def initialize title
+      @title = title
+      @matchers = []
+      @subcommands = []
+      @action = -> { }
+    end
+
+    def action &action
+      @action = action
+    end
+
+    def matches *matchers
+      @matchers += matchers
+    end
+
+    def matches? input_string
+      @matchers.any? do |matcher|
+        if matcher.is_a? String
+          input_string.match /(\s|^)#{matcher}(\s|$)/
+        else
+          input_string.match matcher
+        end
+      end
+    end
+
+    def subcommand title
+      subcommand = Command.new title
+      yield subcommand
+      @subcommands << subcommand
+    end
+
+    def subcommand_response input_string
+      @subcommands.each do |subcommand|
+        response = subcommand.respond_to input_string
+        return response unless response.nil?
+      end
+
+      nil
+    end
+
+    def respond_to input_string
+      if matches? input_string
+        sc_res = subcommand_response input_string
+        sc_res || @action.call(input_string)
+      end
+    end
+  end
+end

data/lib/dog/configure.rb

@@ -0,0 +1,31 @@
+require_relative "command"
+require_relative "scheduled_task"
+
+module Dog
+  class Configure
+    def self.parse config_string
+      config = Configure.new
+      config.instance_eval config_string
+      config
+    end
+
+    attr_reader :commands, :scheduled_tasks
+
+    def initialize
+      @commands = []
+      @scheduled_tasks = []
+    end
+
+    def command title
+      command = Command.new title
+      yield command
+      @commands << command
+    end
+
+    def task title
+      task = ScheduledTask.new title
+      yield task
+      @scheduled_tasks << task
+    end
+  end
+end

data/lib/dog/connection.rb

@@ -0,0 +1,30 @@
+module Dog
+  class Connection
+    def initialize client
+      @client = client
+    end
+
+    def jid
+      @client.jid
+    end
+
+    def join room_name
+      room = "#{room_name}@conference.#{jid.domain}"
+      service = jid.node
+
+      join_stanza = Blather::Stanza::Presence::MUC.new
+      join_stanza.to = "#{room}/#{service}"
+
+      @client.write join_stanza
+    end
+
+    def say to, text
+      @client.write Blather::Stanza::Message.new(to, text, :chat)
+    end
+
+    def say_to_chat room_name, text
+      to = Blather::JID.new room_name, "conference.#{jid.domain}"
+      @client.write Blather::Stanza::Message.new(to, text, :groupchat)
+    end
+  end
+end

data/lib/dog/scheduled_task.rb

@@ -0,0 +1,21 @@
+module Dog
+  class ScheduledTask
+    attr_reader :frequency, :title
+
+    def initialize title
+      @title = title
+    end
+
+    def every frequency
+      @frequency = frequency
+    end
+
+    def action &block
+      @action = block
+    end
+
+    def run context
+      @action.call context
+    end
+  end
+end

data/spec/dog/bot_spec.rb

@@ -0,0 +1,100 @@
+require "ostruct"
+require "minitest/spec"
+require "minitest/autorun"
+
+require_relative "../../lib/dog/bot"
+require_relative "../../lib/dog/command"
+
+class FakeConnection
+  attr_reader :output, :chat_output, :rooms
+
+  def initialize
+    @output = []
+    @chat_output = []
+    @rooms = []
+  end
+
+  def say from, response
+    @output << [from, response]
+  end
+
+  def say_to_chat from, response
+    @chat_output << [from, response]
+  end
+
+  def join room_name
+    @rooms << room_name
+  end
+
+  def jid
+    OpenStruct.new(
+      :jid => OpenStruct.new(:domain => "example.com"),
+      :node => "dog"
+    )
+  end
+end
+
+class Dog::Bot
+  def config
+    command = Dog::Command.new "greet"
+    command.matches "hi"
+    command.action { "hello" }
+    @commands = [command]
+  end
+end
+
+describe Dog::Bot do
+  let(:connection) { FakeConnection.new }
+  subject { Dog::Bot.new connection, "config" }
+
+  before(:each) { subject.config }
+
+  describe ".process_chat_message" do
+    it "processes a message that matches" do
+      message = OpenStruct.new :from => "bob", :body => "hi dog"
+      subject.process_chat_message message
+      connection.output.last.must_equal ["bob", "hello"]
+    end
+
+    it "doesn't process a non-matching message" do
+      message = OpenStruct.new :from => "bob", :body => "bad string"
+      subject.process_chat_message message
+      connection.output.must_be_empty
+    end
+  end
+
+  describe ".process_group_chat_message" do
+    it "processes a message that matches" do
+      message = OpenStruct.new(
+        :from => OpenStruct.new(:node => "bob", :domain => "chat"),
+        :body => "hi dog",
+        :delayed? => false
+      )
+      subject.process_group_chat_message message
+      connection.chat_output.last.must_equal ["bob", "hello"]
+    end
+
+    it "doesn't process a non-matching message" do
+      message = OpenStruct.new(
+        :from => OpenStruct.new(:node => "bob", :domain => "chat"),
+        :body => "bad string",
+        :delayed? => false
+      )
+      subject.process_group_chat_message message
+      connection.chat_output.must_be_empty
+    end
+  end
+
+  describe ".respond_to_action" do
+    it "joins a room" do
+      output = subject.respond_to_action "dog join chatroom", :join
+      output.must_equal "joined chatroom"
+      connection.rooms.last.must_equal "chatroom"
+    end
+
+    it "reloads" do
+      output = subject.respond_to_action "dog reload", :reload
+      output.must_equal "config reloaded"
+    end
+  end
+end

data/spec/dog/command_spec.rb

@@ -0,0 +1,72 @@
+require "minitest/spec"
+require "minitest/autorun"
+require_relative "../../lib/dog/command.rb"
+
+describe Dog::Command do
+  subject do
+    command = Dog::Command.new "Greet"
+    command.matches "hello", /example\.com/
+    command.action { "hi" }
+    command.subcommand "foo" do |subcommand|
+      subcommand.matches "foo"
+      subcommand.action { "bar" }
+    end
+
+    command
+  end
+
+  describe ".action" do
+    it "sets the action of the command" do
+      subject.action { "new action" }
+      subject.respond_to("hello").must_equal "new action"
+    end
+
+    it "passes the body of the incoming text to the action" do
+      subject.action { |body| body }
+      subject.respond_to("hello foobarbaz1").must_equal "hello foobarbaz1"
+    end
+  end
+
+  describe ".matches" do
+    it "adds a matcher to the command" do
+      subject.matches "newmatcher"
+      subject.respond_to("newmatcher").must_equal "hi"
+    end
+
+    it "can be called multiple times" do
+      subject.matches "firstnewmatcher"
+      subject.matches "secondnewmatcher"
+
+      subject.respond_to("firstnewmatcher").must_equal "hi"
+      subject.respond_to("secondnewmatcher").must_equal "hi"
+    end
+  end
+
+  describe ".respond_to" do
+    it "calls it's block if the input string matches a matcher" do
+      subject.respond_to("hello").must_equal "hi"
+    end
+
+    it "calls it's block if a matcher matches a multi-word input string" do
+      subject.respond_to("hello dog!").must_equal "hi"
+    end
+
+    it "returns nil if no matcher maches" do
+      subject.respond_to("bad input").must_be_nil
+    end
+
+    it "matches only words" do
+      subject.respond_to("hellonomatch").must_be_nil
+    end
+
+    it "can use a regex matcher" do
+      subject.respond_to("http:/www.example.com").must_equal "hi"
+    end
+  end
+
+  describe ".subcommand" do
+    it "matches subcommands" do
+      subject.respond_to("hello foo").must_equal "bar"
+    end
+  end
+end

data/spec/dog/configure_spec.rb

@@ -0,0 +1,54 @@
+require "minitest/spec"
+require "minitest/autorun"
+require_relative "../../lib/dog/configure.rb"
+
+describe Dog::Configure do
+  let :command_config_string do
+<<CONFIG
+command "greet" do |c|
+  c.matches "hello", "hi", "whats up"
+  c.action { "hello!" }
+
+  c.subcommand "cool greet" do |subcommand|
+    subcommand.matches "yo"
+    subcommand.action { "yo yo yo, hello!" }
+  end
+end
+CONFIG
+  end
+
+  let :task_config_string do
+<<CONFIG
+task "say hi" do |t|
+  t.every "1m"
+  t.action { "hello!" }
+end
+CONFIG
+  end
+
+  describe "#parse" do
+    it "parses a string into an array of commands" do
+      config = Dog::Configure.parse command_config_string
+      command = config.commands.first
+
+      command.respond_to("hi").must_equal "hello!"
+      command.respond_to("hello").must_equal "hello!"
+      command.respond_to("whats up").must_equal "hello!"
+    end
+
+    it "parses subcommands" do
+      config = Dog::Configure.parse command_config_string
+      command = config.commands.first
+
+      command.respond_to("hi yo").must_equal "yo yo yo, hello!"
+    end
+
+    it "parses a string into an array of scheduled tasks" do
+      config = Dog::Configure.parse task_config_string
+      task = config.scheduled_tasks.first
+
+      task.run({}).must_equal "hello!"
+      task.frequency.must_equal "1m"
+    end
+  end
+end

data/spec/dog/scheduled_task_spec.rb

@@ -0,0 +1,21 @@
+require "minitest/spec"
+require "minitest/autorun"
+require_relative "../../lib/dog/scheduled_task.rb"
+
+describe Dog::ScheduledTask do
+  subject { Dog::ScheduledTask.new "my task" }
+
+  describe ".every" do
+    it "sets the frequency of the task" do
+      subject.every "1m"
+      subject.frequency.must_equal "1m"
+    end
+  end
+
+  describe ".action" do
+    it "sets the action of the task" do
+      subject.action { "my action" }
+      subject.run({}).must_equal "my action"
+    end
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: dog-bot
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ben Mills
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: blather
+  requirement: &17501260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *17501260
+- !ruby/object:Gem::Dependency
+  name: google_image_api
+  requirement: &17500320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *17500320
+- !ruby/object:Gem::Dependency
+  name: rufus-scheduler
+  requirement: &17499020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.17
+  type: :runtime
+  prerelease: false
+  version_requirements: *17499020
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &17498200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+  type: :development
+  prerelease: false
+  version_requirements: *17498200
+description: Chatbot
+email:
+- ben@bmdev.org
+executables:
+- dog
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- dog_config_example.rb
+- lib/dog.rb
+- lib/dog/bot.rb
+- lib/dog/command.rb
+- lib/dog/configure.rb
+- lib/dog/connection.rb
+- lib/dog/scheduled_task.rb
+- spec/dog/bot_spec.rb
+- spec/dog/command_spec.rb
+- spec/dog/configure_spec.rb
+- spec/dog/scheduled_task_spec.rb
+- bin/dog
+homepage: https://github.com/benmills/dog
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Extensible XMPP chatbot
+test_files:
+- spec/dog/bot_spec.rb
+- spec/dog/command_spec.rb
+- spec/dog/configure_spec.rb
+- spec/dog/scheduled_task_spec.rb