epp-ruby 3.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1a9a384212937da97b713b5a728f1ee179e0098abbb212b7d91e69c9a0e77415
+  data.tar.gz: cd988b9429ed50c45f23e470d5f8cf4f03a858444df4175d208b732f65eea084
+SHA512:
+  metadata.gz: d5397574a26e6fd0f88696f3d8e48c563e4460d1ef2e474cfc8238946d8824cf124b1dfdbaab5f0c785bf74512081c4c1887fc1c13cac3eff9525e674f1a3e95
+  data.tar.gz: 94abfc7ed00ad710e4063b1139d9e345e6480d0e1f36ac630bb597520b391705f0e891fee624efe6c64348643660779aad4af7c3dfa87a1503d5af56a40d9f72

data/.gitignore

@@ -0,0 +1,24 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+.bundle
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+.yardoc
+doc

data/.simplecov

@@ -0,0 +1,16 @@
+SimpleCov.start do
+  add_group 'Core' do |src_file|
+    File.dirname(src_file.filename) =~ %r</lib(/epp-client)?$>
+  end
+
+  add_group 'Commands',     'lib/epp-client/commands'
+  add_group 'Requests',     'lib/epp-client/requests'
+  add_group 'Responses',    'lib/epp-client/responses'
+  
+  add_group 'EPP Domain',   'lib/epp-client/domain'
+  add_group 'EPP Contact',  'lib/epp-client/contact'
+  add_group 'EPP Host',     'lib/epp-client/host'
+
+  add_filter '/.bundle/'
+  add_filter '/test/'
+end

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+bundler_args: --without doc coverage
+rvm:
+  - 1.9.3
+  - 2.0.0
+matrix:
+  include:
+    - rvm: 1.8.7
+      gemfile: gemfiles/Gemfile.ruby18
+    - rvm: ree
+      gemfile: gemfiles/Gemfile.ruby18

data/.yardopts

@@ -0,0 +1,4 @@
+lib/**/*.rb
+-r README.md
+-
+LICENSE

data/CHANGELOG.md

@@ -0,0 +1,31 @@
+# Changelog
+
+## 3.0.0 (2026-04-03)
+
+Forked from [railsguru/epp-client](https://github.com/railsguru/epp-client) v2.1.0 and published as `epp-ruby`.
+
+### Added
+- Domain list command
+- Transfer handshake command (accept/reject)
+- Domain create response parser
+- Examples for domain create, check, info, contact create, and host create
+
+### Improved
+- Domain create with nameservers, registrant, and auth info support
+- Domain renew with flexible period/unit options
+- Domain transfer with operation type support
+- Contact command improvements
+
+### Fixed
+- Auto-load issues
+- Various bug fixes
+
+## 2.1.0 (2014-07-04)
+
+*Original release by Geoff Garside as epp-client*
+
+- Domain pending response support
+- Period range validations
+- Multiple street support for contacts
+- Host attribute namespace fix
+- Domain info returns all statuses

data/Gemfile

@@ -0,0 +1,20 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in epp-client.gemspec
+gemspec
+
+gem 'rake'
+
+group :doc do
+  gem 'yard'
+  gem 'redcarpet'
+end
+
+group :test do
+  gem 'shoulda'
+  gem 'mocha'
+end
+
+group :coverage do
+  gem 'simplecov', :platforms => [:ruby_19, :ruby_20, :rbx]
+end

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    epp-client (2.1.0)
+      libxml-ruby
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.0.0)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    atomic (1.1.13)
+    i18n (0.6.5)
+    libxml-ruby (2.7.0)
+    metaclass (0.0.1)
+    minitest (4.7.5)
+    mocha (0.14.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.7.9)
+    rake (10.1.0)
+    redcarpet (3.0.0)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.1.5)
+    shoulda-matchers (2.3.0)
+      activesupport (>= 3.0.0)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    thread_safe (0.1.2)
+      atomic
+    tzinfo (0.3.37)
+    yard (0.8.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  epp-client!
+  mocha
+  rake
+  redcarpet
+  shoulda
+  simplecov
+  yard

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2025 Vibol Teav
+Copyright (c) 2010 Geoff Garside (M247 Ltd)
+
+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.md

@@ -0,0 +1,95 @@
+# epp-ruby
+
+Ruby client for communicating with EPP (Extensible Provisioning Protocol) services. Supports domain, contact, and host management including transfer handshake and domain listing.
+
+Maintained fork of [railsguru/epp-client](https://github.com/railsguru/epp-client) with additional features and fixes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'epp-ruby'
+```
+
+Or install it yourself:
+
+```
+$ gem install epp-ruby
+```
+
+## Usage
+
+```ruby
+require 'epp-ruby'
+
+client = EPP::Client.new('username', 'password', 'epp.server.com')
+client.hello
+```
+
+### Domain Check
+
+```ruby
+resp  = client.check EPP::Domain::Check.new('example.com', 'example.net')
+check = EPP::Domain::CheckResponse.new(resp)
+check.available?('example.com') #=> true
+check.available?('example.net') #=> false
+```
+
+### Domain Info
+
+```ruby
+resp = client.info EPP::Domain::Info.new('example.com')
+info = EPP::Domain::InfoResponse.new(resp)
+info.name         #=> "example.com"
+info.nameservers  #=> [{"name"=>"ns1.example.net"}]
+```
+
+### Domain Create
+
+```ruby
+resp = client.create EPP::Domain::Create.new('example.com', period: 1, unit: 'y',
+  nameservers: ['ns1.example.net', 'ns2.example.net'],
+  registrant: 'contact-id',
+  auth_info: 'secret123')
+create = EPP::Domain::CreateResponse.new(resp)
+```
+
+### Domain Transfer
+
+```ruby
+resp = client.transfer EPP::Domain::Transfer.new('example.com', 'auth-code', op: 'request')
+```
+
+### Domain List
+
+```ruby
+resp = client.list EPP::Domain::List.new
+```
+
+### Transfer Handshake (Accept/Reject)
+
+```ruby
+resp = client.transfer_handshake EPP::Commands::TransferHandshake.new('example.com', op: 'approve')
+```
+
+## Available Commands
+
+* `check` — check domain/contact/host availability
+* `create` — register domains, contacts, or hosts
+* `delete` — remove domains, contacts, or hosts
+* `info` — query domain/contact/host details
+* `renew` — renew domain registration
+* `transfer` — initiate or query domain transfers
+* `transfer_handshake` — accept or reject pending transfers
+* `update` — modify domains, contacts, or hosts
+* `poll` / `ack` — poll for and acknowledge messages
+* `list` — list domains
+
+## History
+
+This gem is a maintained fork of [epp-client](https://github.com/railsguru/epp-client) (v2.1.0) by Geoff Garside, which has been inactive since 2014. It adds transfer handshake support, domain listing, improved domain create/renew, and various bug fixes.
+
+## License
+
+MIT

data/Rakefile

@@ -0,0 +1,20 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/epp-ruby.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/epp-client/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Vibol Teav", "Geoff Garside"]
+  gem.email         = ["vibolteav@gmail.com"]
+  gem.description   = %q{Ruby client for communicating with EPP (Extensible Provisioning Protocol) services. Supports domain, contact, and host management with transfer handshake and domain listing.}
+  gem.summary       = %q{EPP (Extensible Provisioning Protocol) client for Ruby}
+  gem.homepage      = "https://github.com/tvcam/epp-ruby"
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "epp-ruby"
+  gem.require_paths = ["lib"]
+  gem.version       = EPP::VERSION
+
+  gem.extra_rdoc_files = %w(LICENSE README.md)
+
+  gem.add_dependency 'libxml-ruby'
+end

data/examples/contact_create.rb

@@ -0,0 +1,28 @@
+require 'rubygems'
+require 'epp-client'
+
+client = EPP::Client.new('USERNAME', 'password', 'epp.test.host')
+
+command = EPP::Contact::Create.new('admin123',
+  postal_info: {
+    name: 'Test User',
+    org: 'Test Organisation',
+    addr: {
+      street: "Test Building\n14 Test Road",
+      city: "Test City",
+      sp: "Test Province",
+      pc: "TE57 1NG",
+      cc: "GB"
+    }
+  },
+  voice: '+44.1614960000',
+  fax: '+44.1614960001',
+  email: 'user@test.host',
+  auth_info: { pw: '324723984' },
+  disclose: { "0" => %w(voice email)}
+)
+
+resp = client.create command
+result = EPP::Contact::CreateResponse.new(resp)
+result.id             #=> "admin123"
+result.creation_date  #=> 2014-11-27 11:15:04 +0000

data/examples/domain_check.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'epp-client'
+
+client = EPP::Client.new('USERNAME', 'password', 'epp.test.host')
+
+resp  = client.check EPP::Domain::Check.new('example.com', 'example.net', 'example.org')
+check = EPP::Domain::CheckResponse.new(resp)
+
+check.available?('example.com') #=> true
+check.available?('example.net') #=> false
+check.available?('example.org') #=> false

data/examples/domain_create.rb

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'epp-client'
+
+client = EPP::Client.new('USERNAME', 'password', 'epp.test.host')
+
+command = EPP::Domain::Create.new('example.com',
+  period: '1y', registrant: 'test9023742684',
+  auth_info: { pw: 'domainpassword' },
+  contacts: { admin: 'admin123', tech: 'admin123', billing: 'admin123' },
+  nameservers: [
+    {name: 'ns1.example.com', ipv4: '198.51.100.53'}
+    {name: 'ns2.example.com', ipv4: '198.51.100.54'}
+  ]
+)
+
+resp = client.create command
+result = EPP::Domain::CreateResponse.new(resp)
+result.name             #=> "example.com"
+result.expiration_date  #=> 2014-11-27 11:15:04 +0000

data/examples/domain_info.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'epp-client'
+
+client = EPP::Client.new('USERNAME', 'password', 'epp.test.host')
+
+resp = client.info EPP::Domain::Info.new('example.com')
+info = EPP::Domain::InfoResponse.new(resp)
+info.name         #=> "example.com"
+info.nameservers  #=> [{"name"=>"ns1.example.net"},{"name"=>"ns2.example.net"}]

data/examples/host_create.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'epp-client'
+
+client = EPP::Client.new('USERNAME', 'password', 'epp.test.host')
+
+command = EPP::Host::Create.new('ns1.example.com',
+  ipv4: "198.51.100.53",
+  ipv6: "2001:db8::53:1"
+)
+
+resp = client.create command
+result = EPP::Host::CreateResponse.new(resp)
+result.name           #=> "ns1.example.com"
+result.creation_date  #=> 2014-11-27 11:15:04 +0000

data/gemfiles/Gemfile.ruby18

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in epp-client.gemspec
+gemspec :path => '../'
+
+gem 'rake'
+gem 'i18n', '~> 0.6.11'
+gem 'activesupport', '~> 3.2.14'
+
+group :test do
+  gem 'shoulda-matchers', '~> 1.5.6'
+  gem 'shoulda'
+  gem 'mocha'
+end

data/lib/epp-client/client.rb

@@ -0,0 +1,172 @@
+module EPP
+  # Front facing EPP Client.
+  #
+  # Establishes a connection to an EPP server and allows for sending commands
+  # to that EPP server.
+  class Client
+    # Default Service URNs
+    #
+    # Provided to make it easier for clients to add additional services to
+    # the default list.
+    #
+    # @example
+    #   services = DEFAULT_SERVICES + %w(urn:ietf:params:xml:ns:secDNS-1.1)
+    #   EPP::Client.new('username','password','epp.example.com', :services => services)
+    DEFAULT_SERVICES = [ Domain::NAMESPACE, Contact::NAMESPACE, Host::NAMESPACE ]
+
+    # Create new instance of EPP::Client.
+    #
+    # @param [String] tag EPP Tag
+    # @param [String] passwd EPP Tag password
+    # @param [String] host EPP Host address
+    # @param [Hash] options Options
+    # @option options [Integer] :port EPP Port number, default 700
+    # @option options [OpenSSL::SSL::SSLContext] :ssl_context For client certificate auth
+    # @option options [Boolean] :compatibility Compatibility mode, default false
+    # @option options [String] :lang EPP Language code, default 'en'
+    # @option options [String] :version EPP protocol version, default '1.0'
+    # @option options [Array<String>] :extensions EPP Extension URNs
+    # @option options [Array<String>] :services EPP Service URNs
+    # @option options [String] :address_family 'AF_INET' or 'AF_INET6' or either of the
+    #                          appropriate socket constants. Will cause connections to be
+    #                          limited to this address family. Default try all addresses.
+
+    def initialize(tag, passwd, host, options = {})
+      @tag, @passwd, @host, @options = tag, passwd, host, options
+      @conn = if options.delete(:compatibility) == true
+        OldServer.new(tag, passwd, host, options)
+      else
+        Server.new(tag, passwd, host, options)
+      end
+    end
+
+    attr_reader :tag, :passwd, :host, :options
+
+    def compatibility?
+      @conn.is_a?(OldServer)
+    end
+
+    # Returns the last request sent to the EPP server
+    #
+    # @return [Request] last request sent to the EPP server
+    def last_request
+      @conn.last_request
+    end
+
+    # Returns the last request sent to the EPP server
+    #
+    # @deprecated
+    # @return [Request] last request sent to the EPP server
+    def _last_request
+      warn "The #{self.class}#_last_request method is deprecated, please call #last_request"
+      last_request
+    end
+
+    # Returns the last response received from the EPP server
+    #
+    # @return [Response] last response received from the EPP server
+    def last_response
+      @conn.last_response
+    end
+
+    # Returns the last response received from the EPP server
+    #
+    # @deprecated
+    # @return [Response] last response received from the EPP server
+    def _last_response
+      warn "The #{self.class}#_last_response method is deprecated, please call #last_response"
+      last_response
+    end
+
+    # Returns the last error received from a login or logout request
+    #
+    # @return [ResponseError] last error received from login/logout request
+    def last_error
+      @conn.last_error
+    end
+
+    # Returns the last error received from a login or logout request
+    #
+    # @deprecated
+    # @return [ResponseError] last error received from login/logout request
+    def _last_error
+      warn "The #{self.class}#_last_error method is deprecated, please call #last_error"
+      last_error
+    end
+
+    def greeting
+      @conn.greeting
+    end
+
+    # Send hello command
+    def hello
+      @conn.connection do
+        @conn.hello
+      end
+    end
+
+    def check(payload, extension = nil)
+      check = EPP::Commands::Check.new(payload)
+      command(check, extension)
+    end
+
+    def create(payload, extension = nil)
+      create = EPP::Commands::Create.new(payload)
+      command(create, extension)
+    end
+
+    def delete(payload, extension = nil)
+      delete = EPP::Commands::Delete.new(payload)
+      command(delete, extension)
+    end
+
+    def info(payload, extension = nil)
+      info = EPP::Commands::Info.new(payload)
+      command(info, extension)
+    end
+
+    def renew(payload, extension = nil)
+      renew = EPP::Commands::Renew.new(payload)
+      command(renew, extension)
+    end
+
+    def transfer(op, payload, extension = nil)
+      transfer = EPP::Commands::Transfer.new(op, payload)
+      command(transfer, extension)
+    end
+
+    def update(payload, extension = nil)
+      update = EPP::Commands::Update.new(payload)
+      command(update, extension)
+    end
+
+    def accept_transfer(case_id)
+      accept_transfer = EPP::Commands::TransferHandshake.new(case_id, handshake: 'accept')
+      command(accept_transfer)
+    end
+
+    def reject_transfer(case_id)
+      reject_transfer = EPP::Commands::TransferHandshake.new(case_id, handshake: 'reject')
+      command(reject_transfer)
+    end
+
+    def poll
+      poll = EPP::Commands::Poll.new
+      command(poll)
+    end
+    
+    def ack(msgID)
+      ack = EPP::Commands::Poll.new(msgID)
+      command(ack)
+    end
+
+    protected
+      def command(cmd, extension = nil)
+        @conn.connection do
+          @conn.with_login do
+            @conn.request(cmd, extension)
+          end
+        end
+      end
+  end
+end

data/lib/epp-client/commands/check.rb

@@ -0,0 +1,11 @@
+require File.expand_path('../read_write_command', __FILE__)
+
+module EPP
+  module Commands
+    class Check < ReadWriteCommand
+      def name
+        'check'
+      end
+    end
+  end
+end

data/lib/epp-client/commands/command.rb

@@ -0,0 +1,24 @@
+module EPP
+  module Commands
+    class Command
+      include XMLHelpers
+
+      def set_namespaces(namespaces)
+        @namespaces = namespaces
+      end
+
+      # Receiver in XML form
+      # @return [XML::Document] XML of the receiver
+      def to_xml
+        epp_node(name, @namespaces || {})
+      end
+
+      # Convert the receiver to a string
+      #
+      # @param [Hash] opts Formatting options, passed to the XML::Document
+      def to_s(opts = {})
+        to_xml.to_s({:indent => false}.merge(opts))
+      end
+    end
+  end
+end

data/lib/epp-client/commands/create.rb

@@ -0,0 +1,11 @@
+require File.expand_path('../read_write_command', __FILE__)
+
+module EPP
+  module Commands
+    class Create < ReadWriteCommand
+      def name
+        'create'
+      end
+    end
+  end
+end

data/lib/epp-client/commands/delete.rb

@@ -0,0 +1,11 @@
+require File.expand_path('../read_write_command', __FILE__)
+
+module EPP
+  module Commands
+    class Delete < ReadWriteCommand
+      def name
+        'delete'
+      end
+    end
+  end
+end

data/lib/epp-client/commands/info.rb

@@ -0,0 +1,11 @@
+require File.expand_path('../read_write_command', __FILE__)
+
+module EPP
+  module Commands
+    class Info < ReadWriteCommand
+      def name
+        'info'
+      end
+    end
+  end
+end