omniauth-familysearch 1.0.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.rvmrc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in omniauth-familysearch-identity.gemspec
+gemspec
+
+group :development, :test do
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'guard-bundler'
+  gem 'rb-fsevent'
+  gem 'terminal-notifier-guard'
+end

data/Guardfile

@@ -0,0 +1,10 @@
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+
+guard 'bundler' do
+  watch('Gemfile')
+  watch('omniauth-github.gemspec')
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Richard Hill
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,79 @@
+# Omniauth FamilySearch
+
+OmniAuth strategy for FamilySearch OAuth2 API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'omniauth-familysearch'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install omniauth-familysearch
+
+## Usage
+
+```ruby
+use OmniAuth::Builder do
+  provider :familysearch, ENV['FAMILYSEARCH_DEVELOPER_KEY'], ''
+end
+
+# To use the sandbox API
+use Omniauth::Builder do
+  provider :familysearch, ENV['FAMILYSEARCH_DEVELOPER_KEY'], '',
+    :client_options => { :site => 'https://sandbox.familysearch.org' }
+end
+```
+
+## Auth Hash
+
+Here's an example Auth Hash available in `request.env['omniauth.auth']`:
+
+```ruby
+{
+  "provider" => "familysearch",
+  "uid" => "MMMM-QY4Y",
+  "info" => {
+    "name" => "John Doe",
+    "email" => "jdoe@example.com"
+  },
+  "credentials" => {
+    "token" => "56421fc9ac",
+    "secret" => "6f532ad1bb"
+  },
+  "extra" => {
+    "access_token" => "56421fc9ac",
+    "raw_info" => {
+      "users" => [
+        {
+          "id" => "MMMM-QY4Y",
+          "contactName" => "John Doe",
+          "email" => "jdoe@example.com",
+          "links" => {
+            "self" => {
+              "href" => "https://sandbox.familysearch.org/platform/users/current?access_token=abc123"
+            }
+          }
+        }
+      ]
+    }
+  }
+}
+```
+
+## FamilySearch OAuth 2 Docs
+
+https://familysearch.org/developers/docs/oauth2
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'

data/lib/omniauth-familysearch.rb

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

data/lib/omniauth-familysearch/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module FamilySearch
+    VERSION = '1.0.0'
+  end
+end

data/lib/omniauth/strategies/familysearch.rb

@@ -0,0 +1,56 @@
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    class FamilySearch < OmniAuth::Strategies::OAuth2
+      option :client_options, {
+        :site => 'https://api.familysearch.org',
+        :authorize_url => '/cis-web/oauth2/v3/authorization',
+        :token_url => '/cis-web/oauth2/v3/token'
+      }
+
+      def request_phase
+        super
+      end
+
+      def authorize_params
+        super
+      end
+
+      uid { user_info['id'] }
+
+      info do
+        {
+          :name => user_name,
+          :email => user_email
+        }
+      end
+
+      extra do
+        { :raw_info => raw_info }
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get('/platform/users/current',
+                                       :headers => { 'Accept' => 'application/x-fs-v1+json' },
+                                       :parse => :json
+                                      ).parsed
+      end
+
+      def user_info
+        @user_info ||= raw_info['users'] ? raw_info['users'].first : {}
+      end
+
+      def user_name
+        user_info['contactName']
+      end
+
+      def user_email
+        user_info['email']
+      end
+
+    end
+  end
+end
+
+OmniAuth.config.add_camelization 'familysearch', 'FamilySearch'

data/omniauth-familysearch.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/omniauth-familysearch/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ['Richard Hill']
+  gem.email         = ['xrkhill@gmail.com']
+  gem.description   = %q{OmniAuth strategy for FamilySearch OAuth2 API}
+  gem.summary       = %q{OmniAuth strategy for FamilySearch OAuth2 API}
+  gem.homepage      = 'https://github.com/xrkhill/omniauth-familysearch'
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = 'omniauth-familysearch'
+  gem.require_paths = ['lib']
+  gem.version       = OmniAuth::FamilySearch::VERSION
+
+  gem.add_runtime_dependency('multi_json')
+  gem.add_runtime_dependency('omniauth-oauth2', '~> 1.0')
+
+  gem.add_development_dependency 'rspec', '~> 2.7'
+  gem.add_development_dependency 'rack-test'
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'webmock'
+end

data/spec/omniauth/strategies/familysearch_spec.rb

