epp-client-smallregistry 0.11.0

data/ChangeLog

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

data/EXAMPLE.SMALLREGISTRY

@@ -0,0 +1,61 @@
+#!/usr/bin/env ruby
+
+require 'pp'
+require 'rubygems'
+require 'epp-client/smallregistry'
+
+c = EPPClient::SmallRegistry.new(
+  :client_id => 'test',
+  :password => 'test',
+  :ssl_cert => 'test.crt',
+  :ssl_key => 'test.key',
+  :test => true
+)
+
+begin
+
+  c.open_connection
+  c.login
+  pp c.domain_check('mat.cc', 'bidule-truc.aeroport.fr', 'truc-chose.aeroport.fr')
+  pp c.domain_info('truc-chose.aeroport.fr')
+  pp c.contact_check('PP1-SMALL', 'PP2-SMALL', 'foobar')
+  pp c.contact_info('PP1-SMALL')
+  pp contact = c.contact_create( {
+    :email=>"foo@example.org",
+    :authInfo => "foobar",
+    :voice=>"+33.821801821",
+    :postalInfo=> { "loc"=> { :addr=> { :city=>"Paris", :cc=>"FR", :pc=>"75001", :street=>["BP 18", "1, rue Royale"] }, :name=>"Dupond, Jean", :org => "FooBar Inc." }, },
+    # l'un ou l'autre
+    #:person => { :birthDate => '1978-01-01', :birthPlace => 'Paris', },
+    :org => { :companySerial => '505404125', },
+  })
+  pp c.contact_info(contact[:id])
+  pp c.contact_update({
+    :id => contact[:id],
+    :chg => {
+    :email => 'bazar@example.com',
+    :org => { :companySerial => '505404126', },
+  }})
+  pp c.contact_delete(contact[:id])
+  pp c.contact_info(contact[:id])
+  pp c.domain_create({
+    :registrant => "PP1-SMALL",
+    :contacts => {:billing => ["PP1-SMALL"], :tech => ["PP1-SMALL"], :admin => ["PP1-SMALL"]},
+    :ns => ["ns1.absolight.net", "ns2.absolight.net", "ns3.absolight.net", "ns4.absolight.net"], 
+    #:ns => [{:hostAddrv4 => ["1.2.3.4", "1.4.2.3"], :hostName => "ns1.truc-#{$$}.aeroport.fr"}, {:hostAddrv4 => ["1.2.3.5"], :hostAddrv6 => ["2a01:678::1", "2a01:678::2"], :hostName => "ns2.truc-#{$$}.aeroport.fr"}],
+    :name => "truc-#{$$}.aeroport.fr",
+    :authInfo => "PN16IZ0V-XLYDZC-AT70X58L"
+  })
+  pp c.domain_info("truc-#{$$}.aeroport.fr")
+  pp c.domain_update({
+    :name => "truc-#{$$}.aeroport.fr",
+    :chg => { :authInfo => 'Bazar' },
+    :rem => {
+      :ns => ["ns4.absolight.net"],
+    }
+  })
+  pp c.domain_info("truc-#{$$}.aeroport.fr")
+  pp c.domain_delete('truc-70487.aeroport.fr')
+ensure
+  c.logout
+end

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-smallregistry.gemspec

@@ -0,0 +1,36 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/epp-client/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = 'epp-client-smallregistry'
+  gem.version       = EPPClient::VERSION
+  gem.date          = '2010-05-14'
+  gem.authors       = ['Mathieu Arnold']
+  gem.email         = ['m@absolight.fr']
+  gem.description   = 'Smallregistry EPP client library.'
+  gem.summary       = 'Smallregistry 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',
+    'EXAMPLE.SMALLREGISTRY',
+    'Gemfile',
+    'MIT-LICENSE',
+    'README',
+    'Rakefile',
+    'epp-client-smallregistry.gemspec',
+    'lib/epp-client/smallregistry.rb',
+    'vendor/smallregistry/sr-1.0.xsd',
+  ]
+
+  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')
+  gem.add_dependency('epp-client-base',  "~> #{EPPClient::VERSION}")
+end

data/lib/epp-client/smallregistry.rb

@@ -0,0 +1,174 @@
+require 'epp-client/base'
+
+module EPPClient
+  class SmallRegistry < Base
+
+    SCHEMAS_SR = %w[
+      sr-1.0
+    ]
+
+    EPPClient::SCHEMAS_URL.merge!(SCHEMAS_SR.inject({}) do |a,s|
+      a[s.sub(/-1\.0$/, '')] = "https://www.smallregistry.net/schemas/#{s}.xsd" if s =~ /-1\.0$/
+      a[s] = "https://www.smallregistry.net/schemas/#{s}.xsd"
+      a
+    end)
+
+    #
+    # Sets the default for Smallregistry, that is, server and port, according
+    # to Smallregistry's documentation.
+    # https://www.smallregistry.net/faqs/quelles-sont-les-specificites-du-serveur-epp
+    #
+    # ==== Required Attributes
+    #
+    # [<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.
+    # [<tt>:ssl_cert</tt>] the file containing the client certificate.
+    # [<tt>:ssl_key</tt>] the file containing the key of the certificate.
+    #
+    # ==== Optional Attributes
+    # [<tt>:test</tt>] sets the server to be the test server.
+    #
+    # See EPPClient for other attributes.
+    def initialize(attrs)
+      unless attrs.key?(:client_id) && attrs.key?(:password) && attrs.key?(:ssl_cert) && attrs.key?(:ssl_key)
+	raise ArgumentError, "client_id, password, ssl_cert and ssl_key are required"
+      end
+      if attrs.delete(:test) == true
+	attrs[:server] ||= 'epp.test.smallregistry.net'
+	attrs[:port] ||= 2700
+      else
+	attrs[:server] ||= 'epp.smallregistry.net'
+	attrs[:port] ||= 700
+      end
+      @services = EPPClient::SCHEMAS_URL.values_at('domain', 'contact')
+      super(attrs)
+      @extensions << EPPClient::SCHEMAS_URL['sr']
+    end
+
+    # Extends the base contact info so that the specific smallregistry's
+    # informations are processed, the additionnal informations are :
+    #
+    # one of :
+    # [<tt>:org</tt>]
+    #   indicating that the contact is an organisation with the following
+    #   informations :
+    #   [<tt>:companySerial</tt>]
+    #     the company's SIREN / RPPS / whatever serial number is required.
+    # [<tt>:person</tt>]
+    #   indicating that the contact is a human person with the following
+    #   informations :
+    #   [<tt>:birthDate</tt>] the person's birth date.
+    #   [<tt>:birthPlace</tt>] the person's birth place.
+    def contact_info(xml)
+      super # placeholder so that I can add some doc
+    end 
+
+    def contact_info_process(xml) #:nodoc:
+      ret = super
+      if (contact = xml.xpath('epp:extension/sr:ext/sr:infData/sr:contact', EPPClient::SCHEMAS_URL)).size > 0
+	if (person = contact.xpath('sr:person', EPPClient::SCHEMAS_URL)).size > 0
+	  ret[:person] = {
+	    :birthDate => Date.parse(person.xpath('sr:birthDate', EPPClient::SCHEMAS_URL).text),
+	    :birthPlace => person.xpath('sr:birthPlace', EPPClient::SCHEMAS_URL).text,
+	  }
+	end
+	if (org = contact.xpath('sr:org', EPPClient::SCHEMAS_URL)).size > 0
+	  ret[:org] = { :companySerial => org.xpath('sr:companySerial', EPPClient::SCHEMAS_URL).text }
+	end
+      end
+      ret
+    end
+
+    # Extends the base contact create so that the specific smallregistry's
+    # information are sent, the additionnal informations are :
+    #
+    # one of :
+    # [<tt>:org</tt>]
+    #   indicating that the contact is an organisation with the following
+    #   informations :
+    #   [<tt>:companySerial</tt>]
+    #     the company's SIREN / RPPS / whatever serial number is required.
+    # [<tt>:person</tt>]
+    #   indicating that the contact is a human person with the following
+    #   informations :
+    #   [<tt>:birthDate</tt>] the person's birth date.
+    #   [<tt>:birthPlace</tt>] the person's birth place.
+    def contact_create(contact)
+      super # placeholder so that I can add some doc
+    end
+
+    def contact_create_xml(contact) #:nodoc:
+      ret = super
+
+      ext = extension do |xml|
+	xml.ext( :xmlns => EPPClient::SCHEMAS_URL['sr']) do
+	  xml.create do
+	    xml.contact do
+	      if contact.key?(:org)
+		xml.org do
+		  xml.companySerial(contact[:org][:companySerial])
+		end
+	      elsif contact.key?(:person)
+		xml.person do
+		  xml.birthDate(contact[:person][:birthDate])
+		  xml.birthPlace(contact[:person][:birthPlace])
+		end
+	      end
+	    end
+	  end
+	end
+      end
+
+      insert_extension(ret, ext)
+    end
+
+    def contact_update_xml(args) #:nodoc:
+      ret = super
+
+      if args.key?(:chg) && (args[:chg].key?(:org) || args[:chg].key?(:person))
+	ext = extension do |xml|
+	  xml.ext( :xmlns => EPPClient::SCHEMAS_URL['sr']) do
+	    xml.update do
+	      xml.contact do
+		if args[:chg].key?(:org)
+		  xml.org do
+		    xml.companySerial(args[:chg][:org][:companySerial])
+		  end
+		elsif args[:chg].key?(:person)
+		  xml.person do
+		    xml.birthDate(args[:chg][:person][:birthDate])
+		    xml.birthPlace(args[:chg][:person][:birthPlace])
+		  end
+		end
+	      end
+	    end
+	  end
+	end
+
+	return insert_extension(ret, ext)
+      else
+	return ret
+      end
+    end
+
+    # Extends the base contact update so that the specific afnic update
+    # informations can be sent, the additionnal informations are :
+    #
+    # [<tt>:chg</tt>]
+    #   changes one of :
+    #   [<tt>:org</tt>]
+    #     indicating that the contact is an organisation with the following
+    #     informations :
+    #       [<tt>:companySerial</tt>]
+    #         the company's SIREN / RPPS / whatever serial number is required.
+    #   [<tt>:person</tt>]
+    #     indicating that the contact is a human person with the following
+    #     informations :
+    #     [<tt>:birthDate</tt>] the person's birth date.
+    #     [<tt>:birthPlace</tt>] the person's birth place.
+    #
+    def contact_update(args)
+      super # placeholder so that I can add some doc
+    end
+  end
+end

data/vendor/smallregistry/sr-1.0.xsd

@@ -0,0 +1,76 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<schema targetNamespace="https://www.smallregistry.net/schemas/sr-1.0.xsd"
+       xmlns:sr="https://www.smallregistry.net/schemas/sr-1.0.xsd"
+       xmlns:contact="urn:ietf:params:xml:ns:contact-1.0"
+       xmlns:epp="urn:ietf:params:xml:ns:epp-1.0"
+       xmlns:eppcom="urn:ietf:params:xml:ns:eppcom-1.0"
+       xmlns="http://www.w3.org/2001/XMLSchema"
+       elementFormDefault="qualified">
+
+<!--
+Import common element types.
+-->
+ <import namespace="urn:ietf:params:xml:ns:eppcom-1.0" schemaLocation="vendor/ietf/eppcom-1.0.xsd"/>
+ <import namespace="urn:ietf:params:xml:ns:epp-1.0" schemaLocation="vendor/ietf/epp-1.0.xsd"/>
+ <import namespace="urn:ietf:params:xml:ns:contact-1.0" schemaLocation="vendor/ietf/contact-1.0.xsd"/>
+
+ <annotation>
+   <documentation>
+     Extensible Provisioning Protocol v1.0
+     SmallRegistry extensions.
+   </documentation>
+ </annotation>
+
+ <element name="ext" type="sr:extType"/>
+
+ <complexType name="extType">
+   <choice>
+     <element name="infData" type="sr:infDataType"/>
+     <element name="create" type="sr:createType"/>
+     <element name="update" type="sr:updateType"/>
+   </choice>
+ </complexType>
+
+ <complexType name="infDataType">
+   <choice>
+     <element name="contact" type="sr:contactType"/>
+   </choice>
+ </complexType>
+
+ <complexType name="createType">
+   <choice>
+     <element name="contact" type="sr:contactType"/>
+   </choice>
+ </complexType>
+
+ <complexType name="updateType">
+   <choice>
+     <element name="contact" type="sr:contactType"/>
+   </choice>
+ </complexType>
+
+ <complexType name="contactType">
+   <choice>
+     <element name="org" type="sr:legalEntity"/>
+     <element name="person" type="sr:physicalPerson"/>
+   </choice>
+ </complexType>
+
+ <complexType name="legalEntity">
+   <sequence>
+     <element name="companySerial" type="eppcom:minTokenType"/>
+   </sequence>
+ </complexType>
+
+ <complexType name="physicalPerson">
+   <sequence>
+     <element name="birthDate" type="date"/>
+     <element name="birthPlace" type="eppcom:minTokenType"/>
+   </sequence>
+ </complexType>
+
+<!--
+End of schema.
+-->
+</schema>

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification 
+name: epp-client-smallregistry
+version: !ruby/object:Gem::Version 
+  hash: 51
+  prerelease: 
+  segments: 
+  - 0
+  - 11
+  - 0
+  version: 0.11.0
+platform: ruby
+authors: 
+- Mathieu Arnold
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-14 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 4
+        version: "1.4"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: builder
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 1
+        - 2
+        version: 2.1.2
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: epp-client-base
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 51
+        segments: 
+        - 0
+        - 11
+        - 0
+        version: 0.11.0
+  type: :runtime
+  version_requirements: *id004
+description: Smallregistry EPP client library.
+email: 
+- m@absolight.fr
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- ChangeLog
+- EXAMPLE.SMALLREGISTRY
+- Gemfile
+- MIT-LICENSE
+- README
+- Rakefile
+- epp-client-smallregistry.gemspec
+- lib/epp-client/smallregistry.rb
+- vendor/smallregistry/sr-1.0.xsd
+homepage: https://github.com/Absolight/epp-client
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 57
+      segments: 
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.16
+signing_key: 
+specification_version: 3
+summary: Smallregistry EPP client library
+test_files: []
+