enom 0.0.1 → 0.9.0

data/lib/enom.rb

@@ -1,9 +1,8 @@
-require 'rest_client'
-require 'crack/xml'
-require File.expand_path(File.dirname(__FILE__) + '/enom/client')
-require File.expand_path(File.dirname(__FILE__) + '/enom/domain')
+require 'httparty'
 
-module Enom
-  class InterfaceError < StandardError; end
-  class InvalidNameServerCount < StandardError; end
-end
+require 'enom/client'
+require 'enom/domain'
+require 'enom/account'
+require 'enom/error'
+
+module Enom; end

data/lib/enom/account.rb

@@ -0,0 +1,9 @@
+module Enom
+  class Account
+
+    def self.balance
+      Client.request('Command' => 'GetBalance')['interface_response']['AvailableBalance'].gsub(',', '').to_f
+    end
+
+  end
+end

data/lib/enom/cli.rb

@@ -0,0 +1,50 @@
+require 'yaml'
+module Enom
+
+  class CommandNotFound < RuntimeError; end
+
+  class CLI
+
+    def initialize
+      Client.username = "test"
+      Client.password = "password"
+    end
+
+    def execute(command_name, args, options={})
+      command = commands[command_name]
+      if command
+        begin
+          command.new.execute(args, options)
+        rescue Enom::Error => e
+          puts "An error occurred: #{e.message}"
+        rescue RuntimeError => e
+          puts "An error occurred: #{e.message}"
+        end
+      else
+        raise CommandNotFound, "Unknown command: #{command_name}"
+      end
+    end
+
+    def commands
+      {
+        'info' => Enom::Commands::DescribeAccount,
+        'check' => Enom::Commands::CheckDomain,
+        'register' => Enom::Commands::RegisterDomain,
+        # 'renew' => Enom::Commands::RenewDomain,
+        # 'transfer' => Enom::Commands::TransferDomain,
+        # 'describe' => Enom::Commands::DescribeDomain,
+        'list' => Enom::Commands::ListDomains,
+        # 'lock' => Enom::Commands::LockDomain,
+        # 'unlock' => Enom::Commands::UnlockDomain,
+        # 'nameservers:list' => Enom::Commands::ListNameservers,
+        # 'nameservers:set' => Enom::Commands::SetNameservers
+      }
+    end
+
+    require 'enom/commands/describe_account'
+    require 'enom/commands/check_domain'
+    require 'enom/commands/register_domain'
+    require 'enom/commands/list_domains'
+
+  end
+end

data/lib/enom/client.rb

@@ -1,43 +1,40 @@
-require 'cgi'
 module Enom
 
   class Client
+    include HTTParty
 
-    def initialize(username, password, ssl = true, test = false)
-      @@username = username
-      @@password = password
-      @@protocol = ssl == true ? "https" : "http"
-      @@endpoint = test == true ? "resellertest.enom.com" : "reseller.enom.com"
-    end
-
-    def find_domain(name)
-      sld, tld = name.split('.')
-      payload = get('Command' => 'GetDomainInfo', 'SLD' => sld, 'TLD' => tld)
-      Domain.new(payload)
-    end
-
-    def get_balance
-      get('Command' => 'GetBalance')
-    end
+    class << self
+      attr_accessor :username, :password, :test
+      alias_method :test?, :test
 
-    private
+      # All requests must contain the UID, PW, and ResponseType query parameters
+      def default_params
+        { 'UID' => self.username, 'PW' => self.password, 'ResponseType' => 'xml'}
+      end
 
-    def get(params = {})
-      params.merge!(default_params)
-      payload = Crack::XML.parse(RestClient.get(url, {:params => params }))
-      if payload['interface_response']['ErrCount'] == '0'
-        return payload
-      else
-        raise InterfaceError
+      # Enom has a test platform and a production platform.  Both are configured to use
+      # HTTPS at all times. Don't forget to configure permitted IPs (in both environments)
+      # or you'll get InterfaceErrors.
+      def base_uri
+        @base_uri = test? ? "https://resellertest.enom.com/interface.asp" : "https://reseller.enom.com/interface.asp"
       end
-    end
 
-    def url
-      @@protocol + "://" + @@endpoint + "/interface.asp"
-    end
+      # All requests to Enom are GET requests, even when we're changing data.  Unfortunately,
+      # Enom also does not provide HTTP status codes to alert for authentication failures
+      # or other helpful statuses -- everything comes back as a 200.
+      def request(params = {})
+        params.merge!(default_params)
+        response = get(base_uri, :query => params)
+        case response.code
+        when 200
+          if response['interface_response']['ErrCount'] == '0'
+            return response
+          else
+            raise InterfaceError
+          end
+        end
+      end
 
-    def default_params
-      { 'UID' => @@username, 'PW' => @@password, 'ResponseType' => 'xml'}
     end
 
   end

data/lib/enom/domain.rb

@@ -1,32 +1,108 @@
 module Enom
-  class Domain < Client
 
-    attr_reader :name, :sld, :tld
+  class Domain
+    include HTTParty
 
-    def initialize(payload)
-      @name           = payload['interface_response']['GetDomainInfo']['domainname']
-      @sld, @tld      = @name.split('.')
-      @domain_payload = payload
+    # The domain name on Enom
+    attr_reader :name
+
+    # Second-level and first-level domain on Enom
+    attr_reader :sld, :tld
+
+    # Domain expiration date (currently returns a string - 11/9/2010 11:57:39 AM)
+    attr_reader :expiration_date
+
+
+    def initialize(attributes)
+      @name = attributes["DomainName"] || attributes["domainname"]
+      @sld, @tld = @name.split('.')
+      expiration_string = attributes["expiration_date"] || attributes["status"]["expiration"]
+      @expiration_date = Date.parse(expiration_string.split(' ').first)
+
+      # If we have more attributes for the domain from running GetDomainInfo
+      # (as opposed to GetAllDomains), we should save it to the instance to
+      # save on future API calls
+      if attributes["services"] && attributes["status"]
+        set_extended_domain_attributes(attributes)
+      end
+    end
+
+    # Find the domain (must be in your account) on Enom
+    def self.find(name)
+      sld, tld = name.split('.')
+      response = Client.request('Command' => 'GetDomainInfo', 'SLD' => sld, 'TLD' => tld)["interface_response"]["GetDomainInfo"]
+      p response if Client.test?
+      Domain.new(response)
+    end
+
+    # Determine if the domain is available for purchase
+    # def self.check(name)
+    #   sld, tld = name.split('.')
+    #   response = self.get("#{Client.base_uri}/domains/#{name}/check.json", options)
+    #
+    #   p response if Client.test?
+    #
+    #   # return "registered" or "available"
+    # end
+
+    # Find and return all domains in the account
+    def self.all(options = {})
+      response = Client.request("Command" => "GetAllDomains")["interface_response"]["GetAllDomains"]["DomainDetail"]
+
+      p response if Client.test?
+
+      domains = []
+      response.each {|d| domains << Domain.new(d) }
+      return domains
+    end
+
+    # Purchase the domain
+    def self.register!(name, options = {})
+      sld, tld = name.split('.')
+      opts = {}
+      if options[:nameservers]
+        count = 1
+        options[:nameservers].each do |nameserver|
+          opts.merge!("NS#{count}" => nameserver)
+          count += 1
+        end
+      end
+      opts.merge!('NumYears' => options[:years]) if options[:years]
+      purchase = get({'Command' => 'Purchase', 'SLD' => sld, 'TLD' => tld}.merge(opts))
+      self.find(name)
     end
 
+    # Lock the domain at the registrar so it can't be transferred
     def lock
-      get('Command' => 'SetRegLock', 'SLD' => sld, 'TLD' => tld, 'UnlockRegistrar' => '0')
+      Client.request('Command' => 'SetRegLock', 'SLD' => sld, 'TLD' => tld, 'UnlockRegistrar' => '0')
+      @locked = true
+      return self
     end
 
+    # Unlock the domain at the registrar to permit transfers
     def unlock
-      get('Command' => 'SetRegLock', 'SLD' => sld, 'TLD' => tld, 'UnlockRegistrar' => '1')
+      Client.request('Command' => 'SetRegLock', 'SLD' => sld, 'TLD' => tld, 'UnlockRegistrar' => '1')
+      @locked = false
+      return self
     end
 
-    def locked?
-      payload = get('Command' => 'GetRegLock', 'SLD' => sld, 'TLD' => tld)
-      payload['interface_response']['reg_lock'] == '1' ? true : false
+    # Check if the domain is currently locked.  locked? helper method also available
+    def locked
+      unless @locked
+        response = Client.request('Command' => 'GetRegLock', 'SLD' => sld, 'TLD' => tld)['interface_response']['reg_lock']
+        @locked = response == '1'
+      end
+      return @locked
     end
+    alias_method :locked?, :locked
 
+    # Return the DNS nameservers that are currently used for the domain
     def nameservers
-      @domain_payload['interface_response']['GetDomainInfo']['services']['entry'].first['configuration']['dns']
+      get_extended_domain_attributes unless @nameservers
+      return @nameservers
     end
 
-    def update_nameservers(nameservers)
+    def update_nameservers(nameservers = [])
       count = 1
       ns = {}
       if (2..12).include?(nameservers.size)
@@ -34,24 +110,52 @@ module Enom
           ns.merge!("NS#{count}" => nameserver)
           count += 1
         end
-        get({'Command' => 'ModifyNS', 'SLD' => sld, 'TLD' => tld}.merge(ns))
+        Client.request({'Command' => 'ModifyNS', 'SLD' => sld, 'TLD' => tld}.merge(ns))
+        @nameservers = ns.values
+        return self
       else
-        raise InvalidNameServerCount, "A minimum of 2 and maximum of 12 nameservers are required"
+        raise InvalidNameServerCount
       end
     end
 
     def expiration_date
-      @domain_payload['interface_response']['GetDomainInfo']['status']['expiration']
+      date_string = @domain_payload['interface_response']['GetDomainInfo']['status']['expiration']
+      Date.parse(date_string.split(' ').first)
+    end
+
+    def registration_status
+      get_extended_domain_attributes unless @registration_status
+      return @registration_status
+    end
+
+    def active?
+      registration_status == "Registered"
     end
 
     def expired?
+      registration_status == "Expired"
     end
 
-    def registration_status
-      @domain_payload['interface_response']['GetDomainInfo']['status']['registrationstatus']
+    def renew!(years = 1)
+      # get('Command' => 'Renew', 'SLD' => sld, 'TLD' => tld)
+      raise NotImplementedError
+    end
+
+    private
+
+    # Make another API call to get all domain info. Often necessary when domains are
+    # found using Domain.all instead of Domain.find.
+    def get_extended_domain_attributes
+      sld, tld = name.split('.')
+      attributes = Client.request('Command' => 'GetDomainInfo', 'SLD' => sld, 'TLD' => tld)["interface_response"]["GetDomainInfo"]
+      set_extended_domain_attributes(attributes)
     end
 
-    def renew
+    # Set any more attributes that we have to work with to instance variables
+    def set_extended_domain_attributes(attributes)
+      @nameservers = attributes['services']['entry'].first['configuration']['dns']
+      @registration_status = attributes['status']['registrationstatus']
+      return self
     end
 
   end

data/lib/enom/error.rb

@@ -0,0 +1,25 @@
+module Enom
+
+  class InterfaceError < StandardError
+    def initialize(message = nil)
+      if message
+        super message
+      else
+        super "An unknown error occurred.  Check your username, password, and make sure your IP address is permitted to access the Enom API"
+      end
+    end
+  end
+
+  class NotImplementedError < StandardError
+    def initialize
+      super "The command you tried is not yet implemented, but we're planning on it!  Feel free to fork the project and contribute!"
+    end
+  end
+
+  class InvalidNameServerCount < StandardError
+    def initialize
+      super "A minimum of 2 and maximum of 12 nameservers are required"
+    end
+  end
+
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: enom
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 59
   prerelease: false
   segments: 
   - 0
+  - 9
   - 0
-  - 1
-  version: 0.0.1
+  version: 0.9.0
 platform: ruby
 authors: 
 - James Miller
@@ -15,44 +15,29 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-13 00:00:00 -07:00
+date: 2010-11-13 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rest-client
+  name: httparty
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 1
-        - 6
-        - 0
-        version: 1.6.0
-  type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: crack
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 9
+        hash: 5
         segments: 
         - 0
+        - 6
         - 1
-        version: "0.1"
+        version: 0.6.1
   type: :runtime
-  version_requirements: *id002
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: shoulda
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -62,8 +47,8 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  version_requirements: *id003
-description: Enom is a simple Ruby wrapper for a small portion of the Enom domain reseller API.
+  version_requirements: *id002
+description: Enom is a simple Ruby wrapper for portions of the Enom domain reseller API.
 email: bensie@gmail.com
 executables: []
 
@@ -76,8 +61,11 @@ files:
 - Rakefile
 - LICENSE
 - lib/enom.rb
+- lib/enom/account.rb
+- lib/enom/cli.rb
 - lib/enom/client.rb
 - lib/enom/domain.rb
+- lib/enom/error.rb
 - test/enom_test.rb
 - test/test_helper.rb
 has_rdoc: true