@@ -0,0 +1,132 @@
+require 'spec_helper'
+
+describe OmniAuth::Strategies::FamilySearch do
+  let(:access_token) { stub('AccessToken', :options => {}) }
+  let(:parsed_response) { stub('ParsedResponse') }
+  let(:response) { stub('Response', :parsed => parsed_response) }
+
+  let(:sandbox_site)          { 'https://sandbox.familysearch.org' }
+  let(:sandbox_authorize_url) { 'https://sandbox.familysearch.org/cis-web/oauth2/v3/authorization' }
+  let(:sandbox_token_url)     { 'https://sandbox.familysearch.org/cis-web/oauth2/v3/token' }
+  let(:sandbox) do
+    OmniAuth::Strategies::FamilySearch.new('FAMILYSEARCH_DEVELOPER_KEY', '',
+        {
+            :client_options => {
+                :site => sandbox_site,
+                :authorize_url => sandbox_authorize_url,
+                :token_url => sandbox_token_url
+            }
+        }
+    )
+  end
+
+  subject do
+    OmniAuth::Strategies::FamilySearch.new({})
+  end
+
+  before(:each) do
+    subject.stub!(:access_token).and_return(access_token)
+  end
+
+  context 'client options' do
+    it 'should have correct site' do
+      subject.options.client_options.site.should eq('https://api.familysearch.org')
+    end
+
+    it 'should have correct authorize url' do
+      subject.options.client_options.authorize_url.should eq('/cis-web/oauth2/v3/authorization')
+    end
+
+    it 'should have correct token url' do
+      subject.options.client_options.token_url.should eq('/cis-web/oauth2/v3/token')
+    end
+
+    describe 'should be overrideable' do
+      it 'for site' do
+        sandbox.options.client_options.site.should eq(sandbox_site)
+      end
+
+      it 'for authorize url' do
+        sandbox.options.client_options.authorize_url.should eq(sandbox_authorize_url)
+      end
+
+      it 'for token url' do
+        sandbox.options.client_options.token_url.should eq(sandbox_token_url)
+      end
+    end
+  end
+
+  context 'uid' do
+    it 'should return uid from user info if available' do
+      subject.stub!(:raw_info).and_return({ 'users' => [{ 'id' => 'MMDZ-85L' }] })
+      subject.uid.should eq('MMDZ-85L')
+    end
+
+    it 'should return nil if there is no raw_info' do
+      subject.stub!(:raw_info).and_return({})
+      subject.uid.should be_nil
+    end
+  end
+
+  context 'info' do
+    before(:each) do
+      subject.stub!(:raw_info).and_return({})
+    end
+
+    it 'should include name key' do
+      subject.info.should have_key(:name)
+    end
+
+    it 'should include email key' do
+      subject.info.should have_key(:email)
+    end
+  end
+
+  context 'extra' do
+    it 'should ' do
+      subject.stub!(:raw_info).and_return({})
+      subject.extra.should have_key(:raw_info)
+    end
+  end
+
+  context '#raw_info' do
+    it 'should use relative path' do
+      path = '/platform/users/current'
+      opts = { :headers => { 'Accept' => 'application/x-fs-v1+json' }, :parse => :json }
+      access_token.should_receive(:get).with(path, opts).and_return(response)
+      subject.raw_info.should eq(parsed_response)
+    end
+  end
+
+  context '#user_info' do
+    it 'should return first hash from users array' do
+      subject.stub!(:raw_info).and_return({ 'users' => [{ 'first' => 'user' }] })
+      subject.user_info.should eq({ 'first' => 'user' })
+    end
+  end
+
+  context '#user_name' do
+    it 'should return email from raw_info if available' do
+      subject.stub!(:raw_info).and_return({ 'users' => [{ 'contactName' => 'John Doe' }] })
+      subject.user_name.should eq('John Doe')
+    end
+
+    it 'should return nil if there is no raw_info' do
+      subject.stub!(:raw_info).and_return({})
+      subject.user_name.should be_nil
+    end
+  end
+
+  context '#user_email' do
+    it 'should return email from raw_info if available' do
+      subject.stub!(:raw_info).and_return({ 'users' => [{ 'email' => 'name@example.com' }] })
+      subject.user_email.should eq('name@example.com')
+    end
+
+    it 'should return nil if there is no raw_info' do
+      subject.stub!(:raw_info).and_return({})
+      subject.user_email.should be_nil
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+$:.unshift File.expand_path('..', __FILE__)
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'simplecov'
+SimpleCov.start
+require 'rspec'
+require 'rack/test'
+require 'webmock/rspec'
+require 'omniauth'
+require 'omniauth-familysearch'
+
+RSpec.configure do |config|
+  config.include WebMock::API
+  config.include Rack::Test::Methods
+  config.extend  OmniAuth::Test::StrategyMacros, :type => :strategy
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification 
+name: omniauth-familysearch
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Richard Hill
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-02-25 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: multi_json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: omniauth-oauth2
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 2
+        - 7
+        version: "2.7"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rack-test
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: simplecov
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+description: OmniAuth strategy for FamilySearch OAuth2 API
+email: 
+- xrkhill@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/omniauth-familysearch.rb
+- lib/omniauth-familysearch/version.rb
+- lib/omniauth/strategies/familysearch.rb
+- omniauth-familysearch.gemspec
+- spec/omniauth/strategies/familysearch_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/xrkhill/omniauth-familysearch
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: OmniAuth strategy for FamilySearch OAuth2 API
+test_files: 
+- spec/omniauth/strategies/familysearch_spec.rb
+- spec/spec_helper.rb