omniauth-myheritage 1.0.0

data/Gemfile

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

data/README.md

@@ -0,0 +1,72 @@
+# OmniAuth MyHeritage
+
+MyHeritage OAuth2 Strategy for OmniAuth 1.0.
+
+Supports the OAuth 2.0 server-side. Read the MyHeritage docs for more details: http://www.familygraph.com/documentation/authentication
+
+## Installing
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'omniauth-myheritage'
+```
+
+Then `bundle install`.
+
+## Usage
+
+`OmniAuth::Strategies::MyHeritage` 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 :myheritage, ENV['MY_HERITAGE_KEY'], ENV['MY_HERITAGE_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 MyHeritage docs for a full list of available permissions. Default: `email`.
+
+For example, to request `email` permission:
+ 
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :myheritage, ENV['MY_HERITAGE_KEY'], ENV['MY_HERITAGE_SECRET'], :scope => 'email'
+end
+```
+
+## Authentication Hash
+
+Here's an example *Authentication Hash* available in `request.env['omniauth.auth']`:
+
+```ruby
+{
+  :provider => 'myheritage',
+  :uid => '123',
+  :info => {
+    :first_name => 'Alex',
+    :last_name => 'Thompson',
+    :email => 'alex@sample.com',
+    :name => 'Alex Thompson'
+  },
+  :credentials => {
+    :token => 'ABCDEF...',      # OAuth 2.0 access_token
+    :expires_at => 1321747205   # when the access token expires
+  },
+  :extra => {
+    :profile => {
+      :id => '1234567',
+      :name => 'Alex Thompson',
+      :first_name => 'Alex',
+      :last_name => 'Thompson'
+    }
+  }
+}
+```
+
+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/example/Gemfile

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

data/example/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: ../
+  specs:
+    omniauth-myheritage (1.0.0)
+      omniauth-oauth2 (~> 1.0.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    faraday (0.8.7)
+      multipart-post (~> 1.1)
+    hashie (2.0.5)
+    httpauth (0.2.0)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    multi_json (1.7.3)
+    multipart-post (1.2.0)
+    oauth2 (0.8.1)
+      faraday (~> 0.8)
+      httpauth (~> 0.1)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      rack (~> 1.2)
+    omniauth (1.1.4)
+      hashie (>= 1.2, < 3)
+      rack
+    omniauth-oauth2 (1.0.3)
+      oauth2 (~> 0.8.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-myheritage!
+  rack (~> 1.3.6)
+  sinatra

data/example/config.ru

@@ -0,0 +1,31 @@
+require 'bundler/setup'
+require 'sinatra/base'
+require 'omniauth-myheritage'
+
+SCOPE = 'email'
+
+class App < Sinatra::Base
+
+  get '/' do
+    redirect '/auth/myheritage'
+  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 :myheritage, ENV['APP_ID'], ENV['APP_SECRET'], :scope => SCOPE
+end
+
+run App.new

data/lib/omniauth-myheritage.rb

@@ -0,0 +1 @@
+require 'omniauth/my_heritage'

data/lib/omniauth/my_heritage.rb

@@ -0,0 +1,2 @@
+require 'omniauth/my_heritage/version'
+require 'omniauth/strategies/my_heritage'

data/lib/omniauth/my_heritage/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module MyHeritage
+    VERSION = "1.0.0"
+  end
+end

data/lib/omniauth/strategies/my_heritage.rb

@@ -0,0 +1,85 @@
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    class MyHeritage < OmniAuth::Strategies::OAuth2
+
+      option :client_options, {
+        :site => 'https://accounts.myheritage.com',
+        :authorize_url => '/oauth2/authorize',
+        :token_url => '/oauth2/token'
+      }
+
+      option :authorize_params, {
+        
+      }
+
+      option :name, 'myheritage'
+
+      option :access_token_options, {
+        :header_format => 'Bearer %s',
+        :param_name => 'bearer_token'
+      }
+      
+      option :authorize_options, [:scope]
+
+      def request_phase
+        super
+      end
+
+      def build_access_token
+        token_params = {
+          :code => request.params['code'],
+          :redirect_uri => callback_url,
+          :client_id => client.id,
+          :client_secret => client.secret,
+          :grant_type => 'authorization_code'
+        }
+        client.get_token(token_params)
+      end
+      
+      uid { raw_info['id'] }
+      
+      info do
+        prune!({
+          'id'             => raw_info['id'],
+          'email'          => raw_info['email'],
+          'name'           => raw_info['name'],
+          'first_name'     => raw_info['first_name'],
+          'last_name'      => raw_info['last_name'],
+          'gender'         => raw_info['gender'],
+          'birthday'       => raw_info['birth_date'],
+          'link'           => raw_info['link'],
+          'locale'         => raw_info['preferred_display_language']
+        })
+      end
+      
+      extra do 
+        { 'profile' =>  prune!(raw_info) }
+      end
+      
+      def raw_info
+        @raw_info ||= access_token.get('https://familygraph.myheritage.com/me').parsed
+      end
+
+      def authorize_params
+        super.tap do |params|
+          params.merge!(:state => request.params['state']) if request.params['state']
+          params[:scope] ||= 'email'
+        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 'myheritage', 'MyHeritage'

data/omniauth-myheritage.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'omniauth/my_heritage/version'
+
+Gem::Specification.new do |s|
+  s.name     = 'omniauth-myheritage'
+  s.version  = OmniAuth::MyHeritage::VERSION
+  s.authors  = ['Michael Berkovich']
+  s.email    = ['theiceberk@gmail.com']
+  s.summary  = 'MyHeritage strategy for OmniAuth'
+  s.homepage = 'https://github.com/geni/omniauth-myheritage'
+
+  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.add_runtime_dependency 'omniauth-oauth2', '~> 1.0.0'
+
+  s.add_development_dependency 'rspec', '~> 2.7.0'
+  s.add_development_dependency 'rake'
+end

data/spec/omniauth/strategies/myheritage_spec.rb

@@ -0,0 +1,174 @@
+require 'spec_helper'
+require 'omniauth-myheritage'
+
+describe OmniAuth::Strategies::MyHeritage 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::MyHeritage.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://accounts.myheritage.com')
+    end
+
+    it 'has correct authorize url' do
+      subject.client.options[:authorize_url].should eq('/oauth/authorize')
+    end
+
+    it 'has correct token url' do
+      subject.client.options[:token_url].should eq('/oauth/token')
+    end
+  end
+
+  describe '#authorize_params' do
+    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) { { 'id' => '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://familygraph.myheritage.com/me' do
+      @access_token.stub(:get) { double('OAuth2::Response').as_null_object }
+      @access_token.should_receive(:get).with('/api/profile')
+      subject.raw_info
+    end
+    
+    it 'returns a Hash' do
+      @access_token.stub(:get).with('/api/profile') 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({ 'profile' => @raw_info })
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+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,37 @@
+# NOTE it would be useful if this lived in omniauth-oauth2 eventually
+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 '#authorize_params' do
+    it 'should include any authorize params passed in the :authorize_params option' do
+      @options = { :authorize_params => { :foo => 'bar', :baz => 'zip' } }
+      subject.authorize_params['foo'].should eq('bar')
+      subject.authorize_params['baz'].should eq('zip')
+    end
+
+    it 'should include top-level options that are marked as :authorize_options' do
+      @options = { :authorize_options => [:scope, :foo], :scope => 'bar', :foo => 'baz' }
+      subject.authorize_params['scope'].should eq('bar')
+      subject.authorize_params['foo'].should eq('baz')
+    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,110 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-myheritage
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Michael Berkovich
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- theiceberk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- Rakefile
+- example/Gemfile
+- example/Gemfile.lock
+- example/config.ru
+- lib/omniauth-myheritage.rb
+- lib/omniauth/my_heritage.rb
+- lib/omniauth/my_heritage/version.rb
+- lib/omniauth/strategies/my_heritage.rb
+- omniauth-myheritage.gemspec
+- spec/omniauth/strategies/myheritage_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb
+homepage: https://github.com/geni/omniauth-myheritage
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: MyHeritage strategy for OmniAuth
+test_files:
+- spec/omniauth/strategies/myheritage_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb