david-minibot 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2007 David Leal
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,4 @@
+templates
+=================
+
+A plugin for the Merb framework that provides ....

data/Rakefile

@@ -0,0 +1,27 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'spec/rake/spectask'
+
+load 'minibot.gemspec'
+
+Rake::GemPackageTask.new(SPEC) do |pkg|
+  pkg.gem_spec = SPEC
+end
+
+task :install => [:package] do
+  sh %{sudo gem install pkg/#{GEM}-#{VERSION}}
+end
+
+desc "Run all specs"
+Spec::Rake::SpecTask.new('spec') do |t|
+  t.spec_files = FileList['spec/**/*.rb']
+  t.spec_opts = %w{--color}
+end
+
+desc "Run all specs with rcov"
+Spec::Rake::SpecTask.new('spec:rcov') do |t|
+  t.spec_files = FileList['spec/**/*.rb']
+  t.rcov = true
+  t.rcov_opts = %w{--exclude spec --text-summary}
+end
+

data/TODO

@@ -0,0 +1,14 @@
+TODO:
+
+* Add commands to:
+  * Reply to a private message
+  * Reply to a channel message
+* Implement relevant parts of CTCP
+* Discard events generated by the bot (parts, joins, others) (?)
+* Handle PINGs
+* Detect when using a registered nick. 
+* Add ability to reply both to public (by prefixing the username) and private messages 
+* Bot should reconnect upon disconnection
+* Logging.
+* Error handling.
+* Signal trapping for graceful exiting.

data/lib/minibot/commands.rb

@@ -0,0 +1,30 @@
+require 'ostruct'
+
+module MiniBot
+  module Commands
+    include Events::Constants
+
+    def join(*channels)
+      channels.each { |channel| server.write "JOIN #{channel}" }
+    end
+
+    def topic(channel)
+      topic = author = timestamp = nil
+      server.write "TOPIC #{channel}", *EXPECTED_REPLIES_TOPIC do |code, reply|
+        if code == RPL_TOPIC
+          topic = reply
+        elsif code == RPL_TOPIC_META
+          author, timestamp = *reply.split
+        end
+      end
+
+      [ topic, author, timestamp && Time.at(timestamp.to_i) ] 
+    end
+
+    private
+
+    def pong
+      write "PONG #{@host_name}"
+    end
+  end
+end

data/lib/minibot/constants.rb

@@ -0,0 +1,13 @@
+module MiniBot
+  module Events
+    module Constants
+      RPL_WELCOME = "001"
+      RPL_NOTOPIC = "331"
+      RPL_TOPIC = "332"
+      RPL_TOPIC_META = "333"
+      ERR_NICKNAMEINUSE = "433"
+
+      EXPECTED_REPLIES_TOPIC = [ RPL_NOTOPIC, [ RPL_TOPIC, RPL_TOPIC_META ], RPL_TOPIC ]
+    end
+  end
+end

data/lib/minibot/daemon.rb

@@ -0,0 +1,55 @@
+require 'socket'
+
+module MiniBot
+  class Daemon
+    include Events
+    include Commands
+
+    attr_reader :config, :server
+
+    DEFAULTS = {
+      :port => 6667,
+      :channels => []
+    }
+
+    def run
+      begin
+        connect @config[:server], @config[:port]
+        authenticate @config[:nick], @config[:username], @config[:realname]
+        join *@config[:channels]
+        main_loop
+      ensure
+        disconnect
+      end
+    end
+
+    private
+
+    def connect(server, port)
+      @server = Server.connect server, port
+    end
+
+    def disconnect
+      @server.disconnect
+    end
+
+    def initialize(config)
+      @config = DEFAULTS.merge config
+
+      @config[:username] ||= @config[:nick]
+      @config[:realname] ||= @config[:nick]
+    end
+
+    def main_loop
+      while msg = @server.read
+        dispatch msg
+      end
+    end
+
+    def authenticate(nick, username, realname)
+      @server.write "USER #{username} 0 xxx :#{realname}"
+      @server.write "NICK #{nick}"
+    end
+  end
+end
+

data/lib/minibot/events.rb

@@ -0,0 +1,91 @@
+module MiniBot
+  module Events
+    include Constants
+
+    def message(channel, sender, message)
+    end
+
+    def private_message(sender, message)
+    end
+
+    def user_joined(channel, nick)
+    end
+
+    def user_parted(channel, nick)
+    end
+
+    def user_action(channel, nick, message)
+    end
+
+    def invited(channel, nick)
+    end
+
+    def default(message_str)
+    end
+
+    def pinged
+    end
+
+    def topic_changed(channel, nick, topic)
+    end
+
+    def kicked(channel, nick, message)
+    end
+
+    def user_kicked(channel, kicker, kicked, message)
+    end
+
+    def ready
+    end
+
+    def error(num, message)
+    end
+
+    private
+
+    def dispatch(srv_msg)
+      if match = /^:(\w+)!.+ PRIVMSG (\S+) :([^\001].+)/.match(srv_msg)
+        target, origin, message = *match.values_at(2, 1, 3)
+        unless target == @nick
+          message target, origin, message
+        else
+          private_message origin, message
+        end
+      elsif match = /^:(\w+)!.+ JOIN :(\S+)/.match(srv_msg)
+        user_joined *match.values_at(2, 1)
+      elsif match = /^:(\w+)!.+ PART (\S+)/.match(srv_msg)
+        user_parted *match.values_at(2, 1)
+      elsif match = /^:(\w+)!.+ PRIVMSG (\S+) :\001ACTION (.+)\001/.match(srv_msg)
+        user_action *match.values_at(2, 1, 3)
+      elsif match = /^:(\w+)!.+ PRIVMSG #{@nick} :(.+)/.match(srv_msg)
+        private_message *match.values_at(1, 2)
+      elsif match = /^:(\w+)!.+ INVITE \w+ :(\S+)/.match(srv_msg)
+        invited *match.values_at(2, 1)
+      elsif match = /^PING/.match(srv_msg)
+        pinged
+      elsif match = /^:(\w+)!.+ TOPIC (\S+) :(.+)/.match(srv_msg)
+        topic_changed *match.values_at(2, 1, 3)
+      elsif match = /^:(\w+)!.+ KICK (\S+) #{@nick} :(.+)/.match(srv_msg)
+        kicked *match.values_at(2, 1, 3)
+      elsif match = /^:(\w+)!.+ KICK (\S+) (\w+) :(.+)/.match(srv_msg)
+        user_kicked *match.values_at(2, 1, 3, 4)
+      elsif match = /^:\S+ #{RPL_WELCOME} .*?(:.*)?$/.match(srv_msg)
+        ready
+      elsif match = /^:\S+ (\d{3}) \S+ (:.*)?$/.match(srv_msg)
+        code, msg = *match.values_at(1, 2)
+
+        if error?(code)
+          error code, msg.sub(/:/, '')
+        else
+          default(srv_msg)
+        end
+      else
+        default(srv_msg)
+      end
+    end
+
+    def error?(num)
+      return ("400" .. "599").include? num
+    end
+  end
+end

data/lib/minibot/server.rb

@@ -0,0 +1,121 @@
+module MiniBot
+  class Server
+    REPLY_RE = /:\S+ (\d{3}) \S+ :?(.+)/
+
+    def self.connect(server, port)
+      s = new(server, port)
+      s.connect
+      s
+    end
+
+    def connect
+      @socket = TCPSocket.new(@server, @port)
+    end
+
+    def read
+      if @messages.first && message_complete?(@messages.first)
+        to_message(@messages.shift)
+      else
+        read_messages
+        read
+      end
+    end
+
+    def match_code(code, message)
+      if (match = reply?(message)) && match[1] == code
+        match[1, 2]
+      else
+        nil
+      end
+    end
+
+    def write(msg, *replies)
+      @socket.print "#{msg}\r\n"
+
+      unless replies.empty?
+        index = 0
+        matches, messages = catch :halted do
+          loop do
+            index, message = next_message(index)
+            replies.each do |r|
+              case r
+              when String
+                if match = /:\S+ (#{r}) \S+ :?(.+)/.match(message)
+                  throw :halted, [[ match ], [ message ]]
+                end
+              when Array
+                matched = []
+                messages = []
+                r.each do |ri|
+                  if match = /:\S+ (#{ri}) \S+ :?(.+)/.match(message)
+                    matched << match
+                    messages << message
+                    index, message = next_message(index)
+                  elsif !matched.empty?
+                    index -= matched.length
+                    message = matched.first
+                    break
+                  end
+                end
+
+                throw :halted, [matched, messages] unless matched.empty?
+              else
+                raise ArgumentError, "Unknown reply argument type: #{r.inspect}", caller
+              end
+            end
+          end
+        end
+
+        messages.each { |m| delete_message(m) }
+        matches.each { |m| yield m[1, 2] }
+      end
+    end
+
+    def extract(regexp)
+
+    end
+
+    def disconnect
+      @socket.close if @socket
+    end
+
+    private
+
+    def delete_message(m)
+      @messages.delete("#{m}\r")
+    end
+
+    def message_complete?(message)
+      message[-1] == ?\r
+    end
+
+    def to_message(raw)
+      raw.chomp
+    end
+
+    def next_message(index)
+      read_messages if !@messages[index] || !message_complete?(@messages[index])
+
+      [index + 1, to_message(@messages[index])]
+    end
+
+    def reply?(msg)
+      REPLY_RE.match msg
+    end
+
+    def initialize(server, port)
+      @server = server
+      @port = port
+      @messages = []
+    end
+
+    def read_messages
+      buffer = @socket.recvfrom(512).first
+      messages = buffer.split /\n/
+
+      @messages.last << messages.shift if @messages.last && @messages.last[-1] != ?\r
+
+      @messages += messages
+    end
+  end
+end

data/lib/minibot.rb

@@ -0,0 +1,5 @@
+require File.join(File.dirname(__FILE__), 'minibot', 'server')
+require File.join(File.dirname(__FILE__), 'minibot', 'constants')
+require File.join(File.dirname(__FILE__), 'minibot', 'events')
+require File.join(File.dirname(__FILE__), 'minibot', 'commands')
+require File.join(File.dirname(__FILE__), 'minibot', 'daemon')

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: david-minibot
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- David Leal
+autorequire: minibot
+bindir: bin
+cert_chain: []
+
+date: 2008-06-13 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: A mini Ruby IRC bot framework
+email: dgleal@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+- TODO
+files: 
+- LICENSE
+- README
+- TODO
+- Rakefile
+- lib/minibot
+- lib/minibot/commands.rb
+- lib/minibot/daemon.rb
+- lib/minibot/server.rb
+- lib/minibot/events.rb
+- lib/minibot/constants.rb
+- lib/minibot.rb
+has_rdoc: true
+homepage: http://davidleal.com
+post_install_message: 
+rdoc_options: []
+
+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.0.1
+signing_key: 
+specification_version: 2
+summary: A mini Ruby IRC bot framework
+test_files: []
+