Class: Epp::Server

Inherits:
Object
  • Object
show all
Includes:
REXML, RequiresParameters
Defined in:
lib/epp/server.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from RequiresParameters

#requires!

Constructor Details

#initialize(attributes = {}) ⇒ Server

Required Attrbiutes

  • :server - The EPP server to connect to

  • :tag - The tag or username used with <login> requests.

  • :password - The password used with <login> requests.

Optional Attributes

  • :port - The EPP standard port is 700. However, you can choose a different port to use.

  • :clTRID - The client transaction identifier is an element that EPP specifies MAY be used to uniquely identify the command to the server. You are responsible for maintaining your own transaction identifier space to ensure uniqueness. Defaults to “ABC-12345”

  • :lang - Set custom language attribute. Default is ‘en’.

  • :services - Use custom EPP services in the <login> frame. The defaults use the EPP standard domain, contact and host 1.0 services.

  • :extensions - URLs to custom extensions to standard EPP. Use these to extend the standard EPP (e.g., Nominet uses extensions). Defaults to none.

  • :version - Set the EPP version. Defaults to “1.0”.



22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/epp/server.rb', line 22

def initialize(attributes = {})
  requires!(attributes, :tag, :password, :server)
  
  @tag        = attributes[:tag]
  @password   = attributes[:password]
  @server     = attributes[:server]
  @port       = attributes[:port]       || 700
  @lang       = attributes[:lang]       || "en"
  @services   = attributes[:services]   || ["urn:ietf:params:xml:ns:domain-1.0", "urn:ietf:params:xml:ns:contact-1.0", "urn:ietf:params:xml:ns:host-1.0"]
  @extensions = attributes[:extensions] || []
  @version    = attributes[:version]    || "1.0"
  
  @logged_in  = false
end

Instance Attribute Details

#extensions ⇒ Object

Returns the value of attribute extensions.



6
7
8
 
# File 'lib/epp/server.rb', line 6

def extensions
  @extensions
end

#lang ⇒ Object

Returns the value of attribute lang.



6
7
8
 
# File 'lib/epp/server.rb', line 6

def lang
  @lang
end

#password ⇒ Object

Returns the value of attribute password.



6
7
8
 
# File 'lib/epp/server.rb', line 6

def password
  @password
end

#port ⇒ Object

Returns the value of attribute port.



6
7
8
 
# File 'lib/epp/server.rb', line 6

def port
  @port
end

#server ⇒ Object

Returns the value of attribute server.



6
7
8
 
# File 'lib/epp/server.rb', line 6

def server
  @server
end

#services ⇒ Object

Returns the value of attribute services.



6
7
8
 
# File 'lib/epp/server.rb', line 6

def services
  @services
end

#tag ⇒ Object

Returns the value of attribute tag.



6
7
8
 
# File 'lib/epp/server.rb', line 6

def tag
  @tag
end

#version ⇒ Object

Returns the value of attribute version.



6
7
8
 
# File 'lib/epp/server.rb', line 6

def version
  @version
end

Instance Method Details

#close_connection ⇒ Object

Closes the connection to the EPP server.



157
158
159
160
161
162
 
# File 'lib/epp/server.rb', line 157

def close_connection
  socket.close
  connection.close
  
  connection.closed? and socket.closed?
end

#connection ⇒ Object 



108
109
110
 
# File 'lib/epp/server.rb', line 108

def connection
  @connection ||= TCPSocket.new(server, port)
end

#get_frame ⇒ Object

Receive an EPP frame from the server. Since the connection is blocking, this method will wait until the connection becomes available for use. If the connection is broken, a SocketError will be raised. Otherwise, it will return a string containing the XML from the server.

Raises:

  • (SocketError) 


168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/epp/server.rb', line 168

def get_frame
  header = socket.read(4)
  
  raise SocketError.new("Connection closed by remote server") if header.nil? and socket.eof?
  raise SocketError.new("Error reading frame from remote server") if header.nil?
  
  length = header_size(header)
  
  raise SocketError.new("Got bad frame header length of #{length} bytes from the server") if length < 5
  
  response = socket.read(length - 4)
end

#header_size(header) ⇒ Object

Returns size of header of response from the EPP server.



194
195
196
197
 
# File 'lib/epp/server.rb', line 194

