omniauth-orcid 0.3 → 0.4

data/Gemfile

@@ -0,0 +1,10 @@
+source :rubygems
+
+# Specify your gem's dependencies in omniauth-github.gemspec
+gemspec
+
+
+
+# These are development dependencies 
+gem "rake"
+#gem "rspec", "2.0.0.beta.8"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License
+
+Copyright (C) 2012, Gudmundur A. Thorisson
+
+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

@@ -2,12 +2,148 @@
 
 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).
+
 Originally created for the [ORCID example client application in Rails](https://github.com/gthorisson/ORCID-example-client-app-rails), then turned into a gem.
 
-*Note: the gem comes configured to connected to the [ORCID sandbox service](http://devsandbox.orcid.org). Please update the parameters in ```:client_options``` to  connect to the live service when it launches (see http://dev.orcid.org/launch)*
 
 
-*...stuff coming, patience plz....*
+## Installation
+
+The usual way with Bundler: add the following to your `Gemfile` to install the current version of the gem:
+
+```ruby
+gem 'omniauth-orcid'
+```
+
+Or, if you're impatient, you can install straight from GitHub
+
+```ruby
+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:
+
+```bash
+[mummi@nfmac07]gem install omniauth-orcid
+```
+
+## Getting started
+
+Like other OmniAuth strategies, `OmniAuth::Strategies::ORCID` is a piece of Rack middleware. Please read the OmniAuth documentation for detailed instructions: https://github.com/intridea/omniauth.
+
+
+By default the module connects to the live ORCID service. In the very simplest usage, all you have to provide are your client app credentials ([see more here](http://support.orcid.org/knowledgebase/articles/116739)):
+
+```ruby
+use OmniAuth::Builder do
+  provider :orcid, ENV['ORCID_KEY'], ENV['ORCID_SECRET']
+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:
+
+
+### Sinatra
+
+
+Configure the strategy and implement a callback routine in your app:
+
+```ruby
+require 'sinatra'
+require 'sinatra/config_file'
+require 'omniauth-orcid'
+enable :sessions
+
+use OmniAuth::Builder do
+  provider :orcid, ENV['ORCID_KEY'], ENV['ORCID_SECRET']
+end
+...
+get '/auth/orcid/callback' do
+  session[:omniauth] = request.env['omniauth.auth']
+  redirect '/'
+end
+
+get '/' do
+  
+  if session[:omniauth]
+    @orcid = session[:omniauth][:uid]
+  end
+  ..
+```
+
+The bundled `demo.rb` file contains an uber-simple working Sinatra example app. Spin it up, point your browser to http://localhost:4567/ and play:
+
+```bash
+gem install sinatra
+ruby demo.rb
+[2012-11-26 21:41:08] INFO  WEBrick 1.3.1
+[2012-11-26 21:41:08] INFO  ruby 1.9.3 (2012-04-20) [x86_64-darwin11.3.0]
+== Sinatra/1.3.2 has taken the stage on 4567 for development with backup from WEBrick
+[2012-11-26 21:41:08] INFO  WEBrick::HTTPServer#start: pid=8383 port=4567
+
+```
+
+
+### Rails 
+
+
+Add this to `config/initializers/omniauth.rb` to configure the strategy:
+
+```ruby
+require 'omniauth-orcid'
+
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :orcid, ENV['ORCID_KEY'], ENV['ORCID_SECRET']
+end
+```
+
+Register a callback path in 'config/routes.rb'
+
+```ruby
+..
+  match '/auth/:provider/callback' => 'authentications#create'
+..
+```
+
+Implement a callback handler method in a controller:
+
+```ruby
+class AuthenticationsController < ApplicationController
+  ..
+  def create
+    omniauth = request.env["omniauth.auth"]
+    session[:omniauth] = omniauth
+    session[:params]   = params
+    ..
+  end
+```
+
+
+
+## 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`:
+
+```ruby
+config_file 'config.yml'
+use OmniAuth::Builder do
+  provider :orcid, settings.client_id, settings.client_secret, 
+  :client_options => {
+    :site => settings.site, 
+    :authorize_url => settings.authorize_url,
+    :token_url => settings.token_url
+  }
+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
+
 
 
 ## More information 

data/config.yml

@@ -0,0 +1,15 @@
+# Default endpoint URLs for the ORCID OAuth API
+
+production:
+  site: https://api.orcid.org
+  authorize_url: https://orcid.org/oauth/authorize
+  token_url: https://api.orcid.org/oauth/token
+  client_id: 
+  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

data/demo.rb

@@ -0,0 +1,78 @@
+# ORCID example client application in Sinatra.
+# Modelled after this app: https://github.com/zuzara/jQuery-OAuth-Popup
+
+require 'rubygems'
+require 'sinatra'
+require 'sinatra/config_file'
+require 'haml'
+require 'omniauth-orcid'
+require 'json'
+
+enable :sessions
+use Rack::Session::Cookie
+
+config_file 'config.yml'
+if development?
+  puts "Sinatra running in development mode"
+elsif production?
+  puts "Sinatra running in production mode"  
+end
+
+puts "Connecting to ORCID API at " + settings.site + " as client app #{settings.client_id}"
+
+# Configure the ORCID strategy
+use OmniAuth::Builder do
+  provider :orcid, settings.client_id, settings.client_secret, 
+  :client_options => {
+    :site => settings.site, 
+    :authorize_url => settings.authorize_url,
+    :token_url => settings.token_url
+  }
+end
+
+
+get '/' do
+
+  @orcid = ''
+  
+  if session[:omniauth]
+    @orcid = session[:omniauth][:uid]
+  end
+  haml <<-HTML
+%html
+  %head
+    %title ORCID OmniAuth demo app
+  %body
+    - if session[:omniauth]
+      %p
+        Signed in with ORCiD <b>#{@orcid}</b>
+      %p
+        %a(href="/user_info")fetch user info as JSON
+      %p
+        %a(href="/signout") sign out 
+    - else
+      %p
+        %a(href="/auth/orcid") Log in with my ORCiD
+  HTML
+end
+
+
+get '/user_info' do
+  content_type :json
+  session[:omniauth].to_json
+end
+
+
+get '/auth/orcid/callback' do
+  puts "Adding OmniAuth user info to session: " +  request.env['omniauth.auth'].inspect
+  session[:omniauth] = request.env['omniauth.auth']
+  redirect '/'
+end
+
+get '/signout' do
+  session.clear
+  redirect '/'
+end
+
+
+__END__

data/lib/omniauth/strategies/orcid.rb

@@ -6,13 +6,13 @@ module OmniAuth
   module Strategies
     class ORCID < OmniAuth::Strategies::OAuth2
 
-      DEFAULT_SCOPE = '/orcid-bio/read-limited'      
+      DEFAULT_SCOPE = '/orcid-bio/read-limited'
 
       option :client_options, {
-        :site => 'http://api.devsandbox.orcid.org',
-        :authorize_url => 'http://devsandbox.orcid.org/oauth/authorize',
+        :site => 'http://api.orcid.org',
+        :authorize_url => 'http://orcid.org/oauth/authorize',
         :token_url => 'http://api.devsandbox.orcid.org/oauth/token',
-        :scope => '/orcid-profile/read-limited',
+        :scope => 'http://api.orcid.org/oauth/token',
         :response_type => 'code',
         :mode => :header
       }
@@ -30,7 +30,6 @@ module OmniAuth
         super.tap do |params|
           %w[scope].each { |v| params[v.to_sym] = request.params[v] if request.params[v] }
           params[:scope] ||= DEFAULT_SCOPE # ensure that we're always request *some* default scope
-          Rails.logger.debug "Customizing authz params:  " + params.inspect
         end
       end
     end

data/lib/omniauth-orcid/version.rb

@@ -1,5 +1,5 @@
 module OmniAuth
   module ORCID
-    VERSION = "0.3"
+    VERSION = "0.4"
   end
 end

data/omniauth-orcid.gemspec

@@ -0,0 +1,22 @@
+require File.expand_path("../lib/omniauth-orcid/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.authors       = ["Gudmundur A. Thorisson"]
+  s.email         = %q{gthorisson@gmail.com}
+  s.name          = "omniauth-orcid"
+  s.homepage      = %q{https://github.com/gthorisson/omniauth-orcid}
+  s.summary       = %q{ORCID OAuth 2.0 Strategy for OmniAuth 1.0}
+  s.date          = Date.today
+  s.description   = %q{Enables third-party client apps to connect to the ORCID API and access/update protected profile data }
+  s.files         = Dir["{lib}/**/*.rb", "bin/*", "LICENSE.txt", "*.md", "Rakefile", "Gemfile", "demo.rb", "config.yml", "omniauth-orcid.gemspec"]
+  s.require_paths = ["lib"]
+  s.version       = OmniAuth::ORCID::VERSION
+  s.extra_rdoc_files = ["README.md"]
+
+
+  # Declary dependencies here, rather than in the Gemfile
+  s.add_dependency 'omniauth', '~> 1.0'
+  s.add_dependency 'omniauth-oauth2', '~> 1.1'
+
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-orcid
 version: !ruby/object:Gem::Version
-  version: '0.3'
+  version: '0.4'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-06 00:00:00.000000000 Z
+date: 2012-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth
@@ -44,7 +44,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.1'
 description: ! 'Enables third-party client apps to connect to the ORCID API and access/update
-  protected profiledata '
+  protected profile data '
 email: gthorisson@gmail.com
 executables: []
 extensions: []
@@ -54,8 +54,13 @@ files:
 - lib/omniauth/strategies/orcid.rb
 - lib/omniauth-orcid/version.rb
 - lib/omniauth-orcid.rb
+- LICENSE.txt
 - README.md
 - Rakefile
+- Gemfile
+- demo.rb
+- config.yml
+- omniauth-orcid.gemspec
 homepage: https://github.com/gthorisson/omniauth-orcid
 licenses: []
 post_install_message: