omniauth-orcid 1.0.14 → 1.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d595a7dc573239619f732c49f1fc5a2598810340
-  data.tar.gz: 285b0f1eb4cd046f50fcd45fb9058142b422be7d
+  metadata.gz: dd6c27587a6e2d2720b024c7a31f5c6b76fc806a
+  data.tar.gz: a1bb1aa9e3bc2968318ea4ecdb759ca639a0078c
 SHA512:
-  metadata.gz: b9dd5be43d0c1d3d349c68bea6a87bc3a2670ffb5b01090900125f47ee21740e39d62c1a66c18a76d2fb4945eabbde8891272c56bb1e4b94636d0de53111f60a
-  data.tar.gz: 48c029f1c862f7b3bae41a732d5f1dd6c5f1add06414d0a288f24a7ef83f26d3fe1bae71c02d0916ab8dfb2074b3bb9f5c83af4ebfcec785f22d590030b9307b
+  metadata.gz: b9e579ab4c49826b467ace7e6e423efa849c3cd7007667915dae2bea38615b9793b1ced1303a96db45b2babbd880589368326a85cbb09ccdd990e9f09922c511
+  data.tar.gz: 3d56ebbc1bb06f974b6a956f522df681125041996a10e6a1f5bef0710f839b930e94fc0a0de32abec05e3d4b4581406a9472430d7cea3c0874fac5d984a63a23

data/README.md

@@ -34,7 +34,13 @@ gem install omniauth-orcid
 
 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)):
+There are three ways to register a client application and obtain client app credentials (`client_id` and `client_secret`) as well as a `site URL`:
+
+* for non-members (the default): Register your client application in the `Developer Tools` section of your ORCID profile.
+* for members (production): Register your client application [here](http://orcid.org/content/register-client-application).
+* for development (sandbox): Register your client application [here](https://orcid.org/content/register-client-application-sandbox).
+
+By default the module connects to the live ORCID service for non-members. 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
@@ -42,11 +48,13 @@ use OmniAuth::Builder do
 end
 ```
 
-There are three ways to register a client application and obtain client app credentials (`client_id` and `client_secret`) as well as a `site URL`:
+To connect to the member API and/or sandbox, use the `member` and/or `sandbox` options, e.g.
 
-* for non-members (the default): Register your client application in the `Developer Tools` section of your ORCID profile. Use `https://pub.orcid.org` as `site URL`
-* for members (production): Register your client application [here](http://orcid.org/content/register-client-application). Use https://api.orcid.org as `site URL`
-* for development (sandbox): Register your client application [here](https://orcid.org/content/register-client-application-sandbox). Use https://api.sandbox.orcid.org as `site URL`
+```ruby
+use OmniAuth::Builder do
+  provider :orcid, ENV['ORCID_CLIENT_ID'], ENV['ORCID_CLIENT_SECRET'], member: true, sandbox: true
+end
+```
 
 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:
 
@@ -150,28 +158,6 @@ class AuthenticationsController < ApplicationController
   end
 ```
 
-
-## Configuration
-
-You can also grab parameters from a environment variables (e.g. using the [dotenv](https://github.com/bkeepers/dotenv) gem) and pass to the strategy, along with other options specific to your app. Here's an example from the bundled Sinatra app in `demo.rb`:
-
-```ruby
-use OmniAuth::Builder do
-  provider :orcid, ENV['ORCID_CLIENT_ID'], ENV['ORCID_CLIENT_SECRET'],
-    authorize_params: {
-      scope: '/orcid-profile/read-limited'
-    },
-  client_options: {
-    site: ENV['API_ORCID_URL'],
-    authorize_url: "#{ENV['ORCID_URL']}/oauth/authorize",
-    token_url: "#{ENV['API_ORCID_URL']}/oauth/token",
-  }
-end
-
-```
-Where `ENV['ORCID_CLIENT_ID']` and `ENV['ORCID_CLIENT_SECRET']` are provided by ORCID when registering the application, and `ENV['API_ORCID_URL']` depends on the API you are using (see above).
-
-
 ## More information
 
 * [ORCID Open Source Project](https://github.com/ORCID/ORCID-Source)

data/lib/omniauth/orcid/version.rb

@@ -1,5 +1,5 @@
 module OmniAuth
   module Orcid
-    VERSION = "1.0.14"
+    VERSION = "1.0.15"
   end
 end

data/spec/omniauth/strategies/orcid_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe OmniAuth::Strategies::ORCID do
+  subject { OmniAuth::Strategies::ORCID.new({}) }
+
+  describe '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
+
+    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
+  end
+
+  describe 'uid' do
+    before do
+      allow(subject).to receive(:raw_info).and_return(raw_info_hash)
+    end
+
+    it 'should return the uid' do
+      expect(subject.uid).to eq(raw_info_hash['orcid'])
+    end
+  end
+
+  describe 'info' do
+    before do
+      allow(subject).to receive(:raw_info).and_return(raw_info_hash)
+    end
+
+    it 'should returns the name' do
+      expect(subject.info[:name]).to eq(raw_info_hash['name'])
+    end
+  end
+end
+
+private
+
+def raw_info_hash
+  {
+    "name" => "Josiah Carberry",
+    "access_token" => "e6394ba4-34bd-43a8-8c3d-a99752fe0bf9",
+    "expires_in" => 631138518,
+    "token_type" => "bearer",
+    "orcid" => "0000-0002-1825-0097",
+    "scope" => "/authenticate",
+    "refresh_token" => "c07df09f-2015-4b88-a387-61b7e2a89fb0"
+  }
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+$:.unshift File.expand_path('..', __FILE__)
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'rspec'
+require 'rack/test'
+require 'webmock/rspec'
+require 'omniauth'
+require 'omniauth-orcid'
+
+RSpec.configure do |config|
+  config.include WebMock::API
+  config.include Rack::Test::Methods
+  config.extend  OmniAuth::Test::StrategyMacros, :type => :strategy
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-orcid
 version: !ruby/object:Gem::Version
-  version: 1.0.14
+  version: 1.0.15
 platform: ruby
 authors:
 - Gudmundur A. Thorisson
@@ -61,6 +61,8 @@ files:
 - lib/omniauth/orcid/version.rb
 - lib/omniauth/strategies/orcid.rb
 - omniauth-orcid.gemspec
+- spec/omniauth/strategies/orcid_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/datacite/omniauth-orcid
 licenses:
 - MIT
@@ -85,4 +87,6 @@ rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: ORCID OAuth 2.0 Strategy for OmniAuth 1.0
-test_files: []
+test_files:
+- spec/omniauth/strategies/orcid_spec.rb
+- spec/spec_helper.rb