Goodreads 项目技术文档

1. 安装指南

系统要求

• Ruby 版本：1.9.3 或更高版本

安装方法

• 使用 RubyGems 安装：

  gem install goodreads
  

• 手动安装：

  rake install
  

2. 项目使用说明

在使用 Goodreads API 前，您需要创建一个新的应用。请访问 注册表单 了解详情。

初始化客户端

client = Goodreads::Client.new(api_key: "KEY", api_secret: "SECRET")
# 或者简写形式
client = Goodreads.new(api_key: "KEY")

全局配置

可以在全局级别定义客户端凭据。如果是使用 Rails，可以在 config/initializers 下创建一个初始化文件：

Goodreads.configure(
  api_key: "KEY",
  api_secret: "SECRET"
)

获取全局配置信息：

Goodreads.configuration # => { api_key: "YOUR_KEY" }

如果需要重置选项：

Goodreads.reset_configuration

3. 项目API使用文档

查找书籍

可以通过 ID、ISBN 或标题查找书籍：

client.book("id")
client.book_by_isbn("ISBN")
client.book_by_title("书籍标题")

搜索书籍（通过标题、ISBN、分类）：

search = client.search_books("指环王")

search.results.work.each do |book|
  book.id        # => 书籍 ID
  book.title     # => 书籍标题
end

作者

通过 Goodreads 作者 ID 查找作者：

author = client.author("id")

author.id              # => 作者 ID
author.name            # => 作者姓名
author.link            # => 作者 Goodreads 页面链接
author.fans_count      # => 作者在 Goodreads 上的粉丝数量
author.image_url       # => 作者图片链接
author.small_image_url # => 作者小图链接
author.about           # => 作者简介
author.influences      # => 作者影响的列表
author.works_count     # => Goodreads 上作者作品的数量
author.gender          # => 作者性别
author.hometown        # => 作者家乡
author.born_at         # => 作者生日
author.died_at         # => 作者逝世日期

通过名称查找作者：

author = client.author_by_name("作者名称")

author.id     # => 作者 ID
author.name   # => 作者姓名
author.link   # => 作者 Goodreads 页面链接

查找作者书籍：

author = client.author_Book("id")

author.id     # => 作者 ID
author.name   # => 作者姓名
author.link   # => 作者 Goodreads 页面链接
author.books  # => 该作者书籍数组

评论

获取最近的评论：

client.recent_reviews.each do |r|
  r.id            # => 评论 ID
  r.book.title    # => 评论书籍标题
  r.body          # => 评论内容
  r.user.name     # => 评论用户姓名
end

获取评论详情：

review = client.review("id")

review.id         # => 评论 ID
review.user       # => 用户信息
review.book       # => 书籍信息
review.rating     # => 用户评分

书架

获取用户书架上的书籍：

shelf = client.shelf(user_id, shelf_name)

shelf.books  # => 该书架上的书籍数组
shelf.start  # => 该页结果开始索引
shelf.end    # => 该页结果结束索引
shelf.total  # => 该书架上书籍总数

群组

获取群组详情：

group = client.group("id")

group.id                 # => 群组 ID
group.title              # => 群组标题
group.access             # => 群组访问设置（公开或私人）
group.group_users_count  # => 群组中的用户数量

列出指定用户所在的群组：

group_list = client.group_list("user_id", "sort")

group_list.total         # => 群组总数
group_list.group.count  # => 请求返回的群组数量

# 遍历列表以获取每个群组的详细信息。
group_list.group.each do |g|
  g.id                 # => 群组 ID
  g.access             # => 访问设置（私人、公开）
  g.users_count        # => 成员数量
  g.title              # => 标题
  g.image_url          # => 群组图片 URL
  g.last_activity_at   # => 群组最后活动时间
end

sort 参数是可选的，默认为 my_activity。其他排序选项，请参考 Goodreads API。

分页

要获取特定页面的结果，请在调用时使用 page 参数：

books = client.search_books("Term", page: 2)

OAuth

对于需要权限的 API 调用（如写入操作或浏览好友），请参考我们的 OAuth 教程。

4. 项目安装方式

请遵循以下步骤安装 Goodreads 项目：

1. 确保您的系统中已安装 Ruby 1.9.3 或更高版本。
2. 使用 RubyGems 安装 Goodreads gem：

   gem install goodreads
   

3. 或者，手动安装 Goodreads gem：

   rake install
   

按照以上步骤操作后，您就可以开始使用 Goodreads 项目了。