omniauth-orcid 0.5 → 0.6

data/Gemfile

@@ -3,7 +3,7 @@ source :rubygems
 # Specify your gem's dependencies in omniauth-github.gemspec
 gemspec
 
-
+gem "omniauth-oauth2"
 
 # These are development dependencies 
 gem "rake"

data/README.md

@@ -2,7 +2,7 @@
 
 ORCID OAuth 2.0 Strategy for the wonderful [OmniAuth Ruby authentication framework](http://www.omniauth.org).
 
-Provides basic support for connecting a client application to the [Open Researcher & Contributor ID registry service](http://about.orcid.org).
+Provides basic support for connecting a client application to the [Open Researcher & Contributor ID registry service](http://orcid.org).
 
 Originally created for the [ORCID example client application in Rails](https://github.com/gthorisson/ORCID-example-client-app-rails), then turned into a gem.
 
@@ -24,7 +24,7 @@ gem 'omniauth-orcid' , :git => 'git://github.com/gthorisson/omniauth-orcid.git'
 
 Then run `bundle install` to install into your environment.
 
-You can also install the gem system-wide:
+You can also install the gem system-wide in the usual way:
 
 ```bash
 [mummi@nfmac07]gem install omniauth-orcid
@@ -43,7 +43,34 @@ use OmniAuth::Builder do
 end
 ```
 
-You also have to implement a callback handler to grab user data after the OAuth handshake has been completed, and then do something cool with those data. Here's how to get going with a couple of popular Rack-based frameworks:
+OmniAuth takes care of the OAuth external-authentication handshake or "dance". All that the gem does is grab the identifier and tokens at the end of the dance and stick it into the OmniAuth hash which is subsequently accessible to your app via `request.env['omniauth.auth']` (see [AuthHashSchema](https://github.com/intridea/omniauth/wiki/Auth-Hash-Schema)). The hash looks something like this:
+
+```json
+{
+  provider: "orcid",
+  uid: "0000-0003-2012-0010",
+  info: {
+  name: null
+},
+credentials: {
+  token: "e82938fa-a287-42cf-a2ce-f48ef68c9a35",
+  refresh_token: "f94c58dd-b452-44f4-8863-0bf8486a0071",
+  expires_at: 1979903874,
+  expires: true
+},
+extra: { }
+}
+```
+
+You have to implement a callback handler to grab at least the `uid` from the hash and (typically) save it in a session. This effectively provides basic "Log in with your ORCiD" functionality.
+
+Most likely, with the token in hand, you'll want to do something more sophisticated with the API, like retrieving profile data and do something cool with it. See the API guide for more details:
+
+http://support.orcid.org/knowledgebase/articles/116874-orcid-api-guide
+
+
+
+Here's how to get going with a couple of popular Rack-based frameworks:
 
 
 ### Sinatra
@@ -122,15 +149,21 @@ class AuthenticationsController < ApplicationController
 ```
 
 
-
 ## Configuration
 
-You can also grab parameters from a config file (recommended) and pass to the strategy via the `:client_options` hash. Here's an example from the bundled Sinatra app in `demo.rb`:
+You can also grab parameters from a config file (recommended) and pass
+to the strategy, along with other options specific to your app. The OAuth scope or
+scopes in particular frequently need to be customized. Here's an example from the bundled Sinatra app in `demo.rb`:
+
+*UPDATE The [omniauth-oauth2 gem](https://github.com/intridea/omniauth-oauth2)  was recently been updated to process options slightly differently. The `:scope` string must now be passed in via  `:authorize_params`, see below*
 
 ```ruby
 config_file 'config.yml'
 use OmniAuth::Builder do
   provider :orcid, settings.client_id, settings.client_secret, 
+    :authorize_params => {
+      :scope => '/orcid-profile/read-limited'
+    },
   :client_options => {
     :site => settings.site, 
     :authorize_url => settings.authorize_url,
@@ -142,14 +175,15 @@ end
 
 Different sets of params from `config.yml` are used for production environment (points to live ORCID service) vs. development environment (points to ORCID sandbox service).
 
-You can d something similar with in Rails with the same config file, or something . See a working example here: https://github.com/gthorisson/ORCID-example-client-app-rails
+You can do something similar with in Rails with the same config file, or something . See a working example here: https://github.com/gthorisson/ORCID-example-client-app-rails
 
 
 
 ## More information 
 
-ORCID Developer Portal - http://dev.orcid.org
-
+ORCID Open Source Project - https://github.com/ORCID/ORCID-Source
+Developer Wiki - https://github.com/ORCID/ORCID-Source/wiki
+Technical community - http://orcid.org/about/community/orcid-technical-community
 
 
 

data/config.yml

@@ -8,8 +8,8 @@ production:
   client_secret: 
 
 development:
-  site: http://api.devsandbox.orcid.org
-  authorize_url: http://devsandbox.orcid.org/oauth/authorize
-  token_url: http://api.devsandbox.orcid.org/oauth/token
-  client_id: 0000-0002-7649-0259
-  client_secret: 5a81472f-d318-4823-887a-ea64ac6f680a
+  site: http://api.sandbox-1.orcid.org
+  authorize_url: http://sandbox-1.orcid.org/oauth/authorize
+  token_url: http://api.sandbox-1.orcid.org/oauth/token
+  client_id: 0000-0002-8831-0104
+  client_secret: 7fb56071-0c68-4d42-af00-5a52804ae645

data/demo.rb

@@ -1,4 +1,5 @@
 # ORCID example client application in Sinatra.
+#
 # Modelled after this app: https://github.com/zuzara/jQuery-OAuth-Popup
 
 require 'rubygems'
@@ -6,6 +7,7 @@ require 'sinatra'
 require 'sinatra/config_file'
 require 'haml'
 require 'omniauth-orcid'
+require 'oauth2'
 require 'json'
 
 enable :sessions
@@ -31,6 +33,8 @@ use OmniAuth::Builder do
 end
 
 
+
+
 get '/' do
 
   @orcid = ''
@@ -46,10 +50,11 @@ get '/' do
     - if session[:omniauth]
       %p
         Signed in with ORCiD <b>#{@orcid}</b>
+        %a(href="/signout") sign out
       %p
-        %a(href="/user_info")fetch user info as JSON
+        %a(href="/user_info")Show OmniAuth user data as JSON
       %p
-        %a(href="/signout") sign out 
+        %a(href="/orcid_profile")Connect to ORCID API to fetch full profile data as JSON
     - else
       %p
         %a(href="/auth/orcid") Log in with my ORCiD
@@ -69,10 +74,17 @@ get '/auth/orcid/callback' do
   redirect '/'
 end
 
+get '/orcid_profile' do
+  client = OAuth2::Client.new settings.client_id,settings.client_secret, :site  => settings.site
+  atoken = OAuth2::AccessToken.new client, session[:omniauth]['credentials']['token']
+  response = atoken.get "/#{session[:omniauth]['uid']}/orcid-profile", :headers => {'Accept' => 'application/json'}
+  response.body
+end
+
+
 get '/signout' do
   session.clear
   redirect '/'
 end
 
 
-__END__

data/lib/omniauth-orcid/version.rb

@@ -1,5 +1,5 @@
 module OmniAuth
   module ORCID
-    VERSION = "0.5"
+    VERSION = "0.6"
   end
 end

data/omniauth-orcid.gemspec

@@ -1,3 +1,4 @@
+require "date"
 require File.expand_path("../lib/omniauth-orcid/version", __FILE__)
 
 Gem::Specification.new do |s|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-orcid
 version: !ruby/object:Gem::Version
-  version: '0.5'
+  version: '0.6'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-28 00:00:00.000000000 Z
+date: 2013-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth
@@ -81,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: ORCID OAuth 2.0 Strategy for OmniAuth 1.0