ircbgb 0.0.1.pre

data/lib/ircbgb/message_parser.rl

@@ -0,0 +1,84 @@
+# RFC 1459 Message Parser to be processed by Ragel
+%%{
+  machine irc_message_parser;
+
+  action start_parser { eof = pe }
+  action clear_command { cmd = '' }
+  action clear_server { server = '' }
+  action clear_rest { rest = '' }
+  action clear_param { param = '' }
+  action clear_user_mask { user_mask = '' }
+  action append_user_mask { user_mask << data[p] }
+  action append_server { server << data[p] }
+  action append_param { param << data[p] }
+  action append_params { params << param }
+  action append_rest { rest << data[p] }
+  action append_command { cmd << data[p] }
+  action make_source_user {
+    source = ::Ircbgb::User.parse(user_mask)
+  }
+  action make_source_server {
+    source = ::Ircbgb::Server.new(server)
+  }
+  action show_me {
+    puts "Currently parsing data[#{p}/#{data.length}]: '#{data[p]}'"
+  }
+  action message_error {
+    raise ::Ircbgb::MessageFormatError, "invalid form #{data.inspect} at #{p} '#{data[p]}'"
+  }
+
+  sspace = ' ';
+  crlf = '\r\n';
+  whites = sspace | '\0' | '\r' | '\n';
+  nospcrlfcl = any - whites - ':';
+  nonwhite = any - whites;
+  userchar = any - '@' - whites;
+  ip4addr = digit{1,3} '.' digit{1,3} '.' digit{1,3} '.' digit{1,3};
+  ip6addr = (xdigit+ (':' xdigit+){7})
+            | ('0:0:0:0:0:' ('0' | [fF]{4}) ':' ip4addr);
+  hostaddr = ip4addr | ip6addr;
+  shortname = (alpha | digit) (alpha | digit | '-')* (alpha | digit)*;
+  hostname = shortname ('.' shortname)*;
+  host = hostname | hostaddr;
+  user = userchar+;
+  nick_special = '[' | ']' | '\\' | '`' | '_' | '^' | '{' | '|' | '}';
+  nick = (alpha | nick_special) (alpha | digit | nick_special | '-')*;
+  servername = hostname >clear_server $append_server %make_source_server;
+  nick_mask = (nick ('!' user ('@' host)?)?) >clear_user_mask $append_user_mask %make_source_user;
+
+  prefix = servername | nick_mask;
+  command = (alpha+ | digit+) >clear_command @append_command;
+  middle = (nospcrlfcl (':' | nospcrlfcl)*) >clear_param @append_param %append_params;
+  trailing = ((nospcrlfcl | ' ' | ':')*) >clear_rest @append_rest;
+  params = ((sspace+ middle){0,14} (sspace+ ':' trailing)?);
+
+  message = (':' prefix sspace+)? command params? crlf;
+
+  main := message >start_parser $err(message_error);
+}%%
+
+module Ircbgb
+  class MessageParser
+
+    %% write data;
+
+    def self.parse str
+      data = str
+      server = ''
+      user_mask = ''
+      para = ''
+      rest = ''
+      params = []
+      source = nil
+      cmd = ''
+
+      %% write init;
+      %% write exec;
+
+      params << rest unless rest.empty?
+
+      ::Ircbgb::Message.new source, cmd, params
+    end
+  end
+end
+

data/lib/ircbgb/server.rb

@@ -0,0 +1,13 @@
+module Ircbgb
+  class Server
+    attr_reader :host
+    alias :user :host
+    alias :nick :host
+
+    def initialize h
+      @host = h
+    end
+
+    def to_s; @host.dup; end
+  end
+end

data/lib/ircbgb/user.rb

@@ -0,0 +1,32 @@
+module Ircbgb
+  class User
+    attr_reader :nick, :user, :host
+
+    def initialize n, u, h
+      @nick = n.empty? ? '*' : n
+      @user = u.empty? ? '*' : u
+      @host = h.empty? ? '*' : h
+      @mask = "#{@nick}!#{@user}@#{@host}"
+    end
+
+    def to_s; @mask.dup; end
+
+    def =~ other
+      return Matcher.new(other) =~ @mask if String === other
+      @mask =~ other
+    end
+
+    class << self
+      def parse nick_mask
+        case nick_mask
+        when Ircbgb::User
+          nick_mask
+        when /\A([^!]+)!([^@]*)@(.*)\Z/ 
+          new $1, $2, $3
+        else
+          new nick_mask, '', ''
+        end
+      end
+    end
+  end
+end

data/lib/ircbgb/version.rb

@@ -0,0 +1,3 @@
+module Ircbgb
+  VERSION = "0.0.1.pre"
+end

data/spec/ircbgb/client_spec.rb

@@ -0,0 +1,171 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe Ircbgb::Client do
+  include Stubz
+
+  def client
+    @client ||= Ircbgb::Client.new { |c|
+      c.servers << 'irc://server1.example.org'
+      c.servers << 'irc://server2.example.com:7001'
+      c.nicks = ['bot1', 'bot2', 'bot3']
+      c.realname = 'I am a bot'
+      c.username = 'botty'
+    }
+  end
+
+  describe "initialize" do 
+    it "sets up servers" do
+      client.servers.must_equal [
+        'irc://server1.example.org',
+        'irc://server2.example.com:7001'
+      ]
+    end
+
+    it "sets up nicknames" do
+      client.nicks.must_equal [ 'bot1', 'bot2', 'bot3' ]
+    end
+
+    it "sets up a realname" do
+      client.realname.must_equal 'I am a bot'
+    end
+
+    it "sets up a username" do
+      client.username.must_equal 'botty'
+    end
+  end
+
+  describe "attribs" do
+    it "sets servers from a single string" do
+      client.servers = 'irc://foo.bar.bazz'
+      client.servers.must_equal [ 'irc://foo.bar.bazz' ]
+    end
+
+    it "sets servers from an array" do
+      client.servers = [ 'frosty', 'snowman' ] 
+      client.servers.must_equal [ 'frosty', 'snowman' ]
+    end
+
+    it "sets nicks from a single string" do
+      client.nicks = 'peaches'
+      client.nicks.must_equal [ 'peaches' ]
+    end
+
+    it "sets nicks from an array" do
+      client.nicks = ['meaty', 'meaty', 'moo']
+      client.nicks.must_equal ['meaty', 'meaty', 'moo']
+    end
+
+    it "parses server uris" do
+      client.uris.first.host.must_equal 'server1.example.org'
+      client.uris.first.port.must_equal 6667
+      client.uris.last.host.must_equal 'server2.example.com'
+      client.uris.last.port.must_equal 7001
+    end
+  end
+
+  describe "starting and stopping" do
+    before do
+      @mock_io = MiniTest::Mock.new
+      stub(::IoUnblock::TcpSocket, :new, @mock_io)
+    end
+
+    it "starts and stops an unblocked tcp socket and waits until its running" do
+      @mock_io.expect(:start, nil)
+      @mock_io.expect(:running?, true)
+      @mock_io.expect(:stop, nil)
+      client.start
+      client.stop
+      @mock_io.verify
+    end
+  end
+
+  describe "io" do
+    before do
+      @socket = socket = UnblockedTcpSocket.new
+      stub(::IoUnblock::TcpSocket, :new) { |*a|
+        socket.init_with(*a)
+      }
+      client.start
+    end
+
+    after do
+      client.stop
+    end
+
+    describe "connecting" do
+      it "is connected once it's sent the user nick and pong" do
+        client.connected?.must_equal false
+        @socket.trigger_start
+        @socket.server_write 'PING :give tHi:S baCK!'
+        client.connected?.must_equal true
+        @socket.written.must_equal [
+          'USER botty 0 * :I am a bot',
+          'NICK bot1',
+          'PONG :give tHi:S baCK!'
+        ]
+      end
+
+      it "chooses alternate nicknames" do
+        @socket.trigger_start
+        @socket.server_write '433 * bot1 :Nickname is already in use.'
+        client.connected?.must_equal false
+        @socket.server_write '433 * bot2 :Nickname is already in use.'
+        client.connected?.must_equal false
+        @socket.server_write 'PING :0123456'
+        client.connected?.must_equal true
+        @socket.written.must_equal [
+          'USER botty 0 * :I am a bot',
+          'NICK bot1',
+          'NICK bot2',
+          'NICK bot3',
+          'PONG :0123456'
+        ]
+      end
+
+      it "shuts down if all nicknames are taken" do
+        @socket.trigger_start
+        @socket.server_write '433 * bot1 :Nickname is already in use.'
+        @socket.server_write '433 * bot2 :Nickname is already in use.'
+        @socket.server_write '433 * bot3 :Nickname is already in use.'
+        client.connected?.must_equal false
+        @socket.written.must_equal [
+          'USER botty 0 * :I am a bot',
+          'NICK bot1',
+          'NICK bot2',
+          'NICK bot3',
+          'QUIT'
+        ]
+      end
+    end
+
+    describe "events" do
+      it "binds and triggers an event based upon the command" do
+        params = nil
+        msg = nil
+        client.on_403 do |ps, m|
+          params = ps
+          msg = m
+        end
+        @socket.server_write '403 these are :my various arguments'
+        params.must_equal ['these', 'are', 'my various arguments']
+        msg.command.must_equal '403'
+        msg.source.nick.must_equal 'server1.example.org'
+      end
+
+      it "triggers an event split across multiple reads" do
+        params = nil
+        msg = nil
+        client.on_ping do |ps, m|
+          params = ps
+          msg = m
+        end
+
+        @socket.server_write_raw ':server1.example.org PI'
+        @socket.server_write_raw 'NG :echo this bac'
+        @socket.server_write_raw "k to me\r\n"
+        params.must_equal ['echo this back to me']
+        msg.command.must_equal 'PING'
+      end
+    end
+  end
+end

data/spec/ircbgb/matcher_spec.rb

@@ -0,0 +1,25 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe Ircbgb::Matcher do
+  def matcher str; Ircbgb::Matcher.new str; end
+
+  it "treats ? as any single character (/./)" do
+    match = matcher('?lAm?')
+    'flame'.must_match match
+    'bLAMe'.must_match match
+    'lLaMa'.must_match match
+    'claMer'.wont_match match
+    'lam'.wont_match match
+    'filame'.wont_match match
+    'filament'.wont_match match
+  end
+
+  it "treats * as 0 or more characters (/.*/)" do
+    match = matcher('*laM*')
+    'lam'.must_match match
+    'LaMabcdefghijklmnopqrstuvwxyz1234567890[]{}()!@#$%^&*'.must_match match
+    'abcdefghijklmnopqrstuvwxyz1234567890[]{}()!@#$%^&*lAM'.must_match match
+    'abcdefghijklmnopqrsLAMtuvwxyz1234567890[]{}()!@#$%^&*'.must_match match
+    'flMa'.wont_match match
+  end
+end

data/spec/ircbgb/message_parser_spec.rb

@@ -0,0 +1,100 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe Ircbgb::MessageParser do
+  def parse_it str
+    Ircbgb::MessageParser.parse ":#{str}\r\n"
+  end
+
+  it "parses user message without args" do
+    msg = parse_it 'my_nick!~my|user_[nam{@some.host   KiCk'
+    msg.source.nick.must_equal 'my_nick' # just to enusre we've got a user proper
+    msg.source.to_s.must_equal 'my_nick!~my|user_[nam{@some.host'
+    msg.command.must_equal 'KICK'
+    msg.params.must_equal []
+  end
+
+  it "parses user message with args" do
+    msg = parse_it '[slappy-!~figgle@scrappy.dappy.doo 919 a1,a11   b2.3    c3:88'
+    msg.source.to_s.must_equal '[slappy-!~figgle@scrappy.dappy.doo'
+    msg.command.must_equal '919'
+    msg.params.must_equal ['a1,a11', 'b2.3', 'c3:88']
+  end
+
+  it "parses user message with rest" do
+    msg = parse_it 'my_nick!my.user@my.host    PRIVmsg  :this  maintains   the spaces  '
+    msg.source.to_s.must_equal 'my_nick!my.user@my.host'
+    msg.command.must_equal 'PRIVMSG'
+    msg.params.must_equal ['this  maintains   the spaces  ']
+  end
+
+  it "parses user message with args and rest" do
+    msg = parse_it 'my_nick!my.user@my.host  part  #channel1,&channel2   limey :MOA:R  SP:ACES!'
+    msg.source.to_s.must_equal 'my_nick!my.user@my.host'
+    msg.command.must_equal 'PART'
+    msg.params.must_equal ['#channel1,&channel2', 'limey', 'MOA:R  SP:ACES!']
+  end
+
+  it "parses server message without args" do
+    msg = parse_it 'sweet.server  302'
+    msg.source.nick.must_equal 'sweet.server'
+    msg.source.to_s.must_equal 'sweet.server'
+    msg.command.must_equal '302'
+    msg.params.must_equal []
+  end
+
+  it "parses server message with args" do
+    msg = parse_it 'sweet.server  noticed  a1   a2,a3  a4:5'
+    msg.source.to_s.must_equal 'sweet.server'
+    msg.command.must_equal 'NOTICED'
+    msg.params.must_equal ['a1', 'a2,a3', 'a4:5']
+  end
+
+  it "parses server message with rest" do
+    msg = parse_it 'sweet.server  quit           :this   has spaces    !'
+    msg.source.to_s.must_equal 'sweet.server'
+    msg.command.must_equal 'QUIT'
+    msg.params.must_equal ['this   has spaces    !']
+  end
+
+  it "parses server message with args and rest" do
+    msg = parse_it 'sweet.server  Pezz    fright,:clap  beddy pram   :this : has : colons!'
+    msg.source.to_s.must_equal 'sweet.server'
+    msg.command.must_equal 'PEZZ'
+    msg.params.must_equal ['fright,:clap', 'beddy', 'pram', 'this : has : colons!']
+  end
+
+  it "parses ipv4 user hosts" do
+    msg = parse_it 'me!~notyou@123.45.67.89 mklame'
+    msg.source.host.must_equal '123.45.67.89'
+  end
+
+  it "parses ipv6 user hosts" do
+    msg = parse_it 'me!~notyou@00f:a221:03:e:1234:420b:f6:9a mklame'
+    msg.source.host.must_equal '00f:a221:03:e:1234:420b:f6:9a'
+  end
+
+  it "parses ipv4 over ipv6 hosts" do
+    msg = parse_it 'me!~notyou@0:0:0:0:0:0:1.2.3.4 mklame'
+    msg.source.host.must_equal '0:0:0:0:0:0:1.2.3.4'
+    msg = parse_it 'me!~notyou@0:0:0:0:0:FffF:1.2.3.4 mklame'
+    msg.source.host.must_equal '0:0:0:0:0:FffF:1.2.3.4'
+  end
+
+  it "does not parse malformed messages" do
+    lambda {
+      parse_it 'invalid'
+    }.must_raise ::Ircbgb::MessageFormatError
+
+    lambda {
+      parse_it 'nick!user@hostname.com       '
+    }.must_raise ::Ircbgb::MessageFormatError
+
+    lambda {
+      parse_it ''
+    }.must_raise ::Ircbgb::MessageFormatError
+
+    lambda {
+      parse_it '       '
+    }.must_raise ::Ircbgb::MessageFormatError
+  end
+end

data/spec/ircbgb/message_spec.rb

@@ -0,0 +1,39 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe Ircbgb::Message do
+  def client_message *args
+    @client_message ||= Ircbgb::Message.new(
+      Ircbgb::User.parse("nick!~user@some.host.name"),
+      'CMD',
+      ['all', 'the', 'pretty little args']
+    )
+  end
+
+  def server_message
+    @server_message ||= Ircbgb::Message.new(
+      Ircbgb::Server.new('host.domain.tld'),
+      '303',
+      []
+    )
+  end
+
+  it "parses the source" do
+    client_message.source.to_s.must_equal "nick!~user@some.host.name"
+    server_message.source.to_s.must_equal "host.domain.tld"
+  end
+
+  it "parses the command" do
+    client_message.command.must_equal 'CMD'
+    server_message.command.must_equal '303'
+  end
+
+  it "parses the parameters" do
+    client_message.params.must_equal ['all', 'the', 'pretty little args']
+    server_message.params.must_equal []
+  end
+
+  it "identifies a numeric reply" do
+    client_message.numeric?.must_equal false
+    server_message.numeric?.must_equal true
+  end
+end