namecheap-ruby 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a1cea1aa16b1dd79407a492d950343466c6abd37
-  data.tar.gz: 7675a67b49e2ef98829be2bbba1e48c495f9779d
+  metadata.gz: 97ec5beed766721b2fcadd63f7bbb0574e1749fd
+  data.tar.gz: ca91f903a866d4bdb6a6be0cefc0c27e03446974
 SHA512:
-  metadata.gz: 6a4c8fe179d23f19bb743fb9b53d2831a61a973c24618b67d16e98ab30aaf391e5e957c42d4a042b8361da89d80ab86852ba9bb2a43709ef6404b7736a1db6c7
-  data.tar.gz: 7bbda3531a79fbade0e3e778d8388ae2aa94e7f192a2345237773762793ebb454c266d76e9c263e565f88114049a0f6a4af3e45695a790967ac5d16437a32fe5
+  metadata.gz: aac441d240c5c2811efa427935c366d5020dd8ad96a444bc1a60878498bc69d5b51feac933121be571e777bed5cf1c0574839c3c687500dae1b6aae6d2c5b36c
+  data.tar.gz: 28fe6131b0a2f1e04d93a74a2f24cb1bf1079ddc9df3eedf35df8c1ddc33dd5e84d4846b978a3de44c134838f49e43759c5955914c2c0bfa9e5030c54c2cd2db

data/.gitignore

@@ -0,0 +1 @@
+pkg

data/Gemfile.lock

@@ -0,0 +1,23 @@
+PATH
+  remote: .
+  specs:
+    namecheap-ruby (0.0.1)
+      httparty
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    httparty (0.12.0)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    json (1.8.1)
+    multi_xml (0.5.5)
+    rake (10.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  namecheap-ruby!
+  rake

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 James Newton
+Copyright (c) 2013 James Newton <hello@jamesnewton.com>
 
 MIT License
 

data/README.md

@@ -1,12 +1,16 @@
 # Namecheap
 
-TODO: Write a gem description
+A gem to use the Namecheap API easily.
+
+There are many like it, but this one is mine.
+
+This is a work in progress, but totally useable. Feel free to contribute.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'namecheap'
+    gem 'namecheap-ruby'
 
 And then execute:
 
@@ -14,11 +18,15 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install namecheap
+    $ gem install namecheap-ruby
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+Namecheap.configure user: 'something', api_key: 'something', ip: 'something'
+
+Namecheap::Domain.get_list
+```
 
 ## Contributing
 

data/lib/namecheap-ruby.rb

@@ -0,0 +1,20 @@
+require 'httparty'
+
+require 'namecheap/version'
+require 'namecheap/configuration'
+require 'namecheap/api'
+require 'namecheap/resources/domain'
+require 'namecheap/resources/dns'
+require 'namecheap/resources/ns'
+
+module Namecheap
+  class << self
+    def config
+      @config
+    end
+
+    def configure(opts = {})
+      @config = Namecheap::Configuration.new(opts).options
+    end
+  end
+end

data/lib/namecheap.rb

@@ -1,5 +1 @@
-require "namecheap/version"
-
-module Namecheap
-  # Your code goes here...
-end
+require_relative 'namecheap-ruby'

data/lib/namecheap/api.rb

@@ -0,0 +1,39 @@
+module Namecheap::API
+  SANDBOX    = 'https://api.sandbox.namecheap.com/xml.response'
+  PRODUCTION = 'https://api.namecheap.com/xml.response'
+
+  def get(command, options = {})
+    request :get, command, options
+  end
+
+  def post(command, options = {})
+    request :post, command, options
+  end
+
+  private
+
+  def base_uri
+    Namecheap.config[:sandbox] ? SANDBOX : PRODUCTION
+  end
+
+  def request(type, command, options = {})
+    endpoint = "#{params(options)}&Command=namecheap.#{command}"
+
+    HTTParty.send(type, "#{base_uri}#{endpoint}")
+  end
+
+  def params(options = {})
+    params = ''
+
+    {
+      ApiUser:  Namecheap.config[:user],
+      ApiKey:   Namecheap.config[:api_key],
+      ClientIp: Namecheap.config[:ip],
+      UserName: Namecheap.config[:user]
+    }.merge(options).each do |key, value|
+      params += "&#{key}=#{value}"
+    end
+
+    params.gsub(/^&/, '?')
+  end
+end

data/lib/namecheap/configuration.rb

@@ -0,0 +1,19 @@
+class Namecheap::Configuration
+  attr_reader :options
+
+  REQUIRED_PARAMS = [:user, :api_key, :ip]
+
+  def initialize(opts = {})
+    raise "Missing configuration options: #{REQUIRED_PARAMS.delete_if { |param| opts.has_key?(param) }.join(', ')}" unless validate_config(opts)
+
+    @options = opts
+    @options[:sandbox] ||= false
+    @options
+  end
+
+  private
+
+  def validate_config(opts)
+    REQUIRED_PARAMS.delete_if { |param| opts.has_key?(param) }.count.zero?
+  end
+end

data/lib/namecheap/resources/dns.rb

@@ -0,0 +1,68 @@
+module Namecheap::DNS
+  include Namecheap::API
+  extend self
+
+  def get_email_forwarding(domain)
+    get 'domains.dns.getEmailForwarding', DomainName: domain
+  end
+
+  def get_hosts(domain)
+    get 'domains.dns.getHosts', split_domain(domain)
+  end
+
+  def get_list(domain)
+    get 'domains.dns.getList', split_domain(domain)
+  end
+
+  def set_custom(domain, nameservers)
+    nameservers = nameservers.is_a?(Array) ? nameservers.join(',') : nameservers
+
+    get 'domains.dns.setCustom', split_domain(domain).merge(Nameservers: nameservers)
+  end
+
+  def set_default(domain)
+    get 'domains.dns.setDefault', split_domain(domain)
+  end
+
+  def set_email_forwarding(domain, mailboxes)
+    get 'domains.dns.setEmailForwarding', { DomainName: domain }.merge(format_mailboxes(mailboxes))
+  end
+
+  def set_hosts(domain, hosts)
+    get 'domains.dns.setHosts', split_domain(domain).merge(format_hosts(hosts))
+  end
+
+  private
+
+  def format_hosts(hosts)
+    hosts       = hosts.is_a?(Array) ? hosts : [hosts]
+    host_params = {}
+
+    hosts.each_with_index do |hash, index|
+      i                             = index + 1
+      host_params["HostName#{i}"]   = hash[:hostname]
+      host_params["RecordType#{i}"] = hash[:type]
+      host_params["Address#{i}"]    = hash[:address]
+      host_params["MXPref#{i}"]     = hash[:mx_pref] if hash[:type] == 'MX'
+      host_params["EmailType#{i}"]  = hash[:email_type] if hash[:email_type]
+      host_params["TTL#{i}"]        = hash[:ttl] if hash[:ttl]
+    end
+  end
+
+  def format_mailboxes(mailboxes)
+    mailboxes  = mailboxes.is_a?(Array) ? mailboxes : [mailboxes]
+    box_params = {}
+
+    mailboxes.each_with_index do |hash, index|
+      i                                  = index + 1
+      box_params["MailBox#{i}".to_sym]   = hash[:mailbox]
+      box_params["ForwardTo#{i}".to_sym] = hash[:forward_to]
+    end
+  end
+
+  def split_domain(domain)
+    tld, sld = domain.split('.')
+
+    { TLD: tld, SLD: sld }
+  end
+end

data/lib/namecheap/resources/domain.rb

@@ -0,0 +1,57 @@
+module Namecheap::Domain
+  include Namecheap::API
+  extend self
+
+  def check(domains)
+    domains = domains.is_a?(Array) ? domains.join(',') : domains
+
+    get 'domains.check', DomainList: domains
+  end
+
+  def create(*)
+    raise 'implementation needed'
+  end
+
+  def get_contacts(domain)
+    get 'domains.getContacts', DomainName: domain
+  end
+
+  def get_info(domain)
+    get 'domains.getInfo', DomainName: domain
+  end
+
+  def get_list
+    get 'domains.getList'
+  end
+
+  def get_registrar_lock(domain)
+    get 'domains.getRegistrarLock', DomainName: domain
+  end
+
+  def get_tld_list
+    get 'domains.getTldList'
+  end
+
+  def reactivate(domain)
+    get 'domains.reactivate', DomainName: domain
+  end
+
+  def renew(domain, years = 1, promo_code = nil)
+    params = { DomainName: domain, Years: years }
+    params.merge!(PromotionCode: promo_code) unless promo_code.nil?
+
+    get 'domains.renew', params
+  end
+
+  def set_contacts(*)
+    raise 'implementation needed'
+  end
+
+  def set_registrar_lock(domain, lock)
+    raise "Lock value must be 'LOCK' or 'UNLOCK'" unless lock == 'LOCK' || lock == 'UNLOCK'
+
+    params = { DomainName: domain, LockAction: lock }
+
+    get 'domains.setRegistrarLock', params
+  end
+end

data/lib/namecheap/resources/ns.rb

@@ -0,0 +1,30 @@
+module Namecheap::NS
+  include Namecheap::API
+  extend self
+
+  def create(domain, nameserver, ip)
+    get 'domains.ns.create', split_domain(domain).merge(Nameserver: nameserver, IP: ip)
+  end
+
+  def delete(domain, nameserver)
+    get 'domains.ns.delete', split_domain(domain).merge(Nameserver: nameserver)
+  end
+
+  def get_info(domain, nameserver)
+    get 'domains.ns.getInfo', split_domain(domain).merge(Nameserver: nameserver)
+  end
+
+  def update(domain, nameserver, ip)
+    old_ip = get_info(domain, nameserver).parsed_response['ApiResponse']['CommandResponse']['DomainNSInfoResult']['IP']
+
+    get 'domains.ns.update', split_domain(domain).merge(Nameserver: nameserver, OldIP: old_ip, IP: ip)
+  end
+
+  private
+
+  def split_domain(domain)
+    sld, tld = domain.split('.')
+
+    { SLD: sld, TLD: tld }
+  end
+end

data/lib/namecheap/version.rb

@@ -1,3 +1,3 @@
 module Namecheap
-  VERSION = "0.0.1"
+  VERSION = '0.0.2'
 end

data/namecheap-ruby.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency 'httparty'
+
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: namecheap-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - James Newton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-22 00:00:00.000000000 Z
+date: 2014-04-11 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -45,11 +59,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/namecheap-ruby.rb
 - lib/namecheap.rb
+- lib/namecheap/api.rb
+- lib/namecheap/configuration.rb
+- lib/namecheap/resources/dns.rb
+- lib/namecheap/resources/domain.rb
+- lib/namecheap/resources/ns.rb
 - lib/namecheap/version.rb
 - namecheap-ruby.gemspec
 homepage: https://github.com/jameswritescode/namecheap-ruby
@@ -72,8 +94,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.6
+rubygems_version: 2.1.10
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for the Namecheap API
 test_files: []
+has_rdoc: