epp-ruby 3.0.0

data/lib/epp-client/domain/update.rb

@@ -0,0 +1,81 @@
+require File.expand_path('../command', __FILE__)
+
+module EPP
+  module Domain
+    class Update < Command
+      ADD_REM_ORDER = [:ns, :contact, :status]
+      CHG_ORDER     = [:registrant, :auth_info]
+
+
+      # @option [Hash] :status A Hash of status value to text. Text may optionally be an array in the form ["Text", "lang"] if a custom language value needs to be set.
+      def initialize(name, options = {})
+        @name = name
+        @add  = options.delete(:add) || {}
+        @rem  = options.delete(:rem) || {}
+        @chg  = options.delete(:chg) || {}
+
+        @add.delete_if { |k,_| !ADD_REM_ORDER.include?(k) }
+        @rem.delete_if { |k,_| !ADD_REM_ORDER.include?(k) }
+        @chg.delete_if { |k,_| !CHG_ORDER.include?(k) }
+      end
+
+      def name
+        'update'
+      end
+
+      def to_xml
+        node = super
+        node << domain_node('name', @name)
+
+        unless @add.empty?
+          node << add = domain_node('add')
+          add_rem_to_xml(add, @add)
+        end
+
+        unless @rem.empty?
+          node << rem = domain_node('rem')
+          add_rem_to_xml(rem, @rem)
+        end
+
+        unless @chg.empty?
+          node << chg = domain_node('chg')
+          CHG_ORDER.each do |key|
+            value = @chg[key]
+            next if value.nil?
+            
+            case key
+            when :registrant
+              chg << domain_node('registrant', value)
+            when :auth_info
+              chg << auth_info_to_xml(value)
+            end
+          end
+        end
+        
+        node
+      end
+
+      protected
+        def add_rem_to_xml(node, hash)
+          ADD_REM_ORDER.each do |key|
+            value = hash[key]
+            next if value.nil? || value.empty?
+
+            case key
+            when :ns
+              node << nameservers_to_xml(value)
+            when :contact
+              contacts_to_xml(node, value)
+            when :status
+              value.each do |status, text|
+                text, lang = Array(text)
+                node << s = domain_node('status', text)
+                s['lang'] = lang if lang
+                s['s'] = status.to_s
+              end
+            end
+          end
+        end
+    end
+  end
+end

data/lib/epp-client/domain/update_response.rb

@@ -0,0 +1,9 @@
+require File.expand_path('../response', __FILE__)
+
+module EPP
+  module Domain
+    class UpdateResponse < Response
+      
+    end
+  end
+end

data/lib/epp-client/host/check.rb

@@ -0,0 +1,23 @@
+require File.expand_path('../command', __FILE__)
+
+module EPP
+  module Host
+    class Check < Command
+      def initialize(*names)
+        @names = names.flatten
+      end
+
+      def name
+        'check'
+      end
+
+      def to_xml
+        node = super
+        @names.each do |name|
+          node << host_node('name', name)
+        end
+        node
+      end
+    end
+  end
+end

data/lib/epp-client/host/check_response.rb

@@ -0,0 +1,41 @@
+require File.expand_path('../response', __FILE__)
+
+module EPP
+  module Host
+    class CheckResponse < Response
+      def available?(name = nil)
+        return availability[name] if name
+
+        if name.nil? && availability.count == 1
+          return availability.values.first
+        end
+
+        raise ArgumentError, "name must be specified if more than one host checked"
+      end
+      def unavailable?(name = nil)
+        !available?(name)
+      end
+
+      def names
+        availability.keys
+      end
+
+      def name
+        raise "name unavailable when more than one host checked, use #names" if count != 1
+        names.first
+      end
+
+      def count
+        availability.count
+      end
+
+      protected
+        def availability
+          @availability ||= nodes_for_xpath('//host:name').inject({}) do |hash, node|
+            hash[node.content.strip] = node['avail'] == '1'
+            hash
+          end
+        end
+    end
+  end
+end

data/lib/epp-client/host/command.rb

