Represents a domain name ready for extracting its registered domain and TLD.
The least "universally original" domain part of this domain name. For example, "example.co.uk" for "www.sub.example.co.uk". This may be nil if the hostname does not have one, like when it is an IP address, an effective TLD or higher itself, or of a non-canonical domain.
The full host name normalized, ASCII-ized and downcased using the Unicode NFC rules and the Punycode algorithm. If initialized with an IP address, the string representation of the IP address suitable for opening a connection to.
The TLD part of this domain name. For example, if the hostname is "www.sub.example.co.uk", the TLD part is "uk". This property is nil only if ipaddr? is true. This may be nil if the hostname does not have one, like when it is an IP address or of a non-canonical domain.
# File lib/domain_name/etld_data.rb, line 6108 def self.etld_data ETLD_DATA end
Parses hostname into a DomainName object. An IP address is also accepted. An IPv6 address may be enclosed in square brackets.
# File lib/domain_name.rb, line 65 def initialize(hostname) hostname.is_a?(String) or (hostname.respond_to?(:to_str) && (hostname = hostname.to_str).is_a?(String)) or raise TypeError, "#{hostname.class} is not a String" if hostname.start_with?(DOT) raise ArgumentError, "domain name must not start with a dot: #{hostname}" end case hostname when /\A([0-9]+\.[0-9]+\.[0-9]+\.[0-9]+)\z/ @ipaddr = IPAddr.new($1) @uri_host = @hostname = @ipaddr.to_s @domain = @tld = nil return when /\A([0-9A-Fa-f:]*:[0-9A-Fa-f:]*:[0-9A-Fa-f:]*)\z/, /\A\[([0-9A-Fa-f:]*:[0-9A-Fa-f:]*:[0-9A-Fa-f:]*)\]\z/ @ipaddr = IPAddr.new($1) @hostname = @ipaddr.to_s @uri_host = "[#{@hostname}]" @domain = @tld = nil return end @ipaddr = nil @hostname = DomainName.normalize(hostname) @uri_host = @hostname if last_dot = @hostname.rindex(DOT) @tld = @hostname[(last_dot + 1)..-1] else @tld = @hostname end etld_data = DomainName.etld_data if @canonical_tld_p = etld_data.key?(@tld) subdomain = domain = nil parent = @hostname loop { case etld_data[parent] when 0 @domain = domain if domain return when -1 @domain = subdomain if subdomain return when 1 @domain = parent return end subdomain = domain domain = parent pos = @hostname.index(DOT, -domain.length) or break parent = @hostname[(pos + 1)..-1] } else # unknown/local TLD if last_dot # fallback - accept cookies down to second level # cf. http://www.dkim-reputation.org/regdom-libs/ if penultimate_dot = @hostname.rindex(DOT, last_dot - 1) @domain = @hostname[(penultimate_dot + 1)..-1] else @domain = @hostname end else # no domain part - must be a local hostname @domain = @tld end end end
Normalizes a domain using the Punycode algorithm as necessary. The result will be a downcased, ASCII-only string.
# File lib/domain_name.rb, line 246 def normalize(domain) DomainName::Punycode.encode_hostname(domain.chomp(DOT).to_nfc).downcase end
# File lib/domain_name.rb, line 182 def <(other) case self <=> other when -1 true when nil nil else false end end
# File lib/domain_name.rb, line 204 def <=(other) case self <=> other when -1, 0 true when nil nil else false end end
# File lib/domain_name.rb, line 166 def <=>(other) other = DomainName.new(other) unless DomainName === other othername = other.hostname if othername == @hostname 0 elsif @hostname.end_with?(othername) && @hostname[-othername.size - 1, 1] == DOT # The other is higher -1 elsif othername.end_with?(@hostname) && othername[-@hostname.size - 1, 1] == DOT # The other is lower 1 else nil end end
# File lib/domain_name.rb, line 161 def ==(other) other = DomainName.new(other) unless DomainName === other other.hostname == @hostname end
# File lib/domain_name.rb, line 193 def >(other) case self <=> other when 1 true when nil nil else false end end
# File lib/domain_name.rb, line 215 def >=(other) case self <=> other when 1, 0 true when nil nil else false end end
Returns true if this domain name has a canonical registered domain.
# File lib/domain_name.rb, line 57 def canonical? @canonical_tld_p && (@domain ? true : false) end
Returns true if this domain name has a canonical TLD.
# File lib/domain_name.rb, line 51 def canonical_tld? @canonical_tld_p end
# File lib/domain_name.rb, line 232 def inspect str = '#<%s:%s' % [self.class.name, @hostname] if @ipaddr str << ' (ipaddr)' else str << ' domain=' << @domain if @domain str << ' tld=' << @tld if @tld end str << '>' end
Returns true if this is an IP address, such as "192.168.0.1" and "[::1]".
# File lib/domain_name.rb, line 41 def ipaddr? @ipaddr ? true : false end
Returns the superdomain of this domain name.
# File lib/domain_name.rb, line 155 def superdomain return nil if ipaddr? pos = @hostname.index(DOT) or return nil self.class.new(@hostname[(pos + 1)..-1]) end
# File lib/domain_name.rb, line 226 def to_s @hostname end
Generated with the Darkfish Rdoc Generator 2.