Class: Punchblock::RayoNode

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

Direct Known Subclasses

CommandNode, Component::Input::Grammar, Component::Output::Document, Component::ReceiveFax::Fax, Component::SendFax::FaxDocument, Event, Ref

Constant Summary

@@registrations =
{}

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Method Summary (collapse)

Instance Attribute Details

- (Object) client

Returns the value of attribute client



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

def client
  @client
end

- (Object) connection

Returns the value of attribute connection



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

def connection
  @connection
end

- (Object) original_component

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?) class_from_registration(name, ns = nil)

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



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

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

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



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

+ (Object) register(name, ns = nil)

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



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

- (Object) ==(o)



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

- (Object) inherit(xml_node)



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

- (Object) inspect 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

- (Object) rayo_attributes



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

def rayo_attributes
  {}
end

- (Object) rayo_children(root)



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

def rayo_children(root)
end

- (RayoNode) source



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

- (Object) to_rayo(parent = nil)



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

- (Object) to_xml



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

def to_xml
  to_rayo.to_xml
end