relaton-doi 1.14.2 → 1.14.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d39addcfe400051b6cfadb759265bee674ace775bff92dab29a1c7f80891cd48
-  data.tar.gz: e24fa98bbfbff44bcb9b6b200c79750fe2f72ece457f67162a62324742a56cee
+  metadata.gz: 4184d182bd51c7b61a50ae43d52bd95ddd73024defb5ca8ee96641ca7ae4b13b
+  data.tar.gz: 519e7864a1ddea5cc3a74569848e08ba0951d61877b0e9c9262c76b69afb46c5
 SHA512:
-  metadata.gz: 33bf3eabe2d1786be51d05960ad0aff732dc3ebceed3bde02979cb6e01790c2c2f65f221ca5d1f1567b73be3b28ceab9bb2ec4b8303e7165881a7c9d88b3f9ae
-  data.tar.gz: d3e180ade463b3e94785c271dd795b440b645426cecf914a6684b67eadd2313b22155eb31860d4602407c38e8266b031c962cd7affad9947c98361553109a4c8
+  metadata.gz: b544c06393cd74c073cc1c815e12646ef8d06b3f6fcbee464547d21416617d707ea33ffd370bb69c0aba94d6feda816bc78fa0cb36bc7ac5960ed90e5bc4304f
+  data.tar.gz: bd11ec0a75b525c6d34a0b922a1a2b64784a2944f3fd8e49f5756493160b25a7da7078c70ac2b853f7bf8a19ec3e941eb3597327293ccdca6a74429140bb2f55

data/.github/workflows/rake.yml

@@ -5,6 +5,7 @@ name: rake
 on:
   push:
     branches: [ master, main ]
+    tags: [ v* ]
   pull_request:
 
 jobs:

data/.github/workflows/release.yml

@@ -10,8 +10,9 @@ on:
           Next release version. Possible values: x.y.z, major, minor, patch or pre|rc|etc
         required: true
         default: 'skip'
-  push:
-    tags: [ v* ]
+  repository_dispatch:
+    types: [ do-release ]
+
 
 jobs:
   release:

data/.gitignore

@@ -6,6 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+/vendor/
 
 # rspec failure tracking
 .rspec_status

data/.rubocop.yml

@@ -7,6 +7,6 @@ require: rubocop-rails
 inherit_from:
   - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 2.7
 Rails:
   Enabled: false

data/Gemfile

@@ -5,8 +5,13 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in relaton-doi.gemspec
 gemspec
 
+gem "debug"
+gem "equivalent-xml", "~> 0.6"
 gem "rake", "~> 13.0"
-
 gem "rspec", "~> 3.0"
-
 gem "rubocop", "~> 1.7"
+gem "rubocop-performance"
+gem "rubocop-rails"
+gem "simplecov"
+gem "vcr"
+gem "webmock"

data/lib/relaton_doi/crossref.rb

@@ -1,53 +1,6 @@
 module RelatonDoi
-  class Crossref
-    TYPES = {
-      "book-chapter" => "inbook",
-      "book-part" => "inbook",
-      "book-section" => "inbook",
-      "book-series" => "book",
-      "book-set" => "book",
-      "book-track" => "inbook",
-      "component" => "misc",
-      "database" => "dataset",
-      "dissertation" => "thesis",
-      "edited-book" => "book",
-      "grant" => "misc",
-      "journal-article" => "article",
-      "journal-issue" => "journal",
-      "journal-volume" => "journal",
-      "monograph" => "book",
-      "other" => "misc",
-      "peer-review" => "article",
-      "posted-content" => "social_media",
-      "proceedings-article" => "inproceedings",
-      "proceedings-series" => "proceedings",
-      "reference-book" => "book",
-      "reference-entry" => "inbook",
-      "report-component" => "techreport",
-      "report-series" => "techreport",
-      "report" => "techreport",
-    }.freeze
-
-    REALATION_TYPES = {
-      "is-preprint-of" => "reprintOf",
-      "is-review-of" => "reviewOf",
-      "has-review" => "hasReview",
-      "is-identical-to" => "identicalTo", # ?
-      "is-supplement-to" => "complements",
-    }.freeze
-
-    #
-    # Get a document by DOI from the CrossRef API.
-    #
-    # @param [String] doi The DOI.
-    #
-    # @return [RelatonBib::BibliographicItem, RelatonIetf::IetfBibliographicItem,
-    #   RelatonBipm::BipmBibliographicItem, RelatonIeee::IeeeBibliographicItem,
-    #   RelatonNist::NistBibliographicItem] The bibitem.
-    #
-    def self.get(doi)
-      new.get doi
-    end
+  module Crossref
+    extend self
 
     #
     # Get a document by DOI from the CrossRef API.
