ircparser 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b3ba0c73061105629280badf2eda78d434a53c09bca59f77f73397740a6f062
-  data.tar.gz: b49d3de744a1fec6d9c9fabb17ca2df3c4416dc38f8d0afe953e9d0f4587d7b9
+  metadata.gz: f2e712b24986a96105f7fc722698814542a077966bef240ffe6d4c3fcad6859f
+  data.tar.gz: 07d2480c650b4327ceba4e8b98c828846daf0e948210e4ed71bae33ffdada24d
 SHA512:
-  metadata.gz: 04633fd5973f4b80cfdfa50b7c01c75683e9ecea0fe4e087c9d410d3a6cce649158eecc57e4902909fee8900031ebe50c3b5a6c9f070363120b711d762d29de8
-  data.tar.gz: fc2a8e5cadb156963f16743d857703c3bdf4900da0f86a18a9814e13ef52532282d7eee4ba7d1ee761439d46ee7107a62a5da1eb833de330ddc8bf7e33c22762
+  metadata.gz: 725749ad9026c5873708b0586e5dc9c86822549476c0d0fd0883cda9c98100f7584d62142c3ce1b0cec06f83aea623ad40f9c567d5fce673fdeb1bb44eed9db5
+  data.tar.gz: e7a127efc3c55e5aee09c33b6782aa4d5b79d398ae6ea296d589bbf941461d452d1afcc6e8feef0b800b8d5e6b5bf070595f9486dd3f7f50c649a93eae2d791c

data/lib/ircparser.rb

@@ -1,6 +1,6 @@
 # IRCParser - Internet Relay Chat Message Parser
 #
-#   Copyright (C) 2015-2017 Peter "SaberUK" Powell <petpow@saberuk.com>
+#   Copyright (C) 2015-2019 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
@@ -16,11 +16,12 @@
 module IRCParser
 
 	# Public: The version of IRCParser in use.
-	VERSION = '0.6.0'
+	VERSION = '0.6.1'
 end
 
 require_relative 'ircparser/error'
 require_relative 'ircparser/message'
 require_relative 'ircparser/prefix'
 require_relative 'ircparser/stream'
+require_relative 'ircparser/wire/json'
 require_relative 'ircparser/wire/rfc'

data/lib/ircparser/error.rb

@@ -1,6 +1,6 @@
 # IRCParser - Internet Relay Chat Message Parser
 #
-#   Copyright (C) 2015-2017 Peter "SaberUK" Powell <petpow@saberuk.com>
+#   Copyright (C) 2015-2019 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

data/lib/ircparser/message.rb

@@ -1,6 +1,6 @@
 # IRCParser - Internet Relay Chat Message Parser
 #
-#   Copyright (C) 2015-2017 Peter "SaberUK" Powell <petpow@saberuk.com>
+#   Copyright (C) 2015-2019 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
@@ -47,12 +47,12 @@ module IRCParser
 		#
 		# line - The line to attempt to parse.
 		def self.parse line
-			return IRCParser::RFCWireFormat.objectify line.clone
+			return IRCParser::RFCWireFormat.objectify line
 		end
 
 		# Public: Serializes the message to a string.
 		def to_s
-			return IRCParser::RFCWireFormat.stringify self.clone
+			return IRCParser::RFCWireFormat.stringify self
 		end
 	end
 end

data/lib/ircparser/prefix.rb

@@ -1,6 +1,6 @@
 # IRCParser - Internet Relay Chat Message Parser
 #
-#   Copyright (C) 2015-2017 Peter "SaberUK" Powell <petpow@saberuk.com>
+#   Copyright (C) 2015-2019 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

data/lib/ircparser/stream.rb

@@ -1,6 +1,6 @@
 # IRCParser - Internet Relay Chat Message Parser
 #
-#   Copyright (C) 2015-2017 Peter "SaberUK" Powell <petpow@saberuk.com>
+#   Copyright (C) 2015-2019 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

data/lib/ircparser/wire/json.rb

@@ -0,0 +1,265 @@
+# IRCParser - Internet Relay Chat Message Parser
+#
+#   Copyright (C) 2015-2019 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.
+
+require 'json'
+
+module IRCParser
+
+	# Internal: Implements objectification and stringification for the JSON wire format.
+	module JSONWireFormat
+
+		# Internal: Objectifies a message from the JSON wire format to an IRCParser::Message.
+		#
+		# str - A String containing a message in the JSON wire format.
+		def self.objectify str
+
+			# Ruby really needs some kind of basic type checking.
+			unless str.is_a? String
+				raise IRCParser::Error.new(str), "message is not a String"
+			end
+
+			# Parse and validate the JSON object.
+			message = JSON.parse str.lstrip, max_nesting: 6 rescue nil
+			unless message.is_a? Hash
+				raise IRCParser::Error.new(str), 'message is not a JSON object'
+			end
+
+			 { tags: Hash.new, parameters: Array.new }
+
+			# Have we encountered IRCv3 message tags?
+			components = Hash.new
+			components[:tags] = if message.include? 'tags'
+				raise IRCParser::Error.new(str), 'message tags are not a JSON object' unless message[:tags].is_a? Hash
+				message[:tags]
+			else
+				Hash.new
+			end
+
+			components[:prefix] = if message.include? 'source'
+				
+			end
+
+			if current_token != nil && current_token[0] == '@'
+				components[:tags] = self.__objectify_tags current_token
+				current_token = self.__get_token message
+			end
+
+			# Have we encountered the prefix of this message?
+			if current_token != nil && current_token[0] == ':'
+				components[:prefix] = self.__objectify_prefix current_token
+				current_token = self.__get_token message
+			end
+
+			# The command parameter is mandatory.
+			if current_token != nil
+				components[:command] = current_token.upcase
+				current_token = self.__get_final_token message
+			else
+				raise IRCParser::Error.new(str), 'message is missing the command name'
+			end
+
+			# Try to parse all of the remaining parameters.
+			components[:parameters] = Array.new
+			while current_token != nil
+				components[:parameters] << current_token
+				current_token = self.__get_final_token message
+			end
+
+			return IRCParser::Message.new components
+		end
+
+		# Internal: Stringifies a message from an IRCParser::Message to the JSON wire format.
+		#
+		# obj - An IRCParser::Message to stringify to the JSON wire format.
+		def self.stringify obj
+
+			# Ruby really needs some kind of basic type checking.
+			unless obj.is_a? IRCParser::Message
+				raise IRCParser::Error.new(obj), "message is not an IRCParser::Message"
+			end
+
+			# Stringify the tags.
+			buffer = String.new
+			unless obj.tags.empty?
+				buffer += '@'
+				buffer += self.__stringify_tags obj.tags
+				buffer += ' '
+			end
+
+			# Stringify the prefix.
+			unless obj.prefix.nil?
+				buffer += ':'
+				buffer += self.__stringify_prefix obj.prefix
+				buffer += ' '
+			end
+
+			# Stringify the command.
+			buffer += obj.command
+
+			# Stringify the parameters
+			buffer += self.__stringify_parameters obj.parameters
+
+			# We're done!
+			return buffer
+		end
+
+		private
+
+		# Internal: A regular expression which matches a n!u@h mask.
+		MATCH_PREFIX = /^:(?<nick>[^@!]+)  (?:!(?<user>[^@]+))?  (?:@(?<host>.+))?$/x
+
+		# Internal: A regular expression which matches a tag.
+		MATCH_TAG = /^(?<name>[^\s=]+?)(?:=(?<value>[^\s;]+))?$/
+
+		# Internal: The characters which need to be escaped in tag values.
+		TAG_ESCAPES = {
+			'\\\\' => '\\',
+			'\:'   => ';',
+			'\s'   => "\s",
+			'\r'   => "\r",
+			'\n'   => "\n",
+		}
+
+		# Internal: Retrieves a space delimited token from the buffer.
+		#
+		# buffer - The buffer to retrieve the token from.
+		def self.__get_token buffer
+			return nil if buffer.empty?
+			position = buffer.index ' '
+			if position == nil
+				token = buffer.clone
+				buffer.clear
+				return token
+			end
+			token = buffer.slice! 0...position
+			position = buffer.index /\S+/
+			if position == nil
+				buffer.clear
+			else
+				buffer.slice! 0...position
+			end
+			return token
+		end
+
+		# Internal: Retrieves a space delimited token that may be a <trailing> parameter.
+		#
+		# buffer - The buffer to retrieve the token from.
+		def self.__get_final_token buffer
+			return nil if buffer.empty?
+			if buffer[0] == ':'
+				token = buffer[1..-1]
+				buffer.clear
+				return token
+			end
+			return self.__get_token buffer
+		end
+
+		# Internal: Objectifies the prefix from the JSON wire format to an IRCParser::Prefix.
+		#
+		# token - A String containing the prefix in the JSON wire format.
+		def self.__objectify_prefix prefix
+			unless MATCH_PREFIX =~ prefix
+				raise IRCParser::Error.new(prefix), 'prefix is not a user mask or server name'
+			end
+			return IRCParser::Prefix.new nick: $~[:nick], user: $~[:user], host: $~[:host]
+		end
+
+		# Internal: Objectifies tags from the JSON wire format to a Hash.
+		#
+		# token - A String containing tags in the JSON wire format.
+		def self.__objectify_tags token
+			tags = Hash.new
+			token[1..-1].split(';').each do |tag|
+				if tag =~ MATCH_TAG
+					value = nil
+					value_index = 0
+					while $~['value'] != nil && value_index < $~['value'].size
+						value ||= String.new
+						if $~['value'][value_index] == '\\'
+							escape = $~['value'].slice(value_index, 2)
+							if TAG_ESCAPES.include? escape
+								value += TAG_ESCAPES[escape]
+								value_index += 1
+							end
+						else
+							value += $~['value'][value_index]
+						end
+						value_index += 1
+					end
+					tags[$~['name']] = value
+				else
+					raise IRCParser::Error.new(tag), 'tag is malformed'
+				end
+			end
+			return tags
+		end
+
+		# Internal: Stringifies parameters from an Array to the JSON wire format.
+		#
+		# parameters - An Array to stringify to the JSON wire format.
+		def self.__stringify_parameters parameters
+			buffer = String.new
+			parameters.each_with_index do |parameter, index|
+				trailing = parameter.include? ' '
+				if trailing && index != parameters.size-1
+					raise IRCParser::Error.new(parameter), 'only the last parameter may contain spaces'
+				end
+
+				buffer += ' '
+				if trailing || parameter.empty?
+					buffer += ':'
+					buffer += parameter
+					break
+				end
+				buffer += parameter
+			end
+			return buffer
+		end
+
+		# Internal: Stringifies the prefix from an IRCParser::Prefix to the JSON wire format.
+		#
+		# tags - An IRCParser::Prefix to stringify to the JSON wire format.
+		def self.__stringify_prefix prefix
+			buffer = prefix.nick
+			buffer += "!#{prefix.user}" unless prefix.user.nil?
+			buffer += "@#{prefix.host}" unless prefix.host.nil?
+			return buffer
+		end
+
+		# Internal: Stringifies tags from a Hash to the JSON wire format.
+		#
+		# tags - A Hash of tags to stringify to the JSON wire format.
+		def self.__stringify_tags tags
+			buffer = String.new
+			tags.each.with_index do |tag, idx|
+				key, value = tag
+				buffer += key
+				unless value.nil?
+					buffer += '='
+					value.each_char do |chr|
+						if TAG_ESCAPES.has_value? chr
+							buffer += TAG_ESCAPES.key chr
+						else
+							buffer += chr
+						end
+					end
+				end
+				buffer += ';' if idx < tags.size - 1
+			end
+			return buffer
+		end
+
+	end
+end

data/lib/ircparser/wire/rfc.rb

@@ -1,6 +1,6 @@
 # IRCParser - Internet Relay Chat Message Parser
 #
-#   Copyright (C) 2015-2017 Peter "SaberUK" Powell <petpow@saberuk.com>
+#   Copyright (C) 2015-2019 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
@@ -25,39 +25,43 @@ module IRCParser
 
 			# Ruby really needs some kind of basic type checking.
 			unless str.is_a? String
-				raise IRCParser::Error.new(line), "message is not a string"
+				raise IRCParser::Error.new(str), "message is not a String"
 			end
 
+			# Skip any preceding whitespace. This is technically invalid but
+			# is implemented by several servers in the wild.
+			message = str.lstrip
+
 			# Split the message up into an array of tokens.
-			current_token = self.__get_token str
+			current_token = self.__get_token message
 			components = Hash.new
 
 			# Have we encountered IRCv3 message tags?
 			components[:tags] = Hash.new
 			if current_token != nil && current_token[0] == '@'
 				components[:tags] = self.__objectify_tags current_token
-				current_token = self.__get_token str
+				current_token = self.__get_token message
 			end
 
 			# Have we encountered the prefix of this message?
 			if current_token != nil && current_token[0] == ':'
 				components[:prefix] = self.__objectify_prefix current_token
