omniauth-orcid 1.2.3 → 2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 353af87f1d370baacd6d609e4eca0b5fa388bcdf
-  data.tar.gz: fd04e0e1500d68c43e7c8163f0398b94d076ec48
+  metadata.gz: bdc033017ce0638e8e20fbec70003539d806ec89
+  data.tar.gz: 8dcc4883295d1e26f5d50fcec5a633388f0ca13e
 SHA512:
-  metadata.gz: fb3962e9eb0ef421998b825eaedd9729114cd9577559bf046c7b4da1128a1b706930e50259a126765b53776f2108fb8a17d01c05d6346e673c364b1fe9b24917
-  data.tar.gz: ab041314860086b011f2184bbca5261e4443e3aeaccff6fdcb0075e30f2c1978369adb13139992aed2742c20208eb35d50333e4919afdcf7ecf49d7025df901c
+  metadata.gz: c364fee700aaf0781d9f38a886a9f78121f237033aefaad932a212d42e4953c755070d5e27e79cf380a39c9ce68773ef1139498f80e10cb6b6cfb4a0c103d732
+  data.tar.gz: a74e74f9c6d2522a6cea476b84a73764e05fd06cd08a03aceba3b64b20143eb286d4b26af27d28fb3378b16a1422a76d0df8b67f3a1e61d211cad0d104451867

data/README.md

@@ -59,7 +59,7 @@ use OmniAuth::Builder do
 end
 ```
 
-`omniauth-orcid` sets the appropriate default scope depending on the `member` falg:
+`omniauth-orcid` sets the appropriate default scope depending on the `member` flag:
 
 * non-member: `/authenticate`
 * member: `/read-limited /activities/update /person/update`
@@ -74,7 +74,14 @@ OmniAuth takes care of the OAuth external-authentication handshake or "dance". A
   "uid": "0000-0003-2012-0010",
   "info": {
     "name": "John Smith",
-    "email": null
+    "email": "jsmith@example.com",
+    "first_name": "John",
+    "last_name": "Smith",
+    "location": "GB",
+    "description": "John Smith is the ...",
+    "urls": [
+      { "Blog": "http://blog.martinfenner.org" }
+    ]
   },
   "credentials": {
     "token": "e82938fa-a287-42cf-a2ce-f48ef68c9a35",
@@ -83,13 +90,32 @@ OmniAuth takes care of the OAuth external-authentication handshake or "dance". A
     "expires": true
   },
   "extra": {
+    "raw_info": {
+      "email": "jsmith@example.com",
+      "first_name": "John",
+      "last_name": "Smith",
+      "other_names": ["John Fitzgerald Smith"],
+      "location": "GB",
+      "description": "John Smith is the ...",
+      "urls": [
+        { "Blog": "http://blog.martinfenner.org" }
+      ],
+      "external_identifiers": [
+        { "type": "GitHub",
+          "value":"mfenner",
+          "url": "https://github.com/mfenner" }
+      ]
+    }
   }
 }
 ```
