项目技术文档 —— Harvested Ruby Wrapper

1. 安装指南

在开始使用Harvested之前，需要确保您的系统中已经安装了Ruby。然后，通过RubyGems仓库，可以轻松安装Harvested。在命令行中执行以下命令：

gem install harvested

确保在执行安装命令时您有足够的权限，如果在Linux或Mac系统上可能需要使用sudo。

2. 项目使用说明

Harvested是一个用于Ruby的Harvest API的封装库。以下是使用Harvested进行基本操作的说明：

首先，创建一个Harvest客户端实例，需要提供您的Harvest账户的子域名、用户名和密码：

harvest = Harvest.client(subdomain: 'yoursubdomain', username: 'yourusername', password: 'yourpassword')

接下来，可以使用该客户端实例访问不同的资源。例如，列出所有项目：

harvest.projects.all

如果您想针对特定客户端的所有项目，可以传递查询选项：

harvest.projects.all(nil, client: 12345)

这里需要注意的是，第一个参数是一个可选的用户ID字段，如果不包含该字段，必须指定为nil。

3. 项目API使用文档

Harvested提供的API主要是围绕Harvest API构建的。以下是一些基础的使用示例：

创建客户端

client = Harvest::Client.new(name: "Billable Company LTD.")
client = harvest.clients.create(client)

查找客户端

found_client = harvest.clients.find(client.id)

列出所有项目

projects = harvest.projects.all

列出特定客户端的项目

client_projects = harvest.projects.all(nil, client: 12345)

在查询时，可以传递任何符合Harvest API规范的查询属性哈希。

4. 项目安装方式

Harvested的安装方式非常简单，如下：

gem install harvested

确保Ruby环境已经搭建好，并且RubyGems处于最新版本。在一些系统中，您可能需要使用sudo来安装Ruby包。

注意

• Harvested目前冻结了新特性的添加，并且不支持V2 API。更多关于此决定的原因，请查看官方文档。
• Harvested的测试目前支持Ruby 2.0+版本。

通过以上文档，用户应该能够顺利安装并使用Harvested Ruby Wrapper来进行Harvest API的操作。如果遇到任何问题，建议查阅Harvested的官方文档或直接查看其源代码。