namecheap 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rvmrc

@@ -0,0 +1,3 @@
+rvm 1.8.7
+rvm gemset create namecheap
+rvm 1.8.7@namecheap

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in namecheap.gemspec
+gemspec

data/README.textile

@@ -0,0 +1,20 @@
+h1. Ruby Wrapper for Namecheap.com API
+
+Allow the ability to check domain availability through namecheap.com API.
+
+h2. Usage
+
+<pre>
+  <code>
+require 'lib/namecheap'
+
+namecheap = Namecheap.new
+namecheap.is_domain_availble? 'hashrocket.com' # => false
+  </code>
+</pre>
+
+h2. Contributors
+
+* "Hashrocket":http://www.hashrocket.com
+* "Corey Grusden":http://coreygrusden.com
+* "Big Tiger":http://bigtiger.github.com

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/namecheap.rb

@@ -0,0 +1,77 @@
+require "namecheap/version"
+require 'httparty'
+
+module Namecheap
+end
+
+class NilNamecheapResponse < Exception
+end
+
+class NamecheapResponse
+  def initialize(response)
+    @response = response
+  end
+
+  def status
+    @response["ApiResponse"]["Status"] 
+  end
+
+  def message
+    if @response["ApiResponse"]["Errors"].any?
+      @response["ApiResponse"]["Errors"]["Error"]
+    end
+  end
+
+  def items
+    response = @response["ApiResponse"]["CommandResponse"]
+    raise NilNamecheapResponse if response.nil?
+    response.delete_if { |key, value| key == "Type" }
+  end
+
+end
+
+class DomainCheck
+  attr_accessor :domain, :available, :error, :description
+
+  def initialize(item)
+    @domain = item["Domain"]
+    @available = (item["Available"] == "true" ? true : false)
+    @error = item["ErrorNo"]
+    @description = item["Description"]
+  end
+end
+
+class NamecheapDomainCheckResponse < NamecheapResponse
+  def items
+    super.collect {|item| DomainCheck.new(item[1])} 
+  end
+end
+
+class Namecheap
+  attr_reader :username, :key, :client_ip
+  def initialize(options = {})
+    config = YAML.load_file("#{File.dirname(__FILE__)}/namecheap.yml").symbolize_keys!
+    @key = options[:key] || config[:key]
+    @username = options[:username] || config[:username]
+    @client_ip = options[:client_ip] || config[:client_ip]
+  end
+
+  def is_domain_available?(domain)
+    results = domain_check(domain).items
+    results.nil? ? false : results.first.available?
+  end
+
+  def domain_check(domain)
+    domain = domain.join(",") if domain.is_a? Array
+    NamecheapDomainCheckResponse.new(do_query("namecheap.domains.check", "&DomainList=#{domain}"))
+  end
+
+  protected
+  
+  def do_query(api_method, options)
+    query = "https://api.sandbox.namecheap.com/xml.response?ApiUser=#{@username}&ApiKey=#{@key}&UserName=#{@username}&ClientIp=#{@client_ip}&Command=#{api_method}"
+    query += options
+    HTTParty.get(query)
+  end
+
+end

data/lib/namecheap.yml

@@ -0,0 +1,4 @@
+---
+key: apikey
+username: apiuser
+client_ip: 127.0.0.1

data/lib/namecheap/version.rb

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

data/namecheap.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "namecheap/version"
+
+Gem::Specification.new do |s|
+  s.name        = "namecheap"
+  s.version     = Namecheap::VERSION
+  s.authors     = ["parasquid"]
+  s.email       = ["tristan.gomezd@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.rubyforge_project = "namecheap"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  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_runtime_dependency "httparty"
+end

data/spec/namecheap_domain_check_response_spec.rb

@@ -0,0 +1,78 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require File.dirname(__FILE__) + '/../lib/namecheap'
+
+describe NamecheapDomainCheckResponse  do
+  
+  describe "successful response from namecheap" do
+    before(:each) do
+	@domain_check_response_hash = {"ApiResponse"=>{"Status"=>"OK", 
+			      "Errors"=>{},  
+			    "CommandResponse" => {"Type" => "namecheap.domains.check", 
+			      "DomainCheckResult1" => {"Domain" => "domain1.com", "Available" => "true"},
+			      "DomainCheckResult2" => {"Domain" => "domain2.com", "Available" => "false"},
+			      "DomainCheckResult3" => {"Domain" => "domain.wtf", "Available" => "error", 
+			      "ErrorNo" => "750", "Description" => "No response from the registry"}},
+			    "GMTTimeDifference"=>"--6:00", 
+			    "RequestedCommand"=>"namecheap.domains.check", 
+			    "Server"=>"SERVER159", 
+			    "ExecutionTime"=>"0.01", 
+			    "xmlns"=>"http://api.namecheap.com/xml.response"}} 
+
+      @response = NamecheapDomainCheckResponse.new(@domain_check_response_hash)
+
+    end
+
+    it "should have a domain check result" do
+      @response.items.length.should == 3
+    end
+
+    it "should report that domain1.com is available" do
+      @response.items[1].available.should be_true
+    end
+
+    it "should report that domain2.com is not available" do
+      @response.items[2].available.should be_false
+    end
+
+    it "should report errors if there are any" do
+      @response.items[0].error.should == "750"
+    end
+
+    it "should include a description if there are errors" do
+      @response.items[0].description == "No response from the registry"
+    end
+  end
+
+  describe "failure response from namecheap" do 
+    before(:each) do
+      @bad_response_hash = {"ApiResponse"=>{"Status"=>"ERROR", 
+	      "Errors"=>{"Error"=>"API Key is invalid or API access has not been enabled"}, 
+	      "GMTTimeDifference"=>"--6:00", 
+	      "RequestedCommand"=>"namecheap.domains.check", 
+	      "Server"=>"SERVER159", 
+	      "ExecutionTime"=>"0.01", 
+	      "xmlns"=>"http://api.namecheap.com/xml.response"}}
+       
+
+      it "should return false if bad hash is returned" do
+        
+      end
+    end
+  end
+end
+
+  #<?xml version="1.0" encoding="utf-8"?>
+  # <ApiResponse Status="OK" xmlns="http://api.namecheap.com/xml.response">
+  #  <Errors />
+  #  <RequestedCommand>namecheap.domains.check</RequestedCommand>
+  #  <CommandResponse Type="namecheap.domains.check">
+  #    <DomainCheckResult Domain="domain1.com" Available="true" />
+  #    <DomainCheckResult Domain="availabledomain.com" Available="false" />
+  #    <DomainCheckResult Domain="err.tld" Available="error" ErrorNo="750" Description="No response from the registry" />
+  #  </CommandResponse>
+  #  <Server>SERVER-NAME</Server>
+  #  <GMTTimeDifference>+5</GMTTimeDifference>
+  #  <ExecutionTime>32.76</ExecutionTime>
+  #</ApiResponse>
+
+

data/spec/namecheap_response_spec.rb

@@ -0,0 +1,25 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require File.dirname(__FILE__) + '/../lib/namecheap'
+
+describe NamecheapResponse  do
+  before(:each) do
+    @bad_response_hash = {"ApiResponse"=>{"Status"=>"ERROR", 
+            "Errors"=>{"Error"=>"API Key is invalid or API access has not been enabled"}, 
+            "GMTTimeDifference"=>"--6:00", 
+            "RequestedCommand"=>"namecheap.domains.check", 
+            "Server"=>"SERVER159", 
+            "ExecutionTime"=>"0.01", 
+            "xmlns"=>"http://api.namecheap.com/xml.response"}} 
+  end
+
+  it "should return a status" do
+    response = NamecheapResponse.new(@bad_response_hash)
+    response.status.should == "ERROR"
+  end
+
+  it "should give error message for invalid api key when using an invalid key" do
+    response = NamecheapResponse.new(@bad_response_hash)
+    response.message.should include("API Key is invalid")
+  end
+end
+

data/spec/namecheap_spec.rb

@@ -0,0 +1,85 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require File.dirname(__FILE__) + '/../lib/namecheap'
+require 'mocha'
+
+describe "NamecheapAPI Wrapper"  do
+  describe "initializating settings" do
+    describe "with defaults" do 
+      it "should contain a username" do
+	namecheap = Namecheap.new
+	namecheap.send(:username).should == 'apiuser'
+      end	  
+      it "should contain a key" do
+	namecheap = Namecheap.new
+	namecheap.send(:key).should == 'apikey'
+      end
+      it "should contain a client_ip" do
+	namecheap = Namecheap.new
+	namecheap.send(:client_ip).should == '127.0.0.1'
+      end
+    end
+
+    describe "with defaults overidden" do 
+      it "shoud contain a overidden username" do
+	namecheap = Namecheap.new(:username => 'testuser')
+	namecheap.send(:username).should == 'testuser'
+      end	  
+
+      it "shoud contain a key" do
+	namecheap = Namecheap.new(:key => 'testkey')
+	namecheap.send(:key).should == 'testkey'
+      end
+      it "shoud contain a client_ip" do
+	namecheap = Namecheap.new(:client_ip => '66.11.22.44')
+	namecheap.send(:client_ip).should == '66.11.22.44'
+      end
+    end
+  end
+
+  describe "Attempt to connect with bad credentials" do
+    it "should report an error on erroneous account information" do
+      namecheap = Namecheap.new
+      namecheap.domain_check("fakedomain").status.should == "ERROR"
+      end
+
+    it "should give error message for invalid api key when using an invalid key" do
+      namecheap = Namecheap.new
+      namecheap.domain_check("fakedomain").message.should include("API Key is invalid")
+    end
+  end
+
+  describe "Attempt to connect with valid credentials" do
+     
+  end
+
+  describe "#domain_check" do
+    it "should build query with multiple domains" do
+      namecheap = Namecheap.new()
+      namecheap.expects(:do_query).with("namecheap.domains.check", "&DomainList=domain1.com,domain2.com")
+      namecheap.domain_check(['domain1.com','domain2.com'])
+    end
+  end
+
+  describe "#is_domain_available?" do
+    it "should return false if connection fails" do
+      namecheap = Namecheap.new(:apikey => 'BADKEY')
+      lambda {
+	namecheap.is_domain_available?('fakedomain.tld').should be_false
+      }.should raise_error(NilNamecheapResponse)
+    end
+
+    it "should return true if connections succeeds and domain is available" do
+      pending "Need API Access To Namecheap.com"
+      namecheap = Namecheap.new
+      namecheap.is_domain_available?('saucytuborswithashoefetish.com').should be_true
+    end
+
+    it "should return false if connections succeeds and domain is not available" do
+      namecheap = Namecheap.new
+      lambda {
+	namecheap.is_domain_available?('hashrocket.com').should be_false
+      }.should raise_error(NilNamecheapResponse)
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+require 'activesupport'
+require 'activerecord'
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification 
+name: namecheap
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- parasquid
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-10-07 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: Ruby wrapper for the Namecheap API
+email: 
+- tristan.gomezd@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rvmrc
+- Gemfile
+- README.textile
+- Rakefile
+- lib/namecheap.rb
+- lib/namecheap.yml
+- lib/namecheap/version.rb
+- namecheap.gemspec
+- spec/namecheap_domain_check_response_spec.rb
+- spec/namecheap_response_spec.rb
+- spec/namecheap_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/parasquid/namecheap
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: namecheap
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Ruby wrapper for the Namecheap API
+test_files: 
+- spec/namecheap_domain_check_response_spec.rb
+- spec/namecheap_response_spec.rb
+- spec/namecheap_spec.rb
+- spec/spec_helper.rb