whois 1.3.0 → 1.3.1

data/CHANGELOG.rdoc

@@ -1,5 +1,27 @@
 = Changelog
 
+
+== Release 1.3.1
+
+* SERVER: Added the following 10 new IDN TLD:
+    * .xn--fzc2c9e2c (.ලංකා, Sri Lanka)
+    * .xn--j6w193g (.香港, Hong Kong)
+    * .xn--kprw13d (.台灣, Taiwan)
+    * .xn--kpry57d (.台湾, Taiwan)
+    * .xn--mgbayh7gpa (.الاردن, Jordan)
+    * .xn--o3cw4h (.ไทย, Thailand)
+    * .xn--pgbs0dh (.تونس, Tunisia)
+    * .xn--wgbh1c (.مصر, Egypt)
+    * .xn--xkc2al3hye2a (.இலங்கை, Sri Lanka)
+    * .xn--ygbi2ammx (.فلسطين, Palestinian Territory, Occupied)
+
+* SERVER: Sync definitions with Debian whois 5.0.7:
+    * Added new IPv4 allocations.
+    * Updated the .bd, .bo, .cm, .cu, .dz, .gr, .lb, .ni, .rw, .tw, and .tz TLD servers.
+
+* REMOVED: Deprecated Whois::Answer::Parser.properties method.
+
+
 == Release 1.3.0
 
 * ADDED: Ability to query IANA for TLD WHOIS information. [aadlani]

data/README.rdoc

@@ -2,7 +2,7 @@
 
 Whois is an intelligent pure Ruby WHOIS client and parser.
 
