nominet-epp 0.0.4 → 0.0.5

data/History.md

@@ -1,3 +1,9 @@
+0.0.5 / 2011-02-24
+==================
+
+  * Many bug fixes in Create operation
+  * Support for using `host:update` to modify name server glue information.
+
 0.0.4 / 2011-01-31
 ==================
 

data/README.rdoc

@@ -1,6 +1,12 @@
-= nominet-epp
+= Nominet EPP
 
-Description goes here.
+Ruby interface to the {Nominet EPP}[http://www.nominet.org.uk/registrars/systems/nominetepp] registrar interface.
+
+== Initialise a client
+
+ require 'nominet-epp'
+ client = NominetEPP::Client.new('TAGNAME', 'password')
+ testclient = NominetEPP::Client.new('TAGNAME', 'password', 'testbed-epp.nominet.org.uk')
 
 == Note on Patches/Pull Requests
  

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.0.5

data/lib/nominet-epp/helpers.rb

@@ -8,15 +8,15 @@ module NominetEPP
     def domain_ns_xml(nameservers, ns)
       ns_el = XML::Node.new('ns', nil, ns)
 
-      case nameservers.class
+      case nameservers
       when String
-        ns_el << (XML::Node.new('host', nil, ns) << XML::Node.new('hostName', nameservers, ns))
+        ns_el << domain_host_xml(nameservers, ns)
       when Array
         nameservers.each do |nameserver|
           ns_el << domain_host_xml(nameserver, ns)
         end
       else
-        raise ArgumentError, "nameservers must either be a string or array of strings"
+        raise ArgumentError, "nameservers must either be a string or array"
       end
 
       ns_el
@@ -28,7 +28,7 @@ module NominetEPP
     def domain_host_xml(nameserver, ns)
       host = XML::Node.new('host', nil, ns)
 
-      case nameserver.class
+      case nameserver
       when String
         host << XML::Node.new('hostName', nameserver, ns)
       when Hash

data/lib/nominet-epp/operations/create.rb

@@ -22,8 +22,8 @@ module NominetEPP
       # - (Integer) +:order+ --  Contacts order in the list of contacts
       #
       # @param [String] name Domain name to register
-      # @param [String] acct
-      # @param [Array] nameservers Nameservers to set for the domain
+      # @param [String, Hash] acct
+      # @param [String, Array] nameservers Nameservers to set for the domain
       # @param [Hash] options Registration options
       # @option options [String] :period
       # @option options [String] :first_bill
@@ -57,7 +57,7 @@ module NominetEPP
 
         return false unless @resp.success?
 
-        creData = @resp.data.find('/domain:creData', namespaces).first
+        creData = @resp.data.find('//domain:creData', namespaces).first
         h = { :name => node_value(creData, 'domain:name'),
           :crDate => Time.parse(node_value(creData, 'domain:crDate')),
           :exDate => Time.parse(node_value(creData, 'domain:exDate')) }
@@ -86,11 +86,11 @@ module NominetEPP
 
               acct[:contacts].each_with_index do |cont, i|
                 c = XML::Node.new('contact', nil, ns)
-                c['order'] = i
+                c['order'] = i.to_s
                 node << (c << create_account_contact(cont))
               end
 
-              node << create_account_address(acct[:addr], ns)
+              node << create_account_address(acct[:addr], ns) unless acct[:addr].nil?
             end
           else
             raise ArgumentError, "acct must be String or Hash"
@@ -104,7 +104,8 @@ module NominetEPP
         # @raise [ArgumentError] name or email key is missing
         # @return [XML::Node]
         def create_account_contact(cont)
-          raise ArgumentError, "Contact allowed keys are name, email, phone and mobile" unless (cont.keys -[:name, :email, :phone, :mobile]).empty?
+          raise ArgumentError, "cont must be a hash" unless cont.is_a?(Hash)
+          raise ArgumentError, "Contact allowed keys are name, email, phone and mobile" unless (cont.keys - [:name, :email, :phone, :mobile]).empty?
           raise ArgumentError, "Contact requires name and email keys" unless cont.has_key?(:name) && cont.has_key?(:email)
 
           contact('create') do |node, ns|
@@ -117,9 +118,12 @@ module NominetEPP
         # Create contact address
         #
         # @param [Hash] addr Address fields
+        # @param [XML::Namespace] ns XML Namespace
         # @raise [ArgumentError] invalid keys in addr
         # @return [XML::Node]
         def create_account_address(addr, ns)
+          raise ArgumentError, "addr must be a hash" unless addr.is_a?(Hash)
+          raise ArgumentError, "ns must be an xml namespace" unless ns.is_a?(XML::Namespace)
           raise ArgumentError, "Address allowed keys are street, locality, city, county, postcode, country" unless (addr.keys - [:street, :locality, :city, :county, :postcode, :country]).empty?
 
           addr = XML::Node.new('addr', nil, ns)

data/lib/nominet-epp/operations/update.rb

@@ -1,10 +1,59 @@
 module NominetEPP
   module Operations
-    # EPP Update Operation
+    # == EPP Update Operation
+    #
+    # === Domain Update
+    # The +id+ field for domain updates is the domain name to be modified.
+    #
+    # Fields options
+    # - (Hash) +:account+ -- Hash of account details to be updated
+    # - (String,Hash) +:ns+ -- Single or array of nameservers to set on the domain
+    # - (String) +:first_bill+ -- Set first-bill
+    # - (String) +:recur_bill+ -- Set recur-bill
+    # - (String) +:auto_bill+ -- Set auto-bill
+    # - (String) +:purchase_order+ -- Set purchase-oder
+    # - (String) +:notes+ -- Notes about the domain
+    # - (Boolean) +:renew_not_required+ -- Mark a domain as no longer needed
+    # - (String) +:reseller+ -- Set reseller
+    # ... etc ... any other permitted account fields
+    #
+    # === Account Update
+    # The +id+ field for account updates is the ROID identifying
+    # the account record on the remote endpoint.
+    #
+    # Fields options
+    # - (Array) +:contacts+ -- Array of contacts to create on the account
+    # - (Hash) +:addr+ -- Hash of address fields to modify on the account
+    # - (String) +:name+ -- Account holder name
+    # ... etc ... any other permitted account fields
+    #
+    # === Contact Update
+    # The +id+ field for contact updates is the ROID identifying
+    # the contact record on the remote endpoint.
+    #
+    # Fields options
+    # - (String) +:name+ -- Contacts new name
+    # - (String) +:email+ -- Contacts new email address
+    # - (String) +:phone+ -- Contacts new phone number
+    # - (String) +:mobile+ -- Contacts new mobile number
+    #
+    # === Nameserver Update
+    # The +id+ field for nameserver updates is the fully qualified
+    # hostname for the name server you wish to update.
+    #
+    # Fields options
+    # - (Hash) +:add+ -- Addresses to add to the nameserver
+    # - (Hash) +:rem+ -- Addresses to remove from the nameserver
+    # - (String) +:chg+ -- New hostname of the nameserver
+    #
+    # Fields +:add+ and +:rem+ options
+    # - (String) +:v4+ -- IPv4 address to add or remove from the nameserver
+    # - (String) +:v6+ -- IPv6 address to add or remove from the nameserver
     module Update
-      # @param [Symbol] entity Entity to update
-      # @param [String] id Domain, Account or Contact to update
+      # @param [Symbol] entity Entity to update, one of domain, account, contact or nameserver
+      # @param [String] id Domain, Account, Contact or Nameserver to update
       # @param [Hash] fields Fields to update
+      # @return [Boolean] request successful
       def update(entity, id, fields = {})
         @resp = @client.update do
           self.send(:"update_#{entity}", id, fields)
@@ -62,6 +111,62 @@ module NominetEPP
             end
           end
         end
+
+        # Generate +host:update+ payload to modify a nameserver entry
+        # ---
+        # We need to know nameserver old data as well.
+        # If we are changing the nameserver name and keeping the info the same
+        # then we do a host:chg. If we are adding an IPv{4,6} address we use
+        # the host:add wrapper, and to remove we do a host:rem. As Nominet only
+        # allow one IPv{4,6} address per nameserver we should remove the old
+        # IP address from the server before adding the one. Alternatively if
+        # Nominet will automatically drop previous address then we need only
+        # do a host:add call.
+        # +++
+        #
+        # Fields options
+        # - (Hash) +:add+ -- Addresses to add to the nameserver
+        # - (Hash) +:rem+ -- Addresses to remove from the nameserver
+        # - (String) +:chg+ -- New hostname of the nameserver
+        #
+        # Fields +:add+ and +:rem+ options
+        # - (String) +:v4+ -- IPv4 address to add or remove from the nameserver
+        # - (String) +:v6+ -- IPv6 address to add or remove from the nameserver
+        #
+        # @param [String] name Nameserver host to update
+        # @param [Hash] fields Nameserver update information
+        # @raise [ArgumentError] invalid keys, either on fields or fields[:add] or fields[:rem]
+        # @return [XML::Node] +host:update+ payload
+        def update_nameserver(name, fields = {})
+          raise ArgumentError, "allowed keys :add, :rem, :chg" unless (fields.keys - [:add, :rem, :chg]).empty?
+
+          host('update') do |node, ns|
+            node << XML::Node.new('name', name, ns)
+
+            if fields.has_key?(:add) && fields[:add].kind_of?(Hash)
+              raise ArgumentError, "allowed :add keys are :v4 and :v6" unless (fields[:add].keys - [:v4, :v6]).empty?
+              node << (add = XML::Node.new('add', nil, ns))
+              fields[:add].each do |k,v|
+                add << (n = XML::Node.new('addr', v, ns))
+                n['ip'] = k.to_s
+              end
+            end
+
+            if fields.has_key?(:rem) && fields[:rem].kind_of?(Hash)
+              raise ArgumentError, "allowed :rem keys are :v4 and :v6" unless (fields[:rem].keys - [:v4, :v6]).empty?
+              node << (rem = XML::Node.new('rem', nil, ns))
+              fields[:rem].each do |k,v|
+                rem << (n = XML::Node.new('addr', v, ns))
+                n['ip'] = k.to_s
+              end
+            end
+
+            if fields.has_key?(:chg) && fields[:chg].kind_of?(String)
+              node << (chg = XML::Node.new('chg', nil, ns))
+              chg << XML::Node.new('name', fields[:chg], ns)
+            end
+          end
+        end
     end
   end
 end

data/lib/nominet-epp.rb

@@ -49,7 +49,8 @@ module NominetEPP
         :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' }
+        :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
@@ -97,7 +98,7 @@ module NominetEPP
       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]
+        node['xsi:schemaLocation'] = schemaLocations[ns_prefix] if schemaLocations.has_key?(ns_prefix)
 
         case block.arity
         when 0
@@ -150,5 +151,13 @@ module NominetEPP
       def notification(node_name, &block)
         new_node(node_name, :n, &block)
       end
+
+      # @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

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{nominet-epp}
-  s.version = "0.0.4"
+  s.version = "0.0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Geoff Garside"]
-  s.date = %q{2011-01-31}
+  s.date = %q{2011-02-24}
   s.description = %q{Client for communicating with the Nominet EPP}
   s.email = %q{geoff@geoffgarside.co.uk}
   s.extra_rdoc_files = [
@@ -47,7 +47,7 @@ Gem::Specification.new do |s|
   ]
   s.homepage = %q{http://github.com/geoffgarside/nominet-epp}
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.4.2}
+  s.rubygems_version = %q{1.5.2}
   s.summary = %q{Nominet EPP (Extensible Provisioning Protocol) Client}
   s.test_files = [
     "test/helper.rb",

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: nominet-epp
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Geoff Garside
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-31 00:00:00 +00:00
+date: 2011-02-24 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -127,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.4.2
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
 summary: Nominet EPP (Extensible Provisioning Protocol) Client