whois 2.7.0 → 3.0.0

data/lib/whois.rb

@@ -3,7 +3,7 @@
 #
 # An intelligent pure Ruby WHOIS client and parser.
 #
-# Copyright (c) 2009-2012 Simone Carletti <weppos@weppos.net>
+# Copyright (c) 2009-2013 Simone Carletti <weppos@weppos.net>
 #++
 
 
@@ -38,7 +38,7 @@ module Whois
     #   Whois::Client.new.query("google.com")
     #
     def query(object)
-      Client.new.query(object)
+      Client.new.lookup(object)
     end
 
     alias_method :whois, :query
@@ -84,7 +84,7 @@ module Whois
     # This is a technical limitation. Browse the lib/whois/record/parsers folder
     # to view all available parsers.
     #
-    # @param  [String] string The string to be sent as query parameter.
+    # @param  [String] object The string to be sent as query parameter.
     #         It is intended to be a domain name, otherwise this method
     #         may return unexpected responses.
     # @return [Boolean]

data/lib/whois/client.rb

@@ -3,7 +3,7 @@
 #
 # An intelligent pure Ruby WHOIS client and parser.
 #
-# Copyright (c) 2009-2012 Simone Carletti <weppos@weppos.net>
+# Copyright (c) 2009-2013 Simone Carletti <weppos@weppos.net>
 #++
 
 
@@ -31,7 +31,7 @@ module Whois
     # If <tt>block</tt> is given, yields <tt>self</tt>.
     #
     # @param  [Hash] settings Hash of settings to customize the client behavior.
-    # @option settings [Fixnum, nil] :timeout (DEFAULT_TIMEOUT)
+    # @option settings [Integer, nil] :timeout (DEFAULT_TIMEOUT)
     #         The timeout for a WHOIS query, expressed in seconds.
     # @option settings [String] :bind_host (nil)
     #         Providing an IP address or hostname will bind the Socket connection
@@ -39,6 +39,10 @@ module Whois
     # @option settings [Fixnum] :bind_port (nil)
     #         Providing port number will bind the Socket connection
     #         to the specific local port.
+    # @option settings [String, nil] :host (nil)
+    #         The server host to query. Leave it blank for intelligent detection.
+    # @option settings [Boolean, nil] :referral (nil)
+    #         Set to +false+ to disable queries to referral WHOIS servers.
     #
     # @yield  [self]
     #
@@ -69,28 +73,34 @@ module Whois
     end
 
 
-    # Queries the right WHOIS server for <tt>object</tt>
+    # Lookups the right WHOIS server for <tt>object</tt>
     # and returns the response from the server.
     #
-    # @param  [#to_s] object The string to be sent as query parameter.
+    # @param  [#to_s] object The string to be sent as lookup parameter.
     # @return [Whois::Record] The object containing the WHOIS response.
     #
     # @raise  [Timeout::Error]
     #
     # @example
     #
-    #   client.query("google.com")
+    #   client.lookup("google.com")
     #   # => #<Whois::Record>
     #
-    def query(object)
+    def lookup(object)
       string = object.to_s.downcase
       Timeout::timeout(timeout) do
         @server = Server.guess(string)
         @server.configure(settings)
-        @server.query(string)
+        @server.lookup(string)
       end
     end
 
+    # @deprecated
+    def query(*args)
+      Whois.deprecate("Client#query is deprecated, use Client#lookup instead.")
+      lookup(*args)
+    end
+
   end
 
 end

data/lib/whois/core_ext.rb

@@ -1,9 +1,7 @@
 if defined?(ActiveSupport::VERSION) && ActiveSupport::VERSION::MAJOR == 3
   require 'active_support/core_ext/array/wrap'
-  require 'active_support/core_ext/date_time/conversions'
   require 'whois/core_ext/class/attribute'
 else
   require 'whois/core_ext/array/wrap'
-  require 'whois/core_ext/date_time/conversions'
   require 'whois/core_ext/class/attribute'
 end

data/lib/whois/errors.rb

@@ -3,7 +3,7 @@
 #
 # An intelligent pure Ruby WHOIS client and parser.
 #
-# Copyright (c) 2009-2012 Simone Carletti <weppos@weppos.net>
+# Copyright (c) 2009-2013 Simone Carletti <weppos@weppos.net>
 #++
 
 
@@ -18,7 +18,7 @@ module Whois
   end
 
 
-  # @group Server
+  # @!group Server
 
   # Generic class for server errors.
   class ServerError < Error
@@ -53,10 +53,10 @@ module Whois
   class AllocationUnknown < ServerError
   end
 
-  # @endgroup
+  # @!endgroup
 
 
-  # @group Interface
+  # @!group Interface
 
   # Generic class for interfaces not supported.
   class InterfaceNotSupported < ServerError
