sul_orcid_client 0.4.1 → 0.5.0

data/lib/sul_orcid_client/work_mapper.rb

@@ -1,14 +1,18 @@
+# frozen_string_literal: true
+
 class SulOrcidClient
   # Maps a Cocina Description to an Orcid Work.
 
   # Note that this mapping is currently based on a description generated
   # from an H2 work. However, it could be extended to more completely map descriptions.
+  # rubocop:disable Metrics/ClassLength
+  # rubocop:disable Metrics/MethodLength
   class WorkMapper
     # Error raised by WorkMapper
     class WorkMapperError < StandardError; end
 
     def self.map(description:, doi: nil)
-      new(description: description, doi: doi).map
+      new(description:, doi:).map
     end
 
     # @param [Cocina::Models::Description] description to map
@@ -21,16 +25,16 @@ class SulOrcidClient
     def map
       {
         title: map_title,
-        "short-description": map_short_description,
+        'short-description': map_short_description,
         citation: map_citation,
         type: map_type,
-        "publication-date": map_publication_date,
-        "external-ids": map_external_ids,
+        'publication-date': map_publication_date,
+        'external-ids': map_external_ids,
         url: description.purl,
         contributors: map_contributors,
-        "language-code": "en",
+        'language-code': 'en',
         country: {
-          value: "US"
+          value: 'US'
         }
       }.compact
     end
@@ -41,7 +45,7 @@ class SulOrcidClient
 
     def map_title
       title = description.title.first&.value
-      raise WorkMapperError, "Title not mapped" unless title
+      raise WorkMapperError, 'Title not mapped' unless title
 
       {
         title: {
@@ -51,41 +55,41 @@ class SulOrcidClient
     end
 
     def map_short_description
-      description.note.find { |note| note.type == "abstract" }&.value
+      description.note.find { |note| note.type == 'abstract' }&.value
     end
 
     def map_citation
-      citation = description.note.find { |note| note.type == "preferred citation" }&.value
+      citation = description.note.find { |note| note.type == 'preferred citation' }&.value
       return unless citation
 
       {
-        "citation-type": "formatted-unspecified",
-        "citation-value": citation
+        'citation-type': 'formatted-unspecified',
+        'citation-value': citation
       }
     end
 
     def map_external_ids
-      {"external-id":
+      { 'external-id':
         [
-          map_external_id("uri", description.purl, description.purl)
+          map_external_id('uri', description.purl, description.purl)
         ].tap do |ids|
-          ids << map_external_id("doi", doi, "https://doi.org/#{doi}") if doi
-        end}
+          ids << map_external_id('doi', doi, "https://doi.org/#{doi}") if doi
+        end }
     end
 
     def map_external_id(type, value, url)
       {
-        "external-id-type": type,
-        "external-id-value": value,
-        "external-id-url": {
+        'external-id-type': type,
+        'external-id-value': value,
+        'external-id-url': {
           value: url
         },
-        "external-id-relationship": "self"
+        'external-id-relationship': 'self'
       }
     end
 
     def map_publication_date
-      date = event_value("publication") || event_value("deposit")
+      date = event_value('publication') || event_value('deposit')
       return unless date
 
       year, month, day = parse_date(date)
@@ -96,8 +100,8 @@ class SulOrcidClient
           value: year
         }
       }.tap do |publication_date|
-        publication_date[:month] = {value: month} if month
-        publication_date[:day] = {value: day} if month && day
+        publication_date[:month] = { value: month } if month
+        publication_date[:day] = { value: day } if month && day
       end
     end
 
@@ -113,64 +117,67 @@ class SulOrcidClient
     end
 
     H2_TERM_MAP = {
-      "Data" => "data-set",
-      "Software/Code" => "software",
-      "Article" => "journal-article",
-      "Book" => "book",
-      "Book chapter" => "book-chapter",
-      "Code" => "software",
-      "Conference session" => "lecture-speech",
-      "Course/instructional materials" => "manual",
-      "Database" => "data-set",
-      "Dramatic performance" => "artistic-performance",
-      "Geospatial data" => "data-set",
-      "Journal/periodical issue" => "journal-issue",
-      "Performance" => "artistic-performance",
-      "Poetry reading" => "artistic-performance",
-      "Poster" => "conference-poster",
-      "Preprint" => "preprint",
-      "Presentation recording" => "lecture-speech",
-      "Questionnaire" => "research-technique",
-      "Report" => "report",
-      "Software" => "software",
-      "Speech" => "lecture-speech",
-      "Statistical model" => "research-technique",
-      "Syllabus" => "manual",
-      "Tabular data" => "data-set",
-      "Technical report" => "report",
-      "Text corpus" => "data-set",
-      "Thesis" => "dissertation-thesis",
-      "Working paper" => "working-paper"
-    }
+      'Data' => 'data-set',
+      'Software/Code' => 'software',
+      'Article' => 'journal-article',
+      'Book' => 'book',
+      'Book chapter' => 'book-chapter',
+      'Code' => 'software',
+      'Conference session' => 'lecture-speech',
+      'Course/instructional materials' => 'manual',
+      'Database' => 'data-set',
+      'Dramatic performance' => 'artistic-performance',
+      'Geospatial data' => 'data-set',
+      'Journal/periodical issue' => 'journal-issue',
+      'Performance' => 'artistic-performance',
+      'Poetry reading' => 'artistic-performance',
+      'Poster' => 'conference-poster',
+      'Preprint' => 'preprint',
+      'Presentation recording' => 'lecture-speech',
+      'Questionnaire' => 'research-technique',
+      'Report' => 'report',
+      'Software' => 'software',
+      'Speech' => 'lecture-speech',
+      'Statistical model' => 'research-technique',
+      'Syllabus' => 'manual',
+      'Tabular data' => 'data-set',
+      'Technical report' => 'report',
+      'Text corpus' => 'data-set',
+      'Thesis' => 'dissertation-thesis',
+      'Working paper' => 'working-paper'
+    }.freeze
 
     def map_type
       # See https://info.orcid.org/ufaqs/what-work-types-does-orcid-support/
       # For now, only mapping H2 terms; if there is not an H2 term, using "other".
 
