epp-client-base 0.11.0

data/ChangeLog

@@ -0,0 +1,5 @@
+2010-05-14 mat
+	* first release
+
+2010-05-04 mat
+	* Initial commit

data/Gemfile

@@ -0,0 +1,6 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in epp-client.gemspec
+Dir['*.gemspec'].each do |i|
+  gemspec :name => i.sub(/\.gemspec$/, '')
+end

data/MIT-LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2010 Mathieu Arnold, Absolight
+
+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/README

@@ -0,0 +1,5 @@
+An extensible EPP client library
+
+When possible, the objects that are received via EPP are translated to their
+equivalent in ruby, that is, dates in Date object, timestamps in DateTime
+objects.

data/Rakefile

@@ -0,0 +1,37 @@
+#!/usr/bin/env rake
+require 'rake'
+require 'rdoc/task'
+require 'rubygems/package_task'
+require "bundler/gem_helper"
+
+MY_GEMS = Dir['*.gemspec'].map {|g| g.sub(/.*-(.*)\.gemspec/, '\1')}
+
+MY_GEMS.each do |g|
+  namespace g do
+    Bundler::GemHelper.new(Dir.pwd, "epp-client-#{g}").install
+  end
+end
+
+namespace :all do
+  task :build   => MY_GEMS.map { |f| "#{f}:build"   }
+  task :install => MY_GEMS.map { |f| "#{f}:install" }
+  task :release => MY_GEMS.map { |f| "#{f}:release" }
+end
+
+task :build   => 'all:build'
+task :install => 'all:install'
+task :release => 'all:release'
+
+desc "Generate documentation for the Rails framework"
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'doc/rdoc'
+  rdoc.title    = "Documentation"
+
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.options << '--charset' << 'utf-8'
+
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('ChangeLog')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/epp-client-base.gemspec

@@ -0,0 +1,54 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/epp-client/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = 'epp-client-base'
+  gem.version       = EPPClient::VERSION
+  gem.date          = '2010-05-14'
+  gem.authors       = ['Mathieu Arnold']
+  gem.email         = ['m@absolight.fr']
+  gem.description   = 'An extensible EPP client library.'
+  gem.summary       = 'An extensible EPP client library'
+  gem.homepage       = "https://github.com/Absolight/epp-client"
+
+  gem.required_ruby_version = '>= 1.8.7'
+  gem.required_rubygems_version = ">= 1.3.6"
+
+  gem.files         = [
+    'ChangeLog',
+    'Gemfile',
+    'MIT-LICENSE',
+    'README',
+    'Rakefile',
+    'epp-client-base.gemspec',
+    'lib/epp-client/base.rb',
+    'lib/epp-client/connection.rb',
+    'lib/epp-client/contact.rb',
+    'lib/epp-client/domain.rb',
+    'lib/epp-client/exceptions.rb',
+    'lib/epp-client/poll.rb',
+    'lib/epp-client/session.rb',
+    'lib/epp-client/ssl.rb',
+    'lib/epp-client/version.rb',
+    'lib/epp-client/xml.rb',
+    'vendor/ietf/contact-1.0.xsd',
+    'vendor/ietf/domain-1.0.xsd',
+    'vendor/ietf/epp-1.0.xsd',
+    'vendor/ietf/eppcom-1.0.xsd',
+    'vendor/ietf/host-1.0.xsd',
+    'vendor/ietf/rfc4310.txt',
+    'vendor/ietf/rfc5730.txt',
+    'vendor/ietf/rfc5731.txt',
+    'vendor/ietf/rfc5732.txt',
+    'vendor/ietf/rfc5733.txt',
+    'vendor/ietf/rfc5734.txt',
+    'vendor/ietf/rfc5910.txt',
+  ]
+
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.require_paths = ['lib']
+
+  gem.add_development_dependency "bundler", ">= 1.0.0"
+  gem.add_dependency('nokogiri', '~> 1.4')
+  gem.add_dependency('builder',  '>= 2.1.2')
+end

data/lib/epp-client/base.rb

@@ -0,0 +1,113 @@
+require 'openssl'
+require 'socket'
+require 'nokogiri'
+require 'builder'
+require 'date'
+require "epp-client/version"
+require 'epp-client/xml'
+require 'epp-client/session'
+require 'epp-client/connection'
+require 'epp-client/exceptions'
+require 'epp-client/ssl'
+require 'epp-client/poll'
+require 'epp-client/domain'
+require 'epp-client/contact'
+
+module EPPClient
+  class Base
+
+    SCHEMAS = %w[
+      epp-1.0
+      domain-1.0
+      host-1.0
+      contact-1.0
+    ]
+    SCHEMAS_EXT_IETF = %w[
+      rgp-1.0
+    ]
+
+    EPPClient::SCHEMAS_URL = SCHEMAS.inject({}) do |a,s|
+      a[s.sub(/-1\.0$/, '')] = "urn:ietf:params:xml:ns:#{s}" if s =~ /-1\.0$/
+      a[s] = "urn:ietf:params:xml:ns:#{s}"
+      a
+    end.merge!(SCHEMAS_EXT_IETF.inject({}) do |a,s|
+      a[s.sub(/-1\.0$/, '')] = "urn:ietf:params:xml:ns:#{s}" if s =~ /-1\.0$/
+      a[s] = "urn:ietf:params:xml:ns:#{s}"
+      a
+    end)
+
+    include EPPClient::XML
+    include EPPClient::Session
+    include EPPClient::Connection
+    include EPPClient::SSL
+    include EPPClient::Poll # keep before object definition modules.
+    include EPPClient::Domain
+    include EPPClient::Contact
+
+    attr_accessor :client_id, :password, :server, :port, :services, :lang, :extensions, :version, :context
+    attr_writer :clTRID
+
+    # ==== Required Attributes
+    #
+    # [<tt>:server</tt>] The EPP server to connect to
+    # [<tt>:client_id</tt>]
+    #   The tag or username used with <tt><login></tt> requests.
+    # [<tt>:password</tt>] The password used with <tt><login></tt> requests.
+    #
+    # ==== Optional Attributes
+    #
+    # [<tt>:port</tt>]
+    #   The EPP standard port is 700. However, you can choose a different port to
+    #   use.
+    # [<tt>:clTRID</tt>]
+    #   The client transaction identifier is an element that EPP specifies MAY be
+    #   used to uniquely identify the command to the server. The string
+    #   "-<index>" will be added to it, index being incremented at each command.
+    #   Defaults to "test-<pid>-<random>"
+    # [<tt>:lang</tt>] Set custom language attribute. Default is 'en'.
+    # [<tt>:services</tt>]
+    #   Use custom EPP services in the <login> frame. The defaults use the EPP
+    #   standard domain, contact and host 1.0 services.
+    # [<tt>:extensions</tt>]
+    #   URLs to custom extensions to standard EPP. Use these to extend the
+    #   standard EPP (e.g., AFNIC, smallregistry uses extensions). Defaults to
+    #   none.
+    # [<tt>:version</tt>] Set the EPP version. Defaults to "1.0".
+    # [<tt>:ssl_cert</tt>] The file containing the client certificate.
+    # [<tt>:ssl_key</tt>] The file containing the key of the certificate.
+    def initialize(attrs)
+      unless attrs.key?(:server) && attrs.key?(:client_id) && attrs.key?(:password)
+	raise ArgumentError, "server, client_id and password are required"
+      end
+
+      attrs.each do |k,v|
+	begin
+	  self.send("#{k}=", v)
+	rescue NoMethodError
+	  raise ArgumentError, "there is no #{k} argument"
+	end
+      end
+
+      @port ||= 700
+      @lang ||= "en"
+      @services ||= EPPClient::SCHEMAS_URL.values_at('domain', 'contact', 'host')
+      @extensions ||= []
+      @version ||= "1.0"
+      @clTRID ||= "test-#{$$}-#{rand(1000)}"
+      @clTRID_index = 0
+
+      @context ||= OpenSSL::SSL::SSLContext.new
+
+      @logged_in = false
+    end
+
+    def clTRID # :nodoc:
+      @clTRID_index += 1
+      @clTRID + "-#{@clTRID_index}"
+    end
+
+    def debug
+      $DEBUG || ENV['EPP_CLIENT_DEBUG']
+    end
+  end
+end

data/lib/epp-client/connection.rb

@@ -0,0 +1,78 @@
+module EPPClient
+  module Connection
+
+    attr_reader :sent_frame, :recv_frame, :srv_version, :srv_lang, :srv_ns, :srv_ext
+
+    # Establishes the connection to the server, if successful, will return the
+    # greeting frame.
+    def open_connection
+      @tcpserver = TCPSocket.new(server, port)
+      @socket = OpenSSL::SSL::SSLSocket.new(@tcpserver, @context)
+
+      # Synchronously close the connection & socket
+      @socket.sync_close
+
+      # Connect
+      @socket.connect
+
+      # Get the initial greeting frame
+      greeting_process(get_frame)
+    end
+
+    def greeting_process(xml)
+      @srv_version = xml.xpath('epp:epp/epp:greeting/epp:svcMenu/epp:version', EPPClient::SCHEMAS_URL).map {|n| n.text}
+      @srv_lang = xml.xpath('epp:epp/epp:greeting/epp:svcMenu/epp:lang', EPPClient::SCHEMAS_URL).map {|n| n.text}
+      @srv_ns = xml.xpath('epp:epp/epp:greeting/epp:svcMenu/epp:objURI', EPPClient::SCHEMAS_URL).map {|n| n.text}
+      if (ext = xml.xpath('epp:epp/epp:greeting/epp:svcMenu/epp:svcExtension/epp:extURI', EPPClient::SCHEMAS_URL)).size > 0
+	@srv_ext = ext.map {|n| n.text}
+      end
+
+      return xml
+    end
+
+    # Gracefully close the connection
+    def close_connection
+      if defined?(@socket) and @socket.is_a?(OpenSSL::SSL::SSLSocket)
+	@socket.close
+	@socket = nil
+      end
+
+      if defined?(@tcpserver) and @tcpserver.is_a?(TCPSocket)
+	@tcpserver.close
+	@tcpserver = nil
+      end
+
+      return true if @tcpserver.nil? and @socket.nil?
+    end
+
+    # Sends a frame and returns the server's answer
+    def send_request(xml)
+      send_frame(xml)
+      get_frame
+    end
+
+    # sends a frame
+    def send_frame(xml)
+      @sent_frame = xml
+      @socket.write([xml.size + 4].pack("N") + xml)
+      sent_frame_to_xml
+      return
+    end
+
+    # gets a frame from the socket and returns the parsed response.
+    def get_frame
+      size = @socket.read(4)
+      if size.nil?
+	if @socket.eof?
+	  raise SocketError, "Connection closed by remote server"
+	else
+	  raise SocketError, "Error reading frame from remote server"
+	end
+      else
+	size = size.unpack('N')[0]
+	@recv_frame = @socket.read(size - 4)
+	recv_frame_to_xml
+      end
+    end
+  end
+end