nominet-epp 0.0.12 → 1.0.0

data/lib/nominet-epp/notification.rb

@@ -0,0 +1,346 @@
+require 'ostruct'
+module NominetEPP
+  class Notification
+    unless RUBY_VERSION >= "1.9"
+      class OpenStruct < ::OpenStruct
+        undef id
+        undef type
+      end
+    end
+
+    NAMESPACE_URIS = {
+      'urn:ietf:params:xml:ns:domain-1.0' => 'domain',
+      'urn:ietf:params:xml:ns:contact-1.0' => 'contact',
+      'http://www.nominet.org.uk/epp/xml/nom-abuse-feed-1.0' => 'abuse',
+      'http://www.nominet.org.uk/epp/xml/std-notifications-1.0' => 'n',
+      'http://www.nominet.org.uk/epp/xml/std-notifications-1.1' => 'n',
+      'http://www.nominet.org.uk/epp/xml/std-notifications-1.2' => 'n',
+      'http://www.nominet.org.uk/epp/xml/nom-notifications-2.1' => 'n',
+      'http://www.nominet.org.uk/epp/xml/contact-nom-ext-1.0' => 'contact_ext',
+      'http://www.nominet.org.uk/epp/xml/std-warning-1.1' => 'warning' }
+
+    def initialize(response)
+      raise ArgumentError, "must be an EPP::Response" unless response.kind_of?(EPP::Response)
+      @response = response
+      @parsed   = {}
+
+      if response.code == 1301
+        parse_response
+        parse_extension
+      end
+    end
+
+    undef to_s
+
+    def type
+      @type ||= begin
+        case msgQ_msg
+        when /Account Details Change/i
+          :account_change
+        when /Contact deleted/i
+          :contact_deleted
+        when /DQ Workflow process/i
+          :data_quality
+        when /Domain Activity/i
+          :abuse_feed
+        when /Domain name Cancellation/i
+          :domain_cancelled
+        when /Domains Released/i
+          :domains_released
+        when /Domains Suspended/i
+          :domains_suspended
+        when /Host cancellation/i
+          :host_cancellation
+        when /Referral Accepted/i
+          :referral_accepted
+        when /Referral Rejected/i
+          :referral_rejected
+        when /Registrant Transfer/i
+          :registrant_transfer
+        when /Registrar Change Authorisation Request/i
+          :handshake_request
+        when /Registrar Change Handshake Rejected/i
+          :handshake_rejected
+        when /Registrar Change Notification/
+          :registrar_change
+        end
+      end
+    end
+
+    def msgQ_msg
+      @msgQ_msg ||= @response.msgQ.find('e:msg').first.content.strip
+    end
+
+    def method_missing(method, *args, &block)
+      return @parsed[method] if @parsed.has_key?(method)
+      return super unless @response.respond_to?(method)
+      @response.send(method, *args, &block)
+    end
+
+    def respond_to_missing?(method, include_private)
+      @parsed.has_key?(method) || @response.respond_to?(method, include_private)
+    end
+
+    undef id unless RUBY_VERSION >= "1.9"
+
+    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 parse_response
+        ns   = NAMESPACE_URIS[@response.data.namespaces.namespace.href]
+        name = @response.data.name.gsub('-', '_')
+
+        method = :"parse_#{ns}_#{name}"
+        if self.respond_to?(method, true)
+          return self.send(method, @response.data)
+        end
+      end
+      def parse_extension
+        [@response.extension].flatten.compact.each do |extension|
+          ns   = NAMESPACE_URIS[extension.namespaces.namespace.href]
+          name = extension.name.gsub('-', '_')
+
+          method = :"parse_#{ns}_#{name}"
+          if self.respond_to?(method, true)
+            return self.send(method, extension)
+          end
+        end
+      end
+
+      def parse_n_cancData(data)
+        data.children.each do |node|
+          next if node.empty?
+
+          case node.name
+          when 'domainName'
+            @parsed[:name] = node.content.strip
+          when 'orig'
+            @parsed[:originator] = node.content.strip
+          end
+        end
+      end
+      def parse_domain_ns(data)
+        data.children.map do |node|
+          next if node.empty?
+
+          case node.name
+          when 'hostObj'
+            node.content.strip
+          end
+        end.compact
+      end
+      def parse_domain_infData(data)
+        parsed = {}
+        data.children.each do |node|
+          next if node.empty?
+
+          case node.name
+          when 'name'
+            parsed[:name] = node.content.strip
+          when 'roid'
+            parsed[:roid] = node.content.strip
+          when 'ns'
+            parsed[:nameservers] = parse_domain_ns(node)
+          when 'clID'
+            parsed[:client_id] = node.content.strip
+          when 'crID'
+            parsed[:creator_id] = node.content.strip
+          when 'crDate'
+            parsed[:created_date] = Time.parse(node.content.strip)
+          when 'exDate'
+            parsed[:expiration_date] = Time.parse(node.content.strip)
+          end
+        end
+        parsed
+      end
+      def parse_n_domainListData(data)
+        data.children.map do |node|
+          next if node.empty?
+
+          case node.name
+          when 'domainName'
+            node.content.strip
+          when 'infData'
+            OpenStruct.new(parse_domain_infData(node))
+          end
+        end.compact
+      end
+      def parse_n_relData(data)
+        data.children.each do |node|
+          next if node.empty?
+
+          case node.name
+          when 'accountId'
+            @parsed[:account_id] = node.content.strip
+            @parsed[:account_moved?] = node['moved'] == 'Y'
+          when 'from'
+            @parsed[:from] = node.content.strip
+          when 'registrarTag'
+            @parsed[:registrar_tag] = node.content.strip
+          when 'domainListData'
+            @parsed[:domains] = parse_n_domainListData(node)
+          end
+        end
+      end
+      def parse_n_suspData(data)
+        data.children.each do |node|
+          next if node.empty?
+
+          case node.name
+          when 'reason'
+            @parsed[:reason] = node.content.strip
+          when 'cancelDate'
+            @parsed[:cancellation_date] = Time.parse(node.content.strip)
+          when 'domainListData'
+            @parsed[:domains] = parse_n_domainListData(node)
+          end
+        end
+      end
+      def parse_n_trnData(data)
+        data.children.each do |node|
+          next if node.empty?
+
+          case node.name
+          when 'orig'
+            @parsed[:originator] = node.content.strip
+          when 'accountId'
+            @parsed[:account_id] = node.content.strip
+          when 'oldAccountId'
+            @parsed[:old_account_id] = node.content.strip
+          when 'domainListData'
+            @parsed[:domains] = parse_n_domainListData(node)
+          when 'infData'
+            @parsed[:contact] = OpenStruct.new(parse_contact_infData(node))
+          end
+        end
+      end
+      def parse_contact_infData(data)
+        parsed = {}
+        data.children.each do |node|
+          next if node.empty?
+
+          case node.name
+          when 'id'
+            parsed[:id] = node.content.strip
+          when 'roid'
+            parsed[:roid] = node.content.strip
+          when 'status'
+            parsed[:status] = node['s'].to_s
+          when 'postalInfo'
+            parsed[:postal_info] = parse_contact_postalInfo(node)
+          when 'voice'
+            parsed[:voice] = node.content.strip
+          when 'email'
+            parsed[:email] = node.content.strip
+          when 'clID'
+            parsed[:client_id] = node.content.strip
+          when 'crID'
+            parsed[:creator_id] = node.content.strip
+          when 'crDate'
+            parsed[:created_date] = Time.parse(node.content.strip)
+          when 'upID'
+            parsed[:updator_id] = node.content.strip
+          when 'upDate'
+            parsed[:updated_date] = Time.parse(node.content.strip)
+          end
+        end
+        parsed
+      end
+      def parse_contact_postalInfo(data)
+        parsed = {}
+        data.children.each do |node|
+          next if node.empty?
+
+          case node.name
+          when 'name'
+            parsed[:name] = node.content.strip
+          when 'org'
+            parsed[:org] = node.content.strip
+          when 'addr'
+            parsed[:addr] = parse_contact_addr(node)
+          end
+        end
+        parsed
+      end
+      def parse_contact_addr(data)
+        parsed = {}
+        data.children.each do |node|
+          next if node.empty?
+
+          case node.name
+          when 'street'
+            parsed[:street] = node.content.strip
+          when 'city'
+            parsed[:city] = node.content.strip
+          when 'sp'
+            parsed[:sp] = node.content.strip
+          when 'pc'
+            parsed[:pc] = node.content.strip
+          when 'cc'
+            parsed[:cc] = node.content.strip
+          end
+        end
+        parsed
+      end
+      def parse_n_contactDelData(data)
+        data.children.each do |node|
+          next if node.empty?
+
+          case node.name
+          when 'contactId'
+            @parsed[:id] = node.content.strip
+          when 'roid'
+            @parsed[:roid] = node.content.strip
+          end
+        end
+      end
+      def parse_n_rcData(data)
+        data.children.each do |node|
+          next if node.empty?
+
+          case node.name
+          when 'orig'
+            @parsed[:originator] = node.content.strip
+          when 'registrarTag'
+            @parsed[:registrar_tag] = node.content.strip
+          when 'domainListData'
+            @parsed[:domains] = parse_n_domainListData(node)
+          when 'infData'
+            @parsed[:contact] = OpenStruct.new(parse_contact_infData(node))
+          end
+        end
+      end
+
+      def parse_contact_ext_infData(ext)
+        ext.children.each do |node|
+          next if node.empty?
+
+          @parsed[:contact] ||= OpenStruct.new
+
+          case node.name
+          when 'opt-out'
+            @parsed[:contact].opt_out = node.content.strip == 'Y'
+          else
+            @parsed[:contact].send("#{node.name}=", node.content.strip)
+          end
+        end
+      end
+      
+      def parse_warning_truncated_field(ext)
+        field_name = ext['field-name']
+        value = ext.content.strip
+        
+        case field_name
+        when /:crID$/, /:upID$/
+          return
+        end
+      end
+  end
+end

