nominet-epp 0.0.12 → 1.0.0

data/lib/nominet-epp/requests/contact/update.rb

@@ -0,0 +1,63 @@
+module NominetEPP
+  module Contact
+    class Update < Request
+      def initialize(name, changes = {})
+        @name = name
+        @namespaces = {}
+
+        extensions = (changes[:add] || {}).merge(changes[:chg] || {})
+        extensions.delete_if { |k,_| !UpdateExtension::KEYS.include?(k) }
+
+        changes[:add] && changes[:add].delete_if { |k,_| UpdateExtension::KEYS.include?(k) }
+        changes[:rem] && changes[:rem].delete_if { |k,_| UpdateExtension::KEYS.include?(k) }
+        changes[:chg] && changes[:chg].delete_if { |k,_| UpdateExtension::KEYS.include?(k) }
+
+        # Changing the organisation is not permitted by Nominet
+        changes[:chg] && changes[:chg][:postal_info] && changes[:chg][:postal_info].delete(:org)
+
+        @contact_ext = UpdateExtension.new(extensions) rescue nil
+
+        @command    = EPP::Contact::Update.new(name, changes)
+        @extension  = EPP::Requests::Extension.new(@contact_ext) rescue nil
+      end
+    end
+
+    class UpdateExtension < RequestExtension
+      KEYS = [:trad_name, :type, :co_no, :opt_out]
+      NAMESPACE = 'http://www.nominet.org.uk/epp/xml/contact-nom-ext-1.0'
+
+      def initialize(attributes)
+        raise ArgumentError, "must provide Hash of #{KEYS.map(&:inspect).join(", ")}" if attributes.nil? || attributes.empty?
+        @attributes = attributes
+        @namespaces = {}
+      end
+
+      def namespace_uri
+        NAMESPACE
+      end
+      def namespace_name
+        'contact-ext'
+      end
+
+      def to_xml
+        node = x_node('update')
+        x_schemaLocation(node)
+
+        KEYS.each do |key|
+          value = @attributes[key]
+          next if value.nil? || value == ''
+
+          case key
+          when :opt_out
+            node << x_node('opt-out', value ? 'Y' : 'N')
+          else
+            name = key.to_s.gsub('_', '-')
+            node << x_node(name, value.to_s)
+          end
+        end
+
+        node
+      end
+    end
+  end
+end

data/lib/nominet-epp/requests/custom/handshake.rb

@@ -0,0 +1,36 @@
+module NominetEPP
+  module Custom
+    class Handshake < CustomRequest
+      NAMESPACE = 'http://www.nominet.org.uk/epp/xml/std-handshake-1.0'
+
+      def initialize(case_id, registrant = nil)
+        @case_id = case_id
+        @registrant = registrant
+      end
+
+      def command_name
+        'update'
+      end
+      def namespace_name
+        'h'
+      end
+      def namespace_uri
+        NAMESPACE
+      end
+
+      def to_xml
+        @namespaces ||= {}
+        node = x_node('accept')
+        x_schemaLocation(node)
+
+        node << x_node('caseId', @case_id)
+        
+        if @registrant
+          node << x_node('registrant', @registrant)
+        end
+
+        node
+      end
+    end
+  end
+end

data/lib/nominet-epp/requests/custom/list.rb

@@ -0,0 +1,38 @@
+module NominetEPP
+  module Custom
+    class List < CustomRequest
+      NAMESPACE = 'http://www.nominet.org.uk/epp/xml/std-list-1.0'
+
+      def initialize(type, month)
+        month = month.strftime('%Y-%m') if month.respond_to?(:strftime)
+        @month = month
+        @type  = type
+      end
+
+      def command_name
+        'info'
+      end
+      def namespace_name
+        'l'
+      end
+      def namespace_uri
+        NAMESPACE
+      end
+
+      def to_xml
+        @namespaces ||= {}
+        node = x_node('list')
+        x_schemaLocation(node)
+
+        case @type
+        when :registration, 'registration', :month, 'month'
+          node << x_node('month', @month)
+        when :expiry, 'expiry'
+          node << x_node('expiry', @month)
+        end
+
+        node
+      end
+    end
+  end
+end

data/lib/nominet-epp/requests/custom/tag_list.rb

