nic_ar 0.3.0 → 0.4.0

data/.gitignore

@@ -5,6 +5,7 @@
 .config
 .DS_Store
 .ruby-version
+.vimrc
 .yardoc
 Gemfile.lock
 InstalledFiles

data/README.rdoc

@@ -5,20 +5,28 @@
 
 The NicAr::Client class allows to you 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] (Nic.ar) website using 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] (NIC.ar) website using the third-party {nic!alert API}[http://api.nicalert.com.ar] webservice.
 
 == Usage
 
-The NicAr::Client class supports lookups for domain names, domain transactions, entities, people, DNS servers.
+The client initialization is pretty straigt-forward, and the only argument is optional.
 
-First, find out what kind of domain names you are allowed to looup.
+    nic_ar = NicAr::Client.new
+
+The optional argument is an API token that can be obtained to by-pass the CAPTCHA challenge that the NIC.ar website sometimes requests to you solve before answering your domain lookup. Please refer to the nic!alert API {official documentation}[http://api.nicalert.me/docs] for more details.
+
+    nic_ar = NicAr::Client.new("234d3cdf979e04db3d709ed8")
+
+The NicAr::Client class supports lookups for domain names. First, find out what kind of domain names you are allowed to looup.
+
+    nic_ar.whois
 
-    NicAr::Client.domains
     => [".com.ar", ".gob.ar", ".int.ar", ".mil.ar", ".net.ar", ".org.ar", ".tur.ar"]
 
 All the following lookups will raise a NicAr::NotFound exception if the requested resource could not be found.
 
-    NicAr::Client.domains("vivaserver.com.ar")
+    nic_ar.whois("vivaserver.com.ar")
+
     => {
          "status"=> {
            "available"=>false,
@@ -63,25 +71,31 @@ Please note that this output conforms to the latest update of the Nic.ar website
 
 You can also check if a given domain name resolves OK to it's DNS servers, thus effectively know if it's available online or not.
 
-    NicAr::Client.status("www.nic.ar")
-    => {
-         "domain"=>"www.nic.ar", 
-         "online"=>true, 
-         "offline"=>false, 
-         "ip"=>"200.16.109.19",
-         "host"=>"firpo.nic.ar"
-       }
+    nic_ar.status("www.nic.ar")
+
+    => { 
+          "status" => {
+            "domain"=>"www.nic.ar", 
+            "online"=>true, 
+            "offline"=>false, 
+            "ip"=>"200.16.109.19",
+            "host"=>"firpo.nic.ar"
+          }
+        }
 
 But also note that a domain name without the "www." may or may not resolve in the same way.
 
-    NicAr::Client.status("nic.ar")
+    nic_ar.status("nic.ar")
+
     => {
-         "domain"=>"nic.ar",
-         "online"=>true,
-         "offline"=>false,
-         "ip"=>"200.16.109.25", 
-         "host"=>"roldan.nic.ar"
-       }
+          "status" => {
+            "domain"=>"nic.ar",
+            "online"=>true,
+            "offline"=>false,
+            "ip"=>"200.16.109.25", 
+            "host"=>"roldan.nic.ar"
+          }
+        }
 
 Lastly, status checking only works for ".ar" (Argentina) domain names.
 

data/lib/nic_ar.rb

@@ -8,37 +8,34 @@ require 'rest_client'
 
 module NicAr
   # The base URI for the nic!alert API
-  API_URI = 'http://api.nicalert.com.ar'
+  API_URI = 'http://api.nicalert.me/v1'
 
-  # Exception for status HTTP 424: Failed Dependency
-  class CaptchaError < StandardError; end  
+  # status HTTP 204: No Content
+  class NoContent < StandardError; end  
 
-  # Exception for status HTTP 406: Not Acceptable
+  # status HTTP 400: Bad Request
   class RequestError < StandardError; end  
 
-  # Exception for status HTTP 417: Expectation Failed (available?, pending?)
-  class ExpectationError < StandardError; end  
-
-  # Exception for status HTTP 204: No Content
-  class NoContent < StandardError; end  
-
-  # Exception for status HTTP 404: Not Found
+  # status HTTP 404: Not Found
   class NotFound < StandardError; end  
 
-  # Exception for status HTTP 400: Bad Request
-  class ParameterError < StandardError; end  
+  # status HTTP 408: Request Timeout
+  class TimeoutError < StandardError; end  
 
-  # Exception for status HTTP 412: Precondition Failed
+  # status HTTP 412: Precondition Failed
   class PreconditionError < StandardError; end  
 
-  # Exception for status HTTP 500: System Error
+  # status HTTP 417: Expectation Failed (available?, pending?)
+  class ExpectationError < StandardError; end  
+
+  # status HTTP 424: Failed Dependency
+  class CaptchaError < StandardError; end  
+
+  # status HTTP 500: System Error
   class ServiceError < StandardError; end  
 
-  # Exception for status HTTP 503: Service Unavailable
+  # status HTTP 503: Service Unavailable
   class UnavailableError < StandardError; end  
-
-  # Exception for status HTTP 408: Request Timeout, 503: Service Unavailable
-  class TimeoutError < StandardError; end  
 end
 
 require "nic_ar/client"

data/lib/nic_ar/client.rb

@@ -1,74 +1,62 @@
 module NicAr
-
   # NicAr::Client
-  # Simple HTTP client for accessing the {public nic!alert API}[http://api.nicalert.com.ar].
-  # Full API spec. available at {api.nicalert.com.ar/docs}[http://api.nicalert.com.ar/docs]
+  # Simple HTTP client for accessing the {public nic!alert API}[http://api.nicalert.me].
+  # Full API spec. available at {api.nicalert.com.ar/docs}[http://api.nicalert.me/docs]
   #
   # (c)2014 Cristian R. Arroyo <cristian.arroyo@vivaserver.com>
 
   class Client
-    class << self
-      # Maps class methods to API calls
-      def method_missing(name, *args)
-        params = '/' + args.map { |p| CGI.escape(p) }.join('/') unless args.empty?
-        resource = name.to_s
-        # send the bang! trailing the request (upcoming API feat.)
-        if unbanged = resource[/(\w+)!$/,1]
-          resource = unbanged
-          params = "#{params}!"
-        end
-        get "/#{resource}#{params}"
-      end
-
-      # Acknowledge supported methods/API calls
-      def respond_to?(resource)
-        return true if %w[domains].include? resource.to_s  # old resources deprecated by new Nic.ar website
-        super
-      end
-
-      private
+    attr_reader :token
 
-      def get(path)  #:nodoc:
-        response = RestClient.get("#{api_host}/#{path}")
-        raise NoContent if response.code == 204
-        JSON.parse(response)
-      rescue RestClient::Exception => e
-        message = message_from(e.http_body)
+    def initialize(token=nil)
+      @token = token
+    end
 
-        case e.http_code
-        when 400  # Bad Request
-          raise ParameterError, message
-        when 404  # Not Found
-          raise NotFound
-        when 406  # Not Acceptable
-          raise RequestError, message
-        when 408  # Request Timeout
-          raise TimeoutError, message
-        when 412  # Precondition Failed
-          raise PreconditionError, message
-        when 417  # Expectation Failed
-          raise ExpectationError, message
-        when 424  # Failed Dependency
-          raise CaptchaError, message
-        when 500  # System Error
-          raise ServiceError, message
-        when 503  # Service Unavailable
-          raise UnavailableError, message
-        else
-          raise e
-        end
+    def whois(name=nil)  #:nodoc:
+      if name
+        request "whois/#{name}" + (@token.nil? || @token.empty?? '' : "?token=#{@token}")
+      else
+        request "whois"
       end
+    end
 
-      def message_from(response)  #:nodoc:
-        JSON.parse(response)['message']
-      rescue
-        nil
+    private
+
+    def request(path)  #:nodoc:
+      response = RestClient.get("#{api_host}/#{path}")
+      JSON.parse(response)
+    rescue RestClient::Exception => e
+      message = message_from(e.http_body)
+      case e.http_code
+      when 400  # Bad Request
+        fail RequestError, message
+      when 404  # Not Found
+        fail NotFound
+      when 408  # Request Timeout
+        fail TimeoutError, message
+      when 412  # Precondition Failed
+        fail PreconditionError, message  # PageError
+      when 424  # Failed Dependency
+        fail CaptchaError, message       # CaptchaError
+      when 500  # System Error
+        fail ServiceError, message
+      when 503  # Service Unavailable
+        fail UnavailableError, message
+      else
+        raise e
       end
+    end
 
-      # override to support multiple API hosts
-      def api_host  #:nodoc:
-        API_URI
-      end
+    def message_from(response)  #:nodoc:
+      result = JSON.parse(response)
+      result['error']['message'] if result.has_key? 'error'
+    rescue
+      nil
+    end
+
+    # override to support multiple API hosts
+    def api_host  #:nodoc:
+      API_URI
     end
   end
 end

data/lib/nic_ar/version.rb

@@ -1,4 +1,4 @@
 module NicAr
   # This Gem version does not map the API version in any way.
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/spec/client_spec.rb

@@ -1,42 +1,38 @@
 require_relative 'spec_helper'
 
 describe 'NicAr::Client' do
-  it 'fixes respond_to?' do
-    refute NicAr::Client.respond_to? :dns_servers  # old resources deprecated by new Nic.ar website
-    assert NicAr::Client.respond_to? :domains
-    refute NicAr::Client.respond_to? :entities
-    refute NicAr::Client.respond_to? :people
-    refute NicAr::Client.respond_to? :transactions
+  subject do
+    NicAr::Client.new
   end
 
-  describe 'when receiving invalid requests' do
-    it 'rejects single invalid requests' do
-      stub_request(:get,/invalid_request$/).to_return(:status => 406)
-      proc { NicAr::Client.invalid_request }.must_raise NicAr::RequestError
-    end
-
-    it 'also rejects invalid requests with parameters' do
-      stub_request(:get,/invalid_request\/with\/parameters$/).to_return(:status => 406)
-      proc { NicAr::Client.invalid_request 'with', 'parameters' }.must_raise NicAr::RequestError
-    end
+  it 'deprecates some old methods' do
+    assert subject.respond_to? :whois
+    refute subject.respond_to? :domains
+    refute subject.respond_to? :entities
+    refute subject.respond_to? :people
+    refute subject.respond_to? :transactions
   end
 
   describe 'Domains lookups' do
+    it 'sends no token by default' do
+      subject.token.must_be_nil
+    end
+
     it 'knows what kind of domains to lookup' do
-      stub_request(:get,/domains$/).to_return(:body => '[".com.ar", ".gob.ar", ".int.ar", ".mil.ar", ".net.ar", ".org.ar", ".tur.ar"]')
-      result = NicAr::Client.domains
+      stub_request(:get,/whois$/).to_return(:body => '[".com.ar", ".gob.ar", ".int.ar", ".mil.ar", ".net.ar", ".org.ar", ".tur.ar"]')
+      result = subject.whois
       result.must_be_instance_of Array
       result.wont_be_empty
     end
 
     it 'raises on unexisting domains' do
-      stub_request(:get,/domains\/hispafuentes\.com\.ar$/).to_return(:status => 404)
-      proc { NicAr::Client.domains 'hispafuentes.com.ar' }.must_raise NicAr::NotFound
+      stub_request(:get,/whois\/hispafuentes\.com\.ar$/).to_return(:status => 404)
+      proc { subject.whois 'hispafuentes.com.ar' }.must_raise NicAr::NotFound
     end
 
     it 'returns a Hash for Domain lookups' do
-      stub_request(:get,/domains\/dww\.com\.ar$/).to_return(:body => stub_for('domains/dww.com.ar'))
-      result = NicAr::Client.domains 'dww.com.ar'
+      stub_request(:get,/whois\/dww\.com\.ar$/).to_return(:body => stub_for('domains/dww.com.ar'))
+      result = subject.whois 'dww.com.ar'
       result.must_be_instance_of Hash
       result['name'].must_equal 'dww.com.ar'
     end

metadata

@@ -2,14 +2,14 @@
 name: nic_ar
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Cristian R. Arroyo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-14 00:00:00.000000000 Z
+date: 2014-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   prerelease: false
@@ -109,7 +109,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       segments:
       - 0
-      hash: 2419756568503364636
+      hash: -3292143947690208492
       version: '0'
   none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
@@ -118,12 +118,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       segments:
       - 0
-      hash: 2419756568503364636
+      hash: -3292143947690208492
       version: '0'
   none: false
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 1.8.28
 signing_key: 
 specification_version: 3
 summary: A simple client for ".ar" (Argentina) domain names lookups using the nic!alert