bitbckt-botbckt 0.1.0

data/README

@@ -0,0 +1,3 @@
+Boredom strikes on Sunday mornings.
+
+Released under the MIT license. Google it.

data/Rakefile

@@ -0,0 +1,21 @@
+require 'rake/rdoctask'
+
+Rake::RDocTask.new do |rd|
+  rd.main     = 'README'
+  rd.rdoc_dir = 'doc'
+  rd.rdoc_files.include('README', 'lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |g|
+    g.name        = 'botbckt'
+    g.summary     = 'Boredom strikes on Sunday mornings.'
+    g.email       = 'brandon@systemisdown.net'
+    g.homepage    = 'http://github.com/bitbckt/botbckt'
+    g.description = 'Boredom strikes on Sunday mornings.'
+    g.authors     = ['Brandon Mitchell']
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION.yml

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

data/lib/botbckt/bot.rb

@@ -0,0 +1,70 @@
+module Botbckt #:nodoc:
+  
+  # Create a new IRC bot. See Bot.start to get started.
+  #
+  class Bot
+    
+    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 = { }
+    
+    # ==== Parameters
+    # options<Hash{Symbol => String,Integer}>
+    #
+    # ==== Options (options)
+    # :user<String>:: The username this instance should use. Required.
+    # :password<String>:: A password to send to the Nickserv. Optional.
+    # :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'.
+    #
+    def self.start(options)
+      EventMachine::run do
+        Botbckt::IRC.connect(options)
+      end
+    end
+    
+    # ==== Parameters
+    # command<Symbol>:: The name of a registered command to run. Required.
+    # *args:: Arguments to be passed to the command. Optional.
+    #
+    #--
+    # TODO: Before/after callbacks?
+    #++
+    def self.run(command, *args)
+      proc = self.commands[command.to_sym]
+      proc ? proc.call(*args) : say(befuddled)
+    end
+    
+    # Returns a random "affirmative" message. Use to acknowledge user input.
+    #
+    #--
+    # Inspired by Clojurebot: http://github.com/hiredman/clojurebot
+    #++
+    def self.ok
+      AFFIRMATIVE[rand(AFFIRMATIVE.size)]
+    end
+    
+    # Returns a random "confused" message. Use as a kind of "method missing"
+    # on unknown user input.
+    #
+    #--
+    # Inspired by Clojurebot: http://github.com/hiredman/clojurebot
+    #++
+    def self.befuddled
+      NEGATIVE[rand(NEGATIVE.size)]
+    end
+    
+    # ==== Parameters
+    # msg<String>:: A message to send to the channel
+    #
+    def self.say(msg)
+      Botbckt::IRC.connection.say msg
+    end
+    
+  end
+
+end

data/lib/botbckt/commands/google.rb

@@ -0,0 +1,35 @@
+module Botbckt #:nodoc:
+
+  # Sends a query to Google via the JSON API and returns output in-channel:
+  #
+  #  < user> ~google ruby
+  #  < botbckt> First out of 93900000 results:
+  #  < botbckt> Ruby Programming Language
+  #  < botbckt> http://www.ruby-lang.org/
+  #
+  # Inspired by Clojurebot: http://github.com/hiredman/clojurebot
+  #
+  class Google
+    extend Commands
+  
+    on :google do |query, *args|
+      result = google(query)
+      say "First out of #{result.first} results:"
+      say result.last['titleNoFormatting']
+      say result.last['unescapedUrl']
+    end
+  
+    private
+  
+    def self.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)
+
+      [
+        response['responseData']['cursor']['estimatedResultCount'],
+        response['responseData']['results'].first
+      ]
+    end
+
+  end
+end

data/lib/botbckt/commands/meme.rb

@@ -0,0 +1,23 @@
+module Botbckt #:nodoc:
+  
+  # Grabs the first boxofjunk meme and returns output in-channel:
+  #
+  #  < 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
+    
+    on :meme do |*args|
+      say meme
+    end
+   
+   private
+   
+   def self.meme #:nodoc:
+     open("http://meme.boxofjunk.ws/moar.txt?lines=1").read.chomp
+   end
+    
+  end
+  
+end

data/lib/botbckt/commands/ping.rb

@@ -0,0 +1,13 @@
+module Botbckt #:nodoc:
+
+  # Returns 'PONG!' in-channel
+  #
+  class Ping
+    extend Commands
+    
+    on :ping do |*args|
+      say 'PONG!'
+    end
+  end
+  
+end

data/lib/botbckt/commands/remind.rb

@@ -0,0 +1,41 @@
+module Botbckt #:nodoc:
+
+  # Schedules a reminder for a period of seconds, minutes or hours to be
+  # repeated in-channel:
+  #
+  #  < user> ~remind in 5 minutes with message
+  #  ... five minutes
+  #  < botbckt> user: message
+  #
+  class Remind
+    extend Commands
+
+    SCALES = %w{ minute minutes second seconds hour hours }
+
+    on :remind do |reminder_string, user, *args|
+      # Somewhat faster than #match...
+      reminder_string =~ /in (\d+) (\w+) with (.*)/i
+      num, scale, msg = $1, $2, $3
+      
+      if SCALES.include?(scale)
+      	time = num.to_i.send(scale.to_sym).seconds
+
+        # TODO: Abstraction here, please.
+      	remind(user.gsub(/([^!]+).*/, '\1'), msg, time)
+      else 
+        say Botbckt::Bot.befuddled
+      end
+    end
+    
+    private
+    
+    def self.remind(user, msg, seconds) #:nodoc:
+      EventMachine::Timer.new(seconds) do
+        say "#{user}: #{msg}"
+      end
+      say Botbckt::Bot.ok
+    end
+    
+  end
+  
+end

data/lib/botbckt/commands/snack.rb

@@ -0,0 +1,16 @@
+module Botbckt #:nodoc:
+  
+  # Feeds the bot a tasty treat.
+  #
+  # Inspired by Clojurebot: http://github.com/hiredman/clojurebot
+  #
+  class Snack
+    extend Commands
+    
+    on :botsnack do |*args|
+      say 'nom nom nom'
+    end
+    
+  end
+  
+end

data/lib/botbckt/commands/ticker.rb

@@ -0,0 +1,28 @@
+module Botbckt #:nodoc:
+  
+  # Grabs the current stock price of a symbol from Google Finance and displays
+  # in-channel:
+  #
+  #  < user> ~ticker GOOG
+  #  < botbckt> GOOG - $391.06 (+0.06)
+  #
+  class Ticker
+    extend Commands
+    
+    on :ticker do |symbol, *args|
+      say stock_price(symbol)
+    end
+    
+    private
+    
+    def self.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']
+      
+      "#{ticker} - $#{price} (#{change})"
+    end
+  end
+  
+end

data/lib/botbckt/commands.rb

@@ -0,0 +1,33 @@
+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.
+    #
+    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
+    #
+    def say(msg)
+      Botbckt::Bot.say msg
+    end
+    
+  end
+  
+end
+
+Dir[File.dirname(__FILE__) + '/commands/*'].each { |lib| require lib }

data/lib/botbckt/irc.rb

@@ -0,0 +1,100 @@
+module Botbckt #:nodoc:
+  
+  # An EventMachine-based IRC client. See IRC.connect to get started.
+  #
+  class IRC < EventMachine::Connection
+    include EventMachine::Protocols::LineText2
+    
+    attr_accessor :config
+    cattr_accessor :connection
+    
+    # Instantiate a new IRC connection.
+    #
+    # ==== Parameters
+    # options<Hash{Symbol => String,Integer}>
+    #
+    # ==== Options (options)
+    # :user<String>:: The username this instance should use. Required.
+    # :password<String>:: A password to send to the Nickserv. Optional.
+    # :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'.
+    #
+    def self.connect(options)
+      self.connection = EM.connect(options[:server], options[:port].to_i, self, options)
+    end
+    
+    # Use IRC.connect; this method is not for you.
+    #
+    def initialize(options) #:nodoc:
+      self.config = OpenStruct.new(options)
+      
+      log = config[:log] || 'botbckt.log'
+      @logger = ActiveSupport::BufferedLogger.new(log)
+    end
+    
+    # ==== Parameters
+    # msg<String>:: A message to send to the channel
+    #
+    #--
+    # TODO: Handle multiple channels
+    #++
+    def say(msg)
+      msg.split("\n").each do |msg|
+        command "PRIVMSG", "##{config.channels.first}", ":#{msg}"
+      end
+    end
+    
+    
+    def post_init #:nodoc:
+      command "USER", [config.user]*4
+      command "NICK", config.user
+      command("NickServ IDENTIFY", config.user, config.password) if config.password
+      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+)( .*)?$/:
+        # args are optional - not all commands need/support them
+        args = $5 ? [$5.squish, $1, $2] : [$1, $2]
+        
+         # run args: command (with args), sender, channel
+        Botbckt::Bot.run($4, *args)
+      else
+        log line
+      end
+    end
+
+    def unbind #:nodoc:
+      EM.add_timer(3) do
+        reconnect(config.server, config.port)
+        post_init
+      end
+    end
+    
+    private
+    
+    #--
+    # TODO: Add log levels
+    #++
+    def log(msg) #:nodoc:
+      @logger.add(0, msg)
+    end
+    
+    def command(*cmd) #:nodoc:
+      line = "#{ cmd.flatten.join(' ') }\r\n"
+      send_data line
+      log line
+    end
+    
+  end
+  
+end

data/lib/botbckt.rb

@@ -0,0 +1,2 @@
+%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 }" }

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: bitbckt-botbckt
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Brandon Mitchell
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-26 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Boredom strikes on Sunday mornings.
+email: brandon@systemisdown.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- Rakefile
+- VERSION.yml
+- lib/botbckt.rb
+- lib/botbckt/bot.rb
+- lib/botbckt/commands.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/ticker.rb
+- lib/botbckt/irc.rb
+- README
+has_rdoc: true
+homepage: http://github.com/bitbckt/botbckt
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Boredom strikes on Sunday mornings.
+test_files: []
+