omniauth-translationexchange 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d9e9d3f9d1bbe6d22a25449eeab03ed272bf3e8c
+  data.tar.gz: 35f20bd8fa2da242f0eeb6ab4afb9be0a0c6b3de
+SHA512:
+  metadata.gz: 55e8151ee479a93ab3c1a90bad6c71061faea7b3193334bae6b7dcf27d46beec721d8a8fc9485b465994713cacb68e6ce7e3a2f189f28a6cf5d2fc535f747d3b
+  data.tar.gz: 45a9ba8dd631a02f999a47ff3afb436b90ca7e805b52b668b8497e48f888c628615390e7b030e8975ab4f8ca7a5e659e30c1936f8dffdcaffc5c22c23a03cb5d

data/.gitignore

@@ -0,0 +1,2 @@
+.idea
+*.gem

data/Gemfile

@@ -0,0 +1,5 @@
+source :rubygems
+
+gemspec
+
+gem 'jruby-openssl', :platform => :jruby

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    omniauth-translationexchange (1.0.0)
+      omniauth-oauth2 (~> 1.3)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    faraday (0.12.1)
+      multipart-post (>= 1.2, < 3)
+    hashie (3.5.5)
+    jwt (1.5.6)
+    multi_json (1.12.1)
+    multi_xml (0.6.0)
+    multipart-post (2.0.0)
+    oauth2 (1.4.0)
+      faraday (>= 0.8, < 0.13)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    omniauth (1.6.1)
+      hashie (>= 3.4.6, < 3.6.0)
+      rack (>= 1.6.2, < 3)
+    omniauth-oauth2 (1.4.0)
+      oauth2 (~> 1.0)
+      omniauth (~> 1.2)
+    rack (2.0.3)
+    rake (12.0.0)
+    rspec (2.7.0)
+      rspec-core (~> 2.7.0)
+      rspec-expectations (~> 2.7.0)
+      rspec-mocks (~> 2.7.0)
+    rspec-core (2.7.1)
+    rspec-expectations (2.7.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jruby-openssl
+  omniauth-translationexchange!
+  rake (~> 12.0)
+  rspec (~> 2.7)
+
+BUNDLED WITH
+   1.14.6

data/README.md

@@ -0,0 +1,89 @@
+# 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`:
+
+```ruby
+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`:
+
+```ruby
+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:
+ 
+```ruby
+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']`:
+
+```ruby
+{"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.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/deploy

@@ -0,0 +1,66 @@
+#!/usr/bin/env ruby
+
+gem_name = 'omniauth-translationexchange'
+
+def execute(cmd)
+  puts "\n***************************************************************************\n"
+  puts "$ #{cmd}"
+  system(cmd)
+end
+
+def version_file_path
+  './lib/omniauth/translation_exchange/version.rb'
+end
+
+def version_file
+  @version_file ||= File.read(version_file_path)
+end
+
+def version
+  @version ||= version_file.match(/VERSION\s*=\s*'([^']*)'/)[1]
+end
+
+def increment_version
+  parts = version.split('.')
+  parts[2] = (parts[2].to_i + 1).to_s
+  new_version = parts.join('.')
+
+  version_file.gsub!(version, new_version)
+
+  File.open(version_file_path, 'w') do |file|
+    file.write(version_file)
+  end
+
+  @version_file = nil
+  @version = nil
+end
+
+puts "\nBuilding omniauth-translationexchange-#{version}.gem..."
+
+if ARGV.include?('release')
+  execute('git checkout master')
+  execute('git merge develop')
+  execute('git push')
+end
+
+execute('bundle exec rspec')
+execute("gem build #{gem_name}.gemspec")
+execute("gem install #{gem_name}-#{version}.gem --no-ri --no-rdoc")
+
+if ARGV.include?('release')
+  execute("git tag #{version}")
+  execute('git push --tags')
+
+  execute("gem push #{gem_name}-#{version}.gem")
+
+  execute('git checkout develop')
+
+  increment_version
+
+  execute("git add #{version_file_path}")
+  execute("git commit -m 'Updated version to #{version}'")
+  execute('git push')
+end
+
+
+

data/example/Gemfile

@@ -0,0 +1,6 @@
+source :rubygems
+
+gem 'rack', '~> 1.3.6'
+
+gem 'sinatra'
+gem 'omniauth-translationexchange', :path => '../'

data/example/Gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: ../
+  specs:
+    omniauth-geni (1.0.0)
+      omniauth-oauth2 (~> 1.0.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.6)
+    faraday (0.7.6)
+      addressable (~> 2.2)
+      multipart-post (~> 1.1)
+      rack (~> 1.1)
+    hashie (1.2.0)
+    multi_json (1.0.4)
+    multipart-post (1.1.4)
+    oauth2 (0.5.2)
+      faraday (~> 0.7)
+      multi_json (~> 1.0)
+    omniauth (1.0.2)
+      hashie (~> 1.2)
+      rack
+    omniauth-oauth2 (1.0.0)
+      oauth2 (~> 0.5.0)
+      omniauth (~> 1.0)
+    rack (1.3.6)
+    rack-protection (1.2.0)
+      rack
+    sinatra (1.3.2)
+      rack (~> 1.3, >= 1.3.6)
+      rack-protection (~> 1.2)
+      tilt (~> 1.3, >= 1.3.3)
+    tilt (1.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  omniauth-geni!
+  rack (~> 1.3.6)
+  sinatra

data/example/config.ru

@@ -0,0 +1,31 @@
+require 'bundler/setup'
+require 'sinatra/base'
+require 'omniauth-translationexchange'
+
+SCOPE = 'email'
+
+class App < Sinatra::Base
+
+  get '/' do
+    redirect '/auth/translationexchange'
+  end
+
+  get '/auth/:provider/callback' do
+    content_type 'application/json'
+    MultiJson.encode(request.env)
+  end
+  
+  get '/auth/failure' do
+    content_type 'application/json'
+    MultiJson.encode(request.env)
+  end
+
+end
+
+use Rack::Session::Cookie
+
+use OmniAuth::Builder do
+  provider :translationexchange, ENV['APP_ID'], ENV['APP_SECRET'], :scope => SCOPE
+end
+
+run App.new

data/lib/omniauth-translationexchange.rb

@@ -0,0 +1,32 @@
+#--
+# Copyright (c) 2017 Translation Exchange, Inc
+#
+#  _______                  _       _   _             ______          _
+# |__   __|                | |     | | (_)           |  ____|        | |
+#    | |_ __ __ _ _ __  ___| | __ _| |_ _  ___  _ __ | |__  __  _____| |__   __ _ _ __   __ _  ___
+#    | | '__/ _` | '_ \/ __| |/ _` | __| |/ _ \| '_ \|  __| \ \/ / __| '_ \ / _` | '_ \ / _` |/ _ \
+#    | | | | (_| | | | \__ \ | (_| | |_| | (_) | | | | |____ >  < (__| | | | (_| | | | | (_| |  __/
+#    |_|_|  \__,_|_| |_|___/_|\__,_|\__|_|\___/|_| |_|______/_/\_\___|_| |_|\__,_|_| |_|\__, |\___|
+#                                                                                        __/ |
+#                                                                                       |___/
+# 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.
+#++
+
+require 'omniauth/translation_exchange'

data/lib/omniauth/strategies/translation_exchange.rb

@@ -0,0 +1,106 @@
+#--
+# Copyright (c) 2017 Translation Exchange, Inc
+#
+#  _______                  _       _   _             ______          _
+# |__   __|                | |     | | (_)           |  ____|        | |
+#    | |_ __ __ _ _ __  ___| | __ _| |_ _  ___  _ __ | |__  __  _____| |__   __ _ _ __   __ _  ___
+#    | | '__/ _` | '_ \/ __| |/ _` | __| |/ _ \| '_ \|  __| \ \/ / __| '_ \ / _` | '_ \ / _` |/ _ \
+#    | | | | (_| | | | \__ \ | (_| | |_| | (_) | | | | |____ >  < (__| | | | (_| | | | | (_| |  __/
+#    |_|_|  \__,_|_| |_|___/_|\__,_|\__|_|\___/|_| |_|______/_/\_\___|_| |_|\__,_|_| |_|\__, |\___|
+#                                                                                        __/ |
+#                                                                                       |___/
+# 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.
+#++
+
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    class TranslationExchange < OmniAuth::Strategies::OAuth2
+
+      # option :client_options, {
+      #   :site           => 'http://localhost:3000',
+      #   :authorize_url  => 'http://localhost:3008/oauth/authorize',
+      #   :token_url      => 'http://localhost:3008/oauth/token'
+      # }
+
+      option :client_options, {
+        :site           => 'https://api.translationexchange.com',
+        :authorize_url  => 'https://gateway.translationexchange.com/oauth/authorize',
+        :token_url      => 'https://gateway.translationexchange.com/oauth/token'
+      }
+
+      option :name, 'translationexchange'
+
+      option :access_token_options, {
+        :header_format => 'OAuth %s',
+        :param_name => 'access_token'
+      }
+
+      option :authorize_options, [:scope, :display]
+
+      uid { raw_info['uuid'] }
+      
+      info do
+        prune!({
+          'id'             => raw_info['uuid'],
+          'display_name'   => raw_info['display_name'],
+          'first_name'     => raw_info['first_name'],
+          'last_name'      => raw_info['last_name'],
+          'email'          => raw_info['email'],
+          'gender'         => raw_info['gender'],
+          'mugshot'        => raw_info['mugshot']
+        })
+      end
+      
+      extra do 
+        { 'user' =>  prune!(raw_info) }
+      end
+      
+      def raw_info
+        @raw_info ||= access_token.get('/v2/users/me').parsed
+      end
+
+      # fix for the 1.4 and doorkeeper
+      def callback_url
+        full_host + script_name + callback_path
+      end
+
+      def authorize_params
+        super.tap do |params|
+          params.merge!(:display => request.params['display']) if request.params['display']
+          params.merge!(:state => request.params['state']) if request.params['state']
+        end
+      end
+
+      private
+
+      def prune!(hash)
+        hash.delete_if do |_, value|
+          prune!(value) if value.is_a?(Hash)
+          value.nil? || (value.respond_to?(:empty?) && value.empty?)
+        end
+      end
+
+    end
+  end
+end
+
+OmniAuth.config.add_camelization 'translationexchange', 'TranslationExchange'

data/lib/omniauth/translation_exchange.rb

@@ -0,0 +1,33 @@
+#--
+# Copyright (c) 2017 Translation Exchange, Inc
+#
+#  _______                  _       _   _             ______          _
+# |__   __|                | |     | | (_)           |  ____|        | |
+#    | |_ __ __ _ _ __  ___| | __ _| |_ _  ___  _ __ | |__  __  _____| |__   __ _ _ __   __ _  ___
+#    | | '__/ _` | '_ \/ __| |/ _` | __| |/ _ \| '_ \|  __| \ \/ / __| '_ \ / _` | '_ \ / _` |/ _ \
+#    | | | | (_| | | | \__ \ | (_| | |_| | (_) | | | | |____ >  < (__| | | | (_| | | | | (_| |  __/
+#    |_|_|  \__,_|_| |_|___/_|\__,_|\__|_|\___/|_| |_|______/_/\_\___|_| |_|\__,_|_| |_|\__, |\___|
+#                                                                                        __/ |
+#                                                                                       |___/
+# 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.
+#++
+
+require 'omniauth/translation_exchange/version'
+require 'omniauth/strategies/translation_exchange'

data/lib/omniauth/translation_exchange/version.rb

@@ -0,0 +1,36 @@
+#--
+# Copyright (c) 2017 Translation Exchange, Inc
+#
+#  _______                  _       _   _             ______          _
+# |__   __|                | |     | | (_)           |  ____|        | |
+#    | |_ __ __ _ _ __  ___| | __ _| |_ _  ___  _ __ | |__  __  _____| |__   __ _ _ __   __ _  ___
+#    | | '__/ _` | '_ \/ __| |/ _` | __| |/ _ \| '_ \|  __| \ \/ / __| '_ \ / _` | '_ \ / _` |/ _ \
+#    | | | | (_| | | | \__ \ | (_| | |_| | (_) | | | | |____ >  < (__| | | | (_| | | | | (_| |  __/
+#    |_|_|  \__,_|_| |_|___/_|\__,_|\__|_|\___/|_| |_|______/_/\_\___|_| |_|\__,_|_| |_|\__, |\___|
+#                                                                                        __/ |
+#                                                                                       |___/
+# 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.
+#++
+
+module OmniAuth
+  module TranslationExchange
+    VERSION = '1.0.0'
+  end
+end

data/omniauth-translationexchange.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'omniauth/translation_exchange/version'
+
+Gem::Specification.new do |s|
+  s.name     = 'omniauth-translationexchange'
+  s.version  = OmniAuth::TranslationExchange::VERSION
+  s.authors  = ['Michael Berkovich']
+  s.email    = ['michael@translationexchange.com']
+  s.summary  = 'Translation Exchange strategy for OmniAuth'
+  s.homepage = 'https://github.com/translationexchange/omniauth-translationexchange'
+  s.description = 'Translation Exchange strategy for SSO using OmniAuth framework'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+  s.licenses    = 'MIT-LICENSE'
+
+  s.add_runtime_dependency 'omniauth-oauth2', '~> 1.3'
+  s.add_development_dependency 'rspec', '~> 2.7'
+  s.add_development_dependency 'rake', '~> 12.0'
+end

data/spec/omniauth/strategies/translation_exchange_spec.rb

@@ -0,0 +1,211 @@
+#--
+# Copyright (c) 2017 Translation Exchange, Inc
+#
+#  _______                  _       _   _             ______          _
+# |__   __|                | |     | | (_)           |  ____|        | |
+#    | |_ __ __ _ _ __  ___| | __ _| |_ _  ___  _ __ | |__  __  _____| |__   __ _ _ __   __ _  ___
+#    | | '__/ _` | '_ \/ __| |/ _` | __| |/ _ \| '_ \|  __| \ \/ / __| '_ \ / _` | '_ \ / _` |/ _ \
+#    | | | | (_| | | | \__ \ | (_| | |_| | (_) | | | | |____ >  < (__| | | | (_| | | | | (_| |  __/
+#    |_|_|  \__,_|_| |_|___/_|\__,_|\__|_|\___/|_| |_|______/_/\_\___|_| |_|\__,_|_| |_|\__, |\___|
+#                                                                                        __/ |
+#                                                                                       |___/
+# 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.
+#++
+
+require 'spec_helper'
+require 'omniauth-translationexchange'
+
+describe OmniAuth::Strategies::TranslationExchange do
+  before :each do
+    @request = double('Request')
+    @request.stub(:params) { {} }
+    @request.stub(:cookies) { {} }
+    
+    @client_id = 'abc'
+    @client_secret = 'def'
+  end
+  
+  subject do
+    args = [@client_id, @client_secret, @options].compact
+    OmniAuth::Strategies::TranslationExchange.new(nil, *args).tap do |strategy|
+      strategy.stub(:request) { @request }
+    end
+  end
+
+  it_should_behave_like 'an oauth2 strategy'
+
+  describe '#client' do
+    it 'has correct site' do
+      subject.client.site.should eq('https://api.translationexchange.com')
+    end
+
+    it 'has correct authorize url' do
+      subject.client.options[:authorize_url].should eq('https://gateway.translationexchange.com/oauth/authorize')
+    end
+
+    it 'has correct token url' do
+      subject.client.options[:token_url].should eq('https://gateway.translationexchange.com/oauth/token')
+    end
+  end
+
+  describe '#authorize_params' do
+    it 'includes display parameter from request when present' do
+      # @request.stub(:params) { { 'display' => 'mobile' } }
+      # subject.authorize_params.should be_a(Hash)
+      # subject.authorize_params[:display].should eq('mobile')
+    end
+
+    it 'includes state parameter from request when present' do
+      # @request.stub(:params) { { 'state' => 'some_state' } }
+      # subject.authorize_params.should be_a(Hash)
+      # subject.authorize_params[:state].should eq('some_state')
+    end
+  end
+  
+  describe '#uid' do
+    before :each do
+      subject.stub(:raw_info) { { 'uuid' => '123' } }
+    end
+    
+    it 'returns the id from raw_info' do
+      subject.uid.should eq('123')
+    end
+  end
+  
+  describe '#info' do
+    before :each do
+      @raw_info ||= { 'first_name' => 'Alex' }
+      subject.stub(:raw_info) { @raw_info }
+    end
+    
+    context 'when optional data is not present in raw info' do
+      it 'has no email key' do
+        subject.info.should_not have_key('email')
+      end
+    
+      it 'has no last name key' do
+        subject.info.should_not have_key('last_name')
+      end
+    end
+    
+    context 'when data is present in raw info' do
+      it 'returns first name' do
+        subject.info['first_name'].should eq('Alex')
+      end
+    
+      it 'returns the email' do
+        @raw_info['email'] = 'fred@smith.com'
+        subject.info['email'].should eq('fred@smith.com')
+      end
+    end
+  end
+  
+  describe '#raw_info' do
+    before :each do
+      @access_token = double('OAuth2::AccessToken')
+      subject.stub(:access_token) { @access_token }
+    end
+    
+    it 'performs a GET to https://api.translationexchange.com/v1/users/me' do
+      @access_token.stub(:get) { double('OAuth2::Response').as_null_object }
+      @access_token.should_receive(:get).with('/v2/users/me')
+      subject.raw_info
+    end
+    
+    it 'returns a Hash' do
+      @access_token.stub(:get).with('/v2/users/me') do
+        raw_response = double('Faraday::Response')
+        raw_response.stub(:body) { '{ "ohai": "thar" }' }
+        raw_response.stub(:status) { 200 }
+        raw_response.stub(:headers) { { 'Content-Type' => 'application/json' } }
+        OAuth2::Response.new(raw_response)
+      end
+      subject.raw_info.should be_a(Hash)
+      subject.raw_info['ohai'].should eq('thar')
+    end
+  end
+
+  describe '#credentials' do
+    before :each do
+      @access_token = double('OAuth2::AccessToken')
+      @access_token.stub(:token)
+      @access_token.stub(:expires?)
+      @access_token.stub(:expires_at)
+      @access_token.stub(:refresh_token)
+      subject.stub(:access_token) { @access_token }
+    end
+    
+    it 'returns a Hash' do
+      subject.credentials.should be_a(Hash)
+    end
+    
+    it 'returns the token' do
+      @access_token.stub(:token) { '123' }
+      subject.credentials['token'].should eq('123')
+    end
+    
+    it 'returns the expiry status' do
+      @access_token.stub(:expires?) { true }
+      subject.credentials['expires'].should eq(true)
+      
+      @access_token.stub(:expires?) { false }
+      subject.credentials['expires'].should eq(false)
+    end
+    
+    it 'returns the refresh token and expiry time when expiring' do
+      ten_mins_from_now = (Time.now + 600).to_i
+      @access_token.stub(:expires?) { true }
+      @access_token.stub(:refresh_token) { '321' }
+      @access_token.stub(:expires_at) { ten_mins_from_now }
+      subject.credentials['refresh_token'].should eq('321')
+      subject.credentials['expires_at'].should eq(ten_mins_from_now)
+    end
+    
+    it 'does not return the refresh token when it is nil and expiring' do
+      @access_token.stub(:expires?) { true }
+      @access_token.stub(:refresh_token) { nil }
+      subject.credentials['refresh_token'].should be_nil
+      subject.credentials.should_not have_key('refresh_token')
+    end
+    
+    it 'does not return the refresh token when not expiring' do
+      @access_token.stub(:expires?) { false }
+      @access_token.stub(:refresh_token) { 'XXX' }
+      subject.credentials['refresh_token'].should be_nil
+      subject.credentials.should_not have_key('refresh_token')
+    end
+  end
+  
+  describe '#extra' do
+    before :each do
+      @raw_info = { 'name' => 'Fred Smith' }
+      subject.stub(:raw_info) { @raw_info }
+    end
+    
+    it 'returns a Hash' do
+      subject.extra.should be_a(Hash)
+    end
+    
+    it 'contains raw info' do
+      subject.extra.should eq({ 'user' => @raw_info })
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,37 @@
+#--
+# Copyright (c) 2017 Translation Exchange, Inc
+#
+#  _______                  _       _   _             ______          _
+# |__   __|                | |     | | (_)           |  ____|        | |
+#    | |_ __ __ _ _ __  ___| | __ _| |_ _  ___  _ __ | |__  __  _____| |__   __ _ _ __   __ _  ___
+#    | | '__/ _` | '_ \/ __| |/ _` | __| |/ _ \| '_ \|  __| \ \/ / __| '_ \ / _` | '_ \ / _` |/ _ \
+#    | | | | (_| | | | \__ \ | (_| | |_| | (_) | | | | |____ >  < (__| | | | (_| | | | | (_| |  __/
+#    |_|_|  \__,_|_| |_|___/_|\__,_|\__|_|\___/|_| |_|______/_/\_\___|_| |_|\__,_|_| |_|\__, |\___|
+#                                                                                        __/ |
+#                                                                                       |___/
+# 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.
+#++
+
+require 'bundler/setup'
+require 'rspec'
+Dir[File.expand_path('../support/**/*', __FILE__)].each { |f| require f }
+
+RSpec.configure do |config|
+end

data/spec/support/shared_examples.rb

@@ -0,0 +1,53 @@
+#--
+# Copyright (c) 2017 Translation Exchange, Inc
+#
+#  _______                  _       _   _             ______          _
+# |__   __|                | |     | | (_)           |  ____|        | |
+#    | |_ __ __ _ _ __  ___| | __ _| |_ _  ___  _ __ | |__  __  _____| |__   __ _ _ __   __ _  ___
+#    | | '__/ _` | '_ \/ __| |/ _` | __| |/ _ \| '_ \|  __| \ \/ / __| '_ \ / _` | '_ \ / _` |/ _ \
+#    | | | | (_| | | | \__ \ | (_| | |_| | (_) | | | | |____ >  < (__| | | | (_| | | | | (_| |  __/
+#    |_|_|  \__,_|_| |_|___/_|\__,_|\__|_|\___/|_| |_|______/_/\_\___|_| |_|\__,_|_| |_|\__, |\___|
+#                                                                                        __/ |
+#                                                                                       |___/
+# 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.
+#++
+
+shared_examples 'an oauth2 strategy' do
+  describe '#client' do
+    it 'should be initialized with symbolized client_options' do
+      @options = { :client_options => { 'authorize_url' => 'https://example.com' } }
+      subject.client.options[:authorize_url].should == 'https://example.com'
+    end
+  end
+
+  describe '#token_params' do
+    it 'should include any authorize params passed in the :authorize_params option' do
+      @options = { :token_params => { :foo => 'bar', :baz => 'zip' } }
+      subject.token_params['foo'].should eq('bar')
+      subject.token_params['baz'].should eq('zip')
+    end
+
+    it 'should include top-level options that are marked as :authorize_options' do
+      @options = { :token_options => [:scope, :foo], :scope => 'bar', :foo => 'baz' }
+      subject.token_params['scope'].should eq('bar')
+      subject.token_params['foo'].should eq('baz')
+    end
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-translationexchange
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Michael Berkovich
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+description: Translation Exchange strategy for SSO using OmniAuth framework
+email:
+- michael@translationexchange.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- deploy
+- example/Gemfile
+- example/Gemfile.lock
+- example/config.ru
+- lib/omniauth-translationexchange.rb
+- lib/omniauth/strategies/translation_exchange.rb
+- lib/omniauth/translation_exchange.rb
+- lib/omniauth/translation_exchange/version.rb
+- omniauth-translationexchange.gemspec
+- spec/omniauth/strategies/translation_exchange_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb
+homepage: https://github.com/translationexchange/omniauth-translationexchange
+licenses:
+- MIT-LICENSE
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Translation Exchange strategy for OmniAuth
+test_files:
+- spec/omniauth/strategies/translation_exchange_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb