apache-vhosts-parser 0.1

data/lib/apache-vhosts-parser.rb

@@ -0,0 +1,89 @@
+module ApacheVhostsParser
+
+	class Config
+		attr_reader :vhosts
+
+
+		def initialize tag
+			@tag = tag
+
+			@vhosts = @tag[:children].keep_if do |child|
+				child[:name] == 'virtualhost'
+			end.each do |vhost|
+
+				vhost[:addresses] = vhost[:arguments].map do |hp|
+					host, port = hp.split(':')
+					{
+						host: host,
+						port: port ? port.to_i : nil
+					}
+				end
+
+				(vhost[:children] || []).each do |nested|
+					if nested[:type] == 'directive'
+						case nested[:name]
+						when 'servername'
+							vhost[:server_name] = nested[:arguments].first
+						when 'documentroot'
+							vhost[:document_root] = nested[:arguments].first
+						end
+					end
+				end
+			end
+		end
+
+		def urlFor dir
+			vhosts.each do |h|
+				if h[:document_root] == dir
+					return h[:server_name]
+				end
+			end
+			return nil
+		end
+	end
+
+	def self.parseString str
+		vhosts = []
+
+		tag = {
+			children: []
+		}
+
+		str.split(/\n+/).map(&:strip).each do |line|
+			if m = line.match(/<\s*(\w+)(.*?)>$/)
+				opener, rest = m[1], m[2].to_s.strip.split(/\s+/)
+				new_tag = {
+					name: opener.downcase,
+					type: 'tag',
+					original_name: opener,
+					arguments: rest,
+					parent: tag,
+					children: []
+				}
+				tag[:children] << new_tag
+				tag = new_tag
+			elsif closer = line[/<\/\s*(\w+)>$/, 1]
+				if closer.downcase == tag[:name]
+					tag = tag[:parent]
+				else
+					throw "Mismatched closing tag: #{closer} for #{tag[:original_name]}"
+				end
+			else
+				directive, *arguments = line.split(/\s+/)
+				tag[:children] << {
+					name: directive.downcase,
+					arguments: arguments,
+					type: 'directive',
+					original_name: directive,
+					parent: tag
+				}
+			end
+		end
+
+		return Config.new(tag)
+	end
+
+	def self.parseDirectory dir='/etc/apache2/sites-enabled/'
+		parseString Dir.glob(File.join(dir, '*')).map(&File.method(:read)).join "\n"
+	end
+end

data/spec/apache_vhosts_parser_spec.rb

@@ -0,0 +1,96 @@
+require 'apache-vhosts-parser'
+
+describe 'Parser' do
+	it 'should find one virtualhost' do
+		str = <<-eos
+			<VirtualHost>
+				ServerName localhost
+			</VirtualHost>
+		eos
+
+		conf = ApacheVhostsParser.parseString(str)
+		expect(conf.vhosts.count).to be 1
+	end
+
+	it 'should find one virtualhost with *:80 as addresses' do
+		str = <<-eos
+			<VirtualHost *:80>
+				ServerName localhost
+			</VirtualHost>
+		eos
+
+		res = ApacheVhostsParser.parseString(str)
+		expect(res.vhosts.count).to be 1
+		expect(res.vhosts.first[:addresses]).to eq [{host: '*', port: 80}]
+	end
+
+	it 'should find one virtualhost with *:80 and 127.0.0.1:8080 as addresses' do
+		str = <<-eos
+			<VirtualHost *:80 127.0.0.1:8080 1.2.3.4>
+				ServerName localhost
+			</VirtualHost>
+		eos
+
+		res = ApacheVhostsParser.parseString(str)
+		expect(res.vhosts.count).to be 1
+		expect(res.vhosts.first[:addresses]).to eq [
+			{host: '*', port: 80},
+			{host: '127.0.0.1', port: 8080},
+			{host: '1.2.3.4', port: nil}
+		]
+	end
+
+	it 'should find one virtualhost with servername localhost' do
+		str = <<-eos
+			<VirtualHost>
+				ServerName localhost
+			</VirtualHost>
+		eos
+
+		res = ApacheVhostsParser.parseString(str)
+		expect(res.vhosts.count).to be 1
+		expect(res.vhosts.first[:server_name]).to eq 'localhost'
+	end
+
+	it 'should find 2 virtualhosts' do
+		str = <<-eos
+			<VirtualHost>
+				ServerName localhost
+			</VirtualHost>
+
+			<VirtualHost>
+				ServerName example.com
+			</VirtualHost>
+		eos
+
+		res = ApacheVhostsParser.parseString(str)
+		expect(res.vhosts.count).to be 2
+		expect(res.vhosts.first[:server_name]).to eq 'localhost'
+		expect(res.vhosts.last[:server_name]).to eq 'example.com'
+	end
+
+	it 'should find one virtualhost with document root /var/www/example.com' do
+		str = <<-eos
+			<VirtualHost>
+				DocumentRoot /var/www/example.com
+				ServerName localhost
+			</VirtualHost>
+		eos
+
+		res = ApacheVhostsParser.parseString(str)
+		expect(res.vhosts.count).to be 1
+		expect(res.vhosts.first[:document_root]).to eq '/var/www/example.com'
+	end
+
+	it 'should find the URL for /var/www/example.com to be example.com' do
+		str = <<-eos
+			<VirtualHost>
+				DocumentRoot /var/www/example.com
+				ServerName example.com
+			</VirtualHost>
+		eos
+
+		res = ApacheVhostsParser.parseString(str)
+		expect(res.urlFor '/var/www/example.com').to eq 'example.com'
+	end
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: apache-vhosts-parser
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- François-Marie de Jouvencel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-19 00:00:00.000000000 Z
+dependencies: []
+description: Parses apache2 vhosts. Have a look at the spec files to see how the API
+  works!
+email: fm.de.jouvencel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/apache-vhosts-parser.rb
+- spec/apache_vhosts_parser_spec.rb
+homepage: https://github.com/djfm/apache-vhosts-parser
+licenses:
+- OSL
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Sometimes you need some info from an Apache vhosts file or directory. This
+  gem helps.
+test_files: []