# 使用 REST API 和 Ruby 编写脚本

了解如何使用 Octokit.rb SDK 编写脚本，以便与 REST API 交互。

## 关于 Octokit.rb

如果要使用 Ruby 编写脚本以与 GitHub REST API 交互， GitHub 建议使用 Octokit.rb SDK。 Octokit.rb 由 GitHub 维护。 SDK 实现了最佳做法，可让你更轻松地通过 Ruby 与 REST API 进行交互。 Octokit.rb 适用于所有现代浏览器、Node.rb 和 Deno。 有关 Octokit.rb 的详细信息，请参阅 [Octokit.rb 自述文件](https://github.com/octokit/octokit.rb/#readme)。

## 先决条件

本指南假定你熟悉 Ruby 和 GitHub REST API。 有关 REST API 的详细信息，请参阅 [REST API 入门](/zh/enterprise-server@3.22/rest/using-the-rest-api/getting-started-with-the-rest-api)。

必须安装和导入 `octokit` gem，才能使用 Octokit.rb 库。 本指南使用符合 Ruby 约定的导入语句。 有关不同安装方法的详细信息，请参阅 [Octokit.rb 自述文件的安装部分](https://github.com/octokit/octokit.rb/#installation)。

## 实例化和身份验证

> \[!WARNING]
> 将身份验证凭据视为密码。
>
> 若要保护凭据安全，可以将凭据存储为机密，并通过 GitHub Actions运行脚本。 有关详细信息，请参阅“[在 GitHub Actions 中使用机密](/zh/enterprise-server@3.22/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets)”。

> 如果，请考虑使用另一个 CLI 服务安全地存储凭据。

### 使用personal access token进行身份验证

如果要使用 GitHub REST API 进行个人使用，可以创建一个 personal access token。 有关创建personal access token的详细信息，请参阅[管理个人访问令牌](/zh/enterprise-server@3.22/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)。

首先，需要 `octokit` 库。 然后，将 `Octokit` 作为 personal access token 选项传入，以创建 `access_token` 的实例。 在以下示例中，将 `YOUR-TOKEN` 替换为您的 personal access token。

```ruby copy
require 'octokit'

octokit = Octokit::Client.new(access_token: 'YOUR-TOKEN')
```

### 使用GitHub App进行身份验证

如果要代表组织或其他用户使用 API， GitHub 建议使用 GitHub App。 如果某个终结点可供 GitHub Apps 使用，该终结点的 REST 参考文档会注明需要哪种类型的 GitHub App 令牌。 有关详细信息，请参阅 [注册GitHub应用](/zh/enterprise-server@3.22/apps/creating-github-apps/registering-a-github-app/registering-a-github-app) 和 [关于使用 GitHub 应用进行身份验证](/zh/enterprise-server@3.22/apps/creating-github-apps/authenticating-with-a-github-app/about-authentication-with-a-github-app)。

无需使用 `octokit`，只需将你的 `Octokit::Client` 信息作为选项传入，即可创建 GitHub App 的实例。 在以下示例中，将 `APP_ID` 替换为应用的 ID，将 `PRIVATE_KEY` 替换为应用的私钥，将 `INSTALLATION_ID` 替换为要代表其进行身份验证的应用的安装 ID。 可以在应用的设置页面上找到应用的 ID 并生成私钥。 有关详细信息，请参阅“[管理GitHub应用的私钥](/zh/enterprise-server@3.22/apps/creating-github-apps/authenticating-with-a-github-app/managing-private-keys-for-github-apps)”。 可以使用 `GET /users/{username}/installation`、`GET /repos/{owner}/{repo}/installation` 或 `GET /orgs/{org}/installation` 终结点获取安装 ID。 有关详细信息，请参阅 [GitHub Apps 的 REST API 终结点](/zh/enterprise-server@3.22/rest/apps/apps)。 用`HOSTNAME`的名称替换你的 GitHub Enterprise Server 实例。

```ruby copy
require 'octokit'

app = Octokit::Client.new(
  client_id: APP_ID,
  client_secret: PRIVATE_KEY,
  installation_id: INSTALLATION_ID
)

octokit = Octokit::Client.new(bearer_token: app.create_app_installation.access_token)
```

### 在 GitHub Actions 中进行身份验证

如果要在工作流中使用 GitHub Actions API， GitHub 建议使用内置 `GITHUB_TOKEN` 身份验证，而不是创建令牌。 可以使用 `GITHUB_TOKEN` 密钥向 `permissions` 授予权限。 有关 `GITHUB_TOKEN` 的详细信息，请参阅 [GITHUB\_TOKEN](/zh/enterprise-server@3.22/actions/concepts/security/github_token)。

如果工作流需要访问工作流存储库之外的资源，则无法使用 `GITHUB_TOKEN`。 在这种情况下，请将凭据存储为机密，并将以下示例中的 `GITHUB_TOKEN` 替换为机密的名称。 有关机密的详细信息，请参阅 [在 GitHub Actions 中使用机密](/zh/enterprise-server@3.22/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets)。

如果使用 `run` 关键字在工作流中 GitHub Actions 执行 Ruby 脚本，则可以将值 `GITHUB_TOKEN` 存储为环境变量。 脚本可以作为 `ENV['VARIABLE_NAME']` 访问环境变量。

例如，此工作流步骤将 `GITHUB_TOKEN` 存储在名为 `TOKEN` 的环境变量中：

```yaml
- name: Run script
  env:
    TOKEN: ${{ secrets.GITHUB_TOKEN }}
  run: |
    ruby .github/actions-scripts/use-the-api.rb
```

工作流运行的脚本使用 `ENV['TOKEN']` 进行身份验证：

```ruby copy
require 'octokit'

octokit = Octokit::Client.new(access_token: ENV['TOKEN'])
```

### 无需身份验证即可实例化

可以在不进行身份验证的情况下使用 REST API，但速率限制较低，并且无法使用某些终结点。 要在不进行身份验证的情况下创建 `Octokit` 的实例，请不要传递 `access_token` 选项。

```ruby copy
require 'octokit'

octokit = Octokit::Client.new
```

## 发出请求

Octokit 支持多种请求方式。 如果知道终结点的 HTTP 谓词和路径，则可以使用 `request` 方法发出请求。 如果要利用 IDE 中的自动完成和键入功能，可以使用 `rest` 方法。 对于分页终结点，可以使用 `paginate` 方法来请求多页数据。

### 使用 `request` 方法发出请求

若要使用 `request` 方法发出请求，请将 HTTP 方法和路径作为第一个参数传递。 将哈希中的任何主体、查询或路径参数作为第二个自变量传递。 例如，向 `GET` 发出 `/repos/{owner}/{repo}/issues` 请求并传递 `owner`、`repo` 和 `per_page` 参数：

```ruby copy
octokit.request("GET /repos/{owner}/{repo}/issues", owner: "github", repo: "docs", per_page: 2)
```

`request` 方法会自动传递 `Accept: application/vnd.github+json` 标头。 要传递其他标头或不同的 `Accept` 标头，请将 `headers` 选项添加到作为第二个自变量传递的哈希。
`headers` 选项的值是一个哈希，其中标头名称作为键，标头值作为值。 例如，若要发送具有 `content-type` 值的 `text/plain` 标头：

```ruby copy
octokit.request("POST /markdown/raw", text: "Hello **world**", headers: { "content-type" => "text/plain" })
```

### 使用 `rest` 接口方法发出请求

每个 REST API 终结点在 Octokit 中都有一个关联的 `rest` 终结点方法。 为方便起见，这些方法通常会在 IDE 中自动完成。 可以将任何参数作为哈希传递给该方法。

```ruby copy
octokit.rest.issues.list_for_repo(owner: "github", repo: "docs", per_page: 2)
```

### 发出分页请求

如果终结点已分页，并且你想要提取多页结果，则可以使用 `paginate` 方法。
`paginate` 将依次提取结果的下一页，直至到达最后一页，然后将所有结果作为数组返回。 一些端点将分页结果以对象中的数组返回，而不是以数组的形式返回分页结果。
`paginate` 始终返回项的数组，即使原始结果为一个对象。

例如，以下示例从 `github/docs` 存储库中获取所有问题。 虽然它一次请求 100 个问题，但函数在到达最后一页数据之前不会返回。

```ruby copy
issue_data = octokit.paginate("GET /repos/{owner}/{repo}/issues", owner: "github", repo: "docs", per_page: 100)
```

`paginate` 方法接受可选块，可用于处理每个结果页。 这样，你只能从响应中收集所需的数据。 例如，以下示例继续提取结果，直到返回标题中包含“test”的问题。 对于返回的数据页面，仅存储问题标题和作者。

```ruby copy
issue_data = octokit.paginate("GET /repos/{owner}/{repo}/issues", owner: "github", repo: "docs", per_page: 100) do |response, done|
  response.data.map do |issue|
    if issue.title.include?("test")
      done.call
    end
    { title: issue.title, author: issue.user.login }
  end
end
```

可以使用 `octokit.paginate.iterator()` 一次循环访问一个页面，而不是一次提取所有结果。 例如，以下示例一次提取一页结果，并在提取下一页之前处理页面中的每个对象。 到达标题中包含“test”的问题后，脚本将停止迭代，并返回已处理的每个对象的问题标题和问题作者。 迭代器是提取分页数据的内存效率最高的方法。

```ruby copy
iterator = octokit.paginate.iterator("GET /repos/{owner}/{repo}/issues", owner: "github", repo: "docs", per_page: 100)
issue_data = []
break_loop = false
iterator.each do |data|
  break if break_loop
  data.each do |issue|
    if issue.title.include?("test")
      break_loop = true
      break
    else
      issue_data << { title: issue.title, author: issue.user.login }
    end
  end
end
```

也可以将 `paginate` 方法与 `rest` 终结点方法一起使用。 将 `rest` 端点方法作为第一个自变量传递，并将任何参数作为第二个自变量传递。

```ruby copy
iterator = octokit.paginate.iterator(octokit.rest.issues.list_for_repo, owner: "github", repo: "docs", per_page: 100)
```

有关分页的详细信息，请参阅 [在 REST API 中使用分页](/zh/enterprise-server@3.22/rest/using-the-rest-api/using-pagination-in-the-rest-api)。

## 捕获错误

### 捕获所有错误

有时， GitHub REST API 将返回错误。 例如，如果访问令牌已过期或省略了必需的参数，则会收到错误。 Octokit.rb 在收到除 `400 Bad Request`、`401 Unauthorized`、`403 Forbidden`、`404 Not Found` 和 `422 Unprocessable Entity` 以外的错误时，会自动重试请求。 如果在重试后仍发生 API 错误，Octokit.rb 会引发一个错误，其中包含响应的 HTTP 状态代码 (`response.status`) 和响应头 (`response.headers`)。 应在代码中处理这些错误。 例如，可以使用 try/catch 块来捕获错误：

```ruby copy
begin
files_changed = []

iterator = octokit.paginate.iterator("GET /repos/{owner}/{repo}/pulls/{pull_number}/files", owner: "github", repo: "docs", pull_number: 22809, per_page: 100)
iterator.each do | data |
    files_changed.concat(data.map {
      | file_data | file_data.filename
    })
  end
rescue Octokit::Error => error
if error.response
puts "Error! Status: #{error.response.status}. Message: #{error.response.data.message}"
end
puts error
end
```

### 处理预期的错误代码

有时， GitHub 使用 4xx 状态代码来指示非错误响应。 如果您正在使用的终结点这样做，则可以为特定错误添加额外的处理措施。 例如，如果存储库未加星标，则 `GET /user/starred/{owner}/{repo}` 终结点将返回 `404`。 以下示例使用 `404` 响应来指示存储库未加星标；所有其他错误代码都被视为错误。

```ruby copy
begin
octokit.request("GET /user/starred/{owner}/{repo}", owner: "github", repo: "docs")
puts "The repository is starred by me"
rescue Octokit::NotFound => error
puts "The repository is not starred by me"
rescue Octokit::Error => error
puts "An error occurred while checking if the repository is starred: #{error&.response&.data&.message}"
end
```

### 处理速率限制错误

如果收到速率限制错误，可能需要在等待后重试请求。 当您触发速率限制时，GitHub 会返回 `403 Forbidden` 错误，并且响应标头 `x-ratelimit-remaining` 的值将为 `"0"`。 响应标头将包含一个 `x-ratelimit-reset` 标头，该标头告知当前速率限制窗口重置的时间（以 UTC 纪元秒为单位）。 可以在 `x-ratelimit-reset` 指定的时间后重试请求。

```ruby copy
def request_retry(route, parameters)
 begin
 response = octokit.request(route, parameters)
 return response
 rescue Octokit::RateLimitExceeded => error
 reset_time_epoch_seconds = error.response.headers['x-ratelimit-reset'].to_i
 current_time_epoch_seconds = Time.now.to_i
 seconds_to_wait = reset_time_epoch_seconds - current_time_epoch_seconds
 puts "You have exceeded your rate limit. Retrying in #{seconds_to_wait} seconds."
 sleep(seconds_to_wait)
 retry
 rescue Octokit::Error => error
 puts error
 end
 end

 response = request_retry("GET /repos/{owner}/{repo}/issues", owner: "github", repo: "docs", per_page: 2)
```

## 利用响应功能

如果请求成功，`request` 方法将返回响应对象。 响应对象包含 `data`（端点返回的响应正文）、`status`（HTTP 响应代码）、`url`（请求的 URL）和 `headers`（包含响应头的哈希）。 除非另外指定，否则响应正文会采用 JSON 格式。 某些终结点不返回响应正文；在这些情况下，将省略 `data` 属性。

```ruby copy
response = octokit.request("GET /repos/{owner}/{repo}/issues/{issue_number}", owner: "github", repo: "docs", issue_number: 11901)
 puts "The status of the response is: #{response.status}"
 puts "The request URL was: #{response.url}"
 puts "The x-ratelimit-remaining response header is: #{response.headers['x-ratelimit-remaining']}"
 puts "The issue title is: #{response.data['title']}"
```

同样，`paginate` 方法会返回响应对象。 如果 `request` 成功，则 `response` 对象包含数据、状态、URL 和标头。

```ruby copy
response = octokit.paginate("GET /repos/{owner}/{repo}/issues", owner: "github", repo: "docs", per_page: 100)
puts "#{response.data.length} issues were returned"
puts "The title of the first issue is: #{response.data[0]['title']}"
```

## 示例脚本

下面是使用 Octokit.rb 的完整示例脚本。 该脚本导入 `Octokit` 并创建新的 `Octokit` 实例。 如果您想使用 GitHub App 而不是 personal access token 进行身份验证，则应导入并实例化 `App`，而不是 `Octokit`。 有关详细信息，请参阅本指南中的 [身份验证 GitHub App](#authenticating-with-a-github-app) 。

`get_changed_files` 函数获取为拉取请求更改的所有文件。
`comment_if_data_files_changed` 函数调用 `get_changed_files` 函数。 如果拉取请求更改的任何文件的文件路径中包含 `/data/`，则该函数将对拉取请求进行注释。

```ruby copy
require "octokit"

 octokit = Octokit::Client.new(access_token: "YOUR-TOKEN")

 def get_changed_files(octokit, owner, repo, pull_number)
 files_changed = []

 begin
 iterator = octokit.paginate.iterator("GET /repos/{owner}/{repo}/pulls/{pull_number}/files", owner: owner, repo: repo, pull_number: pull_number, per_page: 100)
 iterator.each do | data |
     files_changed.concat(data.map {
       | file_data | file_data.filename
     })
   end
 rescue Octokit::Error => error
 if error.response
 puts "Error! Status: #{error.response.status}. Message: #{error.response.data.message}"
 end
 puts error
 end

 files_changed
 end

 def comment_if_data_files_changed(octokit, owner, repo, pull_number)
 changed_files = get_changed_files(octokit, owner, repo, pull_number)

 if changed_files.any ? {
   | file_name | /\/data\//i.match ? (file_name)
 }
 begin
 comment = octokit.create_pull_request_review_comment(owner, repo, pull_number, "It looks like you changed a data file. These files are auto-generated. \n\nYou must revert any changes to data files before your pull request will be reviewed.")
 comment.html_url
 rescue Octokit::Error => error
 if error.response
 puts "Error! Status: #{error.response.status}. Message: #{error.response.data.message}"
 end
 puts error
 end
 end
 end

# Example usage
owner = "github"
repo = "docs"
pull_number = 22809
comment_url = comment_if_data_files_changed(octokit, owner, repo, pull_number)

puts "A comment was added to the pull request: #{comment_url}"
```

> \[!NOTE]
> 这只是一个基本示例。 实际上，你可能想要使用错误处理和条件检查来处理各种场景。

## 后续步骤

若要详细了解如何使用 GitHub REST API 和 Octokit.rb，请浏览以下资源：

* 要详细了解 Octokit.rb，请参阅 [Octokit.rb 文档](https://github.com/octokit/octokit.rb/#readme)。
* 若要查找有关可用 REST API 终结点的详细信息 GitHub（包括其请求和响应结构），请参阅 [GitHub REST API 文档](/zh/enterprise-server@3.22/rest)。