class Nexpose::Endpoint

This class represents each of the /NexposeReport/nodes/node/endpoints/endpoint 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

new(xml_node) click to toggle source

Accepts an XML node from Nokogiri::XML.

# File lib/nexpose/endpoint.rb, line 13
def initialize(xml_node)
  @xml = xml_node
end

Public Instance Methods

label() click to toggle source

Save some time with a meta attribute, e.g. 80/tcp (open)

# File lib/nexpose/endpoint.rb, line 35
def label
  "#{self.port}/#{self.protocol} (#{self.status})"
end
method_missing(method, *args) click to toggle source

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.

Calls superclass method
# File lib/nexpose/endpoint.rb, line 59
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)

  return nil
end
respond_to?(method, include_private=false) click to toggle source

This allows external callers (and specs) to check for implemented properties

Calls superclass method
# File lib/nexpose/endpoint.rb, line 48
def respond_to?(method, include_private=false)
  return true if supported_tags.include?(method.to_sym)
  super
end
services() click to toggle source

Each of the services associated with this endpoint. Returns an array of Nexpose::Service objects

# File lib/nexpose/endpoint.rb, line 41
def services
  @xml.xpath('./services/service').collect { |xml_service| Service.new(xml_service) }
end
supported_tags() click to toggle source

List of supported tags. They can be attributes, simple descendans or collections (e.g. <references/>, <tags/>)

# File lib/nexpose/endpoint.rb, line 19
def supported_tags
  [
    # meta
    :label,

    # attributes
    :protocol, :port, :status,

    # simple tags

    # multiple tags
    :services
  ]
end