epp-ruby 3.0.0

data/lib/epp-client/commands/login.rb

@@ -0,0 +1,40 @@
+require File.expand_path('../command', __FILE__)
+
+module EPP
+  module Commands
+    class Login < Command
+      def initialize(tag, passwd, config)
+        @tag, @passwd, @config = tag, passwd, config
+      end
+
+      def name
+        'login'
+      end
+
+      def to_xml
+        node = super
+        node << epp_node('clID', @tag, @namespaces || {})
+        node << epp_node('pw', @passwd, @namespaces || {})
+
+        options  = epp_node('options', @namespaces || {})
+        options << epp_node('version', @config[:version], @namespaces || {})
+        options << epp_node('lang', @config[:lang], @namespaces || {})
+        node << options
+
+        svcs = epp_node('svcs', @namespaces || {})
+        @config[:services].each { |uri| svcs << epp_node('objURI', uri, @namespaces || {}) }
+        node << svcs
+
+        unless @config[:extensions].empty?
+          ext = epp_node('svcExtension', @namespaces || {})
+          @config[:extensions].each do |uri|
+            ext << epp_node('extURI', uri, @namespaces || {})
+          end
+          svcs << ext
+        end
+
+        node
+      end
+    end
+  end
+end

data/lib/epp-client/commands/logout.rb

@@ -0,0 +1,11 @@
+require File.expand_path('../command', __FILE__)
+
+module EPP
+  module Commands
+    class Logout < Command
+      def name
+        'logout'
+      end
+    end
+  end
+end

data/lib/epp-client/commands/poll.rb

@@ -0,0 +1,28 @@
+require File.expand_path('../command', __FILE__)
+
+module EPP
+  module Commands
+    class Poll < Command
+      def initialize(msgID = nil)
+        @msgID = msgID
+      end
+      
+      def name
+        'poll'
+      end
+
+      def to_xml
+        node = super
+
+        if @msgID
+          node['op'] = 'ack'
+          node['msgID'] = @msgID
+        else
+          node['op'] = 'req'
+        end
+
+        node
+      end
+    end
+  end
+end

data/lib/epp-client/commands/read_write_command.rb

@@ -0,0 +1,18 @@
+require File.expand_path('../command', __FILE__)
+
+module EPP
+  module Commands
+    class ReadWriteCommand < Command
+      def initialize(command)
+        @command = command
+      end
+      def to_xml
+        node = super
+        
+        @command.set_namespaces(@namespaces) if @command.respond_to?(:set_namespaces)
+        node << as_xml(@command)
+        node
+      end
+    end
+  end
+end

data/lib/epp-client/commands/renew.rb

@@ -0,0 +1,11 @@
+require File.expand_path('../read_write_command', __FILE__)
+
+module EPP
+  module Commands
+    class Renew < ReadWriteCommand
+      def name
+        'renew'
+      end
+    end
+  end
+end

data/lib/epp-client/commands/transfer.rb

@@ -0,0 +1,25 @@
+require File.expand_path('../read_write_command', __FILE__)
+
+module EPP
+  module Commands
+    class Transfer < ReadWriteCommand
+      OPERATIONS = %w(approve cancel query reject request)      
+      
+      def initialize(op, command)
+        raise ArgumentError, "op must be one of #{OPERATIONS.join(', ')}" unless OPERATIONS.include?(op)
+
+        super command
+        @op = op
+      end
+      def name
+        'transfer'
+      end
+
+      def to_xml
+        node = super
+        node['op'] = @op
+        node
+      end
+    end
+  end
+end

data/lib/epp-client/commands/transfer_handshake.rb

@@ -0,0 +1,43 @@
+require File.expand_path('../command', __FILE__)
+
+module EPP
+  module Commands
+    class TransferHandshake < Command
+      NAMESPACE = 'http://www.nominet.org.uk/epp/xml/std-handshake-1.0'
+      SCHEMA_LOCATION = 'http://www.nominet.org.uk/epp/xml/std-handshake-1.0 std-handshake-1.0.xsd'
+
+      def initialize(case_id, handshake: 'accept')
+        raise 'Unsupported handshack command' unless handshake.in? %w(accept reject)
+
+        @case_id = case_id
+        @handshake = handshake
+      end
+
+      def name
+        'update'
+      end
+
+      def to_xml
+        @namespaces ||= {}
+
+        node = super
+        node << handshake_node
+        node
+      end
+
+      private
+
+      def handshake_node
+        node = xml_node(@handshake)
+        node.namespaces.namespace = handshake_namespace(node)
+        node << xml_node('h:caseId', @case_id)
+        node
+      end
+
+      def handshake_namespace(node)
+        return @namespaces['h'] if @namespaces.has_key?('h')
+        @namespaces['h'] = xml_namespace(node, 'h', NAMESPACE)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+require File.expand_path('../read_write_command', __FILE__)
+
+module EPP
+  module Commands
+    class Update < ReadWriteCommand
+      def name
+        'update'
+      end
+    end
+  end
+end

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

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

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

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

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

