nominet-epp 0.0.12 → 1.0.0

data/lib/nominet-epp.rb

@@ -1,172 +1,71 @@
 require 'epp-client'
 require 'time'
 
+require File.dirname(__FILE__) + '/nominet-epp/version'
 require File.dirname(__FILE__) + '/nominet-epp/operations'
 require File.dirname(__FILE__) + '/nominet-epp/helpers'
 
+require File.dirname(__FILE__) + '/nominet-epp/client'
+require File.dirname(__FILE__) + '/nominet-epp/request'
+require File.dirname(__FILE__) + '/nominet-epp/notification'
+
+require File.dirname(__FILE__) + '/nominet-epp/requests/custom/list'
+require File.dirname(__FILE__) + '/nominet-epp/requests/custom/handshake'
+require File.dirname(__FILE__) + '/nominet-epp/requests/custom/tag_list'
+
+require File.dirname(__FILE__) + '/nominet-epp/requests/domain/check'
+require File.dirname(__FILE__) + '/nominet-epp/requests/domain/create'
+require File.dirname(__FILE__) + '/nominet-epp/requests/domain/delete'
+require File.dirname(__FILE__) + '/nominet-epp/requests/domain/info'
+require File.dirname(__FILE__) + '/nominet-epp/requests/domain/release'
+require File.dirname(__FILE__) + '/nominet-epp/requests/domain/renew'
+require File.dirname(__FILE__) + '/nominet-epp/requests/domain/unrenew'
+require File.dirname(__FILE__) + '/nominet-epp/requests/domain/update'
+
+require File.dirname(__FILE__) + '/nominet-epp/requests/contact/check'
+require File.dirname(__FILE__) + '/nominet-epp/requests/contact/create'
+require File.dirname(__FILE__) + '/nominet-epp/requests/contact/delete'
+require File.dirname(__FILE__) + '/nominet-epp/requests/contact/info'
+require File.dirname(__FILE__) + '/nominet-epp/requests/contact/release'
+require File.dirname(__FILE__) + '/nominet-epp/requests/contact/update'
+
+require File.dirname(__FILE__) + '/nominet-epp/requests/host/check'
+require File.dirname(__FILE__) + '/nominet-epp/requests/host/create'
+require File.dirname(__FILE__) + '/nominet-epp/requests/host/delete'
+require File.dirname(__FILE__) + '/nominet-epp/requests/host/info'
+require File.dirname(__FILE__) + '/nominet-epp/requests/host/update'
+
+require File.dirname(__FILE__) + '/nominet-epp/responses/response'
+
+require File.dirname(__FILE__) + '/nominet-epp/responses/custom/list_response'
+require File.dirname(__FILE__) + '/nominet-epp/responses/custom/handshake_response'
+require File.dirname(__FILE__) + '/nominet-epp/responses/custom/tag_list_response'
+
+require File.dirname(__FILE__) + '/nominet-epp/responses/domain/check_response'
+require File.dirname(__FILE__) + '/nominet-epp/responses/domain/create_response'
+require File.dirname(__FILE__) + '/nominet-epp/responses/domain/delete_response'
+require File.dirname(__FILE__) + '/nominet-epp/responses/domain/info_response'
+require File.dirname(__FILE__) + '/nominet-epp/responses/domain/release_response'
+require File.dirname(__FILE__) + '/nominet-epp/responses/domain/renew_response'
+require File.dirname(__FILE__) + '/nominet-epp/responses/domain/unrenew_response'
+require File.dirname(__FILE__) + '/nominet-epp/responses/domain/update_response'
+
+require File.dirname(__FILE__) + '/nominet-epp/responses/contact/check_response'
+require File.dirname(__FILE__) + '/nominet-epp/responses/contact/create_response'
+require File.dirname(__FILE__) + '/nominet-epp/responses/contact/delete_response'
+require File.dirname(__FILE__) + '/nominet-epp/responses/contact/info_response'
+require File.dirname(__FILE__) + '/nominet-epp/responses/contact/release_response'
+require File.dirname(__FILE__) + '/nominet-epp/responses/contact/update_response'
+
+require File.dirname(__FILE__) + '/nominet-epp/responses/host/check_response'
+require File.dirname(__FILE__) + '/nominet-epp/responses/host/create_response'
+require File.dirname(__FILE__) + '/nominet-epp/responses/host/delete_response'
+require File.dirname(__FILE__) + '/nominet-epp/responses/host/info_response'
+require File.dirname(__FILE__) + '/nominet-epp/responses/host/update_response'
+
 # Nominet EPP Module
 module NominetEPP
