epp-ruby 3.0.0

data/lib/epp-client.rb

@@ -0,0 +1,103 @@
+require 'openssl'
+require 'socket'
+require 'time'
+require 'xml'
+
+require File.expand_path('../epp-client/version', __FILE__)
+
+# EPP Module
+module EPP
+  # Generic error class for all EPP errors
+  class Error < RuntimeError; end
+end
+
+require File.expand_path('../epp-client/xml_helper.rb',     __FILE__)
+require File.expand_path('../epp-client/response_helper.rb',                     __FILE__)
+
+module EPP
+  autoload :OldServer, File.expand_path('../epp-client/old_server.rb',    __FILE__)
+
+  module Requests
+    autoload :Hello,     File.expand_path('../epp-client/requests/hello.rb',     __FILE__)
+    autoload :Command,   File.expand_path('../epp-client/requests/command.rb',   __FILE__)
+    autoload :Extension, File.expand_path('../epp-client/requests/extension.rb', __FILE__)
+  end
+
+  module Commands
+    autoload :TransferHandshake,    File.expand_path('../epp-client/commands/transfer_handshake.rb',    __FILE__)
+    autoload :Check,    File.expand_path('../epp-client/commands/check.rb',    __FILE__)
+    autoload :Create,   File.expand_path('../epp-client/commands/create.rb',   __FILE__)
+    autoload :Delete,   File.expand_path('../epp-client/commands/delete.rb',   __FILE__)
+    autoload :Info,     File.expand_path('../epp-client/commands/info.rb',     __FILE__)
+    autoload :Login,    File.expand_path('../epp-client/commands/login.rb',    __FILE__)
+    autoload :Logout,   File.expand_path('../epp-client/commands/logout.rb',   __FILE__)
+    autoload :Poll,     File.expand_path('../epp-client/commands/poll.rb',     __FILE__)
+    autoload :Renew,    File.expand_path('../epp-client/commands/renew.rb',    __FILE__)
+    autoload :Transfer, File.expand_path('../epp-client/commands/transfer.rb', __FILE__)
+    autoload :Update,   File.expand_path('../epp-client/commands/update.rb',   __FILE__)
+  end
+
+  module Domain
+    NAMESPACE       = 'urn:ietf:params:xml:ns:domain-1.0'
+    SCHEMA_LOCATION = 'urn:ietf:params:xml:ns:domain-1.0 domain-1.0.xsd'
+
+    autoload :Check,    File.expand_path('../epp-client/domain/check.rb',     __FILE__)
+    autoload :Create,   File.expand_path('../epp-client/domain/create.rb',    __FILE__)
+    autoload :Delete,   File.expand_path('../epp-client/domain/delete.rb',    __FILE__)
+    autoload :Info,     File.expand_path('../epp-client/domain/info.rb',      __FILE__)
+    autoload :Renew,    File.expand_path('../epp-client/domain/renew.rb',     __FILE__)
+    autoload :Transfer, File.expand_path('../epp-client/domain/transfer.rb',  __FILE__)
+    autoload :Update,   File.expand_path('../epp-client/domain/update.rb',    __FILE__)
+    autoload :List,   File.expand_path('../epp-client/domain/list.rb',    __FILE__)
+
+    autoload :CheckResponse,    File.expand_path('../epp-client/domain/check_response.rb',     __FILE__)
+    autoload :CreateResponse,   File.expand_path('../epp-client/domain/create_response.rb',    __FILE__)
+    autoload :DeleteResponse,   File.expand_path('../epp-client/domain/delete_response.rb',    __FILE__)
+    autoload :InfoResponse,     File.expand_path('../epp-client/domain/info_response.rb',      __FILE__)
+    autoload :RenewResponse,    File.expand_path('../epp-client/domain/renew_response.rb',     __FILE__)
+    autoload :TransferResponse, File.expand_path('../epp-client/domain/transfer_response.rb',  __FILE__)
+    autoload :UpdateResponse,   File.expand_path('../epp-client/domain/update_response.rb',    __FILE__)
+  end
+
+  module Contact
+    NAMESPACE       = 'urn:ietf:params:xml:ns:contact-1.0'
+    SCHEMA_LOCATION = 'urn:ietf:params:xml:ns:contact-1.0 contact-1.0.xsd'
+
+    autoload :Check,    File.expand_path('../epp-client/contact/check.rb',     __FILE__)
+    autoload :Create,   File.expand_path('../epp-client/contact/create.rb',    __FILE__)
+    autoload :Delete,   File.expand_path('../epp-client/contact/delete.rb',    __FILE__)
+    autoload :Info,     File.expand_path('../epp-client/contact/info.rb',      __FILE__)
+    autoload :Transfer, File.expand_path('../epp-client/contact/transfer.rb',  __FILE__)
+    autoload :Update,   File.expand_path('../epp-client/contact/update.rb',    __FILE__)
+
+    autoload :CheckResponse,    File.expand_path('../epp-client/contact/check_response.rb',     __FILE__)
+    autoload :CreateResponse,   File.expand_path('../epp-client/contact/create_response.rb',    __FILE__)
+    autoload :DeleteResponse,   File.expand_path('../epp-client/contact/delete_response.rb',    __FILE__)
+    autoload :InfoResponse,     File.expand_path('../epp-client/contact/info_response.rb',      __FILE__)
+    autoload :TransferResponse, File.expand_path('../epp-client/contact/transfer_response.rb',  __FILE__)
+    autoload :UpdateResponse,   File.expand_path('../epp-client/contact/update_response.rb',    __FILE__)
+  end
+
+  module Host
+    NAMESPACE       = 'urn:ietf:params:xml:ns:host-1.0'
+    SCHEMA_LOCATION = 'urn:ietf:params:xml:ns:host-1.0 host-1.0.xsd'
+
+    autoload :Check,    File.expand_path('../epp-client/host/check.rb',     __FILE__)
+    autoload :Create,   File.expand_path('../epp-client/host/create.rb',    __FILE__)
+    autoload :Delete,   File.expand_path('../epp-client/host/delete.rb',    __FILE__)
+    autoload :Info,     File.expand_path('../epp-client/host/info.rb',      __FILE__)
+    autoload :Update,   File.expand_path('../epp-client/host/update.rb',    __FILE__)
+
+    autoload :CheckResponse,    File.expand_path('../epp-client/host/check_response.rb',     __FILE__)
+    autoload :CreateResponse,   File.expand_path('../epp-client/host/create_response.rb',    __FILE__)
+    autoload :DeleteResponse,   File.expand_path('../epp-client/host/delete_response.rb',    __FILE__)
+    autoload :InfoResponse,     File.expand_path('../epp-client/host/info_response.rb',      __FILE__)
+    autoload :UpdateResponse,   File.expand_path('../epp-client/host/update_response.rb',    __FILE__)
+  end
+end
+
+require File.expand_path('../epp-client/client',            __FILE__)
+require File.expand_path('../epp-client/server.rb',         __FILE__)
+require File.expand_path('../epp-client/request.rb',        __FILE__)
+require File.expand_path('../epp-client/response.rb',       __FILE__)
+require File.expand_path('../epp-client/response_error.rb', __FILE__)

data/lib/epp-ruby.rb

@@ -0,0 +1 @@
+require File.expand_path('../epp-client', __FILE__)

data/test/commands/test_check_command.rb

@@ -0,0 +1,33 @@
+require 'helper'
+
+class TestEppCheckCommand < Test::Unit::TestCase
+  context 'EPP::Commands::Check' do
+    setup do
+      @domain_check = EPP::Domain::Check.new('example.com', 'example.net')
+
+      @check   = EPP::Commands::Check.new(@domain_check)
+      @command = EPP::Requests::Command.new('ABC-123', @check)
+      @request = EPP::Request.new(@command)
+      @xml     = @request.to_xml
+
+      namespaces_from_request
+    end
+
+    should 'validate against schema' do
+      assert @xml.validate_schema(schema)
+    end
+
+    should 'set clTRID' do
+      assert_equal 'ABC-123', xpath_find('//epp:clTRID')
+    end
+
+    should 'set names' do
+      names = []
+      xpath_each('//domain:name') do |node|
+        names << node.content.strip
+      end
+
+      assert_equal %w(example.com example.net), names
+    end
+  end
+end

data/test/commands/test_create_command.rb

@@ -0,0 +1,53 @@
+require 'helper'
+
+class TestEppCreateCommand < Test::Unit::TestCase
+  context 'EPP::Commands::Create' do
+    setup do
+      @domain_create = EPP::Domain::Create.new('example.com',
+        :period => '2y', :registrant => 'UK-2349723',
+        :nameservers => %w(ns1.test.host ns2.test.host),
+        :auth_info => {:pw => '2381728348'})
+
+      @create  = EPP::Commands::Create.new(@domain_create)
+      @command = EPP::Requests::Command.new('ABC-123', @create)
+      @request = EPP::Request.new(@command)
+      @xml     = @request.to_xml
+
+      namespaces_from_request
+    end
+
+    should 'validate against schema' do
+      assert @xml.validate_schema(schema)
+    end
+
+    should 'set clTRID' do
+      assert_equal 'ABC-123', xpath_find('//epp:clTRID')
+    end
+
+    should 'set example.com as name' do
+      assert_equal 'example.com', xpath_find('//domain:name')
+    end
+
+    should 'set period' do
+      assert_equal '2', xpath_find('//domain:period')
+      assert_equal 'y', xpath_find('//domain:period/@unit')
+    end
+
+    should 'set registrant' do
+      assert_equal 'UK-2349723', xpath_find('//domain:registrant')
+    end
+
+    should 'set nameservers' do
+      nameservers = []
+      xpath_each('//domain:ns/domain:hostObj') do |node|
+        nameservers << node.content.strip
+      end
+
+      assert_equal %w(ns1.test.host ns2.test.host), nameservers
+    end
+
+    should 'set authInfo' do
+      assert_equal '2381728348', xpath_find('//domain:authInfo/domain:pw')
+    end
+  end
+end

