iosparse 0.0.3 → 0.0.4

data/README.md

@@ -2,7 +2,7 @@ IOSParse will parse Cisco IOS configuration files, more functionality coming.
 
 # How do I use it?
 Good question.  First install it using `gem install iosparse`.  
-Then use it.  Create a new IOSParse object and pass it filename of the Cisco IOS config file (usually a show all type of dump file).  Then ask it questions:
+Then use it.  Create a new IOSParse object passing it the filename of the Cisco IOS config file (usually a show all type of dump file).  Then ask it questions:
 
 ````
 config = IOSParse.new('path/to/ios.conf')

data/iosparse.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = "iosparse"
-  s.version = "0.0.3"
+  s.version = "0.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ari Mizrahi"]

data/lib/iosparse.rb

@@ -16,23 +16,33 @@ class IOSParse
 	end
 
 	#
-	# Find all interfaces in the configuration file
+	# Find all interfaces
 	#
 	def interfaces
 		# Regex to parse out interfaces
 		interfaces = /\["interface[\s\S]+/
-		# Call findblocks() passing regex, parent name, and parse boolean
-		findblocks(interfaces, "interface", false)
+		# Call find_blocks() passing regex, parent name, and parse boolean
+		find_blocks(interfaces, "interface", false)
 	end
 
 	#
-	# Find all names in the configuration file
+	# Find all interfaces in monitor mode
+	#
+	def monitor_interfaces
+		# Regex to parse out the monitor interfaces
+		interfaces = /monitor-interface.+/
+		# Call find_lines() passing regex, parent name, and parse boolean
+		find_lines(interfaces, "monitor-interface", false)
+	end
+
+	#
+	# Find all names
 	#
 	def names
 		# Regex to parse out names
 		names = /\["names[\s\S]+/
-		# Call findblocks() passing regex, parent name, and parse boolean
-		findblocks(names, "names", false)
+		# Call find_blocks() passing regex, parent name, and parse boolean
+		find_blocks(names, "names", false)
 	end
 
 	#
@@ -41,18 +51,18 @@ class IOSParse
 	def routes
 		# Regex to parse out routes
 		routes = /\["route[\s\S]+/
-		# Call findblocks() passing regex, parent name, and parse boolean
-		findblocks(routes, "route", false)
+		# Call find_blocks() passing regex, parent name, and parse boolean
+		find_blocks(routes, "route", false)
 	end
 
 	#
-	# Find all ACL
+	# Find all access-lists
 	#
 	def access_list
 		# Regex to parse out acl
 		acl = /access-list[\s\S]+/
-		# Call findblocks() passing regex, parent name, and parse boolean
-		findblocks(acl, "access-list", true)
+		# Call find_blocks() passing regex, parent name, and parse boolean
+		find_blocks(acl, "access-list", true)
 	end
 
 	#
@@ -61,8 +71,8 @@ class IOSParse
 	def object_group
 		# Regex to parse out object-groups
 		group = /object-group[\s\S]+/
-		# Call findblocks() passing regex, parent name, and parse boolean
-		findblocks(group, "object-group", true)
+		# Call find_blocks() passing regex, parent name, and parse boolean
+		find_blocks(group, "object-group", true)
 	end
 
 	private
@@ -70,7 +80,7 @@ class IOSParse
 	#
 	# Primary method to accept regex and parent, then use them to parse blocks and store them in an Array
 	#
-	def findblocks(filter, parent, parse = true)
+	def find_blocks(filter, parent, parse)
 		# Array to store parsed blocks
 		output = Array.new
 		@blocks.each do |block|
@@ -79,7 +89,7 @@ class IOSParse
 		end
 		# Some parents are not within "!" blocks and require some extra work
 		if parse == true then
-			parse_parent(clean_object_group(output), parent)
+			parse_parent(clean_parent(output), parent)
 		else
 			# Return the parsed block as an array
 			output
@@ -87,9 +97,28 @@ class IOSParse
 	end
 
 	#
-	# Remove extra characters from object-groups
+	# Primary method to accept regex and parent, then use them to parse lines and store them in an Array
 	#
-	def clean_object_group(block)
+	def find_lines(filter, parent, parse)
+		# Array to store parsed blocks
+		output = Array.new
+		@blocks.each do |block|
+			# Use regex to filter via scan() then split each line
+			block.to_s.match(filter).to_s.split('\n').each do |line|
+				# Skip unless the parent is in the line
+				next unless line.match(filter)
+				# Push matches to array
+				output << normalize_line(line.match(filter))
+			end
+		end
+		# Return the parsed block as an array
+		output
+	end
+
+	#
+	# Remove extra characters from parents
+	#
+	def clean_parent(block)
 		# Array to store parsed blocks
 		output = Array.new
 		block.each do |line| 
@@ -101,23 +130,44 @@ class IOSParse
 	end
 
 	#
-	# Some parents come as a single string, we break each parents into a string and push into an array
+	# Some parents come as a single string, we break each parent into a string and push into an array
 	#
 	def parse_parent(block, parent)
 		# Array to store parsed blocks
 		output = Array.new
 		block.each do |line|
 			# Split the line where each parent begins
-			line.to_s.split(parent).each do |push|
+			line.to_s.split(parent).each do |data|
 				# Skip empty lines
-				next if push.include?('["')
+				next if data.include?('["')
 				# Remove extra "] characters from each line
-				push = push.gsub('"]', '')
+				data = data.gsub('"]', '')
 				# Re-add parent to the beginning of the line and push it into the array line-by-line
-				output << "[\"#{parent}#{push}\"]"
+				output << "[\"#{parent}#{data}\"]"
 			end
 		end
 		# Return the parsed block as an array
 		output
 	end
+
+	#
+	# Normalize block to standardize returned arrays
+	#
+	def normalize_block(block)
+		# Array to store normalized data
+		output = Array.new
+		block.each do |data|
+			# Normalize data
+			output << "[\"#{data}\\\\n\"]"
+		end
+		# Return the normalized array
+		output
+	end
+
+	#
+	# Normalize line to standardize returned arrays
+	def normalize_line(data)
+		# Return normalized data
+		"[\"#{data}\\\\n\"]"
+	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iosparse
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors: