irc_parser 0.1.0

data/spec/irc_parser/rfc1459/4_2_channel_operations/4_2_1_join_message_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+describe IRCParser, "parsing join msg" do
+
+  it_parses "JOIN #foobar" do |msg|
+    msg.channels.should == ["#foobar"]
+    msg.keys.should == []
+  end
+
+  it_parses "JOIN &foo fubar" do |msg|
+    msg.channels.should == ["&foo"]
+    msg.keys.should == ["fubar"]
+  end
+
+  it_parses "JOIN #foo,&bar fubar" do |msg|
+    msg.channels.should == ["#foo", "&bar"]
+    msg.keys.should == ["fubar"]
+  end
+
+  it_parses "JOIN #foo,#bar fubar,foobar" do |msg|
+    msg.channels.should == ["#foo", "#bar"]
+    msg.keys.should == ["fubar", "foobar"]
+  end
+
+  it_parses "JOIN #foo,#bar" do |msg|
+    msg.channels.should == ["#foo", "#bar"]
+    msg.keys.should == []
+  end
+
+  it_parses ":WiZ JOIN #Twilight_zone" do |msg|
+    msg.channels.should == ["#Twilight_zone"]
+    msg.keys.should == []
+    msg.prefix.should == "WiZ"
+  end
+
+  #-------------------------------------------------------------------------------
+
+  it_generates IRCParser::Messages::Join, "JOIN #foobar" do |msg|
+    msg.channels= ["#foobar"]
+  end
+
+  it_generates IRCParser::Messages::Join, "JOIN &foo fubar" do |msg|
+    msg.channels= ["&foo"]
+    msg.keys= ["fubar"]
+  end
+
+  it_generates IRCParser::Messages::Join, "JOIN #foo,&bar fubar" do |msg|
+    msg.channels= ["#foo", "&bar"]
+    msg.keys= ["fubar"]
+  end
+
+  it_generates IRCParser::Messages::Join, "JOIN #foo,#bar fubar,foobar" do |msg|
+    msg.channels= ["#foo", "#bar"]
+    msg.keys= ["fubar", "foobar"]
+  end
+
+  it_generates IRCParser::Messages::Join, "JOIN #foo,#bar" do |msg|
+    msg.channels= ["#foo", "#bar"]
+  end
+
+  it_generates IRCParser::Messages::Join, ":WiZ JOIN #Twilight_zone" do |msg|
+    msg.channels= ["#Twilight_zone"]
+    msg.prefix= "WiZ"
+  end
+end

data/spec/irc_parser/rfc1459/4_2_channel_operations/4_2_2_part_message_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe IRCParser, "parsing part msg" do
+
+  it_parses "PART #twilight_zone" do |msg|
+    msg.channels.should == ["#twilight_zone"]
+  end
+
+  it_parses "PART #oz-ops,&group5" do |msg|
+    msg.channels.should == ["#oz-ops", "&group5"]
+  end
+
+  #-------------------------------------------------------------------------------
+
+  it_generates IRCParser::Messages::Part,  "PART #twilight_zone" do |msg|
+    msg.channels= ["#twilight_zone"]
+  end
+
+  it_generates IRCParser::Messages::Part,  "PART #oz-ops,&group5" do |msg|
+    msg.channels= ["#oz-ops", "&group5"]
+  end
+
+end

data/spec/irc_parser/rfc1459/4_2_channel_operations/4_2_3_1_channel_modes_spec.rb

@@ -0,0 +1,159 @@
+require 'spec_helper'
+
+describe IRCParser, "parsing channel modes" do
+
+  # ; Makes #Finnish channel moderated and 'invite-only'.
+  it_parses "MODE #Finnish +im" do |msg|
+    msg.target.should == "#Finnish"
+    msg.user.should be_nil
+
+    msg.flags.should == "+im"
+    msg.should be_chan_flags_include_invite_only
+    msg.should be_chan_invite_only
+    msg.should be_chan_flags_include_moderated
+    msg.should be_chan_moderated
+  end
+
+  # ; Gives 'chanop' privileges to Kilroy on channel #Finnish.
+  it_parses "MODE #Finnish +o Kilroy" do |msg|
+    msg.target.should == "#Finnish"
+    msg.user.should == "Kilroy"
+
+    msg.flags.should == "+o"
+    msg.should be_chan_flags_include_operator
+    msg.should be_chan_operator
+  end
+
+  # ; Allow WiZ to speak on #Finnish.
+  it_parses "MODE #Finnish +v Wiz" do |msg|
+    msg.target.should == "#Finnish"
+    msg.user.should == "Wiz"
+
+    msg.flags.should == "+v"
+    msg.should be_chan_flags_include_speaker
+    msg.should be_chan_speaker
+  end
+
+  # ; Removes 'secret' flag from channel #Fins.
+  it_parses "MODE #Fins -s" do |msg|
+    msg.target.should == "#Fins"
+    msg.user.should be_nil
+
+    msg.flags.should == "-s"
+    msg.should be_chan_flags_include_secret
+    msg.should_not be_chan_secret
+  end
+
+  # ; Set the channel limit to "oulu".
+  it_parses "MODE #42 +k oulu" do |msg|
+    msg.target.should == "#42"
+    msg.limit.should == "oulu"
+
+    msg.flags.should == "+k"
+    msg.should be_chan_flags_include_password
+    msg.should be_chan_password
+  end
+
+  # ; Set the limit for the number of users on channel to 10.
+  it_parses "MODE #eu-opers +l 10" do |msg|
+    msg.target.should == "#eu-opers"
+    msg.limit.should == "10"
+
+    msg.flags.should == "+l"
+    msg.should be_chan_flags_include_users_limit
+    msg.should be_chan_users_limit
+  end
+
+  # ; list ban masks set for target.
+  it_parses "MODE &oulu +b" do |msg|
+    msg.target.should == "&oulu"
+    msg.limit.should be_nil
+
+    msg.flags.should == "+b"
+    msg.should be_chan_flags_include_ban_mask
+    msg.should be_chan_ban_mask
+  end
+
+  # ; prevent all users from joining.
+  it_parses "MODE &oulu +b *!*@*" do |msg|
+    msg.target.should == "&oulu"
+    msg.ban_mask.should == "*!*@*"
+
+    msg.flags.should == "+b"
+    msg.should be_chan_flags_include_ban_mask
+    msg.should be_chan_ban_mask
+  end
+
+  # ; prevent any user from a hostname matching *.edu from joining.
+  it_parses "MODE &oulu +b *!*@*.edu" do |msg|
+    msg.target.should == "&oulu"
+    msg.ban_mask.should == "*!*@*.edu"
+
+    msg.flags.should == "+b"
+    msg.should be_chan_flags_include_ban_mask
+    msg.should be_chan_ban_mask
+  end
+
+  #-------------------------------------------------------------------------------
+
+  it_generates IRCParser::Messages::Mode, "MODE #Finnish +im" do |msg|
+    msg.target = "#Finnish"
+    msg.positive_flags!
+    msg.chan_invite_only!
+    msg.chan_moderated!
+  end
+
+  it_generates IRCParser::Messages::Mode, "MODE #Finnish +o Kilroy" do |msg|
+    msg.target = "#Finnish"
+    msg.user= "Kilroy"
+    msg.positive_flags!
+    msg.chan_operator!
+  end
+
+  it_generates IRCParser::Messages::Mode, "MODE #Finnish +v Wiz" do |msg|
+    msg.target = "#Finnish"
+    msg.user= "Wiz"
+    msg.positive_flags!
+    msg.chan_speaker!
+  end
+
+  it_generates IRCParser::Messages::Mode, "MODE #Fins -s" do |msg|
+    msg.target = "#Fins"
+    msg.negative_flags!
+    msg.chan_secret!
+  end
+
+  it_generates IRCParser::Messages::Mode, "MODE #42 +k oulu" do |msg|
+    msg.target = "#42"
+    msg.limit= "oulu"
+    msg.positive_flags!
+    msg.chan_password!
+  end
+
+  it_generates IRCParser::Messages::Mode, "MODE #eu-opers +l 10" do |msg|
+    msg.target = "#eu-opers"
+    msg.limit= "10"
+    msg.positive_flags!
+    msg.chan_users_limit!
+  end
+
+  it_generates IRCParser::Messages::Mode, "MODE &oulu +b" do |msg|
+    msg.target = "&oulu"
+    msg.positive_flags!
+    msg.chan_ban_mask!
+  end
+
+  it_generates IRCParser::Messages::Mode, "MODE &oulu +b *!*@*" do |msg|
+    msg.target = "&oulu"
+    msg.ban_mask= "*!*@*"
+    msg.positive_flags!
+    msg.chan_ban_mask!
+  end
+
+  it_generates IRCParser::Messages::Mode, "MODE &oulu +b *!*@*.edu" do |msg|
+    msg.target = "&oulu"
+    msg.ban_mask= "*!*@*.edu"
+    msg.positive_flags!
+    msg.chan_ban_mask!
+  end
+end

data/spec/irc_parser/rfc1459/4_2_channel_operations/4_2_3_2_user_modes_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe IRCParser, "parsing user modes" do
+
+  it_parses "MODE WiZ -w" do |msg| # ; turns reception of WALLOPS messages off for WiZ.
+    msg.target.should == "WiZ"
+
+    msg.flags.should == "-w"
+    msg.should be_user_flags_include_wallops_receptor
+    msg.should_not be_user_wallops_receptor
+  end
+
+  it_parses ":Angel MODE Angel +i" do |msg| # ; Message from Angel to make themselves invisible.
+    msg.target.should == "Angel"
+    msg.prefix.should == "Angel"
+
+    msg.flags.should == "+i"
+    msg.should be_user_flags_include_invisible
+    msg.should be_user_invisible
+  end
+
+  # ; WiZ 'deopping' (removing operator status).  The plain reverse of this command
+  # ("MODE WiZ +o") must not be allowed from users since would bypass the OPER command.
+  it_parses "MODE WiZ -o" do |msg|
+    msg.target.should == "WiZ"
+
+    msg.flags.should == "-o"
+    msg.should be_user_flags_include_operator
+    msg.should_not be_user_operator
+  end
+
+  #------------------------------------------------------------------------------
+
+  it_generates IRCParser::Messages::Mode, "MODE WiZ -w" do |msg| # ; turns reception of WALLOPS messages off for WiZ.
+    msg.target= "WiZ"
+    msg.negative_flags!
+    msg.user_wallops_receptor!
+  end
+
+  it_generates IRCParser::Messages::Mode, ":Angel MODE Angel +i" do |msg| # ; Message from Angel to make themselves invisible.
+    msg.prefix = "Angel"
+    msg.target= "Angel"
+
+    msg.positive_flags!
+    msg.user_invisible!
+  end
+
+  it_generates IRCParser::Messages::Mode, "MODE WiZ -o" do |msg|
+    msg.target= "WiZ"
+
+    msg.negative_flags!
+    msg.user_operator!
+  end
+
+end

data/spec/irc_parser/rfc1459/4_2_channel_operations/4_2_4_topic_message_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe IRCParser, "parsing topic msg" do
+
+  it_parses ":Wiz TOPIC #test :New topic" do |msg| # ;User Wiz setting the topic.
+    msg.channel.should == "#test"
+    msg.topic.should == "New topic"
+  end
+
+  it_parses "TOPIC #test :another topic" do |msg| # ;set the topic on #test to "anothe topic".
+    msg.channel.should == "#test"
+    msg.topic.should == "another topic"
+  end
+
+  it_parses "TOPIC #test" do |msg| # ; check the topic for #test.
+    msg.channel.should == "#test"
+    msg.topic.should be_nil
+  end
+
+  #------------------------------------------------------------------------------
+
+  it_generates IRCParser::Messages::Topic, ":Wiz TOPIC #test :New topic" do |msg| # ;User Wiz setting the topic.
+    msg.prefix= "Wiz"
+    msg.channel= "#test"
+    msg.topic= "New topic"
+  end
+
+  it_generates IRCParser::Messages::Topic, "TOPIC #test :another topic" do |msg| # ;set the topic on #test to "anothe topic".
+    msg.channel= "#test"
+    msg.topic= "another topic"
+  end
+
+  it_generates IRCParser::Messages::Topic, "TOPIC #test" do |msg| # ; check the topic for #test.
+    msg.channel= "#test"
+  end
+end

data/spec/irc_parser/rfc1459/4_2_channel_operations/4_2_5_names_message_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe IRCParser, "parsing names msg" do
+
+  # ; list visible users on #twilight_zone and #42 if the channels are visible to you.
+  it_parses "NAMES #twilight_zone,#42" do |msg|
+    msg.channels.should == ["#twilight_zone", "#42"]
+  end
+
+  # ; list all visible channels and users
+  it_parses "NAMES" do |msg|
+    msg.channels.should == []
+  end
+
+  #------------------------------------------------------------------------------
+
+  # ; list visible users on #twilight_zone and #42 if the channels are visible to you.
+  it_generates IRCParser::Messages::Names, "NAMES #twilight_zone,#42" do |msg|
+    msg.channels= ["#twilight_zone", "#42"]
+  end
+
+  # ; list all visible channels and users
+  it_generates IRCParser::Messages::Names, "NAMES" do |msg|
+  end
+end

data/spec/irc_parser/rfc1459/4_2_channel_operations/4_2_6_list_message_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe IRCParser, "parsing list msg" do
+
+  # ; List all channels.
+  it_parses "LIST" do |msg|
+    msg.channels.should == []
+  end
+
+  # ; List channels #twilight_zone and #42
+  it_parses "LIST #twilight_zone,#42"  do |msg|
+    msg.channels.should == ["#twilight_zone", "#42"]
+  end
+
+  #------------------------------------------------------------------------------
+
+  it_generates IRCParser::Messages::List, "LIST" do |msg|
+  end
+
+  it_generates IRCParser::Messages::List, "LIST #twilight_zone,#42"  do |msg|
+    msg.channels= ["#twilight_zone", "#42"]
+  end
+end

data/spec/irc_parser/rfc1459/4_2_channel_operations/4_2_7_invite_message_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe IRCParser, "parsing invite msg" do
+
+  # ; User Angel inviting WiZ to channel #Dust
+  it_parses ":Angel INVITE Wiz #Dust" do |msg|
+    msg.channel.should == "#Dust"
+    msg.prefix.should == "Angel"
+    msg.to_nick.should == "Wiz"
+  end
+
+  # ; Command to invite WiZ to #Twilight_zone
+  it_parses "INVITE Wiz #Twilight_Zone"  do |msg|
+    msg.channel.should == "#Twilight_Zone"
+    msg.prefix.should be_nil
+    msg.to_nick.should == "Wiz"
+  end
+
+  #------------------------------------------------------------------------------
+
+  it_generates IRCParser::Messages::Invite, ":Angel INVITE Wiz #Dust" do |msg|
+    msg.channel= "#Dust"
+    msg.prefix= "Angel"
+    msg.to_nick= "Wiz"
+  end
+
+  it_generates IRCParser::Messages::Invite, "INVITE Wiz #Twilight_Zone"  do |msg|
+    msg.channel= "#Twilight_Zone"
+    msg.to_nick= "Wiz"
+  end
+end

data/spec/irc_parser/rfc1459/4_2_channel_operations/4_2_8_kick_command_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe IRCParser, "parsing kick command" do
+
+  # ; Kick Matthew from &Melbourne
+  it_parses "KICK &Melbourne Matthew" do |msg|
+    msg.channels.should == ["&Melbourne"]
+    msg.users.should == ["Matthew"]
+    msg.kick_message.should be_nil
+  end
+
+  # ; Kick Matthew and Jason from &Melbourne and #other
+  it_parses "KICK &Melbourne,#other Matthew,Jason" do |msg|
+    msg.channels.should == ["&Melbourne", "#other"]
+    msg.users.should == ["Matthew", "Jason"]
+    msg.kick_message.should be_nil
+  end
+
+  # ; Kick John from #Finnish using "Speaking English" as the reason (comment).
+  it_parses "KICK #Finnish John :Speaking English" do |msg|
+    msg.channels.should == ["#Finnish"]
+    msg.users.should == ["John"]
+    msg.kick_message.should == "Speaking English"
+  end
+
+  # ; KICK msg from WiZ to remove John from channel #Finnish
+  it_parses ":WiZ KICK #Finnish John" do |msg|
+    msg.prefix.should == "WiZ"
+    msg.channels.should == ["#Finnish"]
+    msg.users.should == ["John"]
+  end
+
+  #------------------------------------------------------------------------------
+
+  it_generates IRCParser::Messages::Kick, "KICK &Melbourne Matthew" do |msg|
+    msg.channels= ["&Melbourne"]
+    msg.users= ["Matthew"]
+  end
+
+  it_generates IRCParser::Messages::Kick, "KICK &Melbourne,#other Matthew,Jason" do |msg|
+    msg.channels= ["&Melbourne", "#other"]
+    msg.users= ["Matthew", "Jason"]
+  end
+
+  it_generates IRCParser::Messages::Kick, "KICK #Finnish John :Speaking English" do |msg|
+    msg.channels = "#Finnish"
+    msg.users = "John"
+    msg.kick_message = "Speaking English"
+  end
+
+  it_generates IRCParser::Messages::Kick, ":WiZ KICK #Finnish John" do |msg|
+    msg.prefix= "WiZ"
+    msg.channels= ["#Finnish"]
+    msg.users= ["John"]
+  end
+end