epp-client 0.0.3 → 1.0.0

data/lib/epp-client/client.rb

@@ -4,14 +4,33 @@ module EPP
   # Establishes a connection to an EPP server and allows for sending commands
   # to that EPP server.
   class Client
+    # Default Service URNs
+    #
+    # Provided to make it easier for clients to add additional services to
+    # the default list.
+    #
+    # @example
+    #   services = DEFAULT_SERVICES + %w(urn:ietf:params:xml:ns:secDNS-1.1)
+    #   EPP::Client.new('username','password','epp.example.com', :services => services)
+    DEFAULT_SERVICES = [ Domain::NAMESPACE, Contact::NAMESPACE, Host::NAMESPACE ]
+
     # Create new instance of EPP::Client.
     #
     # @param [String] tag EPP Tag
     # @param [String] passwd EPP Tag password
     # @param [String] host EPP Host address
     # @param [Hash] options Options
-    # @option options [Boolean] :compatibility If compatibility mode should be used?
+    # @option options [Integer] :port EPP Port number, default 700
+    # @option options [Boolean] :compatibility Compatibility mode, default false
+    # @option options [String] :lang EPP Language code, default 'en'
+    # @option options [String] :version EPP protocol version, default '1.0'
+    # @option options [Array<String>] :extensions EPP Extension URNs
+    # @option options [Array<String>] :services EPP Service URNs
+    # @option options [String] :address_family 'AF_INET' or 'AF_INET6' or either of the
+    #                          appropriate socket constants. Will cause connections to be
+    #                          limited to this address family. Default try all addresses.
     def initialize(tag, passwd, host, options = {})
+      @tag, @passwd, @host, @options = tag, passwd, host, options
       @conn = if options.delete(:compatibility) == true
         OldServer.new(tag, passwd, host, options)
       else
@@ -19,20 +38,64 @@ module EPP
       end
     end
 
+    attr_reader :tag, :passwd, :host, :options
+
+    def compatibility?
+      @conn.is_a?(OldServer)
+    end
+
     # Returns the last request sent to the EPP server
     #
     # @return [Request] last request sent to the EPP server
-    def _last_request
+    def last_request
       @conn.last_request
     end
 
+    # Returns the last request sent to the EPP server
+    #
+    # @deprecated
+    # @return [Request] last request sent to the EPP server
+    def _last_request
+      warn "The #{self.class}#_last_request method is deprecated, please call #last_request"
+      last_request
+    end
+
     # Returns the last response received from the EPP server
     #
-    # @return [Request] last response received from the EPP server
-    def _last_response
+    # @return [Response] last response received from the EPP server
+    def last_response
       @conn.last_response
     end
 
+    # Returns the last response received from the EPP server
+    #
+    # @deprecated
+    # @return [Response] last response received from the EPP server
+    def _last_response
+      warn "The #{self.class}#_last_response method is deprecated, please call #last_response"
+      last_response
+    end
+
+    # Returns the last error received from a login or logout request
+    #
+    # @return [ResponseError] last error received from login/logout request
+    def last_error
+      @conn.last_error
+    end
+
+    # Returns the last error received from a login or logout request
+    #
+    # @deprecated
+    # @return [ResponseError] last error received from login/logout request
+    def _last_error
+      warn "The #{self.class}#_last_error method is deprecated, please call #last_error"
+      last_error
+    end
+
+    def greeting
+      @conn.greeting
+    end
+
     # Send hello command
     def hello
       @conn.connection do
@@ -40,23 +103,57 @@ module EPP
       end
     end
 
