omniauth-orcid 1.1.7 → 1.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZDM0Mjc1OTBjZWY4ZjgxOTU4ODJmNTRlOTdiZmE0ZTAwMzU0MmIxNw==
+    ODMzNWYwZWQyZTQ0MmZmZTk3MGRlNzhjNzU3ZTM3NDA4NzI0ODZjMw==
   data.tar.gz: !binary |-
-    NTIxOGI3OWRhMGYwMzFkZDgyZDljYWIzYjYzNjA1YzgwZmQ4MGU2MQ==
+    OGQzOTVkYmY4OWFhZjllY2VmZGY2MWY3NzFlMjMwN2RkOGI2NDQwOA==
 SHA512:
   metadata.gz: !binary |-
-    YjRjMjFmNDFiNmQ2OTQ5ZDY2YzlkNzRmOWY3ZDVhZWVmNzlhN2UyMGRkMDdl
-    ZDE4ZjI5Y2QwZDY2NmIzYzYyYjBlNWY4ZDk0OWM1OGEwY2Y3NjFiYzViMzAx
-    MDk3MDQ1OWFkODgyZDI3MGVjZmViNjIxNmQ4OGVjODNmZDdmYzU=
+    ZjQzZjkyZmVlNmQzZGRjODcwYjI3MWE1MjhhZmJmMzBmZGMyMGZhOWMwMjZi
+    YjRmYzM1MzViMThmODQyNGQ0MjRmYThlYzE4ZjJmNTY2MTVhMjFjOTcwYTUy
+    ZWFlZjYwMzZmMmZiY2IzNjY2Mjk4ZjYzNzUzZGVjYmY0ZmVlY2E=
   data.tar.gz: !binary |-
-    ZTQyOGRiNjAwY2Y1ZTM2NGJmZWUxZTU3NmE4YmQ1MmUzOWVjMGQ4ZmU0NTM1
-    MmMxNTE4YWQ4YWY2Mjg4NDNmNmI1MzMzOGUwMDhjZmUxZDJiNTg5MTMyMWQ0
-    YjRmMDA4MTNiMjJhYTMzMjc0NWYzN2Q1M2Y1MzNjNTZiMWQ5OTE=
+    YjdiN2E0MWJhMzRmYTM2MzFmMzBjOGI4YzcyNjJiNmRiZWU5YzZjYmJiNGQw
+    Y2M4MzVhNTE0OTRlMzM5YzdmYTJhMzc2Mjg1OGNjYTM3NWJiYTk5MmQ0ZGNi
+    ZjE4ZmY3MDkxYThkY2RiZTM5ZTg1MGNkNGIyZjJlZjM4ZTAxNGE=

data/README.md

@@ -1,5 +1,6 @@
 # OmniAuth ORCID
 
