omniauth-familysearch-identity 1.0.0

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in omniauth-familysearch-identity.gemspec
+gemspec

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,98 @@
+# Omniauth FamilySearchIdentity
+
+OmniAuth strategy for FamilySearch Identity v2 API (OAuth 1.0a)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'omniauth-familysearch-identity'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install omniauth-familysearch-identity
+
+## Usage
+
+```ruby
+use OmniAuth::Builder do
+  provider :familysearch_identity, ENV['FAMILYSEARCH_DEVELOPER_KEY'], ''
+end
+```
+
+## Auth Hash
+
+Here's an example Auth Hash available in `request.env['omniauth.auth']`:
+
+```ruby
+{
+  "provider" => "familysearch_identity",
+  "uid" => "jdoe",
+  "info" => {
+    "name" => "John Doe",
+    "email" => "jdoe@example.com",
+    "nickname" => "jdoe",
+    "first_name" => "John",
+    "last_name" => "Doe"
+  },
+  "credentials" => {
+    "token" => "56421fc9ac",
+    "secret" => "6f532ad1bb"
+  },
+  "extra" => {
+    "access_token" => "56421fc9ac",
+    "raw_info" => {
+      "users" => [
+        "id" => "MMMM-QY4Y",
+        "username" => "jdoe",
+        "emails" => [
+          {
+            "type" => "Primary",
+            "value" => "noreply@ldschurch.org"
+          },
+          {
+            "type" => "Alternate",
+            "value" => nil
+          }
+        ],
+        "names" => [
+          {
+            "type" => "Display",
+            "value" => "John Doe"
+          },
+          {
+            "type" => "Family",
+            "value" => "Doe"
+          },
+          {
+            "type" => "Given",
+            "value" => "John"
+          }
+        ],
+        "preferences" => [
+          {
+            "name" => "language",
+            "value" => "en"
+          }
+        ]
+      ]
+    }
+  }
+}
+```
+
+## FamilySearch Identity v2 Docs
+
+https://familysearch.org/developers/docs/identity-v2
+
+## 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-identity.rb

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

data/lib/omniauth-familysearch-identity/version.rb

@@ -0,0 +1,5 @@
+module Omniauth
+  module Familysearch
+    VERSION = '1.0.0'
+  end
+end

data/lib/omniauth/strategies/familysearch_identity.rb

@@ -0,0 +1,100 @@
+require 'omniauth-oauth'
+require 'oauth/signature/plaintext'
+
+module OmniAuth
+  module Strategies
+    class FamilySearchIdentity < OmniAuth::Strategies::OAuth
+
+      option :name, 'familysearch_identity'
+
+      # This is where you pass the options you would pass when
+      # initializing your consumer from the OAuth gem.
+      option :client_options, {
+	:signature_method => 'PLAINTEXT',
+	:scheme => :query_string,
+	:http_method => :get,
+	:site => 'https://sandbox.familysearch.org',
+	:request_token_path => '/identity/v2/request_token',
+	:access_token_path => '/identity/v2/access_token',
+	:authorize_path => '/identity/v2/authorize'
+      }
+
+      def request_phase
+	super
+      end
+
+      def authorize_params
+	super
+      end
+
+      # These are called after authentication has succeeded. If
+      # possible, you should try to set the UID without making
+      # additional calls (if the user id is returned with the token
+      # or as a URI parameter). This may not be possible with all
+      # providers.
+      uid { info[:nickname] }
+
+      info do
+	{
+	  :name => user_name,
+	  :email => user_email,
+	  :nickname => user_info['username'],
+	  :first_name => user_first_name,
+	  :last_name => user_last_name
+	}
+      end
+
+      extra do
+	{ :raw_info => raw_info }
+      end
+
+      def raw_info
+	request = "/identity/v2/user?sessionId=#{access_token.token}&dataFormat=application/json"
+	@raw_info ||= MultiJson.decode(access_token.get(request).body)
+      rescue ::Errno::ETIMEDOUT
+	raise ::Timeout::Error
+      end
+
+      private
+
+      def user_info
+	raw_info['users'].first
+      end
+
+      def user_email
+	email = user_info['emails'].find { |email| email['type'] == 'Primary' }
+
+	unless email.nil?
+	  email['value']
+	end
+      end
+
+      def user_name
+	user_names['Display']
+      end
+
+      def user_first_name
+	user_names['Given']
+      end
+
+      def user_last_name
+	user_names['Family']
+      end
+
+      def user_names
+	@user_names ||= begin
+			  hash = {}
+
+			  user_info['names'].each do |name|
+			    hash[name['type']] = name['value']
+			  end
+
+			  hash
+			end
+      end
+
+    end
+  end
+end
+
+OmniAuth.config.add_camelization 'familysearch_identity', 'FamilySearchIdentity'

data/omniauth-familysearch-identity.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/omniauth-familysearch-identity/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ['Richard Hill']
+  gem.email         = ['xrkhill@gmail.com']
+  gem.description   = %q{OmniAuth strategy for FamilySearch Identity v2 API (OAuth 1.0a)}
+  gem.summary       = %q{OmniAuth strategy for FamilySearch Identity v2 API (OAuth 1.0a)}
+  gem.homepage      = 'https://github.com/xrkhill/omniauth-familysearch-identity'
+
+  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-identity'
+  gem.require_paths = ['lib']
+  gem.version       = Omniauth::Familysearch::VERSION
+
+  gem.add_runtime_dependency('multi_json')
+  gem.add_runtime_dependency('omniauth-oauth', '~> 1.0')
+
+  gem.add_development_dependency('rspec', '~> 2.6')
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification 
+name: omniauth-familysearch-identity
+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-01-01 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-oauth
+  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: 15
+        segments: 
+        - 2
+        - 6
+        version: "2.6"
+  type: :development
+  version_requirements: *id003
+description: OmniAuth strategy for FamilySearch Identity v2 API (OAuth 1.0a)
+email: 
+- xrkhill@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/omniauth-familysearch-identity.rb
+- lib/omniauth-familysearch-identity/version.rb
+- lib/omniauth/strategies/familysearch_identity.rb
+- omniauth-familysearch-identity.gemspec
+homepage: https://github.com/xrkhill/omniauth-familysearch-identity
+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 Identity v2 API (OAuth 1.0a)
+test_files: []
+