bitbckt-botbckt 0.3.0 → 0.4.0

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :patch: 0
 :major: 0
-:minor: 3
+:minor: 4

data/bin/botbckt

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+begin
+  require 'pathname'
+  local_lib = Pathname.new(__FILE__).expand_path.dirname.join('..', 'lib', 'botbckt.rb')
+  if local_lib.file?
+    require local_lib
+  else
+    require 'botbckt'
+  end
+rescue LoadError
+  require 'rubygems'
+  require 'botbckt'
+end
+
+Botbckt::Cmd.run(ARGV)

data/lib/botbckt/bot.rb

@@ -3,12 +3,14 @@ module Botbckt #:nodoc:
   # Create a new IRC bot. See Bot.start to get started.
   #
   class Bot
+    include Singleton
+    include ActiveSupport::BufferedLogger::Severity
     
     AFFIRMATIVE = ["'Sea, mhuise.", "In Ordnung", "Ik begrijp", "Alles klar", "Ok.", "Roger.", "You don't have to tell me twice.", "Ack. Ack.", "C'est bon!"]
     NEGATIVE    = ["Titim gan éirí ort.", "Gabh mo leithscéal?", "No entiendo", "excusez-moi", "Excuse me?", "Huh?", "I don't understand.", "Pardon?", "It's greek to me."]
-    
-    cattr_accessor :commands
-    @@commands = { }
+
+    attr_accessor :logger
+    attr_accessor :store
     
     # ==== Parameters
     # options<Hash{Symbol => String,Integer}>
@@ -21,22 +23,90 @@ module Botbckt #:nodoc:
     # :channels<Array[String]>:: An array of channels to join. Channel names should *not* include the '#' prefix. Required.
     # :log<String>:: The name of a log file. Defaults to 'botbckt.log'.
     # :log_level<Integer>:: The minimum severity level to log. Defaults to 1 (INFO).
+    # :pid<String>:: The name of a file to drop the PID. Defaults to 'botbckt.pid'.
+    # :daemonize<Boolean>:: Fork and background the process. Defaults to true.
+    # :backend_host<String>:: The hostname of a Redis store. Optional.
+    # :backend_port<Integer>:: The port used by the Redis store. Optional.
     #
     def self.start(options)
-      EventMachine::run do
-        Botbckt::IRC.connect(options)
+
+      self.instance.logger = ActiveSupport::BufferedLogger.new options.delete(:log) || 'botbckt.log',
+                                                               options.delete(:log_level) || INFO
+                                                               
+      host, port = options.delete(:backend_host), options.delete(:backend_port)
+      daemonize = options.delete(:daemonize)
+      pid = options.delete(:pid) || 'botbckt.pid'
+
+      if daemonize || daemonize.nil?
+        EventMachine::fork_reactor do
+          Botbckt::IRC.connect(options)
+          
+          if host && port
+             self.instance.store = Store.new(host, port)
+           end
+          
+          if pid
+            File.open(pid, 'w'){ |f| f.write("#{Process.pid}") }
+            at_exit { File.delete(pid) if File.exist?(pid) }
+          end
+          
+        end
+      else
+        EventMachine::run do
+          Botbckt::IRC.connect(options)
+        end
       end
     end
     
+    # Registers a new command.
+    #
+    # ==== Parameters
+    # command<~to_sym>:: Trigger to register. Required.
+    # callable<~call>:: Callback or class with #call to execute. Required.
+    #
+    def register(command, callable)
+      @commands ||= { }
+      @commands[command.to_sym] = callable
+    end
+
+    # Returns currently registered commands.
+    #
+    def commands
+      @commands
+    end
+    
+    #--
+    # TODO: Forwardable?
+    #++
+    def set(key, value, &block)
+      self.store && self.store.set(key, value, &block)
+    end
+    
+    #--
+    # TODO: Forwardable?
+    #++
+    def get(key, &block)
+      self.store && self.store.get(key, &block)
+    end
+    
+    #--
+    # TODO: Forwardable?
+    #++
+    def increment!(key, &block)
+      self.store && self.store.increment!(key, &block)
+    end
+
     # ==== Parameters
     # command<Symbol>:: The name of a registered command to run. Required.
+    # sender<String>:: The sender (incl. hostmask) of the trigger. Required.
+    # channel<String>:: The channel on which the command was triggered. Required.
     # *args:: Arguments to be passed to the command. Optional.
     #
     #--
     # TODO: Before/after callbacks?
     #++
-    def self.run(command, sender, channel, *args)
-      callable = self.commands[command.to_sym]
+    def run(command, sender, channel, *args)
+      callable = commands[command.to_sym]
       
       if callable.is_a?(Class)
         # Callables are Singletons; we use #create! as a convention to give
@@ -44,7 +114,10 @@ module Botbckt #:nodoc:
         callable = callable.create!(sender, channel, *args)
       end
       
-      callable.respond_to?(:call) ? callable.call(sender, channel, *args) : say(befuddled, channel)
+      callable.respond_to?(:call) ? callable.call(sender, channel, *args) : say(Bot.befuddled, channel)
+    # TODO: Log me.
+    rescue StandardError => e
+      say Bot.befuddled, channel
     end
     
     # Returns a random "affirmative" message. Use to acknowledge user input.
@@ -70,10 +143,14 @@ module Botbckt #:nodoc:
     # msg<String>:: A message to send to the channel
     # channel<String>:: The channel to send the message. Required.
     #
-    def self.say(msg, channel)
+    def say(msg, channel)
       Botbckt::IRC.connection.say msg, channel
     end
+
+    def log(msg, level = INFO) #:nodoc:
+      self.logger.add(level, msg)
+    end
     
   end
 
-end
+end

data/lib/botbckt/cmd.rb

@@ -0,0 +1,86 @@
+module Botbckt #:nodoc:
+  
+  class Cmd
+    
+    SEVERITY = %w{0 1 2 3 4 5}
+    SEVERITY_ALIASES = { "DEBUG" => 0, "INFO" => 1, "WARN" => 2, "ERROR" => 3, "FATAL" => 4, "UNKNOWN" => 5}
+    
+    def self.run(args)
+      Botbckt::Bot.start parse(args)
+    end
+    
+    def self.parse(args)
+      options = {}
+      options[:user] = 'botbckt'
+      options[:port] = 6667
+      options[:channels] = []
+      options[:backend_port] = 6379
+      
+      opts = OptionParser.new do |opts|
+        opts.banner = 'Usage: botbckt [options]'
+      
+        opts.separator ''
+        opts.separator 'Options:'
+        
+        opts.on('-u', '--user [USER]', 'Username to identify as. (default: botbckt)') do |user|
+          options[:user] = user
+        end
+        
+        opts.on('-p', '--password [PASSWORD]', 'Password to authenticate with.') do |pass|
+          options[:password] = pass
+        end
+        
+        opts.on('-s', '--server SERVER', 'Address of the IRC server.') do |server|
+          options[:server] = server
+        end
+        
+        opts.on('-P', '--port [PORT]', Integer, 'Port of the IRC server. (default: 6667)') do |port|
+          options[:port] = port
+        end
+        
+        opts.on('-c', '--channels [x,y,z]', Array,
+                'Comma-separated list of channels to JOIN. Do not include the # prefix.') do |channels|
+          options[:channels] = channels
+        end
+      
+        opts.on('-l', '--logfile [FILE]', 'Log file. (default botbckt.log)') do |log|
+          options[:log] = log
+        end
+      
+        severities = SEVERITY_ALIASES.keys.join(', ')
+        opts.on('-V', '--verbosity [LEVEL]', SEVERITY, SEVERITY_ALIASES, Integer,
+                "Minimum severity level to log.Accepted values are: #{severities}. (default: INFO)") do |level|
+          options[:log_level] = level
+        end
+        
+        opts.on('-b', '--backend-host [SERVER]', 'Address of a Redis server.') do |backend|
+          options[:backend_host] = backend
+        end
+        
+        opts.on('-B', '--backend-port [PORT]', Integer, 'Port of a Redis server. (default: 6379)') do |port|
+          options[:backend_port] = port
+        end
+        
+        opts.on('-D', '--[no-]daemonize', 'Fork and run in the background. (default: true)') do |daemon|
+          options[:daemonize] = daemon
+        end
+        
+        opts.on('-i', '--pid FILE', 'File to store PID (default: botbckt.pid)') do |file|
+          options[:pid] = file
+        end
+        
+        opts.on_tail('-h', '--help', 'Show this message.') do |help|
+          puts opts
+          exit
+        end
+      end
+      
+      opts.parse!(args)
+      options
+    rescue OptionParser::ParseError
+      puts opts
+      exit
+    end
+    
+  end
+end

data/lib/botbckt/command.rb

@@ -1,11 +1,10 @@
-require 'singleton'
-
 module Botbckt #:nodoc:
   
-  # This acts as a kind of abstract class for Botbckt commands. Extend your
-  # command class with this module to define new bot commands.
+  # This acts as a kind of abstract class for Botbckt commands. Subclass
+  # this class to define new bot commands.
   #
-  # Command subclasses must (re-)define initialize and call.
+  # Command subclasses must (re-)define call. If any setup is needed, override
+  # create! and return self.instance.
   #
   class Command
     include Utilities
@@ -39,9 +38,10 @@ module Botbckt #:nodoc:
     #
     # ==== Parameters
     # command<Symbol>:: In-channel trigger for the command. Required.
+    # &block:: An optional block to execute, in lieu of call.
     #
     def self.trigger(command, &block)
-      Botbckt::Bot.commands[command.to_sym] = block_given? ? block : self
+      Botbckt::Bot.instance.register(command, block_given? ? block : self)
     end
     
     # ==== Parameters
@@ -49,7 +49,7 @@ module Botbckt #:nodoc:
     # channel<String>:: The channel to send the message. Required.
     #
     def self.say(msg, channel)
-      Botbckt::Bot.say(msg, channel) if msg
+      Botbckt::Bot.instance.say(msg, channel) if msg
     end
     
     # Proxy for Command.say
@@ -58,6 +58,18 @@ module Botbckt #:nodoc:
       self.class.say(msg, channel)
     end
     
+    def set(key, value, &block)
+      Botbckt::Bot.instance.set(key, value, &block)
+    end
+    
+    def get(key, &block)
+      Botbckt::Bot.instance.get(key, &block)
+    end
+    
+    def increment!(key, &block)
+      Botbckt::Bot.instance.increment!(key, &block)
+    end
+    
   end
   
 end

data/lib/botbckt/commands/gooble.rb

