Descobrir recursos para um usuário

Ao fazer solicitações autenticadas na API de GitHub, os aplicativos frequentemente precisam buscar os repositórios e organizações do usuário atual. Neste guia, explicaremos como descobrir esses recursos de forma confiável.

Para interagir com a API do GitHub, usaremos o Octokit.rb. Encontre o código-fonte completo deste projeto no repositório platform-samples.

Introdução

Caso ainda não tenha lido, leia o guia Noções básicas da autenticação antes de trabalhar nos exemplos abaixo. Os exemplos abaixo consideram que você já registrou um OAuth app e que o aplicativo tem um token OAuth para um usuário.

Descubra os repositórios que o seu aplicativo pode acessar para um usuário

Além de ter seus próprios repositórios pessoais, um usuário pode ser um colaborador em repositórios pertencentes a outros usuários e organizações. Coletivamente, estes são os repositórios em que o usuário tem acesso privilegiado: ou é um repositório privado em que o usuário tem acesso de leitura ou gravação ou é um repositório público ou interno em que o usuário tem acesso de gravação.

Os escopos do OAuth e as políticas de aplicativo da organização determinam quais desses repositórios seu aplicativo pode acessar para um usuário. Use o fluxo de trabalho abaixo para descobrir esses repositórios.

Como sempre, primeiro, precisaremos da biblioteca Octokit.rb do Ruby do GitHub. Em seguida, vamos configurar o Octokit.rb para tratar a paginação automaticamente. Para saber mais sobre a paginação, confira Como usar paginação na API REST.

require 'octokit'

Octokit.auto_paginate = true

Em seguida, transmitiremos o token OAuth do aplicativo para um usuário especificado:

# !!! 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"]

Depois, estaremos prontos para buscar os repositórios que nosso aplicativo pode acessar para o usuário:

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

Descubra as organizações que o seu aplicativo pode acessar para um usuário

Os aplicativos podem executar todos os tipos de tarefas relacionadas à organização para um usuário. Para executar essas tarefas, o aplicativo precisa de uma autorização OAuth com permissão suficiente. Por exemplo, o escopo read:org permite que você liste as equipes, e o escopo user permite que você torne pública a associação à organização do usuário. Assim que um usuário conceder um ou mais desses escopos para o seu aplicativo, você estará pronto para buscar as organizações do usuário.

Assim como fizemos ao descobrir os repositórios acima, começaremos exigindo a biblioteca Ruby Octokit.rb do GitHub e configurando-a para cuidar da paginação para nós. Para saber mais sobre a paginação, confira Como usar paginação na API REST.

require 'octokit'

Octokit.auto_paginate = true

Em seguida, transmitiremos o token OAuth do aplicativo para um usuário especificado para inicializar nosso cliente de 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"]

Depois, podemos listar as organizações que nosso aplicativo pode acessar para o usuário:

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

Retorna todas as associações da organização do usuário

Se você leu a documentação na íntegra, talvez tenha observado um método de API usado para listar as associações da organização pública de um usuário. A maioria dos aplicativos deve evitar este método de API. Este método retorna apenas as associações de organizações públicas do usuário, não suas associações de organizações privadas.

Como um aplicativo, normalmente você quer todas as organizações do usuário que o seu aplicativo está autorizado a acessar. O fluxo de trabalho acima fornecerá exatamente isso.