-      h2_form = description.form.find { |form| form.source&.value == "Stanford self-deposit resource types" }
-      return "other" unless h2_form
+      h2_form = description.form.find { |form| form.source&.value == 'Stanford self-deposit resource types' }
+      return 'other' unless h2_form
 
       map_h2_resource_types(h2_form)
     end
 
     def map_h2_resource_types(form)
       # Try to match subtypes first, then type
-      subtype_terms = form.structuredValue.select { |term| term.type == "subtype" }.map(&:value)
-      type_term = form.structuredValue.find { |term| term.type == "type" }&.value
+      subtype_terms = form.structuredValue.select { |term| term.type == 'subtype' }.map(&:value)
+      type_term = form.structuredValue.find { |term| term.type == 'type' }&.value
       matching_term = (subtype_terms + [type_term]).find { |term| H2_TERM_MAP.key?(term) }
-      return "other" unless matching_term
+      return 'other' unless matching_term
 
       H2_TERM_MAP[matching_term]
     end
 
     def map_contributors
-      contributors = description.contributor.map do |contributor|
-        ContributorMapper.map(contributor: contributor)
-      end.compact.presence
+      contributors = description.contributor.filter_map do |contributor|
+        ContributorMapper.map(contributor:)
+      end.presence
       return unless contributors
+
       {
         contributor: contributors
       }
     end
   end
+  # rubocop:enable Metrics/ClassLength
+  # rubocop:enable Metrics/MethodLength
 end

data/lib/sul_orcid_client.rb

@@ -1,18 +1,19 @@
 # frozen_string_literal: true
 
-require "active_support"
-require "active_support/core_ext"
+require 'active_support'
+require 'active_support/core_ext'
 
-require "faraday"
-require "faraday/retry"
-require "oauth2"
-require "singleton"
-require "zeitwerk"
+require 'faraday'
+require 'faraday/retry'
+require 'oauth2'
+require 'singleton'
+require 'zeitwerk'
 
 # Load the gem's internal dependencies: use Zeitwerk instead of needing to manually require classes
 Zeitwerk::Loader.for_gem.setup
 
 # Client for interacting with ORCID API
+# rubocop:disable Metrics/ClassLength
 class SulOrcidClient
   include Singleton
 
@@ -52,16 +53,17 @@ class SulOrcidClient
   end
 
   # Fetches the name for a user given an orcidid
+  # rubocop:disable Metrics/MethodLength
   def fetch_name(orcidid:)
     match = /[0-9xX]{4}-[0-9xX]{4}-[0-9xX]{4}-[0-9xX]{4}/.match(orcidid)
-    raise "invalid orcidid provided" unless match
+    raise 'invalid orcidid provided' unless match
 
     response = public_conn.get("/v3.0/#{match[0]&.upcase}/personal-details")
     case response.status
     when 200
       resp_json = JSON.parse(response.body)
-      [resp_json.dig("name", "given-names", "value"),
-        resp_json.dig("name", "family-name", "value")]
+      [resp_json.dig('name', 'given-names', 'value'),
+       resp_json.dig('name', 'family-name', 'value')]
     else
       raise "ORCID.org API returned #{response.status} (#{response.body}) for: #{orcidid}"
     end
@@ -71,19 +73,20 @@ class SulOrcidClient
   # see https://info.orcid.org/documentation/api-tutorials/api-tutorial-searching-the-orcid-registry
   # @param [query] query to pass to ORCID
   # @param [expanded] set to true or false (defaults to false) to indicate an expanded query results (see ORCID docs)
+  # rubocop:disable Metrics/AbcSize
   def search(query:, expanded: false)
     if expanded
-      search_method = "expanded-search"
-      response_name = "expanded-result"
+      search_method = 'expanded-search'
+      response_name = 'expanded-result'
     else
-      search_method = "search"
-      response_name = "result"
+      search_method = 'search'
+      response_name = 'result'
     end
 
     # this is the maximum number of rows ORCID allows in their response currently
     max_num_returned = 1000
     total_response = get("/v3.0/#{search_method}/?q=#{query}&rows=#{max_num_returned}")
-    num_results = total_response["num-found"]
+    num_results = total_response['num-found']
 
     return total_response if num_results <= max_num_returned
 
@@ -105,24 +108,26 @@ class SulOrcidClient
   # @return [string] put-code
   def add_work(orcidid:, work:, token:)
     response = conn_with_token(token).post("/v3.0/#{base_orcidid(orcidid)}/work",
-      work.to_json,
-      "Content-Type" => "application/json")
+                                           work.to_json,
+                                           'Content-Type' => 'application/json')
 
     case response.status
     when 201
-      response["Location"].match(%r{work/(\d+)})[1]
+      response['Location'].match(%r{work/(\d+)})[1]
     when 401
       raise InvalidTokenError,
-        "Invalid token for #{orcidid} - ORCID.org API returned #{response.status} (#{response.body})"
+            "Invalid token for #{orcidid} - ORCID.org API returned #{response.status} (#{response.body})"
     when 409
       match = response.body.match(/put-code (\d+)\./)
-      raise "ORCID.org API returned a 409, but could not find put-code" unless match
+      raise 'ORCID.org API returned a 409, but could not find put-code' unless match
 
       match[1]
     else
       raise "ORCID.org API returned #{response.status} (#{response.body}) for: #{work.to_json}"
     end
   end
+  # rubocop:enable Metrics/MethodLength
+  # rubocop:enable Metrics/AbcSize
 
   # Update an existing work for a researcher.
   # @param [String] orcidid an ORCiD ID for the researcher
@@ -133,12 +138,16 @@ class SulOrcidClient
   # @raise [RuntimeError] if the API response status is not successful
   def update_work(orcidid:, work:, token:, put_code:)
     response = conn_with_token(token).put("/v3.0/#{base_orcidid(orcidid)}/work/#{put_code}",
-      work.merge({"put-code" => put_code}).to_json,
-      "Content-Type" => "application/vnd.orcid+json")
+                                          work.merge({ 'put-code' => put_code }).to_json,
+                                          'Content-Type' => 'application/vnd.orcid+json')
 
-    raise "ORCID.org API returned #{response.status} when updating #{put_code} for #{orcidid}. The author may have previously deleted this work from their ORCID profile." if response.status == 404
+    if response.status == 404
+      raise "ORCID.org API returned #{response.status} when updating #{put_code} for #{orcidid}. The author may have previously deleted " \
+            'this work from their ORCID profile.'
+    end
 
     raise "ORCID.org API returned #{response.status} when updating #{put_code} for #{orcidid}" unless response.status == 200
+
     true
   end
 
@@ -171,7 +180,7 @@ class SulOrcidClient
 
   def client_token
     client = OAuth2::Client.new(client_id, client_secret, site: base_auth_url)
-    token = client.client_credentials.get_token({scope: "/read-public"})
+    token = client.client_credentials.get_token({ scope: '/read-public' })
     token.token
   end
 
@@ -184,9 +193,9 @@ class SulOrcidClient
   def public_conn
     conn = Faraday.new(url: base_public_url) do |faraday|
       faraday.request :retry, max: 5,
-        interval: 0.5,
-        interval_randomness: 0.5,
-        backoff_factor: 2
+                              interval: 0.5,
+                              interval_randomness: 0.5,
+                              backoff_factor: 2
     end
     conn.options.timeout = 500
     conn.options.open_timeout = 10
@@ -195,12 +204,13 @@ class SulOrcidClient
   end
 
   # @return [Faraday::Connection]
+  # rubocop:disable Metrics/MethodLength
   def conn_with_token(token)
     conn = Faraday.new(url: base_url) do |faraday|
       faraday.request :retry, max: 3,
-        interval: 0.5,
-        interval_randomness: 0.5,
-        backoff_factor: 2
+                              interval: 0.5,
+                              interval_randomness: 0.5,
+                              backoff_factor: 2
     end
     conn.options.timeout = 500
     conn.options.open_timeout = 10
@@ -208,11 +218,12 @@ class SulOrcidClient
     conn.headers[:authorization] = "Bearer #{token}"
     conn
   end
+  # rubocop:enable Metrics/MethodLength
 
   def headers
     {
-      "Accept" => "application/json",
-      "User-Agent" => "stanford-library-sul-pub"
+      'Accept' => 'application/json',
+      'User-Agent' => 'stanford-library-sul-pub'
     }
   end
 
@@ -224,3 +235,4 @@ class SulOrcidClient
     orcidid[-19, 19]
   end
 end
+# rubocop:enable Metrics/ClassLength

data/sul_orcid_client.gemspec

@@ -1,24 +1,24 @@
 # frozen_string_literal: true
 
-lib = File.expand_path("lib", __dir__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "sul_orcid_client/version"
+require 'sul_orcid_client/version'
 
 Gem::Specification.new do |spec|
-  spec.name = "sul_orcid_client"
+  spec.name = 'sul_orcid_client'
   spec.version = SulOrcidClient::VERSION
-  spec.authors = ["Peter Mangiafico", "Justin Littman"]
-  spec.email = ["pmangiafico@stanford.edu", "jlittman@stanford.edu"]
+  spec.authors = ['Peter Mangiafico', 'Justin Littman']
+  spec.email = ['pmangiafico@stanford.edu', 'jlittman@stanford.edu']
 
-  spec.summary = "Interface for interacting with the ORCID API."
-  spec.description = "This provides API interaction with the ORCID API"
-  spec.homepage = "https://github.com/sul-dlss/sul_orcid_client"
-  spec.required_ruby_version = ">= 3.2.0"
+  spec.summary = 'Interface for interacting with the ORCID API.'
+  spec.description = 'This provides API interaction with the ORCID API'
+  spec.homepage = 'https://github.com/sul-dlss/sul_orcid_client'
+  spec.required_ruby_version = '>= 3.2.0'
 
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/sul-dlss/sul_orcid_client"
-  spec.metadata["changelog_uri"] = "https://github.com/sul-dlss/sul_orcid_client/releases"
-  spec.metadata["rubygems_mfa_required"] = "true"
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/sul-dlss/sul_orcid_client'
+  spec.metadata['changelog_uri'] = 'https://github.com/sul-dlss/sul_orcid_client/releases'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -27,22 +27,26 @@ Gem::Specification.new do |spec|
       (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
     end
   end
-  spec.bindir = "exe"
+  spec.bindir = 'exe'
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "activesupport", ">= 4.2", "< 8"
-  spec.add_dependency "cocina-models", "~> 0.90"
-  spec.add_dependency "faraday"
-  spec.add_dependency "faraday-retry"
-  spec.add_dependency "oauth2"
-  spec.add_dependency "zeitwerk"
+  spec.add_dependency 'activesupport', '>= 4.2'
+  spec.add_dependency 'cocina-models', '~> 0.90'
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'faraday-retry'
+  spec.add_dependency 'oauth2'
+  spec.add_dependency 'zeitwerk'
 
-  spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rubocop-rspec"
-  spec.add_development_dependency "simplecov"
-  spec.add_development_dependency "standard"
-  spec.add_development_dependency "vcr"
-  spec.add_development_dependency "webmock"
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-capybara'
+  spec.add_development_dependency 'rubocop-factory_bot'
+  spec.add_development_dependency 'rubocop-performance'
+  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'rubocop-rspec_rails'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock'
 end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sul_orcid_client
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Peter Mangiafico
 - Justin Littman
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-20 00:00:00.000000000 Z
+date: 2025-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -18,9 +17,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -28,9 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '8'
 - !ruby/object:Gem::Dependency
   name: cocina-models
   requirement: !ruby/object:Gem::Requirement
@@ -129,6 +122,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop-capybara
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop-factory_bot
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  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'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -144,7 +193,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rubocop-rspec_rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -158,7 +207,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: standard
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -209,8 +258,6 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
-- ".rubocop/custom.yml"
-- ".standard.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -229,7 +276,6 @@ metadata:
   source_code_uri: https://github.com/sul-dlss/sul_orcid_client
   changelog_uri: https://github.com/sul-dlss/sul_orcid_client/releases
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -244,8 +290,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.21
-signing_key:
+rubygems_version: 3.6.3
 specification_version: 4
 summary: Interface for interacting with the ORCID API.
 test_files: []