raibo 0.0.1 → 0.0.2

data/.gitignore

@@ -2,3 +2,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+Botfile

data/Gemfile

@@ -2,3 +2,6 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in raibo.gemspec
 gemspec
+
+# Development dependencies
+gem 'rspec'

data/bin/raibo

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'raibo'
+
+botfile = ARGV.shift || 'Botfile'
+
+if Dir[botfile].empty?
+  puts "Usage: raibo [botfile]"
+end
+
+b = Raibo::Bot.new('irc.he.net', :nick => 'raibot', :port => 6667, :verbose => true)
+b.instance_eval(File.read(botfile))
+b.run

data/example/example_module.rb

@@ -0,0 +1,25 @@
+# This is a simple example of a module that could be used with Raibo.
+# An associated Botfile might look like this:
+#
+#   require_relative 'example/test_module'
+#   use ExampleModule.new(/hello/, 'goodbye')
+#   use ExampleModule.new(/goodbye/, 'hello')
+#
+# This will run a bot that responds to a message containing "hello"
+# by saying "goodbye", and vice versa.
+#
+# Bots can maintain whatever state they want to. The only requirement
+# is that they respond to a #call method with a Raibo::Connection as
+# the first parameter and Raibo::Message as the second.
+
+class ExampleModule
+  def initialize(regexp, response)
+    @regexp, @response = regexp, response
+  end
+
+  def call(c, message)
+    if message.body =~ @regexp
+      c.say @response
+    end
+  end
+end

data/lib/raibo.rb

@@ -5,3 +5,5 @@ require 'socket'
 
 require 'raibo/version'
 require 'raibo/connection'
+require 'raibo/bot'
+require 'raibo/message'

data/lib/raibo/bot.rb

@@ -0,0 +1,66 @@
+module Raibo
+  class Bot
+    def initialize(*args)
+      @handlers = []
+
+      if args.first.is_a?(Raibo::Connection)
+        @connection = args.shift
+      else
+        @connection = Raibo::Connection.new(*args)
+      end
+    end
+
+    def use(handler=nil, &block)
+      @handlers.push(handler || block)
+    end
+
+    def match(regexp, &block)
+      use do |msg|
+        if msg.body =~ regexp
+          exec_with_var_arity($~, msg, &block)
+        end
+      end
+    end
+
+    def run(async=false)
+      if async
+        @thread = Thread.new { run_sync }
+        @thread.abort_on_exception = true
+      else
+        run_sync
+      end
+    end
+
+    def stop
+      @thread.kill if @thread
+      @connection.close
+    end
+
+    def alive?
+      @thread.alive? if @thread
+    end
+
+    private
+      def run_sync
+        @connection.open
+        @connection.handle_lines do |line|
+          begin
+            message = Raibo::Message.new(line)
+          rescue => e
+            if @connection.verbose
+              puts "Error parsing line:"
+              puts "  #{line}"
+              puts "  #{e.backtrace}"
+            end
+          end
+          @handlers.each do |handler|
+            if handler.is_a?(Proc)
+              break if @connection.instance_exec(message, &handler)
+            else
+              break if handler.call(@connection, message)
+            end
+          end
+        end
+      end
+  end
+end

data/lib/raibo/connection.rb

@@ -3,23 +3,23 @@ module Raibo
     attr_accessor :server, :port, :nick, :channel
 
     def initialize(server, opts={})
-      @server   = server
-      @port     = opts[:port]     || 6667
-      @nick     = opts[:nick]     || 'Raibo'
-      @channel  = opts[:channel]  || '#raibo'
-      @verbose  = !!opts[:verbose]
+      @server  = server
+      @port    = opts[:port]    || 6667
+      @nick    = opts[:nick]    || 'Raibo'
+      @channel = opts[:channel] || '#raibo'
+      @verbose = !!opts[:verbose]
     end
 
     def open
       @connection = TCPSocket.new(@server, @port)
-      send "USER #{@nick} 0 * :Hi"
+      send "USER #{@nick} 0 * :Hello"
       nick @nick
 
       handle_lines do |line|
         case line
-        when /:Nickname is already in use./
-          @nick = "#{@nick}_"
-          nick @nick
+        when /:Nickname is already in use/
+          @connection.close
+          raise "Connection error: Nickname is already in use."
         when /001/
           join @channel
           break
@@ -41,6 +41,8 @@ module Raibo
           yield line
         end
       end
+    rescue IOError
+      close
     end
 
     def nick(nick)
@@ -67,5 +69,14 @@ module Raibo
       puts "<-- #{str}" if @verbose
       @connection.puts(str)
     end
+
+    def exec_with_var_arity(*args, &block)
+      arity = block.arity
+      if arity <= 0
+        instance_eval(&block)
+      else
+        instance_exec(*args.take(block.arity), &block)
+      end
+    end
   end
 end

data/lib/raibo/message.rb

@@ -0,0 +1,63 @@
+module Raibo
+  class Message
+    # Readers for the components of the actual IRC protocol line.
+    attr_reader :prefix, :type, :middle, :trailing
+
+    # Readers for higher-level attributes of the message.
+    attr_reader :kind, :from, :to, :body
+
+    def initialize(line)
+      @prefix, @type, @middle, @trailing = parse_line(line)
+
+      @kind = get_kind
+      @from = get_from
+      @to   = get_to
+      @body = get_body
+    end
+
+    private
+      def parse_line(line)
+        prefix, type, params = line.match(/:(\S+) (\S+) (.*)/).captures
+        if params
+          middle, _, trailing = params.partition(':')
+          middle = middle.split
+          trailing.chomp!
+        end
+        [prefix, type, middle, trailing]
+      end
+
+      def get_kind
+        case type
+          when 'PRIVMSG'
+            if trailing =~ /^\001ACTION/
+              :emote
+            else
+              :message
+            end
+          when 'JOIN'
+            :join
+          when 'PART'
+            :part
+        end
+      end
+
+      def get_from
+        prefix[/^([^!@ ]*)/, 1]
+      end
+
+      def get_to
+        if [:message, :emote].include?(kind)
+          middle.first
+        end
+      end
+
+      def get_body
+        case kind
+        when :message
+          trailing
+        when :emote
+          trailing[/\001ACTION ([^\001]*)/, 1]
+        end
+      end
+  end
+end

data/lib/raibo/version.rb

@@ -1,3 +1,3 @@
 module Raibo
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/message_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+module Raibo
+  describe Message do
+    it 'parses a message' do
+      m = Raibo::Message.new(":someone!someone@Nightstar-251832d1.snfc22.example.com PRIVMSG #raibo :foo bar baz")
+
+      m.kind.should == :message
+      m.from.should == 'someone'
+      m.to.should == '#raibo'
+      m.body.should == 'foo bar baz'
+    end
+
+    it 'parses an emote' do
+      m = Raibo::Message.new(":someone!someone@Nightstar-251832d1.snfc22.example.com PRIVMSG #raibo :\001ACTION foo bar baz\001")
+
+      m.kind.should == :emote
+      m.from.should == 'someone'
+      m.to.should == '#raibo'
+      m.body.should == 'foo bar baz'
+    end
+
+    it 'parses a join' do
+      m = Raibo::Message.new(":someone!someone@Nightstar-251832d1.snfc22.example.com JOIN :#raibo")
+
+      m.kind.should == :join
+      m.from.should == 'someone'
+      m.to.should == nil
+      m.body.should == nil
+    end
+
+    it 'parses a part' do
+      m = Raibo::Message.new(":someone!someone@Nightstar-251832d1.snfc22.example.com PART #raibo")
+
+      m.kind.should == :part
+      m.from.should == 'someone'
+      m.to.should == nil
+      m.body.should == nil
+    end
+
+    it 'parses an arbitrary line' do
+      m = Raibo::Message.new(":Deepthought.NY.US.Nightstar.Net 255 Raibo :I have 83 clients and 1 servers")
+      m.kind.should == nil
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'rubygems'
+require 'raibo'

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: raibo
 version: !ruby/object:Gem::Version 
-  hash: 29
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 1
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Ryan Fitzgerald
@@ -15,15 +10,15 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-12 00:00:00 -07:00
+date: 2011-07-17 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
 description: ""
 email: 
 - rwfitzge@gmail.com
-executables: []
-
+executables: 
+- raibo
 extensions: []
 
 extra_rdoc_files: []
@@ -32,10 +27,16 @@ files:
 - .gitignore
 - Gemfile
 - Rakefile
+- bin/raibo
+- example/example_module.rb
 - lib/raibo.rb
+- lib/raibo/bot.rb
 - lib/raibo/connection.rb
+- lib/raibo/message.rb
 - lib/raibo/version.rb
 - raibo.gemspec
+- spec/message_spec.rb
+- spec/spec_helper.rb
 has_rdoc: true
 homepage: ""
 licenses: []
@@ -50,25 +51,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: raibo
-rubygems_version: 1.5.1
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
 summary: A simple IRC library
-test_files: []
-
+test_files: 
+- spec/message_spec.rb
+- spec/spec_helper.rb