sul_orcid_client 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b75e419476e1943481450cb767b3f580fb25a16c4ca96cde068cd1176000972
-  data.tar.gz: 784a82cb26eaa7f27137bf108a47e4c5d9584588e8c9b98dcabd2902674d7fc1
+  metadata.gz: a962456d9d06f989b7fe1fa4a95922ee3bfab33234baa35f6192398380016dc1
+  data.tar.gz: 7a2b53f1c0fc01c27748e6ec226f6ca271a2f356e78f3f5ac45fc9e920758fa3
 SHA512:
-  metadata.gz: 0e47f1d153ae2dd5afcc676daf545f541d3e4c05ca9e89b0233f8ef1ef9bab896bbc6db6cb8a93c3f311de2fcecf2a48cfeb24cd7eb96e68ac2c587af742401c
-  data.tar.gz: e7390bd10097109537407e1ce9550a58e85213a066b8bf41280e6bf8c23c23c00d7b1e27953ae17f096f6da3aa0c365cb6a62d9e2cba59bf906983691f29357b
+  metadata.gz: 5d41466f03921824b3325bfec46018a0874bca2f01f8e7609171cbf90f0b077c428806b61483b66158699bafbf2ad2eb4afd1d24e5613bbbef7a477c011359a3
+  data.tar.gz: 1fbe6359f523713b2c851c85e249e4b55b4436c4092b4f9b239059750fa6c83507385352d92b78c943c5d8117537904b928c864c13c5b83fef1b24ae150190e7

data/.rubocop/custom.yml

@@ -53,5 +53,33 @@ RSpec/MultipleExpectations:
   Enabled: false
 RSpec/ExampleLength:
   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,8 +1,9 @@
 PATH
   remote: .
   specs:
-    sul_orcid_client (0.1.0)
+    sul_orcid_client (0.3.0)
       activesupport (>= 4.2, < 8)
+      cocina-models (~> 0.90)
       faraday
       faraday-retry
       oauth2
@@ -19,12 +20,54 @@ GEM
     addressable (2.8.4)
       public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
+    attr_extras (7.1.0)
     byebug (11.1.3)
+    cocina-models (0.90.0)
+      activesupport
+      deprecation
+      dry-struct (~> 1.0)
+      dry-types (~> 1.1)
+      edtf
+      equivalent-xml
+      jsonpath
+      nokogiri
+      openapi3_parser
+      openapi_parser (>= 0.11.1, < 1.0)
+      rss
+      super_diff
+      thor
+      zeitwerk (~> 2.1)
+    commonmarker (0.23.9)
     concurrent-ruby (1.2.2)
     crack (0.4.5)
       rexml
+    deprecation (1.1.0)
+      activesupport
     diff-lcs (1.5.0)
     docile (1.4.0)
+    dry-core (1.0.0)
+      concurrent-ruby (~> 1.0)
+      zeitwerk (~> 2.6)
+    dry-inflector (1.0.0)
+    dry-logic (1.5.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0, < 2)
+      zeitwerk (~> 2.6)
+    dry-struct (1.6.0)
+      dry-core (~> 1.0, < 2)
+      dry-types (>= 1.7, < 2)
+      ice_nine (~> 0.11)
+      zeitwerk (~> 2.6)
+    dry-types (1.7.1)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0)
+      dry-inflector (~> 1.0)
+      dry-logic (~> 1.4)
+      zeitwerk (~> 2.6)
+    edtf (3.1.1)
+      activesupport (>= 3.0, < 8.0)
+    equivalent-xml (0.6.0)
+      nokogiri (>= 1.4.3)
     faraday (2.7.10)
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
@@ -35,12 +78,20 @@ GEM
     hashie (5.0.0)
     i18n (1.14.1)
       concurrent-ruby (~> 1.0)
+    ice_nine (0.11.2)
     json (2.6.3)
+    jsonpath (1.1.3)
+      multi_json
     jwt (2.7.1)
     language_server-protocol (3.17.0.3)
     lint_roller (1.1.0)
     minitest (5.18.1)
+    multi_json (1.15.0)
     multi_xml (0.6.0)
+    nokogiri (1.15.3-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.15.3-x86_64-linux)
+      racc (~> 1.4)
     oauth2 (2.0.9)
       faraday (>= 0.17.3, < 3.0)
       jwt (>= 1.0, < 3.0)
@@ -48,10 +99,16 @@ GEM
       rack (>= 1.2, < 4)
       snaky_hash (~> 2.0)
       version_gem (~> 1.1)
+    openapi3_parser (0.9.2)
+      commonmarker (~> 0.17)
+    openapi_parser (0.15.0)
+    optimist (3.0.1)
     parallel (1.23.0)
     parser (3.2.2.3)
       ast (~> 2.4.1)
       racc
+    patience_diff (1.2.0)
+      optimist (~> 3.0)
     public_suffix (5.0.3)
     racc (1.7.1)
     rack (3.0.8)
@@ -72,6 +129,8 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.1)
+    rss (0.2.9)
+      rexml
     rubocop (1.52.1)
       json (~> 2.3)
       parallel (~> 1.10)
@@ -106,17 +165,23 @@ 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)
+    standard-custom (1.0.2)
       lint_roller (~> 1.0)
+      rubocop (~> 1.50)
     standard-performance (1.1.1)
       lint_roller (~> 1.1)
       rubocop-performance (~> 1.18.0)
+    super_diff (0.10.0)
+      attr_extras (>= 6.2.4)
+      diff-lcs
+      patience_diff
+    thor (1.2.2)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.4.2)
@@ -138,7 +203,7 @@ DEPENDENCIES
   rspec (~> 3.0)
   rubocop-rspec
   simplecov
-  standard (~> 1.29.0)
+  standard
   sul_orcid_client!
   vcr
   webmock

data/README.md

