bitbckt-botbckt 0.2.0 → 0.3.0

data/VERSION.yml

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

data/lib/botbckt/bot.rb

@@ -36,8 +36,15 @@ module Botbckt #:nodoc:
     # TODO: Before/after callbacks?
     #++
     def self.run(command, sender, channel, *args)
-      proc = self.commands[command.to_sym]
-      proc ? proc.call(sender, channel, *args) : say(befuddled, channel)
+      callable = self.commands[command.to_sym]
+      
+      if callable.is_a?(Class)
+        # Callables are Singletons; we use #create! as a convention to give
+        # possible setup code a place to live. 
+        callable = callable.create!(sender, channel, *args)
+      end
+      
+      callable.respond_to?(:call) ? callable.call(sender, channel, *args) : say(befuddled, channel)
     end
     
     # Returns a random "affirmative" message. Use to acknowledge user input.

data/lib/botbckt/command.rb

@@ -0,0 +1,63 @@
+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.
+  #
+  # Command subclasses must (re-)define initialize and call.
+  #
+  class Command
+    include Utilities
+    include Singleton
+    
+    # By default, returns the singleton instance. Override in a subclass if
+    # a different behavior is expected.
+    #
+    # ==== Parameters (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 self.create!(*args)
+      self.instance
+    end
+
+    # This method is executed by the Bot when a command is triggered. Override
+    # it in a subclass to get the behavior you want.
+    #
+    # ==== Parameters (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 call(*args)
+      raise NoMethodError, "Implement #call in a subclass."
+    end
+    
+    # Registers a new command with the bot.
+    #
+    # ==== Parameters
+    # command<Symbol>:: In-channel trigger for the command. Required.
+    #
+    def self.trigger(command, &block)
+      Botbckt::Bot.commands[command.to_sym] = block_given? ? block : self
+    end
+    
+    # ==== Parameters
+    # msg<String>:: A message to send to the channel. Required.
+    # channel<String>:: The channel to send the message. Required.
+    #
+    def self.say(msg, channel)
+      Botbckt::Bot.say(msg, channel) if msg
+    end
+    
+    # Proxy for Command.say
+    #
+    def say(msg, channel)
+      self.class.say(msg, channel)
+    end
+    
+  end
+  
+end

data/lib/botbckt/commands/google.rb

@@ -9,10 +9,11 @@ module Botbckt #:nodoc:
   #
   # Inspired by Clojurebot: http://github.com/hiredman/clojurebot
   #
-  class Google
-    extend Commands
+  class Google < Command
   
-    on :google do |sender, channel, query|
+    trigger :google
+    
+    def call(sender, channel, query)
       result = google(query)
       say "First out of #{result.first} results:", channel
       say result.last['titleNoFormatting'], channel
@@ -21,7 +22,7 @@ module Botbckt #:nodoc:
   
     private
   
-    def self.google(term) #:nodoc:
+    def google(term) #:nodoc:
       json     = open("http://ajax.googleapis.com/ajax/services/search/web?v=1.0&q=#{CGI.escape(term)}")
       response = JSON.parse(json.read)
 

data/lib/botbckt/commands/meme.rb

@@ -5,16 +5,17 @@ module Botbckt #:nodoc:
   #  < user> ~meme
   #  < botbckt> THIS IS LARGE. I CAN TELL BY THE DRINKS, AND FROM HAVING SEEN A LOT OF DRAGONS IN MY DAY.
   #
-  class Meme
-    extend Commands
+  class Meme < Command
     
-    on :meme do |sender, channel, *args|
+    trigger :meme
+
+    def call(sender, channel, *args)
       say meme, channel
     end
    
    private
    
-   def self.meme #:nodoc:
+   def meme #:nodoc:
      open("http://meme.boxofjunk.ws/moar.txt?lines=1").read.chomp
    end
     

data/lib/botbckt/commands/ping.rb

@@ -2,10 +2,11 @@ module Botbckt #:nodoc:
 
   # Returns 'PONG!' in-channel
   #
-  class Ping
-    extend Commands
+  class Ping < Command
     
-    on :ping do |sender, channel, *args|
+    trigger :ping
+
+    def call(sender, channel, *args)
       say 'PONG!', channel
     end
   end

data/lib/botbckt/commands/remind.rb

@@ -7,12 +7,13 @@ module Botbckt #:nodoc:
   #  ... five minutes
   #  < botbckt> user: message
   #
-  class Remind
-    extend Commands
+  class Remind < Command
 
     SCALES = %w{ minute minutes second seconds hour hours }
 
-    on :remind do |user, channel, reminder_string|
+    trigger :remind
+    
+    def call(user, channel, reminder_string)
       # Somewhat faster than #match...
       reminder_string =~ /in (\d+) (\w+) with (.*)/i
       num, scale, msg = $1, $2, $3
@@ -20,8 +21,7 @@ module Botbckt #:nodoc:
       if SCALES.include?(scale)
       	time = num.to_i.send(scale.to_sym).seconds
 
-        # TODO: Abstraction here, please.
-      	remind(user.gsub(/([^!]+).*/, '\1'), channel, msg, time)
+      	remind(freenode_split(user).first, channel, msg, time)
       else 
         say Botbckt::Bot.befuddled, channel
       end
@@ -29,7 +29,7 @@ module Botbckt #:nodoc:
     
     private
     
-    def self.remind(user, channel, msg, seconds) #:nodoc:
+    def remind(user, channel, msg, seconds) #:nodoc:
       EventMachine::Timer.new(seconds) do
         say "#{user}: #{msg}", channel
       end

data/lib/botbckt/commands/snack.rb

@@ -4,10 +4,11 @@ module Botbckt #:nodoc:
   #
   # Inspired by Clojurebot: http://github.com/hiredman/clojurebot
   #
-  class Snack
-    extend Commands
+  class Snack < Command
     
-    on :botsnack do |sender, channel, *args|
+    trigger :botsnack
+
+    def call(sender, channel, *args)
       say 'nom nom nom', channel
     end
     

data/lib/botbckt/commands/star_jar.rb

@@ -0,0 +1,62 @@
+module Botbckt #:nodoc:
+  
+  # Gives a gold star to a space-separated list of users.
+  #
+  #  < user> ~star joe
+  #  < botbckt> joe: Gold star for you!
+  #
+  # But when a user tries to award himself...
+  #
+  #  < user> ~star user
+  #  < botbckt> user: No star for you!
+  #
+  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
+    end
+    
+    # Removes a star from the jar for the user
+    #
+    # ==== Parameters
+    # user<String>:: The user being docked a star. Required.
+    #
+    def pop(user)
+      @jar[user] ||= 0
+      
+      if @jar[user] == 0
+        return 0
+      else
+        @jar[user] -= 1
+      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
+        else
+          say "#{rcv}: No star for you!", channel
+        end
+      end
+    end
+    
+  end
+  
+end

data/lib/botbckt/commands/ticker.rb

@@ -6,24 +6,28 @@ module Botbckt #:nodoc:
   #  < user> ~ticker GOOG
   #  < botbckt> GOOG - $391.06 (+0.06)
   #
-  class Ticker
-    extend Commands
+  class Ticker < Command
     
-    on :ticker do |sender, channel, symbol|
-      stock_price symbol, channel
+    trigger :ticker
+    
+    def call(sender, channel, symbol)
+      begin
+        say stock_price(symbol.split(' ').first), channel
+      # TODO: Log me.
+      rescue OpenURI::HTTPError => e
+        say Botbckt::Bot.befuddled, channel
+      end
     end
     
     private
     
-    def self.stock_price(symbol, channel) #:nodoc:
+    def stock_price(symbol) #: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']
       
-      say "#{ticker} - $#{price} (#{change})", channel
-    rescue OpenURI::HTTPError => e
-      say Botbckt::Bot.befuddled, channel
+      "#{ticker} - $#{price} (#{change})"
     end
   end
   

data/lib/botbckt/commands/weather.rb

@@ -0,0 +1,56 @@
+module Botbckt #:nodoc:
+  
+  # Displays a simple forecast or a prosaic description of today's conditions.
+  #
+  #  < user> ~forecast 90210
+  #  < 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.
+  #
+  class Weather < Command
+    
+    trigger :forecast do |sender, channel, query|
+      begin
+        say forecast(query), channel
+      # TODO: Log me.
+      rescue OpenURI::HTTPError => e
+        say Botbckt::Bot.befuddled, channel
+      end
+    end
+    
+    trigger :conditions do |sender, channel, query|
+      begin
+        say conditions(query), channel
+      # TODO: Log me.
+      rescue OpenURI::HTTPError => e
+        say Botbckt::Bot.befuddled, channel
+      end
+    end
+    
+    private
+    
+    def self.conditions(query) #:nodoc:
+      xml     = (search(query)/'txt_forecast')
+      daytime = (xml/'forecastday[1]')
+      evening = (xml/'forecastday[2]')
+      
+      "Conditions -\nToday: #{(daytime/'fcttext').inner_html}\nTonight: #{(evening/'fcttext').inner_html}"
+    end
+    
+    def self.forecast(query) #:nodoc:
+      xml = (search(query)/'simpleforecast/forecastday[1]')
+      
+      "Today's Forecast: #{(xml/'high/fahrenheit').inner_html}F/#{(xml/'low/fahrenheit').inner_html}F (#{(xml/'conditions').inner_html})"
+    end
+    
+    def self.search(query) #:nodoc:
+      xml = open("http://api.wunderground.com/auto/wui/geo/ForecastXML/index.xml?query=#{CGI.escape(query)}")
+      Hpricot.XML(xml)
+    end
+    
+  end
+  
+end

data/lib/botbckt/utilities.rb

@@ -0,0 +1,16 @@
+module Botbckt #:nodoc:
+  
+  module Utilities
+   
+    # Splits a Freenode user string into a login, user, hostmask tuple
+    #
+    # ==== Parameters
+    # str<String>:: The user string to split
+    #
+    def freenode_split(str)
+      str.scan(/^([^!]+)!n=([^@]+)@(.*)$/).flatten!
+    end
+    
+  end
+  
+end

data/lib/botbckt.rb

@@ -1,4 +1,3 @@
-%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']
+%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 }" }
+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.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Brandon Mitchell
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-28 00:00:00 -07:00
+date: 2009-05-04 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -26,14 +26,17 @@ files:
 - VERSION.yml
 - lib/botbckt.rb
 - lib/botbckt/bot.rb
-- lib/botbckt/commands.rb
+- lib/botbckt/command.rb
 - lib/botbckt/commands/google.rb
 - lib/botbckt/commands/meme.rb
 - lib/botbckt/commands/ping.rb
 - lib/botbckt/commands/remind.rb
 - lib/botbckt/commands/snack.rb
+- lib/botbckt/commands/star_jar.rb
 - lib/botbckt/commands/ticker.rb
+- lib/botbckt/commands/weather.rb
 - lib/botbckt/irc.rb
+- lib/botbckt/utilities.rb
 - README
 has_rdoc: true
 homepage: http://github.com/bitbckt/botbckt

data/lib/botbckt/commands.rb

@@ -1,39 +0,0 @@
-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.
-  #
-  module Commands
-    
-    # Registers a new command with the bot. Either a proc or a block are
-    # required.
-    #
-    # Inspired by Isaac: http://github.com/ichverstehe/isaac
-    #
-    # ==== Parameters
-    # command<Symbol>:: In-channel trigger for the command. Required.
-    # 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. Required.
-    # channel<String>:: The channel to send the message. Required.
-    #
-    def say(msg, channel)
-      Botbckt::Bot.say(msg, channel) if msg
-    end
-    
-  end
-  
-end
-
-Dir[File.dirname(__FILE__) + '/commands/*'].each { |lib| require lib }