@@ -0,0 +1,25 @@
+module NominetEPP
+  module Custom
+    class TagList < CustomRequest
+      NAMESPACE = 'http://www.nominet.org.uk/epp/xml/nom-tag-1.0'
+
+      def command_name
+        'info'
+      end
+      def namespace_name
+        'tag'
+      end
+      def namespace_uri
+        NAMESPACE
+      end
+
+      def to_xml
+        @namespaces ||= {}
+        node = x_node('list')
+        x_schemaLocation(node)
+
+        node
+      end
+    end
+  end
+end

data/lib/nominet-epp/requests/domain/check.rb

@@ -0,0 +1,98 @@
+module NominetEPP
+  module Domain
+    class Check < Request
+      def initialize(*names)
+        rights = names.last.is_a?(Hash) ? names.pop : nil
+
+        @command = EPP::Domain::Check.new(*names)
+
+        if rights
+          raise ArgumentError, "cannot check direct rights on more than one name" if names.count > 1
+          @rights_ext = DirectRightsExtension.new(rights)
+          @extension  = EPP::Requests::Extension.new(@rights_ext) rescue nil
+        end
+      end
+
+      class DirectRightsExtension < RequestExtension
+        KEYS = [:postal_info, :email, :registrant]
+        NAMESPACE = 'http://www.nominet.org.uk/epp/xml/nom-direct-rights-1.0'
+
+        def initialize(attributes)
+          raise ArgumentError, "must provide Hash with one of #{KEYS.map(&:inspect).join(", ")}" if attributes.nil? || attributes.empty?
+
+          if attributes.has_key?(:postal_info)
+            unless attributes.has_key?(:email)
+              raise ArgumentError, "must provide :email when using :postal_info"
+            end
+          end
+
+
+          if attributes.has_key?(:email)
+            unless attributes.has_key?(:postal_info)
+              raise ArgumentError, "must provide :postal_info when using :email"
+            end
+          end
+
+          if attributes.has_key?(:registrant)
+            if attributes.has_key?(:email) || attributes.has_key?(:postal_info)
+              raise ArgumentError, ":registrant must be used on its own"
+            end
+          end
+
+          @attributes = attributes
+          @namespaces = {}
+        end
+
+        def namespace_uri
+          NAMESPACE
+        end
+        def namespace_name
+          'nom-direct-rights'
+        end
+
+        def contact_node(name, value = nil)
+          node = xml_node(name, value)
+          node.namespaces.namespace = x_namespace(node,
+            'contact', EPP::Contact::NAMESPACE)
+          node
+        end
+
+        def to_xml
+          node = x_node('check')
+          x_schemaLocation(node)
+
+          KEYS.each do |key|
+            value = @attributes[key]
+            next if value.nil? || value == ''
+
+            case key
+            when :postal_info
+              node << x_node('postalInfo').tap do |postalInfo|
+                postalInfo['type'] = 'loc'
+
+                @namespaces['contact'] = xml_namespace(postalInfo, 'contact', EPP::Contact::NAMESPACE)
+                x_schemaLocation(postalInfo, EPP::Contact::SCHEMA_LOCATION)
+
+                postalInfo << contact_node('name', value[:name])
+                postalInfo << contact_node('org', value[:org]) if value[:org]
+
+                postalInfo << contact_node('addr').tap do |addr|
+                  addr << contact_node('street', value[:addr][:street]) if value[:addr][:street]
+                  addr << contact_node('city', value[:addr][:city])
+                  addr << contact_node('sp', value[:addr][:sp]) if value[:addr][:sp]
+                  addr << contact_node('pc', value[:addr][:pc]) if value[:addr][:pc]
+                  addr << contact_node('cc', value[:addr][:cc])
+                end
+              end
+            else
+              name = key.to_s.gsub('_', '-')
+              node << x_node(name, value.to_s)
+            end
+          end
+
+          node
+        end
+      end
+    end
+  end
+end

data/lib/nominet-epp/requests/domain/create.rb

@@ -0,0 +1,97 @@
+module NominetEPP
+  module Domain
+    class Create < Request
+      def initialize(name, options = {})
+        @name = name
+        @options = options
+        @namespaces = {}
+
+        @extensions = @options.dup
+        @extensions.delete_if { |k,_| !CreateExtension::KEYS.include?(k) }
+        @options.delete_if    { |k,_|  CreateExtension::KEYS.include?(k) }
+
+        @options[:auth_info] ||= {:pw => SecureRandom.hex(8) }
+
+        @domain_ext = CreateExtension.new(@extensions) rescue nil
+        @secdns_ext = CreateSecDNSExtension.new(@options.delete(:ds)) rescue nil
+
+        @command    = EPP::Domain::Create.new(@name, @options)
+        @extension  = EPP::Requests::Extension.new(@domain_ext, @secdns_ext) rescue nil
+      end
+    end
+
+    class CreateExtension < RequestExtension
+      KEYS = [:first_bill, :recur_bill, :auto_bill, :next_bill,
+        :auto_period, :next_period, :notes, :reseller]
+      NAMESPACE = 'http://www.nominet.org.uk/epp/xml/domain-nom-ext-1.2'
+
+      def initialize(attributes)
+        raise ArgumentError, "must provide Hash of #{KEYS.map(&:inspect).join(", ")}" if attributes.nil? || attributes.empty?
+        @attributes = attributes
+        @namespaces = {}
+      end
+
+      def namespace_uri
+        NAMESPACE
+      end
+      def namespace_name
+        'domain-ext'
+      end
+
+      def to_xml
+        node = x_node('create')
+        x_schemaLocation(node)
+
+        KEYS.each do |key|
+          value = @attributes[key]
+          next if value.nil? || value == ''
+
+          case key
+          when :notes
+            Array(value).each do |note|
+              node << x_node('notes', note)
+            end
+          else
+            name = key.to_s.gsub('_', '-')
+            node << x_node(name, value.to_s)
+          end
+        end
+
+        node
+      end
+    end
+
+    class CreateSecDNSExtension < RequestExtension
+      NAMESPACE = 'urn:ietf:params:xml:ns:secDNS-1.1'
+
+      def initialize(attributes)
+        raise ArgumentError, "must provide Array of Hash or Hash of :key_tag, :alg, :digest_type and :digest" if attributes.nil? || attributes.empty?
+        @attributes = attributes
+        @namespaces = {}
+      end
+
+      def namespace_uri
+        NAMESPACE
+      end
+      def namespace_name
+        'secDNS'
+      end
+
+      def to_xml
+        node = x_node('create')
+        x_schemaLocation(node)
+
+        Array(@attributes).each do |attributes|
+          node << x_node('dsData').tap do |dsData|
+            dsData << x_node('keyTag', attributes[:key_tag].to_s)
+            dsData << x_node('alg', attributes[:alg].to_s)
+            dsData << x_node('digestType', attributes[:digest_type].to_s)
+            dsData << x_node('digest', attributes[:digest].gsub(/\s+/, ''))
+          end
+        end
+
+        node
+      end
+    end
+  end
+end

data/lib/nominet-epp/requests/domain/delete.rb

@@ -0,0 +1,9 @@
+module NominetEPP
+  module Domain
+    class Delete < Request
+      def initialize(name)
+        @command = EPP::Domain::Delete.new(name)
+      end
+    end
+  end
+end

data/lib/nominet-epp/requests/domain/info.rb

@@ -0,0 +1,9 @@
+module NominetEPP
+  module Domain
+    class Info < Request
+      def initialize(name)
+        @command = EPP::Domain::Info.new(name)
+      end
+    end
+  end
+end

data/lib/nominet-epp/requests/domain/release.rb

@@ -0,0 +1,33 @@
+module NominetEPP
+  module Domain
+    class Release < CustomRequest
+      NAMESPACE = 'http://www.nominet.org.uk/epp/xml/std-release-1.0'
+
+      def initialize(name, tag)
+        @name = name
+        @tag  = tag
+      end
+
+      def command_name
+        'update'
+      end
+      def namespace_name
+        'r'
+      end
+      def namespace_uri
+        NAMESPACE
+      end
+
+      def to_xml
+        @namespaces ||= {}
+        node = x_node('release')
+        x_schemaLocation(node)
+
+        node << x_node('domainName', @name)
+        node << x_node('registrarTag', @tag)
+
+        node
+      end
+    end
+  end
+end

data/lib/nominet-epp/requests/domain/renew.rb