data/lib/nominet-epp/operations.rb

@@ -4,17 +4,12 @@ module NominetEPP
     autoload :Check,    File.dirname(__FILE__) + '/operations/check.rb'
     autoload :Create,   File.dirname(__FILE__) + '/operations/create.rb'
     autoload :Delete,   File.dirname(__FILE__) + '/operations/delete.rb'
-    autoload :Fork,     File.dirname(__FILE__) + '/operations/fork.rb'
+    autoload :Handshake,File.dirname(__FILE__) + '/operations/handshake.rb'
     autoload :Hello,    File.dirname(__FILE__) + '/operations/hello.rb'
     autoload :Info,     File.dirname(__FILE__) + '/operations/info.rb'
-    autoload :List,     File.dirname(__FILE__) + '/operations/list.rb'
-    autoload :Lock,     File.dirname(__FILE__) + '/operations/lock.rb'
-    autoload :Merge,    File.dirname(__FILE__) + '/operations/merge.rb'
     autoload :Poll,     File.dirname(__FILE__) + '/operations/poll.rb'
+    autoload :Release,  File.dirname(__FILE__) + '/operations/release.rb'
     autoload :Renew,    File.dirname(__FILE__) + '/operations/renew.rb'
-    autoload :Transfer, File.dirname(__FILE__) + '/operations/transfer.rb'
-    autoload :Unlock,   File.dirname(__FILE__) + '/operations/unlock.rb'
-    autoload :Unrenew,  File.dirname(__FILE__) + '/operations/unrenew.rb'
     autoload :Update,   File.dirname(__FILE__) + '/operations/update.rb'
   end
 end

data/lib/nominet-epp/request.rb

@@ -0,0 +1,165 @@
+module NominetEPP
+  class Request
+    attr_reader :command, :extension
+
+    def command_name
+      @command_name ||= command.name
+    end
+
+    def namespaces
+      ext_ns = @extension && @extension.namespaces || {}
+      @command.namespaces.merge(ext_ns)
+    end
+
+    # Creates and returns a new XML node
+    #
+    # @param [String] name of the node to create
+    # @param [String,XML::Node,nil] value of the node
+    # @return [XML::Node]
+    def xml_node(name, value = nil)
+      XML::Node.new(name, value)
+    end
+
+    # Creates and returns a new XML namespace
+    #
+    # @param [XML::Node] node XML node to add the namespace to
+    # @param [String] name Name of the namespace to create
+    # @param [String] uri URI of the namespace to create
+    # @return [XML::Namespace]
+    def xml_namespace(node, name, uri, namespaces = {})
+      XML::Namespace.new(node, name, uri)
+    end
+  end
+
+  class RequestExtension
+    attr_reader :namespaces
+
+    def set_namespaces(namespaces)
+      @namespaces = namespaces
+    end
+
+    def namespace_uri
+      raise NotImplementedError
+    end
+    def namespace_name
+      case namespace_uri
+      when /\Aurn\:/
+        namespace_uri.split(':').last.split('-',2).first.to_sym
+      else
+        namespace_uri.split('/').last.split('-')[0...-1].join('-').to_sym
+      end
+    end
+
+    def schemaLocation
+      "#{namespace_uri} #{schema_name(namespace_uri)}.xsd"
+    end
+
+    protected
+      # Creates and returns a new XML node
+      #
+      # @param [String] name of the node to create
+      # @param [String,XML::Node,nil] value of the node
+      # @return [XML::Node]
+      def xml_node(name, value = nil)
+        XML::Node.new(name, value)
+      end
+
+      # Creates and returns a new XML namespace
+      #
+      # @param [XML::Node] node XML node to add the namespace to
+      # @param [String] name Name of the namespace to create
+      # @param [String] uri URI of the namespace to create
+      # @return [XML::Namespace]
+      def xml_namespace(node, name, uri, namespaces = {})
+        XML::Namespace.new(node, name, uri)
+      end
+    
+      def x_node(name, value = nil)
+        node = xml_node(name, value)
+        node.namespaces.namespace = x_namespace(node)
+        node
+      end
+
+      def x_namespace(node, name = namespace_name, ns = namespace_uri)
+        return @namespaces[name] if @namespaces.has_key?(name)
+        @namespaces[name] = xml_namespace(node, name, ns)
+      end
+
+      def x_schemaLocation(node, sL = schemaLocation)
+        xattr = XML::Attr.new(node, "schemaLocation", sL)
+        xattr.namespaces.namespace = x_namespace(node, 'xsi', 'http://www.w3.org/2001/XMLSchema-instance')
+      end
+
+      # Returns the name of the given schema
+      # @internal
+      # @param [String] urn Schema URN or URI
+      # @return [String] the name of the given schema
+      def schema_name(urn)
+        case urn
+        when /\Aurn\:/
+          urn.split(':').last
+        else
+          urn.split('/').last
+        end
+      end
+  end
+
+  class CustomRequest < Request
+    def command
+      self
+    end
+
+    def namespaces
+      @namespaces
+    end
+    def set_namespaces(namespaces)
+      @namespaces = namespaces
+    end
+
+    def namespace_uri
+      raise NotImplementedError
+    end
+    def namespace_name
+      case namespace_uri
+      when /\Aurn\:/
+        namespace_uri.split(':').last.split('-',2).first.to_sym
+      else
+        namespace_uri.split('/').last.split('-')[0...-1].join('-').to_sym
+      end
+    end
+
+    def schemaLocation
+      "#{namespace_uri} #{schema_name(namespace_uri)}.xsd"
+    end
+
+    protected
+      def x_node(name, value = nil)
+        node = xml_node(name, value)
+        node.namespaces.namespace = x_namespace(node)
+        node
+      end
+
+      def x_namespace(node, name = namespace_name, ns = namespace_uri)
+        return @namespaces[name] if @namespaces.has_key?(name)
+        @namespaces[name] = xml_namespace(node, name, ns)
+      end
+
+      def x_schemaLocation(node, sL = schemaLocation)
+        xattr = XML::Attr.new(node, "schemaLocation", sL)
+        xattr.namespaces.namespace = x_namespace(node, 'xsi', 'http://www.w3.org/2001/XMLSchema-instance')
+      end
+
+      # Returns the name of the given schema
+      # @internal
+      # @param [String] urn Schema URN or URI
+      # @return [String] the name of the given schema
+      def schema_name(urn)
+        case urn
+        when /\Aurn\:/
+          urn.split(':').last
+        else
+          urn.split('/').last
+        end
+      end
+  end
+end

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

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

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

@@ -0,0 +1,60 @@
+module NominetEPP
+  module Contact
+    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) }
+
+        @contact_ext = CreateExtension.new(@extensions) rescue nil
+
+        @command    = EPP::Contact::Create.new(@name, @options)
+        @extension  = EPP::Requests::Extension.new(@contact_ext) rescue nil
+      end
+    end
+
+    class CreateExtension < 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('create')
+        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/contact/delete.rb

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

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

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

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

@@ -0,0 +1,33 @@
+module NominetEPP
+  module Contact
+    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('registrant', @name)
+        node << x_node('registrarTag', @tag)
+
+        node
+      end
+    end
+  end
+end