@@ -0,0 +1,114 @@
+module Botbckt #:nodoc:
+
+  # Sends text repeatedly to Google Translate via the JSON API 
+  # to garble the output. Translation starts and ends with 
+  # MAIN_LANGUAGE unless a language option is passed in. If
+  # an option is present it is used as the starting language.
+  # 
+  #
+  #  < user> ~gooble We the People of the United States, in Order to form a more perfect Union
+  #  < botbckt> Popular in the United States to create the completed
+  #
+  # With language option:
+  # 
+  #  < user> ~gooble --german Guten tag
+  #  < botbckt> Good day
+  #
+  # or the short version
+  #
+  #  < user> ~gooble -de Guten tag
+  #  < botbckt> Good day
+  
+  class Gooble < Command
+  
+    MAIN_LANGUAGE       = "en"
+    TRANSLATE_ATTEMPTS  = 4
+    # Yeah this is wordy but it's self documenting.
+    LANGUAGES           = 
+      {
+        "Albanian"    => "sq",
+        "Arabic"      => "ar",
+        "Bulgarian"   => "bg",
+        "Catalan"     => "ca",
+        "Chinese"     => "zh-CN",
+        "Croatian"    => "hr",
+        "Czech"       => "cs",
+        "Danish"      => "da",
+        "Dutch"       => "nl",
+        "English"     => "en",
+        "Estonian"    => "et",
+        "Filipino"    => "tl",
+        "Finnish"     => "fi",
+        "French"      => "fr",
+        "Galician"    => "gl",
+        "German"      => "de",
+        "Greek"       => "el",
+        "Hebrew"      => "iw",
+        "Hindi"       => "hi",
+        "Hungarian"   => "hu",
+        "Indonesian"  => "id",
+        "Italian"     => "it",
+        "Japanese"    => "ja",
+        "Korean"      => "ko",
+        "Latvian"     => "lv",
+        "Lithuanian"  => "lt",
+        "Maltese"     => "mt",
+        "Norwegian"   => "no",
+        "Polish"      => "pl",
+        "Portuguese"  => "pt",
+        "Romanian"    => "ro",
+        "Russian"     => "ru",
+        "Serbian"     => "sr",
+        "Slovak"      => "sk",
+        "Slovenian"   => "sl",
+        "Spanish"     => "es",
+        "Swedish"     => "sv",
+        "Thai"        => "th",
+        "Turkish"     => "tr",
+        "Ukrainian"   => "uk",
+        "Vietnamese"  => "vi"
+      }
+    
+    trigger :gooble do |sender, channel, gooble_string|
+      # start with english unless asked for something else
+      gooble_string =~ /(-\w{2}|--\w+)?(.*)/i
+      option, text = $1, $2
+      clean_option = option.gsub(/-/,'') if option
+
+      start_language = case option
+        when /^--/ then
+          LANGUAGES[clean_option.capitalize!] || MAIN_LANGUAGE
+        when /^-/ then
+          LANGUAGES.value?(clean_option) ? clean_option : MAIN_LANGUAGE
+        else
+          MAIN_LANGUAGE
+      end
+
+      # languages to use for the goobling
+      languages = [start_language]
+      languages << LANGUAGES.values.sort_by{ rand }.slice(0...TRANSLATE_ATTEMPTS)
+      languages << MAIN_LANGUAGE # always end with main 
+      
+      result = gooble(text, languages.flatten)
+      say result, channel
+    end
+  
+    private
+
+    # args
+    # text<String>: text to translate
+    # langs<Array>: languages to translate from/to
+    def self.gooble(text, languages) #:nodoc:
+      if languages.length >= 2
+        pair     = "#{languages[0]}|#{languages[1]}"
+        json     = open("http://ajax.googleapis.com/ajax/services/language/translate?v=1.0&q=#{CGI.escape(text)}&langpair=#{CGI.escape(pair)}")
+        response = JSON.parse(json.read) # could check for failed response with response['responseStatus'] != 200 
+        languages.shift
+        gooble(response['responseData']['translatedText'], languages)
+      else
+        text
+      end
+    end
+
+  end
+end

data/lib/botbckt/commands/remind.rb

@@ -7,6 +7,10 @@ module Botbckt #:nodoc:
   #  ... five minutes
   #  < botbckt> user: message
   #
+  #  < user> ~remind at 10:30 with message
+  #  ... at 10:30
+  #  < botbckt> user: message
+  #
   class Remind < Command
 
     SCALES = %w{ minute minutes second seconds hour hours }
@@ -14,20 +18,52 @@ module Botbckt #:nodoc:
     trigger :remind
     
     def call(user, channel, reminder_string)
+      
+      case reminder_string 
+      when /^in/i
+        msg, time = *relative_reminder(reminder_string)
+      when /^at/i
+        msg, time = *absolute_reminder(reminder_string)
+      else
+        say Botbckt::Bot.befuddled, channel
+        return
+      end
+      
+      if msg && time
+        remind(freenode_split(user).first, channel, msg, time)
+      else
+        say Botbckt::Bot.befuddled, channel
+      end
+    end
+    
+    private
+
+    def relative_reminder(str) #:nodoc:
       # Somewhat faster than #match...
-      reminder_string =~ /in (\d+) (\w+) with (.*)/i
+      str =~ /in (\d+) (\w+) with (.*)/i
       num, scale, msg = $1, $2, $3
       
       if SCALES.include?(scale)
       	time = num.to_i.send(scale.to_sym).seconds
-
-      	remind(freenode_split(user).first, channel, msg, time)
+        [ msg, time ]
       else 
-        say Botbckt::Bot.befuddled, channel
+        [ ]
       end
     end
     
-    private
+    def absolute_reminder(str) #:nodoc:
+      # Somewhat faster than #match...
+      str =~ /at (.*) with (.*)/i
+      time, msg = $1, $2
+      
+      time = Time.parse(time) - Time.now
+      
+      [ msg, time ]
+    # TODO: Log me.
+    rescue ArgumentError => e
+      # raised by Time.parse; do nothing, for now...
+      [ ]
+    end
     
     def remind(user, channel, msg, seconds) #:nodoc:
       EventMachine::Timer.new(seconds) do

data/lib/botbckt/commands/star_jar.rb

@@ -13,22 +13,14 @@ module Botbckt #:nodoc:
   class StarJar < Command
    
     trigger :star
-
-    attr_accessor :jar
-
-    def self.create!(*args) #:nodoc:
-      self.instance.jar ||= { }
-      self.instance
-    end
    
     # Adds a star to the jar for the user
     #
     # ==== Parameters
     # user<String>:: The user receiving a star. Required.
     #
-    def push(user)
-      @jar[user] ||= 0
-      @jar[user] += 1
+    def push(user, &block)
+      increment! "starjar-#{user}", &block
     end
     
     # Removes a star from the jar for the user
@@ -36,21 +28,23 @@ module Botbckt #:nodoc:
     # ==== Parameters
     # user<String>:: The user being docked a star. Required.
     #
-    def pop(user)
-      @jar[user] ||= 0
+    def pop(user, &block)
+      get "starjar-#{user}" do |stars|
       
-      if @jar[user] == 0
-        return 0
-      else
-        @jar[user] -= 1
+        if stars
+          set "starjar-#{user}", stars - 1, &block
+        else
+          set "starjar-#{user}", 0, &block
+        end
       end
     end
    
     def call(giver, channel, receiver)
       receiver.split(' ').each do |rcv|
         if rcv != freenode_split(giver).first
-          total = push(rcv)
-          say "#{rcv}: Gold star for you! (#{total})", channel
+          push(rcv) do |total|
+            say "#{rcv}: Gold star for you! (#{total})", channel
+          end
         else
           say "#{rcv}: No star for you!", channel
         end

data/lib/botbckt/commands/weather.rb

@@ -6,7 +6,6 @@ module Botbckt #:nodoc:
   #  < botbckt> Today's Forecast: 90F/65F (Sunny)
   #
   #  < user> ~conditions Los Angeles, CA
-  #  < botbckt> Conditions -
   #  < botbckt> Today: Areas of low clouds in the morning then mostly sunny. Highs in the upper 60s to mid 70s. West winds 10 to 20 mph in the afternoon.
   #  < botbckt> Tonight: Mostly clear. Lows in the mid to upper 50s. West winds 10 to 20 mph in the evening.
   #
@@ -37,7 +36,7 @@ module Botbckt #:nodoc:
       daytime = (xml/'forecastday[1]')
       evening = (xml/'forecastday[2]')
       
-      "Conditions -\nToday: #{(daytime/'fcttext').inner_html}\nTonight: #{(evening/'fcttext').inner_html}"
+      "Today: #{(daytime/'fcttext').inner_html}\nTonight: #{(evening/'fcttext').inner_html}"
     end
     
     def self.forecast(query) #:nodoc:

data/lib/botbckt/irc.rb

@@ -4,7 +4,6 @@ module Botbckt #:nodoc:
   #
   class IRC < EventMachine::Connection
     include EventMachine::Protocols::LineText2
-    include ActiveSupport::BufferedLogger::Severity
     
     attr_accessor :config
     cattr_accessor :connection
@@ -20,8 +19,6 @@ module Botbckt #:nodoc:
     # :server<String>:: The FQDN of the IRC server. Required.
     # :port<~to_i>:: The port number of the IRC server. Required.
     # :channels<Array[String]>:: An array of channels to join. Channel names should *not* include the '#' prefix. Required.
