commonmeta-ruby 3.2.15 → 3.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43a78bfc4b2f9b77c966597e4593cdfef5f6b3fffc493857b99e224ff94fb70b
-  data.tar.gz: 7b95a16aa8de6c5f7ce04352966e0855be5a174175514f77fe9ac82efc85d605
+  metadata.gz: 1a5ad35cfa39e4b1aadd232585375001d87f0a14c5f5638b6574c6982bb130a6
+  data.tar.gz: d7104f032539d68ee797c35e6f86d69fd8514691babec286ab3024fa49bac0cf
 SHA512:
-  metadata.gz: cf12683197ddff178718725b72976b1b2fecef23c2bafff50f9c81b9c29b2da67554937830d60b9860d59d9294d5cd7ccd0e86d15633948758896abf3a8827c5
-  data.tar.gz: e357c0d3871e0fd53e2371e792c487f2ba8895bb789982bddef496830d5aea08f0c571f209d8bcaf0f99365ec245eaf38621d7ad4230a548ab3e6f6ca1a7d7fe
+  metadata.gz: 86c9391a579504409de79cd3a2d449a7725a0b46014cde46e5ef5506b51e0595f5aa4a2404ac49fca20c8d8673b8b895234127e42ddf9314dd52214a7bdb9973
+  data.tar.gz: 26d1153f74db838c65c99b5229f2031c0ddb90b907fc3f7f51210bd177cf78e8417814437284378e38a86fb829bf36ccb1c6d5b3a7ac6d35678d870fac918e93

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    commonmeta-ruby (3.2.15)
+    commonmeta-ruby (3.3.1)
       activesupport (>= 4.2.5, < 8.0)
       addressable (~> 2.8.1, < 2.8.2)
       base32-url (>= 0.7.0, < 1)

data/bin/commonmeta

@@ -2,7 +2,7 @@
 
 require File.expand_path("../../lib/commonmeta", __FILE__)
 
-if (ARGV & %w(--version -v help --help encode decode encode_id decode_id json_feed_not_indexed json_feed_unregistered json_feed_by_blog)).empty?
+if (ARGV & %w(--version -v help --help encode decode encode_id decode_id encode_by_blog encode_by_uuid json_feed_not_indexed json_feed_unregistered json_feed_by_blog)).empty?
   Commonmeta::CLI.start(ARGV.dup.unshift("convert"))
 else
   Commonmeta::CLI.start

data/lib/commonmeta/author_utils.rb

@@ -41,7 +41,7 @@ module Commonmeta
       elsif id.nil? && author['ORCID'].present?
         id = author.fetch('ORCID')
       end
-      id = normalize_orcid(id)
+      id = normalize_orcid(id) || normalize_ror(id)
 
       # parse author type, i.e. "Person", "Organization" or not specified
       type = author.fetch('type', nil)

data/lib/commonmeta/cli.rb

@@ -59,6 +59,7 @@ module Commonmeta
     desc "", "encode"
 
     def encode(prefix)
+      return nil unless prefix.present?
       puts encode_doi(prefix)
     end
 
@@ -68,6 +69,22 @@ module Commonmeta
       puts encode_container_id
     end
 
+    desc "", "encode_by_blog"
+
+    def encode_by_blog(blog_id)
+      prefix = get_doi_prefix_by_blog_id(blog_id)
+      return nil unless prefix.present?
+      puts encode_doi(prefix)
+    end
+
+    desc "", "encode_by_uuid"
+
+    def encode_by_uuid(uuid)
+      prefix = get_doi_prefix_by_json_feed_item_uuid(uuid)
+      return nil unless prefix.present?
+      puts encode_doi(prefix)
+    end
+
     desc "", "decode"
 
     def decode(doi)

data/lib/commonmeta/crossref_utils.rb

@@ -94,25 +94,67 @@ module Commonmeta
 
     def insert_crossref_creators(xml)
       xml.contributors do
-        Array.wrap(creators).each_with_index do |person, index|
-          xml.person_name("contributor_role" => "author",
-                          "sequence" => index.zero? ? "first" : "additional") do
-            insert_crossref_person(xml, person)
+        Array.wrap(creators).each_with_index do |creator, index|
+          if creator["type"] == "Organization"
+            xml.organization("contributor_role" => "author",
+                             "sequence" => index.zero? ? "first" : "additional") do
+              insert_crossref_organization(xml, creator)
+            end
+          elsif creator["givenName"].present? || creator["familyName"].present?
+            xml.person_name("contributor_role" => "author",
+                            "sequence" => index.zero? ? "first" : "additional") do
+              insert_crossref_person(xml, creator)
+            end
+          else
+            xml.unknown("contributor_role" => "author",
+                        "sequence" => index.zero? ? "first" : "additional") do
+              insert_crossref_anonymous(xml, creator)
+            end
+          end
+        end
+      end
+    end
+
+    def insert_crossref_person(xml, creator)
+      xml.given_name(creator["givenName"]) if creator["givenName"].present?
+      xml.surname(creator["familyName"]) if creator["familyName"].present?
+      if creator.dig("id") && URI.parse(creator.dig("id")).host == "orcid.org"
+        xml.ORCID(creator.dig("id"))
+      end
+      if creator["affiliation"].present?
+        xml.affiliations do
+          xml.institution do
+            xml.institution_name(creator.dig("affiliation", 0, "name")) if creator.dig("affiliation", 0, "name").present?
+            xml.institution_id(creator.dig("affiliation", 0, "affiliationIdentifier"), "type" => creator.dig("affiliation", 0, "affiliationIdentifierScheme")) if creator.dig("affiliation", 0, "affiliationIdentifier").present?
           end
         end
       end
     end
 
-    def insert_crossref_person(xml, person)
-      xml.given_name(person["givenName"]) if person["givenName"].present?
-      xml.surname(person["familyName"]) if person["familyName"].present?
-      if person.dig("id") && URI.parse(person.dig("id")).host == "orcid.org"
-        xml.ORCID(person.dig("id"))
+    def insert_crossref_organization(xml, creator)
+      xml.name(creator["name"]) if creator["name"].present?
+      if creator["affiliation"].present?
+        xml.affiliations do
+          xml.institution do
+            xml.institution_name(creator.dig("affiliation", 0, "name")) if creator.dig("affiliation", 0, "name").present?
+            xml.institution_id(creator.dig("affiliation", 0, "affiliationIdentifier"), "type" => creator.dig("affiliation", 0, "affiliationIdentifierScheme")) if creator.dig("affiliation", 0, "affiliationIdentifier").present?
+          end
+        end
       end
-      Array.wrap(person["affiliation"]).each do |affiliation|
-        attributes = { "affiliationIdentifier" => affiliation["affiliationIdentifier"],
-                       "affiliationIdentifierScheme" => affiliation["affiliationIdentifierScheme"], "schemeURI" => affiliation["schemeUri"] }.compact
-        xml.affiliation(affiliation["name"], attributes)
+    end
+
+    def insert_crossref_anonymous(xml, creator)
+      if person["affiliation"].present?
+        xml.anonymous do
+          xml.affiliations do
+            xml.institution do
+              xml.institution_name(creator.dig("affiliation", 0, "name")) if creator.dig("affiliation", 0, "name").present?
+              xml.institution_id(creator.dig("affiliation", 0, "affiliationIdentifier"), "type" => creator.dig("affiliation", 0, "affiliationIdentifierScheme")) if creator.dig("affiliation", 0, "affiliationIdentifier").present?
+            end
+          end
+        end
+      else
+        xml.anonymous
       end
     end
 
@@ -265,7 +307,7 @@ module Commonmeta
         }.compact
 
         # strip hyphen from UUIDs, as item_number can only be 32 characters long (UUIDv4 is 36 characters long)
-        alternate_identifier["alternateIdentifier"] = alternate_identifier["alternateIdentifier"].gsub('-','') if alternate_identifier["alternateIdentifierType"] == "UUID"
+        alternate_identifier["alternateIdentifier"] = alternate_identifier["alternateIdentifier"].gsub("-", "") if alternate_identifier["alternateIdentifierType"] == "UUID"
 
         xml.item_number(alternate_identifier["alternateIdentifier"], attributes)
       end

data/lib/commonmeta/readers/json_feed_reader.rb

@@ -20,8 +20,10 @@ module Commonmeta
 
         meta = string.present? ? JSON.parse(string) : {}
 
-        id = options[:doi] ? normalize_doi(options[:doi]) : normalize_id(meta.fetch("id", nil))
         url = normalize_url(meta.fetch("url", nil))
+        id = options[:doi] ? normalize_doi(options[:doi]) : normalize_id(meta.fetch("id", nil))
+        id = url if id.blank? && url.present?
+
         type = "Article"
         creators = if meta.fetch("authors", nil).present?
             get_authors(from_json_feed(Array.wrap(meta.fetch("authors"))))
@@ -124,6 +126,28 @@ module Commonmeta
         blog = JSON.parse(response.body.to_s)
         blog["items"].map { |item| item["uuid"] }.first
       end
