enom 0.9.8 → 0.9.9

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010 James Miller
+Copyright (c) 2011 James Miller
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -3,6 +3,10 @@
 A ruby wrapper for the Enom Domain Registrar's API for checking domain name
 availability, domain contact information, name server settings, etc.
 
+  gem install enom
+
+See the Wiki (https://github.com/bensie/enom/wiki) for usage instructions.
+
 = Copyright
 
-Copyright (c) 2010 James Miller
+Copyright (c) 2011 James Miller

data/bin/enom.rb

@@ -39,7 +39,6 @@ check domain.com                        # Check if a domain is available (for re
 describe domain.com                     # Describe the given domain
 register domain.com                     # Register the given domain with Enom
 renew domain.com                        # Renew the given domain with Enom
-transfer domain.com [authcode]          # Transfer the given domain into Enom
 
 EOF
 end

data/lib/enom/cli.rb

@@ -1,9 +1,6 @@
 require 'yaml'
 module Enom
 
-  class CommandNotFound < RuntimeError; end
-  class InvalidCredentials < RuntimeError; end
-
   class CLI
 
     def initialize
@@ -41,7 +38,7 @@ module Enom
         'check'    => Enom::Commands::CheckDomain,
         'register' => Enom::Commands::RegisterDomain,
         'renew'    => Enom::Commands::RenewDomain,
-        'describe'    => Enom::Commands::DescribeDomain
+        'describe' => Enom::Commands::DescribeDomain
       }
     end
 

data/lib/enom/client.rb

@@ -30,8 +30,6 @@ module Enom
           if response['interface_response']['ErrCount'] == '0'
             return response
           else
-            # Output the entire response if we're running in test mode
-            # p response if test?
             raise InterfaceError, response['interface_response']['errors'].values.join(", ")
           end
         end

data/lib/enom/commands/check_domain.rb

@@ -4,7 +4,9 @@ module Enom
       def execute(args, options={})
         name = args.shift
         response = Domain.check(name)
-        puts "Check domain result for #{name}: #{response}"
+        output = "#{name} is #{response}"
+        puts output
+        return output
       end
     end
   end

data/lib/enom/commands/describe_domain.rb

@@ -10,14 +10,14 @@ module Enom
 
         puts "Name Servers:"
         domain.nameservers.each do |ns|
-          puts "\t#{ns}"
+          puts "\s\s#{ns}"
         end
 
         puts "Contact Info:"
         domain.all_contact_info.each do |k,v|
-          puts "\t#{k}:"
-          v.each do |k,v|
-            puts "\t\t#{k}: #{v}"
+          puts "\s\s#{k}:"
+          v.each do |kk,vv|
+            puts "\s\s\s\s#{kk.gsub(k, '')}: #{vv}"
           end
         end
       end

data/lib/enom/commands/list_domains.rb

@@ -5,9 +5,9 @@ module Enom
         domains = Domain.all
         puts "Found #{domains.length} domains:"
         domains.each do |domain|
-          puts "\t#{domain.name}"
+          puts "\s\s#{domain.name}"
         end
       end
     end
   end
-end
+end

data/lib/enom/commands/register_domain.rb

@@ -4,7 +4,9 @@ module Enom
       def execute(args, options={})
         name = args.shift
         domain = Domain.register!(name)
-        puts "Registered #{domain.name}"
+        output = "Registered #{domain.name}"
+        puts output
+        return output
       end
     end
   end

data/lib/enom/commands/renew_domain.rb

@@ -4,7 +4,9 @@ module Enom
       def execute(args, options={})
         name = args.shift
         domain = Domain.renew!(name)
-        puts "Renewed #{domain.name}"
+        output = "Renewed #{domain.name}"
+        puts output
+        return output
       end
     end
   end

data/lib/enom/contact_info.rb

@@ -32,7 +32,7 @@ module Enom
       # def update_registrant_contact_info(contact_data = {})
       # ...
       # end
