nic_ar 0.0.1 → 0.0.2

data/README.md

@@ -2,7 +2,7 @@
 
 The NicAr::Client gem allows to programatically extract information about any ".ar" (Argentina) domain name. 
 
-It uses the public information as is made available at the [Dirección Nacional del Registro de Dominios de Internet](http://www.nic.ar) via the third-party [nic!alert API](http://api.nicalert.com.ar) webservice.
+It uses the public information as is made available at the [Dirección Nacional del Registro de Dominios de Internet](http://www.nic.ar) website using the third-party [nic!alert API](http://api.nicalert.com.ar) webservice.
 
 ## Installation
 
@@ -25,30 +25,122 @@ The NicAr::Client class supports lookups for domain names, domain transactions,
 All the following lookups will raise a NicAr::NotFound exception if the requested resource could not be found.
 
     NicAr::Client.domains("vivaserver.com.ar")
-    => {"available"=>false, "delegated"=>true, "expiring"=>false, "pending"=>false, "registered"=>true, "name"=>"vivaserver", "domain"=>".com.ar", "created_on"=>"2004-11-18", "expires_on"=>"2012-11-18", "contacts"=>{"registrant"=>{"name"=>"Cristian Renato Arroyo", "occupation"=>"Diseno de Paginas Web", "address"=>"Pje. Vucetich 676. Ciudad De Nieva", "city"=>"S. S. de Jujuy", "province"=>"Jujuy", "zip_code"=>"4600", "country"=>"Argentina", "phone"=>"(0388)155827713", "fax"=>"(0388)155827713"}, "responsible"=>{"name"=>"Cristian Renato Arroyo", "address"=>"Pje. Vucetich 676. Ciudad De Nieva.", "city"=>"S. S. de jujuy", "province"=>"Jujuy", "zip_code"=>"4600", "country"=>"Argentina", "phone"=>"(0388)155827713", "fax"=>"(0388)155827713", "work_hours"=>"8am-1pm"}, "administrative"=>{"name"=>"Dynamic DNS Network Services", "address"=>"210 Park Ave. #267", "city"=>"Worcester", "province"=>"", "zip_code"=>"MA 01609", "country"=>"USA", "phone"=>"1-508-798-2145", "fax"=>"1-508-798-5748", "activity"=>"Network Services"}, "technical"=>{"name"=>"Andre Dure", "address"=>"Humahuaca 1303", "city"=>"Capital Federal", "province"=>"Ciudad de Buenos Aires", "zip_code"=>"C1405BIA", "country"=>"Argentina", "phone"=>"49588864", "fax"=>"43335885", "work_hours"=>"10 a 22"}}, "dns_servers"=>{"primary"=>{"host"=>"ns1.mydyndns.org", "ip"=>nil}, "secondary"=>{"host"=>"ns2.mydyndns.org", "ip"=>nil}, "alternate1"=>{"host"=>"ns3.mydyndns.org", "ip"=>nil}, "alternate2"=>{"host"=>"ns4.mydyndns.org", "ip"=>nil}, "alternate3"=>{"host"=>"ns5.mydyndns.org", "ip"=>nil}}}
+    => {
+         "available"=>false,
+         "delegated"=>true,
+         "expiring"=>false,
+         "pending"=>false,
+         "registered"=>true,
+         "name"=>"vivaserver",
+         "domain"=>".com.ar",
+         "created_on"=>"2004-11-18",
+         "expires_on"=>"2012-11-18",
+         "contacts"=> {
+           "registrant"=>{
+             "name"=>"Cristian Renato Arroyo",
+             "occupation"=>"Diseno de Paginas Web",
+             "address"=>"Pje. Vucetich 676. Ciudad De Nieva",
+             "city"=>"S. S. de Jujuy",
+             "province"=>"Jujuy",
+             "zip_code"=>"4600",
+             "country"=>"Argentina",
+             "phone"=>"(0388)155827713",
+             "fax"=>"(0388)155827713"},
+           "responsible"=>{
+             "name"=>"Cristian Renato Arroyo",
+             "address"=>"Pje. Vucetich 676. Ciudad De Nieva.",
+             "city"=>"S. S. de jujuy",
+             "province"=>"Jujuy",
+             "zip_code"=>"4600",
+             "country"=>"Argentina",
+             "phone"=>"(0388)155827713",
+             "fax"=>"(0388)155827713",
+             "work_hours"=>"8am-1pm"},
+           "administrative"=>{
+             "name"=>"Dynamic DNS Network Services",
+             "address"=>"210 Park Ave. #267",
+             "city"=>"Worcester",
+             "province"=>"",
+             "zip_code"=>"MA 01609",
+             "country"=>"USA",
+             "phone"=>"1-508-798-2145",
+             "fax"=>"1-508-798-5748",
+             "activity"=>"Network Services"},
+           "technical"=>{
+             "name"=>"Andre Dure",
+             "address"=>"Humahuaca 1303",
+             "city"=>"Capital Federal",
+             "province"=>"Ciudad de Buenos Aires",
+             "zip_code"=>"C1405BIA",
+             "country"=>"Argentina",
+             "phone"=>"49588864",
+             "fax"=>"43335885",
+             "work_hours"=>"10 a 22"}
+           },
+         "dns_servers"=>{
+           "primary"=>{"host"=>"ns1.mydyndns.org", "ip"=>nil},
+           "secondary"=>{"host"=>"ns2.mydyndns.org", "ip"=>nil},
+           "alternate1"=>{"host"=>"ns3.mydyndns.org", "ip"=>nil},
+           "alternate2"=>{"host"=>"ns4.mydyndns.org", "ip"=>nil},
+           "alternate3"=>{"host"=>"ns5.mydyndns.org", "ip"=>nil}
+         }
+       }
+
+All registered domains have a related entities (registrant/administrative contacts) and persons (responsible/technical contacts).
 
     NicAr::Client.entities("Dynamic DNS Network Services")
-    => {"name"=>"Dynamic DNS Network Services", "type"=>"ADMINISTRADORA", "address"=>"210 Park Ave. #267", "city"=>"Worcester", "province"=>nil, "country"=>"USA", "activity"=>"Network Services", "handle"=>"NICAR-E607791"}
+    => {
+         "name"=>"Dynamic DNS Network Services",
+         "type"=>"ADMINISTRADORA",
+         "address"=>"210 Park Ave. #267",
+         "city"=>"Worcester",
+         "province"=>nil,
+         "country"=>"USA",
+         "activity"=>"Network Services",
+         "handle"=>"NICAR-E607791"
+       }
 
     NicAr::Client.people("Andre Dure")
     => {"name"=>"Andre Dure", "handle"=>"NICAR-P425476"}
 
+DNS Servers can also be queried by hostname or IP.
+
     NicAr::Client.dns_servers("ns1.mydyndns.org")
-    => {"host"=>"ns1.mydyndns.org", "ip"=>nil, "owner"=>"Andre Dure", "operator"=>"Andre Dure", "handle"=>"NICAR-H12587"}
+    => {
+         "host"=>"ns1.mydyndns.org",
+         "ip"=>nil,
+         "owner"=>"Andre Dure",
+         "operator"=>"Andre Dure",
+         "handle"=>"NICAR-H12587"
+       }
 
-If a domain name has no recent transactions, a NicAr::NoContent exception will be raised.
+If a domain name has no recent transactions, a NicAr::NoContent exception will be raised. Otherwise an array of recent transactions will be returned.
 
     NicAr::Client.transactions("nazarenorock.com.ar")
-    => [{"id"=>"REG18127727", "created_at"=>"2012-10-03T15:11:01-03:00", "description"=>"Registro de Nombre", "status"=>"PENDIENTE", "notes"=>"Se envio acuse de recibo al solicitante"}]
+    => [{
+          "id"=>"REG18127727",
+          "created_at"=>"2012-10-03T15:11:01-03:00",
+          "description"=>"Registro de Nombre",
+          "status"=>"PENDIENTE",
+          "notes"=>"Se envio acuse de recibo al solicitante"
+        }]
 
 Transactions can also be queried by it's unique identifier:
 
     NicAr::Client.transactions("REG18127727")
-    => {"domain"=>"nazarenorock.com.ar", "created_at"=>"2012-10-03T15:11:01-03:00", "description"=>"Registro de Nombre", "status"=>"PENDIENTE", "notes"=>"Se envio acuse de recibo al solicitante"}
+    => {
+         "domain"=>"nazarenorock.com.ar",
+         "created_at"=>"2012-10-03T15:11:01-03:00",
+         "description"=>"Registro de Nombre",
+         "status"=>"PENDIENTE",
+         "notes"=>"Se envio acuse de recibo al solicitante"
+       }
+
+## Hacking
 
-The full documentation of the nic!alert API is available at [api.nicalert.com.ar](http://api.nicalert.com.ar) if you want to write your own client, use any other language, or just use CURL in a RESTful way.
+The full documentation of the **nic!alert API** is available at [api.nicalert.com.ar](http://api.nicalert.com.ar) if you want to write your own client, use any other language, or just use CURL in a RESTful way.
 
-## Live sample
+## Live examples
 
 A live test application is set up at the [nic!alert](http://www.nicalert.com.ar) website that allows for the automatic renewal of ".ar" domain names within their 30-day expiring period. The application also has the added feature of resolving the CAPTCHA challenge for the submission of the renewal request.
 

data/Rakefile

@@ -1 +1,8 @@
 require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib' << 'spec'
+  t.verbose = false
+  t.pattern = 'spec/*_spec.rb'
+end

data/lib/nic_ar/version.rb

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

data/nic_ar.gemspec

@@ -8,11 +8,12 @@ Gem::Specification.new do |gem|
   gem.version       = NicAr::VERSION
   gem.authors       = ["Cristian R. Arroyo"]
   gem.email         = ["cristian.arroyo@vivaserver.com"]
-  gem.description   = %q{A simple client for the nic!alert API}
+  gem.description   = %q{A simple client for ".ar" (Argentina) domain names lookup}
   gem.summary       = %q{A simple client for ".ar" (Argentina) domain names lookup using the nic!alert API}
   gem.homepage      = "https://github.com/vivaserver/nic_ar"
 
-  gem.add_runtime_dependency 'rest-client', "~> 1.6"
+  gem.add_runtime_dependency 'rest-client', '~> 1.6'
+  gem.add_development_dependency 'minitest', '~> 3.3.0'
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/spec/client_spec.rb

@@ -0,0 +1,105 @@
+require_relative 'spec_helper'
+
+describe 'nic!alert API client' do
+  it 'raises ArgumentError if no parameter to resource given' do
+    proc { NicAr::Client.people }.must_raise ArgumentError
+  end
+
+  describe 'using stubbed API responses' do
+    it 'has flexible support for multiple arguments' do
+      RestClient.stub :get, response('transactions/macusadas.com.ar.REN') do
+        result = NicAr::Client.domains 'macusadas.com.ar', 'transactions'
+        result.must_be_instance_of Array
+        transaction = result.first
+        transaction.must_be_instance_of Hash
+        transaction['id'].must_equal 'REN17330833'
+        transaction['status'].must_equal 'FINALIZADO'
+        transaction['description'].must_equal 'Renovacion de Nombre'
+      end
+    end
+
+    describe 'DNS lookups' do
+      it 'returns a hash for primary DNS lookups' do
+        RestClient.stub :get, response('dns_servers/ns1.sedoparking.com') do
+          result = NicAr::Client.dns_servers 'ns1.sedoparking.com'
+          result.must_be_instance_of Hash
+          result['host'].must_equal   'ns1.sedoparking.com'
+          result['handle'].must_equal 'NICAR-H24966'
+        end
+      end
+
+      it 'returns a hash for secondary DNS lookups' do
+        RestClient.stub :get, response('dns_servers/ns2.sedoparking.com') do
+          result = NicAr::Client.dns_servers 'ns2.sedoparking.com'
+          result.must_be_instance_of Hash
+          result['host'].must_equal 'ns2.sedoparking.com'
+          result['handle'].must_equal 'NICAR-H24965'
+        end
+      end
+    end
+
+    describe 'Domains lookups' do
+      it 'returns Nil for Domain 404s' do
+        skip
+        RestClient.stub :get, proc { raise RestClient::ResourceNotFound } do
+          proc { NicAr::Client.domains 'hispafuentes.com.ar' }.must_raise NicAr::NotFound
+        end
+      end
+
+      it 'returns a Hash for Domain lookups' do
+        RestClient.stub :get, response('domains/dww.com.ar') do
+          result = NicAr::Client.domains 'dww.com.ar'
+          result.must_be_instance_of Hash
+          result['name'].must_equal   'dww'
+          result['domain'].must_equal '.com.ar'
+        end
+      end
+    end
+
+    describe 'Entities lookups' do
+      it 'returns an Entity hash for lookups' do
+        RestClient.stub :get, response('entities/Sedo.com LLC') do
+          result = NicAr::Client.entities 'Sedo.com LLC'
+          result.must_be_instance_of Hash
+          result['name'].must_equal   'Sedo.com LLC'
+          result['handle'].must_equal 'NICAR-E779784'
+        end
+      end
+    end
+
+    describe 'Persons lookups' do
+      it 'returns a Person hash for lookups' do
+        RestClient.stub :get, response('persons/Sedo.com LLC - Technical Contact') do
+          result = NicAr::Client.persons 'Sedo.com LLC - Technical Contact'
+          result.must_be_instance_of Hash
+          result['name'].must_equal   'Sedo.com LLC - Technical Contact'
+          result['handle'].must_equal 'NICAR-P1280916'
+        end
+      end
+    end
+
+    describe 'Transactions lookups' do
+      it 'returns a Transactions array for domains lookups' do
+        RestClient.stub :get, response('transactions/macusadas.com.ar.REN') do
+          result = NicAr::Client.transactions 'macusadas.com.ar'
+          result.must_be_instance_of Array
+          result.count.must_equal 1
+          transaction = result.first
+          transaction.must_be_instance_of Hash
+          transaction['id'].must_equal 'REN17330833'
+          transaction['status'].must_equal 'FINALIZADO'
+          transaction['description'].must_equal 'Renovacion de Nombre'
+        end
+      end
+
+      it 'returns a Transaction hash for single transaction lookups' do
+        RestClient.stub :get, response('transactions/REN17330833') do
+          result = NicAr::Client.transactions 'REN17330833'
+          result['domain'].must_equal 'macusadas.com.ar'
+          result['status'].must_equal 'FINALIZADO'
+          result['description'].must_equal 'Renovacion de Nombre'
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require_relative '../lib/nic_ar'
+require 'minitest/autorun'
+
+def response(request)
+  JSON.parse(File.read(File.join(File.dirname(__FILE__),'stubs',"#{request}.json")))
+end

data/spec/stubs/dns_servers/ns1.sedoparking.com.json

@@ -0,0 +1 @@
+{"host":"ns1.sedoparking.com","ip":null,"owner":"Sedo.com LLC","operator":"Sedo.com LLC - Technical Contact","handle":"NICAR-H24966"}

data/spec/stubs/dns_servers/ns2.sedoparking.com.json

@@ -0,0 +1 @@
+{"host":"ns2.sedoparking.com","ip":null,"owner":"Sedo.com LLC","operator":"Sedo.com LLC - Technical Contact","handle":"NICAR-H24965"}

data/spec/stubs/domains/dww.com.ar.json

@@ -0,0 +1 @@
+{"available":false,"delegated":true,"expiring":false,"pending":false,"registered":true,"name":"dww","domain":".com.ar","created_on":"2010-05-18","expires_on":"2013-05-18","days_to_expire":389,"contacts":{"registrant":{"name":"Werlen Analia Guadalupe","occupation":"Diseno de Paginas Web","address":"Soler 138","city":"Cordoba","province":"Cordoba","zip_code":"5000","country":"Argentina","phone":"0351473506","fax":"no"},"responsible":{"name":"Chavarini Leonardo Ariel","address":"Guemes 153","city":"Rafaela","province":"Santa Fe","zip_code":"S2300FNC","country":"Argentina","phone":"3492-15-585634","fax":"no","work_hours":"17-21 leochavarini@gmail.com"},"administrative":{"name":"Sedo.com LLC","address":"One Broadway 1 14","city":"Cambridge, MA","province":"","zip_code":"02142","country":"Argentina","phone":"1.6177584266","fax":"1.6175773983","activity":"Proveedor de Servicios de Internet"},"technical":{"name":"Sedo.com LLC - Technical Contact","address":"One Broadway 1 14","city":"Cambridge, MA","province":"","zip_code":"02142","country":"Estados Unidos","phone":"1.6177584266","fax":"1.6175773983","work_hours":"24x7x365"}},"dns_servers":{"primary":{"host":"ns1.sedoparking.com","ip":null},"secondary":{"host":"ns2.sedoparking.com","ip":null},"alternate1":{"host":null,"ip":null},"alternate2":{"host":null,"ip":null},"alternate3":{"host":null,"ip":null}}}

data/spec/stubs/entities/Sedo.com LLC.json

@@ -0,0 +1 @@
+{"name":"Sedo.com LLC","type":"ADMINISTRADORA","address":"One Broadway 1 14","city":"Cambridge, MA","province":null,"country":"Argentina","activity":"Proveedor de Servicios de Internet","handle":"NICAR-E779784"}

data/spec/stubs/persons/Sedo.com LLC - Technical Contact.json

@@ -0,0 +1 @@
+{"name":"Sedo.com LLC - Technical Contact","handle":"NICAR-P1280916"}

data/spec/stubs/transactions/REN17330833.json

@@ -0,0 +1 @@
+{"domain":"macusadas.com.ar","created_at":"2012-06-20T22:15:50-03:00","description":"Renovacion de Nombre","status":"FINALIZADO","notes":"Tramite finalizado el 20/06/12."}

data/spec/stubs/transactions/macusadas.com.ar.REN.json

@@ -0,0 +1 @@
+[{"id":"REN17330833","created_at":"2012-06-20T22:15:50-03:00","description":"Renovacion de Nombre","status":"FINALIZADO","notes":"Tramite finalizado el 20/06/12."}]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nic_ar
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-31 00:00:00.000000000Z
+date: 2012-11-01 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &85718140 !ruby/object:Gem::Requirement
+  requirement: &72038150 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,8 +21,19 @@ dependencies:
         version: '1.6'
   type: :runtime
   prerelease: false
-  version_requirements: *85718140
-description: A simple client for the nic!alert API
+  version_requirements: *72038150
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &72037900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *72037900
+description: A simple client for ".ar" (Argentina) domain names lookup
 email:
 - cristian.arroyo@vivaserver.com
 executables: []
@@ -38,6 +49,15 @@ files:
 - lib/nic_ar/client.rb
 - lib/nic_ar/version.rb
 - nic_ar.gemspec
+- spec/client_spec.rb
+- spec/spec_helper.rb
+- spec/stubs/dns_servers/ns1.sedoparking.com.json
+- spec/stubs/dns_servers/ns2.sedoparking.com.json
+- spec/stubs/domains/dww.com.ar.json
+- spec/stubs/entities/Sedo.com LLC.json
+- spec/stubs/persons/Sedo.com LLC - Technical Contact.json
+- spec/stubs/transactions/REN17330833.json
+- spec/stubs/transactions/macusadas.com.ar.REN.json
 homepage: https://github.com/vivaserver/nic_ar
 licenses: []
 post_install_message: 
@@ -63,4 +83,13 @@ signing_key:
 specification_version: 3
 summary: A simple client for ".ar" (Argentina) domain names lookup using the nic!alert
   API
-test_files: []
+test_files:
+- spec/client_spec.rb
+- spec/spec_helper.rb
+- spec/stubs/dns_servers/ns1.sedoparking.com.json
+- spec/stubs/dns_servers/ns2.sedoparking.com.json
+- spec/stubs/domains/dww.com.ar.json
+- spec/stubs/entities/Sedo.com LLC.json
+- spec/stubs/persons/Sedo.com LLC - Technical Contact.json
+- spec/stubs/transactions/REN17330833.json
+- spec/stubs/transactions/macusadas.com.ar.REN.json