Ruby-oEmbed 技术文档

1. 安装指南

安装 Ruby-oEmbed

Ruby-oEmbed 是一个用于获取支持 oEmbed 协议的网页嵌入式 HTML 表示的 Ruby 库。你可以通过以下命令安装该库：

gem install ruby-oembed

依赖项

Ruby-oEmbed 依赖于 Ruby 环境。确保你已经安装了 Ruby 和 RubyGems。

2. 项目的使用说明

内置提供者

Ruby-oEmbed 提供了一些内置的 oEmbed 提供者，你可以直接使用这些提供者来获取嵌入式内容。

require 'oembed'

# 注册所有内置提供者
OEmbed::Providers.register_all

# 获取嵌入式内容
resource = OEmbed::Providers.get('http://www.youtube.com/watch?v=2BYXBC8WQ5k')
resource.video? #=> true
resource.thumbnail_url #=> "http://i3.ytimg.com/vi/2BYXBC8WQ5k/hqdefault.jpg"
resource.html #=> "<object width=\"425\" height=\"344\">...</object>"

需要访问令牌的提供者

某些内置提供者需要授权才能正常工作。你可以通过以下方式提供访问令牌：

# 通过 register_all 方法传递访问令牌
OEmbed::Providers.register_all(access_tokens: { facebook: 'my-access-token' })

# 或者通过环境变量提供访问令牌
ENV['OEMBED_FACEBOOK_TOKEN'] = 'my-access-token'
OEmbed::Providers.register_all

自定义提供者

如果你需要使用不在内置列表中的提供者，可以创建自定义提供者：

my_provider = OEmbed::Provider.new("http://my.cool-service.com/api/oembed_endpoint.{format}")
my_provider << "http://*.cool-service.com/image/*"
my_provider << "http://*.cool-service.com/video/*"

# 使用自定义提供者
resource = my_provider.get("http://a.cool-service.com/video/1")
resource.provider.name #=> "My Cool Service"

# 注册自定义提供者
OEmbed::Providers.register(my_provider)
resource = OEmbed::Providers.get("http://a.cool-service.com/video/2")

回退提供者

Ruby-oEmbed 支持 Noembed 和 Embedly 等回退提供者，以及 oEmbed 规范中的提供者发现功能：

OEmbed::Providers.register_fallback(
  OEmbed::ProviderDiscovery,
  OEmbed::Providers::Noembed
)

resource = OEmbed::Providers.get('https://www.xkcd.com/802/')

3. 项目API使用文档

主要API

• OEmbed::Providers.register_all: 注册所有内置提供者。
• OEmbed::Providers.get(url): 根据 URL 获取嵌入式内容。
• OEmbed::Provider.new(endpoint): 创建自定义提供者。
• OEmbed::Providers.register_fallback(providers): 注册回退提供者。

响应对象

• resource.video?: 检查资源是否为视频。
• resource.thumbnail_url: 获取资源的缩略图 URL。
• resource.html: 获取资源的嵌入式 HTML 代码。

4. 项目安装方式

通过 RubyGems 安装

gem install ruby-oembed

从源码安装

# 克隆仓库
git clone git://github.com/ruby-oembed/ruby-oembed.git
cd ruby-oembed

# 安装依赖
gem install bundler
bundle install

# 运行测试
bundle exec rake

通过以上步骤，你可以轻松安装并使用 Ruby-oEmbed 项目。