mais_orcid_client 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78b55c51d036f61b67cae0d7fd72ec1bc231e787301d1f4b4b1298dc45ef9a60
-  data.tar.gz: 2826a1359658edc044a94abd4163827e810b6f9b64063d17837fc0441aab350d
+  metadata.gz: b93e75dc3042635205b947c21d9697808b9bdefa9d9dae8598e03db1eac3e128
+  data.tar.gz: d714d5c0985596191dba26e801a43455dd926b307e5a88753c66e5a8550d918d
 SHA512:
-  metadata.gz: 1f31a13fb73f0643476343081e33dc50b3fb22847f32abb0f95599252efa13293c3f1a94d684dbfec11d3e0799b4370f166db2d4e436f9eb5ce05def99986cbb
-  data.tar.gz: e930d20928af633900545f1cfd8aca7df794c1340b753042704dbbe6a037f95b109aeaadb23f948418f459f720f8d4e094c56dbe4a238faaa44f1cbc12ff6136
+  metadata.gz: 227b68aa40fee6c5a55dbea773ef788bc5235c094a8ede1b717881ad9cb4e431de368a4d8e20b7564e60dc9c02f4f0657d47835a2bc490a4f2db174f6ba0f8e0
+  data.tar.gz: 8860974d178d49ddca9153d9a71a31ca25d4e2050541c02fc7d185c7ad04d45854dc4087022c6194b9c52883a2d7e385a4a6beb7be0ab5858c41608627e4cb37

data/.rubocop/custom.yml

@@ -52,3 +52,33 @@ RSpec/Rails/InferredSpecType: # new in 2.14
 RSpec/MultipleExpectations:
   Enabled: false
 
+Capybara/MatchStyle: # new in 2.17
+  Enabled: true
+FactoryBot/AssociationStyle: # new in 2.23
+  Enabled: true
+FactoryBot/FactoryAssociationWithStrategy: # new in 2.23
+  Enabled: true
+FactoryBot/FactoryNameStyle: # new in 2.16
+  Enabled: true
+FactoryBot/RedundantFactoryOption: # new in 2.23
+  Enabled: true
+RSpec/BeEmpty: # new in 2.20
+  Enabled: true
+RSpec/ContainExactly: # new in 2.19
+  Enabled: true
+RSpec/DuplicatedMetadata: # new in 2.16
+  Enabled: true
+RSpec/IndexedLet: # new in 2.20
+  Enabled: true
+RSpec/MatchArray: # new in 2.19
+  Enabled: true
+RSpec/PendingWithoutReason: # new in 2.16
+  Enabled: true
+RSpec/RedundantAround: # new in 2.19
+  Enabled: true
+RSpec/SkipBlockInsideExample: # new in 2.19
+  Enabled: true
+RSpec/Rails/MinitestAssertions: # new in 2.17
+  Enabled: true
+RSpec/Rails/TravelAround: # new in 2.19
+  Enabled: true

data/.rubocop.yml

@@ -4,6 +4,8 @@ inherit_mode:
 
 require:
   - standard
+  - standard-custom
+  - standard-performance
   - rubocop-performance
   - rubocop-rspec
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mais_orcid_client (0.2.0)
+    mais_orcid_client (0.3.1)
       activesupport (>= 4.2, < 8)
       faraday
       faraday-retry
@@ -11,12 +11,12 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.6)
+    activesupport (7.0.7)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-    addressable (2.8.4)
+    addressable (2.8.5)
       public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
     byebug (11.1.3)
@@ -38,8 +38,8 @@ GEM
     json (2.6.3)
     jwt (2.7.1)
     language_server-protocol (3.17.0.3)
-    lint_roller (1.0.0)
-    minitest (5.18.1)
+    lint_roller (1.1.0)
+    minitest (5.19.0)
     multi_xml (0.6.0)
     oauth2 (2.0.9)
       faraday (>= 0.17.3, < 3.0)
@@ -52,13 +52,13 @@ GEM
     parser (3.2.2.3)
       ast (~> 2.4.1)
       racc
-    public_suffix (5.0.1)
+    public_suffix (5.0.3)
     racc (1.7.1)
     rack (3.0.8)
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.8.1)
-    rexml (3.2.5)
+    rexml (3.2.6)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
@@ -68,7 +68,7 @@ GEM
     rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.5)
+    rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.1)
@@ -91,7 +91,7 @@ GEM
     rubocop-performance (1.18.0)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rspec (2.22.0)
+    rubocop-rspec (2.23.2)
       rubocop (~> 1.33)
       rubocop-capybara (~> 2.17)
       rubocop-factory_bot (~> 2.22)
@@ -106,16 +106,17 @@ GEM
     snaky_hash (2.0.1)
       hashie
       version_gem (~> 1.1, >= 1.1.1)
-    standard (1.29.0)
+    standard (1.30.1)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.0)
       rubocop (~> 1.52.0)
       standard-custom (~> 1.0.0)
       standard-performance (~> 1.1.0)
-    standard-custom (1.0.1)
-      lint_roller (~> 1.0)
-    standard-performance (1.1.0)
+    standard-custom (1.0.2)
       lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.1.2)
