Class: EPP::Requests::Abstract

Inherits:
Object
  • Object
show all
Includes:
XMLHelpers
Defined in:
lib/epp-client/requests/abstract.rb

Overview

Note:

Abstract class, do not instanciate manually

Direct Known Subclasses

Command, Extension, Hello

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from XMLHelpers

#as_xml, #epp_namespace, #epp_node, #xml_document, #xml_namespace, #xml_node

Instance Attribute Details

#namespaces ⇒ Object (readonly)

Returns the value of attribute namespaces.



6
7
8
 
# File 'lib/epp-client/requests/abstract.rb', line 6

def namespaces
  @namespaces
end

Instance Method Details

#name ⇒ Object

Raises:

  • (NotImplementedError) 


12
13
14
 
# File 'lib/epp-client/requests/abstract.rb', line 12

def name
  raise NotImplementedError, "#name must be overriden by subclasses"
end

#set_namespaces(namespaces) ⇒ Object 



8
9
10
 
# File 'lib/epp-client/requests/abstract.rb', line 8

def set_namespaces(namespaces)
  @namespaces = namespaces
end

#to_s(opts = {}) ⇒ Object

Convert the receiver to a string

Parameters:

  • opts (Hash) (defaults to: {}) —

    Formatting options, passed to the XML::Document



25
26
27
 
# File 'lib/epp-client/requests/abstract.rb', line 25

def to_s(opts = {})
  to_xml.to_s({:indent => false}.merge(opts))
end

#to_xml ⇒ XML::Document

Receiver in XML form

Returns:

  • (XML::Document) —

    XML of the receiver



18
19
20
 
# File 'lib/epp-client/requests/abstract.rb', line 18

def to_xml
  epp_node(name, @namespaces || {})
end