orcid_client 0.2.3 → 0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eeaf7b53eebf7c7877d24e9fc458a7a6a307032d
-  data.tar.gz: 65e9b253be1606b55d93d8eabddf834a2a10ef7a
+  metadata.gz: 4409ba94da970aeb5d0ed1eb13bf77b97b7c697d
+  data.tar.gz: ff0317e8fbdba576f41a127af792336be090fd5d
 SHA512:
-  metadata.gz: 996e7dcb216b8568c2823c7fdbd11abcc84bba831b46e34e0040b79f38d923f0f921a2313c6f478abdfda8f3c533b34d869766482d9b225cfd8a36edce31b80c
-  data.tar.gz: 87d4e73f8a67f2a670f5d9b4d1757480c2a1a8a2236b29636c7e3cf62f39b1c57cf03779c38728d4640ff5803bf6940875e9a947e79d780e5d15b35ffe1e6abb
+  metadata.gz: 8e3c17393883843786e75e5531e3f93959294d7c12aa9d1762514076f2f45c6576b19337411101c4d50f4bf770c009af591fe9063c417db3c6f31321d0a6e28a
+  data.tar.gz: 8e0ad8d7273a78a3e0c81032740a6d9700a9e6ffe45949183296780ba1c9595b82b9761103aa9bf0306779040245d2c5f62f0622f168b86b7c6392094144193d

data/Gemfile.lock

@@ -1,35 +1,60 @@
 PATH
   remote: .
   specs:
-    orcid_client (0.2.3)
-      activesupport (~> 4.2, >= 4.2.5)
+    orcid_client (0.3)
+      activesupport (>= 4.2.5, < 6)
+      bolognese (~> 0.9.26)
       builder (~> 3.2, >= 3.2.2)
       dotenv (~> 2.1, >= 2.1.1)
-      maremma (~> 3.0)
+      maremma (~> 3.5, >= 3.5.7)
       namae (~> 0.11.3)
-      nokogiri (~> 1.6.8)
+      nokogiri (~> 1.6, >= 1.6.8)
       sanitize (~> 4.0, >= 4.0.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (4.2.7.1)
+    activesupport (5.1.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (~> 0.7)
-      json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
-      thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
-    addressable (2.5.0)
+    addressable (2.5.1)
       public_suffix (~> 2.0, >= 2.0.2)
+    benchmark_methods (0.7)
+    bibtex-ruby (4.4.3)
+      latex-decode (~> 0.0)
+    bolognese (0.9.26)
+      activesupport (>= 4.2.5, < 6)
+      benchmark_methods (~> 0.7)
+      bibtex-ruby (~> 4.1)
+      builder (~> 3.2, >= 3.2.2)
+      colorize (~> 0.8.1)
+      gender_detector (~> 0.1.2)
+      json-ld (~> 2.1, >= 2.1.2)
+      jsonlint (~> 0.2.0)
+      loofah (~> 2.0, >= 2.0.3)
+      maremma (~> 3.5, >= 3.5.7)
+      namae (~> 0.11.3)
+      nokogiri (~> 1.6, >= 1.6.8)
+      postrank-uri (~> 1.0, >= 1.0.18)
+      rdf-rdfxml (~> 2.0)
+      rdf-turtle (~> 2.2)
+      thor (~> 0.19)
     builder (3.2.3)
-    codeclimate-test-reporter (1.0.5)
-      simplecov
+    codeclimate-test-reporter (1.0.8)
+      simplecov (<= 0.13)
+    colorize (0.8.1)
+    concurrent-ruby (1.0.5)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     crass (1.0.2)
     diff-lcs (1.3)
     docile (1.1.5)
-    dotenv (2.2.0)
+    dotenv (2.2.1)
+    ebnf (1.1.0)
+      rdf (~> 2.0)
+      sxp (~> 1.0)
     excon (0.45.4)
     faraday (0.9.2)
       multipart-post (>= 1.2, < 3)
@@ -37,50 +62,94 @@ GEM
       faraday
     faraday_middleware (0.10.1)
       faraday (>= 0.7.4, < 1.0)
-    hashdiff (0.3.2)
-    i18n (0.8.0)
-    json (1.8.6)
-    maremma (3.1.2)
-      activesupport (~> 4.2, >= 4.2.5)
-      addressable (~> 2.5)
+    gender_detector (0.1.2)
+      unicode_utils (>= 1.3.0)
+    haml (5.0.1)
+      temple (>= 0.8.0)
+      tilt
+    hamster (3.0.0)
+      concurrent-ruby (~> 1.0)
+    hashdiff (0.3.4)
+    htmlentities (4.3.4)
+    i18n (0.8.4)
+    json (2.1.0)
+    json-ld (2.1.4)
+      multi_json (~> 1.12)
+      rdf (~> 2.2)
+    jsonlint (0.2.0)
+      oj (~> 2)
+      trollop (~> 2)
+    latex-decode (0.2.2)
+      unicode (~> 0.4)
+    link_header (0.0.8)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    maremma (3.5.8)
+      activesupport (>= 4.2.5)
+      addressable (>= 2.3.6)
       builder (~> 3.2, >= 3.2.2)
       excon (~> 0.45.0)
       faraday (~> 0.9.2)
       faraday-encoding (~> 0.0.1)
       faraday_middleware (~> 0.10.0)
-      multi_json (~> 1.11.2)
-      nokogiri (~> 1.6.7)
-      oj (~> 2.13.1)
+      multi_json (~> 1.12)
+      nokogiri (~> 1.6, >= 1.6.8)
+      oj (~> 2.18, >= 2.18.1)
     mini_portile2 (2.1.0)
-    minitest (5.10.1)
-    multi_json (1.11.3)
+    minitest (5.10.2)
+    multi_json (1.12.1)
     multipart-post (2.0.0)
     namae (0.11.3)
-    nokogiri (1.6.8.1)
+    nokogiri (1.7.2)
       mini_portile2 (~> 2.1.0)
-    nokogumbo (1.4.10)
+    nokogumbo (1.4.13)
       nokogiri
-    oj (2.13.1)
+    oj (2.18.5)
+    postrank-uri (1.0.22)
+      addressable (>= 2.3.0, < 2.6)
+      nokogiri (>= 1.6.1, < 1.8)
+      public_suffix (>= 2.0.0, < 2.1)
     public_suffix (2.0.5)
-    rack (2.0.1)
+    rack (2.0.3)
     rack-test (0.6.3)
       rack (>= 1.0)
     rake (12.0.0)
-    rspec (3.5.0)
-      rspec-core (~> 3.5.0)
-      rspec-expectations (~> 3.5.0)
-      rspec-mocks (~> 3.5.0)
-    rspec-core (3.5.4)
-      rspec-support (~> 3.5.0)
-    rspec-expectations (3.5.0)
+    rdf (2.2.6)
+      hamster (~> 3.0)
+      link_header (~> 0.0, >= 0.0.8)
+    rdf-aggregate-repo (2.2.0)
+      rdf (~> 2.0)
+    rdf-rdfa (2.2.2)
+      haml (~> 5.0)
+      htmlentities (~> 4.3)
+      rdf (~> 2.2)
+      rdf-aggregate-repo (~> 2.2)
+      rdf-xsd (~> 2.1)
+    rdf-rdfxml (2.0.0)
+      htmlentities (~> 4.3)
+      rdf (~> 2.0)
+      rdf-rdfa (~> 2.0)
+      rdf-xsd (~> 2.0)
+    rdf-turtle (2.2.0)
+      ebnf (~> 1.1)
+      rdf (~> 2.2)
+    rdf-xsd (2.1.0)
+      rdf (~> 2.1)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-mocks (3.5.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-support (3.5.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
     safe_yaml (1.0.4)
-    sanitize (4.4.0)
+    sanitize (4.5.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.4.4)
       nokogumbo (~> 1.4.1)
@@ -88,12 +157,20 @@ GEM
       docile (~> 1.1.0)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.0)
-    thread_safe (0.3.5)
-    tzinfo (1.2.2)
+    simplecov-html (0.10.1)
+    sxp (1.0.0)
+      rdf (~> 2.0)
+    temple (0.8.0)
+    thor (0.19.4)
+    thread_safe (0.3.6)
+    tilt (2.0.7)
+    trollop (2.1.2)
+    tzinfo (1.2.3)
       thread_safe (~> 0.1)
+    unicode (0.4.4.4)
+    unicode_utils (1.4.0)
     vcr (3.0.3)
-    webmock (1.24.6)
+    webmock (3.0.1)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff
@@ -110,7 +187,7 @@ DEPENDENCIES
   rspec (~> 3.4)
   simplecov
   vcr
-  webmock (~> 1.22, >= 1.22.3)
+  webmock (~> 3.0, >= 3.0.1)
 
 BUNDLED WITH
    1.12.5

data/lib/orcid_client/api.rb

@@ -2,7 +2,7 @@ require "uri"
 
 module OrcidClient
   module Api
-    API_VERSION = "2.0_rc3"
+    API_VERSION = "2.0"
 
     def get_works(options={})
       return OpenStruct.new(body: { "errors" => [{ "title" => "Access token missing" }] }) unless access_token.present?

data/lib/orcid_client/author.rb

@@ -1,54 +1,7 @@
-require 'namae'
-
 module OrcidClient
   module Author
-    def validate_orcid(orcid)
-      orcid = Array(/\A(?:http:\/\/orcid\.org\/)?(\d{4}[[:space:]-]\d{4}[[:space:]-]\d{4}[[:space:]-]\d{3}[0-9X]+)\z/.match(orcid)).last
-      orcid.gsub(/[[:space:]]/, "-") if orcid.present?
-    end
-
-    # parse author string into CSL format
-    def get_one_author(author)
-      return "" if author.blank?
-
-      names = Namae.parse(author)
-      if names.present?
-        name = names.first
-
-        { "family" => name.family,
-          "given" => name.given }.compact
-      else
-        { "literal" => author }
-      end
-    end
-
-    # parse array of author strings into CSL format
-    def get_authors(authors)
-      Array(authors).map { |author| get_one_author(author) }
-    end
-
-    # parse array of author hashes into CSL format
-    def get_hashed_authors(authors)
-      Array(authors).map { |author| get_one_hashed_author(author) }
-    end
-
-    def get_one_hashed_author(author)
-      raw_name = author.fetch("creatorName", nil)
-
-      author_hsh = get_one_author(raw_name)
-      author_hsh["ORCID"] = get_name_identifier(author)
-      author_hsh.compact
-    end
-
-    def get_name_identifier(author)
-      name_identifier = author.fetch("nameIdentifier", nil)
-      name_identifier_scheme = author.fetch("nameIdentifierScheme", "orcid").downcase
-      if name_identifier_scheme == "orcid" && name_identifier = validate_orcid(name_identifier)
-        "http://orcid.org/#{name_identifier}"
-      else
-        nil
-      end
-    end
+    include Bolognese::AuthorUtils
+    include Bolognese::Utils
 
     def get_credit_name(author)
       [author['given'], author['family']].compact.join(' ').presence || author['literal']

data/lib/orcid_client/date.rb

@@ -38,9 +38,9 @@ module OrcidClient
       month = iso8601_time[5..6]
       day = iso8601_time[8..9]
 
-      { 'year' => year.to_i,
-        'month' => month.to_i,
-        'day' => day.to_i }.delete_if { |key, value| value == 0 }
+      { 'year' => year,
+        'month' => month,
+        'day' => day }.compact
     end
 
     def get_iso8601_from_time(time)

data/lib/orcid_client/external_identifier.rb

@@ -46,7 +46,7 @@ module OrcidClient
       { :'put-code' => put_code,
         :'visibility' => 'public',
         :'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance',
-        :'xsi:schemaLocation' => 'http://www.orcid.org/ns/external-identifier ../person-external-identifier-2.0_rc3.xsd',
+        :'xsi:schemaLocation' => 'http://www.orcid.org/ns/external-identifier ../person-external-identifier-2.0.xsd',
         :'xmlns:common' => 'http://www.orcid.org/ns/common',
         :'xmlns:external-identifier' => 'http://www.orcid.org/ns/external-identifier' }.compact
     end

data/lib/orcid_client/notification.rb

@@ -5,12 +5,10 @@ require_relative 'api'
 require_relative 'author'
 require_relative 'base'
 require_relative 'date'
-require_relative 'metadata'
 
 module OrcidClient
   class Notification
     include OrcidClient::Base
-    include OrcidClient::Metadata
     include OrcidClient::Author
     include OrcidClient::Date
     include OrcidClient::Api
@@ -30,11 +28,11 @@ module OrcidClient
     SCHEMA = File.expand_path("../../../resources/notification_#{API_VERSION}/notification-permission-#{API_VERSION}.xsd", __FILE__)
 
     def metadata
-      @metadata ||= get_metadata(doi, 'datacite')
+      @metadata ||= Bolognese::Metadata.new(input: doi)
     end
 
     def item_name
-      metadata.fetch('title', nil)
+      parse_attributes(metadata.title, content: "text", first: true)
     end
 
     def item_type
@@ -109,7 +107,7 @@ module OrcidClient
 
     def root_attributes
       { :'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance',
-        :'xsi:schemaLocation' => 'http://www.orcid.org/ns/notification ../notification-permission-2.0_rc3.xsd',
+        :'xsi:schemaLocation' => 'http://www.orcid.org/ns/notification ../notification-permission-2.0.xsd',
         :'xmlns:common' => 'http://www.orcid.org/ns/common',
         :'xmlns:notification' => 'http://www.orcid.org/ns/notification' }
     end

data/lib/orcid_client/version.rb

@@ -1,3 +1,3 @@
 module OrcidClient
-  VERSION = "0.2.3"
+  VERSION = "0.3"
 end

data/lib/orcid_client/work.rb

@@ -6,19 +6,19 @@ require_relative 'api'
 require_relative 'author'
 require_relative 'base'
 require_relative 'date'
-require_relative 'metadata'
 require_relative 'work_type'
 
 module OrcidClient
   class Work
     include OrcidClient::Base
-    include OrcidClient::Metadata
     include OrcidClient::Author
     include OrcidClient::Date
     include OrcidClient::WorkType
     include OrcidClient::Api
 
-    attr_reader :doi, :orcid, :schema, :access_token, :put_code, :validation_errors
+    include Bolognese::Utils
+
+    attr_reader :doi, :orcid, :schema, :access_token, :put_code, :validation_errors, :name_detector
 
     def initialize(doi:, orcid:, access_token:, **options)
       @doi = doi
@@ -28,51 +28,46 @@ module OrcidClient
     end
 
     SCHEMA = File.expand_path("../../../resources/record_#{API_VERSION}/work-#{API_VERSION}.xsd", __FILE__)
+    # recognize given name. Can be loaded once as ::NameDetector, e.g. in a Rails initializer
+    def name_detector
+      @name_detector ||= defined?(::NameDetector) ? ::NameDetector : GenderDetector.new
+    end
 
     def metadata
-      @metadata ||= get_metadata(doi, 'datacite')
+      @metadata ||= Bolognese::Metadata.new(input: doi)
     end
 
     def contributors
-      Array(metadata.fetch('author', nil)).map do |contributor|
-        { orcid: contributor.fetch('ORCID', nil),
-          credit_name: get_credit_name(contributor),
+      Array.wrap(metadata.author).map do |contributor|
+        orcid = validate_orcid(contributor.fetch('id', nil))
+        orcid = "http://orcid.org/#{orcid}" if orcid.present?
+
+        { orcid: orcid,
+          credit_name: contributor.fetch('name', nil),
           role: nil }.compact
       end
     end
 
-    def author_string
-      Array(metadata.fetch('author', nil)).map do |contributor|
-        get_full_name(contributor)
-      end.join(" and ")
-    end
-
-    def sanitize(string)
-      Sanitize.fragment(string).squish
-    end
-
     def title
-      metadata.fetch('title', nil)
+      parse_attributes(metadata.title, content: "text", first: true)
     end
 
+    # user publisher name as fallback
     def container_title
-      metadata.fetch('container-title', nil)
-    end
-
-    def publisher_id
-      metadata.fetch('publisher_id', nil)
+      metadata.container_title || metadata.publisher
     end
 
     def publication_date
-      get_year_month_day(metadata.fetch('published', nil))
+      get_year_month_day(metadata.date_published)
     end
 
     def description
-      sanitize(Array(metadata.fetch('description', nil)).first)
+      ct = parse_attributes(metadata.description, content: "text", first: true)
+      ct.squish if ct.present?
     end
 
     def type
-      orcid_work_type(metadata.fetch('type', nil), metadata.fetch('subtype', nil))
+      orcid_work_type(metadata.resource_type_general, metadata.additional_type)
     end
 
     def has_required_elements?
@@ -158,7 +153,7 @@ module OrcidClient
       if contributor[:orcid].present?
         xml.send(:'common:contributor-orcid') do
           xml.send(:'common:uri', contributor[:orcid])
-          xml.send(:'common:path', contributor[:orcid][17..-1])
+          xml.send(:'common:path', validate_orcid(contributor[:orcid]))
           xml.send(:'common:host', 'orcid.org')
         end
       end
@@ -184,7 +179,7 @@ module OrcidClient
       { :'put-code' => put_code,
         :'visibility' => 'public',
         :'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance',
-        :'xsi:schemaLocation' => 'http://www.orcid.org/ns/work ../work-2.0_rc3.xsd',
+        :'xsi:schemaLocation' => 'http://www.orcid.org/ns/work ../work-2.0.xsd',
         :'xmlns:common' => 'http://www.orcid.org/ns/common',
         :'xmlns:work' => 'http://www.orcid.org/ns/work' }.compact
     end

data/lib/orcid_client.rb

@@ -1,3 +1,5 @@
+require 'bolognese'
+
 require "orcid_client/work"
 require "orcid_client/notification"
 require "orcid_client/external_identifier"

data/orcid_client.gemspec

@@ -19,11 +19,12 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # Declary dependencies here, rather than in the Gemfile
-  s.add_dependency 'maremma', '~> 3.0'
-  s.add_dependency 'nokogiri', '~> 1.6.8'
+  s.add_dependency 'maremma', '~> 3.5', '>= 3.5.7'
+  s.add_dependency 'bolognese', '~> 0.9.26'
+  s.add_dependency 'nokogiri', '~> 1.6', '>= 1.6.8'
   s.add_dependency 'builder', '~> 3.2', '>= 3.2.2'
   s.add_dependency 'namae', '~> 0.11.3'
-  s.add_dependency 'activesupport', '~> 4.2', '>= 4.2.5'
+  s.add_dependency 'activesupport', '>= 4.2.5', '< 6'
   s.add_dependency 'sanitize', '~> 4.0', '>= 4.0.1'
   s.add_dependency 'dotenv', '~> 2.1', '>= 2.1.1'
   s.add_development_dependency 'bundler', '~> 1.0'
@@ -31,7 +32,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rack-test', '~> 0'
   s.add_development_dependency 'vcr'
-  s.add_development_dependency 'webmock', '~> 1.22', '>= 1.22.3'
+  s.add_development_dependency 'webmock', '~> 3.0', '>= 3.0.1'
   s.add_development_dependency 'codeclimate-test-reporter', "~> 1.0.0"
   s.add_development_dependency 'simplecov'
 end