namecheap 0.2.0 → 0.3.0

data/lib/namecheap/ns.rb

@@ -1,31 +1,31 @@
 module Namecheap
   class Ns < Api
+    # Creates a new nameserver.
+    # @see http://developer.namecheap.com/docs/doku.php?id=api-reference:domains.ns:create
     def create(sld, tld, options = {})
-      args = options.clone
-      args['SLD'] = sld
-      args['TLD'] = tld
-      api_call('namecheap.domains.ns.create', args)
+      options = {:SLD => sld, :TLD => tld}.merge(options)
+      get 'domains.ns.create', options
     end
 
+    # Deletes a nameserver associated with the requested domain.
+    # @see http://developer.namecheap.com/docs/doku.php?id=api-reference:domains.ns:delete
     def delete(sld, tld, options = {})
-      args = options.clone
-      args['SLD'] = sld
-      args['TLD'] = tld
-      api_call('namecheap.domains.ns.delete', args)
+      options = {:SLD => sld, :TLD => tld}.merge(options)
+      get 'domains.ns.delete', options
     end
 
+    # Retrieves information about a registered nameserver.
+    # @see http://developer.namecheap.com/docs/doku.php?id=api-reference:domains.ns:getinfo
     def get_info(sld, tld, options = {})
-      args = options.clone
-      args['SLD'] = sld
-      args['TLD'] = tld
-      api_call('namecheap.domains.ns.getInfo', args)
+      options = {:SLD => sld, :TLD => tld}.merge(options)
+      get 'domains.ns.getInfo', options
     end
 
+    # Updates the IP address of a registered nameserver.
+    # @see http://developer.namecheap.com/docs/doku.php?id=api-reference:domains.ns:update
     def update(sld, tld, options = {})
-      args = options.clone
-      args['SLD'] = sld
-      args['TLD'] = tld
-      api_call('namecheap.domains.ns.update', args)
+      options = {:SLD => sld, :TLD => tld}.merge(options)
+      get 'domains.ns.update', options
     end
   end
 end

data/lib/namecheap/ssl.rb

@@ -1,60 +1,70 @@
 module Namecheap
   class Ssl < Api
+    # Activates a newly purchased SSL certificate.
+    # @see http://developer.namecheap.com/docs/doku.php?id=api-reference:ssl:activate
     def activate(id, options = {})
-      args = options.clone
-      args['CertificateID'] = id
-      api_call('namecheap.ssl.activate', args)
+      options = {:CertificateID => id}.merge(options)
+      get 'ssl.activate', options
     end
 
+    # Retrieves information about the requested SSL certificate.
+    # @see http://developer.namecheap.com/docs/doku.php?id=api-reference:ssl:getinfo
     def get_info(id, options = {})
-      args = options.clone
-      args['CertificateID'] = id
-      api_call('namecheap.ssl.getInfo', args)
+      options = {:CertificateID => id}.merge(options)
+      get 'ssl.getInfo', options
     end
 
+    # Parsers the CSR.
+    # @see http://developer.namecheap.com/docs/doku.php?id=api-reference:ssl:parsecsr
     def parse_csr(csr, options = {})
-      args = options.clone
-      args['csr'] = csr
-      api_call('namecheap.ssl.parseCSR', args)
+      options = {:csr => csr}.merge(options)
+      get 'ssl.parseCSR', options
     end
 
+    # Gets approver email list for the requested domain.
+    # @see http://developer.namecheap.com/docs/doku.php?id=api-reference:ssl:getapproveremaillist
     def get_approver_email_list(domain, options = {})
-      args = options.clone
-      args['DomainName'] = domain
-      api_call('namecheap.ssl.getApproverEmailList', args)
+      options = {:DomainName => domain}.merge(options)
+      get 'ssl.getApproverEmailList', options
     end
 
+    # Returns a list of SSL certificates for a particular user.
+    # @see http://developer.namecheap.com/docs/doku.php?id=api-reference:ssl:getlist
     def get_list(options = {})
-      args = options.clone
-      api_call('namecheap.ssl.getList', args)
+      get 'ssl.getList', options
     end
 
+    # Creates a new SSL certificate.
+    # @see http://developer.namecheap.com/docs/doku.php?id=api-reference:ssl:create
     def create(options = {})
-      args = options.clone
-      api_call('namecheap.ssl.create', args)
+      get 'ssl.create', options
     end
 
+    # Renews an SSL certificate.
+    # @see http://developer.namecheap.com/docs/doku.php?id=api-reference:ssl:renew
     def renew(options = {})
-      args = options.clone
-      api_call('namecheap.ssl.renew', args)
+      get 'ssl.renew', options
     end
 
+    # Resends the approver email.
+    # @see http://developer.namecheap.com/docs/doku.php?id=api-reference:ssl:resendapproveremail
     def resend_approver_email(id, options = {})
-      args = options.clone
-      args['CertificateID'] = id
-      api_call('namecheap.ssl.resendApproverEmail', args)
+      options = {:CertificateID => id}.merge(options)
+      get 'ssl.resendApproverEmail', options
     end
 
+    # Resends the fulfilment email containing the certificate.
+    # @see http://developer.namecheap.com/docs/doku.php?id=api-reference:ssl:resendfulfillmentemail
     def resend_fulfillment_email(id, options = {})
-      args = options.clone
-      args['CertificateID'] = id
-      api_call('namecheap.ssl.resendfulfillmentemail', args)
+      options = {:CertificateID => id}.merge(options)
+      get 'ssl.resendfulfillmentemail', options
     end
 
+    # Reissues an SSL certificate.
+    # @see http://developer.namecheap.com/docs/doku.php?id=api-reference:ssl:reissue
     def reissue(id, options = {})
-      args = options.clone
-      args['CertificateID'] = id
-      api_call('namecheap.ssl.reissue', args)
+      options = {:CertificateID => id}.merge(options)
+      get 'ssl.reissue', options
     end
   end
 end

data/lib/namecheap/transfers.rb

@@ -1,26 +1,30 @@
 module Namecheap
   class Transfers < Api
+    # Transfers a domain to Namecheap.
+    # @see http://developer.namecheap.com/docs/doku.php?id=api-reference:domains.transfer:create
     def create(domain, options = {})
-      args = options.clone
-      args['DomainName'] = domain
-      api_call('namecheap.domains.transfer.create', args)
+      options = {:DomainName => domain}.merge(options)
+      get 'domains.transfer.create', options
     end
 
+    # Gets the status of a particular transfer.
+    # @see http://developer.namecheap.com/docs/doku.php?id=api-reference:domains.transfer:getstatus
     def get_status(id, options = {})
-      args = options.clone
-      args['TransferID'] = id
-      api_call('namecheap.domains.transfer.getStatus', args)
+      options = {:TransferID => id}.merge(options)
+      get 'domains.transfer.getStatus', options
     end
 
+    # Updates the status of a particular transfer.
+    # @see http://developer.namecheap.com/docs/doku.php?id=api-reference:domains.transfer:updatestatus
     def update_status(id, options = {})
-      args = options.clone
-      args['TransferID'] = id
-      api_call('namecheap.domains.transfer.updateStatus', args)
+      options = {:TransferID => id}.merge(options)
+      get 'domains.transfer.updateStatus', options
     end
-    
+
+    # Gets the list of domain transfers.
+    # @see http://developer.namecheap.com/docs/doku.php?id=api-reference:domains.transfer:getlist
     def get_list(options = {})
-      args = options.clone
-      api_call('namecheap.domains.transfer.getList', args)
+      get 'domains.transfer.getList', options
     end
   end
 end

data/lib/namecheap/users.rb

@@ -1,44 +1,58 @@
 module Namecheap
   class Users < Api
+    # Creates a new user account at NameCheap.
+    # @see http://developer.namecheap.com/docs/doku.php?id=api-reference:users:create
+    def create(options = {})
+      get 'users.create', options
+    end
+
+    # Returns pricing information for a requested product type.
+    # @see http://developer.namecheap.com/docs/doku.php?id=api-reference:users:getpricing
     def get_pricing(options = {})
-      args = options.clone
-      api_call('namecheap.users.getPricing', args)
+      get 'users.getPricing', options
     end
 
+    # Gets information about fund in the user's account.
+    # @see http://developer.namecheap.com/docs/doku.php?id=api-reference:users:getbalances
     def get_balances(options = {})
