Project

omniauth-translationexchange

0.0
No commit activity in last 3 years
No release in over 3 years
omniauth-translationexchangetranslationexchange/omniauth-translationexchangeHomepageDocumentationSource CodeBug TrackerWiki
Translation Exchange strategy for SSO using OmniAuth framework
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
2,390
Stars
0
Forks
0
Watchers
4
 Releases
Current version
1.0.0
Total releases
1
First release
2017-06-20
Latest release
2017-06-20
 Development
Primary Language
Ruby
Licenses
MIT-LICENSE
Average date of last 50 commits
2017-01-08
Reverse Dependencies
0

 Dependencies

Development

rake
~> 12.0
rspec
~> 2.7

Runtime

omniauth-oauth2
~> 1.3
 Project Readme

OmniAuth for Translation Exchange

Translation Exchange OAuth2 Strategy for OmniAuth 1.4.

Supports the OAuth 2.0 server-side. Read the Translation Exchange docs for more details: https://docs.translationexchange.com/

Installing

Add to your Gemfile:

gem 'omniauth-translationexchange'

Then bundle install.

Usage

OmniAuth::Strategies::TranslationExchange is simply a Rack middleware. Read the OmniAuth 1.0 docs for detailed instructions: https://github.com/intridea/omniauth.

Here's a quick example, adding the middleware to a Rails app in config/initializers/omniauth.rb:

Rails.application.config.middleware.use OmniAuth::Builder do
  provider :translationexchange, ENV['TRANSLATION_EXCHANGE_KEY'], ENV['TRANSLATION_EXCHANGE_SECRET']
end

Configuring

You can configure several options, which you pass in to the provider method via a Hash:

  • scope: A comma-separated list of permissions you want to request from the user. See the Translation Exchange docs for a full list of available permissions. Default: email.
  • display: The display context to show the authentication page. Options are: web, desktop and mobile. Default: web.

For example, to request email permission and display the authorization page in a mobile app:

Rails.application.config.middleware.use OmniAuth::Builder do
  provider :translationexchange, ENV['TRANSLATION_EXCHANGE_KEY'], ENV['TRANSLATION_EXCHANGE_SECRET'], { 
      :scope => 'email', 
      :display => 'mobile'
  }
end

If you want to set the display format on a per-request basis, you can just pass it to the OmniAuth request phase URL, for example: /auth/translationexchange?display=popup.

Authentication Hash

Here's an example Authentication Hash available in request.env['omniauth.auth']:

{"provider"=>"translationexchange",
 "uid"=>"4e4885fd-c0ee-47f2-871d-22473a3de08d",
 "info"=>
  {"id"=>"4e4885fd-c0ee-47f2-871d-22473a3de08d",
   "display_name"=>"Alex Peterson",
   "first_name"=>"Alex",
   "last_name"=>"Peterson",
   "email"=>"alex@domain.com",
   "gender"=>"male",
   "mugshot"=>
    "https://gravatar.com/avatar/sdfasdfasdfasdfasdfasdfr34fsdf.png?s=65"},
 "credentials"=>
  {"token"=>"0ce884c17c79b74667e773c4c226e9fdc8f94f4c6fe4e7fd7b4558dbbbe62505",
   "expires_at"=>1495153596,
   "expires"=>true},
 "extra"=>
  {"user"=>
    {"uuid"=>"4e4885fd-c0ee-47f2-871d-22473a3de08d",
     "email"=>"alex@domain.com",
     "role"=>"developer",
     "display_name"=>"Alex Peterson",
     "first_name"=>"Alex",
     "last_name"=>"Peterson",
     "name"=>"Alex Peterson",
     "username"=>"alex",
     "mugshot"=>
      "https://gravatar.com/avatar/87345b2271259e2eeea3b01142f9af56.png?s=65",
     "time_zone"=>"Pacific Time (US & Canada)",
     "gender"=>"male",
     "created_at"=>"2013-11-21 14:28:45",
     "updated_at"=>"2017-05-18 15:23:03",
     "password_set_at"=>"2016-11-28 19:22:39",
     "last_logged_in_at"=>"2017-05-18 15:23:03"}}}

The precise information available may depend on the permissions which you request.