@@ -0,0 +1,106 @@
+module EPP
+  module Contact
+    class Command
+      include XMLHelpers
+      attr_reader :namespaces
+
+      DISCLOSE_ORDER = ['name', 'org', 'addr', 'voice', 'fax', 'email']
+      MAX_STREETS = 3
+
+      class TooManyStreetLines < RuntimeError
+        attr_reader :streets
+        def initialize(streets)
+          super("too many streets, #{streets[MAX_STREETS..-1]} would be excluded")
+          @streets = streets
+        end
+      end
+
+      def set_namespaces(namespaces)
+        @namespaces = namespaces
+      end
+
+      def name
+        raise NotImplementedError, "#name must be implemented in subclasses"
+      end
+
+      def to_xml
+        @namespaces ||= {}
+        node = contact_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 contact_node(name, value = nil)
+          node = xml_node(name, value)
+          node.namespaces.namespace = contact_namespace(node)
+          node
+        end
+        def contact_namespace(node)
+          return @namespaces['contact'] if @namespaces.has_key?('contact')
+          @namespaces['contact'] = xml_namespace(node, 'contact', NAMESPACE)
+        end
+
+        def postal_info_to_xml(postal_info)
+          node = contact_node('postalInfo')
+          node['type'] = 'loc'
+
+          node << contact_node('name', postal_info[:name]) if postal_info[:name]
+          node << contact_node('org', postal_info[:org]) if postal_info[:org]
+          node << addr_to_xml(postal_info[:addr]) if postal_info[:addr]
+
+          node
+        end
+        def addr_to_xml(addr)
+          node = contact_node('addr')
+
+          if addr[:street]
+            streets = addr[:street].split("\n")
+            if streets.count > MAX_STREETS
+              raise TooManyStreetLines.new(streets)
+            end
+            
+            streets.each do |street|
+              node << contact_node('street', street)
+            end
+          end
+
+          node << contact_node('city', addr[:city])
+          node << contact_node('sp', addr[:sp]) if addr[:sp]
+          node << contact_node('pc', addr[:pc]) if addr[:pc]
+          node << contact_node('cc', addr[:cc])
+
+          node
+        end
+        def disclose_to_xml(disclose)
+          flag = disclose.keys.first
+          node = contact_node('disclose')
+          node['flag'] = flag
+
+          DISCLOSE_ORDER.each do |name|
+            next unless disclose[flag].include?(name)
+            node << n = contact_node(name)
+            n['type'] = 'loc' if ['name', 'org', 'addr'].include?(name)
+          end
+
+          node
+        end
+
+        def auth_info_to_xml(auth_info)
+          a = contact_node('authInfo')
+
+          if auth_info.has_key?(:pw)
+            a << pw = contact_node('pw', auth_info[:pw])
+            pw['roid'] = auth_info[:roid] if auth_info.has_key?(:roid)
+          elsif auth_info.has_key?(:ext)
+            a << contact_node('ext', auth_info[:ext])
+          end
+
+          a
+        end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+require File.expand_path('../command', __FILE__)
+
+module EPP
+  module Contact
+    class Create < Command
+      def initialize(id, options = {})
+        @id = id
+
+        @postal_info  = options.delete(:postal_info)
+        @voice        = options.delete(:voice)
+        @fax          = options.delete(:fax)
+        @email        = options.delete(:email)
+        @auth_info    = options.delete(:auth_info)
+        @disclose     = options.delete(:disclose)
+      end
+
+      def name
+        'create'
+      end
+
+      def to_xml
+        node = super
+        node << contact_node('id', @id)
+        node << postal_info_to_xml(@postal_info)
+        node << contact_node('voice', @voice) if @voice
+        node << contact_node('fax', @fax) if @fax
+        node << contact_node('email', @email)
+        node << auth_info_to_xml(@auth_info)
+        node << disclose_to_xml(@disclose) if @disclose
+        node
+      end
+    end
+  end
+end

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,74 @@
+require File.expand_path('../response', __FILE__)
+
+module EPP
+  module Contact
+    class InfoResponse < Response
+      def id
+        @id ||= value_for_xpath('//contact:id')
+      end
+      def roid
+        @roid ||= value_for_xpath('//contact:roid')
+      end
+      def status
+        @status ||= values_for_xpath('//contact:status/@s')
+      end
+      def email
+        @email ||= value_for_xpath('//contact:email')
+      end
+      def fax
+        @fax ||= value_for_xpath('//contact:fax') do |node|
+          [node.content.strip, node['x']].compact.join(".")
+        end
+      end
+      def voice
+        @voice ||= value_for_xpath('//contact:voice') do |node|
+          [node.content.strip, node['x']].compact.join(".")
+        end
+      end
+      def postal_info
+        @postal_info ||= {
+          :name => value_for_xpath('//contact:postalInfo/contact:name'),
+          :org  => value_for_xpath('//contact:postalInfo/contact:org'),
+          :addr => {
+            :street => values_for_xpath('//contact:postalInfo/contact:addr/contact:street').join("\n"),
+            :city   => value_for_xpath('//contact:postalInfo/contact:addr/contact:city'),
+            :sp     => value_for_xpath('//contact:postalInfo/contact:addr/contact:sp'), 
+            :pc     => value_for_xpath('//contact:postalInfo/contact:addr/contact:pc'),
+            :cc     => value_for_xpath('//contact:postalInfo/contact:addr/contact:cc')
+          }
+        }
+      end
+      def client_id
+        @clid ||= value_for_xpath('//contact:clID')
+      end
+      def creator_id
+        @crid ||= value_for_xpath('//contact:crID')
+      end
+      def created_date
+        @crdate ||= value_for_xpath('//contact:crDate') && Time.parse(value_for_xpath('//contact:crDate'))
+      end
+      def updator_id
+        @upid ||= value_for_xpath('//contact:upID')
+      end
+      def updated_date
+        @update ||= value_for_xpath('//contact:upDate') && Time.parse(value_for_xpath('//contact:upDate'))
+      end
+      def transfer_date
+        @trdate ||= value_for_xpath('//contact:trDate') && Time.parse(value_for_xpath('//contact:trDate'))
+      end
+      def auth_info
+        @auth_info ||= begin
+          { 'pw' => value_for_xpath('//contact:authInfo/contact:pw') }
+        end
+      end
+      def disclose
+        @disclose ||= begin
+          nodes_for_xpath('//contact:disclose').inject({}) do |hash, node|
+            hash[node['flag'].to_s] = node.children.reject{|n| n.empty?}.map { |child| child.name }
+            hash
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+module EPP
+  module Contact
+    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
+          {'contact' => NAMESPACE}
+        end
+    end
+  end
+end

