bitbckt-botbckt 0.1.1 → 0.2.0

data/VERSION.yml

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

data/lib/botbckt/bot.rb

@@ -20,6 +20,7 @@ module Botbckt #:nodoc:
     # :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.start(options)
       EventMachine::run do
@@ -34,9 +35,9 @@ module Botbckt #:nodoc:
     #--
     # TODO: Before/after callbacks?
     #++
-    def self.run(command, *args)
+    def self.run(command, sender, channel, *args)
       proc = self.commands[command.to_sym]
-      proc ? proc.call(*args) : say(befuddled)
+      proc ? proc.call(sender, channel, *args) : say(befuddled, channel)
     end
     
     # Returns a random "affirmative" message. Use to acknowledge user input.
@@ -60,9 +61,10 @@ module Botbckt #:nodoc:
     
     # ==== Parameters
     # msg<String>:: A message to send to the channel
+    # channel<String>:: The channel to send the message. Required.
     #
-    def self.say(msg)
-      Botbckt::IRC.connection.say msg
+    def self.say(msg, channel)
+      Botbckt::IRC.connection.say msg, channel
     end
     
   end

data/lib/botbckt/commands/google.rb

@@ -12,11 +12,11 @@ module Botbckt #:nodoc:
   class Google
     extend Commands
   
-    on :google do |query, *args|
+    on :google do |sender, channel, query|
       result = google(query)
-      say "First out of #{result.first} results:"
-      say result.last['titleNoFormatting']
-      say result.last['unescapedUrl']
+      say "First out of #{result.first} results:", channel
+      say result.last['titleNoFormatting'], channel
+      say result.last['unescapedUrl'], channel
     end
   
     private

data/lib/botbckt/commands/meme.rb

@@ -8,8 +8,8 @@ module Botbckt #:nodoc:
   class Meme
     extend Commands
     
-    on :meme do |*args|
-      say meme
+    on :meme do |sender, channel, *args|
+      say meme, channel
     end
    
    private

data/lib/botbckt/commands/ping.rb

@@ -5,8 +5,8 @@ module Botbckt #:nodoc:
   class Ping
     extend Commands
     
-    on :ping do |*args|
-      say 'PONG!'
+    on :ping do |sender, channel, *args|
+      say 'PONG!', channel
     end
   end
   

data/lib/botbckt/commands/remind.rb

@@ -12,7 +12,7 @@ module Botbckt #:nodoc:
 
     SCALES = %w{ minute minutes second seconds hour hours }
 
-    on :remind do |reminder_string, user, *args|
+    on :remind do |user, channel, reminder_string|
       # Somewhat faster than #match...
       reminder_string =~ /in (\d+) (\w+) with (.*)/i
       num, scale, msg = $1, $2, $3
@@ -21,19 +21,19 @@ module Botbckt #:nodoc:
       	time = num.to_i.send(scale.to_sym).seconds
 
         # TODO: Abstraction here, please.
-      	remind(user.gsub(/([^!]+).*/, '\1'), msg, time)
+      	remind(user.gsub(/([^!]+).*/, '\1'), channel, msg, time)
       else 
-        say Botbckt::Bot.befuddled
+        say Botbckt::Bot.befuddled, channel
       end
     end
     
     private
     
-    def self.remind(user, msg, seconds) #:nodoc:
+    def self.remind(user, channel, msg, seconds) #:nodoc:
       EventMachine::Timer.new(seconds) do
-        say "#{user}: #{msg}"
+        say "#{user}: #{msg}", channel
       end
-      say Botbckt::Bot.ok
+      say Botbckt::Bot.ok, channel
     end
     
   end

data/lib/botbckt/commands/snack.rb

@@ -7,8 +7,8 @@ module Botbckt #:nodoc:
   class Snack
     extend Commands
     
-    on :botsnack do |*args|
-      say 'nom nom nom'
+    on :botsnack do |sender, channel, *args|
+      say 'nom nom nom', channel
     end
     
   end

data/lib/botbckt/commands/ticker.rb

@@ -9,22 +9,21 @@ module Botbckt #:nodoc:
   class Ticker
     extend Commands
     
-    on :ticker do |symbol, *args|
-      say stock_price(symbol)
+    on :ticker do |sender, channel, symbol|
+      stock_price symbol, channel
     end
     
     private
     
-    def self.stock_price(symbol) #:nodoc:
+    def self.stock_price(symbol, channel) #:nodoc:
       json     = open("http://www.google.com/finance/info?q=#{CGI.escape(symbol)}")
       response = JSON.parse(json.read[4..-1]).first
       
       ticker, price, change = response['t'], response['l'], response['c']
       
-      "#{ticker} - $#{price} (#{change})"
+      say "#{ticker} - $#{price} (#{change})", channel
     rescue OpenURI::HTTPError => e
-      say Botbckt::Bot.befuddled
-      nil
+      say Botbckt::Bot.befuddled, channel
     end
   end
   

data/lib/botbckt/commands.rb

@@ -15,15 +15,21 @@ module Botbckt #:nodoc:
     # proc<Proc>:: Proc to execute when the command is triggered.
     # &block:: Block to execute when the command is triggered.
     #
+    # ==== Callable args
+    # sender<String>:: The user and host of the triggering user. Example: botbckt!n=botbckt@unaffiliated/botbckt
+    # channel<String>:: The channel on which the command was triggered. Example: #ruby-lang
+    # *args:: Any string following the trigger in the message
+    #
     def on(command, proc = nil, &block)
       Botbckt::Bot.commands[command.to_sym] = proc || block
     end
     
     # ==== Parameters
-    # msg<String>:: A message to send to the channel
+    # msg<String>:: A message to send to the channel. Required.
+    # channel<String>:: The channel to send the message. Required.
     #
-    def say(msg)
-      Botbckt::Bot.say(msg) if msg
+    def say(msg, channel)
+      Botbckt::Bot.say(msg, channel) if msg
     end
     
   end

data/lib/botbckt/irc.rb

@@ -4,6 +4,7 @@ module Botbckt #:nodoc:
   #
   class IRC < EventMachine::Connection
     include EventMachine::Protocols::LineText2
+    include ActiveSupport::BufferedLogger::Severity
     
     attr_accessor :config
     cattr_accessor :connection
@@ -20,6 +21,7 @@ module Botbckt #:nodoc:
     # :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)
@@ -27,25 +29,26 @@ module Botbckt #:nodoc:
     
     # Use IRC.connect; this method is not for you.
     #
+    #--
+    # TODO: Ensure options[:channels] is always an Array
+    #++
     def initialize(options) #:nodoc:
       self.config = OpenStruct.new(options)
       
-      @logger = ActiveSupport::BufferedLogger.new(self.config.log || 'botbckt.log')
+      @logger = ActiveSupport::BufferedLogger.new self.config.log || 'botbckt.log',
+                                                  self.config.log_level || INFO
     end
     
     # ==== Parameters
-    # msg<String>:: A message to send to the channel
+    # msg<String>:: A message to send to the channel. Required.
+    # channel<String>:: The channel to send the message. Required.
     #
-    #--
-    # TODO: Handle multiple channels
-    #++
-    def say(msg)
+    def say(msg, channel)
       msg.split("\n").each do |msg|
-        command "PRIVMSG", "##{config.channels.first}", ":#{msg}"
+        command "PRIVMSG", "##{channel}", ":#{msg}"
       end
     end
     
-    
     def post_init #:nodoc:
       command "USER", [config.user]*4
       command "NICK", config.user
@@ -53,19 +56,16 @@ module Botbckt #:nodoc:
       config.channels.each { |channel| command("JOIN", "##{ channel }")  } if config.channels
     end
 
-    #--
-    # FIXME: Re-order commands args such that 1-2 arity commands can still access
-    #        both sender and channel
-    #++
     def receive_line(line) #:nodoc:
       case line
       when /^PING (.*)/:
         command('PONG', $1)
-      when /^:(\S+) PRIVMSG (.*) :(~|#{Regexp.escape config.user}: )(\w+)( .*)?$/:
+      when /^:(\S+) PRIVMSG #(.*) :(~|#{Regexp.escape config.user}: )(\w+)( .*)?$/:
         # args are optional - not all commands need/support them
-        args = $5 ? [$5.squish, $1, $2] : [$1, $2]
+        args = [$1, $2]
+        args << $5.squish if $5
         
-         # run args: command (with args), sender, channel
+         # run args: command, sender, channel, optional args
         Botbckt::Bot.run($4, *args)
       else
         log line
@@ -80,12 +80,9 @@ module Botbckt #:nodoc:
     end
     
     private
-    
-    #--
-    # TODO: Add log levels
-    #++
-    def log(msg) #:nodoc:
-      @logger.add(0, msg)
+
+    def log(msg, level = INFO) #:nodoc:
+      @logger.add(level, msg)
     end
     
     def command(*cmd) #:nodoc:

data/lib/botbckt.rb

@@ -1,2 +1,4 @@
 %w{ rubygems eventmachine activesupport ostruct json open-uri cgi }.each { |lib| require lib }
 %w{ irc bot commands }.each { |lib| require File.dirname(__FILE__) + "/botbckt/#{ lib }" }
+
+Botbckt::Bot.start :user => 'botbckt', :server => 'irc.freenode.net', :port => 6667, :channels => ['reno.rb']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bitbckt-botbckt
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors: 
 - Brandon Mitchell
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-27 00:00:00 -07:00
+date: 2009-04-28 00:00:00 -07:00
 default_executable: 
 dependencies: []