Guia de início rápido do Ruby

Conclua as etapas descritas no restante desta página e, em cerca de cinco minutos, você terá um aplicativo de linha de comando Ruby simples que faz solicitações à API YouTube Data.

O código de exemplo usado neste guia recupera o recurso channel do canal do YouTube GoogleDevelopers e imprime algumas informações básicas desse recurso.

Pré-requisitos

Para executar este guia de início rápido, você precisa de:

  • Ruby 2.0 ou mais recente.
  • Acesso à Internet e a um navegador da Web.
  • uma Conta do Google.

Etapa 1: ativar a API YouTube Data

  1. Use este assistente para criar ou selecionar um projeto no Google Developers Console e ativar a API automaticamente. Clique em Continuar e em Acessar credenciais.

  2. Na página Criar credenciais, clique no botão Cancelar.

  3. Na parte de cima da página, selecione a guia Tela de permissão do OAuth. Selecione um endereço de e-mail, insira um nome do produto, se ainda não tiver sido definido, e clique no botão Salvar.

  4. Selecione a guia Credenciais, clique no botão Criar credenciais e selecione ID do cliente OAuth.

  5. Selecione o tipo de aplicativo Outro, insira o nome "Início rápido da API YouTube Data" e clique no botão Criar.

  6. Clique em OK para fechar a caixa de diálogo resultante.

  7. Clique no botão (Fazer o download do JSON) à direita do ID do cliente.

  8. Mova o arquivo transferido por download para o diretório de trabalho e renomeie-o como client_secret.json.

Etapa 2: Instalar a biblioteca de cliente do Google

Execute o comando a seguir para instalar a biblioteca:

gem install google-api-client

Consulte a página de instalação da biblioteca para conferir as opções de instalação alternativas.

Etapa 3: configurar o exemplo

Crie um arquivo chamado quickstart.rb no diretório de trabalho e copie o código a seguir:

# Sample Ruby code for user authorization

require 'rubygems'
gem 'google-api-client', '>0.7'
require 'google/apis'
require 'google/apis/youtube_v3'
require 'googleauth'
require 'googleauth/stores/file_token_store'

require 'fileutils'
require 'json'

# REPLACE WITH VALID REDIRECT_URI FOR YOUR CLIENT
REDIRECT_URI = 'http://localhost'
APPLICATION_NAME = 'YouTube Data API Ruby Tests'

# REPLACE WITH NAME/LOCATION OF YOUR client_secrets.json FILE
CLIENT_SECRETS_PATH = 'client_secret.json'

# REPLACE FINAL ARGUMENT WITH FILE WHERE CREDENTIALS WILL BE STORED
CREDENTIALS_PATH = File.join(Dir.home, '.credentials',
                             "youtube-quickstart-ruby-credentials.yaml")

# SCOPE FOR WHICH THIS SCRIPT REQUESTS AUTHORIZATION
SCOPE = Google::Apis::YoutubeV3::AUTH_YOUTUBE_READONLY

def authorize
  FileUtils.mkdir_p(File.dirname(CREDENTIALS_PATH))

  client_id = Google::Auth::ClientId.from_file(CLIENT_SECRETS_PATH)
  token_store = Google::Auth::Stores::FileTokenStore.new(file: CREDENTIALS_PATH)
  authorizer = Google::Auth::UserAuthorizer.new(
    client_id, SCOPE, token_store)
  user_id = 'default'
  credentials = authorizer.get_credentials(user_id)
  if credentials.nil?
    url = authorizer.get_authorization_url(base_url: REDIRECT_URI)
    puts "Open the following URL in the browser and enter the " +
         "resulting code after authorization"
    puts url
    code = gets
    credentials = authorizer.get_and_store_credentials_from_code(
      user_id: user_id, code: code, base_url: REDIRECT_URI)
  end
  credentials
end

# Initialize the API
service = Google::Apis::YoutubeV3::YouTubeService.new
service.client_options.application_name = APPLICATION_NAME
service.authorization = authorize

# Sample ruby code for channels.list

def channels_list_by_username(service, part, **params)
  response = service.list_channels(part, params).to_json
  item = JSON.parse(response).fetch("items")[0]

  puts ("This channel's ID is #{item.fetch("id")}. " +
        "Its title is '#{item.fetch("snippet").fetch("title")}', and it has " +
        "#{item.fetch("statistics").fetch("viewCount")} views.")
end

channels_list_by_username(service, 'snippet,contentDetails,statistics', for_username: 'GoogleDevelopers')

Etapa 4: executar a amostra

Execute o exemplo usando o comando a seguir:

ruby quickstart.rb

Na primeira vez que você executar o exemplo, será necessário autorizar o acesso:

  1. O exemplo tenta abrir uma nova janela ou guia no navegador padrão. Se isso falhar, copie o URL do console e abra-o manualmente no navegador.

    Se você ainda não tiver feito login na sua Conta do Google, será solicitado a fazer login. Se você estiver conectado a várias Contas do Google, será necessário selecionar uma conta para usar na autorização.

  2. Clique no botão Aceitar.

  3. Copie o código fornecido, cole-o no prompt de linha de comando e pressione Enter. O código pode aparecer no URL da página para a qual você é redirecionado após conceder a autorização:

    http://localhost/?code=4/nr_1TspmmQPFyifh7nz...OFo#

Observações

  • As informações de autorização são armazenadas no sistema de arquivos. Portanto, as execuções subsequentes não vão solicitar autorização.
  • O fluxo de autorização neste exemplo foi projetado para um aplicativo de linha de comando. Para informações sobre como realizar a autorização em um aplicativo da Web, consulte Usar o OAuth 2.0 para aplicativos de servidor da Web (em inglês).

Leitura adicional