+[![Gem Version](https://badge.fury.io/rb/omniauth-orcid.svg)](https://badge.fury.io/rb/omniauth-orcid)
 [![Build Status](https://travis-ci.org/datacite/omniauth-orcid.svg?branch=master)](https://travis-ci.org/datacite/omniauth-orcid)
 [![DOI](https://zenodo.org/badge/15088/datacite/omniauth-orcid.svg)](https://zenodo.org/badge/latestdoi/15088/datacite/omniauth-orcid)
 

data/lib/omniauth/orcid/version.rb

@@ -1,5 +1,5 @@
 module OmniAuth
   module Orcid
-    VERSION = "1.1.7"
+    VERSION = "1.2"
   end
 end

data/lib/omniauth/strategies/orcid.rb

@@ -6,7 +6,6 @@ module OmniAuth
   module Strategies
     class ORCID < OmniAuth::Strategies::OAuth2
 
-      DEFAULT_SCOPE = '/orcid-profile/read-limited /orcid-works/create'
       API_VERSION = '1.2'
 
       option :name, "orcid"
@@ -15,7 +14,13 @@ module OmniAuth
       option :sandbox, false
       option :provider_ignores_state, true
 
-      option :authorize_options, [:redirect_uri, :show_login]
+      option :authorize_options, [:redirect_uri,
+                                  :show_login,
+                                  :lang,
+                                  :given_names,
+                                  :family_names,
+                                  :email,
+                                  :orcid]
 
       args [:client_id, :client_secret]
 
@@ -29,15 +34,17 @@ module OmniAuth
         @options.client_options.scope         = scope
       end
 
+      # available options at https://members.orcid.org/api/get-oauthauthorize
       def authorize_params
         super.tap do |params|
-          %w[scope redirect_uri show_login lang].each do |v|
-            if request.params[v]
-              params[v.to_sym] = request.params[v]
-            end
+          options[:authorize_options].each do |k|
+            params[k] = request.params[k.to_s] unless [nil, ''].include?(request.params[k.to_s])
           end
 
-          params[:show_login] ||= 'true'
+          # show login form and not registration form by default
+          params[:show_login] = 'true' if params[:show_login].nil?
+
+          session['omniauth.state'] = params[:state] if params['state']
         end
       end
 
@@ -90,7 +97,7 @@ module OmniAuth
 
       def scope
         if options[:member]
-          '/orcid-profile/read-limited /orcid-works/create /orcid-bio/external-identifiers/create /affiliations/create /funding/create'
+          '/read-limited /activities/update /orcid-bio/update'
         else
           '/authenticate'
         end
@@ -100,7 +107,7 @@ module OmniAuth
 
       info do
         { name: raw_info[:name],
-          email: nil,
+          email: raw_info[:email],
           first_name: raw_info[:first_name],
           last_name: raw_info[:last_name],
           description: raw_info[:description],
@@ -119,12 +126,25 @@ module OmniAuth
       def raw_info
         orcid_bio = request_info.fetch('orcid-profile', nil).to_h.fetch('orcid-bio', {})
 
+        emails = orcid_bio.fetch('contact-details', nil).to_h.fetch('email', nil)
+        email = nil
+
+        if emails.is_a? Array
+          emails.each do |e|
+            next unless e['visibility'] == "PUBLIC"
+            next unless e['verified']
+            email = e['value']
+            break
+          end
+        end
+
         { name: orcid_bio.fetch('personal-details', nil).to_h.fetch('credit-name', nil).to_h.fetch('value', nil),
           first_name: orcid_bio.fetch('personal-details', nil).to_h.fetch('given-names', nil).to_h.fetch('value', nil),
           last_name: orcid_bio.fetch('personal-details', nil).to_h.fetch('family-name', nil).to_h.fetch('value', nil),
           other_names: orcid_bio.fetch('personal-details', nil).to_h.fetch('other-names', nil).to_h.fetch('other-name', [{}]).map { |other_name| other_name.fetch('value', nil) },
           description: orcid_bio.fetch('biography', nil).to_h.fetch('value', nil),
-          urls: {}
+          urls: {},
+          email: email
         }
       end
 

data/spec/omniauth/strategies/orcid_spec.rb

@@ -1,75 +1,189 @@
 require 'spec_helper'
 
 describe OmniAuth::Strategies::ORCID do
-  subject { OmniAuth::Strategies::ORCID.new({}) }
+  let(:request) { double('Request', :params => {}, :cookies => {}, :env => {}) }
+  let(:app) {
+    lambda do
+      [200, {}, ["Hello."]]
+    end
+  }
+
+  subject do
+    OmniAuth::Strategies::ORCID.new(app, 'client_id', 'client_secret', @options || {}).tap do |strategy|
+      allow(strategy).to receive(:request) {
+        request
+      }
+    end
+  end
+
+  before do
+    OmniAuth.config.test_mode = true
+  end
+
+  after do
+    OmniAuth.config.test_mode = false
+  end
 
-  describe 'client options' do
+  context 'client options' do
     it 'should have correct name' do
       expect(subject.options.name).to eq('orcid')
     end
 
-    it 'should have correct site' do
-      expect(subject.options.client_options.site).to eq('http://pub.orcid.org')
-    end
+    describe "default" do
+      it 'should have correct site' do
+        expect(subject.options.client_options.site).to eq('http://pub.orcid.org')
+      end
 
-    it 'should have correct authorize url' do
-      expect(subject.options.client_options.authorize_url).to eq('https://orcid.org/oauth/authorize')
-    end
+      it 'should have correct scope' do
+        expect(subject.options.client_options.scope).to eq('/authenticate')
+      end
 
-    it 'should have correct base url' do
-      expect(subject.options.client_options.api_base_url).to eq('http://pub.orcid.org/v1.2')
-    end
+      it 'should have correct token url' do
+        expect(subject.options.client_options.token_url).to eq("https://pub.orcid.org/oauth/token")
+      end
 
-    it 'should have correct scope' do
-      expect(subject.options.client_options.scope).to eq('/authenticate')
-    end
-  end
+      it 'should have correct authorize url' do
+        expect(subject.options.client_options.authorize_url).to eq('https://orcid.org/oauth/authorize')
+      end
 
-  describe 'uid' do
-    before do
-      allow(subject).to receive(:request_info).and_return(request_info_hash)
+      it 'should have correct base url' do
+        expect(subject.options.client_options.api_base_url).to eq('http://pub.orcid.org/v1.2')
+      end
     end
 
-    # it 'should return the uid' do
-    #   expect(subject.uid).to eq(1)
-    # end
-  end
+    describe "sandbox" do
+      before do
+        @options = { sandbox: true }
+      end
+
+      it 'should have correct site' do
+        expect(subject.options.client_options.site).to eq("http://pub.sandbox.orcid.org")
+      end
+
+      it 'should have correct scope' do
+        expect(subject.options.client_options.scope).to eq("/authenticate")
+      end
 
-  describe 'info' do
-    before do
-      allow(subject).to receive(:request_info).and_return(request_info_hash)
+      it 'should have correct token url' do
+        expect(subject.options.client_options.token_url).to eq("https://pub.sandbox.orcid.org/oauth/token")
+      end
+
+      it 'should have correct authorize url' do
+        expect(subject.options.client_options.authorize_url).to eq("https://sandbox.orcid.org/oauth/authorize")
+      end
+
+      it 'should have correct base url' do
+        expect(subject.options.client_options.api_base_url).to eq("http://pub.sandbox.orcid.org/v1.2")
+      end
     end
 
-    it 'should return name' do
-      expect(subject.info[:name]).to eq("Martin Fenner")
+    describe "member" do
+      before do
+        @options = { member: true }
+      end
+
+      it 'should have correct site' do
+        expect(subject.options.client_options.site).to eq('http://api.orcid.org')
+      end
+
+      it 'should have correct scope' do
+        expect(subject.options.client_options.scope).to eq('/read-limited /activities/update /orcid-bio/update')
+      end
+
+      it 'should have correct token url' do
+        expect(subject.options.client_options.token_url).to eq("https://api.orcid.org/oauth/token")
+      end
     end
 
-    it 'should return first_name' do
-      expect(subject.info[:first_name]).to eq("Martin")
+    describe "member sandbox" do
+      before do
+        @options = { member: true, sandbox: true }
+      end
+
+      it 'should have correct site' do
+        expect(subject.options.client_options.site).to eq("http://api.sandbox.orcid.org")
+      end
+
+      it 'should have correct scope' do
+        expect(subject.options.client_options.scope).to eq('/read-limited /activities/update /orcid-bio/update')
+      end
+
+      it 'should have correct token url' do
+        expect(subject.options.client_options.token_url).to eq("https://api.sandbox.orcid.org/oauth/token")
+      end
     end
 
-    it 'should return last_name' do
-      expect(subject.info[:last_name]).to eq("Fenner")
+    describe "redirect_uri" do
+      it 'should default to nil' do
+        @options = {}
+        expect(subject.authorize_params['redirect_uri']).to be_nil
+      end
+
+      it 'should set the redirect_uri parameter if present' do
+        @options = { redirect_uri: 'https://example.com' }
+        expect(subject.authorize_params['redirect_uri']).to eq('https://example.com')
+      end
     end
 
-    it 'should return description' do
-      expect(subject.info[:description]).to eq("Martin Fenner is the DataCite Technical Director and manages the technical architecture for Datacite as well as DataCite’s technical contributions for the EU-funded THOR project.. From 2012 to 2015 he was technical lead for the PLOS Article-Level Metrics project. He served on the Board of the Open Researcher and Contributor ID (ORCID) initiative from 2010-2012, and worked for ORCID EU in the EC-funded ODIN project from 2012 to 2013. Martin has a medical degree from the Free University of Berlin and is a Board-certified medical oncologist.")
+    describe "show_login" do
+      it 'should default to true' do
+        @options = {}
+        expect(subject.authorize_params['show_login']).to eq("true")
+      end
+
+      it 'should set the show_login parameter if present' do
+        @options = { show_login: "false" }
+        expect(subject.authorize_params['show_login']).to eq("false")
+      end
     end
-  end
 
-  describe 'raw_info' do
-    before do
-      allow(subject).to receive(:request_info).and_return(request_info_hash)
+    describe "lang" do
+      it 'should default to nil' do
+        @options = {}
+        expect(subject.authorize_params['lang']).to be_nil
+      end
+
+      it 'should set the lang parameter if present' do
+        @options = { lang: 'es' }
+        expect(subject.authorize_params['lang']).to eq("es")
+      end
     end
 
-    it 'should return other_names' do
-      expect(subject.raw_info[:other_names]).to eq([" Martin Hellmut Fenner", "M Fenner", "MH Fenner", "Martin H. Fenner"])
+    describe "names and email" do
+      it 'should default to nil' do
+        @options = {}
+        expect(subject.authorize_params['given_names']).to be_nil
+      end
+
+      it 'should set the names and email parameters if present' do
+        @options = { given_names: "Josiah", family_names: "Carberry", email: "josiah@brown.edu" }
+        expect(subject.authorize_params["given_names"]).to eq("Josiah")
+        expect(subject.authorize_params["family_names"]).to eq("Carberry")
+        expect(subject.authorize_params["email"]).to eq("josiah@brown.edu")
+      end
     end
   end
-end
-
-private
 
-def request_info_hash
-  { 'message-version' => '1.2', 'orcid-profile' => { 'orcid' => nil, 'orcid-id' => nil, 'orcid-identifier' => { 'value' => nil, 'uri' => 'http://orcid.org/0000-0003-1419-2405', 'path' => '0000-0003-1419-2405', 'host' => 'orcid.org' }, 'orcid-deprecated' => nil, 'orcid-preferences' => { 'locale' => 'EN' }, 'orcid-history' => { 'creation-method' => 'WEBSITE', 'completion-date' => { 'value' => 1_349_732_964_340 }, 'submission-date' => { 'value' => 1_349_729_360_270 }, 'last-modified-date' => { 'value' => 1_446_719_619_721 }, 'claimed' => { 'value' => true }, 'source' => nil, 'deactivation-date' => nil, 'verified-email' => { 'value' => true }, 'verified-primary-email' => { 'value' => true }, 'visibility' => nil }, 'orcid-bio' => { 'personal-details' => { 'given-names' => { 'value' => 'Martin' }, 'family-name' => { 'value' => 'Fenner' }, 'credit-name' => { 'value' => 'Martin Fenner', 'visibility' => 'PUBLIC' }, 'other-names' => { 'other-name' => [{ 'value' => ' Martin Hellmut Fenner' }, { 'value' => 'M Fenner' }, { 'value' => 'MH Fenner' }, { 'value' => 'Martin H. Fenner' }], 'visibility' => 'PUBLIC' } }, 'biography' => { 'value' => 'Martin Fenner is the DataCite Technical Director and manages the technical architecture for Datacite as well as DataCite’s technical contributions for the EU-funded THOR project.. From 2012 to 2015 he was technical lead for the PLOS Article-Level Metrics project. He served on the Board of the Open Researcher and Contributor ID (ORCID) initiative from 2010-2012, and worked for ORCID EU in the EC-funded ODIN project from 2012 to 2013. Martin has a medical degree from the Free University of Berlin and is a Board-certified medical oncologist.', 'visibility' => 'PUBLIC' }, 'researcher-urls' => { 'researcher-url' => [{ 'url-name' => { 'value' => 'Blog' }, 'url' => { 'value' => 'http://blog.martinfenner.org' } }, { 'url-name' => { 'value' => 'Twitter' }, 'url' => { 'value' => 'http://twitter.com/mfenner' } }, { 'url-name' => { 'value' => 'My SciENCV' }, 'url' => { 'value' => 'http://www.ncbi.nlm.nih.gov/myncbi/mfenner/cv/1413/' } }], 'visibility' => 'PUBLIC' }, 'contact-details' => { 'email' => [], 'address' => { 'country' => { 'value' => 'DE', 'visibility' => 'PUBLIC' } } }, 'keywords' => nil, 'external-identifiers' => { 'external-identifier' => [{ 'orcid' => nil, 'external-id-orcid' => nil, 'external-id-common-name' => { 'value' => 'ISNI' }, 'external-id-reference' => { 'value' => '000000035060549X' }, 'external-id-url' => { 'value' => 'http://isni.org/000000035060549X' }, 'external-id-source' => nil, 'source' => { 'source-orcid' => { 'value' => nil, 'uri' => 'http://orcid.org/0000-0003-0412-1857', 'path' => '0000-0003-0412-1857', 'host' => 'orcid.org' }, 'source-client-id' => nil, 'source-name' => nil, 'source-date' => nil } }, { 'orcid' => nil, 'external-id-orcid' => nil, 'external-id-common-name' => { 'value' => 'Scopus Author ID' }, 'external-id-reference' => { 'value' => '7006600825' }, 'external-id-url' => { 'value' => 'http://www.scopus.com/inward/authorDetails.url?authorID=7006600825&partnerID=MN8TOARS' }, 'external-id-source' => nil, 'source' => { 'source-orcid' => { 'value' => nil, 'uri' => 'http://orcid.org/0000-0002-5982-8983', 'path' => '0000-0002-5982-8983', 'host' => 'orcid.org' }, 'source-client-id' => nil, 'source-name' => nil, 'source-date' => nil } }], 'visibility' => 'PUBLIC' }, 'delegation' => nil, 'scope' => nil }, 'orcid-activities' => nil, 'orcid-internal' => nil, 'type' => 'USER', 'group-type' => nil, 'client-type' => nil }, 'orcid-search-results' => nil, 'error-desc' => nil }
+  describe 'extra' do
+    describe 'raw_info' do
+      context 'when skip_info is true' do
+        before { subject.options[:skip_info] = true }
+
+        it 'should not include raw_info' do
+          expect(subject.extra).not_to have_key(:raw_info)
+        end
+      end
+
+      # context 'when skip_info is false' do
+      #   before { subject.options[:skip_info] = false }
+
+      #   it 'should include raw_info' do
+      #     stub_request(:get, "http://pub.orcid.org/v1.2/0000-0002-1825-0097/orcid-bio").
+      #       with(:headers => { 'Accept'=>'application/json' }).
+      #       to_return(:status => 200, :body => "", :headers => {})
+      #     expect(subject.extra[:raw_info]).to eq('sub' => '12345')
+      #   end
+      # end
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,7 @@
-$:.unshift File.expand_path('..', __FILE__)
-$:.unshift File.expand_path('../../lib', __FILE__)
+require 'bundler/setup'
+Bundler.setup
+
+require 'omniauth-orcid'
 require 'rspec'
 require 'rack/test'
 require 'webmock/rspec'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-orcid
 version: !ruby/object:Gem::Version
-  version: 1.1.7
+  version: '1.2'
 platform: ruby
 authors:
 - Gudmundur A. Thorisson
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-11 00:00:00.000000000 Z
+date: 2016-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth-oauth2