-				current_token = self.__get_token str
+				current_token = self.__get_token message
 			end
 
 			# The command parameter is mandatory.
 			if current_token != nil
 				components[:command] = current_token.upcase
-				current_token = self.__get_final_token str
+				current_token = self.__get_final_token message
 			else
-				raise IRCParser::Error.new(line), 'message is missing the command name'
+				raise IRCParser::Error.new(str), 'message is missing the command name'
 			end
 
 			# Try to parse all of the remaining parameters.
 			components[:parameters] = Array.new
 			while current_token != nil
 				components[:parameters] << current_token
-				current_token = self.__get_final_token str
+				current_token = self.__get_final_token message
 			end
 
 			return IRCParser::Message.new components

data/test/test_message.rb

@@ -1,6 +1,6 @@
 # IRCParser - Internet Relay Chat Message Parser
 #
-#   Copyright (C) 2015-2017 Peter "SaberUK" Powell <petpow@saberuk.com>
+#   Copyright (C) 2015-2019 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
@@ -144,12 +144,24 @@ describe IRCParser::Message do
 		end
 	end
 
+	describe 'when checking we can handle a space before the command' do
+		before do
+			@text = ' COMMAND'
+			@message = IRCParser::Message.parse @text
+		end
+		it 'should parse the message properly' do
+			@message.command.must_equal 'COMMAND'
+			@message.parameters.size.must_equal 0
+		end
+	end
+
 	describe 'when checking we can handle a space after the command' do
 		before do
 			@text = 'COMMAND '
 			@message = IRCParser::Message.parse @text
 		end
 		it 'should parse the message properly' do
+			@message.command.must_equal 'COMMAND'
 			@message.parameters.size.must_equal 0
 		end
 	end
@@ -160,6 +172,7 @@ describe IRCParser::Message do
 			@message = IRCParser::Message.parse @text
 		end
 		it 'should parse the trailing parameter properly' do
+			@message.command.must_equal 'COMMAND'
 			@message.parameters.size.must_equal 1
 			@message.parameters[0].must_equal ''
 		end
@@ -202,4 +215,31 @@ describe IRCParser::Message do
 		end
 	end
 
+	describe 'when checking we handle parsing malformed messages properly' do
+		it 'should throw an IRCParser::Error when trying to parse an empty message' do
+			proc {
+				IRCParser::Message.parse ''
+			}.must_raise IRCParser::Error
+		end
+		it 'should throw an IRCParser::Error when trying to parse an whitespace message' do
+			proc {
+				IRCParser::Message.parse '     '
+			}.must_raise IRCParser::Error
+		end
+		it 'should throw an IRCParser::Error when trying to parse a message with tags and a prefix but no command' do
+			proc {
+				IRCParser::Message.parse '@foo;bar=baz :irc.example.com'
+			}.must_raise IRCParser::Error
+		end
+		it 'should throw an IRCParser::Error when trying to parse a message with tags but no command' do
+			proc {
+				IRCParser::Message.parse '@foo;bar=baz'
+			}.must_raise IRCParser::Error
+		end
+		it 'should throw an IRCParser::Error when trying to parse a message with a prefix but no command' do
+			proc {
+				IRCParser::Message.parse ':irc.example.com'
+			}.must_raise IRCParser::Error
+		end
+	end
 end

data/test/test_prefix.rb

@@ -1,6 +1,6 @@
 # IRCParser - Internet Relay Chat Message Parser
 #
-#   Copyright (C) 2015-2017 Peter "SaberUK" Powell <petpow@saberuk.com>
+#   Copyright (C) 2015-2019 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ircparser
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Peter "SaberUK" Powell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-12 00:00:00.000000000 Z
+date: 2019-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -69,10 +69,11 @@ files:
 - lib/ircparser/message.rb
 - lib/ircparser/prefix.rb
 - lib/ircparser/stream.rb
+- lib/ircparser/wire/json.rb
 - lib/ircparser/wire/rfc.rb
 - test/test_message.rb
 - test/test_prefix.rb
-homepage: https://github.com/SaberUK/ircparser
+homepage: https://github.com/SaberUK/ircparser-ruby
 licenses:
 - ISC
 metadata: {}
@@ -91,8 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.5
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: An IRCv3 message parser.