ultraspeed-epp 1.0.2 → 1.0.3

data/README.rdoc

@@ -1,4 +1,4 @@
-= EPP Version 1.0.1
+= EPP (by {Ultraspeed}[http://ultraspeed.co.uk])
 
 The EPP gem provides basic functionality for connecting and making requests on EPP (Extensible Provisioning Protocol) servers. Currently, major providers Centralnic and Nominet have been tested.
 
@@ -24,48 +24,32 @@ Once you do that, you can install the gem by typing <tt>sudo rake gems:install</
 
 == Example Usage
 
-First, you must initialize an Epp::Server object to use. This requires the server address and port:
+First, you must initialize an Epp::Server object to use. This requires the EPP server address, tag/username and password:
 
     server = Epp::Server.new(
       :server => "testbed-epp.nominet.org.uk",
-      :port => 700
+      :tag => "TESTING",
+      :password => "testing"
     )
     
 If no port is specified, it will be assumed that you will be using port 700.
 
-You would then make an XML request to the server. You can build this however you'd like. For simplicity purposes, here is a string <tt><login></tt> request:
-
-    xml = %{
-    <?xml version="1.0" encoding="UTF-8"?>
-    <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"
-         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:schemaLocation="urn:ietf:params:xml:ns:epp-1.0 epp-1.0.xsd">
-      <command>
-        <login>
-          <clID>EXAMPLE-TAG</clID>
-          <pw>foo-123</pw>
-          <options>
-            <version>1.0</version>
-            <lang>en</lang>
-          </options>
-          <svcs>
-            <objURI>urn:ietf:params:xml:ns:domain-1.0</objURI>
-            <objURI>urn:ietf:params:xml:ns:contact-1.0</objURI>
-            <objURI>urn:ietf:params:xml:ns:host-1.0</objURI>
-          </svcs>
-        </login>
-        <clTRID>ABC-12345</clTRID>
-      </command>
-    </epp>
-    }
-      
-    response = server.request(xml)
-    
-The EPP server would then return the XML response as a string, and set it equal to <tt>response</tt> for your usage.
+You would then make an XML request to the server. 
+
+    xml       = "<?xml ... </epp>"
+    response  = server.request(xml)
+  
+You can build this however you'd like. The process is as follows:
+
+* Connect to EPP server, get the <greeting> frame
+* Send a standard <login> request
+* Send your request
+* Send a standard <logout> request
+* Disconnect the socket from the server
 
-You can close the connection to the server completely by using the following:
+The EPP server would then return the XML response as a string. In this example, the response XML would be set equal to <tt>response</tt> for your usage.
 
-    server.close_connection
+Once the request is complete, it will automatically close the connection. For simplicity purposes, this plug-in will *not* use a persistent connection to the EPP server.
 
 == Bugs/Issues
 

data/lib/epp/server.rb

@@ -1,6 +1,5 @@
 module Epp #:nodoc:
   class Server
-    include REXML
     include RequiresParameters
         
     attr_accessor :tag, :password, :server, :port, :clTRID
@@ -43,7 +42,7 @@ module Epp #:nodoc:
       return @response
     end
     
-    private
+    # private
     
     # Wrapper which sends an XML frame to the server, and receives 
     # the response frame in return.
@@ -53,8 +52,8 @@ module Epp #:nodoc:
     end
     
     def login
-      xml = Document.new
-      xml << XMLDecl.new("1.0", "UTF-8", "no")
+      xml = REXML::Document.new
+      xml << REXML::XMLDecl.new("1.0", "UTF-8", "no")
       
       xml.add_element("epp", {
         "xmlns" => "urn:ietf:params:xml:ns:epp-1.0",
@@ -79,12 +78,22 @@ module Epp #:nodoc:
       
       command.add_element("clTRID").text = @clTRID
 
-      send_request(xml.to_s)
+      # Receive the login response
+      response = Hpricot.XML(send_request(xml.to_s))
+      
+      result_message  = (response/"epp"/"response"/"result"/"msg").text.strip
+      result_code     = (response/"epp"/"response"/"result").attr("code").to_i
+      
+      if result_code == 1000
+        return true
+      else
+        raise EppErrorResponse.new(:code => result_code, :message => result_message)
+      end
     end
     
     def logout
-      xml = Document.new
-      xml << XMLDecl.new("1.0", "UTF-8", "no")
+      xml = REXML::Document.new
+      xml << REXML::XMLDecl.new("1.0", "UTF-8", "no")
       
       xml.add_element('epp', {
         'xmlns' => "urn:ietf:params:xml:ns:epp-1.0",
@@ -95,7 +104,17 @@ module Epp #:nodoc:
       command = xml.root.add_element("command")
       login = command.add_element("logout")
       
-      send_request(xml.to_s)
+      # Receive the logout response
+      response = Hpricot.XML(send_request(xml.to_s))
+      
+      result_message  = (response/"epp"/"response"/"result"/"msg").text.strip
+      result_code     = (response/"epp"/"response"/"result").attr("code").to_i
+      
+      if result_code == 1500
+        return true
+      else
+        raise EppErrorResponse.new(:code => result_code, :message => result_message)
+      end
     end
     
     # Establishes the connection to the server. If the connection is
@@ -157,9 +176,7 @@ module Epp #:nodoc:
     # Send an XML frame to the server. Should return the total byte
     # size of the frame sent to the server. If the socket returns EOF,
     # the connection has closed and a SocketError is raised.
-    def send_frame(xml)
-      raise SocketError.new("Connection closed by remote server") if @socket.eof?
-      
+    def send_frame(xml)      
       @socket.write([xml.size + 4].pack("N") + xml)
     end
   end

data/lib/epp.rb

@@ -7,9 +7,11 @@ require 'socket'
 require 'activesupport'
 require 'require_parameters'
 require 'rexml/document'
+require 'hpricot'
 
-require 'epp/server.rb'
+require 'epp/server'
+require 'epp/exceptions'
 
 module Epp #:nodoc:
-  VERSION = '1.0.2'
+  VERSION = '1.0.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ultraspeed-epp
 version: !ruby/object:Gem::Version 
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors: 
 - Josh Delsman
@@ -11,8 +11,27 @@ cert_chain: []
 
 date: 2009-06-04 00:00:00 -07:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hpricot
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.8.1
+    version: 
 description: Basic functionality for connecting and making requests on EPP (Extensible Provisioning Protocol) servers.
 email: jdelsman@ultraspeed.com
 executables: []