+
+      def get_doi_prefix_by_blog_id(blog_id)
+        # for generating a random DOI.
+
+        url = json_feed_by_blog_url(blog_id)
+        response = HTTP.get(url)
+        return nil unless response.status.success?
+
+        post = JSON.parse(response.body.to_s)
+        post.to_h.dig('prefix')
+      end
+
+      def get_doi_prefix_by_json_feed_item_uuid(uuid)
+        # for generating a random DOI. Prefix is based on the blog id.
+
+        url = json_feed_item_by_uuid_url(uuid)
+        response = HTTP.get(url)
+        return nil unless response.status.success?
+
+        post = JSON.parse(response.body.to_s)
+        post.to_h.dig('blog', 'prefix')
+      end
     end
   end
 end

data/lib/commonmeta/utils.rb

@@ -543,6 +543,11 @@ module Commonmeta
       orcid.gsub(/[[:space:]]/, "-") if orcid.present?
     end
 
+    def validate_ror(ror)
+      ror = Array(%r{\A(?:(?:http|https)://ror\.org/)?([0-9a-z]{7}\d{2})\z}.match(ror)).last
+      ror.gsub(/[[:space:]]/, "-") if ror.present?
+    end
+
     def validate_orcid_scheme(orcid_scheme)
       Array(%r{\A(http|https)://(www\.)?(orcid\.org)}.match(orcid_scheme)).last
     end
@@ -634,6 +639,14 @@ module Commonmeta
       "https://orcid.org/" + Addressable::URI.encode(orcid)
     end
 
+    def normalize_ror(ror)
+      ror = validate_ror(ror)
+      return nil unless ror.present?
+
+      # turn ROR ID into URL
+      "https://ror.org/" + Addressable::URI.encode(ror)
+    end
+
     # pick electronic issn if there are multiple
     # format issn as xxxx-xxxx
     def normalize_issn(input, options = {})
@@ -1371,6 +1384,26 @@ module Commonmeta
     end
 
     def encode_doi(prefix, options = {})
+      return nil unless prefix.present?
+      
+      # DOI suffix is a generated from a random number, encoded in base32
+      # suffix has 8 digits plus two checksum digits. With base32 there are
+      # 32 possible digits, so 8 digits gives 32^8 possible combinations
+      if options[:uuid]
+        str = Base32::URL.encode_uuid(options[:uuid], split: 7, checksum: true)
+        return nil unless str.present?
+      else
+        random_int = SecureRandom.random_number(32 ** 7..(32 ** 8) - 1)
+        suffix = Base32::URL.encode(random_int, checksum: true)
+        str = "#{suffix[0, 5]}-#{suffix[5, 10]}"
+      end
+      "https://doi.org/#{prefix}/#{str}"
+    end
+
+    def encode_doi_for_uuid(uuid, options = {})
+      # look up prefix for rogue scholar blog associated with uuid
+      # returns nil if unknown uuid or doi registration is not enabled for blog
+      json_feed_by_uuid(uuid)
       # DOI suffix is a generated from a random number, encoded in base32
       # suffix has 8 digits plus two checksum digits. With base32 there are
       # 32 possible digits, so 8 digits gives 32^8 possible combinations
@@ -1415,5 +1448,9 @@ module Commonmeta
     def json_feed_by_blog_url(blog_id)
       "https://rogue-scholar.org/api/blogs/#{blog_id}"
     end
+
+    def json_feed_item_by_uuid_url(uuid)
+      "https://rogue-scholar.org/api/posts/#{uuid}"
+    end
   end
 end

data/lib/commonmeta/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Commonmeta
-  VERSION = '3.2.15'
+  VERSION = '3.3.1'
 end

data/spec/cli_spec.rb

@@ -311,12 +311,36 @@ describe Commonmeta::CLI do
     # end
   end
 
-  describe "encode" do
-    let(:input) { "10.53731" }
-
+  describe "encode", vcr: true do
     it "blog prefix" do
+      input = "10.53731"
       expect { subject.encode input }.to output(/https:\/\/doi.org\/10.53731/).to_stdout
     end
+
+    it "blog prefix missing" do
+      input = ""
+      expect { subject.encode input }.to output("").to_stdout
+    end
+
+    it "by_blog" do
+      input = "tyfqw20"
+      expect { subject.encode_by_blog input }.to output(/https:\/\/doi.org\/10.59350/).to_stdout
+    end
+
+    it "by_blog unknown blog_id" do
+      input = "tyfqw"
+      expect { subject.encode_by_blog input }.to output("").to_stdout
+    end
+
+    it "by_uuid" do
+      input = "2b22bbba-bcba-4072-94cc-3f88442fff88"
+      expect { subject.encode_by_uuid input }.to output(/https:\/\/doi.org\/10.54900/).to_stdout
+    end
+
+    it "by_uuid unknown uuid" do
+      input = "2b22bbba-bcba-4072-94cc-3f88442"
+      expect { subject.encode_by_uuid input }.to output("").to_stdout
+    end
   end
 
   describe "decode" do