class Nexpose::Service
This class represents each of the /NexposeReport/nodes/node/endpoints/endpoint/services/service elements in the Nexpose
Full XML document.
It provides a convenient way to access the information scattered all over the XML in attributes and nested tags.
Instead of providing separate methods for each supported property we rely on Ruby's method_missing
to do most of the work.
Public Class Methods
Accepts an XML node from Nokogiri::XML.
# File lib/nexpose/service.rb, line 12 def initialize(xml_node) @xml = xml_node end
Public Instance Methods
This method is invoked by Ruby when a method that is not defined in this instance is called.
In our case we inspect the @method@ parameter and try to find the attribute, simple descendent or collection that it maps to in the XML tree.
# File lib/nexpose/service.rb, line 51 def method_missing(method, *args) # We could remove this check and return nil for any non-recognized tag. # The problem would be that it would make tricky to debug problems with # typos. For instance: <>.potr would return nil instead of raising an # exception unless supported_tags.include?(method) super return end # First we try the attributes. In Ruby we use snake_case, but in XML # CamelCase is used for some attributes translations_table = { } method_name = translations_table.fetch(method, method.to_s) return @xml.attributes[method_name].value if @xml.attributes.key?(method_name) # Finally the enumerations: references, tags if ['fingerprints', 'configurations'].include?(method_name) xpath_selector = { 'fingerprints' => './fingerprints/fingerprint', 'configurations' => './configuration/config' }[method_name] @xml.xpath(xpath_selector).collect do |xml_item| {:text => xml_item.text}.merge( Hash[ xml_item.attributes.collect do |name, xml_attribute| [name.sub(/-/,'_').to_sym, xml_attribute.value] end ] ) end else # nothing found, the tag is valid but not present in this ReportItem return nil end end
This allows external callers (and specs) to check for implemented properties
# File lib/nexpose/service.rb, line 40 def respond_to?(method, include_private=false) return true if supported_tags.include?(method.to_sym) super end
Convert each ./test/test entry into a simple hash
# File lib/nexpose/service.rb, line 31 def tests(*args) @xml.xpath('./tests/test').map do |xml_test| Nexpose::Test.new(xml_test) end end