epp-eis 0.1.1

data/lib/epp-eis/domain.rb

@@ -0,0 +1,410 @@
+module Epp
+  module Eis
+    
+    XML_NS_DOMAIN = 'http://www.nic.cz/xml/epp/domain-1.4'
+    
+    XML_SCHEMALOC = 'http://www.nic.cz/xml/epp/domain-1.4.xsd domain-1.4.xsd'
+
+    class DomainCreateResponse
+      def initialize(response)
+        @response = Nokogiri::XML(response)
+      end
+      
+      def code
+        @response.css('epp response result').first['code'].to_i
+      end
+
+      def message
+        @response.css('epp response result msg').text
+      end
+      
+      def domain_name
+        @response.css('domain|creData domain|name', 'domain' => XML_NS_DOMAIN).text
+      end
+      
+      def domain_create_date
+        @response.css('domain|creData domain|crDate', 'domain' => XML_NS_DOMAIN).text
+      end
+      
+      def domain_expire_date
+        @response.css('domain|creData domain|exDate', 'domain' => XML_NS_DOMAIN).text
+      end
+    end
+    
+    class DomainDeleteResponse
+      def initialize(response)
+        @response = Nokogiri::XML(response)
+      end
+      
+      def code
+        @response.css('epp response result').first['code'].to_i
+      end
+
+      def message
+        @response.css('epp response result msg').text
+      end
+    end
+
+    class DomainTransferResponse
+      def initialize(response)
+        @response = Nokogiri::XML(response)
+      end
+      
+      def code
+        @response.css('epp response result').first['code'].to_i
+      end
+
+      def message
+        @response.css('epp response result msg').text
+      end
+    end
+    
+    class DomainUpdateResponse
+      def initialize(response)
+        @response = Nokogiri::XML(response)
+      end
+      
+      def code
+        @response.css('epp response result').first['code'].to_i
+      end
+
+      def message
+        @response.css('epp response result msg').text
+      end
+    end
+
+    class DomainInfoResponse
+      def initialize(response)
+        @response = Nokogiri::XML(response)
+      end
+      
+      def code
+        @response.css('epp response result').first['code'].to_i
+      end
+
+      def message
+        @response.css('epp response result msg').text
+      end
+      
+      def domain_name
+        @response.css('domain|infData domain|name', 'domain' => XML_NS_DOMAIN).text
+      end
+
+      def domain_roid
+        @response.css('domain|infData domain|roid', 'domain' => XML_NS_DOMAIN).text
+      end
+
+      def domain_status
+        @response.css('domain|infData domain|status', 'domain' => XML_NS_DOMAIN).text
+      end
+      
+      def domain_registrant
+        @response.css('domain|infData domain|registrant', 'domain' => XML_NS_DOMAIN).text
+      end
+      
+      def domain_admin
+        @response.css('domain|infData domain|admin', 'domain' => XML_NS_DOMAIN).text
+      end
+      
+      def domain_nsset
+        @response.css('domain|infData domain|nsset', 'domain' => XML_NS_DOMAIN).text
+      end
+      
+      def domain_clid
+        @response.css('domain|infData domain|clID', 'domain' => XML_NS_DOMAIN).text
+      end
+      
+      def domain_crid
+        @response.css('domain|infData domain|crID', 'domain' => XML_NS_DOMAIN).text
+      end
+      
+      def domain_create_date
+        @response.css('domain|infData domain|crDate', 'domain' => XML_NS_DOMAIN).text
+      end
+      
+      def domain_expire_date
+        @response.css('domain|infData domain|exDate', 'domain' => XML_NS_DOMAIN).text
+      end
+      
+      def domain_authinfo
+        @response.css('domain|infData domain|authInfo', 'domain' => XML_NS_DOMAIN).text
+      end
+    end
+
+    class DomainRenewResponse
+      def initialize(response)
+        @response = Nokogiri::XML(response)
+      end
+      
+      def code
+        @response.css('epp response result').first['code'].to_i
+      end
+
+      def message
+        @response.css('epp response result msg').text
+      end
+      
+      def domain_name
+        @response.css('domain|renData domain|name', 'domain' => XML_NS_DOMAIN).text
+      end
+      
+      def domain_expire_date
+        @response.css('domain|renData domain|exDate', 'domain' => XML_NS_DOMAIN).text
+      end
+    end
+
+    class DomainCheck
+      attr_accessor :name, :available, :reason
+
+      def initialize(name, available, reason)
+        @name = name
+        @available = available
+        @reason = reason
+      end
+
+      def available?
+        @available
+      end
+    end
+
+    class DomainCheckResponse
+
+      def initialize(response)
+        @response = Nokogiri::XML(response)
+      end
+
+      def code
+        @response.css('epp response result').first['code'].to_i
+      end
+
+      def message
+        @response.css('epp response result msg').text
+      end
+
+      def items
+        @response.css('domain|chkData domain|cd', 'domain' => XML_NS_DOMAIN).collect do |domain|
+          DomainCheck.new(
+            domain.css('domain|name', 'domain' => XML_NS_DOMAIN).text,
+            domain.css('domain|name', 'domain' => XML_NS_DOMAIN).first['avail'].to_i == 1,
+            domain.css('domain|reason', 'domain' => XML_NS_DOMAIN).text
+          )
+        end
+      end
+    end
+    
+    module DomainCommands
+      
+      # Create a new domain.
+      #
+      # Domain names with IDN characters õ, ä. ö. ü, š, ž will be allowed. If a domain name contains at least one of
+      # these characters then it must be translated to PUNYCODE before domain create.
+      #
+      # domain          - Domain name to be registered
+      # nsset           - Nameserver id
+      # registrant      - Registrant contact id
+      # admin           - Admin contact id, or array of id-s
+      # legal_document  - Legal document binary data
+      # legal_doc_type  - Legal document type (pdf, ddoc)
+      #
+      # Returns DomainCreateResponse object
+      def create_domain(domain, nsset, registrant, admins, legal_document, legal_doc_type)
+        builder = build_epp_request do |xml|
+          xml.command {
+            xml.create {
+              xml.create('xmlns:domain' => XML_NS_DOMAIN, 'xsi:schemaLocation' => XML_SCHEMALOC) {
+                xml.parent.namespace = xml.parent.namespace_definitions.first
+                xml.name domain
+                xml.period '1', 'unit' => 'y'
+                xml.nsset nsset
+                xml.registrant registrant
+                [admins].flatten.each { |admin| xml.admin admin }
+              }
+            }
+            add_legal_document(xml, legal_document, legal_doc_type)
+            xml.clTRID UUIDTools::UUID.timestamp_create.to_s
+          }
+        end
+        
+        DomainCreateResponse.new(send_request(builder.to_xml))
+      end
+      
+      # Delete domain.
+      #
+      # domain          - Domain name to be registered
+      # legal_document  - Legal document binary data
+      # legal_doc_type  - Legal document type (pdf, ddoc)
+      #
+      # Returns DomainDeleteResponse object
+      def delete_domain(domain, legal_document, legal_doc_type)
+        builder = build_epp_request do |xml|
+          xml.command {
+            xml.delete {
+              xml.delete('xmlns:domain' => XML_NS_DOMAIN, 'xsi:schemaLocation' => XML_SCHEMALOC) {
+                xml.parent.namespace = xml.parent.namespace_definitions.first
+                xml.name domain
+              }
+            }
+            add_legal_document(xml, legal_document, legal_doc_type)
+            xml.clTRID UUIDTools::UUID.timestamp_create.to_s
+          }
+        end
+        
+        DomainDeleteResponse.new(send_request(builder.to_xml))
+      end
+      
+      # Will return detailed information about the domain. The information will include domain password field. The field
+      # will be populated with a real value if the domain owner executed the function. Non-owner will see empty domain
+      # password field value.
+      #
+      # domain  - Domain name to be queried
+      #
+      # Returns DomainInfoResponse object
+      def info_domain(domain)
+        builder = build_epp_request do |xml|
+          xml.command {
+            xml.info {
+              xml.info('xmlns:domain' => XML_NS_DOMAIN, 'xsi:schemaLocation' => XML_SCHEMALOC) {
+                xml.parent.namespace = xml.parent.namespace_definitions.first
+                xml.name domain
+              }
+            }
+            xml.clTRID UUIDTools::UUID.timestamp_create.to_s
+          }
+        end
+        
+        DomainInfoResponse.new(send_request(builder.to_xml))
+      end
+      
+      # Updates domain expiration period for another year.
+      #
+      # domain                - Domain to be renewed
+      # current_expire_date   - Current expiration date of the domain in YYYY-MM-DD format
+      #
+      # Returns DomainRenewResponse object with server response information
+      def renew_domain(domain, current_expire_date)
+        builder = build_epp_request do |xml|
+          xml.command {
+            xml.renew {
+              xml.renew('xmlns:domain' => XML_NS_DOMAIN, 'xsi:schemaLocation' => XML_SCHEMALOC) {
+                xml.parent.namespace = xml.parent.namespace_definitions.first
+                xml.name domain
+                xml.curExpDate current_expire_date
+                xml.period '1', 'unit' => 'y'
+              }
+            }
+            xml.clTRID UUIDTools::UUID.timestamp_create.to_s
+          }
+        end
+        
+        DomainRenewResponse.new(send_request(builder.to_xml))
+      end
+      
+      # Used to transfer domain ownership from one registrar to another.
+      #
+      # domain      - Name of the domain to be transferred
+      # auth_info   - Domain authorization code
+      #
+      # Returns DomainTransferResponse object
+      def transfer_domain(domain, auth_info, legal_document, legal_doc_type)
+        builder = build_epp_request do |xml|
+          xml.command {
+            xml.transfer('op' => 'request') {
+              xml.transfer('xmlns:domain' => XML_NS_DOMAIN, 'xsi:schemaLocation' => XML_SCHEMALOC) {
+                xml.parent.namespace = xml.parent.namespace_definitions.first
+                xml.name domain
+                xml.authInfo auth_info
+              }
+            }
+            add_legal_document(xml, legal_document, legal_doc_type)
+            xml.clTRID UUIDTools::UUID.timestamp_create.to_s
+          }
+        end
+        
+        DomainTransferResponse.new(send_request(builder.to_xml))
+      end
+      
+      # Used to update domain information.
+      #
+      # domain          - Domain name to be updated
+      # add_admins      - Array of admin contact ids to be added. Set to nil or empty array if no changes needed
+      # rem_admins      - Array of admin contact ids to be removed. Set to nil or empty array if no changes needed
+      # nsset           - Domain nsset id to be changed. Set to nil if no changes needed
+      # registrant      - Domain registrant contact id to be changed. Set to nil if no changes needed
+      # auth_info       - Domain authorization code to be changed. Set to nil if no changes needed
+      # legal_document  - Legal document binary data
+      # legal_doc_type  - Legal document type (pdf, ddoc)
+      # 
+      # Returns DomainUpdateResponse object
+      def update_domain(domain, add_admins, rem_admins, nsset, registrant, auth_info, legal_document, legal_doc_type)
+        builder = build_epp_request do |xml|
+          xml.command {
+            xml.update {
+              xml.update('xmlns:domain' => XML_NS_DOMAIN, 'xsi:schemaLocation' => XML_SCHEMALOC) {
+                xml.parent.namespace = xml.parent.namespace_definitions.first
+                xml.name domain
+                if !add_admins.nil? && !add_admins.empty?
+                  xml.add {
+                    add_admins.each { |add_admin| xml.admin add_admin }
+                  }
+                end
+                if !rem_admins.nil? && !rem_admins.empty?
+                  xml.rem {
+                    rem_admins.each { |rem_admin| xml.admin rem_admin }
+                  }
+                end
+                if [nsset, registrant, auth_info].any?{ |item| !item.nil? }
+                  xml.chg {
+                    xml.nsset nsset if nsset
+                    xml.registrant registrant if registrant
+                    xml.auth_info auth_info if auth_info
+                  }
+                end
+              }
+            }
+            add_legal_document(xml, legal_document, legal_doc_type)
+            xml.clTRID UUIDTools::UUID.timestamp_create.to_s
+          }
+        end
+        
+        DomainUpdateResponse.new(send_request(builder.to_xml))
+      end
+      
+      def list_domains
+        list_command('listDomains')
+      end
+
+      # Check availability for a domain or a list of domains.
+      #
+      # Returns DomainCheckResponse object with server response information
+      def check_domain(*domains)
+        builder = build_epp_request do |xml|
+          xml.command {
+            xml.check {
+              xml.check('xmlns:domain' => XML_NS_DOMAIN, 'xsi:schemaLocation' => XML_SCHEMALOC) {
+                xml.parent.namespace = xml.parent.namespace_definitions.first
+                domains.each do |domain|
+                  xml.name domain
+                end
+              }
+            }
+            xml.clTRID UUIDTools::UUID.timestamp_create.to_s
+          }
+        end
+
+        DomainCheckResponse.new(send_request(builder.to_xml))
+      end
+      
+      # Shortcut function to check whether domain is available.
+      #
+      # domain  - Domain name to be checked
+      #
+      # Returns true if domain is available and false if it is not.
+      def is_domain_available?(domain)
+        results = check_domain(domain).items
+        results.nil? ? false : results.first.available?
+      end
+    end
+  end
+end
+
+Epp::Server.send(:include, Epp::Eis::DomainCommands)

data/lib/epp-eis/extensions.rb

@@ -0,0 +1,22 @@
+require 'base64'
+
+# EIS specific EPP extensions
+module Epp
+  module Eis
+    module EisExtensions
+      
+      private
+    
+      def append_legal_document(xml, legal_document, legal_doc_type)
+        xml.extension {
+          xml.extdata('xmlns:eis' => 'urn:ee:eis:xml:epp:eis-1.0', 'xsi:schemaLocation' => 'urn:ee:eis:xml:epp:eis-1.0 eis-1.0.xsd') {
+            xml.parent.namespace = xml.parent.namespace_definitions.first
+            xml.legalDocument Base64.encode64(legal_document), 'type' => legal_doc_type
+          }
+        }
+      end
+    end
+  end
+end
+
+Epp::Server.send(:include, Epp::Eis::EisExtensions)

data/lib/epp-eis/nsset.rb

@@ -0,0 +1,246 @@
+module Epp
+  module Eis
+    
+    XML_NS_NSSET = 'http://www.nic.cz/xml/epp/nsset-1.2'
+    
+    XML_SCHEMALOC = 'http://www.nic.cz/xml/epp/nsset-1.2 nsset-1.2.xsd'
+    
+    class NssetCheck
+      attr_accessor :name, :available
+
+      def initialize(name, available)
+        @name = name
+        @available = available
+      end
+
+      def available?
+        @available
+      end
+    end
+
+    class NssetCheckResponse
+
+      def initialize(response)
+        @response = Nokogiri::XML(response)
+      end
+
+      def code
+        @response.css('epp response result').first['code'].to_i
+      end
+
+      def message
+        @response.css('epp response result msg').text
+      end
+
+      def items
+        @response.css('nsset|chkData nsset|cd', 'nsset' => XML_NS_NSSET).collect do |nsset|
+          NssetCheck.new(
+            nsset.css('nsset|id', 'nsset' => XML_NS_NSSET).text,
+            nsset.css('nsset|id', 'nsset' => XML_NS_NSSET).first['avail'].to_i == 1
+          )
+        end
+      end
+    end
+
+    class NssetCreateResponse
+      def initialize(response)
+        @response = Nokogiri::XML(response)
+      end
+      
+      def code
+        @response.css('epp response result').first['code'].to_i
+      end
+    
+      def message
+        @response.css('epp response result msg').text
+      end
+      
+      def nsset_id
+        @response.css('nsset|creData nsset|id', 'nsset' => XML_NS_NSSET).text
+      end
+      
+      def nsset_create_date
+        @response.css('nsset|creData nsset|crDate', 'nsset' => XML_NS_NSSET).text
+      end
+    end
+    
+    class NssetDeleteResponse
+      def initialize(response)
+        @response = Nokogiri::XML(response)
+      end
+      
+      def code
+        @response.css('epp response result').first['code'].to_i
+      end
+    
+      def message
+        @response.css('epp response result msg').text
+      end
+    end
+    
+    class NssetInfoResponse
+      def initialize(response)
+        @response = Nokogiri::XML(response)
+      end
+      
+      def code
+        @response.css('epp response result').first['code'].to_i
+      end
+    
+      def message
+        @response.css('epp response result msg').text
+      end
+      
+      def nsset_id
+        @response.css('nsset|infData nsset|id', 'nsset' => XML_NS_NSSET).text
+      end
+    
+      def nsset_roid
+        @response.css('nsset|infData nsset|roid', 'nsset' => XML_NS_NSSET).text
+      end
+    
+      def nsset_status
+        @response.css('nsset|infData nsset|status', 'nsset' => XML_NS_NSSET).first['s']
+      end
+      
+      def nameservers
+        @response.css('nsset|infData nsset|ns', 'nsset' => XML_NS_NSSET).inject(Array.new) do |memo, nsset|
+          memo << [nsset.css('nsset|name', 'nsset' => XML_NS_NSSET).text, nsset.css('nsset|addr', 'nsset' => XML_NS_NSSET).text]
+        end
+      end
+    end
+    
+    class NssetUpdateResponse
+      def initialize(response)
+        @response = Nokogiri::XML(response)
+      end
+      
+      def code
+        @response.css('epp response result').first['code'].to_i
+      end
+    
+      def message
+        @response.css('epp response result msg').text
+      end
+    end
+    
+    module NssetCommands
+      
+      # Check availability for a nsset identification.
+      def check_nsset(*nssets)
+        builder = build_epp_request do |xml|
+          xml.command {
+            xml.check {
+              xml.check('xmlns:nsset' => XML_NS_NSSET, 'xsi:schemaLocation' => XML_SCHEMALOC) {
+                xml.parent.namespace = xml.parent.namespace_definitions.first
+                nssets.each { |nsset| xml.id_ nsset }
+              }
+            }
+            xml.clTRID UUIDTools::UUID.timestamp_create.to_s
+          }
+        end
+
+        NssetCheckResponse.new(send_request(builder.to_xml))
+      end
+      
+      # Create a new nameserver object
+      def create_nsset(nsset, nameservers, contact)
+        builder = build_epp_request do |xml|
+          xml.command {
+            xml.create {
+              xml.create('xmlns:nsset' => XML_NS_NSSET, 'xsi:schemaLocation' => XML_SCHEMALOC) {
+                xml.parent.namespace = xml.parent.namespace_definitions.first
+                xml.id_ nsset
+                nameservers.each do |nameserver|
+                  xml.ns {
+                    xml.name nameserver[0]
+                    xml.addr nameserver[1]
+                  }
+                end
+                xml.tech contact
+              }
+            }
+            xml.clTRID UUIDTools::UUID.timestamp_create.to_s
+          }
+        end
+        
+        NssetCreateResponse.new(send_request(builder.to_xml))
+      end
+      
+      # Delete nameserver object. Can only be deleted if object does not have relations to other objects.
+      def delete_nsset(nsset)
+        builder = build_epp_request do |xml|
+          xml.command {
+            xml.delete {
+              xml.delete('xmlns:nsset' => XML_NS_NSSET, 'xsi:schemaLocation' => XML_SCHEMALOC) {
+                xml.parent.namespace = xml.parent.namespace_definitions.first
+                xml.id_ nsset
+              }
+            }
+            xml.clTRID UUIDTools::UUID.timestamp_create.to_s
+          }
+        end
+        
+        NssetDeleteResponse.new(send_request(builder.to_xml))
+      end
+      
+      # Returns intormation about existing nameserver object.
+      def info_nsset(nsset)
+        builder = build_epp_request do |xml|
+          xml.command {
+            xml.info {
+              xml.info('xmlns:nsset' => XML_NS_NSSET, 'xsi:schemaLocation' => XML_SCHEMALOC) {
+                xml.parent.namespace = xml.parent.namespace_definitions.first
+                xml.id_ nsset
+              }
+            }
+            xml.clTRID UUIDTools::UUID.timestamp_create.to_s
+          }
+        end
+        
+        NssetInfoResponse.new(send_request(builder.to_xml))
+      end
+      
+      def list_nssets
+        list_command('listNssets')
+      end
+      
+      # Updates nameserver object. Update has been divided into three sections. Depending on the section that is used,
+      # update can add, remove and/or change data all at once.
+      def update_nsset(nsset, add_nameservers, add_contact, rem_nameserver, rem_contact)
+        builder = build_epp_request do |xml|
+          xml.command {
+            xml.update {
+              xml.update('xmlns:nsset' => XML_NS_NSSET, 'xsi:schemaLocation' => XML_SCHEMALOC) {
+                xml.parent.namespace = xml.parent.namespace_definitions.first
+                xml.id_ nsset
+                if add_nameservers or add_contact
+                  xml.add {
+                    add_nameservers.each do |nameserver|
+                      xml.ns {
+                        xml.name nameserver[0]
+                        xml.addr nameserver[1]
+                      }
+                    end if add_nameservers
+                    xml.tech add_contact if add_contact
+                  }
+                end
+                if rem_nameserver or rem_contact
+                  xml.rem {
+                    xml.name rem_nameserver
+                    xml.tech rem_contact
+                  }
+                end
+              }
+            }
+            xml.clTRID UUIDTools::UUID.timestamp_create.to_s
+          }
+        end
+        
+        NssetUpdateResponse.new(send_request(builder.to_xml))
+      end
+    end
+  end
+end
+
+Epp::Server.send(:include, Epp::Eis::NssetCommands)