Ghee 项目技术文档

1. 安装指南

Ghee 是一个非官方的 Ruby 客户端，用于 GitHub API。为了使用 Ghee，您需要先确保您的系统中已经安装了 Ruby 环境。

步骤：

1. 确认安装 Ruby 环境。
2. 使用 gem install ghee 命令安装 Ghee。

2. 项目的使用说明

Ghee 提供了丰富的 API 接口，用于操作 GitHub 上的各种资源，如 Gists、Repos、Commits、Collaborators 等。

示例：

• 列出用户 jonmagic 的 Gists：

gh.user('jonmagic').gists

• 列出认证用户的 Gists：

gh.gists

• 创建一个 Gist：

gh.gists.create({
  :description => 'Ghee',
  :public => true,
  :files => {
    'file1.txt' => {
      :content => 'buttah yo bread'
    }
  }
})

3. 项目 API 使用文档

以下是 Ghee 部分 API 的使用文档：

Gists

• 列出用户 Gists：

gh.user(user_name).gists

• 列出公共 Gists：

gh.gists.public

• 创建一个 Gist：

gh.gists.create({
  :description => '描述',
  :public => true,
  :files => {
    '文件名' => {
      :content => '文件内容'
    }
  }
})

Repos

• 获取单个 Repo：

gh.repos(user_name, repo_name)

• 列出 Repo 的 Pull Requests：

gh.repos(user_name, repo_name).pulls

• 创建一个 Pull Request：

gh.repos(user_name, repo_name).pulls.create({
  :title => '标题',
  :body => '内容',
  :base => 'base 分支',
  :head => 'head 分支'
})

Commits

• 列出 Repo 的 Commits：

gh.repos(user_name, repo_name).commits

• 获取单个 Commit：

gh.repos(user_name, repo_name).commits(sha)

Collaborators

• 列出 Repo 的 Collaborators：

gh.repos(user_name, repo_name).collaborators

• 添加一个 Collaborator：

gh.repos(user_name, repo_name).collaborators.add(collaborator_user_name)

4. 项目安装方式

如前所述，您可以使用以下命令安装 Ghee：

gem install ghee

确保您已经安装了 Ruby 环境。在安装完成后，您可以使用 require 'ghee' 在 Ruby 项目中引用 Ghee。