sponge 0.2.9 → 0.3.0

data/README.rdoc

@@ -1,11 +1,20 @@
 == Sponge
 
-Sponge is a simple, lightweight IRC library for Ruby.
+Sponge is a simple, lightweight plugin based IRC bot and IRC library for Ruby.
+See the {wiki}[http://wiki.github.com/injekt/sponge] for more information.
 
 
 == Example
+
+  client = Sponge::IRC::Client.new do
+    server "irc.freenode.org"
+    nickname "MyNick"
+  end
   
-See http://rdoc.injekt.net/sponge/Sponge/IRC/Client.html for a quick example
+  client.run
+
+
+See {Sponge::IRC::Client}[http://rdoc.injekt.net/sponge/Sponge/IRC/Client.html] for more
 
 
 == Notes
@@ -16,7 +25,8 @@ are no specs and it lacks documenation. These will be added soon.
 == Installation
 
   gem install sponge
-  
+
+
 or alternatively you can checkout the latest revision from github
 
   git clone git://github.com/injekt/sponge

data/Rakefile

@@ -3,11 +3,12 @@ require "rake/clean"
 require "rake/gempackagetask"
 require "find"
 require "rake/rdoctask"
+require 'spec/rake/spectask'
 require "lib/sponge/version"
  
 NAME = 'sponge'
 VERSION = Sponge::VERSION
-TITLE = "Sponge: The simple IRC library"
+TITLE = "Sponge: The simple plugin based IRC bot/library"
 CLEAN.include ["*.gem", "doc"]
 RDOC_OPTS = [
   "-U", "--title", TITLE,
@@ -20,23 +21,28 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.add %w(README.rdoc lib/**/*.rb)
 end
 
+desc "Run all specs"
+Spec::Rake::SpecTask.new('spec') do |t|
+  t.spec_files = Dir['spec/**/*.rb']
+end
+
 desc "Package sponge"
-task :package=>[:clean] do |p|
+task :package => [:clean] do |p|
   sh "gem build #{NAME}.gemspec"
 end
 
 desc "Install gem"
-task :install=>[:package] do
+task :install => [:package] do
   sh "sudo gem install ./#{NAME}-#{VERSION} --local"
 end
- 
+
 desc "Uninstall gem"
-task :uninstall=>[:clean] do
+task :uninstall => [:clean] do
   sh "sudo gem uninstall #{NAME}"
 end
- 
+
 desc "Upload gem to gemcutter"
-task :release=>[:package] do
+task :release => [:package] do
   sh "gem push ./#{NAME}-#{VERSION}.gem"
 end
 
@@ -46,8 +52,16 @@ task :version do
 end
 
 desc "Upload rdoc to injekt.net"
-task :upload do
+task :upload => [:clean, :rdoc] do
   sh("scp -rP 2295 doc/* injekt@injekt.net:/var/www/localhost/rdoc.injekt.net/sponge")
 end
 
-task :default => [:clean, :rdoc, :package]
+desc "Report code statistics (KLOCs, etc) from the application"
+task :stats do
+  STATS_DIRECTORIES = [%w(Code lib/), %w(Spec spec)].map{|name, dir| [ name, "./#{dir}" ] }.select { |name, dir| File.directory?(dir)}
+  require "extra/stats"
+  verbose = true
+  CodeStatistics.new(*STATS_DIRECTORIES).to_s
+end
+
+task :default => [:spec]

data/bin/sponge

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+
+begin
+  require 'sponge'
+rescue LoadError
+  require 'rubygems'
+  require 'sponge'
+end
+
+require 'optparse'
+require 'fileutils'
+
+# This doesn't really do much at the moment
+# At some point it should handling running bots
+# but until then... bah
+OptionParser.new do |opts|
+  opts.banner = "Usage: sponge [options]"
+
+  opts.separator ""
+  
+  opts.on("--init NAME", "Create a new directory with NAME and copy the default Sponge proto") do |n|
+    if File.exists?(n)
+      puts "Unable to create proto, file exists.."
+      exit
+    end
+    FileUtils.mkdir(n)
+    path = File.expand_path(n)
+    proto = File.expand_path(Sponge::BASE + '/proto')
+    FileUtils.cp_r Dir[proto + '/**'], path
+  end
+
+  opts.on("-v", "--version", "Return the current version of Sponge") do
+    puts Sponge.version
+    exit
+  end
+end.parse!
+
+

data/lib/proto/plugins/help.rb

@@ -0,0 +1,11 @@
+class Help < Sponge::Plugin
+  
+  def reply(m, arg)
+    if @bot.plugins.has_plugin?(arg)
+      m.reply @bot.plugins.help(arg)
+    else
+      m.reply "Plugin unknown"
+    end
+  end
+  
+end

data/lib/proto/plugins/log.rb

@@ -0,0 +1,8 @@
+class Log < Sponge::Plugin
+  listen_to :privmsg, :join, :part, :quit
+  
+  def listen(message)
+    puts "<#{message.channel}/#{message.nick}> #{message.text}"
+  end
+  
+end

data/lib/proto/plugins/login.rb

@@ -0,0 +1,14 @@
+class Login < Sponge::Plugin
+  
+  def reply(m, arg)
+    if @bot.auth.login(m.nick, arg.to_s)
+      m.answer "You're logged in"
+    else
+      m.answer "Unable to log in"
+    end
+  end
+  
+  def help
+    "login <password>"
+  end
+end

data/lib/proto/plugins/logout.rb

@@ -0,0 +1,11 @@
+class Logout < Sponge::Plugin
+  
+  def reply(m, arg)
+    if @bot.auth.logout(m.nick)
+      m.answer "You're now logged out"
+    else
+      m.answer "Unable to log you out"
+    end
+  end
+  
+end

data/lib/proto/plugins/say.rb

@@ -0,0 +1,11 @@
+class Say < Sponge::Plugin
+
+  def reply(message, arg)
+    message.reply arg
+  end
+  
+  def help
+    "say <text> - reply in current channel with <text>"
+  end
+  
+end

data/lib/proto/plugins/seen.rb

@@ -0,0 +1,20 @@
+class SeenPlugin < Sponge::Plugin
+  listen_to :privmsg
+  
+  def initialize(bot)
+    @users = {}
+  end
+  
+  def listen(message)
+    @users[message.nick] = message
+  end
+  
+  def reply(m, arg)
+    if @users.include?(arg)
+      m.reply "I have seen #{arg}"
+    else
+      m.reply "I haven't seen #{arg}"
+    end
+  end
+  
+end

data/lib/proto/sponge.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'sponge'
+
+bot = Sponge::Bot.new('irc.yourserver.net',
+  :channels => ['#yourchannel'],
+  :users => {'foo' => 'bar'},
+)
+
+bot.start

data/lib/sponge.rb

@@ -9,9 +9,7 @@ module Sponge
   require 'socket'
   require 'pp'
   require 'ostruct'
-  
-  # Sponge core
-  require 'sponge/version'
+  require 'set'
   
   # IRC library
   require 'sponge/irc/socket'
@@ -20,4 +18,11 @@ module Sponge
   require 'sponge/irc/user'
   require 'sponge/irc/client'
   require 'sponge/irc/listeners'
+  
+  # Sponge core
+  require 'sponge/version'
+  require 'sponge/plugins'
+  require 'sponge/plugin'
+  require 'sponge/auth'
+  require 'sponge/bot'
 end

data/lib/sponge/auth.rb

@@ -0,0 +1,41 @@
+module Sponge
+  class Auth
+    
+    def initialize(client, users)
+      @client = client
+      @users = users
+      @logged = []
+    end
+    
+    # Log a user in, returns the user if the user has successfully
+    # logged in, and nil otherwise
+    def login(user, pass)
+      return unless @users.key?(user) && @users[user] == pass
+      @logged.push(user).uniq!
+      user
+    end
+    
+    # Log a user out, returns nil if the user isn't logged in
+    def logout(user)
+      return unless logged_in?(user)
+      @logged.delete(user)
+      true
+    end
+    
+    # Check if a user is logged in
+    def logged_in?(user)
+      @logged.include?(user)
+    end
+    
+    # How many users we have logged in
+    def count
+      @logged.size
+    end
+    
+    # Log all users out
+    def clear
+      @logged.clear
+    end
+      
+  end
+end

data/lib/sponge/bot.rb

@@ -0,0 +1,64 @@
+module Sponge
+  class Bot < IRC::Client
+    
+    attr_reader :plugins
+    
+    attr_reader :auth
+    
+    def initialize(server=nil, options={}, &blk)
+      @plugins = Plugins.new(self)
+      @auth = Auth.new(self, options[:users] || {})
+      
+      @command_prefix = options[:prefix] || '!'
+      @channels = options[:channels] || []
+      
+      setup_plugins
+      
+      super(server, options, &blk)
+      init_listeners
+    end
+    
+    # This probably isn't a good idea, I generally don't like seeing any
+    # eval lines, as it's a nightmare to debug. It'll do for now, though.
+    def init_listeners
+      path = File.expand_path('../listeners', __FILE__)
+      Dir[path + '/*.rb'].each do |listener|
+        instance_eval(File.read(listener))
+      end
+    end
+    
+    # Looks through the 'plugins' directory, require all plugins
+    # found, and add them into Sponge::Plugins
+    def setup_plugins
+      unless File.directory?(@plugins.path)
+        raise(LoadError, "No plugins directory found. Did you run `sponge init'?")
+      end
+      
+      Dir[@plugins.path + '/*.rb'].each do |plugin|
+        require plugin
+      end
+      
+      Plugin::LIST.each do |plugin|
+        add_plugin(plugin)
+      end
+    end
+    
+    # Should only be used by #setup_plugins (for now..)
+    # Sugar for Sponge::Plugins#add
+    def add_plugin(plugin)
+      plugins.add(plugin)
+    end
+    
+    # Registers an IRC command ready to dispatch to any
+    # plugin who are listening
+    def register(command, message)
+      if Plugin.has_listener?(command)
+        Plugin::LISTENERS[command.to_s.downcase].each do |cmd|
+          plugins.dispatch_listen(cmd, message)
+        end
+      end
+    end
+    
+  end
+end
+

data/lib/sponge/irc/listeners.rb

@@ -22,6 +22,8 @@ module Sponge
         end
       end
       
+      class ListenerExistsError < RuntimeError; end
+      
       # The IRC::Client using this Listener List
       attr_reader :client
       
@@ -37,8 +39,8 @@ module Sponge
       # * See IRC::Client#on
       def add(*commands, &blk)
         commands.each do |command|
-          command = command.to_s
-          raise "listener for #{command} already exists" if @list.key?(command)
+          command = command.to_s.downcase
+          raise ListenerExistsError, "listener for #{command} already exists" if @list.key?(command)
           @list[command] = Listener.new(command, &blk)
         end
         commands
@@ -46,7 +48,7 @@ module Sponge
       
       # Remove a listener from our list
       def delete(command)
-        @list.delete(command)
+        @list.delete(command.to_s.downcase)
       end
       
       def [](command)
@@ -54,14 +56,19 @@ module Sponge
       end
       
       def include?(k)
-        @list.key?(k)
+        @list.key?(k.to_s.downcase)
+      end
+      
+      def clear
+        @list.clear
       end
       
       # Invoke #call on a Listener if it exists passing an IRC::Message
       def handle(message)
         raise "Not a IRC::Message" unless message.is_a?(Sponge::IRC::Message)
-        if @list.key?(message.command)
-          @list[message.command].call(client.irc, message)
+        command = message.command.to_s.downcase
+        if @list.key?(command)
+          @list[command].call(client.irc, message)
         end
       end
       

data/lib/sponge/irc/parser.rb

@@ -9,6 +9,8 @@ module Sponge
     # == Synopsis
     #
     class Parser
+      
+      class BadMessageFormat < RuntimeError; end
 
       # Our IRC::Client instance
       attr_reader :client
@@ -21,7 +23,7 @@ module Sponge
       # for you to play with
       def parse(data)
         return unless data
-        raise "Unknown Message" unless matches = data.match(/\A(?:\:(\S+)\s)?([A-Z0-9]+?)\s(.+?)\Z/)
+        raise(BadMessageFormat, "Unknown Message") unless matches = data.match(/\A(?:\:(\S+)\s)?([A-Z0-9]+?)\s(.+?)\Z/)
         prefix, command, params = matches.captures
         
         message = IRC::Message.new(client, data, prefix, command, params)

data/lib/sponge/listeners/376.rb

@@ -0,0 +1,5 @@
+on(376) do |irc, message|
+  @channels.each do |chan|
+    irc.join chan
+  end
+end

data/lib/sponge/listeners/join.rb

@@ -0,0 +1,4 @@
+on(:JOIN) do |irc, message|
+  
+  register(:JOIN, message)
+end

data/lib/sponge/listeners/privmsg.rb

@@ -0,0 +1,14 @@
+on(:PRIVMSG) do |irc, message|
+  
+  prefix = Regexp.escape(@command_prefix)
+
+  if matches = message.text.match(/#{prefix}([a-zA-Z]+?)(\s*\Z|\s(.*))/)
+    command = matches[1]
+    arg = matches[3]
+    if @plugins.has_plugin?(command)
+      @plugins.dispatch_reply(command, message, arg)
+    end
+  end
+  
+  register(:PRIVMSG, message)
+end

data/lib/sponge/plugin.rb

@@ -0,0 +1,109 @@
+module Sponge
+  
+  # == Plugin Example
+  #   class SayPlugin < Sponge::Plugin
+  #     def reply(m, arg)
+  #       m.reply arg
+  #     end
+  #   end
+  #
+  # Simple as that, the reply method will get invoked when the say command is used.
+  # You can also have plugins 'listen' for stuff, for example if you'd like a plugin
+  # to print PRIVMSG's to your terminal you can have a plugin which listens for them.
+  #
+  #   class ShowMessage < Sponge::Plugin
+  #     listen_to :privmsg
+  #
+  #     def listen(m)
+  #       if m.public?
+  #         puts "[#{m.channel}]<#{m.nick}> #{m.text}"
+  #       end
+  #     end
+  #   end
+  #
+  # And that's it, the listen method will be invoked whenever the bot see's a PRIVMSG
+  # and it'll send the Sponge::IRC::Message applicable for this command.
+  #
+  # All plugins should be placed into a 'plugins' directory. All plugins are loaded on start
+  # and cannot be 'unloaded' although im sure this feature will be implemented at some time.
+  class Plugin
+    
+    # Our list of plugins
+    LIST = []
+    
+    # For plugins which require authentication
+    AUTH = []
+    
+    # A hash containing IRC commands as keys whose values are Arrays containing
+    # a list of commands who are interested in 'listening' to them
+    #
+    #   :privmsg => ['log', 'memo', 'seen']
+    #   :join => ['log']
+    LISTENERS = {}
+    
+    # Throw our plugin straight into the LIST
+    def self.inherited(plugin)
+      LIST << plugin
+    end
+    
+    # This works ok, but I should probably add a better way of checking
+    # at some point.. heh.
+    # Returns 'say' from SayPlugin, etc
+    def self.command
+      name.downcase.sub(/plugin$/, '')
+    end
+    
+    # Check if an IRC command has any plugins 'listening' for it
+    def self.has_listener?(cmd)
+      LISTENERS.key?(cmd.to_s.downcase)
+    end
+    
+    # Plugin requires the nick to be authenticated
+    def self.requires_auth
+      AUTH << command
+      p AUTH
+    end
+    
+    # Allows a specific plugin to 'listen' to irc messages
+    # making the plugins a little more interactive
+    def self.listen_to(*commands)
+      commands.each do |cmd|
+        cmd = cmd.to_s.downcase
+        if LISTENERS.key?(cmd)
+          LISTENERS[cmd] << command
+        else
+          LISTENERS[cmd] = [command]
+        end
+      end
+    end
+    
+    # Create a new Plugin instance
+    # This is done for *every* command, if you want to reference the Sponge::Bot
+    # instance and also want to create add variables in your plugins constructor
+    # then make sure you either call super() or assign @bot in your plugins
+    #
+    # Probably a bad idea to use ::new on every Plugin, perhaps create a 'setup'
+    # method for controlling per plugin options and data in the future
+    #
+    # Need to implement a way of setting plugin specific options through class methods
+    # without using constants that just store the plugin name (ie AUTH)
+    def initialize(bot)
+      @bot = bot
+    end
+    
+    # The default help if a specific plugin lacks it
+    def help
+      "No help for this plugin"
+    end
+    
+    # The default usage if a specific plugin lacks it
+    def usage
+      "No usage for this plugin"
+    end
+    
+    def requires_auth?
+      AUTH.include? self.class.command
+    end
+
+  end
+end

data/lib/sponge/plugins.rb

@@ -0,0 +1,79 @@
+module Sponge
+  class Plugins
+    
+    attr_reader :bot
+    
+    # The full path to our plugins directory
+    attr_reader :path
+    
+    def initialize(bot)
+      @bot = bot
+      @path = File.expand_path('plugins')
+      @list = {}
+    end
+    
+    # Add a plugin, this method invokes Plugin::new and passes our Sponge::Bot instance
+    # so we can access it in all of our plugins
+    def add(plugin)
+      @list[plugin.command] = plugin.new(bot)
+    end
+    
+    # Grab a plugin
+    def get(plugin)
+      @list[plugin]
+    end
+    alias [] get
+    
+    # Check if a plugin exists
+    def include?(command)
+      @list.key?(command)
+    end
+    alias has_plugin? include?
+    
+    # Return a list of our plugin commands
+    def commands
+      @list.keys
+    end
+    
+    def dispatch_listen(command, message)
+      if include?(command)
+        plugin = get(command)
+
+        if plugin.respond_to?(:listen)
+          plugin.send(:listen, message)
+        else
+          raise(ArgumentError, "Unable to dispatch to #{command}, does the #{plugin} plugin have a `listen' method?")
+        end
+      else
+        raise(ArgumentError, "Attempting to dispatch to unknown plugin")
+      end
+    end
+    
+    def dispatch_reply(command, message, args)
+      if include?(command)
+        plugin = get(command)
+        
+        # We don't raise if a plugin hasn't implemented a reply method
+        # as plugins can *just* be listeners
+        if plugin.respond_to?(:reply)
+          if plugin.requires_auth?
+            return unless bot.auth.logged_in?(message.nick)
+          end
+          plugin.send(:reply, message, args)
+        end
+      else
+        raise(ArgumentError, "Attempting to dispatch to unknown plugin")
+      end
+    end
+    alias :reply :dispatch_reply
+    
+    def help(command)
+      if include?(command)
+        plugin = get(command)
+        
+        plugin.help
+      end
+    end
+    
+  end
+end

data/lib/sponge/version.rb

@@ -1,7 +1,7 @@
 module Sponge
   MAJOR = 0
-  MINOR = 2
-  TINY = 9
+  MINOR = 3
+  TINY = 0
   
   VERSION = [MAJOR, MINOR, TINY].join('.')
   
@@ -9,4 +9,4 @@ module Sponge
   def self.version
     VERSION
   end
-end
+end

data/spec/helper.rb

@@ -1,6 +1,10 @@
 require File.expand_path('../../lib/sponge.rb', __FILE__)
 require 'bacon'
 
+BaseClient = Sponge::IRC::Client.new do
+  server 'irc.freenode.org'
+end unless defined?(BaseClient)
+
 class Sponge::IRC::Socket
   def write(data)
     nil

data/spec/sponge/auth.rb

@@ -0,0 +1,67 @@
+require File.expand_path('../../../lib/sponge/auth', __FILE__)
+
+users = {
+  'injekt' => 'sekret',
+  'foo' => 'bar',
+  'lorem' => 'ipsum',
+}
+
+auth = Sponge::Auth.new(nil, users)
+
+describe "Sponge::Auth" do
+  describe "#login" do
+    it "should log a user in" do
+      auth.login('injekt', 'sekret')
+      auth.logged_in?('injekt').should == true
+    end
+    
+    it "should return nil if given wrong credentials" do
+      resp = auth.login('injekt', 'wrongpass')
+      resp.should == nil
+    end
+  end
+  
+  describe "#logout" do
+    it "should log a user out" do
+      auth.logout('injekt')
+      auth.logged_in?('injekt').should == false
+    end
+    
+    it "should return nil if a user is not logged in" do
+      resp = auth.logout('foo')
+      resp.should == nil
+    end
+  end
+  
+  describe "#clear" do
+    it "should log all users out" do
+      auth.login('injekt', 'sekret')
+      auth.login('foo', 'bar')
+      auth.count.should == 2
+      auth.clear
+      auth.count.should == 0
+    end
+  end
+  
+  describe "#logged_in?" do
+    it "should return true if a user is logged in" do
+      auth.login('injekt', 'sekret')
+      resp = auth.logged_in?('injekt')
+      resp.should == true
+    end
+    
+    it "should return false if a user is not logged in" do
+      auth.clear
+      resp = auth.logged_in?('injekt')
+      resp.should == false
+    end
+  end
+  
+  describe "#count" do
+    it "should display how many users are currently logged in" do
+      auth.login('injekt', 'sekret')
+      auth.login('foo', 'bar')
+      auth.count.should == 2
+    end
+  end
+end

data/spec/sponge/irc/client.rb

@@ -12,6 +12,12 @@ describe "Sponge::IRC::Client" do
     client.config.nickname.should == 'Sponge'
   end
   
+  it "should raise if no server is supplied" do
+    lambda { Sponge::IRC::Client.new }
+    .should.raise(ArgumentError)
+    .message.should == "No server supplied"
+  end
+  
   it "should use the default nickname if no username, hostname, or realname are supplied" do
     c = Sponge::IRC::Client.new('', :nickname => 'foobot')
     

data/spec/sponge/irc/listeners.rb

@@ -0,0 +1,65 @@
+require File.expand_path('../../../helper', __FILE__)
+
+listeners = Sponge::IRC::Listeners.new(nil)
+
+describe "Sponge::IRC::Listeners" do
+  
+  it "is not case specific for keys" do
+    listeners.add('Case1', 'case2', 'CASE3')
+    3.times do |n|
+      str = "CaSe#{n+1}"
+      listeners.include?(str.upcase).should == true
+      listeners.include?(str.downcase).should == true
+    end
+  end
+  
+  describe "::new" do
+    it "should add the default ping listener" do
+      listeners.include?('PING').should == true
+    end
+  end
+  
+  describe "#add" do
+    it "should add a listener" do
+     listeners.add('foo')
+     listeners.include?('foo').should == true
+    end
+    
+    it "should add many listeners" do
+      listeners.add('lorem', 'ipsum')
+      listeners.include?('lorem').should == true
+      listeners.include?('ipsum').should == true
+    end
+    
+    it "should convert Integers and Symbols to Strings" do
+      listeners.add(:blah)
+      listeners.include?('blah').should == true
+      
+      listeners.add(376)
+      listeners.include?('376').should == true
+    end
+    
+    it "should raise a ListenerExistsError if a listener already exists" do
+      lambda { listeners.add(:PING) }
+      .should.raise(Sponge::IRC::Listeners::ListenerExistsError)
+      .message.should =~ /listener for \w+ already exists/
+    end
+  end
+  
+  describe "#delete" do
+    it "should remove a listener" do
+      listeners.add(:deleteme)  
+      listeners.include?(:deleteme).should == true
+      listeners.delete(:deleteme)
+      listeners.include?(:deleteme).should == false
+    end
+  end
+  
+  describe "#clear" do
+    it "should remove all listeners" do
+      listeners.clear
+      listeners.all.empty?.should == true
+    end
+  end
+  
+end

data/spec/sponge/irc/parser.rb

@@ -0,0 +1,37 @@
+require File.expand_path '../../../helper', __FILE__
+
+lines = {
+  :ping => 'PING :1825672507',
+  :notice => ':injekt!~injekt@myhostname.com NOTICE Sponge :foo bar',
+  :privmsg => ':injekt!~injekt@myhostname.com PRIVMSG Sponge :foo bar',
+  :join => ':injekt!~injekt@myhostname.com JOIN #sponge',
+  :part => ':injekt!~injekt@myhostname.com PART #sponge :cya!',
+  :quit => ':injekt!~injekt@myhostname.com QUIT :bye',
+  # more commands
+}
+
+badline = "foobar"
+
+parser = Sponge::IRC::Parser.new(BaseClient)
+
+describe "Sponge::IRC::Parser#parse" do
+  
+  it "should return an IRC::Message" do
+    m = parser.parse(lines[:privmsg])
+    m.class.should == Sponge::IRC::Message
+  end
+  
+  it "should raise BadMessageFormat if string is bad formatting" do
+    lambda { parser.parse(badline) }
+    .should.raise(Sponge::IRC::Parser::BadMessageFormat)
+    .message.should == "Unknown Message"
+  end
+  
+  lines.each do |c, d|
+    it "should parse a #{c} message" do
+      m = parser.parse(d)
+      m.command.downcase.should == c.to_s
+    end
+  end
+  
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 9
-  version: 0.2.9
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Lee 'injekt' Jarvis
@@ -14,8 +14,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-05 00:00:00 +01:00
-default_executable: 
+date: 2010-04-07 00:00:00 +01:00
+default_executable: sponge
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: bacon
@@ -31,10 +31,10 @@ dependencies:
         version: 1.1.0
   type: :development
   version_requirements: *id001
-description: A simple IRC library
+description: A simple plugin based IRC bot/library
 email: ljjarvis@gmail.com
-executables: []
-
+executables: 
+- sponge
 extensions: []
 
 extra_rdoc_files: 
@@ -42,27 +42,42 @@ extra_rdoc_files:
 files: 
 - README.rdoc
 - Rakefile
-- examples/client.rb
-- examples/socket.rb
+- spec/sponge/auth.rb
+- spec/sponge/irc/listeners.rb
 - spec/sponge/irc/client.rb
+- spec/sponge/irc/parser.rb
 - spec/helper.rb
+- lib/proto/plugins/log.rb
+- lib/proto/plugins/logout.rb
+- lib/proto/plugins/login.rb
+- lib/proto/plugins/seen.rb
+- lib/proto/plugins/help.rb
+- lib/proto/plugins/say.rb
+- lib/proto/sponge.rb
 - lib/sponge/version.rb
+- lib/sponge/plugins.rb
+- lib/sponge/auth.rb
+- lib/sponge/bot.rb
+- lib/sponge/listeners/privmsg.rb
+- lib/sponge/listeners/376.rb
+- lib/sponge/listeners/join.rb
 - lib/sponge/irc/listeners.rb
 - lib/sponge/irc/client.rb
 - lib/sponge/irc/message.rb
 - lib/sponge/irc/socket.rb
 - lib/sponge/irc/user.rb
 - lib/sponge/irc/parser.rb
+- lib/sponge/plugin.rb
 - lib/sponge.rb
 has_rdoc: true
-homepage: http://rdoc.injekt.net/sponge
+homepage: http://wiki.github.com/injekt/sponge
 licenses: []
 
 post_install_message: 
 rdoc_options: 
 - --quiet
 - --title
-- "Sponge: The Simple IRC library"
+- "Sponge: The Simple plugin based IRC bot/library"
 - --main
 - README.rdoc
 require_paths: 
@@ -89,6 +104,6 @@ rubyforge_project:
 rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
-summary: A simple IRC library
+summary: A simple plugin based IRC bot/library
 test_files: []
 

data/examples/client.rb

@@ -1,20 +0,0 @@
-require 'sponge'
-
-client = Sponge::IRC::Client.new do
-  server "irc.freenode.org"
-  nickname "Sponge"
-end
-
-# 376 is the command for end of motd
-client.on "376" do |irc, message|
-  irc.join "#mychannel"
-end
-
-# Add a callback for when someone (including ourselves) joins a channel
-client.on "JOIN" do |irc, message|
-  unless message.nick == 'Sponge'
-    message.reply "Hi there #{message.nick}, welcome to #{message.channel}!"
-  end
-end
-
-client.run

data/examples/socket.rb

@@ -1,9 +0,0 @@
-require 'sponge'
-
-sock = Sponge::IRC::Socket.open('irc.freenode.org')
-sock.nick "SpongeBot"
-sock.user "SpongeBot", "sponge", "sponge", "Sponge IRC bot"
-sock.join "#mychan"
-sock.privmsg "#mychan", "Hello!"
-sock.part "#mychan"
-sock.quit "Quitting.."