-  # Front end interface Client to the NominetEPP Service
-  class Client
-    # Default Nominet Service URNs
-    DEFAULT_SERVICES = %w(http://www.nominet.org.uk/epp/xml/nom-domain-2.0
-      http://www.nominet.org.uk/epp/xml/nom-notifications-2.0
-      urn:ietf:params:xml:ns:host-1.0)
-
-    # Create a new instance of NominetEPP::Client
-    #
-    # @param [String] tag Nominet TAG
-    # @param [String] passwd Nominet TAG EPP Password
-    # @param [String] server Nominet EPP Server address
-    def initialize(tag, passwd, server = 'epp.nominet.org.uk')
-      @tag, @server = tag, server
-      @client = EPP::Client.new(tag, passwd, server, :services => DEFAULT_SERVICES)
-    end
-
-    # @see Object#inspect
-    def inspect
-      "#<#{self.class} #{@tag}@#{@server}>"
-    end
-
-    # Returns the last EPP::Response received
-    #
-    # @return [EPP::Response] last received response
-    def last_response
-      @resp
-    end
-
-    # Returns the last EPP message received
-    #
-    # @return [String] last EPP message
-    # @see #last_response
-    def last_message
-      last_response.message
-    end
-
-    # Returns the last Nominet failData response found
-    #
-    # @note This is presently only set by certain method calls,
-    #       so it may not always be present.
-    # @return [Hash] last failData found
-    def last_error_info
-      @error_info
-    end
-
-    # @return [Hash] Nominet Namespaces by prefixes
-    def namespaces
-      { :domain  => 'http://www.nominet.org.uk/epp/xml/nom-domain-2.0',
-        :account => 'http://www.nominet.org.uk/epp/xml/nom-account-2.0',
-        :contact => 'http://www.nominet.org.uk/epp/xml/nom-contact-2.0',
-        :tag     => 'http://www.nominet.org.uk/epp/xml/nom-tag-1.0',
-        :n       => 'http://www.nominet.org.uk/epp/xml/nom-notifications-2.0',
-        :host    => 'urn:ietf:params:xml:ns:host-1.0' }
-    end
-
-    # @return [Hash] Nominet Schema Locations by prefix
-    def schemaLocations
-      { :domain  => 'http://www.nominet.org.uk/epp/xml/nom-domain-2.0 nom-domain-2.0.xsd',
-        :account => 'http://www.nominet.org.uk/epp/xml/nom-account-2.0 nom-account-2.0.xsd',
-        :contact => 'http://www.nominet.org.uk/epp/xml/nom-contact-2.0 nom-contact-1.0.xsd',
-        :tag     => 'http://www.nominet.org.uk/epp/xml/nom-tag-1.0 nom-tag-1.0.xsd',
-        :n       => 'http://www.nominet.org.uk/epp/xml/nom-notifications-2.0  nom-notifications-2.0.xsd' }
-    end
-
-    include Helpers
-
-    include Operations::Check
-    include Operations::Create
-    include Operations::Delete
-    include Operations::Fork
-    include Operations::Hello
-    include Operations::Info
-    include Operations::List
-    include Operations::Lock
-    include Operations::Merge
-    include Operations::Poll
-    include Operations::Renew
-    include Operations::Transfer
-    include Operations::Unlock
-    include Operations::Unrenew
-    include Operations::Update
-
-    private
-      # @param [XML::Node] node XML Node to find the value from
-      # @param [String] xpath XPath Expression for the value
-      # @return [String] node value
-      def node_value(node, xpath)
-        n = node.find(xpath, namespaces).first
-        n && n.content.strip
-      end
-
-      # @param [String] name XML Element name
-      # @param [Symbol] ns_prefix Namespace Prefix
-      # @yield [node, ns] block to populate node
-      # @yieldparam [XML::Node] node XML Node to populate
-      # @yieldparam [XML::Namespace] ns XML Namespace of the node
-      # @return [XML::Node] newly created node
-      def new_node(name, ns_prefix, &block)
-        node = XML::Node.new(name)
-        node.namespaces.namespace = ns = XML::Namespace.new(node, ns_prefix.to_s, namespaces[ns_prefix])
-        node['xsi:schemaLocation'] = schemaLocations[ns_prefix] if schemaLocations.has_key?(ns_prefix)
-
-        case block.arity
-        when 0
-          yield
-        when 1
-          yield node
-        when 2
-          yield node, ns
-        end
-
-        node
-      end
-
-      # @param [String] node_name XML Element name
-      # @yield [node, ns] block to populate node
-      # @return [XML::Node] new node in :domain namespace
-      # @see new_node
-      def domain(node_name, &block)
-        new_node(node_name, :domain, &block)
-      end
-
-      # @param [String] node_name XML Element name
-      # @yield [node, ns] block to populate node
-      # @return [XML::Node] new node in :account namespace
-      # @see new_node
-      def account(node_name, &block)
-        new_node(node_name, :account, &block)
-      end
-
-      # @param [String] node_name XML Element name
-      # @yield [node, ns] block to populate node
-      # @return [XML::Node] new node in :contact namespace
-      # @see new_node
-      def contact(node_name, &block)
-        new_node(node_name, :contact, &block)
-      end
-
-      # @param [String] node_name XML Element name
-      # @yield [node, ns] block to populate node
-      # @return [XML::Node] new node in :tag namespace
-      # @see new_node
-      def tag(node_name, &block)
-        new_node(node_name, :tag, &block)
-      end
 
-      # @param [String] node_name XML Element name
-      # @yield [node, ns] block to populate node
-      # @return [XML::Node] new node in :notification namespace
-      # @see new_node
-      def notification(node_name, &block)
-        new_node(node_name, :n, &block)
-      end
+  autoload :LogSubscriber, File.expand_path('../nominet-epp/log_subscriber.rb', __FILE__)
 
-      # @param [String] node_name XML Element name
-      # @yield [node, ns] block to populate node
-      # @return [XML::Node] new node in :host namespace
-      # @see new_node
-      def host(node_name, &block)
-        new_node(node_name, :host, &block)
-      end
-  end
 end

data/nominet-epp.gemspec

@@ -1,71 +1,21 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+require File.expand_path('../lib/nominet-epp/version', __FILE__)
 
-Gem::Specification.new do |s|
-  s.name = %q{nominet-epp}
-  s.version = "0.0.12"
+Gem::Specification.new do |gem|
+  gem.authors       = ["Geoff Garside"]
+  gem.email         = ["geoff@geoffgarside.co.uk"]
+  gem.description   = %q{Client for communicating with the Nominet EPP}
+  gem.summary       = %q{Nominet EPP (Extensible Provisioning Protocol) Client}
+  gem.homepage      = "https://github.com/m247/nominet-epp"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Geoff Garside"]
-  s.date = %q{2011-05-24}
-  s.description = %q{Client for communicating with the Nominet EPP}
-  s.email = %q{geoff@geoffgarside.co.uk}
-  s.extra_rdoc_files = [
-    "LICENSE",
-    "README.rdoc"
-  ]
-  s.files = [
-    ".yardopts",
-    "History.rdoc",
-    "LICENSE",
-    "README.rdoc",
-    "Rakefile",
-    "VERSION",
-    "lib/nominet-epp.rb",
-    "lib/nominet-epp/helpers.rb",
-    "lib/nominet-epp/operations.rb",
-    "lib/nominet-epp/operations/check.rb",
-    "lib/nominet-epp/operations/create.rb",
-    "lib/nominet-epp/operations/delete.rb",
-    "lib/nominet-epp/operations/fork.rb",
-    "lib/nominet-epp/operations/hello.rb",
-    "lib/nominet-epp/operations/info.rb",
-    "lib/nominet-epp/operations/list.rb",
-    "lib/nominet-epp/operations/lock.rb",
-    "lib/nominet-epp/operations/merge.rb",
-    "lib/nominet-epp/operations/poll.rb",
-    "lib/nominet-epp/operations/renew.rb",
-    "lib/nominet-epp/operations/transfer.rb",
-    "lib/nominet-epp/operations/unlock.rb",
-    "lib/nominet-epp/operations/unrenew.rb",
-    "lib/nominet-epp/operations/update.rb",
-    "nominet-epp.gemspec",
-    "test/helper.rb",
-    "test/test_nominet-epp.rb"
-  ]
-  s.homepage = %q{http://github.com/geoffgarside/nominet-epp}
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.7.2}
-  s.summary = %q{Nominet EPP (Extensible Provisioning Protocol) Client}
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "nominet-epp"
+  gem.require_paths = ["lib"]
+  gem.version       = NominetEPP::VERSION
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
+  gem.extra_rdoc_files = %w(LICENSE README.md HISTORY.md)
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<shoulda>, [">= 0"])
-      s.add_development_dependency(%q<yard>, [">= 0"])
-      s.add_runtime_dependency(%q<epp-client>, [">= 0"])
-    else
-      s.add_dependency(%q<shoulda>, [">= 0"])
-      s.add_dependency(%q<yard>, [">= 0"])
-      s.add_dependency(%q<epp-client>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<shoulda>, [">= 0"])
-    s.add_dependency(%q<yard>, [">= 0"])
-    s.add_dependency(%q<epp-client>, [">= 0"])
-  end
+  gem.add_dependency 'epp-client', '~> 1.0.0'
 end
-

data/test/helper.rb

@@ -5,6 +5,63 @@ require 'shoulda'
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'nominet-epp'
+require 'epp-client/testing'
+
+module NominetEPP
+  class Client
+    def prepare_request(type, request, extension = nil)
+      @client.__send__(:"#{type}_prepare", request, extension)
+    end
+    def load_response(xml)
+      @client.__send__(:load_response, xml)
+    end
+  end
+end
 
 class Test::Unit::TestCase
+  def load_xml(name)
+    xml_path = File.expand_path("../support/responses/#{name}.xml", __FILE__)
+    File.read(xml_path)
+  end
+  def load_response(name)
+    xml = load_xml(name)
+    test_client.load_response(xml)
+  end
+
+  def load_schema(name)
+    xsd_path = File.expand_path("../support/schemas/#{name}.xsd", __FILE__)
+    xsd_doc  = XML::Document.file(xsd_path)
+    XML::Schema.document(xsd_doc)
+  end
+  def schema
+    @schema ||= load_schema('nom-root-std-1.0.7')
+  end
+  def xpath_find(query)
+    n = @xml.find(query, @namespaces).first
+    case n
+    when XML::Node
+      n.content.strip
+    when XML::Attr
+      n.value.strip
+    end
+  end
+  def xpath_each(query)
+    @xml.find(query, @namespaces).each do |node|
+      yield node
+    end
+  end
+  def xpath_exists?(query)
+    !@xml.find(query, @namespaces).empty?
+  end
+  def namespaces_from_request(request = @request)
+    @namespaces = Hash[*request.namespaces.map { |k,ns| [k, ns.href] }.flatten]
+  end
+
+  def test_client
+    @test_client ||= NominetEPP::Client.new('TEST', 'testing')
+  end
+
+  def prepare_request(name = @request.command_name, request = @request)
+    test_client.prepare_request(name, request.command, request.extension)
+  end
 end

data/test/notifications/test_contact_deleted_notification.rb

@@ -0,0 +1,23 @@
+require 'helper'
+
+class TestNominetContactDeletedNotification < Test::Unit::TestCase
+  context 'NominetEPP::Notifications::ContactDeleted' do
+    setup do
+      @notification =
+        NominetEPP::Notification.new(
+          load_response('notifications/contact-deleted'))
+    end
+    subject { @notification }
+
+    should 'have type' do
+      assert_equal :contact_deleted, subject.type
+    end
+
+    should 'have contact id' do
+      assert_equal 'EPPID0003', subject.id
+    end
+    should 'have roid' do
+      assert_equal '1002703-UK', subject.roid
+    end
+  end
+end

data/test/notifications/test_domain_cancelled_notification.rb

@@ -0,0 +1,23 @@
+require 'helper'
+
+class TestNominetDomainCancelledNotification < Test::Unit::TestCase
+  context 'NominetEPP::Notifications::DomainCancelled' do
+    setup do
+      @notification =
+        NominetEPP::Notification.new(
+          load_response('notifications/domain-cancelled'))
+    end
+    subject { @notification }
+
+    should 'have type' do
+      assert_equal :domain_cancelled, subject.type
+    end
+
+    should 'have domain name' do
+      assert_equal 'epp-example1.co.uk', subject.name
+    end
+    should 'have originator' do
+      assert_equal 'example@nominet', subject.originator
+    end
+  end
+end

data/test/notifications/test_domains_released_notification.rb

@@ -0,0 +1,34 @@
+require 'helper'
+
+class TestNominetDomainsReleasedNotification < Test::Unit::TestCase
+  context 'NominetEPP::Notifications::DomainsReleased' do
+    setup do
+      @notification =
+        NominetEPP::Notification.new(
+          load_response('notifications/domains-released'))
+    end
+    subject { @notification }
+
+    should 'have type' do
+      assert_equal :domains_released, subject.type
+    end
+
+    should 'have account ID' do
+      assert_equal '12345', subject.account_id
+    end
+    should 'flag account ID as moved' do
+      assert_equal true, subject.account_moved?
+    end
+    should 'have EXAMPLE1-TAG as sender' do
+      assert_equal 'EXAMPLE1-TAG', subject.from
+    end
+    should 'have EXAMPLE2-TAG as receiver' do
+      assert_equal 'EXAMPLE2-TAG', subject.registrar_tag
+    end
+    should 'have domains' do
+      expected = %w(epp-example1.co.uk epp-example2.co.uk epp-example3.co.uk
+        epp-example4.co.uk epp-example5.co.uk epp-example6.co.uk)
+      assert_equal expected, subject.domains
+    end
+  end
+end

data/test/notifications/test_domains_suspended_notification.rb

@@ -0,0 +1,30 @@
+require 'helper'
+
+class TestNominetDomainsSuspendedNotification < Test::Unit::TestCase
+  context 'NominetEPP::Notifications::DomainsSuspended' do
+    setup do
+      @notification =
+        NominetEPP::Notification.new(
+          load_response('notifications/domains-suspended'))
+    end
+    subject { @notification }
+
+    should 'have type' do
+      assert_equal :domains_suspended, subject.type
+    end
+
+    should 'have reason' do
+      assert_equal 'Data Quality', subject.reason
+    end
+
+    should 'have cancellation date' do
+      expected = Time.gm(2009,12,12,0,0,13)
+      assert_equal expected, subject.cancellation_date
+    end
+
+    should 'have domains' do
+      expected = %w(epp-example1.co.uk epp-example2.co.uk)
+      assert_equal expected, subject.domains
+    end
+  end
+end

data/test/notifications/test_handshake_rejected_notification.rb

@@ -0,0 +1,34 @@
+require 'helper'
+
+class TestNominetHandshakeRejectedNotification < Test::Unit::TestCase
+  context 'NominetEPP::Notifications::HandshakeRejected' do
+    setup do
+      @notification =
+        NominetEPP::Notification.new(
+          load_response('notifications/handshake-rejected'))
+    end
+    subject { @notification }
+
+    should 'have type' do
+      assert_equal :handshake_rejected, subject.type
+    end
+
+    should 'have account ID' do
+      assert_equal '1243654', subject.account_id
+    end
+    should 'flag account ID as moved' do
+      assert_equal false, subject.account_moved?
+    end
+    should 'have EXAMPLE1-TAG as sender' do
+      assert_equal 'EXAMPLE1-TAG', subject.from
+    end
+    should 'have EXAMPLE2-TAG as receiver' do
+      assert_equal 'EXAMPLE2-TAG', subject.registrar_tag
+    end
+    should 'have domains' do
+      expected = %w(epp-example1.co.uk epp-example2.co.uk epp-example3.co.uk
+        epp-example4.co.uk epp-example5.co.uk epp-example6.co.uk)
+      assert_equal expected, subject.domains
+    end
+  end
+end

data/test/notifications/test_registrant_transfer_notification.rb

@@ -0,0 +1,78 @@
+require 'helper'
+
+class TestNominetRegistrantTransferNotification < Test::Unit::TestCase
+  context 'NominetEPP::Notifications::RegistrantTransfer' do
+    setup do
+      @notification =
+        NominetEPP::Notification.new(
+          load_response('notifications/registrant-transfer'))
+    end
+    subject { @notification }
+
+    should 'have type' do
+      assert_equal :registrant_transfer, subject.type
+    end
+
+    should 'have originator' do
+      assert_equal 'p@automaton-example.org.uk', subject.originator
+    end
+    should 'have account Id' do
+      assert_equal '58658458', subject.account_id
+    end
+    should 'have old account Id' do
+      assert_equal '596859', subject.old_account_id
+    end
+    should 'have domains' do
+      expected = %w(epp-example1.co.uk epp-example2.co.uk)
+      assert_equal expected, subject.domains
+    end
+    should 'have contact type' do
+      assert_equal 'IND', subject.contact.type
+    end
+    should 'have contact id' do
+      assert_equal 'ST68956589R4', subject.contact.id
+    end
+    should 'have contact roid' do
+      assert_equal '123456-UK', subject.contact.roid
+    end
+    should 'have contact postal info' do
+      expected = { :name => "Mr R. Strant",
+        :addr => {
+          :street => "2102 High Street",
+          :city => "Oxford",
+          :sp => "Oxon",
+          :pc => "OX1 1QQ",
+          :cc => "GB" }}
+      assert_equal expected, subject.contact.postal_info
+    end
+    should 'have contact email' do
+      assert_equal 'example@epp-example1.co.uk', subject.contact.email
+    end
+    should 'have nil voice' do
+      assert_equal nil, subject.contact.voice
+    end
+    should 'have nil fax' do
+      assert_equal nil, subject.contact.fax
+    end
+    should 'have opt out' do
+      assert_equal true, subject.contact.opt_out
+    end
+    should 'have contact client id' do
+      assert_equal 'TEST', subject.contact.client_id
+    end
+    should 'have contact creator id' do
+      assert_equal 'TEST', subject.contact.creator_id
+    end
+    should 'have contact created date' do
+      expected = Time.gm(1999,4,3,22,0,0)
+      assert_equal expected, subject.contact.created_date
+    end
+    should 'have contact updator id' do
+      assert_equal 'domains@isp.com', subject.contact.updator_id
+    end
+    should 'have contact updated date' do
+      expected = Time.gm(1999,12,3,9,0,0)
+      assert_equal expected, subject.contact.updated_date
+    end
+  end
+end