@@ -85,10 +85,10 @@ module Whois
 
   end
 
-  # @endgroup
+  # @!endgroup
 
 
-  # @group Parser
+  # @!group Parser
 
   # Generic class for parser errors.
   class ParserError < Error
@@ -100,25 +100,18 @@ module Whois
   class ParserNotFound < ParserError
   end
 
-  # Raised when the property method has not been overwritten (implemented)
-  # in a child parser class.
-  class PropertyNotImplemented < ParserError
+  # Raised when you are trying to access an attribute that has not been implemented.
+  class AttributeNotImplemented < ParserError
   end
 
-  # Raised when you are trying to access a property that is not supported
-  # for the current WHOIS record.
-  class PropertyNotSupported < ParserError
+  # Raised when you are trying to access an attribute that is not supported.
+  class AttributeNotSupported < ParserError
   end
 
-  # Raised when you are trying to access a property that is not supported
-  # by any of the parsers available for current WHOIS record.
-  class PropertyNotAvailable < ParserError
-  end
-
-  # @endgroup
+  # @!endgroup
 
 
-  # @group Response
+  # @!group Response
 
   # Generic class for response errors.
   class ResponseError < Error
@@ -137,6 +130,6 @@ module Whois
   class ResponseIsUnavailable < ResponseError
   end
 
-  # @endgroup
+  # @!endgroup
 
 end

data/lib/whois/record.rb

@@ -3,18 +3,20 @@
 #
 # An intelligent pure Ruby WHOIS client and parser.
 #
-# Copyright (c) 2009-2012 Simone Carletti <weppos@weppos.net>
+# Copyright (c) 2009-2013 Simone Carletti <weppos@weppos.net>
 #++
 
 
-require 'whois/record/parser'
-require 'whois/record/parser/base'
+require 'whois/record/part'
 
 
 module Whois
 
   class Record
 
+    autoload :Parser, 'whois/record/parser'
+
+
     # @return [Whois::Server] The server that originated this record.
     attr_reader :server
 
@@ -41,7 +43,7 @@ module Whois
     # @return [Boolean]
     #
     def respond_to?(symbol, include_private = false)
-      super || Parser::PROPERTIES.include?(symbol) || Parser::METHODS.include?(symbol)
+      respond_to_parser_method?(symbol) || super
     end
 
     # Returns a String representation of this record.
@@ -131,20 +133,20 @@ module Whois
       @parser ||= Parser.new(self)
     end
 
-    # Returns <tt>true</tt> if the <tt>property</tt> passed as symbol
-    # is supported by any available parser for this record.
+    # Checks if the <tt>property</tt> passed as symbol
+    # is supported in any of the parsers.
     #
     # @param  [Symbol] property The name of the property to check.
     # @return [Boolean]
     #
-    # @see Whois::Record::Parser#property_supported?
+    # @see Whois::Record::Parser#property_any_supported?
     #
-    def property_supported?(property)
-      parser.property_supported?(property)
+    def property_any_supported?(property)
+      parser.property_any_supported?(property)
     end
 
 
-    # @group Properties
+    # @!group Properties
 
     # Returns a Hash containing all supported properties for this record
     # along with corresponding values.
@@ -157,10 +159,10 @@ module Whois
       hash
     end
 
-    # @endgroup
+    # @!endgroup
 
 
-    # @group Methods
+    # @!group Methods
 
     # Shortcut for <tt>#registrant_contacts.first</tt>.
     #
@@ -172,7 +174,7 @@ module Whois
     # @see Whois::Record#registrant_contacts
     #
     def registrant_contact
-      if property_supported?(:registrant_contacts)
+      if property_any_supported?(:registrant_contacts)
         parser.registrant_contacts.first
       end
     end
@@ -187,7 +189,7 @@ module Whois
     # @see Whois::Record#admin_contacts
     #
     def admin_contact
-      if property_supported?(:admin_contacts)
+      if property_any_supported?(:admin_contacts)
         parser.admin_contacts.first
       end
     end
@@ -202,7 +204,7 @@ module Whois
     # @see Whois::Record#technical_contacts
     #
     def technical_contact
-      if property_supported?(:technical_contacts)
+      if property_any_supported(:technical_contacts)
         parser.technical_contacts.first
       end
     end
@@ -217,10 +219,10 @@ module Whois
       parser.contacts
     end
 
-    # @endgroup
+    # @!endgroup
 
 
-    # @group Response
+    # @!group Response
 
     # Checks whether this {Whois::Record} is different than +other+.
     #
@@ -256,8 +258,7 @@ module Whois
         raise(ArgumentError, "Can't compare `#{self.class}' with `#{other.class}'")
       end
 
-      equal?(other) ||
-      parser.unchanged?(other.parser)
+      equal?(other) || parser.unchanged?(other.parser)
     end
 
 
