namecheap 0.2.0 → 0.3.0

data/Gemfile

@@ -1,4 +1,12 @@
-source "http://rubygems.org"
+source 'https://rubygems.org'
+
+group :development do
+  gem 'pry'
+end
+
+group :test do
+  gem 'rspec', '>= 2.11'
+  gem 'webmock'
+end
 
-# Specify your gem's dependencies in namecheap.gemspec
 gemspec

data/README.md

@@ -1,6 +1,32 @@
 Overview
 ========
 
+Documentation
+-----
+
+[http://rubygems.org/gems/namecheap](http://rubygems.org/gems/namecheap)
+
+Usage
+-----
+
+In your initializers, configure Namecheap like so:
+
+```ruby
+Namecheap.configure do |config|
+  config.key = 'apikey'
+  config.username = 'apiuser'
+  config.client_ip = '127.0.0.1'
+end
+```
+
+Then you can do something like:
+
+```ruby
+Namecheap.domains.get_list
+```
+
+Please see the Namecheap API documentation for more information
+
 About this project
 -------------
 
@@ -34,22 +60,20 @@ the purchase API wrappers, but it was a good starting point (and allowed me to
 study how seasoned pros would approach API wrappers). So I forked, published a
 gem based on the fork, and hacked on it. And that's how it all began :)
 
-Usage
------
+Credits
+-------
 
-In your initializers, configure Namecheap like so:
+Tristan V. Gomez: tristan dot gomez at gmail dot com
+
+[Hashrocket](http://www.hashrocket.com/) from where the original code was forked from
 
-    Namecheap.configure do |config|
-      config.key = 'apikey'
-      config.username = 'apiuser'
-      config.client_ip = '127.0.0.1'
-    end
+[Mongoid](http://www.mongoid.org) from where the configuration code was modified from
 
-Then you can do something like:
 
-    Namecheap.domains.get_list
+Plug!!
+------
 
-Please see the Namecheap API documentation for more information
+Mindvalley is [hiring](http://www.mindvalley.com/careers) :)
 
 License
 -------
@@ -68,19 +92,3 @@ GNU General Public License for more details.
 
 You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
-
-Credits
--------
-
-Tristan V. Gomez: tristan dot gomez at gmail dot com
-
-[Hashrocket](http://www.hashrocket.com/) from where the original code was forked from
-
-[Mongoid](http://www.mongoid.org) from where the configuration code was modified from
-
-
-Plug!!
-------
-
-Mindvalley is [hiring](http://www.mindvalley.com/careers) :)

data/lib/namecheap.rb

@@ -1,9 +1,15 @@
 require 'httparty'
-require 'monkey_patch'
 require 'pp'
-
-$LOAD_PATH.unshift("#{File.dirname(__FILE__)}/namecheap")
-Dir.glob("#{File.dirname(__FILE__)}/namecheap/*.rb") { |lib| require File.basename(lib, '.*') }
+require 'namecheap/version'
+require 'namecheap/api'
+require 'namecheap/config'
+require 'namecheap/domains'
+require 'namecheap/dns'
+require 'namecheap/ns'
+require 'namecheap/ssl'
+require 'namecheap/transfers'
+require 'namecheap/users'
+require 'namecheap/whois_guard'
 
 module Namecheap
 
@@ -22,15 +28,14 @@ module Namecheap
     block_given? ? yield(Config) : Config
   end
   alias :config :configure
-  
-  # Take all the public instance methods from the Config singleton and allow
-  # them to be accessed through the Namecheap module directly.
-  #
-  # @example Delegate the configuration methods.
-  #   Namecheap.key = 'newkey'
-  delegate *(Config.public_instance_methods(false) << { :to => Config })
 
-  attr_accessor :domains
+  attr_accessor :domains, :dns, :ns, :transfers, :ssl, :users, :whois_guard
   self.domains = Namecheap::Domains.new
+  self.dns = Namecheap::Dns.new
+  self.ns = Namecheap::Ns.new
+  self.transfers = Namecheap::Transfers.new
+  self.ssl = Namecheap::Ssl.new
+  self.users = Namecheap::Users.new
+  self.whois_guard = Namecheap::Whois_Guard.new
 
 end

data/lib/namecheap/api.rb

@@ -1,3 +1,5 @@
+require 'active_support/core_ext/string/inflections'
+
 module Namecheap
   class Api
     SANDBOX = 'https://api.sandbox.namecheap.com/xml.response'
@@ -5,18 +7,56 @@ module Namecheap
     ENVIRONMENT = defined?(Rails) && Rails.respond_to?(:env) ? Rails.env : (ENV["RACK_ENV"] || 'development')
     ENDPOINT = (ENVIRONMENT == 'production' ? PRODUCTION : SANDBOX)
 
-    def api_call(command, command_args)
-      args = init_args(command_args.merge :command => command)
-      query = ENDPOINT + '?' + args.to_param
-      HTTParty.get(query)
+    def get(command, options = {})
+      request 'get', command, options
+    end
+
+    def post(command, options = {})
+      request 'post', command, options
+    end
+
+    def put(command, options = {})
+      request 'post', command, options
+    end
+
+    def delete(command, options = {})
+      request 'post', command, options
+    end
+
+    def request(method, command, options = {})
+      command = 'namecheap.' + command
+      options = init_args.merge(options).merge({:command => command})
+      options.keys.each do |key|
+        options[key.to_s.camelize] = options.delete(key)
+      end
+
+      case method
+      when 'get'
+        #raise options.inspect
+        HTTParty.get(ENDPOINT, { :query => options})
+      when 'post'
+        HTTParty.post(ENDPOINT, { :query => options})
+      when 'put'
+        HTTParty.put(ENDPOINT, { :query => options})
+      when 'delete'
+        HTTParty.delete(ENDPOINT, { :query => options})
+      end
     end
 
-    def init_args(options = {})
-      args = {}
-      args['ApiUser'] = args['UserName'] = Namecheap.username
-      args['ApiKey'] = Namecheap.key
-      args['ClientIp'] = Namecheap.client_ip
-      args.merge options.camelize_keys!
+    def init_args
+      %w(username key client_ip).each do |key|
+        if Namecheap.config.key.nil?
+          raise Namecheap::Config::RequiredOptionMissing,
+            "Configuration parameter missing: #{key}, " +
+            "please add it to the Namecheap.configure block"
+        end
+      end
+      options = {
+        api_user:  Namecheap.config.username,
+        user_name: Namecheap.config.username,
+        api_key:   Namecheap.config.key,
+        client_ip: Namecheap.config.client_ip
+      }
     end
   end
-end
+end

data/lib/namecheap/config.rb

@@ -1,43 +1,9 @@
 module Namecheap
   module Config
-    # Taken and modified from Mongoid config.rb
-
+    class RequiredOptionMissing < RuntimeError ; end
     extend self
 
-    attr_accessor :settings, :defaults
-    @settings = {}
-    @defaults = {}
-
-    # Define a configuration option with a default.
-    #
-    # @example Define the option.
-    #   Config.option(:client_ip, :default => '127.0.0.1')
-    #
-    # @param [ Symbol ] name The name of the configuration option.
-    # @param [ Hash ] options Extras for the option.
-    #
-    # @option options [ Object ] :default The default value.
-    def option(name, options = {})
-      defaults[name] = settings[name] = options[:default]
-
-      class_eval <<-RUBY
-        def #{name}
-          settings[#{name.inspect}]
-        end
-
-        def #{name}=(value)
-          settings[#{name.inspect}] = value
-        end
-
-        def #{name}?
-          #{name}
-        end
-      RUBY
-    end
-
-    option :key, :default => 'apikey'
-    option :username, :default => 'apiuser'
-    option :client_ip, :default => '127.0.0.1'
+    attr_accessor :key, :username, :client_ip
 
     # Configure namecheap from a hash. This is usually called after parsing a
     # yaml config file such as mongoid.yml.
@@ -65,14 +31,5 @@ module Namecheap
         from_hash(settings)
       end
     end
-
-    # Reset the configuration options to the defaults.
-    #
-    # @example Reset the configuration options.
-    #   config.reset
-    def reset
-      settings.replace(defaults)
-    end
-
   end
-end
+end

data/lib/namecheap/dns.rb

@@ -1,51 +1,56 @@
 module Namecheap
   class Dns < Api
+    # Sets domain to use Namecheap's default DNS servers.
+    # @see http://developer.namecheap.com/docs/doku.php?id=api-reference:domains.dns:setdefault
     def set_default(sld, tld, options = {})
-      args = options.clone
-      args['SLD'] = sld
-      args['TLD'] = tld
-      api_call('namecheap.domains.dns.setDefault', args)
+      options = {:SLD => sld, :TLD => tld}.merge(options)
+      get 'domains.dns.setDefault', options
     end
 
+    # Sets domain to use custom DNS servers.
+    # @see http://developer.namecheap.com/docs/doku.php?id=api-reference:domains.dns:setcustom
     def set_custom(sld, tld, nameservers = [], options = {})
-      args = options.clone
-      args['SLD'] = sld
-      args['TLD'] = tld
-      args['Nameservers'] = nameservers.respond_to?(:join) ? nameservers.join(',') : nameservers
-      api_call('namecheap.domains.dns.setCustom', args)
+      if nameservers.respond_to?(:join)
+        nameservers = nameservers.join(',')
+      end
+      
+      options = {:SLD => sld, :TLD => tld, :Nameservers => nameservers}.merge(options)
+      get 'domains.dns.setCustom', options
     end
 
+    # Gets a list of DNS servers associated with the requested domain.
+    # @see http://developer.namecheap.com/docs/doku.php?id=api-reference:domains.dns:getlist
     def get_list(sld, tld, options = {})
-      args = options.clone
-      args['SLD'] = sld
-      args['TLD'] = tld
-      api_call('namecheap.domains.dns.getList', args)
+      options = {:SLD => sld, :TLD => tld}.merge(options)
+      get 'domains.dns.getList', options
     end
 
+    # Retrieves DNS host record settings for the requested domain.
+    # @see http://developer.namecheap.com/docs/doku.php?id=api-reference:domains.dns:gethosts
     def get_hosts(sld, tld, options = {})
-      args = options.clone
-      args['SLD'] = sld
-      args['TLD'] = tld
-      api_call('namecheap.domains.dns.getHosts', args)
+      options = {:SLD => sld, :TLD => tld}.merge(options)
+      get 'domains.dns.getHosts', options
     end
 
+    # Gets email forwarding settings for the requested domain.
+    # @see http://developer.namecheap.com/docs/doku.php?id=api-reference:domains.dns:getemailforwarding
     def get_email_forwarding(domain, options = {})
-      args = options.clone
-      args['DomainName'] = domain
-      api_call('namecheap.domains.dns.getEmailForwarding', args)
+      options = {:DomainName => domain}.merge(options)
+      get 'domains.dns.getEmailForwarding', options
     end
 
+    # Sets email forwarding for a domain name.
+    # @see http://developer.namecheap.com/docs/doku.php?id=api-reference:domains.dns:setemailforwarding
     def set_email_forwarding(domain, options = {})
-      args = options.clone
-      args['DomainName'] = domain
-      api_call('namecheap.domains.dns.setEmailForwarding', args)
+      options = {:DomainName => domain}.merge(options)
+      get 'domains.dns.setEmailForwarding', options
     end
 
+    # Sets DNS host records settings for the requested domain.
+    # @see http://developer.namecheap.com/docs/doku.php?id=api-reference:domains.dns:sethosts
     def set_hosts(sld, tld, options = {})
-      args = options.clone
-      args['SLD'] = sld
-      args['TLD'] = tld
-      api_call('namecheap.domains.dns.setHosts', args)
+      options = {:SLD => sld, :TLD => tld}.merge(options)
+      get 'domains.dns.setHosts', options
     end
   end
 end

data/lib/namecheap/domains.rb

@@ -1,67 +1,82 @@
 module Namecheap
   class Domains < Api
+    # Returns a list of domains for the particular user.
+    # @see http://developer.namecheap.com/docs/doku.php?id=api-reference:domains:getlist
     def get_list(options = {})
-      args = options.clone
-      api_call('namecheap.domains.getList', args)
+      get 'domains.getList', options
     end
 
+    # Gets contact information for the requested domain.
+    # @see http://developer.namecheap.com/docs/doku.php?id=api-reference:domains:getcontacts
     def get_contacts(domain, options = {})
-      args = options.clone
-      args['DomainName'] = domain
-      api_call('namecheap.domains.getContacts', args)
+      options = {:DomainName => domain}.merge(options)
+      get 'domains.getContacts', options
     end
 
+    # Registers a domain.
+    # @see http://developer.namecheap.com/docs/doku.php?id=api-reference:domains:create
     def create(domain, options = {})
-      args = options.clone
-      args['DomainName'] = domain
-      api_call('namecheap.domains.create', args)
+      options = {:DomainName => domain}.merge(options)
+      get 'domains.create', options
     end
 
+    # Returns a list of tlds.
+    # @see http://developer.namecheap.com/docs/doku.php?id=api-reference:domains:gettldlist
     def get_tld_list(options = {})
-      args = options.clone
-      api_call('namecheap.domains.getTldList', args)
+      get 'domains.getTldList', options
     end
 
+    # Sets contact information for the requested domain.
+    # @see http://developer.namecheap.com/docs/doku.php?id=api-reference:domains:setcontacts
     def set_contacts(domain, options = {})
-      args = options.clone
-      args['DomainName'] = domain
-      api_call('namecheap.domains.setContacts', args)
+      options = {:DomainName => domain}.merge(options)
+      get 'domains.setContacts', options
     end
 
+    # Checks the availability of domains.
+    # @see http://developer.namecheap.com/docs/doku.php?id=api-reference:domains:check
     def check(domains = [], options = {})
-      args = options.clone
-      args['DomainList'] = domains.respond_to?(:join) ? domains.join(',') : domains
-      api_call('namecheap.domains.check', args)
+      if domains.respond_to?(:join)
+        domains = domains.join(',')
+      end
+      
+      options = {:DomainList => domains}.merge(options)
+      get 'domains.check', options
     end
 
+    # Reactivates an expired domain.
+    # @see http://developer.namecheap.com/docs/doku.php?id=api-reference:domains:reactivate
     def reactivate(domain, options = {})
-      args = options.clone
-      args['DomainName'] = domain
-      api_call('namecheap.domains.reactivate', args)
+      options = {:DomainName => domain}.merge(options)
+      get 'domains.reactivate', options
     end
 
+    # Renews an expiring domain.
+    # http://developer.namecheap.com/docs/doku.php?id=api-reference:domains:renew
     def renew(domain, options = {})
-      args = options.clone
-      args['DomainName'] = domain
-      api_call('namecheap.domains.renew', args)
+      options = {:DomainName => domain}.merge(options)
+      get 'domains.renew', options
     end
 
+    # Gets the status of RegistrarLock for the requested domain.
+    # @see http://developer.namecheap.com/docs/doku.php?id=api-reference:domains:getregistrarlock
     def get_registrar_lock(domain, options = {})
-      args = options.clone
-      args['DomainName'] = domain
-      api_call('namecheap.domains.getRegistrarLock', args)
+      options = {:DomainName => domain}.merge(options)
+      get 'domains.getRegistrarLock', options
     end
 
+    # Sets the RegistrarLock status for a domain.
+    # @see http://developer.namecheap.com/docs/doku.php?id=api-reference:domains:setregistrarlock
     def set_registrar_lock(domain, options = {})
-      args = options.clone
-      args['DomainName'] = domain
-      api_call('namecheap.domains.setRegistrarLock', args)
+      options = {:DomainName => domain}.merge(options)
+      get 'domains.setRegistrarLock', options
     end
 
+    # Returns information about the requested domain.
+    # @see http://developer.namecheap.com/docs/doku.php?id=api-reference:domains:getinfo
     def get_info(domain, options = {})
-      args = options.clone
-      args['DomainName'] = domain
-      api_call('namecheap.domains.getInfo', args)
+      options = {:DomainName => domain}.merge(options)
+      get 'domains.getInfo', options
     end
   end
 end