Class: Punchblock::RayoNode

Inherits:
Object show all
Defined in:
lib/punchblock/rayo_node.rb

Constant Summary collapse

@@registrations = 
{}

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#client ⇒ Object

Returns the value of attribute client.



22
23
24
 
# File 'lib/punchblock/rayo_node.rb', line 22

def client
  @client
end

#connection ⇒ Object

Returns the value of attribute connection.



22
23
24
 
# File 'lib/punchblock/rayo_node.rb', line 22

def connection
  @connection
end

#original_component ⇒ Object

Returns the value of attribute original_component.



22
23
24
 
# File 'lib/punchblock/rayo_node.rb', line 22

def original_component
  @original_component
end

Class Method Details

.class_from_registration(name, ns = nil) ⇒ Class?

Find the class to use given the name and namespace of a stanza

Parameters:

  • name (#to_s) —

    the name to lookup

  • xmlns (String, nil) —

    the namespace the node belongs to

Returns:

  • (Class, nil) —

    the class appropriate for the name/ns combination



43
44
45
 
# File 'lib/punchblock/rayo_node.rb', line 43

def self.class_from_registration(name, ns = nil)
  @@registrations[[name.to_s, ns]]
end

.from_xml(node, call_id = nil, component_id = nil, uri = nil, timestamp = nil) ⇒ Object

Import an XML::Node to the appropriate class

Looks up the class the node should be then creates it based on the elements of the XML::Node

Parameters:

  • node (XML::Node) —

    the node to import

Returns:

  • the appropriate object based on the node name and namespace



53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/punchblock/rayo_node.rb', line 53

def self.from_xml(node, call_id = nil, component_id = nil, uri = nil, timestamp = nil)
  ns = (node.namespace.href if node.namespace)
  klass = class_from_registration(node.name, ns)
  if klass && klass != self
    klass.from_xml node, call_id, component_id
  else
    new.inherit node
  end.tap do |event|
    event.target_call_id = call_id
    event.component_id = component_id
    event.source_uri = uri
    event.timestamp = timestamp if timestamp
  end
end

.register(name, ns = nil) ⇒ Object

Register a new stanza class to a name and/or namespace

This registers a namespace that is used when looking up the class name of the object to instantiate when a new stanza is received

Parameters:

  • name (#to_s) —

    the name of the node

  • ns (String, nil) (defaults to: nil) —

    the namespace the node belongs to



32
33
34
35
36
 
# File 'lib/punchblock/rayo_node.rb', line 32

def self.register(name, ns = nil)
  self.registered_name = name.to_s
  self.registered_ns = ns.is_a?(Symbol) ? RAYO_NAMESPACES[ns] : ns
  @@registrations[[self.registered_name, self.registered_ns]] = self
end

Instance Method Details

#==(o) ⇒ Object 



80
81
82
 
# File 'lib/punchblock/rayo_node.rb', line 80

def ==(o)
  o.is_a?(self.class) && self.comparable_attributes == o.comparable_attributes
end

#inherit(xml_node) ⇒ Object 



68
69
70
71
72
73
74
 
# File 'lib/punchblock/rayo_node.rb', line 68

def inherit(xml_node)
  xml_node.attributes.each do |key, attr_node|
    setter_method = "#{key.gsub('-', '_')}="
    send setter_method, xml_node[key] if respond_to?(setter_method)
  end
  self
end

#inspect ⇒ Object Also known as: to_s 



76
77
78
 
# File 'lib/punchblock/rayo_node.rb', line 76

def inspect
  "#<#{self.class} #{to_hash.map { |k, v| "#{k}=#{v.inspect}" }.compact * ', '}>"
end

#rayo_attributes ⇒ Object 



92
93
94
 
# File 'lib/punchblock/rayo_node.rb', line 92

def rayo_attributes
  {}
end

#rayo_children(root) ⇒ Object 



96
97
 
# File 'lib/punchblock/rayo_node.rb', line 96

def rayo_children(root)
end

#source ⇒ RayoNode

Returns the original command issued that lead to this event.

Returns:

  • (RayoNode) —

    the original command issued that lead to this event



87
88
89
90
 
# File 'lib/punchblock/rayo_node.rb', line 87

def source
  @source ||= client.find_component_by_uri source_uri if client && source_uri
  @source ||= original_component
end

#to_rayo(parent = nil) ⇒ Object 



99
100
101
102
103
104
105
106
107
 
# File 'lib/punchblock/rayo_node.rb', line 99

def to_rayo(parent = nil)
  parent = parent.parent if parent.is_a?(Nokogiri::XML::Builder)
  Nokogiri::XML::Builder.with(parent) do |xml|
    xml.send(registered_name,
      {xmlns: registered_ns}.merge(rayo_attributes.delete_if { |k,v| v.nil? })) do |root|
      rayo_children root
    end
  end.doc.root
end

#to_xml ⇒ Object 



109
110
111
 
# File 'lib/punchblock/rayo_node.rb', line 109

def to_xml
  to_rayo.to_xml
end