@@ -291,16 +292,16 @@ module Whois
       parser.response_unavailable?
     end
 
-    # @endgroup
+    # @!endgroup
 
 
-  private
+    private
 
     # @api private
     def self.define_property_method(method)
       class_eval <<-RUBY, __FILE__, __LINE__ + 1
         def #{method}(*args, &block)
-          if property_supported?(:#{method})
+          if property_any_supported?(:#{method})
             parser.#{method}(*args, &block)
           end
         end
@@ -327,6 +328,11 @@ module Whois
       RUBY
     end
 
+    def respond_to_parser_method?(symbol)
+      name = symbol.to_s =~ /\?$/ ? symbol.to_s[0..-2] : symbol
+      Parser::PROPERTIES.include?(name.to_sym) || Parser::METHODS.include?(name.to_sym)
+    end
+
     # Delegates all method calls to the internal parser.
     def method_missing(method, *args, &block)
       if Parser::PROPERTIES.include?(method)

data/lib/whois/record/contact.rb

@@ -3,7 +3,7 @@
 #
 # An intelligent pure Ruby WHOIS client and parser.
 #
-# Copyright (c) 2009-2012 Simone Carletti <weppos@weppos.net>
+# Copyright (c) 2009-2013 Simone Carletti <weppos@weppos.net>
 #++
 
 

data/lib/whois/record/nameserver.rb

@@ -3,7 +3,7 @@
 #
 # An intelligent pure Ruby WHOIS client and parser.
 #
-# Copyright (c) 2009-2012 Simone Carletti <weppos@weppos.net>
+# Copyright (c) 2009-2013 Simone Carletti <weppos@weppos.net>
 #++
 
 

data/lib/whois/record/parser.rb

@@ -3,7 +3,7 @@
 #
 # An intelligent pure Ruby WHOIS client and parser.
 #
-# Copyright (c) 2009-2012 Simone Carletti <weppos@weppos.net>
+# Copyright (c) 2009-2013 Simone Carletti <weppos@weppos.net>
 #++
 
 
@@ -16,21 +16,21 @@ module Whois
     # The list of properties and methods is available
     # in the following constants:
     #
-    # * {Whois::Record::METHODS}
-    # * {Whois::Record::PROPERTIES}
+    # * {Whois::Record::Parser::METHODS}
+    # * {Whois::Record::Parser::PROPERTIES}
     #
     class Parser
 
       METHODS = [
-        :changed?, :unchanged?,
         :contacts,
-        # :response_throttled?, :response_incomplete?,
+        :changed?, :unchanged?,
+        # :response_incomplete?, :response_throttled?, :response_unavailable?,
+        # :referral_whois, :referral_url,
       ]
 
       PROPERTIES = [
         :disclaimer,
         :domain, :domain_id,
-        :referral_whois, :referral_url,
         :status, :available?, :registered?,
         :created_on, :updated_on, :expires_on,
         :registrar,
@@ -38,6 +38,10 @@ module Whois
         :nameservers,
       ]
 
+      PROPERTY_STATE_NOT_IMPLEMENTED = :not_implemented
+      PROPERTY_STATE_NOT_SUPPORTED = :not_supported
+      PROPERTY_STATE_SUPPORTED = :supported
+
 
       # Returns the proper parser instance for given <tt>part</tt>.
       # The parser class is selected according to the
@@ -149,7 +153,7 @@ module Whois
       #
       # @return [Boolean]
       def respond_to?(symbol, include_private = false)
-        super || PROPERTIES.include?(symbol) || METHODS.include?(symbol)
+        respond_to_parser_method?(symbol) || super
       end
 
 
@@ -163,19 +167,28 @@ module Whois
         @parsers ||= init_parsers
       end
 
-      # Returns <tt>true</tt> if the <tt>property</tt> passed as symbol
-      # is supported by any available parser.
+      # Checks if the <tt>property</tt> passed as symbol
+      # is supported in any of the parsers.
       #
       # @return [Boolean]
       #
       # @see Whois::Record::Parser::Base.property_supported?
       #
-      def property_supported?(property)
+      def property_any_supported?(property)
         parsers.any? { |parser| parser.property_supported?(property) }
       end
 
+      # Checks if the <tt>property</tt> passed as symbol
+      # is "not implemented" in any of the parsers.
+      #
+      # @return [Boolean]
+      #
+      def property_any_not_implemented?(property)
+        parsers.any? { |parser| parser.class.property_state?(property, Whois::Record::Parser::PROPERTY_STATE_NOT_IMPLEMENTED) }
+      end
+
 
-      # @group Methods
+      # @!group Methods
 
       # Collects and returns all the contacts from all the record parts.
       #
@@ -188,10 +201,10 @@ module Whois
         parsers.map(&:contacts).flatten
       end
 
-      # @endgroup
+      # @!endgroup
 
 
-      # @group Response
+      # @!group Response
 
       # Loop through all the record parts to check
       # if at least one part changed.
@@ -223,6 +236,7 @@ module Whois
         parsers.size == other.parsers.size && all_in_parallel?(parsers, other.parsers) { |one, two| one.unchanged?(two) }
       end
 
+
       # Loop through all the parts to check if at least
       # one part is an incomplete response.
       #
@@ -259,51 +273,64 @@ module Whois
         any_is?(parsers, :response_unavailable?)
       end
 
-      # @endgroup
+      # @!endgroup
+
 
+      private
 
-    private
+      # @api private
+      def self.define_property_method(method)
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def #{method}(*args, &block)
+            delegate_property_to_parsers(:#{method}, *args, &block)
+          end
+        RUBY
+      end
 
       # @api private
-      def self.define_missing_method(method)
+      def self.define_method_method(method)
         class_eval <<-RUBY, __FILE__, __LINE__ + 1
           def #{method}(*args, &block)
-            delegate_to_parsers(:#{method}, *args, &block)
+            delegate_method_to_parsers(:#{method}, *args, &block)
           end
         RUBY
       end
 
+      def respond_to_parser_method?(symbol)
+        Parser::PROPERTIES.include?(symbol) || Parser::METHODS.include?(symbol)
+      end
+
       def method_missing(method, *args, &block)
         if PROPERTIES.include?(method)
-          self.class.define_missing_method(method)
+          self.class.define_property_method(method)
           send(method, *args, &block)
         elsif METHODS.include?(method)
-          self.class.define_missing_method(method)
+          self.class.define_method_method(method)
           send(method, *args, &block)
         else
           super
         end
       end
 
-      def delegate_to_parsers(method, *args, &block)
-        # Raise an error without any parser
+      def delegate_property_to_parsers(method, *args, &block)
         if parsers.empty?
-          raise ParserError, "Unable to select a parser because the record is empty"
-
-        # Select a parser where the property is supported
-        # and call the method.
-        elsif parser = select_parser(method, :supported)
+          raise ParserError, "Unable to select a parser because the Record is empty"
+        elsif (parser = select_parser { |p| p.class.property_state?(method, PROPERTY_STATE_SUPPORTED) })
           parser.send(method, *args, &block)
-
-        # Select a parser where the property is defined but not supported
-        # and call the method.
-        # The call is expected to raise an exception.
-        elsif parser = select_parser(method, :not_supported)
+        elsif (parser = select_parser { |p| p.class.property_state?(method, PROPERTY_STATE_NOT_SUPPORTED) })
           parser.send(method, *args, &block)
+        else
+          raise AttributeNotImplemented, "Unable to find a parser for property `#{method}'"
+        end
+      end
 
-        # The property is not supported nor defined.
+      def delegate_method_to_parsers(method, *args, &block)
+        if parsers.empty?
+          raise ParserError, "Unable to select a parser because the Record is empty"
+        elsif (parser = select_parser { |p| p.respond_to?(method) })
+          parser.send(method, *args, &block)
         else
-          raise PropertyNotAvailable, "Unable to find a parser for `#{method}'"
+          nil
         end
       end
 
@@ -325,34 +352,31 @@ module Whois
       #   parser.parsers
       #   # => [Whois::Record::Parser::WhoisBarCom, Whois::Record::Parser::WhoisFooCom]
       #
-      # @see Whois::Record::Parser#select_parser
-      #
+      # @api private
       def init_parsers
         record.parts.reverse.map { |part| self.class.parser_for(part) }
       end
 
-      # Selects the first parser in {#parsers}
-      # where given property matches <tt>status</tt>.
-      #
-      # @param  [Symbol] property The property to search for.
-      # @param  [Symbol] status The status value.
+      # Selects the first parser in {#parsers} where blocks evaluates to true.
       #
       # @return [Whois::Record::Parser::Base]
-      #         The parser which satisfies given requirement.
+      #         The parser for which the block returns true.
       # @return [nil]
       #         If the parser wasn't found.
       #
+      # @yield  [parser]
+      #
       # @example
       #
-      #   select_parser(:nameservers)
+      #   select_parser { |parser| parser.class.property_state?(:nameserver, :any) }
       #   # => #<Whois::Record::Parser::WhoisExampleCom>
-      #
-      #   select_parser(:nameservers, :supported)
+      #   select_parser { |parser| parser.class.property_state?(:nameservers, PROPERTY_STATE_SUPPORTED) }
       #   # => nil
       #
-      def select_parser(property, status = :any)
+      # @api private
+      def select_parser(&block)
         parsers.each do |parser|
-          return parser if parser.class.property_registered?(property, status)
+          return parser if block.call(parser)
         end
         nil
       end