Enterprise Server 3.15 は、現在リリース候補として使用できます。

ユーザのリソースを調べる

REST APIに対する認証済みリクエストにおいて、アプリケーションがアクセスできるユーザのリポジトリやOrganizationを確実に調べる方法を学びます。

この記事の内容

GitHub Enterprise Server APIに対して認証済みのリクエストを行う際には、アプリケーションがカレントユーザのリポジトリやOrganizationをフェッチしなければならないことがしばしばあります。 このガイドでは、これらのリソースを確実に調べる方法について説明します。

GitHub Enterprise Server API を使うには、Octokit.rb を使います。 このプロジェクトの完全なソース コードは、platform-samples リポジトリにあります。

作業の開始

まだ「認証の基本」を読んでいない場合は、それを読んでから以下の例に取り組んでください。 以下の例は、OAuth app を登録してあり、アプリケーションにユーザー用の OAuth トークンがあることを前提としています。

アプリケーションでアクセス可能なユーザのリポジトリを調べる

ユーザは、個人でリポジトリを所有する他に、別のユーザやOrganizationが所有するリポジトリのコラボレータであることもあります。 全体的にこれらは、ユーザーが特権アクセスを行なえるリポジトリです。ユーザーが読み取りあるいは書き込みのアクセス権を持つプライベートリポジトリであったり、ユーザーが書き込みのアクセス権を持つパブリックもしくは内部のリポジトリであったりします。

OAuth スコープと Organization のアプリケーション ポリシーによって、アプリでユーザーに対してアクセスできるリポジトリが決まります。 以下のワークフローを使用して、これらのリポジトリを調べます。

いつものように、まずは GitHub の Octokit.rb Ruby ライブラリが必要です。 そして、ページネーションを自動的に処理するように Octokit.rb を構成します。 改ページ位置の自動修正の詳細については、「REST API 内での改ページ位置の自動修正の使用」を参照してください。

require 'octokit'

Octokit.auto_paginate = true

次に、アプリケーションの特定ユーザー用の OAuth トークンを渡します。

# !!! DO NOT EVER USE HARD-CODED VALUES IN A REAL APP !!!
# Instead, set and test environment variables, like below.
client = Octokit::Client.new :access_token => ENV["OAUTH_ACCESS_TOKEN"]

これで、アプリケーションがそのユーザーに対してアクセスできるリポジトリをフェッチする準備ができました。

client.repositories.each do |repository|
  full_name = repository[:full_name]
  has_push_access = repository[:permissions][:push]

  access_type = if has_push_access
                  "write"
                else
                  "read-only"
                end

  puts "User has #{access_type} access to #{full_name}."
end

アプリケーションがアクセス可能なユーザのOrganizationを調べる

アプリケーションは、ユーザに対してOrganizationに関するあらゆるタスクを実行できます。 これらのタスクを実行するには、アプリに十分な権限を持つ OAuth 承認が必要です。 たとえば、read:org スコープを使うとチームの一覧を表示することができ、user スコープではユーザーの Organization メンバーシップを公開することができます。 ユーザがこれらのスコープのうちの1つ以上をアプリケーションに付与すると、ユーザのOrganizationをフェッチする準備が整います。

上でリポジトリを調べたときと同様に、まずは GitHub の Octokit.rb Ruby ライブラリを要求し、ページネーションを自動的に処理するように構成します。 改ページ位置の自動修正の詳細については、「REST API 内での改ページ位置の自動修正の使用」を参照してください。

require 'octokit'

Octokit.auto_paginate = true

次に、アプリケーションの特定ユーザーに対する OAuth トークンを渡して、API クライアントを初期化します。

# !!! DO NOT EVER USE HARD-CODED VALUES IN A REAL APP !!!
# Instead, set and test environment variables, like below.
client = Octokit::Client.new :access_token => ENV["OAUTH_ACCESS_TOKEN"]

これで、アプリケーションがそのユーザーに対してアクセスできる Organization の一覧を取得することができます。

client.organizations.each do |organization|
  puts "User belongs to the #{organization[:login]} organization."
end

ユーザのすべてのOrganizationメンバーシップを返す

ドキュメントをよく読むと、ユーザーのパブリックな Organization のメンバーシップの一覧を取得する API メソッドに気付くかもしれません。 ほとんどのアプリケーションでは、このAPIメソッドを避けるべきです。 このメソッドは、ユーザのパブリックなOrganizationに属するメンバーだけを返し、プライベートなOrganizationに属するメンバーは返しません。

アプリケーションでは通常、アクセスを認可されたすべてのユーザのOrganizationが求められます。 上記のワークフローでは、まさにこれを実行しています。