mais_orcid_client 0.4.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ddc18f86e894ccbe78b835023154bda7b47bfea027bbac35e2639ce780691183
-  data.tar.gz: 4ca18413e81bf9ee03f731c8b799fc30095b29de13e1e91e5c662b521dc21f1d
+  metadata.gz: 37780670257a67170aacd956c9b28d77462974a7068229a221985c55993435e0
+  data.tar.gz: bb7b89396a2ac1539d7b39dfe6732e5047312c14ae0a269e8a20b9780e434642
 SHA512:
-  metadata.gz: b66a9f5531913fe22f347f53f6f872b9292c98bae7a1b0cf47f85f058b8c32df57d7226ba112ca5f7a38e9e95d1d704d9e54704cd4ae0fb2664a02f8973807ed
-  data.tar.gz: b13aaef08ca495384919ad30db4bb666611cfbbcc5a7629f0a747e3537694224b9d008370d19ddad622467475c9ced50d8f9cce3d5f703781e0dbf253b0e3bfe
+  metadata.gz: f64d3d4daa1150758535609ee01669850b03fa581e0a6089dbb40702373ab41a2189e4ddc0cdc2783ef8f5894e3b59bb8718ab5c6b376fac59bc5089325b729a
+  data.tar.gz: 525a539b133093d30b7b3099bfadd7d149b7ee53c64b2cee364e4325e73eb7e82876c85d4d768f2b21ea88c94bec1bb2856e84da0d83ceaa3c563197c96f99af

data/Gemfile.lock

@@ -1,17 +1,18 @@
 PATH
   remote: .
   specs:
-    mais_orcid_client (0.4.0)
+    mais_orcid_client (1.0.0)
       activesupport (>= 4.2)
       faraday
       faraday-retry
       oauth2
+      ostruct
       zeitwerk
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (8.0.1)
+    activesupport (8.0.2)
       base64
       benchmark (>= 0.3)
       bigdecimal
@@ -26,7 +27,7 @@ GEM
       uri (>= 0.13.1)
     addressable (2.8.7)
       public_suffix (>= 2.0.2, < 7.0)
-    ast (2.4.2)
+    ast (2.4.3)
     base64 (0.2.0)
     benchmark (0.4.0)
     bigdecimal (3.1.9)
@@ -36,7 +37,7 @@ GEM
     crack (1.0.0)
       bigdecimal
       rexml
-    diff-lcs (1.5.1)
+    diff-lcs (1.6.0)
     docile (1.4.1)
     drb (2.2.1)
     faraday (2.12.2)
@@ -51,12 +52,13 @@ GEM
     hashie (5.0.0)
     i18n (1.14.7)
       concurrent-ruby (~> 1.0)
-    json (2.9.1)
+    json (2.10.2)
     jwt (2.10.1)
       base64
     language_server-protocol (3.17.0.4)
+    lint_roller (1.1.0)
     logger (1.6.6)
-    minitest (5.25.4)
+    minitest (5.25.5)
     multi_xml (0.7.1)
       bigdecimal (~> 3.1)
     net-http (0.6.0)
@@ -68,17 +70,18 @@ GEM
       rack (>= 1.2, < 4)
       snaky_hash (~> 2.0)
       version_gem (~> 1.1)
+    ostruct (0.6.1)
     parallel (1.26.3)
-    parser (3.3.7.1)
+    parser (3.3.7.2)
       ast (~> 2.4.1)
       racc
     public_suffix (6.0.1)
     racc (1.8.1)
-    rack (3.1.9)
+    rack (3.1.12)
     rainbow (3.1.1)
     rake (13.2.1)
     regexp_parser (2.10.0)
-    rexml (3.4.0)
+    rexml (3.4.1)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
@@ -92,9 +95,10 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.2)
-    rubocop (1.71.2)
+    rubocop (1.74.0)
       json (~> 2.3)
-      language_server-protocol (>= 3.17.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
@@ -102,20 +106,25 @@ GEM
       rubocop-ast (>= 1.38.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.38.0)
-      parser (>= 3.3.1.0)
-    rubocop-capybara (2.21.0)
-      rubocop (~> 1.41)
-    rubocop-factory_bot (2.26.1)
-      rubocop (~> 1.61)
-    rubocop-performance (1.23.1)
-      rubocop (>= 1.48.1, < 2.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
-    rubocop-rspec (3.4.0)
-      rubocop (~> 1.61)
-    rubocop-rspec_rails (2.30.0)
-      rubocop (~> 1.61)
-      rubocop-rspec (~> 3, >= 3.0.1)
+    rubocop-ast (1.41.0)
+      parser (>= 3.3.7.2)
+    rubocop-capybara (2.22.1)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
+    rubocop-factory_bot (2.27.1)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
+    rubocop-performance (1.24.0)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.72.1, < 2.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
+    rubocop-rspec (3.5.0)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
+    rubocop-rspec_rails (2.31.0)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
+      rubocop-rspec (~> 3.5)
     ruby-progressbar (1.13.0)
     securerandom (0.4.1)
     simplecov (0.22.0)
@@ -132,17 +141,18 @@ GEM
     unicode-display_width (3.1.4)
       unicode-emoji (~> 4.0, >= 4.0.4)
     unicode-emoji (4.0.4)
-    uri (1.0.2)
+    uri (1.0.3)
     vcr (6.3.1)
       base64
-    version_gem (1.1.4)
-    webmock (3.25.0)
+    version_gem (1.1.6)
+    webmock (3.25.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    zeitwerk (2.7.1)
+    zeitwerk (2.7.2)
 
 PLATFORMS
+  arm64-darwin-23
   x86_64-darwin-19
   x86_64-darwin-20
   x86_64-darwin-21
@@ -165,4 +175,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   2.4.13
+   2.6.6

data/README.md

@@ -25,12 +25,17 @@ For one-off requests:
 require "mais_orcid_client"
 
 # NOTE: The settings below live in the consumer, not in the gem.
+# The user_agent string can be changed by consumers as requested by MaIS for tracking
 client = MaisOrcidClient.configure(
   client_id: Settings.mais_orcid.client_id,
   client_secret: Settings.mais_orcid.client_secret,
-  base_url: Settings.mais_orcid.base_url
+  base_url: Settings.mais_orcid.base_url,
+  token_url: Settings.mais_orcid.token_url,
+  user_agent: 'some-user-agent-string-to-send-in-requests' # defaults to 'stanford-library-sul-pub'
 )
-client.fetch_orcid_user(sunetid: 'nataliex')
+client.fetch_orcid_user(sunetid: 'nataliex') # get a single user by sunet
+client.fetch_orcid_user(orcid: '0000-1111-2222-3333-4444') # get a single user by orcidid
+client.fetch_orcid_users # return all users
 ```
 
 You can also invoke methods directly on the client class, which is useful in a
@@ -43,7 +48,8 @@ to be sure configuration has already occurred, e.g.:
 MaisOrcidClient.configure(
   client_id: Settings.mais_orcid.client_id,
   client_secret: Settings.mais_orcid.client_secret,
-  base_url: Settings.mais_orcid.base_url
+  base_url: Settings.mais_orcid.base_url,
+  token_url: Settings.mais_orcid.token_url
 )
 
 # app/services/my_mais_orcid_service.rb
@@ -72,6 +78,7 @@ To record new cassettes:
 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")
+5. The cassette should have access tokens and secrets sanitized by the config in `spec_helper.rb`, but you can double check.
 6. Set your configuration at the top of the spec back to the fake client_id and client_secret values.
+7. The spec that checks for a raised exception when fetching all users may need to be handcrafted in the cassette to look it raised a 500.  It's hard to get the actual URL to produce a 500 on this call.
 7. Re-run all the specs - they should pass now without making real calls.

data/lib/mais_orcid_client/authenticator.rb

@@ -18,8 +18,8 @@ class MaisOrcidClient
     # @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',
+                                                            token_url: '/oauth2/token',
+                                                            authorize_url: '/oauth2/authorize',
                                                             auth_scheme: :request_body)
       client.client_credentials.get_token.token
     end

data/lib/mais_orcid_client/token_wrapper.rb

@@ -6,7 +6,7 @@ class MaisOrcidClient
     def self.refresh(config)
       yield
     rescue UnexpectedResponse::UnauthorizedError
-      config.token = Authenticator.token(config.client_id, config.client_secret, config.base_url)
+      config.token = Authenticator.token(config.client_id, config.client_secret, config.token_url)
       yield
     end
   end

data/lib/mais_orcid_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class MaisOrcidClient
-  VERSION = '0.4.0'
+  VERSION = '1.0.0'
 end

data/lib/mais_orcid_client.rb

@@ -6,6 +6,7 @@ require 'active_support/core_ext/hash/indifferent_access'
 require 'faraday'
 require 'faraday/retry'
 require 'oauth2'
+require 'ostruct'
 require 'singleton'
 require 'zeitwerk'
 
@@ -27,13 +28,16 @@ class MaisOrcidClient
     # @param client_id [String] the client identifier registered with MAIS
     # @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:)
+    # @param token_url [String] the base token URL for authentication (getting token)
+    # @param user_agent [String] the user agent to use for requests (default: 'stanford-library-sul-pub')
+    def configure(client_id:, client_secret:, base_url:, token_url:, user_agent: 'stanford-library-sul-pub')
       # rubocop:disable Style/OpenStructUse
       instance.config = OpenStruct.new(
-        token: Authenticator.token(client_id, client_secret, base_url),
+        token: Authenticator.token(client_id, client_secret, token_url),
         client_id:,
         client_secret:,
-        base_url:
+        base_url:,
+        user_agent:
       )
       # rubocop:enable Style/OpenStructUse
 
@@ -117,7 +121,7 @@ class MaisOrcidClient
   # rubocop:disable Metrics/MethodLength
   def get_response(path, allow404: false)
     TokenWrapper.refresh(config) do
-      response = conn.get("/mais/orcid/v1#{path}")
+      response = conn.get("/orcid/v1#{path}")
 
       return if allow404 && response.status == 404
 
@@ -133,6 +137,7 @@ class MaisOrcidClient
     end
   end
 
+  # rubocop:disable Metrics/AbcSize
   def conn
     conn = Faraday.new(url: config.base_url) do |faraday|
       faraday.request :retry, max: 3,
@@ -142,10 +147,11 @@ class MaisOrcidClient
     end
     conn.options.timeout = 500
     conn.options.open_timeout = 10
-    conn.headers[:user_agent] = 'stanford-library-sul-pub'
+    conn.headers[:user_agent] = config.user_agent
     conn.headers[:authorization] = "Bearer #{config.token}"
     conn
   end
+  # rubocop:enable Metrics/AbcSize
   # rubocop:enable Metrics/MethodLength
 
   # @param [string] orcidid which can include a full URI, e.g. "https://sandbox.orcid.org/0000-0002-7262-6251"

data/mais_orcid_client.gemspec

@@ -35,6 +35,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'faraday'
   spec.add_dependency 'faraday-retry'
   spec.add_dependency 'oauth2'
+  spec.add_dependency 'ostruct'
   spec.add_dependency 'zeitwerk'
 
   spec.add_development_dependency 'byebug'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mais_orcid_client
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Peter Mangiafico
 - Justin Littman
 bindir: exe
 cert_chain: []
-date: 2025-02-18 00:00:00.000000000 Z
+date: 2025-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement