galador-isaac 0.2.6

data/LICENSE

@@ -0,0 +1,6 @@
+------------------------------------------------------------------------------
+"THE BEER-WARE LICENSE" (Revision 42):
+<ichverstehe@gmail.com> wrote this file. As long as you retain this notice you
+can do whatever you want with this stuff. If we meet some day, and you think
+this stuff is worth it, you can buy me a beer in return.
+------------------------------------------------------------------------------

data/README.rdoc

@@ -0,0 +1,81 @@
+= Isaac - the smallish DSL for writing IRC bots
+
+== Features
+* Wraps parsing of incoming messages and raw IRC commands in simple constructs.
+* Hides all the ugly regular expressions of matching IRC commands. Leaves only the essentials for you to match.
+* Takes care of dull stuff such as replying to PING-messages and avoiding excess flood.
+
+== Getting started
+An Isaac-bot needs a few basics:
+  require 'isaac'
+  configure do |c|
+    c.nick    = "AwesomeBot"
+    c.server  = "irc.freenode.net"
+    c.port    = 6667
+  end
+That's it. Run <tt>ruby bot.rb</tt> and it will connect to the specified server.
+
+=== Connecting
+After the bot has connected to the IRC server you might want to join some channels:
+  on :connect do
+    join "#awesome_channel", "#WesternBar"
+  end
+
+=== Responding to messages
+Joining a channel and sitting idle is not much fun. Let's repeat everything being said in these channels:
+
+  on :channel do
+    msg channel, message
+  end
+
+Notice the +channel+ and +message+ variables. Additionally +nick+ and +match+ is
+available for channel-events. +nick+ being the sender of the message, +match+
+being an array of captures from the regular expression:
+
+  on :channel, /^quote this: (.*)/ do
+    msg channel, "Quote: '#{match[0]}' by #{nick}"
+  end
+
+If you want to match private messages use the +on :private+ event:
+
+  on :private, /^login (\S+) (\S+)/ do
+    username = match[0]
+    password = match[1]
+    # do something to authorize or whatevz.
+    msg nick, "Login successful!"
+  end
+
+You can also pass the RegExp captures as block arguments:
+    
+  on :channel, /catch this: (.*) and this: (.*)/ do |first, last|
+    # `first` will contain the first regexp capture,
+    # `last` the second.
+  end
+
+=== Defining helpers
+Helpers should not be defined in the top level, but instead using the +helpers+-constructor:
+
+  helpers do
+    def rain_check(meeting)
+      msg nick, "Can I have a rain check on the #{meeting}?"
+    end
+  end
+
+  on :private, /date/ do
+    rain_check("romantic date")
+  end
+
+=== Errors, errors, errors
+Errors, as specified by RFC 1459, can be reacted upon as well. If you e.g. try to send a message to a non-existant nick you will get error 401: "No such nick/channel".
+
+  on :error, 401 do
+    # Do something.
+  end
+
+Available variables: +nick+ and +channel+.
+
+== Contribute
+The source is hosted at GitHub: http://github.com/ichverstehe/isaac
+
+== License
+The MIT. Google it.

data/isaac.gemspec

@@ -0,0 +1,18 @@
+Gem::Specification.new do |s|
+  s.name     = "isaac"
+  s.version  = "0.2.6"
+  s.date     = "2009-07-12"
+  s.summary  = "The smallish DSL for writing IRC bots"
+  s.email    = "bryan@galador.org"
+  s.homepage = "http://github.com/galador/isaac"
+  s.description = "Small DSL for writing IRC bots."
+  s.rubyforge_project = "isaac"
+  s.has_rdoc = true
+  s.authors  = ["Bryan H."]
+  s.files    = ["README.rdoc", 
+    "LICENSE",
+    "isaac.gemspec", 
+    "lib/isaac.rb"]
+  s.rdoc_options = ["--main", "README.rdoc"]
+  s.extra_rdoc_files = ["LICENSE", "README.rdoc"]
+end

data/lib/isaac.rb

@@ -0,0 +1,240 @@
+require 'socket'
+
+module Isaac
+  VERSION = '0.2.1'
+
+  Config = Struct.new(:server, :port, :ssl, :password, :nick, :realname, :version, :environment, :verbose)
+
+  def self.bot
+    @bot ||= Bot.new
+  end
+
+  class Bot
+    attr_accessor :config, :irc, :nick, :channel, :message, :userhost, :match,
+      :error
+
+    def initialize(&b)
+      @events = {}
+      @config = Config.new("localhost", 6667, false, nil, "isaac", "Isaac", 'isaac', :production, false)
+
+      instance_eval(&b) if block_given?
+    end
+
+    def configure(&b)
+      b.call(@config)
+    end
+
+    def on(event, match=//, &block)
+      match = match.to_s if match.is_a? Integer
+      (@events[event] ||= []) << [Regexp.new(match), block]
+    end
+
+    def helpers(&b)
+      instance_eval(&b)
+    end
+
+    def halt
+      throw :halt
+    end
+
+    def raw(command)
+      @irc.message(command)
+    end
+
+    def msg(recipient, text)
+      raw("PRIVMSG #{recipient} :#{text}")
+    end
+
+    def join(*channels)
+      channels.each {|channel| raw("JOIN #{channel}")}
+    end
+
+    def part(*channels)
+      channels.each {|channel| raw("PART #{channel}")}
+    end
+
+    def topic(channel, text)
+      raw("TOPIC #{channel} :#{text}")
+    end
+
+    def quit(message=nil)
+      command = message ? "QUIT :#{message}" : "QUIT"
+      raw command
+    end
+
+    def start
+      puts "Connecting to #{@config.server}:#{@config.port}" unless @config.environment == :test
+      @irc = IRC.new(self, @config)
+      @irc.connect
+    end
+
+    def dispatch(event, env={})
+      self.nick, self.userhost, self.channel, self.error =
+        env[:nick], env[:userhost], env[:channel], env[:error]
+      self.message = env[:message] || ""
+
+      if handler = find(event, message)
+        regexp, block = *handler
+        self.match = message.match(regexp).captures
+        invoke block
+      end
+    end
+
+  private
+    def find(type, message)
+      if events = @events[type]
+        events.detect {|regexp,_| message.match(regexp)}
+      end
+    end
+
+    def invoke(block)
+      mc = class << self; self; end
+      mc.send :define_method, :__isaac_event_handler, &block
+
+      bargs = case block.arity <=> 0
+        when -1; match
+        when 0; []
+        when 1; match[0..block.arity-1]
+      end
+
+      catch(:halt) { __isaac_event_handler(*bargs) }
+    end
+  end
+
+  class IRC
+    def initialize(bot, config)
+      @bot, @config = bot, config
+      @transfered = 0
+      @registration = []
+    end
+
+    def connect
+      tcpsocket = TCPSocket.open(@config.server, @config.port)
+      if @config.ssl
+        require 'openssl'
+        ssl_context = OpenSSL::SSL::SSLContext.new()
+        ssl_context.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        @socket = OpenSSL::SSL::SSLSocket.new(tcpsocket, ssl_context)
+        @socket.sync = true
+        @socket.connect
+      else
+        @socket = tcpsocket
+      end
+
+      @queue = Queue.new(@socket, @bot.config.server)
+      message "PASS #{@config.password}" if @config.password
+      message "NICK #{@config.nick}"
+      message "USER #{@config.nick} 0 * :#{@config.realname}"
+      @queue.lock
+
+      while line = @socket.gets
+        parse line
+      end
+    end
+
+    def parse(input)
+      puts "<< #{input}" if @bot.config.verbose
+      case input.chomp
+      when /(^:\S+ )?00([1-4])/
+        @registration << $2.to_i
+        if registered?
+          @queue.unlock
+          @bot.dispatch(:connect)
+        end
+      when /(^:(\S+)!\S+ )?PRIVMSG \S+ :?\001VERSION\001/
+        message "NOTICE #{$2} :\001VERSION #{@bot.config.version}\001"
+      when /^PING (\S+)/
+        @queue.unlock
+        message "PONG #{$1}"
+      when /(^:(\S+)!(\S+) )?PRIVMSG (\S+) :?(.*)/
+        env = { :nick => $2, :userhost => $3, :channel => $4, :message => $5 }
+        type = env[:channel].match(/^#/) ? :channel : :private
+        @bot.dispatch(type, env)
+      when /(^:\S+ )?([4-5]\d\d) \S+ (\S+)/
+        env = {:error => $2.to_i, :message => $2, :nick => $3, :channel => $3}
+        @bot.dispatch(:error, env)
+      when /(^:\S+ )?PONG/
+        @queue.unlock
+      end
+    end
+
+    def registered?
+      ([1,2,3,4] - @registration).empty?
+    end
+
+    def message(msg)
+      @queue << msg
+    end
+  end
+
+  class Queue
+    def initialize(socket, server)
+      # We need  server  for pinging us out of an excess flood
+      @socket, @server = socket, server
+      @queue, @lock, @transfered = [], false, 0
+    end
+
+    def lock
+      @lock = true
+    end
+
+    def unlock
+      @lock, @transfered = false, 0
+      invoke
+    end
+
+    def <<(message)
+      @queue << message
+      invoke
+    end
+
+  private
+    def message_to_send?
+      !@lock && !@queue.empty?
+    end
+
+    def transfered_after_next_send
+      @transfered + @queue.first.size + 2 # the 2 is for \r\n
+    end
+
+    def exceed_limit?
+      transfered_after_next_send > 1472
+    end
+
+    def lock_and_ping
+      lock
+      @socket.print "PING :#{@server}\r\n"
+    end
+
+    def next_message
+      @queue.shift.to_s.chomp + "\r\n"
+    end
+
+    def invoke
+      while message_to_send?
+        if exceed_limit?
+          lock_and_ping; break
+        else
+          @transfered = transfered_after_next_send
+          @socket.print next_message
+          # puts ">> #{msg}" if @bot.config.verbose
+        end
+      end
+    end
+  end
+end
+
+%w(configure helpers on).each do |method|
+  eval(<<-EOF)
+    def #{method}(*args, &block)
+      Isaac.bot.#{method}(*args, &block)
+    end
+  EOF
+end
+
+at_exit do
+  unless defined?(Test::Unit)
+    raise $! if $!
+    Isaac.bot.start
+  end
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification 
+name: galador-isaac
+version: !ruby/object:Gem::Version 
+  version: 0.2.6
+platform: ruby
+authors: 
+- Bryan H.
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-12 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Small DSL for writing IRC bots.
+email: bryan@galador.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- README.rdoc
+- LICENSE
+- isaac.gemspec
+- lib/isaac.rb
+has_rdoc: true
+homepage: http://github.com/galador/isaac
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+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: isaac
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: The smallish DSL for writing IRC bots
+test_files: []
+