Taskmapper 项目技术文档

1. 安装指南

安装 Taskmapper

Taskmapper 是一个 Ruby Gem，可以通过 RubyGems 轻松安装：

gem install taskmapper

Taskmapper 依赖于 Hashie 库，该库会在安装 Taskmapper 时自动安装。

安装提供者

Taskmapper 本身功能有限，您可能需要安装一个提供者来扩展功能。可以通过以下命令查找可用的提供者：

gem search taskmapper

例如，安装 taskmapper-pivotal：

gem install taskmapper-pivotal

2. 项目使用说明

实例化 Taskmapper

首先，我们需要使用正确的选项实例化一个新类。以下示例展示了如何使用 Pivotal Tracker 进行身份验证：

pivotal = taskmapper.new(:pivotal, {:username => "john", :password => "seekrit"})

获取项目

实例化 Taskmapper 后，可以通过项目名称获取项目：

project = pivotal.project["testproject"]
#=> TaskMapper::Project<#name="testproject"..>

Project#[] 是 Project#find 的别名，也可以这样查找项目：

project = pivotal.project.find "testproject"
#=> TaskMapper::Project<#name="testproject"..>

创建工单

获取项目后，可以创建工单：

project.ticket!(:title => "Test", :description => "Hello World")

查找工单

可以通过 ID 查找工单：

ticket = project.tickets(:id => 22)
#=> TaskMapper::Ticket<#id=22..>

修改工单属性

可以修改工单的状态和描述：

ticket.status = :in_progress
ticket.description = "Changed description to something else!"
ticket.save

关闭工单

可以通过以下方式关闭工单：

ticket.close(:resolution => "fixed", :description => "Fixed issue by doing x")

3. 项目 API 使用文档

项目 API

• Taskmapper.new(provider, options)：实例化 Taskmapper 对象。
• Taskmapper#project.find(options)：查找项目。
• Taskmapper#project.ticket!(options)：创建工单。
• Taskmapper#project.tickets(options)：查找工单。

工单 API

• TaskMapper::Ticket#status=：设置工单状态。
• TaskMapper::Ticket#description=：设置工单描述。
• TaskMapper::Ticket#save：保存工单更改。
• TaskMapper::Ticket#close(options)：关闭工单。

4. 项目安装方式

安装 Taskmapper

gem install taskmapper

安装提供者

gem install taskmapper-pivotal

使用提供者

require 'taskmapper'
require 'taskmapper-pivotal'
pivotal = taskmapper.new(:pivotal, {:username => "john", :password => "seekrit"})

通过以上步骤，您可以成功安装并使用 Taskmapper 项目。