-      define_method "update_#{contact_type.downcase}_contact_info" do |contact_data = {}|
+      define_method "update_#{contact_type.downcase}_contact_info" do |contact_data|
 
         # Remove attributes that are not in Enom's list of available fields
         contact_data.select!{|k| FIELDS.map{|f| f[:name] }.include?(k)}

data/lib/enom/domain.rb

@@ -108,6 +108,12 @@ module Enom
     end
     alias_method :locked?, :locked
 
+    # Check if the domain is currently unlocked.  unlocked? helper method also available
+    def unlocked
+      !locked?
+    end
+    alias_method :unlocked?, :unlocked
+
     # Return the DNS nameservers that are currently used for the domain
     def nameservers
       get_extended_domain_attributes unless @nameservers

data/lib/enom/error.rb

@@ -1,5 +1,8 @@
 module Enom
 
+  class CommandNotFound < RuntimeError; end
+  class InvalidCredentials < RuntimeError; end
+
   class Error < StandardError
     def initialize(message)
       super "An error occurred: #{message}"

data/test/account_test.rb

@@ -0,0 +1,15 @@
+require 'test_helper'
+
+class AccountTest < Test::Unit::TestCase
+
+  context "An authorized account" do
+    setup do
+      Enom::Client.username = "resellid"
+      Enom::Client.password = "resellpw"
+    end
+
+    should "return the available account balance" do
+      assert_equal 3669.40, Enom::Account.balance
+    end
+  end
+end

data/test/cli_test.rb

@@ -0,0 +1,45 @@
+require 'test_helper'
+require File.expand_path('../../lib/enom/cli',   __FILE__)
+
+class CliTest < Test::Unit::TestCase
+
+  context "The CLI command" do
+    setup do
+      Enom::Client.username = "resellid"
+      Enom::Client.password = "resellpw"
+      Enom::Client.test = false
+      @cli = Enom::CLI.new
+    end
+
+    context "'check'" do
+      should "indicate an available domain name is available" do
+        assert_equal "test123456test123456.com is available", @cli.execute("check", ["test123456test123456.com"])
+      end
+
+      should "indicate an unavailable domain name is unavailable" do
+        assert_equal "google.com is unavailable", @cli.execute("check", ["google.com"])
+      end
+    end
+
+    context "'register'" do
+      should "register the domain" do
+        assert_equal "Registered test123456test123456.com", @cli.execute("register", ["test123456test123456.com"])
+      end
+    end
+
+    context "'renew'" do
+      should "renew the domain" do
+        assert_equal "Renewed test123456test123456.com", @cli.execute("renew", ["test123456test123456.com"])
+      end
+    end
+
+    # context "'describe'" do
+    #   should "show the domain information" do
+    #     assert_equal "...", @cli.execute("describe", ["test1234test1234.com"])
+    #   end
+    # end
+
+
+  end
+
+end

data/test/client_test.rb

@@ -0,0 +1,34 @@
+require 'test_helper'
+
+class ClientTest < Test::Unit::TestCase
+
+  context "A test connection" do
+    setup do
+      Enom::Client.username = "resellidtest"
+      Enom::Client.password = "resellpwtest"
+      Enom::Client.test = true
+    end
+
+    should "return a test Enom::Client object" do
+      assert_equal "resellidtest", Enom::Client.username
+      assert_equal "resellpwtest", Enom::Client.password
+      assert_equal "https://resellertest.enom.com/interface.asp", Enom::Client.base_uri
+      assert_equal Hash['UID' => 'resellidtest', 'PW' => 'resellpwtest', 'ResponseType' => 'xml'], Enom::Client.default_params
+    end
+  end
+
+  context "A live connection" do
+    setup do
+      Enom::Client.username = "resellid"
+      Enom::Client.password = "resellpw"
+    end
+
+    should "return a real Enom::Client object" do
+      assert_equal "resellid", Enom::Client.username
+      assert_equal "resellpw", Enom::Client.password
+      assert_equal "https://reseller.enom.com/interface.asp", Enom::Client.base_uri
+      assert_equal Hash['UID' => 'resellid', 'PW' => 'resellpw', 'ResponseType' => 'xml'], Enom::Client.default_params
+    end
+  end
+
+end