+      lint_roller (~> 1.1)
       rubocop-performance (~> 1.18.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
@@ -126,7 +127,7 @@ GEM
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    zeitwerk (2.6.8)
+    zeitwerk (2.6.11)
 
 PLATFORMS
   x86_64-darwin-19

data/README.md

@@ -6,6 +6,8 @@
 # mais_orcid_client
 API client for accessing MAIS's ORCID endpoints.
 
+MAIS's ORCID API provides access to ORCID information for Stanford users. (This is different from orcid.org's ORCID API, which is supported by https://github.com/sul-dlss/orcid_client.)
+
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:
@@ -68,8 +70,8 @@ recorded.
 
 To record new cassettes:
 1. Temporarily adjust the configuration (client_id, client_secret for the MaIS UAT URL) at the top of `spec/mais_orcid_client_spec.rb` so it matches the real MaIS UAT environment.
-2. Add your new spec with a new cassette name (or delete a cassette to re-create it).
-3. Run just that new spec.
+2. Add your new spec with a new cassette name (or delete a previous cassette to re-create it).
+3. Run just that new spec (important: else previous specs may use cassettes that have redacted credentials, causing your new spec to fail).
 4. You should get a new cassette with the name you specified in the spec.
 5. The cassette should have access tokens and secrets sanitized by the config in `spec_helper.rb`, but you can double check, EXCEPT for user access tokens in the user response.  These should be sanitized manaully (e.g. "access_token":"8d13b8bb-XXXX-YYYY-b7d6-87aecd5a8975")
 6. Set your configuration at the top of the spec back to the fake client_id and client_secret values.

data/lib/mais_orcid_client/authenticator.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+class MaisOrcidClient
+  # The namespace for the "login" command
+  class Authenticator
+    attr_reader :client_id, :client_secret, :base_url
+
+    def self.token(client_id, client_secret, base_url)
+      new(client_id, client_secret, base_url).token
+    end
+
+    def initialize(client_id, client_secret, base_url)
+      @client_id = client_id
+      @client_secret = client_secret
+      @base_url = base_url
+    end
+
+    # @return [String]
+    def token
+      client = OAuth2::Client.new(client_id, client_secret, site: base_url,
+        token_url: "/api/oauth/token", authorize_url: "/api/oauth/authorize",
+        auth_scheme: :request_body)
+      client.client_credentials.get_token.token
+    end
+  end
+end

data/lib/mais_orcid_client/token_wrapper.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class MaisOrcidClient
+  # Wraps API operations to request new access token if expired
+  class TokenWrapper
+    def self.refresh(config)
+      yield
+    rescue UnexpectedResponse::UnauthorizedError
+      config.token = Authenticator.token(config.client_id, config.client_secret, config.base_url)
+      yield
+    end
+  end
+end

data/lib/mais_orcid_client/unexpected_response.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+class MaisOrcidClient
+  # Handles unexpected responses when communicating with Mais
+  class UnexpectedResponse
+    # Error raised when the Mais API returns a 401 Unauthorized
+    class UnauthorizedError < StandardError; end
+
+    # Error raised when the Mais API returns a 500 error
+    class ServerError < StandardError; end
+
+    # Error raised when the Mais API returns a response with an error message in it
+    class ResponseError < StandardError; end
+
+    def self.call(response)
+      case response.status
+      when 401
+        raise UnauthorizedError, "There was a problem with the access token: #{response.body}"
+      when 500
+        raise ServerError, "Mais server error: #{response.body}"
+      else
+        raise StandardError, "Unexpected response: #{response.status} #{response.body}"
+      end
+    end
+  end
+end

data/lib/mais_orcid_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class MaisOrcidClient
-  VERSION = "0.2.0"
+  VERSION = "0.3.1"
 end

data/lib/mais_orcid_client.rb

@@ -28,16 +28,20 @@ class MaisOrcidClient
     # @param client_secret [String] the client secret to authenticate with MAIS
     # @param base_url [String] the base URL for the API
     def configure(client_id:, client_secret:, base_url:)
-      instance.base_url = base_url
-      instance.client_id = client_id
-      instance.client_secret = client_secret
+      instance.config = OpenStruct.new(
+        token: Authenticator.token(client_id, client_secret, base_url),
+        client_id:,
+        client_secret:,
+        base_url:
+      )
+
       self
     end
 
-    delegate :fetch_orcid_users, :fetch_orcid_user, to: :instance
+    delegate :config, :fetch_orcid_users, :fetch_orcid_user, to: :instance
   end
 
-  attr_accessor :base_url, :client_id, :client_secret
+  attr_accessor :config
 
   # @param [int] limit number of users requested
   # @param [int] page_size number of users per page
@@ -79,26 +83,18 @@ class MaisOrcidClient
     OrcidUser.new(result[:sunet_id], result[:orcid_id], result[:scope], result[:access_token], result[:last_updated])
   end
 
-  # @param [string] orcidid to fetch
+  # @param [string] orcidid to fetch (note any ORCID URI will be stripped, as MaIS endpoint requires bare ORCIDID only)
   # @return [<OrcidUser>, nil] orcid user or nil if not found
   def fetch_by_orcidid(orcidid)
-    # NOTE: This is intended to be a temporary implementation that iterates over all users
-    # until we find the orcidid of interest and then return it.  It can be slow (1-2 minutes)
-    # if the orcidid queried is at the end of the list (or doesn't exist).
-    # The idea is that when MaIS implements this functionality in their API, we replace this
-    # iteration with a simple call to their API.
-    # see https://github.com/sul-dlss/happy-heron/issues/3164
-    next_page = first_page
-    loop do
-      response = get_response(next_page)
-      response[:results].each do |result|
-        if result[:orcid_id] == orcidid
-          return OrcidUser.new(result[:sunet_id], result[:orcid_id], result[:scope], result[:access_token], result[:last_updated])
-        end
-      end
-      next_page = response.dig(:links, :next)
-      return nil if last_page?(response[:links])
-    end
+    bare_orcid = orcidid_without_uri(orcidid)
+
+    return if bare_orcid.empty? # don't even bother sending the search if the incoming orcidid is bogus
+
+    result = get_response("/users/#{bare_orcid}", allow404: true)
+
+    return if result.nil?
+
+    OrcidUser.new(result[:sunet_id], result[:orcid_id], result[:scope], result[:access_token], result[:last_updated])
   end
 
   def first_page(page_size = nil)
@@ -112,40 +108,37 @@ class MaisOrcidClient
   end
 
   def get_response(path, allow404: false)
-    response = conn.get("/mais/orcid/v1#{path}")
+    TokenWrapper.refresh(config) do
+      response = conn.get("/mais/orcid/v1#{path}")
 
-    return if allow404 && response.status == 404
+      return if allow404 && response.status == 404
 
-    raise "UIT MAIS ORCID User API returned #{response.status}" if response.status != 200
+      return UnexpectedResponse.call(response) unless response.success?
 
-    body = JSON.parse(response.body).with_indifferent_access
-    raise "UIT MAIS ORCID User API returned an error: #{response.body}" if body.key?(:error)
+      body = JSON.parse(response.body).with_indifferent_access
+      raise UnexpectedResponse::ResponseError, "UIT MAIS ORCID User API returned an error: #{response.body}" if body.key?(:error)
 
-    body
+      body
+    end
   end
 
-  # @return [Faraday::Connection]
   def conn
-    @conn ||= begin
-      conn = Faraday.new(url: base_url) do |faraday|
-        faraday.request :retry, max: 3,
-          interval: 0.5,
-          interval_randomness: 0.5,
-          backoff_factor: 2
-      end
-      conn.options.timeout = 500
-      conn.options.open_timeout = 10
-      conn.headers[:user_agent] = "stanford-library-sul-pub"
-      conn.headers[:authorization] = token
-      conn
+    conn = Faraday.new(url: config.base_url) do |faraday|
+      faraday.request :retry, max: 3,
+        interval: 0.5,
+        interval_randomness: 0.5,
+        backoff_factor: 2
     end
+    conn.options.timeout = 500
+    conn.options.open_timeout = 10
+    conn.headers[:user_agent] = "stanford-library-sul-pub"
+    conn.headers[:authorization] = "Bearer #{config.token}"
+    conn
   end
 
-  def token
-    client = OAuth2::Client.new(client_id, client_secret, site: base_url,
-      token_url: "/api/oauth/token", authorize_url: "/api/oauth/authorize",
-      auth_scheme: :request_body)
-    token = client.client_credentials.get_token
-    "Bearer #{token.token}"
+  # @param [string] orcidid which can include a full URI, e.g. "https://sandbox.orcid.org/0000-0002-7262-6251"
+  # @return [string] orcidid without URI (if valid), e.g. "0000-0002-7262-6251" or empty string if none found or orcidid invalid
+  def orcidid_without_uri(orcidid)
+    orcidid.match(/\d{4}-\d{4}-\d{4}-\d{3}(\d|X){1}\z/).to_s
   end
 end

data/mais_orcid_client.gemspec

@@ -44,4 +44,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "webmock"
   spec.add_development_dependency "vcr"
+  spec.add_development_dependency "byebug"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mais_orcid_client
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Peter Mangiafico
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-12 00:00:00.000000000 Z
+date: 2023-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -185,6 +185,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: This provides API interaction with the MAIS's ORCID API
 email:
 - pmangiafico@stanford.edu
@@ -203,6 +217,9 @@ files:
 - README.md
 - Rakefile
 - lib/mais_orcid_client.rb
+- lib/mais_orcid_client/authenticator.rb
+- lib/mais_orcid_client/token_wrapper.rb
+- lib/mais_orcid_client/unexpected_response.rb
 - lib/mais_orcid_client/version.rb
 - mais_orcid_client.gemspec
 homepage: https://github.com/sul-dlss/mais_orcid_client
@@ -227,7 +244,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.14
+rubygems_version: 3.4.13
 signing_key:
 specification_version: 4
 summary: Interface for interacting with the MAIS's ORCID API.