nominet-epp 0.0.2

data/lib/nominet-epp/operations/transfer.rb

@@ -0,0 +1,84 @@
+module NominetEPP
+  module Operations
+    # EPP Transfer Operation
+    module Transfer
+      # @overload transfer(:release, name, tag, to_account_id = nil)
+      #   @param [String] name Domain to release
+      #   @param [String] tag TAG to release the domain to
+      #   @param [String] to_account_id Specific account ID to release to
+      #   @return [Hash] +{:result => true|:handshake}+ if successfully transferred or pending
+      #   @return [false] transfer failed
+      # @overload transfer(:approve, case_id)
+      #   @param [String] case_id Transfer case to approve
+      #   @return [false] failed
+      #   @return [Hash] of +:case_id+ and array of +:domains+
+      # @overload transfer(:reject, case_id)
+      #   @param [String] case_id Transfer case to reject
+      #   @return [false] failed
+      #   @return [Hash] of +:case_id+ and array of +:domains+
+      # @param [Symbol] type Type of transfer operation
+      # @raise [ArgumentError] type is not one of +:release+, +:approve+ or +:reject+
+      # @see transfer_release
+      # @see transfer_approve
+      # @see transfer_reject
+      def transfer(type, *args)
+        raise ArgumentError, "type must be :release, :approve, :reject" unless [:release, :approve, :reject].include?(type)
+
+        resp = @client.transfer do |transfer|
+          transfer['op'] = type.to_s
+          transfer << self.send(:"transfer_#{type}", *args)
+        end
+
+        if type == :release
+          case resp.code
+          when 1000
+            { :result => true }
+          when 1001
+            { :result => :handshake }
+          else
+            false
+          end
+        else
+          return false unless resp.success?
+          nCase, domainList = resp.data
+          { :case_id => node_value(nCase,'//n:Case/n:case-id'),
+            :domains => domainList.find('//n:domain-name', namespaces).map{|n| n.content.strip} }
+        end
+      end
+
+      private
+        # @param [String] name Domain to release
+        # @param [String] tag TAG to release the domain to
+        # @param [String] to_account_id Specific account ID to release to
+        # @return [XML::Node] +domain:transfer+ payload 
+        def transfer_release(name, tag, to_account_id = nil)
+          domain('transfer') do |node, ns|
+            node << XML::Node.new('name', name, ns)
+            node << XML::Node.new('registrar-tag', tag, ns)
+
+            unless to_account_id.nil?
+              account = XML::Node.new('account', nil, ns)
+              account << XML::Node.new('account-id', to_account_id, ns)
+              node << account
+            end
+          end
+        end
+
+        # @param [String] case_id Transfer case to approve
+        # @return [XML::Node] +notification:case+ payload
+        def transfer_approve(case_id)
+          notification('Case') do |node, ns|
+            node << XML::Node.new('case-id', case_id, ns)
+          end
+        end
+
+        # @param [String] case_id Transfer case to reject
+        # @return [XML::Node] +notification:case+ payload
+        def transfer_reject(case_id)
+          notification('Case') do |node, ns|
+            node << XML::Node.new('case-id', case_id, ns)
+          end
+        end
+    end
+  end
+end

data/lib/nominet-epp/operations/unlock.rb

@@ -0,0 +1,56 @@
+module NominetEPP
+  module Operations
+    # EPP Unlock Operation
+    module Unlock
+      # Unlock domain or account 'investigation' or 'opt-out'
+      #
+      # @param [Symbol] entity Entity to unlock
+      # @param [String] type Type of unlock
+      # @param [String] id Domain name or account ID
+      # @raise [ArgumentError] entity is not +:domain+ or +:account+
+      # @raise [ArgumentError] type is not 'investigation' or 'opt-out'
+      # @return [Boolean] unlocking successful
+      def unlock(entity, type, id)
+        raise ArgumentError, "entity must be :domain or :account" unless [:domain, :account].include?(entity)
+        raise ArgumentError, "type must be 'investigation' or 'opt-out'" unless %w(investigation opt-out).include?(type)
+
+        resp = @client.update do
+          case type
+          when 'investigation'
+            lock_investigation(entity, id)
+          when 'opt-out'
+            lock_opt_out(entity, id)
+          end
+        end
+
+        return resp.success?
+      end
+      private
+        # Create +account:unlock+ XML element for opt-out lock
+        # @param [Symbol] entity Entity to set opt out lock on
+        # @param [String] id Domain name or Account ID to lock
+        # @return [XML::Node] +account:unlock+ element
+        def unlock_opt_out(entity, id)
+          account('unlock') do |node, ns|
+            node['type'] = 'opt-out'
+            node << XML::Node.new((entity == :domain ? 'domain-name' : 'roid'), id, ns)
+          end
+        end
+
+        # Create +unlock+ XML element for investigation lock
+        #
+        # We don't support 'investigation' on account:domain-name as this ability
+        # is already provided via domain:name
+        #
+        # @param [Symbol] entity Entity to set investigation unlock on
+        # @param [String] id Domain name or account ID to set unlock on
+        # @return [XML::Node] +lock+ element
+        def unlock_investigation(entity, id)
+          self.send(entity, 'unlock') do |node, ns|
+            node['type'] = 'investigation'
+            node << XML::Node.new((entity == :domain ? 'name' : 'roid'), id, ns)
+          end
+        end
+    end
+  end
+end

data/lib/nominet-epp/operations/unrenew.rb

@@ -0,0 +1,36 @@
+module NominetEPP
+  module Operations
+    # EPP Unrenew Operation
+    module Unrenew
+      # Reverse a renewal request for one or more domain names.
+      #
+      # Unrenew commands will only be processed if the renewal invoice
+      # has not yet been generated. If the operation is successful, an
+      # email will be sent to the registrant of the domain name notifying
+      # them of the renewal reversal.
+      #
+      # @param [String, ...] *names Domain names to unrenew
+      # @return [false] unrenew failed
+      # @return [Hash<String, Time>] hash of domains and expiry times 
+      def unrenew(*names)
+        resp = @client.update do
+          domain('unrenew') do |node, ns|
+            names.each do |name|
+              node << XML::Node.new('name', name, ns)
+            end
+          end
+        end
+
+        return false unless resp.success?
+
+        hash = {}
+        resp.data.find('//domain:renData', namespaces).each do |node|
+          renName = node_value(node, 'domain:name')
+          renExp  = node_value(node, 'domain:exDate')
+          hash[renName] = Time.parse(renExp)
+        end
+        hash
+      end
+    end
+  end
+end

data/lib/nominet-epp/operations/update.rb

@@ -0,0 +1,67 @@
+module NominetEPP
+  module Operations
+    # EPP Update Operation
+    module Update
+      # @param [Symbol] entity Entity to update
+      # @param [String] id Domain, Account or Contact to update
+      # @param [Hash] fields Fields to update
+      def update(entity, id, fields = {})
+        resp = @client.update do
+          self.send(:"update_#{entity}", id, fields)
+        end
+
+        return resp.success?
+      end
+      private
+        # Generate +domain:update+ payload
+        # @param [String] name Domain name to update
+        # @param [Hash] fields Fields to update on the domain
+        # @return [XML::Node] +domain:update+ payload
+        def update_domain(name, fields)
+          domain('update') do |node, ns|
+            node << XML::Node.new('name', name, ns)
+            fields.each do |k,v|
+              case k
+              when :account
+                node << (d_acct = XML::Node.new('account', nil, ns))
+                d_acct << account('update') do |acct, a_ns|
+                  account_update_xml(v, acct, a_ns)
+                end
+              when :ns
+                node << domain_ns_xml(v, ns)
+              else
+                node << XML::Node.new(k.gsub('_', '-'), v, ns)
+              end
+            end
+          end
+        end
+
+        # Generate +account:update+ payload
+        # @param [String] roid Account ID
+        # @param [Hash] fields Fields to update on the account
+        # @return [XML::Node] +account:update+ payload
+        def update_account(roid, fields = {})
+          account('update') do |node, ns|
+            node << XML::Node.new('roid', roid, ns)
+            account_fields_xml(fields, node, ns)
+          end
+        end
+
+        # Generate +contact:update+ payload
+        # @param [String] roid Contact ID
+        # @param [Hash] fields Fields to update on the contact
+        # @raise [ArgumentError] invalid keys
+        # @return [XML::Node] +contact:update+ payload
+        def update_contact(roid, fields = {})
+          raise ArgumentError, "fields allowed keys name, email, phone, mobile" unless (fields.keys - [:name, :email, :phone, :mobile]).empty?
+
+          contact('update') do |node, ns|
+            node << XML::Node.new('roid', roid, ns)
+            fields.each do |k,v|
+              node << XML::Node.new(k, v, ns)
+            end
+          end
+        end
+    end
+  end
+end

data/nominet-epp.gemspec

@@ -0,0 +1,74 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{nominet-epp}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Geoff Garside"]
+  s.date = %q{2011-01-07}
+  s.description = %q{Client for communicating with the Nominet EPP}
+  s.email = %q{geoff@geoffgarside.co.uk}
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/nominet-epp.rb",
+    "lib/nominet-epp/helpers.rb",
+    "lib/nominet-epp/operations.rb",
+    "lib/nominet-epp/operations/check.rb",
+    "lib/nominet-epp/operations/create.rb",
+    "lib/nominet-epp/operations/delete.rb",
+    "lib/nominet-epp/operations/fork.rb",
+    "lib/nominet-epp/operations/hello.rb",
+    "lib/nominet-epp/operations/info.rb",
+    "lib/nominet-epp/operations/list.rb",
+    "lib/nominet-epp/operations/lock.rb",
+    "lib/nominet-epp/operations/merge.rb",
+    "lib/nominet-epp/operations/poll.rb",
+    "lib/nominet-epp/operations/renew.rb",
+    "lib/nominet-epp/operations/transfer.rb",
+    "lib/nominet-epp/operations/unlock.rb",
+    "lib/nominet-epp/operations/unrenew.rb",
+    "lib/nominet-epp/operations/update.rb",
+    "nominet-epp.gemspec",
+    "test/helper.rb",
+    "test/test_nominet-epp.rb"
+  ]
+  s.homepage = %q{http://github.com/geoffgarside/nominet-epp}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.4.2}
+  s.summary = %q{Nominet EPP (Extensible Provisioning Protocol) Client}
+  s.test_files = [
+    "test/helper.rb",
+    "test/test_nominet-epp.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+      s.add_runtime_dependency(%q<epp-client>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<yard>, [">= 0"])
+      s.add_dependency(%q<epp-client>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<yard>, [">= 0"])
+    s.add_dependency(%q<epp-client>, [">= 0"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'nominet-epp'
+
+class Test::Unit::TestCase
+end

data/test/test_nominet-epp.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestNominetEpp < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification 
+name: nominet-epp
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Geoff Garside
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-07 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: epp-client
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: Client for communicating with the Nominet EPP
+email: geoff@geoffgarside.co.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/nominet-epp.rb
+- lib/nominet-epp/helpers.rb
+- lib/nominet-epp/operations.rb
+- lib/nominet-epp/operations/check.rb
+- lib/nominet-epp/operations/create.rb
+- lib/nominet-epp/operations/delete.rb
+- lib/nominet-epp/operations/fork.rb
+- lib/nominet-epp/operations/hello.rb
+- lib/nominet-epp/operations/info.rb
+- lib/nominet-epp/operations/list.rb
+- lib/nominet-epp/operations/lock.rb
+- lib/nominet-epp/operations/merge.rb
+- lib/nominet-epp/operations/poll.rb
+- lib/nominet-epp/operations/renew.rb
+- lib/nominet-epp/operations/transfer.rb
+- lib/nominet-epp/operations/unlock.rb
+- lib/nominet-epp/operations/unrenew.rb
+- lib/nominet-epp/operations/update.rb
+- nominet-epp.gemspec
+- test/helper.rb
+- test/test_nominet-epp.rb
+has_rdoc: true
+homepage: http://github.com/geoffgarside/nominet-epp
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: Nominet EPP (Extensible Provisioning Protocol) Client
+test_files: 
+- test/helper.rb
+- test/test_nominet-epp.rb