ultraspeed-epp 1.0.0

data/README.rdoc

@@ -0,0 +1,32 @@
+= EPP Version 1.0
+
+http://github.com/ultraspeed/epp
+
+== DESCRIPTION:
+
+Basic functionality for connecting and making requests on EPP (Extensible Provisioning Protocol) servers.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Josh Delsman (Ultraspeed)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+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.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'fileutils'
+
+require File.dirname(__FILE__) + '/lib/epp'
+
+Dir['tasks/**/*.rake'].each { |t| load t }

data/lib/epp.rb

@@ -0,0 +1,12 @@
+require 'openssl'
+require 'socket'
+
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'require_parameters'
+require 'epp/server.rb'
+
+module Epp #:nodoc:
+  VERSION = '1.0'
+end

data/lib/epp/server.rb

@@ -0,0 +1,75 @@
+module Epp #:nodoc:
+  class Server
+    include RequiresParameters
+    
+    def initialize(attributes = {})
+      requires!(attributes, :server, :port)
+
+      @connection = open_connection(attributes[:server], attributes[:port])
+      @socket     = open_socket(@connection)
+      
+      # Initiate the connection to the server through the SSL socket
+      @socket.connect
+      
+      # Receive the EPP <greeting> frame which is sent by the server
+      # upon initial connection
+      get_frame
+    end
+
+    # Sends an XML request to the EPP server, and receives an XML response
+    def request(xml)
+      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
+    # a <logout> command before ending the session, so it is recommended
+    # that you do so.
+    def close_connection
+      @socket.close if defined?(@socket) && !@socket.closed?
+      @connection.close if defined?(@connection) && !@connection.closed?
+    end
+    
+    # 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,
+    # it will return a string containing the XML from the server.
+    def get_frame
+      header = @socket.read(4)
+
+      if header.nil? and @socket.closed?
+        raise SocketError.new("Connection closed by remote server")
+      elsif header.nil?
+        raise SocketError.new("Error reading frame from remote server")
+      else
+        unpacked_header = header.unpack("N")
+        length = unpacked_header[0]
+
+        if length < 5
+          raise SocketError.new("Got bad frame header length of #{length} bytes from the server")
+        else
+          @socket.read(length - 4)
+        end
+      end
+    end
+    
+    # Send an XML frame to the server. Should return the total byte
+    # size of the frame sent to the server.
+    def send_frame(xml)
+      @socket.write([xml.length].pack("N") + xml)
+    end
+  end
+end

data/lib/require_parameters.rb

@@ -0,0 +1,14 @@
+module RequiresParameters #:nodoc:
+  def requires!(hash, *params)
+    params.each do |param| 
+      if param.is_a?(Array)
+        raise ArgumentError.new("Missing required parameter: #{param.first}") unless hash.has_key?(param.first) 
+
+        valid_options = param[1..-1]
+        raise ArgumentError.new("Parameter: #{param.first} must be one of #{valid_options.to_sentence(:connector => 'or')}") unless valid_options.include?(hash[param.first])
+      else
+        raise ArgumentError.new("Missing required parameter: #{param}") unless hash.has_key?(param) 
+      end
+    end
+  end    
+end

data/test/test_epp.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestEpp < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  def test_truth
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/epp'

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification 
+name: ultraspeed-epp
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Josh Delsman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-03 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Basic functionality for connecting and making requests on EPP (Extensible Provisioning Protocol) servers.
+email: jdelsman@ultraspeed.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/epp/server.rb
+- lib/epp.rb
+- lib/require_parameters.rb
+- Rakefile
+- README.rdoc
+- test/test_epp.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/ultraspeed/epp
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: epp
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Basic functionality for connecting and making requests on EPP (Extensible Provisioning Protocol) servers.
+test_files: []
+