def header_size(header)
  unpacked_header = header.unpack("N")
  unpacked_header[0]
end

#login ⇒ Object

Sends a standard login request to the EPP server.



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/epp/server.rb', line 38

def       
  xml = new_epp_request
  
  command = xml.root.add_element("command")
   = command.add_element("login")
  
  .add_element("clID").text = tag
  .add_element("pw").text = password
  
  options = .add_element("options")
  options.add_element("version").text = version
  options.add_element("lang").text = lang
  
  services = .add_element("svcs")
  services.add_element("objURI").text = "urn:ietf:params:xml:ns:domain-1.0"
  services.add_element("objURI").text = "urn:ietf:params:xml:ns:contact-1.0"
  services.add_element("objURI").text = "urn:ietf:params:xml:ns:host-1.0"
  
  extensions_container = services.add_element("svcExtension") unless extensions.empty?
  
  for uri in extensions
    extensions_container.add_element("extURI").text = uri
  end
  
  command.add_element("clTRID").text = "ABC-12345"

  response = Hpricot.XML(send_request(xml.to_s))

  result_message  = (response/"epp"/"response"/"result"/"msg").text.strip
  result_code     = (response/"epp"/"response"/"result").attr("code").to_i
   
  if result_code == 1000
    return true
  else
    raise EppErrorResponse.new(:xml => response, :code => result_code, :message => result_message)
  end
end

#logout ⇒ Object

Sends a standard logout request to the EPP server.



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/epp/server.rb', line 77

def logout      
  xml = new_epp_request
  
  command = xml.root.add_element("command")
   = command.add_element("logout")
  
  response = Hpricot.XML(send_request(xml.to_s))
  
  result_message  = (response/"epp"/"response"/"result"/"msg").text.strip
  result_code     = (response/"epp"/"response"/"result").attr("code").to_i
  
  if result_code == 1500
    return true
  else
    raise EppErrorResponse.new(:xml => response, :code => result_code, :message => result_message)
  end
end

#new_epp_request ⇒ Object 



95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/epp/server.rb', line 95

def new_epp_request
  xml = Document.new
  xml << XMLDecl.new("1.0", "UTF-8", "no")
  
  xml.add_element("epp", {
    "xmlns" => "urn:ietf:params:xml:ns:epp-1.0",
    "xmlns:xsi" => "http://www.w3.org/2001/XMLSchema-instance",
    "xsi:schemaLocation" => "urn:ietf:params:xml:ns:epp-1.0 epp-1.0.xsd"
  })
  
  return xml
end

#open_connection ⇒ Object

established, then this method will call get_frame and return the EPP <greeting> frame which is sent by the server upon connection.



149
150
151
152
153
154
 
# File 'lib/epp/server.rb', line 149

def open_connection
  socket.sync_close
  socket.connect

  get_frame
end

#packed(xml) ⇒ Object

Pack the XML as a header for the EPP server.



189
190
191
 
# File 'lib/epp/server.rb', line 189

def packed(xml)
  [xml.size + 4].pack("N")
end

#request(xml) ⇒ Object

Sends an XML request to the EPP server, and receives an XML response. <login> and <logout> requests are also wrapped around the request, so we can close the socket immediately after the request is made.



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/epp/server.rb', line 120

def request(xml)
  open_connection
  
  @logged_in = true if 
  
  begin
    @response = send_request(xml)
  ensure
    if @logged_in
      @logged_in = false if logout
    end
    
    close_connection
  end
  
  return @response
end

#send_frame(xml) ⇒ Object

Send an XML frame to the server. Should return the total byte size of the frame sent to the server. If the socket returns EOF, the connection has closed and a SocketError is raised.



184
185
186
 
# File 'lib/epp/server.rb', line 184

def send_frame(xml)
  socket.write(packed(xml) + xml)
end

#send_request(xml) ⇒ Object

Wrapper which sends an XML frame to the server, and receives the response frame in return.



140
141
142
143
 
# File 'lib/epp/server.rb', line 140

def send_request(xml)
  send_frame(xml)
  get_frame
end

#socket ⇒ Object 



112
113
114
 
# File 'lib/epp/server.rb', line 112

def socket
  @socket ||= OpenSSL::SSL::SSLSocket.new(connection) if connection
end