Pinboard Ruby Gem 技术文档

本文档将详细介绍如何安装、使用以及API接口调用方法，帮助用户更好地了解和使用 Pinboard Ruby Gem。

1. 安装指南

要安装 Pinboard Ruby Gem，请在命令行中运行以下命令：

gem install pinboard

2. 项目使用说明

Pinboard Ruby Gem 是一个 Ruby 封装库，用于访问 Pinboard API。以下是使用该库的两种方式：

初始化客户端

pinboard = Pinboard::Client.new(:token => 'your_api_token')

您可以在 Pinboard 设置页面 找到您的 API 令牌。

通过用户名和密码访问

posts = Pinboard::Post.all(:username => 'foo', :password => 'bar')

两种方法均可以正常工作。

3. 项目API使用文档

以下是一些 API 调用的示例：

获取文章

pinboard.posts(:tag => 'ruby') # 获取所有标记为 'ruby' 的文章
pinboard.posts(:tag => 'ruby,pinboard') # 获取所有标记为 'ruby' 和 'pinboard' 的文章
pinboard.posts(:start => 20) # 从第20篇文章开始
pinboard.posts(:results => 20) # 只返回前20篇符合条件的文章
pinboard.posts(:fromdt => 4.days.ago) # 获取过去4天的所有文章
pinboard.posts(:todt => 4.days.ago) # 获取到4天前的所有文章

添加新文章

pinboard.add(:url => "http://example.com/", :description => 'Example post')

未来示例

pinboard.posts(:meta => true) # 在文章模型中包含元数据

4. 项目安装方式

Pinboard Ruby Gem 的安装方式如前所述，通过运行以下命令：

gem install pinboard

本项目支持以下 Ruby 版本，并通过 travis-ci.org 进行持续集成：

• 1.9.3
• 2.0.0
• 2.1
• 2.2
• jruby
• ruby-head

如需贡献代码或有问题反馈，请参考项目在 GitHub 的 issue tracker。本项目遵循 MIT 许可证。