ultraspeed-epp 1.0.0 → 1.0.1

data/README.rdoc

@@ -1,14 +1,86 @@
-= EPP Version 1.0
+= EPP Version 1.0.1
 
-http://github.com/ultraspeed/epp
+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.
 
-== DESCRIPTION:
+* {Nominet Standard EPP Documentation}[http://www.nominet.org.uk/registrars/systems/standardepp/]
+* {Centralnic Labs EPP Documentation}[http://labs.centralnic.com/epp/]
 
-Basic functionality for connecting and making requests on EPP (Extensible Provisioning Protocol) servers.
+== Installation
 
-== LICENSE:
+You can install this gem with:
 
-(The MIT License)
+    $ sudo gem sources -a http://gems.github.com
+    $ sudo gem install ultraspeed-epp
+    
+Then, you can require it in your Ruby app:
+
+    require "epp"
+    
+If you're using Rails, add the following line to your Rails <tt>config/environment.rb</tt>:
+
+    config.gem "ultraspeed-epp", :lib => "epp", :source => "http://gems.github.com"
+    
+Once you do that, you can install the gem by typing <tt>sudo rake gems:install</tt>.
+
+== Example Usage
+
+First, you must initialize an Epp::Server object to use. This requires the server address and port:
+
+    server = Epp::Server.new(
+      :server => "testbed-epp.nominet.org.uk",
+      :port => 700
+    )
+    
+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 can close the connection to the server completely by using the following:
+
+    server.close_connection
+
+== Bugs/Issues
+
+Please report all issues using the GitHub issue tracker at:
+
+http://github.com/ultraspeed/epp/issues
+
+== Credit
+
+Author::          Josh Delsman at Ultraspeed (http://twitter.com/voxxit)
+Inspired from::   http://labs.centralnic.com/Net_EPP_Client.php
+
+== License
+
+The MIT License
 
 Copyright (c) 2009 Josh Delsman (Ultraspeed)
 
@@ -29,4 +101,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -1,8 +1,15 @@
 require 'rubygems'
 require 'rake'
 require 'rake/clean'
+require 'hanna/rdoctask'
 require 'fileutils'
 
 require File.dirname(__FILE__) + '/lib/epp'
 
-Dir['tasks/**/*.rake'].each { |t| load t }
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# Rdoc
+Rake::RDocTask.new do |rd|
+  rd.main = "README.rdoc"
+  rd.rdoc_files.include("README.rdoc", "lib/**/*.rb")
+end

data/lib/epp/server.rb

@@ -5,8 +5,8 @@ module Epp #:nodoc:
     def initialize(attributes = {})
       requires!(attributes, :server, :port)
 
-      @connection = open_connection(attributes[:server], attributes[:port])
-      @socket     = open_socket(@connection)
+      @connection = TCPSocket.new(attributes[:server], attributes[:port])
+      @socket     = OpenSSL::SSL::SSLSocket.new(@connection)
       
       # Initiate the connection to the server through the SSL socket
       @socket.connect
@@ -21,18 +21,6 @@ module Epp #:nodoc:
       send_frame(xml)
       get_frame
     end
-
-    private
-    
-    # Opens a connection to the EPP server.
-    def open_connection(server, port)
-      TCPSocket.new(server, port)
-    end
-    
-    # Opens an SSL socket with the EPP server.
-    def open_socket(connection)
-      OpenSSL::SSL::SSLSocket.new(connection)
-    end
     
     # Closes the connection to the EPP server. It should be noted
     # that the EPP specification indicates that clients should send
@@ -43,6 +31,8 @@ module Epp #:nodoc:
       @connection.close if defined?(@connection) && !@connection.closed?
     end
     
+    private
+    
     # Receive an EPP frame from the server. Since the connection is blocking,
     # this method will wait until the connection becomes available for use. If
     # the connection is broken, a SocketError will be raised. Otherwise,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ultraspeed-epp
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors: 
 - Josh Delsman