@@ -0,0 +1,9 @@
+module NominetEPP
+  module Domain
+    class Renew < Request
+      def initialize(name, exp_date, period = nil)
+        @command = EPP::Domain::Renew.new(name, exp_date, period)
+      end
+    end
+  end
+end

data/lib/nominet-epp/requests/domain/unrenew.rb

@@ -0,0 +1,33 @@
+module NominetEPP
+  module Domain
+    class Unrenew < CustomRequest
+      NAMESPACE = 'http://www.nominet.org.uk/epp/xml/std-unrenew-1.0'
+
+      def initialize(*names)
+        @names = names
+      end
+
+      def command_name
+        'update'
+      end
+      def namespace_name
+        'u'
+      end
+      def namespace_uri
+        NAMESPACE
+      end
+
+      def to_xml
+        @namespaces ||= {}
+        node = x_node('unrenew')
+        x_schemaLocation(node)
+
+        @names.each do |name|
+          node << x_node('domainName', name)
+        end
+
+        node
+      end
+    end
+  end
+end

data/lib/nominet-epp/requests/domain/update.rb

@@ -0,0 +1,134 @@
+module NominetEPP
+  module Domain
+    class Update < Request
+      def initialize(name, changes = {})
+        @name = name
+        @namespaces = {}
+
+        extensions = (changes[:add] || {}).merge(changes[:chg] || {})
+        extensions.delete_if { |k,_| !UpdateExtension::KEYS.include?(k) }
+
+        changes[:add] && changes[:add].delete_if { |k,_| UpdateExtension::KEYS.include?(k) }
+        changes[:rem] && changes[:rem].delete_if { |k,_| UpdateExtension::KEYS.include?(k) }
+        changes[:chg] && changes[:chg].delete_if { |k,_| UpdateExtension::KEYS.include?(k) }
+
+        dnssec = {}
+        dnssec[:add] = changes[:add] && changes[:add].delete(:ds)
+        dnssec[:rem] = changes[:rem] && changes[:rem].delete(:ds)
+        dnssec[:chg] = changes[:chg] && changes[:chg].delete(:ds)
+
+        @domain_ext = UpdateExtension.new(extensions) rescue nil
+        @secdns_ext = UpdateSecDNSExtension.new(dnssec) rescue nil
+
+        @command    = EPP::Domain::Update.new(name, changes)
+        @extension  = EPP::Requests::Extension.new(@domain_ext, @secdns_ext) rescue nil
+      end
+    end
+
+    class UpdateExtension < RequestExtension
+      KEYS = [:first_bill, :recur_bill, :auto_bill, :next_bill,
+        :auto_period, :next_period, :renew_not_required, :notes, :reseller]
+
+      NAMESPACE = 'http://www.nominet.org.uk/epp/xml/domain-nom-ext-1.2'
+
+      def initialize(attributes)
+        raise ArgumentError, "must provide Hash of #{KEYS.map(&:inspect).join(", ")}" if attributes.nil? || attributes.empty?
+        @attributes = attributes
+        @namespaces = {}
+      end
+
+      def namespace_uri
+        NAMESPACE
+      end
+      def namespace_name
+        'domain-ext'
+      end
+
+      def to_xml
+        node = x_node('update')
+        x_schemaLocation(node)
+
+        KEYS.each do |key|
+          value = @attributes[key]
+          next if value.nil? || value == ''
+
+          case key
+          when :notes
+            Array(value).each do |note|
+              node << x_node('notes', note)
+            end
+          when :renew_not_required
+            node << x_node('renew-not-required', value ? 'Y' : 'N')
+          else
+            name = key.to_s.gsub('_', '-')
+            node << x_node(name, value.to_s)
+          end
+        end
+
+        node
+      end
+    end
+
+    class UpdateSecDNSExtension < RequestExtension
+      NAMESPACE = 'urn:ietf:params:xml:ns:secDNS-1.1'
+
+      def initialize(attributes)
+        @add = Array(attributes[:add])
+        @rem = Array(attributes[:rem])
+        @chg = Array(attributes[:chg])
+
+        raise ArgumentError, "must provide :add, :rem or :chg keys" if @add.empty? && @rem.empty? && @chg.empty?
+
+        @namespaces = {}
+      end
+
+      def namespace_uri
+        NAMESPACE
+      end
+      def namespace_name
+        'secDNS'
+      end
+
+      def to_xml
+        node = x_node('update')
+        x_schemaLocation(node)
+
+        if @rem[0] == :all || @rem[0] == 'all'
+          node << x_node('rem').tap do |n|
+            n << x_node('all', 'true')
+          end
+        elsif !@rem.empty?
+          node << x_node('rem').tap do |n|
+            @rem.each do |ds|
+              n << x_node('dsData').tap do |dsData|
+                dsData << x_node('keyTag', ds[:key_tag].to_s)
+                dsData << x_node('alg', ds[:alg].to_s)
+                dsData << x_node('digestType', ds[:digest_type].to_s)
+                dsData << x_node('digest', ds[:digest].gsub(/\s/,''))
+              end
+            end
+          end
+        end
+
+        if @add && !@add.empty?
+          node << x_node('add').tap do |n|
+            @add.each do |ds|
+              n << x_node('dsData').tap do |dsData|
+                dsData << x_node('keyTag', ds[:key_tag].to_s)
+                dsData << x_node('alg', ds[:alg].to_s)
+                dsData << x_node('digestType', ds[:digest_type].to_s)
+                dsData << x_node('digest', ds[:digest].gsub(/\s/,''))
+              end
+            end
+          end
+        end
+
+        if @chg && !@chg.empty?
+          # Nominet don't support maxSigLife so nothing happens here
+        end
+
+        node
+      end
+    end
+  end
+end

