nominet-epp 0.0.12 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1baec8eaf94460dfaaffe706aab21f691db5e124
+  data.tar.gz: 18c591b8f71fc9af7ff4b67b6bd600e9c4402f37
+SHA512:
+  metadata.gz: 30bff530d232683cc4b6724c193c562fecd39b4ebfc09208c524c8f4e4a89900038485dd2c34f94714cc09b0088b4aa6afb6c0cbe81bb0f23964ea82b568ed08
+  data.tar.gz: ced5fbd803365d58a870a0e791be50b00f447518cb421a255a2936410ab5f9c8ed0f3d73b99f6384a05724790c19879e24dfd28d6ec126610848be38bf17df54

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/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+bundler_args: --without doc coverage development
+rvm:
+  - 1.9.3
+  - 2.0.0
+matrix:
+  include:
+    - rvm: 1.8.7
+      gemfile: gemfiles/Gemfile.ruby18
+    - rvm: ree
+      gemfile: gemfiles/Gemfile.ruby18
+branches:
+  only:
+    - standard-epp

data/.yardopts

@@ -1,2 +1,8 @@
-lib/**/*.rb -
-History.rdoc LICENSE
+lib/**/*.rb
+--tag internal
+--hide-tag internal
+--private
+--protected
+-r README.md
+-
+HISTORY.md LICENSE

data/Gemfile

@@ -0,0 +1,22 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in nominet-epp.gemspec
+gemspec
+
+gem 'rake'
+gem 'epp-client', :github => "m247/epp-client"
+
+group :development do
+  gem 'pry'
+  gem 'pry-doc'
+  gem 'awesome_print'
+end
+
+group :test do
+  gem 'shoulda'
+end
+
+group :doc do
+  gem 'yard'
+  gem 'redcarpet'
+end

data/Gemfile.lock