data/test/commands/test_delete_command.rb

@@ -0,0 +1,28 @@
+require 'helper'
+
+class TestEppDeleteCommand < Test::Unit::TestCase
+  context 'EPP::Commands::Delete' do
+    setup do
+      @domain_delete = EPP::Domain::Delete.new('example.com')
+
+      @delete  = EPP::Commands::Delete.new(@domain_delete)
+      @command = EPP::Requests::Command.new('ABC-123', @delete)
+      @request = EPP::Request.new(@command)
+      @xml     = @request.to_xml
+
+      namespaces_from_request
+    end
+
+    should 'validate against schema' do
+      assert @xml.validate_schema(schema)
+    end
+
+    should 'set clTRID' do
+      assert_equal 'ABC-123', xpath_find('//epp:clTRID')
+    end
+
+    should 'set example.com as name' do
+      assert_equal 'example.com', xpath_find('//domain:name')
+    end
+  end
+end

data/test/commands/test_info_command.rb

@@ -0,0 +1,28 @@
+require 'helper'
+
+class TestEppInfoCommand < Test::Unit::TestCase
+  context 'EPP::Commands::Info' do
+    setup do
+      @domain_info = EPP::Domain::Info.new('example.com')
+
+      @info    = EPP::Commands::Info.new(@domain_info)
+      @command = EPP::Requests::Command.new('ABC-123', @info)
+      @request = EPP::Request.new(@command)
+      @xml     = @request.to_xml
+
+      namespaces_from_request
+    end
+
+    should 'validate against schema' do
+      assert @xml.validate_schema(schema)
+    end
+
+    should 'set clTRID' do
+      assert_equal 'ABC-123', xpath_find('//epp:clTRID')
+    end
+
+    should 'set example.com as name' do
+      assert_equal 'example.com', xpath_find('//domain:name')
+    end
+  end
+end

data/test/commands/test_login_command.rb