data/lib/nominet-epp/requests/host/check.rb

@@ -0,0 +1,9 @@
+module NominetEPP
+  module Host
+    class Check < Request
+      def initialize(*names)
+        @command = EPP::Host::Check.new(*names)
+      end
+    end
+  end
+end

data/lib/nominet-epp/requests/host/create.rb

@@ -0,0 +1,9 @@
+module NominetEPP
+  module Host
+    class Create < Request
+      def initialize(name, attributes = {})
+        @command = EPP::Host::Create.new(name, attributes)
+      end
+    end
+  end
+end

data/lib/nominet-epp/requests/host/delete.rb

@@ -0,0 +1,9 @@
+module NominetEPP
+  module Host
+    class Delete < Request
+      def initialize(name)
+        @command = EPP::Host::Delete.new(name)
+      end
+    end
+  end
+end

data/lib/nominet-epp/requests/host/info.rb

@@ -0,0 +1,9 @@
+module NominetEPP
+  module Host
+    class Info < Request
+      def initialize(name)
+        @command = EPP::Host::Info.new(name)
+      end
+    end
+  end
+end

data/lib/nominet-epp/requests/host/update.rb

@@ -0,0 +1,9 @@
+module NominetEPP
+  module Host
+    class Update < Request
+      def initialize(name, attributes = {})
+        @command = EPP::Host::Update.new(name, attributes)
+      end
+    end
+  end
+end

data/lib/nominet-epp/responses/contact/check_response.rb

@@ -0,0 +1,10 @@
+module NominetEPP
+  module Contact
+    class CheckResponse < BasicResponse
+      def initialize(response)
+        raise ArgumentError, "must be an EPP::Response" unless response.kind_of?(EPP::Response)
+        super EPP::Contact::CheckResponse.new(response)
+      end
+    end
+  end
+end

data/lib/nominet-epp/responses/contact/create_response.rb

@@ -0,0 +1,14 @@
+module NominetEPP
+  module Contact
+    class CreateResponse < BasicResponse
+      def initialize(response)
+        raise ArgumentError, "must be an EPP::Response" unless response.kind_of?(EPP::Response)
+        super EPP::Contact::CreateResponse.new(response)
+      end
+
+      def name
+        @response.id
+      end
+    end
+  end
+end

data/lib/nominet-epp/responses/contact/delete_response.rb

@@ -0,0 +1,10 @@
+module NominetEPP
+  module Contact
+    class DeleteResponse < BasicResponse
+      def initialize(response)
+        raise ArgumentError, "must be an EPP::Response" unless response.kind_of?(EPP::Response)
+        super EPP::Contact::DeleteResponse.new(response)
+      end
+    end
+  end
+end