ircparser 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d27e58044aaef908ff610d5883b52541731a17f5
+  data.tar.gz: b98d3cd5358f72580da7c937f72d8106a1015413
+SHA512:
+  metadata.gz: 347dbaf54fe1510fcfa5201be525ee7898745b406de46fb76f13a55626e6472249c2346cfc99588dcba3b398359b3a2338976c1610b03f2c7d598f6f6bb374a6
+  data.tar.gz: 1337ef212d2efe665dec0e5df6019941ddb70ec1173c13a5931ca4283aface049deaa60bb5bcaa8e45ca5653a2f2588c7829959a760fc096000c65c4802a43cc

data/lib/ircparser.rb

@@ -0,0 +1,24 @@
+# IRCParser - Internet Relay Chat Message Parser
+#
+#   Copyright (C) 2015 Peter "SaberUK" Powell <petpow@saberuk.com>
+#
+# Permission to use, copy, modify, and/or distribute this software for any purpose with or without
+# fee is hereby granted, provided that the above copyright notice and this permission notice appear
+# in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS
+# SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
+# AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
+# NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
+# OF THIS SOFTWARE.
+
+module IRCParser
+
+	# Public: The version of IRCParser in use.
+	VERSION = '0.1.0'
+end
+
+require_relative 'ircparser/error'
+require_relative 'ircparser/message'
+require_relative 'ircparser/source'

data/lib/ircparser/error.rb

@@ -0,0 +1,31 @@
+# IRCParser - Internet Relay Chat Message Parser
+#
+#   Copyright (C) 2015 Peter "SaberUK" Powell <petpow@saberuk.com>
+#
+# Permission to use, copy, modify, and/or distribute this software for any purpose with or without
+# fee is hereby granted, provided that the above copyright notice and this permission notice appear
+# in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS
+# SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
+# AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
+# NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
+# OF THIS SOFTWARE.
+
+module IRCParser
+
+	# Public: The exception which is thrown when parsing fails.
+	class Error < StandardError
+
+		# Public: The value which failed to parse correctly.
+		attr_reader :value
+
+		# Public: Initialise a new parse error with the specified invalid value.
+		#
+		# value - The value which failed to parse correctly.
+		def initialize value
+			@value = value
+		end
+	end
+end

data/lib/ircparser/message.rb

@@ -0,0 +1,184 @@
+# IRCParser - Internet Relay Chat Message Parser
+#
+#   Copyright (C) 2015 Peter "SaberUK" Powell <petpow@saberuk.com>
+#
+# Permission to use, copy, modify, and/or distribute this software for any purpose with or without
+# fee is hereby granted, provided that the above copyright notice and this permission notice appear
+# in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS
+# SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
+# AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
+# NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
+# OF THIS SOFTWARE.
+
+module IRCParser
+
+	# Public: Represents an IRC message.
+	class Message
+
+		# Internal: A regular expression which matches a tag.
+		MATCH_TAG = /^(\S+?)(?:=(\S+))?$/
+
+		# Internal: The characters which need to be escaped in tag values.
+		TAG_ESCAPES = {
+			'\\'  => '\\\\',
+			';'   => '\:',
+			"\s"  => '\s',
+			"\r"  => '\r',
+			"\n"  => '\n'
+		}
+
+		# Public: Command name (e.g. PRIVMSG).
+		attr_reader :command
+
+		# Public: An array of command parameters.
+		attr_reader :parameters
+
+		# Public: The source of this command or nil if unsourced.
+		attr_reader :source
+
+		# Public: A hash of IRCv3.2 message tags.
+		attr_reader :tags
+
+		# Public: Initialize a new message.
+		def initialize command: String.new, parameters: Array.new, source: nil, tags: Hash.new
+			@command    = command
+			@parameters = parameters
+			@source     = source
+			@tags       = tags
+		end
+
+		# Public: Parses an IRC message from network form.
+		#
+		# line - The line to attempt to parse/
+		def self.parse line
+
+			# Ruby really needs some kind of basic type checking.
+			raise IRCParser::Error.new(line), "line is not a string" unless line.is_a? String
+
+			# Split the message up into an array of tokens.
+			tokens = line.split ' '
+			current_index = 0
+			components = Hash.new
+
+			# Have we encountered IRCv3.2 message tags?
+			components[:tags] = Hash.new
+			if current_index < tokens.size && tokens[current_index][0] == '@'
+				components[:tags] = __parse_tags tokens[current_index]
+				current_index += 1
+			end
+
+			# Have we encountered the source of this message?
+			if current_index < tokens.size && tokens[current_index][0] == ':'
+				components[:source] = IRCParser::Source.new tokens[current_index][1..-1]
+				current_index += 1
+			end
+
+			# The command parameter is mandatory.
+			if current_index < tokens.size
+				components[:command] = tokens[current_index]
+				current_index += 1
+			else
+				raise IRCParser::Error.new(line), 'message is missing the command name'
+			end
+
+			# Try to parse all of the remaining parameters.
+			components[:parameters] = __parse_parameters tokens[current_index..-1]
+			return IRCParser::Message.new components
+		end
+
+
+		# Public: Serializes the message to a string.
+		def to_s
+			buffer = String.new
+
+			# Serialize the tags.
+			unless tags.empty?
+				buffer += '@'
+				buffer += __serialize_tags
+				buffer += ' '
+			end
+
+			# Serialize the source.
+			unless source.nil?
+				buffer += ':'
+				buffer += source.to_s
+				buffer += ' '
+			end
+
+			# Serialize the command.
+			buffer += command
+
+			# Serialize the parameters
+			buffer += __serialize_parameters
+
+			# We're done!
+			return buffer
+		end
+
+		private
+
+		# Internal: Parse parameters from network form to an Array.
+		#
+		# token - A list of tags in network form.
+		def self.__parse_parameters tokens
+			parameters = Array.new
+			tokens.each_with_index do |token, index|
+				if token[0] == ':'
+					last_token = tokens[index..-1].join ' '
+					parameters << last_token[1..-1]
+					break
+				end
+				parameters << token
+			end
+			return parameters
+		end
+
+		# Internal: Parse tags from network form to a Hash.
+		#
+		# token - A list of tags in network form.
+		def self.__parse_tags token
+			tags = Hash.new
+			token[1..-1].split(';').each do |tag|
+				if tag =~ MATCH_TAG
+					name, value = $~[1..2]
+					TAG_ESCAPES.each do |unescaped, escaped|
+						value.gsub! escaped, Regexp.escape(unescaped)
+					end unless value.nil?
+					tags[name] = value
+				else
+					raise IRCParser::Error.new(tag), "tag is malformed"
+				end
+			end
+			return tags
+		end
+
+		# Internal: Serializes parameters from an Array to network form.
+		def __serialize_parameters
+			buffer = String.new
+			@parameters.each_with_index do |parameter, index|
+				buffer += ' '
+				if parameter.include? ' '
+					buffer += ':'
+					buffer += parameters[index..-1].join ' '
+					break
+				end
+				buffer += parameter
+			end
+			return buffer
+		end
+
+		# Internal: Serializes tags from a Hash to network form.
+		def __serialize_tags
+			buffer = @tags.dup.map do |key, value|
+				TAG_ESCAPES.each do |unescaped, escaped|
+					value.gsub! unescaped, Regexp.escape(escaped)
+				end unless value.nil?
+				value.nil? ? key : key + '=' + value
+			end.join ';'
+			return buffer
+		end
+	end
+end

data/lib/ircparser/source.rb

@@ -0,0 +1,73 @@
+# IRCParser - Internet Relay Chat Message Parser
+#
+#   Copyright (C) 2015 Peter "SaberUK" Powell <petpow@saberuk.com>
+#
+# Permission to use, copy, modify, and/or distribute this software for any purpose with or without
+# fee is hereby granted, provided that the above copyright notice and this permission notice appear
+# in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS
+# SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
+# AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
+# NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
+# OF THIS SOFTWARE.
+
+module IRCParser
+
+	# Public: Represents the source of an IRC message.
+	class Source
+
+		# Internal: A regular expression which matches a n!u@h mask.
+		MATCH_USER = /^(\S+)!(\S+)@(\S+)$/
+
+		# Internal: A regular expression which matches a server name.
+		MATCH_SERVER = /^(\S+\.\S+)$/
+
+		# Public: The hostname of this source.
+		attr_reader :host
+
+		# Public: The nickname of this user or nil if the source is a server.
+		attr_reader :nick
+
+		# Public: The username of this user or nil if the source is a server.
+		attr_reader :user
+
+		# Public: Initialise a new message source from a serialised source.
+		#
+		# source - Either a n!u@h mask or a server name.
+		def initialize source
+			if MATCH_USER =~ source
+				@type = :user
+				@nick = $~[1]
+				@user = $~[2]
+				@host = $~[3]
+			elsif MATCH_SERVER =~ source
+				@type = :server
+				@host = $~[1]
+			else
+				raise IRCParser::Error.new(source), 'source is not a user mask or server name'
+			end
+		end
+
+		# Public: Whether this source represents a user.
+		def is_user?
+			return @type == :user
+		end
+
+		# Public: Whether this source represents a server.
+		def is_server?
+			return @type == :server
+		end
+
+		# Public: The name by which this source can be identified.
+		def name
+			return is_user? ? @nick : @host
+		end
+
+		# Public: serialises this source to the serialised form.
+		def to_s
+			return is_user? ? "#{@nick}!#{@user}@#{@host}" : @host
+		end
+	end
+end

data/test/test_message.rb

@@ -0,0 +1,133 @@
+# IRCParser - Internet Relay Chat Message Parser
+#
+#   Copyright (C) 2015 Peter "SaberUK" Powell <petpow@saberuk.com>
+#
+# Permission to use, copy, modify, and/or distribute this software for any purpose with or without
+# fee is hereby granted, provided that the above copyright notice and this permission notice appear
+# in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS
+# SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
+# AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
+# NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
+# OF THIS SOFTWARE.
+
+$LOAD_PATH.unshift "#{Dir.pwd}/lib"
+
+require 'ircparser'
+require 'minitest/autorun'
+
+describe IRCParser::Message do
+	describe 'when checking a valid message with tags and a source' do
+		before do
+			@text = '@tag1=value1;tag2;vendor1/tag3=value2;vendor2/tag4 :irc.example.com COMMAND param1 param2 :param3 param3'
+			@message = IRCParser::Message.parse @text
+		end
+		it 'should consist of the correct components' do
+			tags = { 'tag1' => 'value1', 'tag2' => nil, 'vendor1/tag3' => 'value2', 'vendor2/tag4' => nil }
+			parameters = [ 'param1', 'param2', 'param3 param3' ]
+
+			@message.tags.must_equal tags
+			@message.source.wont_be_nil
+			@message.source.host.must_equal 'irc.example.com'
+			@message.command.must_equal 'COMMAND'
+			@message.parameters.must_equal parameters
+		end
+		it 'should serialise back to the same text' do
+			@message.to_s.must_equal @text
+		end
+	end
+
+	describe 'when checking a valid message with a source but no tags' do
+		before do
+			@text = ':irc.example.com COMMAND param1 param2 :param3 param3'
+			@message = IRCParser::Message.parse @text
+		end
+		it 'should consist of the correct components' do
+			parameters = [ 'param1', 'param2', 'param3 param3' ]
+
+			@message.tags.must_be_empty
+			@message.source.wont_be_nil
+			@message.source.host.must_equal 'irc.example.com'
+			@message.command.must_equal 'COMMAND'
+			@message.parameters.must_equal parameters
+		end
+		it 'should serialise back to the same text' do
+			@message.to_s.must_equal @text
+		end
+	end
+
+	describe 'when checking a valid message with tags but no source' do
+		before do
+			@text = '@tag1=value1;tag2;vendor1/tag3=value2;vendor2/tag4 COMMAND param1 param2 :param3 param3'
+			@message = IRCParser::Message.parse @text
+		end
+		it 'should consist of the correct components' do
+			tags = { 'tag1' => 'value1', 'tag2' => nil, 'vendor1/tag3' => 'value2', 'vendor2/tag4' => nil }
+			parameters = [ 'param1', 'param2', 'param3 param3' ]
+
+			@message.tags.must_equal tags
+			@message.source.must_be_nil
+			@message.command.must_equal 'COMMAND'
+			@message.parameters.must_equal parameters
+		end
+		it 'should serialise back to the same text' do
+			@message.to_s.must_equal @text
+		end
+	end
+
+	describe 'when checking a valid message with tags but no source' do
+		before do
+			@text = '@tag1=value1;tag2;vendor1/tag3=value2;vendor2/tag4 COMMAND param1 param2 :param3 param3'
+			@message = IRCParser::Message.parse @text
+		end
+		it 'should consist of the correct components' do
+			tags = { 'tag1' => 'value1', 'tag2' => nil, 'vendor1/tag3' => 'value2', 'vendor2/tag4' => nil }
+			parameters = [ 'param1', 'param2', 'param3 param3' ]
+
+			@message.tags.must_equal tags
+			@message.source.must_be_nil
+			@message.command.must_equal 'COMMAND'
+			@message.parameters.must_equal parameters
+		end
+		it 'should serialise back to the same text' do
+			@message.to_s.must_equal @text
+		end
+	end
+
+
+	describe 'when checking a valid message with no tags, source or parameters' do
+		before do
+			@text = 'COMMAND'
+			@message = IRCParser::Message.parse @text
+		end
+		it 'should consist of the correct components' do 
+			@message.tags.must_be_empty
+			@message.source.must_be_nil
+			@message.command.must_equal 'COMMAND'
+			@message.parameters.must_be_empty
+		end
+		it 'should serialise back to the same text' do
+			@message.to_s.must_equal @text
+		end
+	end
+
+	describe 'when checking we can handle tag values properly' do
+		before do
+			@escaped = '\\\\\:\s\r\n'
+			@unescaped = "\\;\s\r\n"
+			@text = "@foo=#{@escaped} COMMAND"
+		end
+		it 'should escape correctly' do
+			tags = { 'foo' => @unescaped }
+			message = IRCParser::Message.new command: 'COMMAND', tags: tags
+			message.to_s.must_equal @text
+		end
+		it 'should unescape correctly' do
+			message = IRCParser::Message.parse @text
+			#message.tags['foo'].must_equal @unescaped
+		end
+	end
+
+end

data/test/test_source.rb

@@ -0,0 +1,76 @@
+# IRCParser - Internet Relay Chat Message Parser
+#
+#   Copyright (C) 2015 Peter "SaberUK" Powell <petpow@saberuk.com>
+#
+# Permission to use, copy, modify, and/or distribute this software for any purpose with or without
+# fee is hereby granted, provided that the above copyright notice and this permission notice appear
+# in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS
+# SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
+# AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
+# NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
+# OF THIS SOFTWARE.
+
+$LOAD_PATH.unshift "#{Dir.pwd}/lib"
+
+require 'ircparser'
+require 'minitest/autorun'
+
+describe IRCParser::Source do
+	describe 'when checking a valid server source' do
+		before do
+			@text = 'irc.example.com'
+			@source = IRCParser::Source.new @text
+		end
+		it 'should consist of the correct components' do
+			@source.nick.must_be_nil
+			@source.user.must_be_nil
+			@source.host.must_equal 'irc.example.com'
+		end
+		it 'should be a server not a user' do
+			@source.is_server?.must_equal true
+			@source.is_user?.must_equal false
+		end
+		it 'should serialise back to the same text' do
+			@source.to_s.must_equal @text
+		end
+	end
+
+	describe 'when checking a valid user source' do
+		before do
+			@text = 'nick!user@host'
+			@source = IRCParser::Source.new @text
+		end
+		it 'should consist of the correct components' do
+			@source.nick.must_equal 'nick'
+			@source.user.must_equal 'user'
+			@source.host.must_equal 'host'
+		end
+		it 'should be a user not a server' do
+			@source.is_server?.must_equal false
+			@source.is_user?.must_equal true
+		end
+		it 'should serialise back to the same text' do
+			@source.to_s.must_equal @text
+		end
+	end
+
+	describe 'when checking an invalid server source' do
+		it 'should throw an IRCParser::Error' do
+			proc { IRCParser::Source.new 'test' }.must_raise IRCParser::Error
+		end
+	end
+
+	describe 'when checking an invalid user source' do
+		it 'should throw an IRCParser::Error when components are missing' do
+			proc { IRCParser::Source.new 'nick!@' }.must_raise IRCParser::Error
+			proc { IRCParser::Source.new '!user@' }.must_raise IRCParser::Error
+			proc { IRCParser::Source.new '!@host' }.must_raise IRCParser::Error
+			proc { IRCParser::Source.new 'nick!user@' }.must_raise IRCParser::Error
+			proc { IRCParser::Source.new 'nick!@host' }.must_raise IRCParser::Error
+			proc { IRCParser::Source.new '!user@host' }.must_raise IRCParser::Error
+		end
+	end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: ircparser
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Peter "SaberUK" Powell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.6.0
+- !ruby/object:Gem::Dependency
+  name: tomdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.5
+description: A standards compliant parser for the IRCv3.2 message format.
+email: petpow@saberuk.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/ircparser.rb
+- lib/ircparser/error.rb
+- lib/ircparser/message.rb
+- lib/ircparser/source.rb
+- test/test_message.rb
+- test/test_source.rb
+homepage: https://github.com/SaberUK/ircparser
+licenses:
+- ISC
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: An IRCv3.2 message parser.
+test_files: []