@@ -1,8 +1,12 @@
 [![Gem Version](https://badge.fury.io/rb/sul_orcid_client.svg)](https://badge.fury.io/rb/sul_orcid_client)
 [![CircleCI](https://dl.circleci.com/status-badge/img/gh/sul-dlss/orcid_client/tree/main.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/sul-dlss/orcid_client/tree/main)
+[![Maintainability](https://api.codeclimate.com/v1/badges/5f53521299eeec2f9346/maintainability)](https://codeclimate.com/github/sul-dlss/orcid_client/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/5f53521299eeec2f9346/test_coverage)](https://codeclimate.com/github/sul-dlss/orcid_client/test_coverage)
 
-# sul_orcid_client
-API client for accessing ORCID API.
+# orcid_client
+API client for accessing ORCID API and for mapping to ORCID works.
+
+Note: the *gem* name is `sul_orcid_client`;  the git repo's name is `orcid_client`.
 
 ## Installation
 

data/lib/sul_orcid_client/cocina_support.rb

@@ -0,0 +1,27 @@
+class SulOrcidClient
+  # Helper methods for working with Orcid in Cocina
+  class CocinaSupport
+    # @param [Cocina::Models::Contributor] contributor to check
+    # @return [Boolean] true unless the contributor has a citation status of false
+    def self.cited?(contributor)
+      contributor.note.none? { |note| note.type == "citation status" && note.value == "false" }
+    end
+
+    # @param [Cocina::Models::Contributor] contributor to check
+    # @return [String, nil] orcid id including host if present
+    def self.orcidid(contributor)
+      identifier = contributor.identifier.find { |identifier| identifier.type == "ORCID" }
+      return unless identifier
+
+      URI.join(identifier.source.uri, identifier.value).to_s
+    end
+
+    # @param [Cocina::Models::Description] description containing contributors to check
+    # @return [Array<String>] orcid ids including host if present
+    # Note that non-cited contributors are excluded.
+    def self.cited_orcidids(description)
+      cited_contributors = description.contributor.select { |contributor| cited?(contributor) }
+      cited_contributors.map { |contributor| orcidid(contributor) }.compact
+    end
+  end
+end

data/lib/sul_orcid_client/contributor_mapper.rb

@@ -0,0 +1,85 @@
+class SulOrcidClient
+  # Maps a Cocina Contributor to an Orcid Contributor.
+
+  class ContributorMapper
+    def self.map(contributor:)
+      new(contributor: contributor).map
+    end
+
+    # @param [Cocina::Models::Contributor] contributor to map
+    def initialize(contributor:)
+      @contributor = contributor
+    end
+
+    def map
+      return unless CocinaSupport.cited?(contributor)
+
+      {
+        "credit-name": map_credit_name,
+        "contributor-orcid": map_orcid,
+        "contributor-attributes": map_attributes
+      }.compact
+    end
+
+    private
+
+    attr_reader :contributor
+
+    def map_credit_name
+      value = if contributor.name.first&.structuredValue.present?
+        name_from_structured_value(contributor.name.first.structuredValue)
+      else
+        contributor.name.first&.value
+      end
+
+      return unless value
+
+      {
+        value: value
+      }
+    end
+
+    def name_from_structured_value(structured_value)
+      forename = structured_value.find { |name_part| name_part.type == "forename" }&.value
+      surname = structured_value.find { |name_part| name_part.type == "surname" }&.value
+      [forename, surname].join(" ")
+    end
+
+    def map_orcid
+      identifier = contributor.identifier.find { |identifier| ["ORCID", "ROR"].include?(identifier.type) }
+
+      return unless identifier
+
+      {
+        uri: URI.join(identifier.source.uri, identifier.value).to_s,
+        path: identifier.value,
+        host: (identifier.type == "ORCID") ? "orcid.org" : "ror.org"
+      }
+    end
+
+    def map_attributes
+      {
+        "contributor-role": map_role
+      }.compact.presence
+    end
+
+    MARC_RELATOR_MAP = {
+      "aut" => "author",
+      "cmp" => "author",
+      "ctb" => "author",
+      "cre" => "author",
+      "edt" => "editor",
+      "rth" => "principal-investigator"
+    }
+
+    def map_role
+      role = contributor.role.find do |role|
+        role.source&.code == "marcrelator" && MARC_RELATOR_MAP.key?(role.code)
+      end
+
+      return unless role
+
+      MARC_RELATOR_MAP[role.code]
+    end
+  end
+end

data/lib/sul_orcid_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class SulOrcidClient
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
 end

data/lib/sul_orcid_client/work_mapper.rb

@@ -0,0 +1,176 @@
+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.
+  class WorkMapper
+    # Error raised by WorkMapper
+    class WorkMapperError < StandardError; end
+
+    def self.map(description:, doi: nil)
+      new(description: description, doi: doi).map
+    end
+
+    # @param [Cocina::Models::Description] description to map
+    # @param [String] doi from identification.doi
+    def initialize(description:, doi: nil)
+      @description = description
+      @doi = doi
+    end
+
+    def map
+      {
+        title: map_title,
+        "short-description": map_short_description,
+        citation: map_citation,
+        type: map_type,
+        "publication-date": map_publication_date,
+        "external-ids": map_external_ids,
+        url: description.purl,
+        contributors: map_contributors,
+        "language-code": "en",
+        country: {
+          value: "US"
+        }
+      }.compact
+    end
+
+    private
+
+    attr_reader :description, :doi
+
+    def map_title
+      title = description.title.first&.value
+      raise WorkMapperError, "Title not mapped" unless title
+
+      {
+        title: {
+          value: title.truncate(500) # ORCID has a max length for this field
+        }
+      }
+    end
+
+    def map_short_description
+      description.note.find { |note| note.type == "abstract" }&.value
+    end
+
+    def map_citation
+      citation = description.note.find { |note| note.type == "preferred citation" }&.value
+      return unless citation
+
+      {
+        "citation-type": "formatted-unspecified",
+        "citation-value": citation
+      }
+    end
+
+    def map_external_ids
+      {"external-id":
+        [
+          map_external_id("uri", description.purl, description.purl)
+        ].tap do |ids|
+          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": {
+          value: url
+        },
+        "external-id-relationship": "self"
+      }
+    end
+
+    def map_publication_date
+      date = event_value("publication") || event_value("deposit")
+      return unless date
+
+      year, month, day = parse_date(date)
+      return unless year
+
+      {
+        year: {
+          value: year
+        }
+      }.tap do |publication_date|
+        publication_date[:month] = {value: month} if month
+        publication_date[:day] = {value: day} if month && day
+      end
+    end
+
+    def parse_date(date)
+      matcher = date.match(/(\d{4})-?(\d{2})?-?(\d{2})?/)
+      return [nil, nil, nil] unless matcher
+
+      matcher[1..3]
+    end
+
+    def event_value(type)
+      description&.event&.find { |event| event.type == type }&.date&.first&.value
+    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"
+    }
+
+    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
+
+      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
+      matching_term = (subtype_terms + [type_term]).find { |term| H2_TERM_MAP.key?(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
+      return unless contributors
+      {
+        contributor: contributors
+      }
+    end
+  end
+end

data/lib/sul_orcid_client.rb

@@ -33,7 +33,7 @@ class SulOrcidClient
       self
     end
 
-    delegate :fetch_works, :fetch_work, :fetch_name, :search, :add_work, :delete_work, to: :instance
+    delegate :fetch_works, :fetch_work, :fetch_name, :search, :add_work, :update_work, :delete_work, to: :instance
   end
 
   attr_accessor :base_url, :base_public_url, :base_auth_url, :client_id, :client_secret
@@ -124,6 +124,22 @@ class SulOrcidClient
     end
   end
 
+  # Update an existing work for a researcher.
+  # @param [String] orcidid an ORCiD ID for the researcher
+  # @param [Hash] work a work in correct data structure for ORCID work
+  # @param [String] token an ORCiD API access token
+  # @param [String] put_code the PUT code
+  # @return [Boolean] true if update succeeded
+  # @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")
+
+    raise "ORCID.org API returned #{response.status} when updating #{put_code} for #{orcidid}" unless response.status == 200
+    true
+  end
+
   # Delete a work
   # @param [string] ORCID ID for the researcher
   # @param [string] put-code

data/sul_orcid_client.gemspec

@@ -32,6 +32,7 @@ Gem::Specification.new do |spec|
   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"
@@ -41,7 +42,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rubocop-rspec"
   spec.add_development_dependency "simplecov"
-  spec.add_development_dependency "standard", "~> 1.29.0" # Pinning until https://github.com/standardrb/standard-custom/pull/5
+  spec.add_development_dependency "standard"
   spec.add_development_dependency "vcr"
   spec.add_development_dependency "webmock"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sul_orcid_client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Peter Mangiafico
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-13 00:00:00.000000000 Z
+date: 2023-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -31,6 +31,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '8'
+- !ruby/object:Gem::Dependency
+  name: cocina-models
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.90'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.90'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -147,16 +161,16 @@ dependencies:
   name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.29.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.29.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -203,7 +217,10 @@ files:
 - README.md
 - Rakefile
 - lib/sul_orcid_client.rb
+- lib/sul_orcid_client/cocina_support.rb
+- lib/sul_orcid_client/contributor_mapper.rb
 - lib/sul_orcid_client/version.rb
+- lib/sul_orcid_client/work_mapper.rb
 - sul_orcid_client.gemspec
 homepage: https://github.com/sul-dlss/sul_orcid_client
 licenses: []