Feed Normalizer 技术文档

1. 安装指南

Feed Normalizer 是一个用于封装 Atom 和 RSS 解析器的 Ruby Gem。要安装 Feed Normalizer，请运行以下命令：

gem install feed-normalizer

或者，您可以从以下地址获取源代码：

svn co http://feed-normalizer.googlecode.com/svn/trunk

2. 项目的使用说明

Feed Normalizer 封装了多种 RSS 和 Atom 解析器，并返回一个统一的对象图，无论底层的馈送格式是什么。

以下是一个简单的使用示例：

require 'feed-normalizer'
require 'open-uri'

# 解析 RSS 馈送
feed_rss = FeedNormalizer::FeedNormalizer.parse open('http://www.iht.com/rss/frontpage.xml')

puts feed_rss.title # 输出: "International Herald Tribune"
puts feed_rss.url # 输出: "http://www.iht.com/pages/index.php"
puts feed_rss.entries.first.url # 输出: "http://www.iht.com/articles/2006/10/03/frontpage/web.1003UN.php"
puts feed_rss.class # 输出: FeedNormalizer::Feed
puts feed_rss.parser # 输出: "RSS::Parser"

# 解析 Atom 馈送
feed_atom = FeedNormalizer::FeedNormalizer.parse open('http://www.atomenabled.org/atom.xml')

puts feed_atom.title # 输出: "AtomEnabled.org"
puts feed_atom.url # 输出: "http://www.atomenabled.org/atom.xml"
puts feed_atom.entries.first.url # 输出: "http://www.atomenabled.org/2006/09/moving-toward-atom.php"
puts feed_atom.class # 输出: FeedNormalizer::Feed
puts feed_atom.parser # 输出: "SimpleRSS"

即使底层解析器不同，馈送表示也保持不变。

3. 项目API使用文档

Feed Normalizer 提供了以下主要API：

• FeedNormalizer::FeedNormalizer.parse: 用于解析给定的馈送地址，并返回统一的对象图。

• feed.clean!: 用于清洗和净化馈送中的元素，确保所有元素都是干净的HTML或者HTML转义字符串。

以下是一个使用 feed.clean! 方法的示例：

feed.title # 输出: "My Feed > Your Feed"
feed.entries.first.content # 输出: "<p x='y'>Hello</p><object></object></html>"

feed.clean!

feed.title # 输出: "My Feed &gt; Your Feed"
feed.entries.first.content # 输出: "<p>Hello</p>"

4. 项目安装方式

请参考本文档的“安装指南”部分，安装方式与前面所述相同。

通过以上文档，您应该能够顺利安装并使用 Feed Normalizer 项目，处理各种 RSS 和 Atom 馈送数据。