@@ -0,0 +1,64 @@
+GIT
+  remote: git://github.com/m247/epp-client.git
+  revision: a07e51fefcc2a68a317cf1200d4d80ce0b7dbfe0
+  specs:
+    epp-client (1.0.0)
+      libxml-ruby
+
+PATH
+  remote: .
+  specs:
+    nominet-epp (1.0.0)
+      epp-client (~> 1.0.0)
+
+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.14)
+    awesome_print (1.2.0)
+    coderay (1.0.9)
+    i18n (0.6.5)
+    libxml-ruby (2.7.0)
+    method_source (0.8.2)
+    minitest (4.7.5)
+    multi_json (1.8.0)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    pry-doc (0.4.6)
+      pry (>= 0.9)
+      yard (>= 0.8)
+    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.4.0)
+      activesupport (>= 3.0.0)
+    slop (3.4.6)
+    thread_safe (0.1.3)
+      atomic
+    tzinfo (0.3.37)
+    yard (0.8.7.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print
+  epp-client!
+  nominet-epp!
+  pry
+  pry-doc
+  rake
+  redcarpet
+  shoulda
+  yard

data/HISTORY.md

@@ -0,0 +1,78 @@
+# NominetEPP History
+
+## 0.0.12 / 2011-05-24
+
+  * Capture +domain:failData+ information from +create+ operation failures.
+
+## 0.0.11 / 2011-05-17
+
+  * Remove setting account:contact[type] attribute as this is not in the schema
+
+## 0.0.10 / 2011-05-04
+
+  * Fix syntax error in helpers.rb
+
+## 0.0.9 / 2011-05-04
+
+  * Correct implementation of Update Operation for domain, account and contact to send
+    the correct sequence of XML elements
+
+## 0.0.8 / 2011-05-03
+
+  * Amend account:contact elements in Create operation to ensure order attribute range
+  * Fix sequencing of elements in account:addr block
+  * Fix sequencing of elements in contact:create block
+  * Fix sequencing of elements in account:create block
+  * Enforce the correct element sequencing for the domain:create operation
+
+## 0.0.7 / 2011-04-21
+
+  * Yank v0.0.6 and bump version to fix bug introduced in v0.0.6
+
+## 0.0.6 / 2011-04-21
+
+  * Fix "Command Syntax Error" response for Create operation with "2y" style periods
+
+## 0.0.5 / 2011-02-24
+
+  * Many bug fixes in Create operation
+  * Support for using `host:update` to modify name server glue information.
+
+## 0.0.4 / 2011-01-31
+
+  * Operations now cache their responses, accessible through `Client#last_response`
+  * Last response messages are available through `Client#last_message`
+
+## 0.0.3 / 2011-01-17
+
+  * Tweak how #poll method works w.r.t blocks
+
+## 0.0.2 / 2011-01-07
+
+  * Add Documentation
+  * Support the 'abuse-limit' on Nominet check operation
+  * Fix issue with info operation XML response parsing
+
+## 0.0.1 / 2010-05-26
+
+  * Add support for 'none' and 'all' options on list operation
+  * Fix bugs in info operation for account objects
+  * Improve handling of XML namespaces and schema locations
+
+## 0.0.0 / 2010-05-25
+
+  * Initial release
+  * Supports the following operations
+    * Create
+    * Delete
+    * Fork
+    * Hello
+    * Info
+    * List
+    * Lock
+    * Merge
+    * Poll
+    * Transfer
+    * Unlock
+    * Unrenew
+    * Update

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010 Geoff Garside
+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

data/README.md

@@ -0,0 +1,23 @@
+# Nominet EPP
+
+Ruby interface to the [Nominet EPP][http://www.nominet.org.uk/registrars/systems/nominetepp] registrar interface.
+
+## Initialise a client
+
+    require 'nominet-epp'
+    client = NominetEPP::Client.new('TAGNAME', 'password')
+    testclient = NominetEPP::Client.new('TAGNAME', 'password', 'testbed-epp.nominet.org.uk')
+
+## Note on Patches/Pull Requests
+ 
+  * Fork the project.
+  * Make your feature addition or bug fix.
+  * Add tests for it. This is important so I don't break it in a
+    future version unintentionally.
+  * Commit, do not mess with rakefile, version, or history.
+    (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+  * Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2010 Geoff Garside (M247 Ltd). See LICENSE for details.

data/Rakefile

@@ -1,25 +1,5 @@
-require 'rubygems'
-require 'rake'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "nominet-epp"
-    gem.summary = %Q{Nominet EPP (Extensible Provisioning Protocol) Client}
-    gem.description = %Q{Client for communicating with the Nominet EPP}
-    gem.email = "geoff@geoffgarside.co.uk"
-    gem.homepage = "http://github.com/geoffgarside/nominet-epp"
-    gem.authors = ["Geoff Garside"]
-    gem.add_development_dependency "shoulda", ">= 0"
-    gem.add_development_dependency "yard", ">= 0"
-
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-    gem.add_dependency "epp-client", ">= 0"
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
 
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
@@ -28,21 +8,6 @@ Rake::TestTask.new(:test) do |test|
   test.verbose = true
 end
 
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/test_*.rb'
-    test.verbose = true
-  end
-rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
-  end
-end
-
-task :test => :check_dependencies
-
 task :default => :test
 
 begin

data/gemfiles/Gemfile.ruby18

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

data/lib/nominet-epp/client.rb

@@ -0,0 +1,364 @@
+module NominetEPP
+  # Front end interface Client to the NominetEPP Service
+  class Client
+    # Standard EPP Services to be used
+    SERVICE_URNS = EPP::Client::DEFAULT_SERVICES
+
+    # Additional Nominet specific service extensions
+    SERVICE_EXTENSION_URNS = %w(
+      urn:ietf:params:xml:ns:secDNS-1.1
+      http://www.nominet.org.uk/epp/xml/domain-nom-ext-1.2
+      http://www.nominet.org.uk/epp/xml/contact-nom-ext-1.0
+      http://www.nominet.org.uk/epp/xml/std-notifications-1.2
+      http://www.nominet.org.uk/epp/xml/std-handshake-1.0
+      http://www.nominet.org.uk/epp/xml/std-warning-1.1
+      http://www.nominet.org.uk/epp/xml/std-release-1.0
+      http://www.nominet.org.uk/epp/xml/std-unrenew-1.0
+      http://www.nominet.org.uk/epp/xml/std-list-1.0
+      http://www.nominet.org.uk/epp/xml/nom-direct-rights-1.0)
+
+    # Create a new instance of NominetEPP::Client
+    #
+    # @param [String] tag Nominet TAG
+    # @param [String] passwd Nominet TAG EPP Password
+    # @param [String] server Nominet EPP Server address (nil forces default)
+    # @param [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, server = 'epp.nominet.org.uk', address_family = nil)
+      @tag, @server = tag, (server || 'epp.nominet.org.uk')
+      @client = EPP::Client.new(@tag, passwd, @server, :services => SERVICE_URNS,
+        :extensions => SERVICE_EXTENSION_URNS, :address_family => address_family)
+    end
+
+    # @see Object#inspect
+    def inspect
+      "#<#{self.class} #{@tag}@#{@server}>"
+    end
+
+    def self.logger=(l)
+      @@logger = l
+    end
+    def self.logger
+      @@logger ||= Logger.new(STDERR).tap do |l|
+        l.level = Logger::ERROR
+      end
+    end
+    def logger
+      self.class.logger
+    end
+
+    # Returns the last EPP::Request sent
+    #
+    # @return [EPP::Request] last sent request
+    def last_request
+      @client.last_request
+    end
+
+    # Returns the last EPP::Response received
+    #
+    # @return [EPP::Response] last received response
+    def last_response
+      @client.last_response
+    end
+
+    # Returns the last EPP message received
+    #
+    # @return [String] last EPP message
+    # @see #last_response
+    def last_message
+      last_response.message
+    end
+
+    # Returns the last Nominet failData response found
+    #
+    # @note This is presently only set by certain method calls,
+    #       so it may not always be present.
+    # @return [Hash] last failData found
+    def last_error_info
+      @error_info || {}
+    end
+
+    def greeting
+      @client._greeting
+    end
+
+    def hello
+      @client.hello
+    end
+
+    def check(entity, *names)
+      check_entity! entity
+
+      mod = module_for_type(entity)
+      req = mod::Check.new(*names)
+      res = @client.check(req.command, req.extension)
+
+      mod::CheckResponse.new(res)
+    end
+
+    def create(entity, name, attributes = {})
+      check_entity! entity
+
+      mod = module_for_type(entity)
+      req = mod::Create.new(name, attributes)
+      res = @client.create(req.command, req.extension)
+
+      mod::CreateResponse.new(res)
+    end
+
+    def delete(entity, name)
+      check_entity! entity
+
+      unless entity == :domain || entity == 'domain'
+        raise ArgumentError, "#{entity} entity is not supported for the delete operation at this time"
+      end
+
+      mod = module_for_type(entity)
+      req = mod::Delete.new(name)
+      res = @client.delete(req.command, req.extension)
+
+      mod::DeleteResponse.new(res)
+    end
+
+    def info(entity, name)
+      check_entity! entity
+
+      mod = module_for_type(entity)
+      req = mod::Info.new(name)
+      res = @client.info(req.command, req.extension)
+
+      mod::InfoResponse.new(res)
+    end
+
+    def poll
+      while res = @client.poll
+        res = Notification.new(res)
+
+        return if res.code != 1301 || res.msgQ['count'] == '0'
+        return [res.msgQ['id'], res] unless block_given?
+
+        result = yield res
+        return if result == false
+
+        raise AckError, "failed to acknowledge #{res.msgQ['id']}" unless @client.ack(res.msgQ['id'])
+      end
+    end
+
+    def ack(msgID)
+      @client.ack(msgID)
+    end
+
+    def release(entity, name, tag)
+      entity = :contact if entity == 'registrant' || entity == :registrant
+      check_entity! entity
+
+      if entity == 'host' || entity == :host
+        raise ArgumentError, "host entity is not support for the release operation"
+      end
+
+      mod = module_for_type(entity)
+      req = mod::Release.new(name, tag)
+      res = @client.update(req.command, req.extension)
+
+      mod::ReleaseResponse.new(res)
+    end
+
+    def renew(name, expiry_date, period = '2y')
+      req = Domain::Renew.new(name, expiry_date, period)
+      res = @client.renew(req.command, req.extension)
+
+      Domain::RenewResponse.new(res)
+    end
+
+    def update(entity, name, changes = {})
+      check_entity! entity
+
+      mod = module_for_type(entity)
+      req = mod::Update.new(name, changes)
+      res = @client.update(req.command, req.extension)
+
+      mod::UpdateResponse.new(res)
+    end
+
+    private
+      def check_entity!(entity)
+        unless [:domain, :contact, :host, 'domain', 'contact', 'host'].include?(entity)
+          raise ArgumentError, "Unsupported entity #{entity}"
+        end
+      end
+      def module_for_type(name)
+        case name
+        when :domain, 'domain'
+          Domain
+        when :contact, 'contact'
+          Contact
+        when :host, 'host'
+          Host
+        end
+      end
+
+      # Wrapper for ActiveSupport::Notifications if available to perform
+      # instrumentation of methods.
+      #
+      # @internal
+      # @param [String,Symbol] name Instrument name. Will be prefixed with "request.nominetepp".
+      # @param [Hash] payload Extra information to be included with the instrumentation data.
+      def instrument(name, payload = {})
+        if defined?(ActiveSupport::Notifications)
+          ActiveSupport::Notifications.instrument("request.nominetepp.#{name}", payload) do
+            yield
+          end
+        else
+          yield
+        end
+      end
+
+    # OldAPI
+    public
+      alias_method :new_check, :check
+      alias_method :new_create, :create
+      alias_method :new_delete, :delete
+      alias_method :new_release, :release
+      alias_method :new_renew, :renew
+      alias_method :new_update, :update
+      alias_method :new_info, :info
+
+      def check(entity, *names)
+        res = new_check(entity, *names)
+
+        if res.respond_to?(:abuse_limit)
+          @check_limit = res.abuse_limit
+        end
+
+        return res.available?(names.first) if names.length == 1
+
+        names.inject({}) do |hash, name|
+          hash[name] = res.available?(name)
+          hash
+        end
+      end
+      def create(entity, name, attributes = {})
+        res = new_create(entity, name, attributes)
+
+        if res.success?
+          case entity
+          when :domain, 'domain'
+            { :name => res.name,
+              :crDate => res.creation_date,
+              :exDate => res.expiration_date }
+          when :contact, 'contact'
+            { :name => res.id,
+              :crDate => res.creation_date }
+          when :host, 'host'
+            { :name => res.id,
+              :crDate => res.creation_date }
+          end
+        else
+          @error_info = { :name => res.message, :reason => res.error_reason }
+          return false
+        end
+      end
+      def delete(entity, name)
+        res = new_delete(entity, name)
+        res.success?
+      end
+      def release(entity, name, tag)
+        res = new_release(entity, name, tag)
+
+        case res.code
+        when 1000
+          { :result => true }
+        when 1001
+          { :result => :handshake }
+        else
+          false
+        end
+      end
+      def renew(name, expiry_date, period = '2y')
+        res = new_renew(name, expiry_date, period)
+
+        return false unless res.success?
+
+        raise "Renewed name #{res.name} does not match #{name}" if res.name != name
+        return res.expiration_date
+      end
+      def update(entity, name, changes = {})
+        res = new_update(entity, name, changes)
+        res.success?
+      end
+      def info(entity, name)
+        res = new_info(entity, name)
+
+        return false unless res.success?
+        return self.send(:"old_info_#{entity}", res)
+      end
+      def old_info_domain(res)
+        nameservers = res.nameservers.map do |ns|
+          h = { :name => ns['name'] }
+          h[:v4] = ns['ipv4'] if ns['ipv4']
+          h[:v6] = ns['ipv6'] if ns['ipv6']
+          h
+        end
+
+        {
+          :name => res.name,
+          :roid => res.roid,
+          :registrant => res.registrant,
+          :ns => nameservers,
+          :host => res.hosts,
+          :clID => res.client_id,
+          :crID => res.creator_id,
+          :crDate => res.created_date,
+          :upDate => res.updated_date,
+          :exDate => res.expiration_date,
+          :reg_status => res.reg_status,
+          :first_bill => res.first_bill,
+          :recur_bill => res.recur_bill,
+          :auto_bill  => res.auto_bill,
+          :auto_period => res.auto_period,
+          :next_bill  => res.next_bill,
+          :next_period => res.next_period,
+          :renew_not_required => res.renew_not_required,
+          :notes => res.notes,
+          :reseller => res.reseller,
+          :ds => res.ds
+        }
+      end
+      def old_info_contact(res)
+        {
+          :id => res.id,
+          :roid => res.roid,
+          :status => res.status[0],
+          :postal_info => res.postal_info,
+          :voice => res.voice,
+          :email => res.email,
+          :clID => res.client_id,
+          :crID => res.creator_id,
+          :crDate => res.created_date,
+          :type => res.type,
+          :trad_name => res.trad_name,
+          :co_no => res.co_no,
+          :opt_out => res.opt_out
+        }
+      end
+      def old_info_host(res)
+        addrs = res.addresses.try(:dup) || {}
+        addrs[:v4] = addrs.delete('ipv4')
+        addrs[:v6] = addrs.delete('ipv6')
+
+        addrs[:v4] = addrs[:v4][0] if addrs[:v4].kind_of?(Array)
+        addrs[:v6] = addrs[:v6][0] if addrs[:v6].kind_of?(Array)
+
+        {
+          :name => res.name,
+          :roid => res.roid,
+          :status => res.status[0],
+          :clID => res.client_id,
+          :crID => res.creator_id,
+          :crDate => res.created_date,
+          :addr => addrs
+        }
+      end
+  end
+end