-    # Calls an EPP command after connecting to the EPP Server and logging in.
-    #
-    # @overload method_missing(command, payload)
-    #   @param [String, #to_s] command EPP Command to call
-    #   @param [XML::Node, XML::Document, String] payload EPP XML Payload
-    # @overload method_missing(command)
-    #   @param [String, #to_s] command EPP Command to call
-    #   @yield [xml] block to construct payload
-    #   @yieldparam [XML::Node] xml XML Node of the command
-    #     for the payload to be added into
-    # @return [Response] EPP Response object
-    def method_missing(command, payload = nil, &block)
-      @conn.connection do
-        @conn.with_login do
-          @conn.request(command, payload, &block)
+    def check(payload, extension = nil)
+      check = EPP::Commands::Check.new(payload)
+      command(check, extension)
+    end
+
+    def create(payload, extension = nil)
+      create = EPP::Commands::Create.new(payload)
+      command(create, extension)
+    end
+
+    def delete(payload, extension = nil)
+      delete = EPP::Commands::Delete.new(payload)
+      command(delete, extension)
+    end
+
+    def info(payload, extension = nil)
+      info = EPP::Commands::Info.new(payload)
+      command(info, extension)
+    end
+
+    def renew(payload, extension = nil)
+      renew = EPP::Commands::Renew.new(payload)
+      command(renew, extension)
+    end
+
+    def transfer(op, payload, extension = nil)
+      transfer = EPP::Commands::Transfer.new(op, payload)
+      command(transfer, extension)
+    end
+
+    def update(payload, extension = nil)
+      update = EPP::Commands::Update.new(payload)
+      command(update, extension)
+    end
+
+    def poll
+      poll = EPP::Commands::Poll.new
+      command(poll)
+    end
+    def ack(msgID)
+      ack = EPP::Commands::Poll.new(msgID)
+      command(ack)
+    end
+
+    protected
+      def command(cmd, extension = nil)
+        @conn.connection do
+          @conn.with_login do
+            @conn.request(cmd, extension)
+          end
         end
       end
-    end
   end
 end

data/lib/epp-client/commands/check.rb

@@ -0,0 +1,11 @@
+require File.expand_path('../read_write_command', __FILE__)
+
+module EPP
+  module Commands
+    class Check < ReadWriteCommand
+      def name
+        'check'
+      end
+    end
+  end
+end

data/lib/epp-client/commands/command.rb

@@ -0,0 +1,24 @@
+module EPP
+  module Commands
+    class Command
+      include XMLHelpers
+
+      def set_namespaces(namespaces)
+        @namespaces = namespaces
+      end
+
+      # Receiver in XML form
+      # @return [XML::Document] XML of the receiver
+      def to_xml
+        epp_node(name, @namespaces || {})
+      end
+
+      # Convert the receiver to a string
+      #
+      # @param [Hash] opts Formatting options, passed to the XML::Document
+      def to_s(opts = {})
+        to_xml.to_s({:indent => false}.merge(opts))
+      end
+    end
+  end
+end

data/lib/epp-client/commands/create.rb

@@ -0,0 +1,11 @@
+require File.expand_path('../read_write_command', __FILE__)
+
+module EPP
+  module Commands
+    class Create < ReadWriteCommand
+      def name
+        'create'
+      end
+    end
+  end
+end

data/lib/epp-client/commands/delete.rb

@@ -0,0 +1,11 @@
+require File.expand_path('../read_write_command', __FILE__)
+
+module EPP
+  module Commands
+    class Delete < ReadWriteCommand
+      def name
+        'delete'
+      end
+    end
+  end
+end

data/lib/epp-client/commands/info.rb

@@ -0,0 +1,11 @@
+require File.expand_path('../read_write_command', __FILE__)
+
+module EPP
+  module Commands
+    class Info < ReadWriteCommand
+      def name
+        'info'
+      end
+    end
+  end
+end

data/lib/epp-client/commands/login.rb

@@ -0,0 +1,40 @@
+require File.expand_path('../command', __FILE__)
+
+module EPP
+  module Commands
+    class Login < Command
+      def initialize(tag, passwd, config)
+        @tag, @passwd, @config = tag, passwd, config
+      end
+
+      def name
+        'login'
+      end
+
+      def to_xml
+        node = super
+        node << epp_node('clID', @tag, @namespaces || {})
+        node << epp_node('pw', @passwd, @namespaces || {})
+
+        options  = epp_node('options', @namespaces || {})
+        options << epp_node('version', @config[:version], @namespaces || {})
+        options << epp_node('lang', @config[:lang], @namespaces || {})
+        node << options
+
+        svcs = epp_node('svcs', @namespaces || {})
+        @config[:services].each { |uri| svcs << epp_node('objURI', uri, @namespaces || {}) }
+        node << svcs
+
+        unless @config[:extensions].empty?
+          ext = epp_node('svcExtension', @namespaces || {})
+          @config[:extensions].each do |uri|
+            ext << epp_node('extURI', uri, @namespaces || {})
+          end
+          svcs << ext
+        end
+
+        node
+      end
+    end
+  end
+end

data/lib/epp-client/commands/logout.rb

@@ -0,0 +1,11 @@
+require File.expand_path('../command', __FILE__)
+
+module EPP
+  module Commands
+    class Logout < Command
+      def name
+        'logout'
+      end
+    end
+  end
+end

data/lib/epp-client/commands/poll.rb

@@ -0,0 +1,28 @@
+require File.expand_path('../command', __FILE__)
+
+module EPP
+  module Commands
+    class Poll < Command
+      def initialize(msgID = nil)
+        @msgID = msgID
+      end
+      
+      def name
+        'poll'
+      end
+
+      def to_xml
+        node = super
+
+        if @msgID
+          node['op'] = 'ack'
+          node['msgID'] = @msgID
+        else
+          node['op'] = 'req'
+        end
+
+        node
+      end
+    end
+  end
+end

data/lib/epp-client/commands/read_write_command.rb

@@ -0,0 +1,18 @@
+require File.expand_path('../command', __FILE__)
+
+module EPP
+  module Commands
+    class ReadWriteCommand < Command
+      def initialize(command)
+        @command = command
+      end
+      def to_xml
+        node = super
+        
+        @command.set_namespaces(@namespaces) if @command.respond_to?(:set_namespaces)
+        node << as_xml(@command)
+        node
+      end
+    end
+  end
+end

data/lib/epp-client/commands/renew.rb

@@ -0,0 +1,11 @@
+require File.expand_path('../read_write_command', __FILE__)
+
+module EPP
+  module Commands
+    class Renew < ReadWriteCommand
+      def name
+        'renew'
+      end
+    end
+  end
+end

data/lib/epp-client/commands/transfer.rb

@@ -0,0 +1,25 @@
+require File.expand_path('../read_write_command', __FILE__)
+
+module EPP
+  module Commands
+    class Transfer < ReadWriteCommand
+      OPERATIONS = %w(approve cancel query reject request)      
+      
+      def initialize(op, command)
+        raise ArgumentError, "op must be one of #{OPERATIONS.join(', ')}" unless OPERATIONS.include?(op)
+
+        super command
+        @op = op
+      end
+      def name
+        'transfer'
+      end
+
+      def to_xml
+        node = super
+        node['op'] = @op
+        node
+      end
+    end
+  end
+end

data/lib/epp-client/commands/update.rb

@@ -0,0 +1,11 @@
+require File.expand_path('../read_write_command', __FILE__)
+
+module EPP
+  module Commands
+    class Update < ReadWriteCommand
+      def name
+        'update'
+      end
+    end
+  end
+end

data/lib/epp-client/contact/check.rb

@@ -0,0 +1,23 @@
+require File.expand_path('../command', __FILE__)
+
+module EPP
+  module Contact
+    class Check < Command
+      def initialize(*ids)
+        @ids = ids.flatten
+      end
+
+      def name
+        'check'
+      end
+
+      def to_xml
+        node = super
+        @ids.each do |id|
+          node << contact_node('id', id)
+        end
+        node
+      end
+    end
+  end
+end

data/lib/epp-client/contact/check_response.rb

@@ -0,0 +1,22 @@
+require File.expand_path('../response', __FILE__)
+
+module EPP
+  module Contact
+    class CheckResponse < Response
+      def available?(id)
+        availability[id]
+      end
+      def unavailable?(id)
+        !available?(id)
+      end
+
+      protected
+        def availability
+          @availability ||= nodes_for_xpath('//contact:id').inject({}) do |hash, node|
+            hash[node.content.strip] = node['avail'] == '1'
+            hash
+          end
+        end
+    end
+  end
+end