data/lib/epp-client/contact/transfer.rb

@@ -0,0 +1,21 @@
+require File.expand_path('../command', __FILE__)
+
+module EPP
+  module Contact
+    class Transfer < Command
+      def initialize(id)
+        @id = id
+      end
+
+      def name
+        'transfer'
+      end
+
+      def to_xml
+        node = super
+        node << contact_node('id', @id)
+        node
+      end
+    end
+  end
+end

data/lib/epp-client/contact/transfer_response.rb

@@ -0,0 +1,26 @@
+require File.expand_path('../response', __FILE__)
+
+module EPP
+  module Contact
+    class TransferResponse < Response
+      def id
+        @id ||= value_for_xpath('//contact:id')
+      end
+      def status
+        @trStatus ||= value_for_xpath('//contact:trStatus')
+      end
+      def requested_id
+        @reID ||= value_for_xpath('//contact:reID')
+      end
+      def requested_date
+        @reDate ||= value_for_xpath('//contact:reDate') && Time.parse(value_for_xpath('//contact:reDate'))
+      end
+      def action_id
+        @acID ||= value_for_xpath('//contact:acID')
+      end
+      def action_date
+        @acDate ||= value_for_xpath('//contact:acDate') && Time.parse(value_for_xpath('//contact:acDate'))
+      end
+    end
+  end
+end