data/test/domain_test.rb

@@ -0,0 +1,79 @@
+require 'test_helper'
+
+class DomainTest < Test::Unit::TestCase
+
+  context "With a valid account" do
+    setup do
+      Enom::Client.username = "resellid"
+      Enom::Client.password = "resellpw"
+      Enom::Client.test = false
+    end
+
+    context "checking for available domains" do
+      should "return 'available' for an available domain" do
+        assert_equal "available", Enom::Domain.check("test123456test123456.com")
+      end
+      should "return 'unavailable' for an unavailable domain" do
+        assert_equal "unavailable", Enom::Domain.check("google.com")
+      end
+    end
+
+    context "registering a domain" do
+      setup do
+        @domain = Enom::Domain.register!("test123456test123456.com")
+      end
+      should "register the domain and return a domain object" do
+        assert_kind_of Enom::Domain, @domain
+        assert_equal @domain.name, "test123456test123456.com"
+      end
+    end
+
+    context "renewing a domain" do
+      setup do
+        @domain = Enom::Domain.renew!("test123456test123456.com")
+      end
+      should "renew the domain and return a domain object" do
+        assert_kind_of Enom::Domain, @domain
+        assert_equal @domain.name, "test123456test123456.com"
+      end
+    end
+
+    context "finding a domain in your account" do
+      setup do
+        @domain = Enom::Domain.find("test123456test123456.com")
+      end
+
+      should "return a domain object" do
+        assert_kind_of Enom::Domain, @domain
+      end
+
+      should "have corect attributes" do
+        assert_equal "test123456test123456.com", @domain.name
+        assert_equal "test123456test123456", @domain.sld
+        assert_equal "com", @domain.tld
+      end
+
+      should "be registered" do
+        assert @domain.active?
+        assert !@domain.expired?
+      end
+
+      should "be locked" do
+        assert @domain.locked?
+        assert !@domain.unlocked?
+      end
+
+      should "have default Enom nameservers" do
+        nameservers = [
+          "dns1.name-services.com",
+          "dns2.name-services.com",
+          "dns3.name-services.com",
+          "dns4.name-services.com",
+          "dns5.name-services.com"
+        ]
+        assert_equal nameservers, @domain.nameservers
+      end
+    end
+  end
+
+end

data/test/test_helper.rb

@@ -1,3 +1,290 @@
 require 'rubygems'
-require 'active_support'
-require 'active_support/test_case'
+require 'test/unit'
+require 'shoulda'
+require 'fakeweb'
+
+require File.expand_path('../../lib/enom',   __FILE__)
+
+class Test::Unit::TestCase
+
+  FakeWeb.allow_net_connect = false
+
+  commands = [
+    {
+      :command => "Purchase (Success)",
+      :request => "https://reseller.enom.com/interface.asp?Command=Purchase&SLD=test123456test123456&TLD=com&UseDNS=default&UID=resellid&PW=resellpw&ResponseType=xml",
+      :response => <<-EOF
+        <?xml version="1.0"?>
+        <interface-response>
+          <OrderID>157609741</OrderID>
+          <TotalCharged>15</TotalCharged>
+          <RegistrantPartyID>{CF869235-0083-4BB0-99DF-DCEAC6F2294E}</RegistrantPartyID>
+          <RRPCode>200</RRPCode>
+          <RRPText>Command completed successfully - 157609741</RRPText>
+          <Command>PURCHASE</Command>
+          <Language>eng</Language>
+          <ErrCount>0</ErrCount>
+          <ResponseCount>0</ResponseCount>
+          <MinPeriod>1</MinPeriod>
+          <MaxPeriod>10</MaxPeriod>
+          <Server>RESELLERTEST</Server>
+          <Site>eNom</Site>
+          <IsLockable>True</IsLockable>
+          <IsRealTimeTLD>True</IsRealTimeTLD>
+          <TimeDifference>+08.00</TimeDifference>
+          <ExecTime>2.938</ExecTime>
+          <Done>true</Done>
+          <debug><![CDATA[]]></debug>
+        </interface-response>
+      EOF
+    },
+    {
+      :command => "Check (Failure)",
+      :request => "https://reseller.enom.com/interface.asp?Command=Check&SLD=google&TLD=com&UID=resellid&PW=resellpw&ResponseType=xml",
+      :response => <<-EOF
+        <?xml version="1.0"?>
+        <interface-response>
+          <DomainName>google.com</DomainName>
+          <RRPCode>211</RRPCode>
+          <RRPText>Domain not available</RRPText>
+          <AuctionDate/>
+          <AuctionID/>
+          <Command>CHECK</Command>
+          <Language>eng</Language>
+          <ErrCount>0</ErrCount>
+          <ResponseCount>0</ResponseCount>
+          <MinPeriod>1</MinPeriod>
+          <MaxPeriod>10</MaxPeriod>
+          <Server>RESELLERTEST</Server>
+          <Site>eNom</Site>
+          <IsLockable>True</IsLockable>
+          <IsRealTimeTLD>True</IsRealTimeTLD>
+          <TimeDifference>+08.00</TimeDifference>
+          <ExecTime>0.625</ExecTime>
+          <Done>true</Done>
+          <debug><![CDATA[]]></debug>
+        </interface-response>
+      EOF
+    },
+    {
+      :command => "Check (Success)",
+      :request => "https://reseller.enom.com/interface.asp?Command=Check&SLD=test123456test123456&TLD=com&UID=resellid&PW=resellpw&ResponseType=xml",
+      :response => <<-EOF
+        <?xml version="1.0"?>
+        <interface-response>
+          <DomainName>test123456test123456.com</DomainName>
+          <RRPCode>210</RRPCode>
+          <RRPText>Domain available</RRPText>
+          <AuctionDate/>
+          <AuctionID/>
+          <Command>CHECK</Command>
+          <Language>eng</Language>
+          <ErrCount>0</ErrCount>
+          <ResponseCount>0</ResponseCount>
+          <MinPeriod>1</MinPeriod>
+          <MaxPeriod>10</MaxPeriod>
+          <Server>RESELLERTEST</Server>
+          <Site>eNom</Site>
+          <IsLockable>True</IsLockable>
+          <IsRealTimeTLD>True</IsRealTimeTLD>
+          <TimeDifference>+08.00</TimeDifference>
+          <ExecTime>0.672</ExecTime>
+          <Done>true</Done>
+          <debug><![CDATA[]]></debug>
+        </interface-response>
+      EOF
+    },
+    {
+      :command => "GetDomainInfo (Success)",
+      :request => "https://reseller.enom.com/interface.asp?Command=GetDomainInfo&SLD=test123456test123456&TLD=com&UID=resellid&PW=resellpw&ResponseType=xml",
+      :response => <<-EOF
+        <?xml version="1.0"?>
+        <interface-response>
+          <GetDomainInfo>
+            <domainname sld="test123456test123456" tld="com" domainnameid="340724808">test123456test123456.com</domainname>
+            <multy-langSLD>
+        </multy-langSLD>
+            <status>
+              <expiration>1/30/2012 5:23:00 PM</expiration>
+              <escrowliftdate/>
+              <escrowhold/>
+              <deletebydate>1/30/2012 5:23:00 PM</deletebydate>
+              <deletetype/>
+              <registrar>eNom, Inc.</registrar>
+              <registrationstatus>Registered</registrationstatus>
+              <purchase-status>Paid</purchase-status>
+              <belongs-to party-id="{CF869235-0083-4BB0-99DF-DCEAC6F2294E}">resellid</belongs-to>
+            </status>
+            <ParkingEnabled>False</ParkingEnabled>
+            <services>
+              <entry name="dnsserver">
+                <enomDNS value="YES" isDotName="NO"/>
+                <service changable="1">1006</service>
+                <configuration changable="0" type="dns">
+                  <dns>dns1.name-services.com</dns>
+                  <dns>dns2.name-services.com</dns>
+                  <dns>dns3.name-services.com</dns>
+                  <dns>dns4.name-services.com</dns>
+                  <dns>dns5.name-services.com</dns>
+                </configuration>
+              </entry>
+              <entry name="dnssettings">
+                <service changable="0">1021</service>
+                <configuration changable="1" type="host">
+                  <host>
+                    <name><![CDATA[*]]></name>
+                    <type><![CDATA[A]]></type>
+                    <address><![CDATA[69.25.142.5]]></address>
+                    <mxpref><![CDATA[10]]></mxpref>
+                    <iseditable><![CDATA[1]]></iseditable>
+                  </host>
+                  <host>
+                    <name><![CDATA[@]]></name>
+                    <type><![CDATA[A]]></type>
+                    <address><![CDATA[69.25.142.5]]></address>
+                    <mxpref><![CDATA[10]]></mxpref>
+                    <iseditable><![CDATA[1]]></iseditable>
+                  </host>
+                  <host>
+                    <name><![CDATA[www]]></name>
+                    <type><![CDATA[A]]></type>
+                    <address><![CDATA[69.25.142.5]]></address>
+                    <mxpref><![CDATA[10]]></mxpref>
+                    <iseditable><![CDATA[1]]></iseditable>
+                  </host>
+                </configuration>
+              </entry>
+              <entry name="wsb">
+                <service changable="1">1060</service>
+              </entry>
+              <entry name="emailset">
+                <service changable="1">1048</service>
+              </entry>
+              <entry name="wpps">
+                <service changable="1">1123</service>
+              </entry>
+              <entry name="wbl">
+                <wbl>
+                  <statusid><![CDATA[0]]></statusid>
+                  <statusdescr><![CDATA[Available]]></statusdescr>
+                </wbl>
+              </entry>
+              <entry name="mobilizer">
+                <service changable="0">1117</service>
+                <mobilizer/>
+              </entry>
+              <entry name="parking">
+                <service changable="1">1033</service>
+              </entry>
+              <entry name="messaging">
+                <service changable="1">1087</service>
+              </entry>
+              <entry name="map">
+                <service changable="1">1108</service>
+              </entry>
+            </services>
+          </GetDomainInfo>
+          <Command>GETDOMAININFO</Command>
+          <Language>eng</Language>
+          <ErrCount>0</ErrCount>
+          <ResponseCount>0</ResponseCount>
+          <MinPeriod>1</MinPeriod>
+          <MaxPeriod>10</MaxPeriod>
+          <Server>RESELLERTEST</Server>
+          <Site>eNom</Site>
+          <IsLockable>True</IsLockable>
+          <IsRealTimeTLD>True</IsRealTimeTLD>
+          <TimeDifference>+08.00</TimeDifference>
+          <ExecTime>0.344</ExecTime>
+          <Done>true</Done>
+          <debug><![CDATA[]]></debug>
+        </interface-response>
+      EOF
+    },
+    {
+      :command => "Extend (Success)",
+      :request => "https://reseller.enom.com/interface.asp?Command=Extend&SLD=test123456test123456&TLD=com&UID=resellid&PW=resellpw&ResponseType=xml",
+      :response => <<-EOF
+        <?xml version="1.0"?>
+        <interface-response>
+          <Extension>successful</Extension>
+          <DomainName>test123456test123456.com</DomainName>
+          <OrderID>157609742</OrderID>
+          <RRPCode>200</RRPCode>
+          <RRPText>Command completed successfully</RRPText>
+          <Command>EXTEND</Command>
+          <Language>eng</Language>
+          <ErrCount>0</ErrCount>
+          <ResponseCount>0</ResponseCount>
+          <MinPeriod>1</MinPeriod>
+          <MaxPeriod>10</MaxPeriod>
+          <Server>RESELLERTEST</Server>
+          <Site>eNom</Site>
+          <IsLockable>True</IsLockable>
+          <IsRealTimeTLD>True</IsRealTimeTLD>
+          <TimeDifference>+08.00</TimeDifference>
+          <ExecTime>1.453</ExecTime>
+          <Done>true</Done>
+          <debug><![CDATA[]]></debug>
+        </interface-response>
+      EOF
+    },
+    {
+      :command => "GetBalance",
+      :request => "https://reseller.enom.com/interface.asp?Command=GetBalance&UID=resellid&PW=resellpw&ResponseType=xml",
+      :response => <<-EOF
+        <?xml version="1.0"?>
+        <interface-response>
+          <Reseller>1</Reseller>
+          <Balance>3,709.20</Balance>
+          <AvailableBalance>3,669.40</AvailableBalance>
+          <DomainCount>74</DomainCount>
+          <Command>GETBALANCE</Command>
+          <ErrCount>0</ErrCount>
+          <Server>ResellerTest</Server>
+          <Site>enom</Site>
+          <Done>true</Done>
+          <debug><![CDATA[]]></debug>
+        </interface-response>
+      EOF
+    },
+    {
+      :command => "GetRegLock",
+      :request => "https://reseller.enom.com/interface.asp?Command=GetRegLock&SLD=test123456test123456&TLD=com&UID=resellid&PW=resellpw&ResponseType=xml",
+      :response => <<-EOF
+        <?xml version="1.0"?>
+        <interface-response>
+          <reg-lock>1</reg-lock>
+          <registrar>E</registrar>
+          <RRPCode>200</RRPCode>
+          <RRPText>Command completed successfully</RRPText>
+          <Command>GETREGLOCK</Command>
+          <Language>eng</Language>
+          <ErrCount>0</ErrCount>
+          <ResponseCount>0</ResponseCount>
+          <MinPeriod>1</MinPeriod>
+          <MaxPeriod>10</MaxPeriod>
+          <Server>RESELLERTEST</Server>
+          <Site>eNom</Site>
+          <IsLockable>True</IsLockable>
+          <IsRealTimeTLD>True</IsRealTimeTLD>
+          <TimeDifference>+08.00</TimeDifference>
+          <ExecTime>0.375</ExecTime>
+          <Done>true</Done>
+          <debug><![CDATA[]]></debug>
+        </interface-response>
+      EOF
+    }
+  ]
+
+  commands.each do |c|
+    FakeWeb.register_uri(
+      :get,
+      c[:request],
+      :body => c[:response],
+      :content_type => "application/xml",
+      :status => ["200", "OK"]
+    )
+  end
+
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 9
-  - 8
-  version: 0.9.8
+  - 9
+  version: 0.9.9
 platform: ruby
 authors: 
 - James Miller
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-29 00:00:00 -08:00
+date: 2011-01-30 00:00:00 -08:00
 default_executable: enom
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -45,6 +45,19 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
 description: Enom is a Ruby wrapper and command line interface for portions of the Enom domain reseller API.
 email: bensie@gmail.com
 executables: 
@@ -69,7 +82,10 @@ files:
 - lib/enom/commands/list_domains.rb
 - lib/enom/commands/register_domain.rb
 - lib/enom/commands/renew_domain.rb
-- test/enom_test.rb
+- test/account_test.rb
+- test/cli_test.rb
+- test/client_test.rb
+- test/domain_test.rb
 - test/test_helper.rb
 - bin/enom
 - bin/enom.rb

data/test/enom_test.rb

@@ -1,4 +0,0 @@
-require 'test_helper'
-
-class EnomTest < ActiveSupport::TestCase
-end