Omniauth Redu

Implementação de estratégia de autenticação do OAuth 2.0 para Ruby.

Pré-requisitos

Instalação e uso

Dependências

Adicione a seguinte dependência no seu Gemfile:

gem 'omniauth-redu'

Execute o comando bundle install para baixar e instalar a dependência.

Rotas

É necessário fazer o mapeamente entre URL e actions nos controllers da sua aplicação. Para isso edite o arquivo config/routes.rb e adicione as seguintes rotas:

Neste exemplo é assumido que há um controller com o nome SessionsController que possui um action create.

  match '/auth/:provider/callback', :to => 'sessions#create'
  match '/auth/:provider', :to => 'sessions#create', as: :create_session

Controller

Sempre que uma requisição for feita para a URL /auth/redu é dado início ao ciclo de autorização. Ao fim do ciclo, o navegador do usuário é redirecionado para /auth/redu/callback junto com o access_token do mesmo. O access_token deve ser persistido por sua aplicação e utilizado nas requisições subsequentes para pegar mais informações do usuário.

Um exemplo de SessionsController mais simples possível pode ser visto abaixo:

class SessionsController < BaseController
  respond_to :html, :json

  def create
    # Busca ou cria usuário baseado no UID.
    if user = User.find_by_uid(auth_hash['uid']) || User.create_with_omniauth(auth_hash)

    # Informações para depuração
    Rails.logger.info "Adding #{user.id} to the session[:user_id]"

    # Adiciona ID do usuário à sessão
    session[:user_id] = user.id

    # Redireciona para URL da aplicação
    redirect_to root_path
  end

  protected

  def auth_hash
    request.env['omniauth.auth']
  end
end

O formado do hash disponível através de request.env['omniauth.redu'] é o seguinte:

{
  "uid" => 1212, # ID do usuário no Redu,
  "info" => {
    "name" => "Guilherme",
    "login" => "guiocavalcanti",
    "email" => "[email protected]",
  },
  "credentials" => { "token" => "XXX" }
}

Uma imaplentação do método User.create_with_omniauth! pode ser vista abaixo:

class User < ActiveRecord::Base
  attr_accessible :email, :login, :name, :token, :uid

  def self.create_with_omniauth(auth)
    create! do |user|
      user.uid = auth["uid"]
      user.name = auth["info"]["name"]
      user.login = auth["info"]["login"]
      user.email = auth["info"]["email"]
      user.token = auth["credentials"]["token"]
    end
  end
end

Mais exemplos de aplicatiovs

Redu Canvas application to enable students to submit exercises: https://github.com/redu/submitit
Aplicativo de cooperação anônima par a par para a plataforma social educacional Redu.: https://github.com/redu/autorregulacao

Redu Educational Technologies

This project is maintained and funded by Redu Educational Techologies.

Copyright

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.