nic_ar 0.0.5 → 0.1.0

data/{README.md → README.rdoc}

@@ -1,24 +1,10 @@
-# NicAr::Client
+= NicAr::Client
 
-The NicAr::Client gem allows to programatically extract information about any ".ar" (Argentina) domain name. 
+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) 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] website using the third-party {nic!alert API}[http://api.nicalert.com.ar] webservice.
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'nic_ar'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install nic_ar
-
-## Usage
+== Usage
 
 The NicAr::Client class supports lookups for domain names, domain transactions, entities, people, DNS servers.
 
@@ -141,21 +127,21 @@ Transactions can also be queried by it's unique identifier:
          "notes"=>"Se envio acuse de recibo al solicitante"
        }
 
-## Hacking
+== 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 <b>nic!alert API</b> 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 examples
+== Live examples
 
-### nic!alert
+=== nic!alert
 
-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.
+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.
 
-### Nic.ar Whois domain
+=== Nic.ar Whois domain
 
-A very nice Node.js application that provides "typeahead" domain searching capabilities. The wesite is [hosted at Heroku](http://nicar.herokuapp.com/) and it's [code at GitHub](https://github.com/danzajdband/nicar-whois). Credits to Dan Zajdband.
+A very nice Node.js application that provides "typeahead" domain searching capabilities. The wesite is {hosted at Heroku}[http://nicar.herokuapp.com/] and it's {code at GitHub}[https://github.com/danzajdband/nicar-whois]. Credits to Dan Zajdband.
 
-## Contributing
+== Contributing
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
@@ -163,6 +149,6 @@ A very nice Node.js application that provides "typeahead" domain searching capab
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
-## Copyright
+== Copyright
 
-Copyright (c)2012 [Cristian R. Arroyo](mailto:cristian.arroyo@vivasserver.com). MIT Licensed.
+Copyright (c)2012 {Cristian R. Arroyo}[mailto:cristian.arroyo@vivasserver.com]

data/lib/nic_ar/client.rb

@@ -1,6 +1,12 @@
 module NicAr
+
+  # Simple HTTP client for accessing the public {nic!alert API}[http://api.nicalert.com.ar].
+  #
+  # Full API spec. available at {api.nicalert.com.ar}[http://api.nicalert.com.ar]
+  #
   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
@@ -48,6 +54,8 @@ module NicAr
         #500: System Error
         when 500
           raise ServiceError, message
+        else
+          raise e
         end
       end
 
@@ -58,7 +66,6 @@ module NicAr
       end
 
       # override to support multiple API hosts
-
       def api_host  #:nodoc:
         API_URI
       end

data/lib/nic_ar/version.rb

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

data/lib/nic_ar.rb

@@ -4,20 +4,38 @@ require 'rubygems'
 require 'bundler/setup'
 require 'rest_client'
 
+# NicAr is the _official_ Ruby gem for accessing the {nic!alert API}[http://api.nicalert.com.ar]. See the README.rdoc
+
 module NicAr
+  # The base URI for the nic!alert API.
   API_URI = 'http://api.nicalert.com.ar'
 
-  # exceptions match API's error codes
-
-  class CaptchaError      < StandardError; end  #424: Failed Dependency
-  class RequestError      < StandardError; end  #406: Not Acceptable
-  class ExpectationError  < StandardError; end  #417: Expectation Failed (available?, pending?)
-  class NoContent         < StandardError; end  #204: No Content
-  class NotFound          < StandardError; end  #404: Not Found
-  class ParameterError    < StandardError; end  #400: Bad Request
-  class PreconditionError < StandardError; end  #412: Precondition Failed
-  class ServiceError      < StandardError; end  #500: System Error
-  class TimeoutError      < StandardError; end  #408: Request Timeout
+  # Exception for status HTTP 424: Failed Dependency
+  class CaptchaError < StandardError; end  
+
+  # Exception for status HTTP 406: Not Acceptable
+  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
+  class NotFound < StandardError; end  
+
+  # Exception for status HTTP 400: Bad Request
+  class ParameterError < StandardError; end  
+
+  # Exception for status HTTP 412: Precondition Failed
+  class PreconditionError < StandardError; end  
+
+  # Exception for status HTTP 500: System Error
+  class ServiceError < StandardError; end  
+
+  # Exception for status HTTP 408: Request Timeout
+  class TimeoutError < StandardError; end  
 end
 
 require "nic_ar/client"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nic_ar
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-02 00:00:00.000000000Z
+date: 2012-11-04 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &76028530 !ruby/object:Gem::Requirement
+  requirement: &70638290 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '1.6'
   type: :runtime
   prerelease: false
-  version_requirements: *76028530
+  version_requirements: *70638290
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &76028270 !ruby/object:Gem::Requirement
+  requirement: &70638020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '3.3'
   type: :development
   prerelease: false
-  version_requirements: *76028270
+  version_requirements: *70638020
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &76027960 !ruby/object:Gem::Requirement
+  requirement: &70637730 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,7 +43,7 @@ dependencies:
         version: '1.8'
   type: :development
   prerelease: false
-  version_requirements: *76027960
+  version_requirements: *70637730
 description: A simple client for ".ar" (Argentina) domain names lookups
 email:
 - cristian.arroyo@vivaserver.com
@@ -54,7 +54,7 @@ files:
 - .gitignore
 - Gemfile
 - LICENSE.txt
-- README.md
+- README.rdoc
 - Rakefile
 - lib/nic_ar.rb
 - lib/nic_ar/client.rb