+ject. Martin has a medical degree from the Free University of Berlin and is a Board-certified medical oncologist.", :location=>["DE"], :urls=>["http://blog.martinfenner.org"], :external_identifiers=>[{"type"=>"GitHub", "value"=>"mfenner", "url"=>"https://github.com/mfenner"}]}
+........
+
 
 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 documentation](http://members.orcid.org/api/api-calls) for more details:
+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 [Basic Tutorial: Read data on ORCID record](http://members.orcid.org/api/tutorial/read-orcid-records) for more details.
 
 Here's how to get going with a couple of popular Rack-based frameworks:
 
@@ -133,10 +159,8 @@ ruby demo.rb
 
 ```
 
-
 ### Rails
 
-
 Add this to `config/initializers/omniauth.rb` to configure the strategy:
 
 ```ruby
@@ -168,13 +192,39 @@ class AuthenticationsController < ApplicationController
   end
 ```
 
+Or use `omniauth-orcid` with the [Devise](https://github.com/plataformatec/devise)
+authentication solution.
+
+```ruby
+# in config/initializers/devise.rb
+
+config.omniauth :orcid, ENV['ORCID_CLIENT_ID'],
+                        ENV['ORCID_CLIENT_SECRET'],
+                        member: ENV['ORCID_MEMBER'],
+                        sandbox: ENV['ORCID_SANDBOX']
+```
+
+```ruby
+# in app/models/user.rb
+
+devise :omniauthable, :omniauth_providers => [:orcid]
+```
+
+```ruby
+# in config/routes.rb
+
+Rails.application.routes.draw do
+  devise_for :users, controllers: { omniauth_callbacks: "users/omniauth_callbacks" }
+```
+
+And then add custom logic in `users/omniauth_callbacks`.
+
 ## More information
 
 * [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)
 
-
 ## License
 
 The [MIT License](license.txt) (OSI approved, see more at http://www.opensource.org/licenses/mit-license.php)

data/lib/omniauth/orcid/version.rb

@@ -1,5 +1,5 @@
 module OmniAuth
   module Orcid
-    VERSION = "1.2.3"
+    VERSION = "2.0"
   end
 end

data/lib/omniauth/strategies/orcid.rb

@@ -6,7 +6,7 @@ module OmniAuth
   module Strategies
     class ORCID < OmniAuth::Strategies::OAuth2
 
-      API_VERSION = '1.2'
+      API_VERSION = '2.0'
 
       option :name, "orcid"
 
@@ -20,7 +20,6 @@ module OmniAuth
                                   :given_names,
                                   :family_names,
                                   :email,
-                                  :orcid,
                                   :scope]
 
       args [:client_id, :client_secret]
@@ -37,7 +36,7 @@ module OmniAuth
       # available options at https://members.orcid.org/api/get-oauthauthorize
       def authorize_params
         super.tap do |params|
-          %w[scope redirect_uri show_login lang given_names family_names email orcid].each do |v|
+          %w[scope redirect_uri show_login lang given_names family_names email].each do |v|
             if request.params[v]
               params[v.to_sym] = request.params[v]
             end
@@ -76,9 +75,9 @@ module OmniAuth
 
       def api_base_url
         if options[:sandbox]
-          "http://pub.sandbox.orcid.org/v#{API_VERSION}"
+          "https://pub.sandbox.orcid.org/v#{API_VERSION}"
         else
-          "http://pub.orcid.org/v#{API_VERSION}"
+          "https://pub.orcid.org/v#{API_VERSION}"
         end
       end
 
@@ -109,10 +108,11 @@ module OmniAuth
       uid { access_token.params["orcid"] }
 
       info do
-        { name: raw_info[:name],
+        { name: access_token.params["name"],
           email: raw_info[:email],
           first_name: raw_info[:first_name],
           last_name: raw_info[:last_name],
+          location: raw_info[:location],
           description: raw_info[:description],
           urls: raw_info[:urls]
         }
@@ -123,31 +123,31 @@ module OmniAuth
       end
 
       def request_info
-        client.request(:get, "#{api_base_url}/#{uid}/orcid-bio", headers: { accept: 'application/json' }).parsed || {}
+        @request_info || client.request(:get, "#{api_base_url}/#{uid}/person", headers: { accept: 'application/json' }).parsed || {}
       end
 
       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
+        # retrieve all verified email addresses and include visibility (LIMITED vs. PUBLIC)
+        # and whether this is the primary email address
+        # all other information will in almost all cases be PUBLIC
+        emails = request_info.dig('emails', 'email')
+          .select { |e| e.fetch('verified') }
+          .map { |e| e.select { |k, | %w(email visibility primary).include? k } }
+
+        { first_name: request_info.dig('name', 'given-names', 'value'),
+          last_name: request_info.dig('name', 'family-name', 'value'),
+          other_names: request_info.dig('other-names', 'other-name').map { |o| o.fetch('content') },
+          description: request_info.dig('biography', 'content'),
+          location: request_info.dig('addresses', 'address').map { |a| a.dig('country', 'value') }.first,
+          email: emails.find { |e| e.fetch('primary') }.to_h.fetch('email'),
+          urls: request_info.dig('researcher-urls', 'researcher-url').map do |r|
+            { r.fetch("url-name", nil) => r.dig('url', 'value') }
+          end,
+          external_identifiers: request_info.dig('external-identifiers', 'external-identifier').map do |e|
+            { 'type' => e.fetch('external-id-type', nil),
+              'value' => e.fetch('external-id-value', nil),
+              'url' => e.dig('external-id-url', 'value') }
           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: {},
-          email: email
         }
       end
 

data/omniauth-orcid.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'bundler', '~> 1.0'
   s.add_development_dependency 'rspec', '~> 3.4'
   s.add_development_dependency 'rack-test', '~> 0.6.3'
-  s.add_development_dependency 'webmock', '~> 1.22', '>= 1.22.3'
+  s.add_development_dependency 'webmock', '~> 3.0', '>= 3.0.1'
   s.add_development_dependency 'codeclimate-test-reporter', "~> 1.0.0"
   s.add_development_dependency 'simplecov'
 end

data/spec/fixtures/access_token.json

@@ -0,0 +1,9 @@
+{
+  "name": "Martin Fenner",
+  "access_token": "123",
+  "expires_in": 631138518,
+  "token_type": "bearer",
+  "orcid": "0000-0001-6528-2027",
+  "scope": "/read-limited",
+  "refresh_token": "456"
+}

data/spec/fixtures/request_info.json

@@ -0,0 +1,213 @@
+{
+  "name": {
+    "credit-name": {
+      "value": "Martin Fenner"
+    },
+    "family-name": {
+      "value": "Fenner"
+    },
+    "last-modified-date": {
+      "value": 1500190904445
+    },
+    "created-date": {
+      "value": 1460669194723
+    },
+    "visibility": "PUBLIC",
+    "source": null,
+    "given-names": {
+      "value": "Martin"
+    },
+    "path": "0000-0001-6528-2027"
+  },
+  "last-modified-date": {
+    "value": 1500192622273
+  },
+  "researcher-urls": {
+    "researcher-url": [
+      {
+        "put-code": 42818,
+        "last-modified-date": {
+          "value": 1500192382862
+        },
+        "url": {
+          "value": "http://blog.martinfenner.org"
+        },
+        "created-date": {
+          "value": 1500192382862
+        },
+        "visibility": "PUBLIC",
+        "source": {
+          "source-orcid": {
+            "path": "0000-0001-6528-2027",
+            "host": "sandbox.orcid.org",
+            "uri": "http://sandbox.orcid.org/0000-0001-6528-2027"
+          },
+          "source-name": {
+            "value": "Martin Fenner"
+          },
+          "source-client-id": null
+        },
+        "display-index": 1,
+        "path": "/0000-0001-6528-2027/researcher-urls/42818",
+        "url-name": "Blog"
+      }
+    ],
+    "path": "/0000-0001-6528-2027/researcher-urls",
+    "last-modified-date": {
+      "value": 1500192382862
+    }
+  },
+  "other-names": {
+    "other-name": [
+      {
+        "put-code": 16403,
+        "last-modified-date": {
+          "value": 1500191301536
+        },
+        "created-date": {
+          "value": 1500191301534
+        },
+        "visibility": "PUBLIC",
+        "content": "Martin Hellmut Fenner",
+        "source": {
+          "source-orcid": {
+            "path": "0000-0001-6528-2027",
+            "host": "sandbox.orcid.org",
+            "uri": "http://sandbox.orcid.org/0000-0001-6528-2027"
+          },
+          "source-name": {
+            "value": "Martin Fenner"
+          },
+          "source-client-id": null
+        },
+        "display-index": 1,
+        "path": "/0000-0001-6528-2027/other-names/16403"
+      }
+    ],
+    "path": "/0000-0001-6528-2027/other-names",
+    "last-modified-date": {
+      "value": 1500191301536
+    }
+  },
+  "keywords": {
+    "path": "/0000-0001-6528-2027/keywords",
+    "keyword": [],
+    "last-modified-date": null
+  },
+  "path": "/0000-0001-6528-2027/person",
+  "external-identifiers": {
+    "path": "/0000-0001-6528-2027/external-identifiers",
+    "external-identifier": [
+      {
+        "external-id-value": "mfenner",
+        "put-code": 3882,
+        "last-modified-date": {
+          "value": 1499800792190
+        },
+        "external-id-relationship": "SELF",
+        "created-date": {
+          "value": 1499800792189
+        },
+        "external-id-type": "GitHub",
+        "source": {
+          "source-orcid": null,
+          "source-name": {
+            "value": "DataCite/ORCID Claim Tool"
+          },
+          "source-client-id": {
+            "path": "APP-127VAQ5PMV9OKM9F",
+            "host": "sandbox.orcid.org",
+            "uri": "http://sandbox.orcid.org/client/APP-127VAQ5PMV9OKM9F"
+          }
+        },
+        "visibility": "PUBLIC",
+        "display-index": 0,
+        "path": "/0000-0001-6528-2027/external-identifiers/3882",
+        "external-id-url": {
+          "value": "https://github.com/mfenner"
+        }
+      }
+    ],
+    "last-modified-date": {
+      "value": 1499800792190
+    }
+  },
+  "emails": {
+    "path": "/0000-0001-6528-2027/email",
+    "email": [
+      {
+        "put-code": null,
+        "verified": true,
+        "last-modified-date": {
+          "value": 1438058214424
+        },
+        "created-date": {
+          "value": 1438058214424
+        },
+        "visibility": "LIMITED",
+        "primary": true,
+        "source": {
+          "source-orcid": {
+            "path": "0000-0001-6528-2027",
+            "host": "sandbox.orcid.org",
+            "uri": "http://sandbox.orcid.org/0000-0001-6528-2027"
+          },
+          "source-name": {
+            "value": "Martin Fenner"
+          },
+          "source-client-id": null
+        },
+        "path": null,
+        "email": "martin.fenner@datacite.org"
+      }
+    ],
+    "last-modified-date": {
+      "value": 1438058214424
+    }
+  },
+  "biography": {
+    "content": "Martin Fenner is the DataCite Technical Director and manages the technical architecture for Datacite as well as DataCite\u2019s technical contributions for the EU-funded THOR project. From 2012 to 2015 he was the technical lead for the PLOS Article-Level Metrics project. Martin has a medical degree from the Free University of Berlin and is a Board-certified medical oncologist.",
+    "path": "/0000-0001-6528-2027/biography",
+    "created-date": {
+      "value": 1460669194724
+    },
+    "visibility": "PUBLIC",
+    "last-modified-date": {
+      "value": 1500206408067
+    }
+  },
+  "addresses": {
+    "path": "/0000-0001-6528-2027/address",
+    "address": [
+      {
+        "put-code": 4809,
+        "last-modified-date": {
+          "value": 1500192622273
+        },
+        "country": {
+          "value": "DE"
+        },
+        "created-date": {
+          "value": 1500192622273
+        },
+        "visibility": "PUBLIC",
+        "source": {
+          "source-orcid": {
+            "path": "0000-0001-6528-2027",
+            "host": "sandbox.orcid.org",
+            "uri": "http://sandbox.orcid.org/0000-0001-6528-2027"
+          },
+          "source-name": {
+            "value": "Martin Fenner"
+          },
+          "source-client-id": null
+        },
+        "display-index": 1,
+        "path": "/0000-0001-6528-2027/address/4809"
+      }
+    ],
+    "last-modified-date": {
+      "value": 1500192622273
+    }
+  }
+}

data/spec/omniauth/strategies/orcid_spec.rb

@@ -47,7 +47,7 @@ describe OmniAuth::Strategies::ORCID do
       end
 
       it 'should have correct base url' do
-        expect(subject.options.client_options.api_base_url).to eq('http://pub.orcid.org/v1.2')
+        expect(subject.options.client_options.api_base_url).to eq('https://pub.orcid.org/v2.0')
       end
     end
 
@@ -73,7 +73,7 @@ describe OmniAuth::Strategies::ORCID do
       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")
+        expect(subject.options.client_options.api_base_url).to eq("https://pub.sandbox.orcid.org/v2.0")
       end
     end
 
@@ -176,26 +176,90 @@ describe OmniAuth::Strategies::ORCID do
     end
   end
 
-  describe 'extra' do
-    describe 'raw_info' do
-      context 'when skip_info is true' do
-        before { subject.options[:skip_info] = true }
+  context 'info' do
+    let(:params) { JSON.parse(IO.read(fixture_path + 'access_token.json')) }
+    let(:access_token) { OpenStruct.new("params" => params) }
+    let(:request_info) { JSON.parse(IO.read(fixture_path + 'request_info.json')) }
 
-        it 'should not include raw_info' do
-          expect(subject.extra).not_to have_key(:raw_info)
-        end
-      end
+    before do
+      allow(subject).to receive(:access_token).and_return(access_token)
+      allow(subject).to receive(:request_info).and_return(request_info)
+    end
+
+    it 'should return name' do
+      expect(subject.info[:name]).to eq('Martin Fenner')
+    end
+
+    it 'should return first_name' do
+      expect(subject.info[:first_name]).to eq('Martin')
+    end
+
+    it 'should return last_name' do
+      expect(subject.info[:last_name]).to eq('Fenner')
+    end
+
+    it 'should return description' do
+      expect(subject.info[:description]).to start_with('Martin Fenner is the DataCite Technical Director')
+    end
+
+    it 'should return location' do
+      expect(subject.info[:location]).to eq("DE")
+    end
+
+    it 'should return email' do
+      expect(subject.info[:email]).to eq( "martin.fenner@datacite.org")
+    end
+
+    it 'should return urls' do
+      expect(subject.info[:urls]).to eq([{"Blog"=>"http://blog.martinfenner.org"}])
+    end
+  end
+
+  context 'raw_info' do
+    let(:params) { JSON.parse(IO.read(fixture_path + 'access_token.json')) }
+    let(:access_token) { OpenStruct.new("params" => params) }
+    let(:request_info) { JSON.parse(IO.read(fixture_path + 'request_info.json')) }
 
-      # context 'when skip_info is false' do
-      #   before { subject.options[:skip_info] = false }
+    before do
+      allow(subject).to receive(:access_token).and_return(access_token)
+      allow(subject).to receive(:request_info).and_return(request_info)
+    end
+
+    it 'should not include raw_info' do
+      subject.options[:skip_info] = true
+      expect(subject.extra).not_to have_key(:raw_info)
+    end
+
+    it 'should return first_name' do
+      expect(subject.extra.dig(:raw_info, :first_name)).to eq('Martin')
+    end
+
+    it 'should return last_name' do
+      expect(subject.extra.dig(:raw_info, :last_name)).to eq('Fenner')
+    end
+
+    it 'should return other_names' do
+      expect(subject.extra.dig(:raw_info, :other_names)).to eq(["Martin Hellmut Fenner"])
+    end
+
+    it 'should return description' do
+      expect(subject.extra.dig(:raw_info, :description)).to start_with('Martin Fenner is the DataCite Technical Director')
+    end
+
+    it 'should return location' do
+      expect(subject.extra.dig(:raw_info, :location)).to eq("DE")
+    end
+
+    it 'should return email' do
+      expect(subject.extra.dig(:raw_info, :email)).to eq( "martin.fenner@datacite.org")
+    end
+
+    it 'should return urls' do
+      expect(subject.extra.dig(:raw_info, :urls)).to eq([{"Blog"=>"http://blog.martinfenner.org"}])
+    end
 
-      #   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
+    it 'should return external_identifiers' do
+      expect(subject.extra.dig(:raw_info, :external_identifiers)).to eq([{"type"=>"GitHub", "value"=>"mfenner", "url"=>"https://github.com/mfenner"}])
     end
   end
 end

data/spec/spec_helper.rb

@@ -11,6 +11,10 @@ require 'webmock/rspec'
 require 'omniauth'
 require 'omniauth-orcid'
 
+def fixture_path
+  File.expand_path("../fixtures", __FILE__) + '/'
+end
+
 RSpec.configure do |config|
   config.include WebMock::API
   config.include Rack::Test::Methods

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-orcid
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: '2.0'
 platform: ruby
 authors:
 - Gudmundur A. Thorisson
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-05 00:00:00.000000000 Z
+date: 2017-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth-oauth2
@@ -73,20 +73,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.22'
+        version: '3.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.22.3
+        version: 3.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.22'
+        version: '3.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.22.3
+        version: 3.0.1
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
@@ -138,6 +138,8 @@ files:
 - lib/omniauth/orcid/version.rb
 - lib/omniauth/strategies/orcid.rb
 - omniauth-orcid.gemspec
+- spec/fixtures/access_token.json
+- spec/fixtures/request_info.json
 - spec/omniauth/strategies/orcid_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/datacite/omniauth-orcid