-      args = options.clone
-      api_call('namecheap.users.getBalances', args)
+      get 'users.getBalances', options
     end
 
+    # Changes the password for a user.
+    # @see http://developer.namecheap.com/docs/doku.php?id=api-reference:users:changepassword
     def change_password(options = {})
-      args = options.clone
-      api_call('namecheap.users.changePassword', args)
+      get 'users.changePassword', options
     end
 
+    # Updates user account information for the particular user.
+    # @see http://developer.namecheap.com/docs/doku.php?id=api-reference:users:update
     def update(options = {})
-      args = options.clone
-      api_call('namecheap.users.update', args)
+      get 'users.update', options
     end
 
+    # Allows you to add funds to a user account.
+    # @see http://developer.namecheap.com/docs/doku.php?id=api-reference:users:createaddfundsrequest
     def create_add_funds_request(options = {})
-      args = options.clone
-      api_call('namecheap.users.createaddfundsrequest', args)
+      get 'users.createaddfundsrequest', options
     end
 
+    # Gets the status of add funds request.
+    # @see http://developer.namecheap.com/docs/doku.php?id=api-reference:users:getaddfundsstatus
     def get_add_funds_status(id, options = {})
-      args = options.clone
-      args['TokenId'] = id
-      api_call('namecheap.users.getAddFundsStatus', args)
+      options = {:TokenId => id}.merge(options)
+      get 'users.getAddFundsStatus', options
     end
 
+    # Validates the username and password of user accounts you have created.
+    # @see http://developer.namecheap.com/docs/doku.php?id=api-reference:users:login
     def login(options = {})
-      args = options.clone
-      api_call('namecheap.users.login', args)
+      get 'users.login', options
     end
 
+    # Sends a reset password link to user.
+    # @see http://developer.namecheap.com/docs/doku.php?id=api-reference:users:resetpassword
     def reset_password(options = {})
-      args = options.clone
-      api_call('namecheap.users.resetPassword', args)
+      get 'users.resetPassword', options
     end
   end
 end

data/lib/namecheap/version.rb

@@ -1,3 +1,3 @@
 module Namecheap
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/namecheap/whois_guard.rb

@@ -1,40 +1,45 @@
 module Namecheap
   class Whois_Guard < Api
+    # Allots WhoisGuard privacy protection.
+    # @see http://developer.namecheap.com/docs/doku.php?id=api-reference:whoisguard:allot
     def allot(id, domain, options = {})
-      args = options.clone
-      args['WhoisguardId'] = id
-      args['DomainName'] = domain
-      api_call('namecheap.whoisguard.allot', args)
+      options = {:WhoisguardId => id, :DomainName => domain}.merge(options)
+      get 'whoisguard.allot', options
     end
 
+    # Discards the WhoisGuard.
+    # @see http://developer.namecheap.com/docs/doku.php?id=api-reference:whoisguard:discard
     def discard(id, options = {})
-      args = options.clone
-      args['WhoisguardId'] = id
-      api_call('namecheap.whoisguard.discard', args)
+      options = {:WhoisguardId => id}.merge(options)
+      get 'whoisguard.discard', options
     end
 
+    # Unallots WhoisGuard privacy protection for the WhoisguardID.
+    # @see http://developer.namecheap.com/docs/doku.php?id=api-reference:whoisguard:unallot
     def unallot(id, options = {})
-      args = options.clone
-      args['WhoisguardId'] = id
-      api_call('namecheap.whoisguard.unallot', args)
+      options = {:WhoisguardId => id}.merge(options)
+      get 'whoisguard.unallot', options
     end
 
+    # Disables WhoisGuard privacy protection for the WhoisguardID.
+    # @see http://developer.namecheap.com/docs/doku.php?id=api-reference:whoisguard:disable
     def disable(id, options = {})
-      args = options.clone
-      args['WhoisguardId'] = id
-      api_call('namecheap.whoisguard.disable', args)
+      options = {:WhoisguardId => id}.merge(options)
+      get 'whoisguard.disable', options
     end
 
+    # Enables WhoisGuard privacy protection for the WhoisguardID.
+    # @see http://developer.namecheap.com/docs/doku.php?id=api-reference:whoisguard:enable
     def enable(id, options = {})
-      args = options.clone
-      args['WhoisguardId'] = id
-      api_call('namecheap.whoisguard.enable', args)
+      options = {:WhoisguardId => id}.merge(options)
+      get 'whoisguard.enable', options
     end
 
+    # Changes WhoisGuard email address.
+    # @see http://developer.namecheap.com/docs/doku.php?id=api-reference:whoisguard:changeemailaddress
     def change_email_address(id, options = {})
-      args = options.clone
-      args['WhoisguardId'] = id
-      api_call('namecheap.whoisguard.changeemailaddress', args)
+      options = {:WhoisguardId => id}.merge(options)
+      get 'whoisguard.changeemailaddress', options
     end
   end
 end

data/namecheap.gemspec

@@ -8,8 +8,10 @@ Gem::Specification.new do |s|
   s.authors     = ["parasquid"]
   s.email       = ["tristan.gomez@gmail.com"]
   s.homepage    = "https://github.com/parasquid/namecheap"
-  s.summary     = %q{Ruby wrapper for the Namecheap API}
   s.description = %q{Ruby wrapper for the Namecheap API}
+  s.summary     = s.description
+  s.homepage    = 'https://github.com/parasquid/namecheap'
+  s.licenses    = ['GNU']
 
   s.rubyforge_project = "namecheap"
 
@@ -18,8 +20,8 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  # specify any dependencies here; for example:
   s.add_development_dependency "rspec"
-  # s.add_runtime_dependency "rest-client"
+  s.add_development_dependency 'rspec-its'
   s.add_runtime_dependency "httparty"
+  s.add_runtime_dependency "activesupport", '>= 3.0.0'
 end

data/spec/helper.rb

@@ -0,0 +1,25 @@
+begin
+  require 'rspec'
+  require 'rspec/its'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift File.expand_path('../../lib',__FILE__)
+require 'namecheap'
+
+RSpec.configure do |config|
+  def reset_config
+    Namecheap.config.username = nil
+    Namecheap.config.key = nil
+    Namecheap.config.client_ip = nil
+  end
+
+  def set_dummy_config
+    Namecheap.config.username = "the_username"
+    Namecheap.config.key = "the_key"
+    Namecheap.config.client_ip = "127.0.0.1"
+  end
+end

data/spec/namecheap/dns_spec.rb

@@ -0,0 +1,13 @@
+require 'helper'
+
+describe Namecheap::Dns do
+  before { set_dummy_config }
+
+  it 'should initialize' do
+    Namecheap::Dns.new
+  end
+
+  it 'should be already initialized from the Namecheap namespace' do
+    Namecheap.dns.should_not be_nil
+  end
+end

data/spec/{domains_spec.rb → namecheap/domains_spec.rb}

@@ -1,6 +1,8 @@
-require File.dirname(__FILE__) + '/spec_helper'
+require 'helper'
+
+describe Namecheap::Domains do
+  before { set_dummy_config }
 
-describe "Domains"  do
   it 'should initialize' do
     Namecheap::Domains.new
   end

data/spec/namecheap/ns_spec.rb

@@ -0,0 +1,13 @@
+require 'helper'
+
+describe Namecheap::Ns do
+  before { set_dummy_config }
+
+  it 'should initialize' do
+    Namecheap::Ns.new
+  end
+
+  it 'should be already initialized from the Namecheap namespace' do
+    Namecheap.ns.should_not be_nil
+  end
+end

data/spec/namecheap/ssl_spec.rb

@@ -0,0 +1,17 @@
+require 'helper'
+
+describe Namecheap::Ssl do
+  before { set_dummy_config }
+
+  it 'should initialize' do
+    Namecheap::Ssl.new
+  end
+
+  it 'should be already initialized from the Namecheap namespace' do
+    Namecheap.ssl.should_not be_nil
+  end
+
+  it 'should not raise an error' do
+    Namecheap.ssl.get_list
+  end
+end

data/spec/namecheap/transfers.rb

@@ -0,0 +1,13 @@
+require 'helper'
+
+describe Namecheap::Transfers do
+  before { set_dummy_config }
+
+  it 'should initialize' do
+    Namecheap::Transfers.new
+  end
+
+  it 'should be already initialized from the Namecheap namespace' do
+    Namecheap.transfers.should_not be_nil
+  end
+end