-It is a OS-independent library and doesn't require external C libraries or Gems: it is a 100% Ruby software with all the advantages and disadvantages that it involves.
+It is a OS-independent library and doesn't require external C libraries or Gems: it is a 100% Ruby software.
 
 This software was developed to power {RoboDomain}[http://www.robodomain.com] and, since July 2009, it ran more than thousands requests.
 
@@ -11,20 +11,20 @@ An extensive test suite is available to verify the library correctness but you m
 
 == Features
 
-* Pure Ruby library without any external dependency other than Ruby itself
-* Intelligent Ruby client
-* Flexible and extensible configuration with support for user-defined servers
-* Powerful whois response parser
-* Support for IPv6, IPv4, TLD and domain WHOIS queries
-* Object oriented design
-* Compatible with Ruby 1.8.6 and newer, including Ruby 1.9
+* Ability to query registry data for IPv4, IPv6, TLDs, and domain names
+* Ability to parse WHOIS responses
+* Flexible and extensible interface (e.g. You can define custom servers on the fly)
+* Object oriented design, featuring 10 different design patterns
+* Pure Ruby library, without any external dependency other than Ruby itself
+* Compatible with Ruby 1.8.6 and greater, including Ruby 1.9 branch
+* Successfully tested against multiple Ruby platforms and versions including Ruby, Ruby Enterprise Edition and MacRuby
 
 
 == Requirements
 
 * Ruby >= 1.8.6
 
-Whois has been {successfully tested}[http://www.ruby-whois.org/manual/installation.html] against the following Ruby platforms:
+Whois has been {successfully tested}[http://www.ruby-whois.org/manual/installation.html] against the following Ruby interpreters:
 
 * Ruby 1.8.6 / 1.8.7 / 1.9.1 / 1.9.2
 * MacRuby
@@ -184,8 +184,8 @@ Bug reports and Feature suggestions {are welcomed}[http://github.com/weppos/whoi
 == More
 
 * {Homepage}[http://www.ruby-whois.org]
-* {GitHub Repository}[http://github.com/weppos/whois]
-* {API Documentation}[http://www.ruby-whois.org/api/]
+* {Repository}[http://github.com/weppos/whois]
+* {API Documentation}[http://www.ruby-whois.org/api/] (RDoc)
 * {Discussion Group}[http://groups.google.com/group/ruby-whois]
 
 

data/lib/whois.rb

@@ -32,9 +32,15 @@ module Whois
   # Queries the right WHOIS server for <tt>qstring</tt> and returns
   # the response from the server.
   #
-  # qstring - The String to be sent as query parameter.
+  # ==== Parameters
   #
-  # Examples
+  # qstring:: The String to be sent as query parameter.
+  #
+  # ==== Returns
+  #
+  # Whois::Answer:: The answer containing the response from the WHOIS server.
+  #
+  # ==== Examples
   #
   #   Whois.query("google.com")
   #   # => #<Whois::Answer>
@@ -44,18 +50,30 @@ module Whois
   #   Whois::Client.new.query("google.com")
   #   # => #<Whois::Answer>
   #
-  # Returns a <tt>Whois::Answer</tt> instance.
   def self.query(qstring)
     Client.new.query(qstring)
   end
 
   # Checks whether the object represented by <tt>qstring</tt> is available.
   #
-  # qstring - The String to be sent as query parameter.
-  #   It is intented to be a domain name, otherwise this method
-  #   may return unexpected responses.
+  # Warning: this method is only available if a Whois parser exists
+  # for the top level domain of <tt>qstring</tt>.
+  # If no parser exists for <tt>qstring</tt>, you'll receive a 
+  # warning message and the method will return <tt>nil</tt>.
+  # This is a technical limitation. Browse the lib/whois/answer/parsers
+  # folder to view all available parsers.
+  #
+  # ==== Parameters
+  #
+  # qstring:: The String to be sent as query parameter.
+  #           It is intended to be a domain name, otherwise this method
+  #           may return unexpected responses.
+  #
+  # ==== Returns
   #
-  # Examples
+  # Boolean
+  #
+  # ==== Examples
   #
   #   Whois.available?("google.com")
   #   # => false
@@ -63,14 +81,6 @@ module Whois
   #   Whois.available?("google-is-not-available-try-again-later.com")
   #   # => true
   #
-  # Warning: this method is only available if a Whois parser exists
-  # for the top level domain of <tt>qstring</tt>.
-  # If no parser exists for <tt>qstring</tt>, you'll receive a warning message
-  # and the method will return <tt>nil</tt>.
-  # This is a technical limitation. Browse the lib/whois/answer/parsers folder
-  # to view all available parsers.
-  #
-  # Returns a <tt>true</tt> if the domain is available.
   def self.available?(qstring)
     query(qstring).available?
   rescue ParserNotFound => e
@@ -81,11 +91,24 @@ module Whois
 
   # Checks whether the object represented by <tt>qstring</tt> is registered.
   #
-  # qstring - The String to be sent as query parameter.
-  #           It is intented to be a domain name, otherwise this method
+  # Warning: this method is only available if a Whois parser exists
+  # for the top level domain of <tt>qstring</tt>.
+  # If no parser exists for <tt>qstring</tt>, you'll receive a warning message
+  # and the method will return <tt>nil</tt>.
+  # This is a technical limitation. Browse the lib/whois/answer/parsers folder
+  # to view all available parsers.
+  #
+  # ==== Parameters
+  #
+  # qstring:: The String to be sent as query parameter.
+  #           It is intended to be a domain name, otherwise this method
   #           may return unexpected responses.
   #
-  # Examples
+  # ==== Returns
+  #
+  # Boolean
+  #
+  # ==== Examples
   #
   #   Whois.registered?("google.com")
   #   # => true
@@ -93,14 +116,6 @@ module Whois
   #   Whois.registered?("google-is-not-available-try-again-later.com")
   #   # => false
   #
-  # Warning: this method is only available if a Whois parser exists
-  # for the top level domain of <tt>qstring</tt>.
-  # If no parser exists for <tt>qstring</tt>, you'll receive a warning message
-  # and the method will return <tt>nil</tt>.
-  # This is a technical limitation. Browse the lib/whois/answer/parsers folder
-  # to view all available parsers.
-  #
-  # Returns <tt>true</tt> if the domain is registered.
   def self.registered?(qstring)
     query(qstring).registered?
   rescue ParserNotFound => e
@@ -111,8 +126,6 @@ module Whois
 
 
   # See <tt>Whois#query</tt>.
-  #
-  # Returns a <tt>Whois::Answer</tt> instance.
   def self.whois(qstring)
     query(qstring)
   end

data/lib/whois/answer.rb

@@ -66,8 +66,7 @@ module Whois
     end
 
 
-    # Returns the content of this answer as a string.
-    # This method joins all answer parts into a single string
+    # This method joins and returns all answer parts into a single string
     # and separates each response with a newline character.
     #
     #   answer = Whois::Answer.new([Whois::Answer::Part.new("First answer.")])
@@ -78,6 +77,10 @@ module Whois
     #   answer.content
     #   # => "First answer.\nSecond answer."
     #
+    # ==== Returns
+    #
+    # String:: The content of this answer.
+    #
     def content
       @content ||= parts.map(&:response).join("\n")
     end
@@ -125,6 +128,15 @@ module Whois
     # Returns <tt>true</tt> if the <tt>property</tt> passed as symbol
     # is supported by any available parser for this answer.
     # See also <tt>Whois::Answer::Parser.supported?</tt>.
+    #
+    # ==== Parameters
+    #
+    # property::  A Symbol with the property name to check.
+    #
+    # ==== Returns
+    #
+    # Boolean
+    #
     def property_supported?(property)
       parser.property_supported?(property)
     end
@@ -171,4 +183,4 @@ module Whois
 
   end
 
-end
+end

data/lib/whois/answer/parser.rb

@@ -101,35 +101,47 @@ module Whois
           end
         end
 
-        # Protected: Loops through all answer parts, for each parts tries to guess
-        # the appropriate parser object whenever available,
+        # Loops through all answer parts, for each part
+        # tries to guess the appropriate parser object whenever available,
         # and returns the final array of server-specific parsers.
         #
         # Parsers are initialized in reverse order for performance reason.
         # See also <tt>#select_parser</tt>.
         #
-        # Examples
+        # ==== Returns
+        #
+        # Returns an Array of Class,
+        # where each item is the parts reverse-N specific parser Class.
+        # Each Class is expected to be a child of Whois::Answer::Parser::Base.
+        #
+        # ==== Examples
         #
         #   parser.parts
         #   # => [whois.foo.com, whois.bar.com]
+        #
         #   parser.parsers
         #   # => [Whois::Answer::Parser::WhoisBarCom, Whois::Answer::Parser::WhoisFooCom]
         #
-        # Returns an Array of Class, where
-        #   each item is the parts reverse-N specific parser Class.
-        #   Each Class is expected to be a child of Whois::Answer::Parser::Base.
         def init_parsers
           answer.parts.reverse.map { |part| self.class.parser_for(part) }
         end
 
-        # Protected: Selects the first parser in <tt>#parsers</tt>
+        # Selects the first parser in <tt>#parsers</tt>
         # where <tt>given</tt> matches <tt>status</tt>.
         #
-        # property - The Symbol property to search for
-        # status - The Symbol status (default: :any)
+        # ==== Parameters
         #
+        # property::  The Symbol property to search for.
+        # status::    The Symbol status (default: :any).
         #
-        # Examples
+        # ==== Returns
+        #
+        # Whois::Answer::Parser::Base::
+        #   The parser which satisfies given requirement.
+        # nil::
+        #   If the parser wasn't found.
+        #
+        # ==== Examples
         #
         #   select_parser(:nameservers)
         #   # => #<Whois::Answer::Parser::WhoisExampleCom>
@@ -137,9 +149,6 @@ module Whois
         #   select_parser(:nameservers, :supported)
         #   # => nil
         #
-        # Returns an instance of Whois::Answer::Parser::Base
-        #   with the parser which satisfies given requirement,
-        #   or nil the parser wasn't found.
         def select_parser(property, status = :any)
           parsers.each do |parser|
             return parser if parser.class.property_registered?(property, status)
@@ -152,9 +161,16 @@ module Whois
       # The parser class is selected according to the
       # value of the <tt>#host</tt> attribute for given <tt>part</tt>.
       #
-      # part - The Whois::Answer::Parser::Part to get the parser for
+      # ==== Parameters
+      # 
+      # part:: The Whois::Answer::Parser::Part to get the parser for.
       #
-      # Examples
+      # ==== Returns
+      #
+      # Returns an instance of the specific parser for given part.
+      # The instance is expected to be a child of Whois::Answer::Parser::Base.
+      # 
+      # ==== Examples
       #
       #   # Parser for a known host
       #   Parser.parser_for("whois.example.com")
@@ -164,8 +180,6 @@ module Whois
       #   Parser.parser_for("missing.example.com")
       #   #<Whois::Answer::Parser::Blank>
       #
-      # Returns an instance of the specific parser for given part.
-      #   The instance is expected to be a child of Whois::Answer::Parser::Base.
       def self.parser_for(part)
         parser_klass(part.host).new(part)
       end
@@ -177,9 +191,19 @@ module Whois
       # a custom parser, simple make sure the class is loaded in the Ruby
       # environment before this method is called.
       #
-      # host - A String with the host
+      # ==== Parameters
+      #
+      # host:: A String with the host.
       #
-      # Examples
+      # ==== Returns
+      #
+      # Returns an instance of Class representing the parser Class
+      # corresponding to <tt>host</tt>.
+      # If <tt>host</tt> doesn't have a specific parser implementation,
+      # then returns the Whois::Answer::Parser::Blank Class.
+      # The Class is expected to be a child of Whois::Answer::Parser::Base.
+      #
+      # ==== Examples
       #
       #   Parser.parser_klass("missing.example.com")
       #   # => Whois::Answer::Parser::Blank
@@ -191,11 +215,6 @@ module Whois
       #   Parser.parser_klass("missing.example.com")
       #   # => Whois::Answer::Parser::MissingExampleCom
       #
-      # Returns an instance of Class representing the parser Class
-      #   corresponding to <tt>host</tt>.
-      #   If <tt>host</tt> doesn't have a specific parser implementation,
-      #   then returns the Whois::Answer::Parser::Blank Class.
-      #   The Class is expected to be a child of Whois::Answer::Parser::Base.
       def self.parser_klass(host)
         name = host_to_parser(host)
         Parser.const_defined?(name) || autoload(host)
@@ -208,12 +227,15 @@ module Whois
 
       # Converts <tt>host</tt> to the corresponding parser class name.
       #
-      # host - A String with the host
+      # ==== Parameters
+      #
+      # host:: A String with the host.
       #
-      # Examples
+      # ==== Examples
       #
       #   Parser.host_to_parser("whois.nic.it")
       #   # => "WhoisNicIt"
+      #
       #   Parser.host_to_parser("whois.nic-info.it")
       #   # => "WhoisNicInfoIt"
       #
@@ -226,20 +248,19 @@ module Whois
 
       # Requires the file at <tt>whois/answer/parser/#{name}</tt>.
       #
-      # name - A string with the file name
+      # ==== Parameters
+      #
+      # name:: A string with the file name.
+      #
+      # ==== Returns
+      #
+      # Nothing.
       #
-      # Returns nothing.
       def self.autoload(name)
         file = "whois/answer/parser/#{name}"
         require file
       end
 
-
-      def self.properties # :nodoc:
-        Whois.deprecate("Whois::Answer::Parser.properties is deprecated. Use the Whois::Answer::Parser::PROPERTIES constant.")
-        PROPERTIES
-      end
-
     end
 
   end

data/lib/whois/answer/parser/whois.cat.rb

@@ -41,11 +41,11 @@ module Whois
         end
 
         property_supported :available? do
-          @available ||= !!(content_for_scanner =~ /Object (.*?) NOT FOUND/)
+          @available  ||= !!(content_for_scanner =~ /Object (.*?) NOT FOUND/)
         end
 
         property_supported :registered? do
-          !available?
+          @registered ||= !available?
         end
 
 

data/lib/whois/client.rb

@@ -34,19 +34,24 @@ module Whois
     #
     # Initializes a new <tt>Whois::Client</tt> with <tt>options</tt>.
     #
-    # options - The Hash options used to refine the selection (default: {}):
+    # ==== Parameters
+    #
+    # options:: Hash of options (default: {}):
     #           :timeout - The Integer script timeout, expressed in seconds (default: DEFAULT_TIMEOUT).
     #
     # If <tt>block</tt> is given, yields <tt>self</tt>.
     #
-    # Examples
+    # ==== Returns
+    #
+    # Whois::Client:: The client instance.
+    #
+    # ==== Examples
     #
     #   client = Whois::Client.new do |c|
     #     c.timeout = nil
     #   end
     #   client.query("google.com")
     #
-    # Returns a <tt>Whois::Client</tt>.
     def initialize(options = {}, &block)
       self.timeout = options[:timeout] || DEFAULT_TIMEOUT
       yield(self) if block_given?
@@ -68,14 +73,19 @@ module Whois
     # Queries the right WHOIS server for <tt>qstring</tt> and returns
     # the response from the server.
     #
-    # qstring - The String to be sent as query parameter.
+    # ==== Parameters
+    #
+    # qstring:: The String to be sent as query parameter.
+    #
+    # ==== Returns
+    #
+    # Whois::Answer:: The answer object containing the WHOIS response.
     #
-    # Examples
+    # ==== Examples
     #
     #   client.query("google.com")
     #   # => #<Whois::Answer>
     #
-    # Returns a <tt>Whois::Answer</tt> instance.
     def query(qstring)
       string = qstring.to_s
       Timeout::timeout(timeout) do