@@ -0,0 +1,56 @@
+require 'helper'
+
+class TestEppLoginCommand < Test::Unit::TestCase
+  context 'EPP::Commands::Login' do
+    setup do
+      @options = {:lang => 'en', :version => '1.0',
+        :services => EPP::Client::DEFAULT_SERVICES,
+        :extensions => ['http://www.nominet.org.uk/epp/xml/domain-nom-ext-1.2']}
+
+      @login   = EPP::Commands::Login.new('TEST', 'testing', @options)
+      @command = EPP::Requests::Command.new('ABC-123', @login)
+      @request = EPP::Request.new(@command)
+
+      @xml = @request.to_xml
+
+      namespaces_from_request
+    end
+
+    should 'validate against schema' do
+      assert @xml.validate_schema(schema)
+    end
+
+    should 'set clTRID' do
+      assert_equal 'ABC-123', xpath_find('//epp:clTRID')
+    end
+
+    should 'set TEST as clID' do
+      assert_equal 'TEST', xpath_find('//epp:clID')
+    end
+    should 'set testing as pw' do
+      assert_equal 'testing', xpath_find('//epp:pw')
+    end
+    should 'set 1.0 as version' do
+      assert_equal '1.0', xpath_find('//epp:version')
+    end
+    should 'set en as lang' do
+      assert_equal 'en', xpath_find('//epp:lang')
+    end
+    should 'set services' do
+      services = []
+      xpath_each('//epp:svcs/epp:objURI') do |node|
+        services << node.content
+      end
+
+      assert_equal services, @options[:services]
+    end
+    should 'set service extensions' do
+      extensions = []
+      xpath_each('//epp:svcs/epp:svcExtension/epp:extURI') do |node|
+        extensions << node.content
+      end
+
+      assert_equal extensions, @options[:extensions]
+    end
+  end
+end

data/test/commands/test_logout_command.rb

@@ -0,0 +1,22 @@
+require 'helper'
+
+class TestEppLogoutCommand < Test::Unit::TestCase
+  context 'EPP::LogoutCommand' do
+    setup do
+      @logout  = EPP::Commands::Logout.new
+      @command = EPP::Requests::Command.new('ABC-123', @logout)
+      @request = EPP::Request.new(@command)
+      @xml     = @request.to_xml
+
+      namespaces_from_request
+    end
+
+    should 'validate against schema' do
+      assert @xml.validate_schema(schema)
+    end
+
+    should 'set clTRID' do
+      assert_equal 'ABC-123', xpath_find('//epp:clTRID')
+    end
+  end
+end

data/test/commands/test_poll_command.rb

@@ -0,0 +1,54 @@
+require 'helper'
+
+class TestEppPollCommand < Test::Unit::TestCase
+  context 'EPP::Commands::Poll' do
+    context 'poll' do
+      setup do
+        @poll    = EPP::Commands::Poll.new
+        @command = EPP::Requests::Command.new('ABC-123', @poll)
+        @request = EPP::Request.new(@command)
+        @xml     = @request.to_xml
+
+        namespaces_from_request
+      end
+
+      should 'validate against schema' do
+        assert @xml.validate_schema(schema)
+      end
+
+      should 'set clTRID' do
+        assert_equal 'ABC-123', xpath_find('//epp:clTRID')
+      end
+
+      should 'set op mode req' do
+        assert_equal 'req', xpath_find('//epp:poll/@op')
+      end
+    end
+    context 'ack' do
+      setup do
+        @poll    = EPP::Commands::Poll.new('234629834')
+        @command = EPP::Requests::Command.new('ABC-123', @poll)
+        @request = EPP::Request.new(@command)
+        @xml     = @request.to_xml
+
+        namespaces_from_request
+      end
+
+      should 'validate against schema' do
+        assert @xml.validate_schema(schema)
+      end
+
+      should 'set clTRID' do
+        assert_equal 'ABC-123', xpath_find('//epp:clTRID')
+      end
+
+      should 'set op mode ack' do
+        assert_equal 'ack', xpath_find('//epp:poll/@op')
+      end
+
+      should 'set msgID' do
+        assert_equal '234629834', xpath_find('//epp:poll/@msgID')
+      end
+    end
+  end
+end

data/test/commands/test_renew_command.rb

@@ -0,0 +1,39 @@
+require 'helper'
+
+class TestEppRenewCommand < Test::Unit::TestCase
+  context 'EPP::Commands::Renew' do
+    setup do
+      @time = Time.now
+      @domain_renew = EPP::Domain::Renew.new('example.com', @time, '12m')
+
+      @renew   = EPP::Commands::Renew.new(@domain_renew)
+      @command = EPP::Requests::Command.new('ABC-123', @renew)
+      @request = EPP::Request.new(@command)
+      @xml     = @request.to_xml
+
+      namespaces_from_request
+    end
+
+    should 'validate against schema' do
+      assert @xml.validate_schema(schema)
+    end
+
+    should 'set clTRID' do
+      assert_equal 'ABC-123', xpath_find('//epp:clTRID')
+    end
+
+    should 'set example.com as name' do
+      assert_equal 'example.com', xpath_find('//domain:name')
+    end
+
+    should 'set date as curExpDate' do
+      date = @time.strftime('%Y-%m-%d')
+      assert_equal date, xpath_find('//domain:curExpDate')
+    end
+
+    should 'set period' do
+      assert_equal '12', xpath_find('//domain:period')
+      assert_equal 'm', xpath_find('//domain:period/@unit')
+    end
+  end
+end

data/test/commands/test_transfer_command.rb

@@ -0,0 +1,37 @@
+require 'helper'
+
+class TestEppTransferCommand < Test::Unit::TestCase
+  context 'EPP::Commands::Transfer' do
+    setup do
+      @domain_transfer = EPP::Domain::Transfer.new('example.com', '12m', :pw => '2381728348')
+
+      @transfer = EPP::Commands::Transfer.new('query', @domain_transfer)
+      @command = EPP::Requests::Command.new('ABC-123', @transfer)
+      @request = EPP::Request.new(@command)
+      @xml     = @request.to_xml
+
+      namespaces_from_request
+    end
+
+    should 'validate against schema' do
+      assert @xml.validate_schema(schema)
+    end
+
+    should 'set clTRID' do
+      assert_equal 'ABC-123', xpath_find('//epp:clTRID')
+    end
+
+    should 'set example.com as name' do
+      assert_equal 'example.com', xpath_find('//domain:name')
+    end
+
+    should 'set period' do
+      assert_equal '12', xpath_find('//domain:period')
+      assert_equal 'm', xpath_find('//domain:period/@unit')
+    end
+
+    should 'set authInfo' do
+      assert_equal '2381728348', xpath_find('//domain:authInfo/domain:pw')
+    end
+  end
+end

data/test/commands/test_update_command.rb

@@ -0,0 +1,60 @@
+require 'helper'
+
+class TestEppUpdateCommand < Test::Unit::TestCase
+  context 'EPP::Commands::Update' do
+    setup do
+      @domain_update = EPP::Domain::Update.new('example.com',
+        :add => {:ns => %w(ns1.test.host ns2.test.host)},
+        :rem => {:ns => %w(ns3.test.host ns4.test.host)},
+        :chg => {
+          :registrant => 'UK-2349723',
+          :auth_info => {:pw => '2381728348'}
+        })
+
+      @update  = EPP::Commands::Update.new(@domain_update)
+      @command = EPP::Requests::Command.new('ABC-123', @update)
+      @request = EPP::Request.new(@command)
+      @xml     = @request.to_xml
+
+      namespaces_from_request
+    end
+
+    should 'validate against schema' do
+      assert @xml.validate_schema(schema)
+    end
+
+    should 'set clTRID' do
+      assert_equal 'ABC-123', xpath_find('//epp:clTRID')
+    end
+
+    should 'set example.com as name' do
+      assert_equal 'example.com', xpath_find('//domain:name')
+    end
+
+    should 'add nameservers' do
+      nameservers = []
+      xpath_each('//domain:add/domain:ns/domain:hostObj') do |node|
+        nameservers << node.content.strip
+      end
+
+      assert_equal %w(ns1.test.host ns2.test.host), nameservers
+    end
+
+    should 'remove nameservers' do
+      nameservers = []
+      xpath_each('//domain:rem/domain:ns/domain:hostObj') do |node|
+        nameservers << node.content.strip
+      end
+
+      assert_equal %w(ns3.test.host ns4.test.host), nameservers
+    end
+
+    should 'set registant for change' do
+      assert_equal 'UK-2349723', xpath_find('//domain:chg/domain:registrant')
+    end
+
+    should 'set authInfo for change' do
+      assert_equal '2381728348', xpath_find('//domain:chg/domain:authInfo/domain:pw')
+    end
+  end
+end

data/test/contact/test_contact_check.rb

@@ -0,0 +1,33 @@
+require 'helper'
+
+class TestEppContactCheckCommand < Test::Unit::TestCase
+  context 'EPP::Contact::Check' do
+    setup do
+      @contact_check = EPP::Contact::Check.new('UK-39246923864', 'UK-23489239')
+
+      @check   = EPP::Commands::Check.new(@contact_check)
+      @command = EPP::Requests::Command.new('ABC-123', @check)
+      @request = EPP::Request.new(@command)
+      @xml     = @request.to_xml
+
+      namespaces_from_request
+    end
+
+    should 'validate against schema' do
+      assert @xml.validate_schema(schema)
+    end
+
+    should 'set clTRID' do
+      assert_equal 'ABC-123', xpath_find('//epp:clTRID')
+    end
+
+    should 'set ids' do
+      ids = []
+      xpath_each('//contact:id') do |node|
+        ids << node.content.strip
+      end
+
+      assert_equal %w(UK-39246923864 UK-23489239), ids
+    end
+  end
+end

data/test/contact/test_contact_check_response.rb

@@ -0,0 +1,88 @@
+require 'helper'
+
+class TestEppContactCheckResponse < Test::Unit::TestCase
+  context 'EPP::Contact::CheckResponse' do
+    setup do
+      @response = EPP::Response.new(load_xml('contact/check'))
+      @check_response = EPP::Contact::CheckResponse.new(@response)
+    end
+
+    should 'proxy methods to @response' do
+      assert_equal @response.message, @check_response.message
+    end
+
+    should 'be successful' do
+      assert @check_response.success?
+      assert_equal 1000, @check_response.code
+    end
+
+    should 'have message' do
+      assert_equal 'Command completed successfully', @check_response.message
+    end
+
+    should 'have ids' do
+      expected = ['sh8013', 'sah8013', '8013sah'].sort
+      assert_equal expected, @check_response.ids.sort
+    end
+
+    should 'have count' do
+      assert_equal 3, @check_response.count
+    end
+
+    should 'list sh8013 as available' do
+      assert @check_response.available?('sh8013')
+      assert !@check_response.unavailable?('sh8013')
+    end
+
+    should 'list sah8013 as unavailable' do
+      assert @check_response.unavailable?('sah8013')
+      assert !@check_response.available?('sah8013')
+    end
+
+    should 'list 8013sah as available' do
+      assert @check_response.available?('8013sah')
+      assert !@check_response.unavailable?('8013sah')
+    end
+
+    should 'raise ArgumentError if available with no argument for count > 1' do
+      assert_raise ArgumentError do
+        @check_response.available?
+      end
+    end
+
+    should 'raise RuntimeError if id called with count > 1' do
+      assert_raise RuntimeError do
+        @check_response.id
+      end
+    end
+  end
+
+  context 'EPP::Contact::CheckResponse Single Query' do
+    setup do
+      @response = EPP::Response.new(load_xml('contact/check-single'))
+      @check_response = EPP::Contact::CheckResponse.new(@response)
+    end
+
+    should 'have names' do
+      assert_equal ['sh8013'], @check_response.ids
+    end
+
+    should 'have name' do
+      assert_equal 'sh8013', @check_response.id
+    end
+
+    should 'have count' do
+      assert_equal 1, @check_response.count
+    end
+
+    should 'list sh8013 as available' do
+      assert @check_response.available?('sh8013')
+      assert !@check_response.unavailable?('sh8013')
+    end
+
+    should 'be available? with no argument' do
+      assert @check_response.available?
+      assert !@check_response.unavailable?
+    end
+  end
+end