@@ -0,0 +1,47 @@
+module EPP
+  module Host
+    class Command
+      include XMLHelpers
+      attr_reader :namespaces
+
+      def set_namespaces(namespaces)
+        @namespaces = namespaces
+      end
+
+      def name
+        raise NotImplementedError, "#name must be implemented in subclasses"
+      end
+
+      def to_xml
+        @namespaces ||= {}
+        node = host_node(name)
+
+        xattr = XML::Attr.new(node, "schemaLocation", SCHEMA_LOCATION)
+        xattr.namespaces.namespace = @namespaces['xsi'] || XML::Namespace.new(node, 'xsi', 'http://www.w3.org/2001/XMLSchema-instance')
+        
+        node
+      end
+
+      protected
+        def host_node(name, value = nil)
+          node = xml_node(name, value)
+          node.namespaces.namespace = host_namespace(node)
+          node
+        end
+        def host_namespace(node)
+          return @namespaces['host'] if @namespaces.has_key?('host')
+          @namespaces['host'] = xml_namespace(node, 'host', NAMESPACE)
+        end
+
+        def addrs_to_xml(node, addrs)
+          addrs.each do |key, values|
+            ip = key.to_s.sub('ip', '')
+            Array(values).each do |value|
+              node << addr = host_node('addr', value)
+              addr['ip'] = ip
+            end
+          end
+        end
+    end
+  end
+end

data/lib/epp-client/host/create.rb

@@ -0,0 +1,24 @@
+require File.expand_path('../command', __FILE__)
+
+module EPP
+  module Host
+    class Create < Command
+      def initialize(name, addrs = {})
+        @name = name
+        @addrs = addrs
+      end
+
+      def name
+        'create'
+      end
+
+      def to_xml
+        node = super
+        node << host_node('name', @name)
+        addrs_to_xml(node, @addrs)
+
+        node
+      end
+    end
+  end
+end

data/lib/epp-client/host/create_response.rb

@@ -0,0 +1,14 @@
+require File.expand_path('../response', __FILE__)
+
+module EPP
+  module Host
+    class CreateResponse < Response
+      def name
+        @name ||= value_for_xpath('//host:name')
+      end
+      def creation_date
+        @crdate ||= value_for_xpath('//host:crDate') && Time.parse(value_for_xpath('//host:crDate'))
+      end
+    end
+  end
+end

data/lib/epp-client/host/delete.rb

@@ -0,0 +1,21 @@
+require File.expand_path('../command', __FILE__)
+
+module EPP
+  module Host
+    class Delete < Command
+      def initialize(name)
+        @name = name
+      end
+
+      def name
+        'delete'
+      end
+
+      def to_xml
+        node = super
+        node << host_node('name', @name)
+        node
+      end
+    end
+  end
+end

data/lib/epp-client/host/delete_response.rb

@@ -0,0 +1,9 @@
+require File.expand_path('../response', __FILE__)
+
+module EPP
+  module Host
+    class DeleteResponse < Response
+      
+    end
+  end
+end

data/lib/epp-client/host/info.rb

@@ -0,0 +1,21 @@
+require File.expand_path('../command', __FILE__)
+
+module EPP
+  module Host
+    class Info < Command
+      def initialize(name)
+        @name = name
+      end
+
+      def name
+        'info'
+      end
+
+      def to_xml
+        node = super
+        node << host_node('name', @name)
+        node
+      end
+    end
+  end
+end

data/lib/epp-client/host/info_response.rb

@@ -0,0 +1,42 @@
+require File.expand_path('../response', __FILE__)
+
+module EPP
+  module Host
+    class InfoResponse < Response
+      def name
+        @name ||= value_for_xpath('//host:name')
+      end
+      def roid
+        @roid ||= value_for_xpath('//host:roid')        
+      end
+      def status
+        @status ||= values_for_xpath('//host:status/@s')
+      end
+      def addresses
+        @addresses ||= nodes_for_xpath('//host:addr').inject({}) do |hash, node|
+          hash["ip#{node['ip']}"] ||= Array.new
+          hash["ip#{node['ip']}"] << node.content.strip
+          hash
+        end
+      end
+      def client_id
+        @clid ||= value_for_xpath('//host:clID')
+      end
+      def creator_id
+        @crid ||= value_for_xpath('//host:crID')
+      end
+      def created_date
+        @crdate ||= value_for_xpath('//host:crDate') && Time.parse(value_for_xpath('//host:crDate'))
+      end
+      def updator_id
+        @upid ||= value_for_xpath('//host:upID')
+      end
+      def updated_date
+        @update ||= value_for_xpath('//host:upDate') && Time.parse(value_for_xpath('//host:upDate'))
+      end
+      def transfer_date
+        @trdate ||= value_for_xpath('//host:trDate') && Time.parse(value_for_xpath('//host:trDate'))
+      end
+    end
+  end
+end

data/lib/epp-client/host/response.rb

@@ -0,0 +1,34 @@
+module EPP
+  module Host
+    class Response
+      include ResponseHelper
+
+      def initialize(response)
+        @response = response
+      end
+      
+      def method_missing(meth, *args, &block)
+        return super unless @response.respond_to?(meth)
+        @response.send(meth, *args, &block)
+      end
+
+      def respond_to_missing?(method, include_private)
+        @response.respond_to?(method, include_private)
+      end
+
+      unless RUBY_VERSION >= "1.9.2"
+        def respond_to?(method, include_private = false)
+          respond_to_missing?(method, include_private) || super
+        end
+        def method(sym)
+          respond_to_missing?(sym, true) ? @response.method(sym) : super
+        end
+      end
+
+      protected
+        def namespaces
+          {'host' => NAMESPACE}
+        end
+    end
+  end
+end

data/lib/epp-client/host/update.rb

@@ -0,0 +1,76 @@
+require File.expand_path('../command', __FILE__)
+
+module EPP
+  module Host
+    class Update < Command
+      ADD_REM_ORDER = [:addr, :status]
+      CHG_ORDER     = [:name]
+
+      # @option [Hash] :status A Hash of status value to text. Text may optionally be an array in the form ["Text", "lang"] if a custom language value needs to be set.
+      def initialize(name, options = {})
+        @name = name
+        @add  = options.delete(:add) || {}
+        @rem  = options.delete(:rem) || {}
+        @chg  = options.delete(:chg) || {}
+
+        @add.delete_if { |k,_| !ADD_REM_ORDER.include?(k) }
+        @rem.delete_if { |k,_| !ADD_REM_ORDER.include?(k) }
+        @chg.delete_if { |k,_| !CHG_ORDER.include?(k) }
+      end
+
+      def name
+        'update'
+      end
+
+      def to_xml
+        node = super
+        node << host_node('name', @name)
+
+        unless @add.empty?
+          node << add = host_node('add')
+          add_rem_to_xml(add, @add)
+        end
+
+        unless @rem.empty?
+          node << rem = host_node('rem')
+          add_rem_to_xml(rem, @rem)
+        end
+
+        unless @chg.empty?
+          node << chg = host_node('chg')
+          CHG_ORDER.each do |key|
+            value = @chg[key]
+            next if value.nil?
+            
+            case key
+            when :name
+              chg << host_node('name', value)
+            end
+          end
+        end
+        
+        node
+      end
+
+      protected
+        def add_rem_to_xml(node, hash)
+          ADD_REM_ORDER.each do |key|
+            value = hash[key]
+            next if value.nil? || value.empty?
+
+            case key
+            when :addr
+              addrs_to_xml(node, value)
+            when :status
+              value.each do |status, text|
+                text, lang = Array(text)
+                node << s = host_node('status', text)
+                s['lang'] = lang if lang
+                s['s'] = status.to_s
+              end
+            end
+          end
+        end
+    end
+  end
+end

data/lib/epp-client/host/update_response.rb

@@ -0,0 +1,9 @@
+require File.expand_path('../response', __FILE__)
+
+module EPP
+  module Host
+    class UpdateResponse < Response
+      
+    end
+  end
+end

data/lib/epp-client/old_server.rb

@@ -0,0 +1,25 @@
+module EPP
+  # Handles sending and receiving data to older EPP servers.
+  #
+  # These servers transmit the payload with CRLF at the end
+  # and recieve one byte at a time until EOF is reached.
+  class OldServer < Server
+    # Sends frame using old method
+    #
+    # @param [String] xml XML payload to send
+    def send_frame(xml)
+      @sock.write(xml + "\r\n")
+    end
+
+    # Receives frame using old method
+    #
+    # @return [String] XML Payload response
+    def recv_frame
+      data = ''
+      until @sock.eof?
+        data << @sock.read(1)
+      end
+      data
+    end
+  end
+end

data/lib/epp-client/request.rb

@@ -0,0 +1,51 @@
+module EPP
+  # An EPP XML Request
+  class Request
+    include XMLHelpers
+
+    # Create and return a new EPP Request Payload
+    #
+    # @param [EPP::Request]
+    def initialize(request)
+      @request = request
+    end
+
+    def namespaces
+      @namespaces
+    end
+
+    # Receiver in XML form
+    # @return [XML::Document] XML of the receiver
+    def to_xml
+      doc      = XML::Document.new('1.0')
+      doc.root = XML::Node.new('epp')
+      root     = doc.root
+
+      epp_ns   = XML::Namespace.new(root, nil, 'urn:ietf:params:xml:ns:epp-1.0')
+      root.namespaces.namespace = epp_ns
+
+      xsi_ns   = XML::Namespace.new(root, 'xsi', 'http://www.w3.org/2001/XMLSchema-instance')
+      xsi_sL   = XML::Attr.new(root, 'schemaLocation', 'urn:ietf:params:xml:ns:epp-1.0 epp-1.0.xsd')
+      xsi_sL.namespaces.namespace = xsi_ns
+
+      @namespaces = {'epp' => epp_ns, 'xsi' => xsi_ns}
+
+      @request.set_namespaces(@namespaces) if @request.respond_to?(:set_namespaces)
+      root << @request.to_xml
+
+      doc
+    end
+
+    # Convert the receiver to a string
+    #
+    # @param [Hash] opts Formatting options, passed to the XML::Document
+    def to_s(opts = {})
+      to_xml.to_s({:indent => false}.merge(opts))
+    end
+
+    # @see Object#inspect
+    # def inspect
+    #   "#<#{self.class}>"
+    # end
+  end
+end

data/lib/epp-client/requests/abstract.rb

@@ -0,0 +1,30 @@
+module EPP
+  module Requests
+    # @note Abstract class, do not instanciate manually
+    class Abstract
+      include XMLHelpers
+      attr_reader :namespaces
+
+      def set_namespaces(namespaces)
+        @namespaces = namespaces
+      end
+
+      def name
+        raise NotImplementedError, "#name must be overriden by subclasses"
+      end
+
+      # Receiver in XML form
+      # @return [XML::Document] XML of the receiver
+      def to_xml
+        epp_node(name, @namespaces || {})
+      end
+
+      # Convert the receiver to a string
+      #
+      # @param [Hash] opts Formatting options, passed to the XML::Document
+      def to_s(opts = {})
+        to_xml.to_s({:indent => false}.merge(opts))
+      end
+    end
+  end
+end

data/lib/epp-client/requests/command.rb

@@ -0,0 +1,28 @@
+require File.expand_path('../abstract', __FILE__)
+
+module EPP
+  module Requests
+    class Command < Abstract
+      def initialize(tid, command, extension = nil)
+        @tid, @command, @extension = tid, command, extension
+      end
+
+      def name
+        'command'
+      end
+
+      def to_xml
+        node = super
+
+        @command.set_namespaces(@namespaces) if @command.respond_to?(:set_namespaces)
+        @extension.set_namespaces(@namespaces) if @extension && @extension.respond_to?(:set_namespaces)
+
+        node << as_xml(@command)
+        node << as_xml(@extension) if @extension
+        node << epp_node('clTRID', @tid, @namespaces)
+
+        node
+      end
+    end
+  end
+end

data/lib/epp-client/requests/extension.rb

@@ -0,0 +1,28 @@
+require File.expand_path('../abstract', __FILE__)
+
+module EPP
+  module Requests
+    class Extension < Abstract
+      def initialize(*extensions)
+        raise ArgumentError, "you must provide at least one extension" if extensions.compact.empty?
+        @extensions = extensions.compact
+      end
+
+      def name
+        'extension'
+      end
+
+      def to_xml
+        node = super
+
+        Array(@extensions).each do |extension|
+          next if extension.nil?
+          extension.set_namespaces(@namespaces) if extension.respond_to?(:set_namespaces)
+          node << as_xml(extension)
+        end
+
+        node
+      end
+    end
+  end
+end

data/lib/epp-client/requests/hello.rb

@@ -0,0 +1,12 @@
+require File.expand_path('../abstract', __FILE__)
+
+module EPP
+  module Requests
+    # An EPP Hello Request
+    class Hello < Abstract
+      def name
+        'hello'
+      end
+    end
+  end
+end