@@ -61,387 +14,21 @@ module RelatonDoi
     def get(doi)
       warn "[relaton-doi] [\"#{doi}\"] fetching..."
       id = doi.sub(%r{^doi:}, "")
-      resp = Serrano.works ids: id
-      @message = resp[0]["message"]
-      warn "[relaton-doi] [\"#{doi}\"] found #{@message['DOI']}"
-      create_bibitem @message["DOI"], bibitem_hash
-    end
-
-    #
-    # Create a bibitem from the bibitem hash.
-    #
-    # @param [String] doi The DOI.
-    # @param [Hash] bibitem The bibitem hash.
-    #
-    # @return [RelatonBib::BibliographicItem, RelatonIetf::IetfBibliographicItem,
-    #   RelatonBipm::BipmBibliographicItem, RelatonIeee::IeeeBibliographicItem,
-    #   RelatonNist::NistBibliographicItem] The bibitem.
-    #
-    # @raise [RelatonDoi::Error] if the document type is not supported.
-    #
-    def create_bibitem(doi, bibitem) # rubocop:disable Metrics/CyclomaticComplexity
-      # case @message["institution"]&.first&.fetch("acronym")&.first
-      case doi
-      when /\/nist/ then RelatonNist::NistBibliographicItem.new(**bibitem)
-      when /\/rfc\d+/ then RelatonIetf::IetfBibliographicItem.new(**bibitem)
-      when /\/0026-1394\// then RelatonBipm::BipmBibliographicItem.new(**bibitem)
-      # when "ISO" then RelatonIso::IsoBibliographicItem.new(**bibitem)
-      # when "W3C" then RelatonW3c::W3cBibliographicItem.new(**bibitem)
-      when /\/ieee/ then RelatonIeee::IeeeBibliographicItem.new(**bibitem)
-      else RelatonBib::BibliographicItem.new(**bibitem)
-      end
-    end
-
-    #
-    # Create a bibitem hash from the message hash.
-    #
-    # @return [Hash] The bibitem hash.
-    #
-    def bibitem_hash # rubocop:disable Metrics/MethodLength
-      {
-        type: parse_type,
-        fetched: Date.today.to_s,
-        title: create_title,
-        docid: create_docid,
-        date: create_date,
-        link: create_link,
-        abstract: create_abstract,
-        contributor: create_contributors,
-        doctype: @message["type"],
-        place: create_place,
-        relation: create_relation,
-        extent: create_extent,
-        series: create_series,
-      }
-    end
-
-    #
-    # Parse the document type.
-    #
-    # @return [String] The document type.
-    #
-    def parse_type
-      TYPES[@message["type"]] || @message["type"]
-    end
-
-    #
-    # Create a title and a subtitle from the message hash.
-    #
-    # @return [Array<RelatonBib::TypedTitleString>] The title and subtitle.
-    #
-    def create_title
-      @message["title"].map do |t|
-        RelatonBib::TypedTitleString.new(
-          type: "main", content: t, language: "en", script: "Latn",
-        )
-      end + @message["subtitle"].map do |t|
-        RelatonBib::TypedTitleString.new(
-          type: "subtitle", content: t, language: "en", script: "Latn",
-        )
-      end
-    end
-
-    #
-    # Create a docid from the message hash.
-    #
-    # @return [Array<RelatonBib::DocumentIdentifier>] The docid.
-    #
-    def create_docid
-      %w[DOI ISBN].each_with_object([]) do |type, obj|
-        id = @message[type].is_a?(Array) ? @message[type].first : @message[type]
-        next unless id
-
-        primary = type == "DOI"
-        obj << RelatonBib::DocumentIdentifier.new(type: type, id: id, primary: primary)
-      end
+      message = get_by_id id
+      warn "[relaton-doi] [\"#{doi}\"] found #{message['DOI']}"
+      Parser.parse message
     end
 
     #
