Kindle Highlights 技术文档

1. 安装指南

1.1 环境要求

• Ruby 版本 2.1.0 或更高版本
• 一个 Amazon Kindle 账户

1.2 安装步骤

使用以下命令安装 kindle-highlights gem：

gem install kindle-highlights

2. 项目的使用说明

2.1 初始化客户端

首先，需要在你的 Ruby 代码中引入 kindle-highlights gem，并通过你的 Amazon Kindle 账户的邮箱地址和密码初始化一个客户端：

require 'kindle_highlights'

kindle = KindleHighlights::Client.new(
  email_address: "[e-mail]",
  password: "password"
)

2.2 获取 Kindle 书籍列表

使用 books 方法获取你所有的 Kindle 书籍列表。该方法返回一个 KindleHighlights::Book 对象的集合：

kindle.books

每个 Book 对象包含以下属性：

• asin: 书籍的 Amazon ASIN
• author: 书籍的作者
• title: 书籍的标题

book = kindle.books.first
book.asin
book.author
book.title

2.3 获取单本书籍的标注

使用 highlights_for 方法获取特定书籍的所有标注。需要传入书籍的 Amazon ASIN 作为参数。该方法返回一个 KindleHighlights::Highlight 对象的集合：

kindle.highlights_for("B005CQ2ZE6")

每个 Highlight 对象包含以下属性：

• asin: 书籍的 Amazon ASIN
• text: 标注的文本内容
• location: 标注在书籍中的位置

highlight = kindle.highlights_for("B005CQ2ZE6").first
highlight.asin
highlight.text
highlight.location

2.4 高级用法

kindle-highlights gem 使用 mechanize 与 Amazon 的 Kindle 页面进行交互。你可以通过传递自定义的 mechanize_options 来覆盖默认的 mechanize 设置：

kindle = KindleHighlights::Client.new(
  email_address: "[e-mail]",
  password: "amazon_password",
  mechanize_options: { user_agent_alias: 'Mac Safari' }
)

你还可以使用其他 TLD 的 read.amazon.com 等效地址：

kindle = KindleHighlights::Client.new(
  email_address: "[e-mail]",
  password: "amazon_password",
  root_url: 'https://read.amazon.co.jp'
)

3. 项目 API 使用文档

3.1 KindleHighlights::Client.new(email_address:, password:, mechanize_options: {}, root_url: 'https://read.amazon.com')

初始化一个新的客户端实例。

• email_address: 你的 Amazon Kindle 账户的邮箱地址
• password: 你的 Amazon Kindle 账户的密码
• mechanize_options: 自定义的 mechanize 选项
• root_url: Amazon Kindle 页面的根 URL

3.2 kindle.books

获取所有 Kindle 书籍的列表，返回一个 KindleHighlights::Book 对象的集合。

3.3 kindle.highlights_for(asin)

获取指定书籍的所有标注，返回一个 KindleHighlights::Highlight 对象的集合。

• asin: 书籍的 Amazon ASIN

3.4 book.highlights_from_amazon

获取指定书籍的所有标注，返回一个 KindleHighlights::Highlight 对象的集合。

4. 项目安装方式

4.1 使用 RubyGems 安装

通过 RubyGems 安装 kindle-highlights gem：

gem install kindle-highlights

4.2 在 Gemfile 中添加依赖

如果你使用 Bundler 管理依赖，可以在 Gemfile 中添加以下内容：

gem 'kindle-highlights'

然后运行 bundle install 安装依赖。

---

通过本文档，你应该能够顺利安装并使用 kindle-highlights gem 来获取和管理你的 Kindle 标注。如果在使用过程中遇到问题，可以参考文档中的高级用法部分，或者查看项目的 GitHub 页面获取更多信息。