Public Suffix for Ruby 使用与安装指南

1. 安装指南

PublicSuffix 是一个基于 Ruby 的域名解析器，它依赖于 Public Suffix List。以下是安装步骤：

• 手动安装：运行以下命令来安装 gem。

  gem install public_suffix
  

• 使用 Bundler：在 Gemfile 中添加以下依赖，然后运行 bundle install。

  gem 'public_suffix'
  

确保你的 Ruby 版本至少是 3.0。如果你使用的是较旧版本的 Ruby，请使用之前发布的版本。

2. 项目使用说明

PublicSuffix 可以用来解析域名，并提取其中的顶级域名（TLD）、二级域名（SLD）和子域名。以下是一些使用示例：

提取域名

PublicSuffix.domain("google.com")
# => "google.com"

PublicSuffix.domain("www.google.com")
# => "google.com"

PublicSuffix.domain("www.google.co.uk")
# => "google.co.uk"

解析域名

domain = PublicSuffix.parse("google.com")
# => #<PublicSuffix::Domain>
domain.tld
# => "com"
domain.sld
# => "google"
domain.trd
# => nil
domain.domain
# => "google.com"
domain.subdomain
# => nil

简单验证示例

PublicSuffix.valid?("google.com")
# => true

PublicSuffix.valid?("www.google.com")
# => true

# 明确禁止，列为私有域名
PublicSuffix.valid?("blogspot.com")
# => false

# 未知/未列出的 TLD 域名默认有效
PublicSuffix.valid?("example.tldnotlisted")
# => true

完全限定域名（FQDN）

此库自动识别以点结尾的完全限定域名（FQDN）。

PublicSuffix.domain("www.google.com")
# => "google.com"

PublicSuffix.domain("www.google.com.")
# => "google.com"

私有域名

此库支持关闭对私有（非 ICANN）域名的支持。

# 包括私有域名
PublicSuffix.domain("something.blogspot.com")
# => "something.blogspot.com"

# 排除私有域名
PublicSuffix.domain("something.blogspot.com", ignore_private: true)
# => "blogspot.com"

3. 项目API使用文档

以下是 PublicSuffix 的一些主要 API 方法：

• PublicSuffix.domain(name)：提取域名中的有效域名。
• PublicSuffix.parse(name)：解析域名，返回一个包含域名信息的对象。
• PublicSuffix.valid?(name)：验证域名是否有效。
• PublicSuffix::List.default：获取当前默认的 Public Suffix 列表。

更多 API 文档可以在 rubydoc.info 上找到。

4. 项目安装方式

除了上述的手动安装和 Bundler 安装外，如果你希望手动添加域名到列表中，可以使用以下方法：

PublicSuffix::List.default << PublicSuffix::Rule.factory('onmicrosoft.com')

以上就是 PublicSuffix for Ruby 的安装和使用指南。希望这份文档能帮助你更好地使用这个库。