bitbckt-botbckt 0.4.0 → 0.4.2

data/Rakefile

@@ -15,6 +15,12 @@ begin
     g.homepage    = 'http://github.com/bitbckt/botbckt'
     g.description = 'Boredom strikes on Sunday mornings.'
     g.authors     = ['Brandon Mitchell']
+    g.executables << 'botbckt'
+    g.add_dependency('eventmachine', '>= 0.12.0')
+    g.add_dependency('activesupport')
+    g.add_dependency('json', '>= 1.1.2')
+    g.add_dependency('hpricot', '>= 0.6')
+    g.add_dependency('em-redis', '>= 0.1.1')
   end
 rescue LoadError
   puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"

data/VERSION.yml

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

data/lib/botbckt/bot.rb

@@ -11,6 +11,7 @@ module Botbckt #:nodoc:
 
     attr_accessor :logger
     attr_accessor :store
+    attr_accessor :connection
     
     # ==== Parameters
     # options<Hash{Symbol => String,Integer}>
@@ -29,32 +30,21 @@ module Botbckt #:nodoc:
     # :backend_port<Integer>:: The port used by the Redis store. Optional.
     #
     def self.start(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
+          start!
           
           if pid
-            File.open(pid, 'w'){ |f| f.write("#{Process.pid}") }
+            File.open(pid, 'w') { |file| file.write("#{Process.pid}") }
             at_exit { File.delete(pid) if File.exist?(pid) }
           end
           
         end
       else
-        EventMachine::run do
-          Botbckt::IRC.connect(options)
-        end
+        EventMachine::run { start! }
       end
     end
     
@@ -75,6 +65,14 @@ module Botbckt #:nodoc:
       @commands
     end
     
+    # Sets the key to the given value, creating the key if necessary.
+    #
+    # ==== Parameters
+    # key<String>:: The identifier for this value. Required.
+    # value<Object>:: The value to store at the key. Required.
+    # &block:: A callback to execute after the value is stored. The block should
+    #          take a single parameter: the value stored. Optional.
+    #
     #--
     # TODO: Forwardable?
     #++
@@ -82,6 +80,13 @@ module Botbckt #:nodoc:
       self.store && self.store.set(key, value, &block)
     end
     
+    # Retrieves the value stored at key. Returns nil if the key does not exist.
+    #
+    # ==== Parameters
+    # key<String>:: The identifier to retrieve. Required.
+    # &block:: A callback to execute after the value is retrieved. The block should
+    #          take a single parameter: the value retrieved. Required.
+    #
     #--
     # TODO: Forwardable?
     #++
@@ -89,6 +94,14 @@ module Botbckt #:nodoc:
       self.store && self.store.get(key, &block)
     end
     
+    # Increments the value stored at key by 1, creating the key and initializing
+    # it to 0 if necessary.
+    #
+    # ==== Parameters
+    # key<String>:: The identifier whose value should be incremented. Required.
+    # &block:: A callback to execute after the value is stored. The block should
+    #          take a single parameter: the value stored. Optional.
+    #
     #--
     # TODO: Forwardable?
     #++
@@ -106,7 +119,7 @@ module Botbckt #:nodoc:
     # TODO: Before/after callbacks?
     #++
     def run(command, sender, channel, *args)
-      callable = commands[command.to_sym]
+      callable = commands[command.to_sym] || raise("Unregistered command called. (#{command})")
       
       if callable.is_a?(Class)
         # Callables are Singletons; we use #create! as a convention to give
@@ -114,9 +127,14 @@ module Botbckt #:nodoc:
         callable = callable.create!(sender, channel, *args)
       end
       
-      callable.respond_to?(:call) ? callable.call(sender, channel, *args) : say(Bot.befuddled, channel)
-    # TODO: Log me.
-    rescue StandardError => e
+      if callable.respond_to?(:call)
+        callable.call(sender, channel, *args)
+      else
+        raise("Non-callable used as command. (#{command})")
+      end
+
+    rescue StandardError => error
+      log "ERROR:\n#{error.inspect}\n#{error.backtrace}", DEBUG
       say Bot.befuddled, channel
     end
     
@@ -140,17 +158,36 @@ module Botbckt #:nodoc:
     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, channel)
-      Botbckt::IRC.connection.say msg, channel
+      self.connection.say msg, channel
     end
 
-    def log(msg, level = INFO) #:nodoc:
+    # ==== Parameters
+    # msg<String>:: A message to log. Required.
+    # level<Integer>:: The minimum log level at which to log this message. Defaults to INFO.
+    #
+    def log(msg, level = INFO)
       self.logger.add(level, msg)
     end
     
+    private
+    
+    def self.start!(options) #:nodoc:
+      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)
+      
+      if host && port
+        self.instance.store = Store.new(host, port)
+      end
+      
+      self.instance.connection = Botbckt::IRC.connect(options.merge(:bot => self.instance))   
+    end
+    
   end
 
 end

data/lib/botbckt/cmd.rb

@@ -1,6 +1,6 @@
 module Botbckt #:nodoc:
   
-  class Cmd
+  class Cmd #:nodoc:
     
     SEVERITY = %w{0 1 2 3 4 5}
     SEVERITY_ALIASES = { "DEBUG" => 0, "INFO" => 1, "WARN" => 2, "ERROR" => 3, "FATAL" => 4, "UNKNOWN" => 5}

data/lib/botbckt/command.rb

@@ -49,7 +49,7 @@ module Botbckt #:nodoc:
     # channel<String>:: The channel to send the message. Required.
     #
     def self.say(msg, channel)
-      Botbckt::Bot.instance.say(msg, channel) if msg
+      Botbckt::Bot.instance.say(msg, channel)
     end
     
     # Proxy for Command.say
@@ -58,14 +58,37 @@ module Botbckt #:nodoc:
       self.class.say(msg, channel)
     end
     
+    # Sets the key to the given value, creating the key if necessary.
+    #
+    # ==== Parameters
+    # key<String>:: The identifier for this value. Required.
+    # value<Object>:: The value to store at the key. Required.
+    # &block:: A callback to execute after the value is stored. The block should
+    #          take a single parameter: the value stored. Optional.
+    #
     def set(key, value, &block)
       Botbckt::Bot.instance.set(key, value, &block)
     end
     
+    # Retrieves the value stored at key. Returns nil if the key does not exist.
+    #
+    # ==== Parameters
+    # key<String>:: The identifier to retrieve. Required.
+    # &block:: A callback to execute after the value is retrieved. The block should
+    #          take a single parameter: the value retrieved. Required.
+    #
     def get(key, &block)
       Botbckt::Bot.instance.get(key, &block)
     end
     
+    # Increments the value stored at key by 1, creating the key and initializing
+    # it to 0 if necessary.
+    #
+    # ==== Parameters
+    # key<String>:: The identifier whose value should be incremented. Required.
+    # &block:: A callback to execute after the value is stored. The block should
+    #          take a single parameter: the value stored. Optional.
+    #
     def increment!(key, &block)
       Botbckt::Bot.instance.increment!(key, &block)
     end

data/lib/botbckt/irc.rb

@@ -60,7 +60,7 @@ module Botbckt #:nodoc:
         args << $5.squish if $5
         
          # run args: command, sender, channel, optional args
-        Botbckt::Bot.instance.run($4, *args)
+        self.config.bot.run($4, *args)
       else
         log line
       end
@@ -76,7 +76,7 @@ module Botbckt #:nodoc:
     private
 
     def log(msg, level = Botbckt::Bot::INFO) #:nodoc:
-      Botbckt::Bot.instance.log msg, level
+      self.config.bot.log msg, level
     end
     
     def command(*cmd) #:nodoc:

data/lib/botbckt/store.rb

@@ -1,5 +1,3 @@
-require 'em-redis'
-
 module Botbckt #:nodoc:
   
   # Implements a basic key/value store API for cross-session state storage.
@@ -11,18 +9,46 @@ module Botbckt #:nodoc:
     
     attr_accessor :backend
     
+    # ==== Parameters
+    # host<String>:: IP address or hostname of the Redis server. Required.
+    # port<Integer>:: Port the Redis server is listening on. Required.
+    #
     def initialize(host, port)
       self.backend = EventMachine::Protocols::Redis.connect(host, port)
     end
     
+    # Sets the key to the given value, creating the key if necessary.
+    #
+    # ==== Parameters
+    # key<String>:: The identifier for this value. Required.
+    # value<Object>:: The value to store at the key. Required.
+    # &block:: A callback to execute after the value is stored. The block should
+    #          take a single parameter: the value stored. Optional.
+    #
     def set(key, value, &block)
       backend.set(key, value, &block)
     end
-    
+
+    # Retrieves the value stored at key. Returns nil if the key does not exist.
+    #
+    # ==== Parameters
+    # key<String>:: The identifier to retrieve. Required.
+    # &block:: A callback to execute after the value is retrieved. The block should
+    #          take a single parameter: the value retrieved. Required.
+    #
     def get(key, &block)
+      return unless block_given?
       backend.get(key, &block)
     end
     
+    # Increments the value stored at key by 1, creating the key and initializing
+    # it to 0 if necessary.
+    #
+    # ==== Parameters
+    # key<String>:: The identifier whose value should be incremented. Required.
+    # &block:: A callback to execute after the value is stored. The block should
+    #          take a single parameter: the value stored. Optional.
+    #
     def increment!(key, &block)
       backend.incr(key, &block)
     end

data/lib/botbckt.rb

@@ -1,3 +1,3 @@
-%w{ rubygems eventmachine activesupport ostruct json open-uri cgi hpricot singleton optparse }.each { |lib| require lib }
+%w{ rubygems eventmachine activesupport ostruct json open-uri cgi hpricot singleton optparse em-redis }.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.4.0
+  version: 0.4.2
 platform: ruby
 authors: 
 - Brandon Mitchell
@@ -9,14 +9,64 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-23 00:00:00 -07:00
-default_executable: botbckt
-dependencies: []
-
+date: 2009-06-24 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: eventmachine
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.12.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hpricot
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0.6"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: em-redis
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.1
+    version: 
 description: Boredom strikes on Sunday mornings.
 email: brandon@systemisdown.net
 executables: 
 - botbckt
+- botbckt
 extensions: []
 
 extra_rdoc_files: