irc_parser 0.1.0

data/spec/irc_parser/helper_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe IRCParser::Helper, "in general" do
+
+  def with_channel_helpers(str)
+    str.tap { |str| str.extend(IRCParser::Helper::Channel) }
+  end
+
+  def with_nick_helpers(str)
+    str.tap { |str| str.extend(IRCParser::Helper::NicknameHelpers) }
+  end
+
+  it "knows valid and invalid nick names" do
+    with_nick_helpers("emmanuel").should be_valid_nick
+    with_nick_helpers("1emmanuel").should_not be_valid_nick
+  end
+
+  it "knows valid and invalid channel names, and channel modes" do
+    IRCParser::Helper::CHANNEL_PREFIXES.values.each do |prefix|
+      with_channel_helpers("#{prefix}hola").should be_valid_channel_name
+      with_channel_helpers("#{prefix}hola").should_not be_invalid_channel_name
+    end
+
+    with_channel_helpers("hola").should be_invalid_channel_name
+    with_channel_helpers("hola").should_not be_valid_channel_name
+
+    with_channel_helpers("+hola").should be_modeless_channel
+    with_channel_helpers("#hola").should be_normal_channel
+    with_channel_helpers("!hola").should be_safe_channel
+    with_channel_helpers("&hola").should be_local_channel
+  end
+end

data/spec/irc_parser/irc_parser_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe IRCParser do
+  it "provides a helper method to generate messages" do
+    IRCParser.message("MODE", nil, ["nick"]).to_s.should == "MODE nick\r\n"
+    IRCParser.message("MODE") { |msg| msg.target = "nick" }.to_s.should == "MODE nick\r\n"
+  end
+
+  it "provides a helper method to generate messages" do
+    IRCParser.message("PASS") { |msg| msg.password = "pass" }.to_s.should == "PASS pass\r\n"
+  end
+end

data/spec/irc_parser/messages_spec.rb

@@ -0,0 +1,195 @@
+require 'spec_helper'
+describe IRCParser::Messages do
+  context "Factories" do
+
+    context "in general" do
+      context "commands" do
+        SomeCommand = IRCParser::Messages.message_class(:SomeCommand)
+        subject { SomeCommand  }
+
+        its(:name)           { should == :SomeCommand }
+        its(:to_sym)         { should == :some_command }
+        its(:identifier)     { should == :SOMECOMMAND }
+        its(:postfix_format) { should == nil }
+        its(:is_error?)      { should be_false }
+        its(:is_reply?)      { should be_false }
+        its(:is_command?)    { should be_true }
+      end
+
+      context "errors" do
+        ErrSomeError = IRCParser::Messages.message_class(:ErrSomeError, "1400")
+        subject { ErrSomeError }
+
+        its(:name)           { should == :ErrSomeError }
+        its(:to_sym)         { should == :err_some_error }
+        its(:identifier)     { should == :"1400" }
+        its(:postfix_format) { should == nil }
+        its(:is_error?)      { should be_true }
+        its(:is_reply?)      { should be_false }
+        its(:is_command?)    { should be_false }
+      end
+
+      context "replies" do
+        RplSomeReply = IRCParser::Messages.message_class(:RplSomeReply, "1300")
+        subject { RplSomeReply }
+
+        its(:name)           { should == :RplSomeReply }
+        its(:to_sym)         { should == :rpl_some_reply }
+        its(:identifier)     { should == :"1300" }
+        its(:postfix_format) { should == nil }
+        its(:is_error?)      { should be_false }
+        its(:is_reply?)      { should be_true }
+        its(:is_command?)    { should be_false }
+      end
+    end
+
+    context "parameter-less messages" do
+      ParamLess = IRCParser::Messages.message_class :ParamLess
+
+      let(:message) { ParamLess.new }
+
+      it "generates a parameter-less message" do
+        message.to_s.should == "PARAMLESS\r\n"
+      end
+
+      it "generates a parameter-less message with prefix" do
+        message.prefix = "someone"
+        message.to_s.should == ":someone PARAMLESS\r\n"
+      end
+
+      it "generates a parameter-less message with postfix" do
+        message.postfix = "something cool"
+        message.to_s.should == "PARAMLESS :something cool\r\n"
+      end
+
+      it "generates a parameter-less message with prefix and postfix" do
+        message.prefix = "someone"
+        message.postfix = "something cool"
+        message.to_s.should == ":someone PARAMLESS :something cool\r\n"
+      end
+    end
+
+    context "one parameter" do
+      OneParam = IRCParser::Messages.message_class :OneParam, :nick
+
+      let(:message) { OneParam.new "", ["Tony"] }
+
+      it "generates a message with one parameter" do
+        message.to_s.should == "ONEPARAM Tony\r\n"
+      end
+
+      it "generates a message with prefix" do
+        message.prefix = "someone"
+        message.to_s.should == ":someone ONEPARAM Tony\r\n"
+      end
+
+      it "generates a message with postfix" do
+        message.postfix = "something cool"
+        message.to_s.should == "ONEPARAM Tony :something cool\r\n"
+      end
+
+      it "generates a message with prefix and postfix" do
+        message.prefix = "someone"
+        message.postfix = "something cool"
+        message.to_s.should == ":someone ONEPARAM Tony :something cool\r\n"
+      end
+    end
+
+    context "two parameters" do
+      TwoParams = IRCParser::Messages.message_class :TwoParams, {:nick => {:default => "*"}}, :name
+
+      let(:message) { TwoParams.new "", ["Tony", "Motola"] }
+
+      it "defaults to * for missing fields with defaults" do
+        TwoParams.new.to_s.should == "TWOPARAMS *\r\n"
+        TwoParams.new("", ["Moncho", nil]).to_s.should == "TWOPARAMS Moncho\r\n"
+        TwoParams.new("", ["", "Moncho"]).to_s.should == "TWOPARAMS * Moncho\r\n"
+      end
+
+      it "generates a message with one parameter" do
+        message.to_s.should == "TWOPARAMS Tony Motola\r\n"
+      end
+
+      it "generates a message with prefix" do
+        message.prefix = "someone"
+        message.to_s.should == ":someone TWOPARAMS Tony Motola\r\n"
+      end
+
+      it "generates a with postfix" do
+        message.postfix = "something cool"
+        message.to_s.should == "TWOPARAMS Tony Motola :something cool\r\n"
+      end
+
+      it "generates a message with prefix and postfix" do
+        message.prefix = "someone"
+        message.postfix = "something cool"
+        message.to_s.should == ":someone TWOPARAMS Tony Motola :something cool\r\n"
+      end
+    end
+
+    context "parameters with configuration" do
+      WithConfig = IRCParser::Messages.message_class :WithConfig, {:nick => {:default => "Titus"}}, {:names => {:csv => " "}}
+
+      let(:message) { WithConfig.new "", ["", ["Tito", "Puente"]] }
+
+      it "generates a message with the defaults fill up" do
+        message.to_s.should == "WITHCONFIG Titus Tito Puente\r\n"
+      end
+
+      it "generates a message with prefix" do
+        message.prefix = "someone"
+        message.to_s.should == ":someone WITHCONFIG Titus Tito Puente\r\n"
+      end
+
+      it "generates a message with postfix" do
+        message.postfix = "something cool"
+        message.to_s.should == "WITHCONFIG Titus Tito Puente :something cool\r\n"
+      end
+
+      it "generates a message with prefix and postfix" do
+        message.prefix = "someone"
+        message.postfix = "something cool"
+        message.to_s.should == ":someone WITHCONFIG Titus Tito Puente :something cool\r\n"
+      end
+    end
+
+    context "defining classes" do
+      IRCParser::Messages.define_message(:MyCommand)
+      IRCParser::Messages.define_message(:ErrMyErr, "1200")
+      IRCParser::Messages.define_message(:RplMyRpl, "1600")
+
+      it "defines classes in the Messages namespace" do
+        defined?(IRCParser::Messages::MyCommand).should be_true
+        defined?(IRCParser::Messages::ErrMyErr).should be_true
+        defined?(IRCParser::Messages::RplMyRpl).should be_true
+      end
+
+      it "is able to retrieve the classes with different keys" do
+        IRCParser.message_class(:"MyCommand"). should == IRCParser::Messages::MyCommand
+        IRCParser.message_class(:"MYCOMMAND"). should == IRCParser::Messages::MyCommand
+        IRCParser.message_class(:my_command).  should == IRCParser::Messages::MyCommand
+        IRCParser.message_class("my_command"). should == IRCParser::Messages::MyCommand
+        IRCParser.message_class("MYCOMMAND").  should == IRCParser::Messages::MyCommand
+
+        IRCParser.message_class(:"ERRMYERR").  should == IRCParser::Messages::ErrMyErr
+        IRCParser.message_class(:"ErrMyErr").  should == IRCParser::Messages::ErrMyErr
+        IRCParser.message_class(:err_my_err).  should == IRCParser::Messages::ErrMyErr
+        IRCParser.message_class("ERRMYERR").   should == IRCParser::Messages::ErrMyErr
+        IRCParser.message_class("ErrMyErr").   should == IRCParser::Messages::ErrMyErr
+        IRCParser.message_class("err_my_err"). should == IRCParser::Messages::ErrMyErr
+        IRCParser.message_class("1200").       should == IRCParser::Messages::ErrMyErr
+        IRCParser.message_class(1200).         should == IRCParser::Messages::ErrMyErr
+
+        IRCParser.message_class(:"RPLMYRPL").  should == IRCParser::Messages::RplMyRpl
+        IRCParser.message_class(:"RplMyRpl").  should == IRCParser::Messages::RplMyRpl
+        IRCParser.message_class(:rpl_my_rpl).  should == IRCParser::Messages::RplMyRpl
+        IRCParser.message_class("RPLMYRPL").   should == IRCParser::Messages::RplMyRpl
+        IRCParser.message_class("RplMyRpl").   should == IRCParser::Messages::RplMyRpl
+        IRCParser.message_class("rpl_my_rpl"). should == IRCParser::Messages::RplMyRpl
+        IRCParser.message_class("1600").       should == IRCParser::Messages::RplMyRpl
+        IRCParser.message_class(1600).         should == IRCParser::Messages::RplMyRpl
+      end
+    end
+
+  end
+end

data/spec/irc_parser/parser_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe IRCParser, "parser" do
+  it "raises an exception on bad msg" do |message|
+    expect { IRCParser.parse("fail\r\n") }.to raise_error(IRCParser::ParserError)
+    expect { IRCParser.parse("LALALA nick\r\n") }.to raise_error(IRCParser::ParserError)
+    expect { IRCParser.parse("PASS nick\r\n") }.to_not raise_error(IRCParser::ParserError)
+  end
+end

data/spec/irc_parser/rfc1459/4_1_connection_registration/4_1_1_password_message_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe IRCParser, "parsing password msg" do
+
+  it_parses "PASS secretpasswordhere" do |msg|
+    msg.password.should == "secretpasswordhere"
+  end
+
+  it_parses "PASS" do |msg|
+    msg.password.should == nil
+  end
+
+  it_parses "PASS :" do |msg|
+    msg.password.should == ""
+  end
+
+  it_generates IRCParser::Messages::Pass, "PASS" do |msg|
+    msg.password = ""
+  end
+
+  it_generates IRCParser::Messages::Pass, "PASS" do |msg|
+    msg.password = nil
+  end
+
+  it_generates IRCParser::Messages::Pass, "PASS secretpasswordhere" do |msg|
+    msg.password = "secretpasswordhere"
+  end
+end

data/spec/irc_parser/rfc1459/4_1_connection_registration/4_1_2_nick_message_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe IRCParser, "parsing nick msg" do
+
+  it_parses "NICK Wiz" do |msg| # Introducing new nick "Wiz".
+    msg.nick.should == "Wiz"
+    msg.hopcount.should be_nil
+  end
+
+  it_parses "NICK Wiz 10" do |msg| # nick "Wiz" with hopcount.
+    msg.nick.should == "Wiz"
+    msg.hopcount.should == "10"
+  end
+
+  it_parses ":WiZ NICK Kilroy" do |msg| # WiZ changed his nickname to Kilroy.
+    msg.nick.should == "Kilroy"
+    msg.prefix.should == "WiZ"
+  end
+
+  #------------------------------------------------------------------------------
+
+  it_generates IRCParser::Messages::Nick, "NICK Wiz" do |msg| # Introducing new nick "Wiz".
+    msg.nick = "Wiz"
+  end
+
+  it_generates IRCParser::Messages::Nick, "NICK Wiz 10" do |msg| # nick "Wiz" with hopcount.
+    msg.nick = "Wiz"
+    msg.hopcount = "10"
+  end
+
+  it_generates IRCParser::Messages::Nick, ":WiZ NICK Kilroy" do |msg| # WiZ changed his nickname to Kilroy.
+    msg.nick = "Kilroy"
+    msg.prefix = "WiZ"
+  end
+end

data/spec/irc_parser/rfc1459/4_1_connection_registration/4_1_3_user_message_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe IRCParser, "parsing user msg" do
+
+  it_parses "USER guest tolmoon tolsun :Ronnie Reagan" do |msg|
+    msg.mode.should       == "tolmoon"
+    msg.realname.should  == "Ronnie Reagan"
+    msg.servername.should == "tolsun"
+    msg.user.should       == "guest"
+  end
+
+  it_parses ":testnick USER guest tolmoon tolsun :Ronnie Reagan" do |msg|
+    msg.mode.should       == "tolmoon"
+    msg.prefix.should     == "testnick"
+    msg.realname.should  == "Ronnie Reagan"
+    msg.servername.should == "tolsun"
+    msg.user.should       == "guest"
+  end
+
+  #------------------------------------------------------------------------------
+
+  it_generates IRCParser::Messages::User, "USER guest tolmoon tolsun :Ronnie Reagan" do |msg|
+    msg.mode= "tolmoon"
+    msg.realname= "Ronnie Reagan"
+    msg.servername= "tolsun"
+    msg.user= "guest"
+  end
+
+  it_generates IRCParser::Messages::User, ":testnick USER guest tolmoon tolsun :Ronnie Reagan" do |msg|
+    msg.servername= "tolsun"
+    msg.mode= "tolmoon"
+    msg.prefix= "testnick"
+    msg.realname= "Ronnie Reagan"
+    msg.user= "guest"
+  end
+
+  it_generates IRCParser::Messages::User, "USER guest * * :Ronnie Reagan" do |msg|
+    msg.realname= "Ronnie Reagan"
+    msg.user= "guest"
+  end
+
+  it_generates IRCParser::Messages::User, ":testnick USER guest * * :Ronnie Reagan" do |msg|
+    msg.prefix= "testnick"
+    msg.user= "guest"
+    msg.realname= "Ronnie Reagan"
+  end
+end

data/spec/irc_parser/rfc1459/4_1_connection_registration/4_1_4_server_message_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe IRCParser, "parsing server msg" do
+
+  it_parses "SERVER test.oulu.fi 1 :[tolsun.oulu.fi] Experimental server" do |msg|
+    msg.server.should == "test.oulu.fi"
+    msg.hopcount.should == 1
+    msg.info.should == "[tolsun.oulu.fi] Experimental server"
+  end
+
+  it_parses ":tolsun.oulu.fi SERVER csd.bu.edu 5 :BU Central Server" do |msg|
+    msg.prefix.should == "tolsun.oulu.fi"
+    msg.server.should == "csd.bu.edu"
+    msg.hopcount.should == 5
+    msg.info.should == "BU Central Server"
+  end
+
+  #------------------------------------------------------------------------------
+
+  it_generates IRCParser::Messages::Server, "SERVER test.oulu.fi 1 :[tolsun.oulu.fi] Experimental server" do |msg|
+    msg.server= "test.oulu.fi"
+    msg.hopcount= 1
+    msg.info= "[tolsun.oulu.fi] Experimental server"
+  end
+
+  it_generates IRCParser::Messages::Server, ":tolsun.oulu.fi SERVER csd.bu.edu 5 :BU Central Server" do |msg|
+    msg.prefix= "tolsun.oulu.fi"
+    msg.server= "csd.bu.edu"
+    msg.hopcount= 5
+    msg.info= "BU Central Server"
+  end
+
+end

data/spec/irc_parser/rfc1459/4_1_connection_registration/4_1_5_oper_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe IRCParser, "parsing oper" do
+
+  it_parses "OPER foo bar" do |msg|
+    msg.user.should == "foo"
+    msg.password.should == "bar"
+  end
+
+  #------------------------------------------------------------------------------
+
+  it_generates IRCParser::Messages::Oper, "OPER foo bar" do |msg|
+    msg.user= "foo"
+    msg.password= "bar"
+  end
+
+end

data/spec/irc_parser/rfc1459/4_1_connection_registration/4_1_6_quit_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe IRCParser, "parsing quit" do
+
+  it_parses ":some_nick!some_user@some_server QUIT :Gone to have lunch" do |msg|
+    msg.prefix.should == "some_nick!some_user@some_server"
+    msg.quit_message.should == "Gone to have lunch"
+  end
+
+  #------------------------------------------------------------------------------
+
+  it_generates IRCParser::Messages::Quit, ":some_nick!some_user@some_server QUIT :Gone to have lunch" do |msg|
+    msg.prefix = "some_nick!some_user@some_server"
+    msg.quit_message= "Gone to have lunch"
+  end
+
+end

data/spec/irc_parser/rfc1459/4_1_connection_registration/4_1_7_server_quit_message_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe IRCParser, "parsing server quit msg" do
+
+  it_parses "SQUIT tolsun.oulu.fi :Bad Link ?" do |msg|
+    msg.server.should == "tolsun.oulu.fi"
+    msg.reason.should == "Bad Link ?"
+  end
+
+  it_parses ":Trillian SQUIT cm22.eng.umd.edu :Server out of control" do |msg|
+    msg.server.should == "cm22.eng.umd.edu"
+    msg.reason.should == "Server out of control"
+    msg.prefix.should == "Trillian"
+    msg.server.should == "cm22.eng.umd.edu"
+    msg.reason.should == "Server out of control"
+  end
+
+  #------------------------------------------------------------------------------
+
+  it_generates IRCParser::Messages::SQuit, "SQUIT tolsun.oulu.fi :Bad Link ?" do |msg|
+    msg.server= "tolsun.oulu.fi"
+    msg.reason= "Bad Link ?"
+  end
+
+  it_generates IRCParser::Messages::SQuit, ":Trillian SQUIT cm22.eng.umd.edu :Server out of control" do |msg|
+    msg.server= "cm22.eng.umd.edu"
+    msg.reason= "Server out of control"
+    msg.prefix= "Trillian"
+    msg.server= "cm22.eng.umd.edu"
+    msg.reason= "Server out of control"
+  end
+end