-    # Create dates from the message hash.
-    #
-    # @return [Array<RelatonBib::BibliographicDate>] The dates.
-    #
-    def create_date
-      %w[created issued published approved].each_with_object([]) do |type, obj|
-        next unless @message[type]
-
-        on = @message[type]["date-parts"][0].map { |d| d.to_s.rjust(2, "0") }.join "-"
-        obj << RelatonBib::BibliographicDate.new(type: type, on: on)
-      end
-    end
-
-    #
-    # Create a link from the message hash.
-    #
-    # @return [Array<RelatonBib::TypedUri>] The link.
-    #
-    def create_link
-      links = []
-      if @message["URL"]
-        links << RelatonBib::TypedUri.new(type: "DOI", content: @message["URL"])
-      end
-      return links unless @message["link"]&.any?
-
-      link = @message["link"].first
-      if link["URL"].match?(/\.pdf$/)
-        links << RelatonBib::TypedUri.new(type: "pdf", content: link["URL"])
-      end
-      links
-    end
-
-    #
-    # Create an abstract from the message hash.
-    #
-    # @return [Array<RelatonBib::FormattedString>] The abstract.
-    #
-    def create_abstract
-      return [] unless @message["abstract"]
-
-      content = @message["abstract"]
-      abstract = RelatonBib::FormattedString.new(
-        content: content, language: "en", script: "Latn", format: "text/html",
-      )
-      [abstract]
-    end
-
-    #
-    # Create contributors from the message hash.
-    #
-    # @return [Array<RelatonBib::ContributionInfo>] The contributors.
-    #
-    def create_contributors # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
-      contribs = %w[author editor translator].each_with_object([]) do |type, obj|
-        @message[type]&.each do |contrib|
-          obj << contributor(person(contrib), type)
-        end
-      end
-      contribs << contributor(org_publisher, "publisher")
-    end
-
-    #
-    # Cerate an organization publisher from the message hash.
-    #
-    # @return [RelatonBib::Organization] The organization.
-    #
-    def org_publisher
-      pbr = @message["institution"]&.detect do |i|
-        @message["publisher"].include?(i["name"]) ||
-          i["name"].include?(@message["publisher"])
-      end
-      a = pbr["acronym"]&.first if pbr
-      RelatonBib::Organization.new name: @message["publisher"], abbreviation: a
-    end
-
-    #
-    # Create contributor from an entity and a role type.
-    #
-    # @param [RelatonBib::Person, RelatonBib::Organization] entity The entity.
-    # @param [String] type The role type.
-    #
-    # @return [RelatonBib::ContributionInfo] The contributor.
-    #
-    def contributor(entity, type)
-      RelatonBib::ContributionInfo.new(entity: entity, role: [type: type])
-    end
-
-    #
-    # Create a person from a person hash.
-    #
-    # @param [Hash] person The person hash.
-    #
-    # @return [RelatonBib::Person] The person.
-    #
-    def person(person)
-      RelatonBib::Person.new(
-        name: person_name(person), affiliation: affiliation(person),
-        identifier: person_id(person)
-      )
-    end
-
-    #
-    # Create person affiliations from a person hash.
-    #
-    # @param [Hash] person The person hash.
-    #
-    # @return [Array<RelatonBib::Affiliation>] The affiliations.
-    #
-    def affiliation(person)
-      (person["affiliation"] || []).map do |a|
-        org = RelatonBib::Organization.new(name: a["name"])
-        RelatonBib::Affiliation.new organization: org
-      end
-    end
-
-    #
-    # Create a person full name from a person hash.
-    #
-    # @param [Hash] person The person hash.
-    #
-    # @return [RelatonBib::FullName] The full name.
-    #
-    def person_name(person)
-      sn = RelatonBib::LocalizedString.new(person["family"], "en", "Latn")
-      RelatonBib::FullName.new(
-        surname: sn, forename: forename(person), addition: nameaddition(person),
-        completename: completename(person), prefix: nameprefix(person)
-      )
-    end
-
-    #
-    # Create a person name prefix from a person hash.
-    #
-    # @param [Hash] person The person hash.
-    #
-    # @return [Array<RelatonBib::LocalizedString>] The name prefix.
-    #
-    def nameprefix(person)
-      return [] unless person["prefix"]
-
-      [RelatonBib::LocalizedString.new(person["prefix"], "en", "Latn")]
-    end
-
-    #
-    # Create a complete name from a person hash.
-    #
-    # @param [Hash] person The person hash.
-    #
-    # @return [RelatonBib::LocalizedString] The complete name.
-    #
-    def completename(person)
-      return unless person["name"]
-
-      RelatonBib::LocalizedString.new(person["name"], "en", "Latn")
-    end
-
-    #
-    # Create a forename from a person hash.
-    #
-    # @param [Hash] person The person hash.
-    #
-    # @return [Array<RelatonBib::LocalizedString>] The forename.
-    #
-    def forename(person)
-      return [] unless person["given"]
-
-      [RelatonBib::Forename.new(content: person["given"], language: "en", script: "Latn")]
-    end
-
-    #
-    # Create an addition from a person hash.
-    #
-    # @param [Hash] person The person hash.
-    #
-    # @return [Array<RelatonBib::LocalizedString>] The addition.
-    #
-    def nameaddition(person)
-      return [] unless person["suffix"]
-
-      [RelatonBib::LocalizedString.new(person["suffix"], "en", "Latn")]
-    end
-
-    #
-    # Create a person identifier from a person hash.
-    #
-    # @param [Hash] person The person hash.
-    #
-    # @return [Array<RelatonBib::PersonIdentifier>] The person identifier.
-    #
-    def person_id(person)
-      return [] unless person["ORCID"]
-
-      [RelatonBib::PersonIdentifier.new("orcid", person["ORCID"])]
-    end
-
-    #
-    # Create a place from the message hash.
-    #
-    # @return [Array<RelatonBib::Place>] The place.
-    #
-    def create_place
-      return [] unless @message["publisher-location"]
-
-      city, rg = @message["publisher-location"].split(", ")
-      region = RelatonBib::Place::RegionType.new(name: rg)
-      [RelatonBib::Place.new(city: city, region: [region])]
-    end
-
-    #
-    # Crerate relations from the message hash.
-    #
-    # @return [Array<RelatonBib::DocumentRelation>] The relations.
-    #
-    def create_relation # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-      rels = []
-      @message["container-title"]&.each do |ct|
-        contrib = included_in_editors(ct)
-        bib = RelatonBib::BibliographicItem.new(title: [content: ct], contributor: contrib)
-        rels << RelatonBib::DocumentRelation.new(type: "includedIn", bibitem: bib)
-      end
-      @message["relation"].each_with_object(rels) do |(k, v), a|
-        fref = RelatonBib::FormattedRef.new(content: v["id"])
-        bib = create_bibitem v["id"], formattedref: fref
-        type = REALATION_TYPES[k] || k
-        a << RelatonBib::DocumentRelation.new(type: type, bibitem: bib)
-      end
-    end
-
-    #
-    # Fetch included in editors.
-    #
-    # @param [String] title container-title
-    #
-    # @return [Array<RelatonBib::ContributionInfo>] The editors contribution info.
-    #
-    def included_in_editors(title)
-      item = fetch_included_in title
-      return [] unless item
-
-      item["editor"].map { |e| contributor(person(e), "editor") }
-    end
-
-    #
-    # Fetch included in relation.
-    #
-    # @param [String] title container-title
-    #
-    # @return [Hash] The included in relation item.
-    #
-    def fetch_included_in(title) # rubocop:disable Metrics/AbcSize
-      year = (@message["published"] || @message["approved"])["date-parts"][0][0]
-      query = "#{title}, #{@message['publisher']}, #{@message['publisher-location']}, #{year}"
-      resp = Faraday.get %{http://api.crossref.org/works?query.bibliographic="#{query}"&rows=5&filter=type:book}
-      json = JSON.parse resp.body
-      json["message"]["items"].detect { |i| i["title"].include?(title) && i["editor"] }
-    end
-
-    #
-    # Create an extent from the message hash.
-    #
-    # @return [Array<RelatonBib::Locality>] The extent.
-    #
-    def create_extent # rubocop:disable Metrics/AbcSize
-      extent = []
-      extent << RelatonBib::Locality.new("volume", @message["volume"]) if @message["volume"]
-      extent << RelatonBib::Locality.new("issue", @message["issue"]) if @message["issue"]
-      if @message["page"]
-        from, to = @message["page"].split("-")
-        extent << RelatonBib::Locality.new("page", from, to)
-      end
-      extent.any? ? [RelatonBib::LocalityStack.new(extent)] : []
-    end
-
+    # Get a document by DOI from the CrossRef API.
     #
-    # Create a series from the message hash.
+    # @param [String] id The DOI.
     #
-    # @return [Arrey<RelatonBib::Series>] The series.
+    # @return [Hash] The document.
     #
-    def create_series
-      return [] unless @message["container-title"]
-
-      @message["container-title"].map do |ct|
-        title = RelatonBib::TypedTitleString.new content: ct
-        RelatonBib::Series.new title: title
-      end
+    def get_by_id(id)
+      resp = Serrano.works ids: id
+      resp[0]["message"]
     end
   end
 end