Module: NominetEPP::Operations::List

Included in:
Client
Defined in:
lib/nominet-epp/operations/list.rb

Overview

EPP List Operatons

Instance Method Summary collapse

Instance Method Details

#list(type, date, fields = 'none') ⇒ nil, ...

Obtain a list of domains, and optionally their details, which either expire or were registered in the month given.

Parameters:

  • type (Symbol) —

    Listing type, either :expiry or :month

  • date (String, #strftime) —

    Date of either expiry or registration to list

  • fields (String) (defaults to: 'none') —

    Verbosity of the response, either ‘none’ or ‘all’

Returns:

  • (nil) —

    list failed

  • (Array<String>) —

    list of domains

  • (Array<Hash>) —

    list of domains with details

Raises:

  • (ArgumentError) —

    type must be :expiry or :month



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/nominet-epp/operations/list.rb', line 15

def list(type, date, fields = 'none')
  raise ArgumentError, "type must be :expiry or :month" unless [:expiry, :month].include?(type)

  date = date.strftime("%Y-%m") if date.respond_to?(:strftime)
  @resp = @client.info do
    domain('list') do |node, ns|
      node << XML::Node.new(type, date, ns)
      node << XML::Node.new('fields', fields, ns)
    end
  end

  return nil unless @resp.success?

  if fields == 'none'
    @resp.data.find('//domain:name', namespaces).map do |node|
      node.content.strip
    end
  else
    @resp.data.find('//domain:infData', namespaces).map do |infData|
      hash = {}
      infData.children.reject{|n| n.empty?}.each do |node|
        key = node.name.gsub('-', '_').to_sym
        case node.name
        when 'account'
          hash[:account] = (node)
        when 'ns'
          hash[:ns] = node.find('domain:host', namespaces).map do |hostnode|
            { :name => node_value(hostnode, 'domain:hostName'),
              :v4 => node_value(hostnode, 'domain:hostAddr[@ip="v4"]'),
              :v6 => node_value(hostnode, 'domain:hostAddr[@ip="v6"]') }.reject{|k,v| v.nil?}
          end
        when /date/i
          hash[key] = Time.parse(node.content.strip)
        else
          hash[key] = node.content.strip
        end
      end
      hash
    end
  end
end

#tag_list ⇒ false, Array<Hash>

list of all tags that accept tag changes along with their handshake settings

The returned array of hashes contain the following keys

  • (String) :registrar_tag – TAG name

  • (String) :name – Name of the TAG owner

  • (String) :trad_name – TAG trading name

  • (BOOL) :handshake – Whether the TAG accepts handshakes

Returns:

  • (false) —

    failure

  • (Array<Hash>) —

    tag details



67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/nominet-epp/operations/list.rb', line 67

def tag_list
  resp = @client.info do
    tag('list')
  end

  return false unless resp.success?

  resp.data.find('//tag:infData', namespaces).map do |node|
    { :registrar_tag => node_value(node, 'tag:registrar-tag'),
      :name =>          node_value(node, 'tag:name'),
      :trad_name =>     node_value(node, 'tag:trad-name'),
      :handshake =>     node_value(node, 'tag:handshake') == 'Y' }
  end
end