-    # :log<String>:: The name of a log file. Defaults to 'botbckt.log'.
-    # :log_level<Integer>:: The minimum severity level to log. Defaults to 1 (INFO).
     #
     def self.connect(options)
       self.connection = EM.connect(options[:server], options[:port].to_i, self, options)
@@ -34,9 +31,6 @@ module Botbckt #:nodoc:
     #++
     def initialize(options) #:nodoc:
       self.config = OpenStruct.new(options)
-      
-      @logger = ActiveSupport::BufferedLogger.new self.config.log || 'botbckt.log',
-                                                  self.config.log_level || INFO
     end
     
     # ==== Parameters
@@ -66,7 +60,7 @@ module Botbckt #:nodoc:
         args << $5.squish if $5
         
          # run args: command, sender, channel, optional args
-        Botbckt::Bot.run($4, *args)
+        Botbckt::Bot.instance.run($4, *args)
       else
         log line
       end
@@ -81,8 +75,8 @@ module Botbckt #:nodoc:
     
     private
 
-    def log(msg, level = INFO) #:nodoc:
-      @logger.add(level, msg)
+    def log(msg, level = Botbckt::Bot::INFO) #:nodoc:
+      Botbckt::Bot.instance.log msg, level
     end
     
     def command(*cmd) #:nodoc:

data/lib/botbckt/store.rb

@@ -0,0 +1,33 @@
+require 'em-redis'
+
+module Botbckt #:nodoc:
+  
+  # Implements a basic key/value store API for cross-session state storage.
+  #
+  # Currently, this class is Redis-backed, but any key/value store could be
+  # supported, in theory.
+  #
+  class Store
+    
+    attr_accessor :backend
+    
+    def initialize(host, port)
+      self.backend = EventMachine::Protocols::Redis.connect(host, port)
+    end
+    
+    def set(key, value, &block)
+      backend.set(key, value, &block)
+    end
+    
+    def get(key, &block)
+      backend.get(key, &block)
+    end
+    
+    def increment!(key, &block)
+      backend.incr(key, &block)
+    end
+    
+  end
+  
+end
+    

data/lib/botbckt.rb

@@ -1,3 +1,3 @@
-%w{ rubygems eventmachine activesupport ostruct json open-uri cgi hpricot }.each { |lib| require lib }
-%w{ irc bot utilities command }.each { |lib| require File.dirname(__FILE__) + "/botbckt/#{ lib }" }
+%w{ rubygems eventmachine activesupport ostruct json open-uri cgi hpricot singleton optparse }.each { |lib| require lib }
+%w{ irc store bot utilities command cmd }.each { |lib| require File.dirname(__FILE__) + "/botbckt/#{ lib }" }
 Dir[File.dirname(__FILE__) + '/botbckt/commands/*'].each { |lib| require lib }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bitbckt-botbckt
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Brandon Mitchell
@@ -9,14 +9,14 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-04 00:00:00 -07:00
-default_executable: 
+date: 2009-06-23 00:00:00 -07:00
+default_executable: botbckt
 dependencies: []
 
 description: Boredom strikes on Sunday mornings.
 email: brandon@systemisdown.net
-executables: []
-
+executables: 
+- botbckt
 extensions: []
 
 extra_rdoc_files: 
@@ -24,9 +24,12 @@ extra_rdoc_files:
 files: 
 - Rakefile
 - VERSION.yml
+- bin/botbckt
 - lib/botbckt.rb
 - lib/botbckt/bot.rb
+- lib/botbckt/cmd.rb
 - lib/botbckt/command.rb
+- lib/botbckt/commands/gooble.rb
 - lib/botbckt/commands/google.rb
 - lib/botbckt/commands/meme.rb
 - lib/botbckt/commands/ping.rb
@@ -36,6 +39,7 @@ files:
 - lib/botbckt/commands/ticker.rb
 - lib/botbckt/commands/weather.rb
 - lib/botbckt/irc.rb
+- lib/botbckt/store.rb
 - lib/botbckt/utilities.rb
 - README
 has_rdoc: true