relaton-nist 1.18.0 → 1.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96861330895fb2cca8e2d6ab7320bd4daa8ef8e2873231399761604eed233be1
-  data.tar.gz: 524bb34cd6285c212067c3ac791f916ecd72296a523627f82b7cf364de917dd3
+  metadata.gz: cd31209270fb62d1b7dabbddf7f379eb7b33a21832f3e290dd9ed49c94d715c4
+  data.tar.gz: 8f15ad43f7d1edfd0a9135a6b750bf1414c3fd24216fd30c730586b9cd342f5c
 SHA512:
-  metadata.gz: 2afde329d073bb4dc564005568eb06fdb52e1cc1911c74d6ad4656ab0e492d01108a2c3ba31fe2b29bdb84bab5640f7f199afdd021dcadd5b6c1aaab5b9269f8
-  data.tar.gz: 230883c366766fd4dc7b23a3acd0edee052709391e7c3cdd4e97f28a7f864666859a95fcf4d401b5247d6b81b80543bb2cb6a9ac2e575b6e96b0fc647f0130be
+  metadata.gz: ea6daf8959d56b98ab2e02e63315c2ecf7bd483824ec2ad0832fc9239e32d57e556942d86edbaa4c88655904d2e04e9a05c50cb4bbf38486773ab3cb0986c851
+  data.tar.gz: 2ca580e13556eb72455cc61f9a783d30894675d3f98630dd2de589a3a2a894380bc96a26453eb345e727eec37a7ecb8535b35aa011b34cab9580b858fc0e70ae

data/README.adoc

@@ -71,24 +71,13 @@ Or install it yourself as:
 
 == Usage
 
-=== Configuration
-
-Configuration is optional. The available option is `logger` which is a `Logger` instance. By default, the logger is `Logger.new($stderr)` with `Logger::WARN` level. To change the logger level, use `RelatonNist.configure` block.
+=== Search for a standard using keywords
 
 [source,ruby]
 ----
 require 'relaton_nist'
 => true
 
-RelatonNist.configure do |config|
-  config.logger.level = Logger::DEBUG
-end
-----
-
-=== Search for a standard using keywords
-
-[source,ruby]
-----
 hit_collection = RelatonNist::NistBibliography.search("NISTIR 8200")
 [relaton-nist] (NIST IR 8200) Fetching from csrc.nist.gov ...
 [relaton-nist] (NIST IR 8200) Fetching from Relaton repository ...
@@ -103,7 +92,7 @@ item = hit_collection[0].fetch
 [source,ruby]
 ----
 item.to_xml
-=> "<bibitem id="NISTIR8200" type="standard" schema-version="v1.2.8">
+=> "<bibitem id="NISTIR8200" type="standard" schema-version="v1.2.9">
       <fetched>2023-10-16</fetched>
       <title format="text/plain" language="en" script="Latn">Interagency report on the status of international cybersecurity standardization for the internet of things (IoT)</title>
       ...
@@ -113,7 +102,7 @@ With argument `bibdata: true` it outputs XML wrapped by `bibdata` element and ad
 [source,ruby]
 ----
 item.to_xml bibdata: true
-=> "<bibdata type="standard" schema-version="v1.2.8">
+=> "<bibdata type="standard" schema-version="v1.2.9">
       <fetched>2023-10-16</fetched>
       <title format="text/plain" language="en" script="Latn">Interagency report on the status of international cybersecurity standardization for the internet of things (IoT)</title>
       ...
@@ -239,6 +228,10 @@ Done in: 42 sec.
 => nil
 ----
 
+=== Logging
+
+RelatonNist uses the relaton-logger gem for logging. By default, it logs to STDOUT. To change the log levels and add other loggers, read the https://github.com/relaton/relaton-logger#usage[relaton-logger] documentation.
+
 == Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/grammars/basicdoc.rng

@@ -244,6 +244,9 @@
         <data type="ID"/>
       </attribute>
       <attribute name="reviewer"/>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="date">
           <data type="dateTime"/>

data/lib/relaton_nist/data_fetcher.rb

@@ -30,7 +30,7 @@ module RelatonNist
       id = bib.docidentifier[0].id.gsub(%r{[/\s:.]}, "_").upcase.sub(/^NIST_IR/, "NISTIR")
       file = File.join(@output, "#{id}.#{@ext}")
       if @files.include? file
-        warn "File #{file} exists. Docid: #{bib.docidentifier[0].id}"
+        Util.warn "File #{file} exists. Docid: #{bib.docidentifier[0].id}"
         # warn "Link: #{bib.link.detect { |l| l.type == 'src' }.content}"
       else @files << file
       end
@@ -64,8 +64,7 @@ module RelatonNist
       puts "Stopped at: #{t2}"
       puts "Done in: #{(t2 - t1).round} sec."
     rescue StandardError => e
-      warn e.message
-      warn e.backtrace[0..5].join("\n")
+      Util.error "#{e.message}\n#{e.backtrace[0..5].join("\n")}"
     end
 
     def fetch_tech_pubs

data/lib/relaton_nist/hit_collection.rb

@@ -190,7 +190,7 @@ module RelatonNist
     # @raise [OpenURI::HTTPError] if GitHub repo is not available
     #
     def from_ga # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-      Util.warn "(#{@reference}) Fetching from Relaton repository ..."
+      Util.info "Fetching from Relaton repository ...", key: @reference
       ref = full_ref
       return [] if ref.empty?
 
@@ -222,7 +222,7 @@ module RelatonNist
     # @return [Array<RelatonNist::Hit>] hits
     #
     def from_json # rubocop:disable Metrics/AbcSize
-      Util.warn "(#{@reference}) Fetching from csrc.nist.gov ..."
+      Util.info "Fetching from csrc.nist.gov ...", key: @reference
       select_data.map do |h|
         /(?<series>(?<=-)\w+$)/ =~ h["series"]
         title = [h["title-main"], h["title-sub"]].compact.join " - "

data/lib/relaton_nist/nist_bibliographic_item.rb

@@ -3,32 +3,32 @@ module RelatonNist
     # @return [Array<RelatonNist::Keyword>]
     # attr_reader :keyword
 
-    # @return [RelatonNist::CommentPeriod, NilClass]
+    # @return [RelatonNist::CommentPeriod, nil]
     attr_reader :commentperiod
 
-    # @param id [String, NilClass]
+    # @param id [String, nil]
     # @param title [Array<RelatonBib::TypedTitleString>]
-    # @param formattedref [RelatonBib::FormattedRef, NilClass]
-    # @param type [String, NilClass]
+    # @param formattedref [RelatonBib::FormattedRef, nil]
+    # @param type [String, nil]
     # @param docid [Array<RelatonBib::DocumentIdentifier>]
-    # @param docnumber [String, NilClass]
+    # @param docnumber [String, nil]
     # @param language [Arra<String>]
     # @param script [Array<String>]
-    # @param docstatus [RelatonNist::DocumentStatus, NilClass]
-    # @param edition [String, NilClass]
-    # @param version [RelatonBib::BibliographicItem::Version, NilClass]
+    # @param docstatus [RelatonNist::DocumentStatus, nil]
+    # @param edition [String, nil]
+    # @param version [RelatonBib::BibliographicItem::Version, nil]
     # @param biblionote [Array<RelatonBib::FormattedStrong>]
     # @param series [Array<RelatonBib::Series>]
     # @param medium [RelatonBib::Medium, NilClas]
     # @param place [Array<String>]
     # @param extent [Array<Relaton::BibItemLocality>]
     # @param accesslocation [Array<String>]
-    # @param classification [RelatonBib::Classification, NilClass]
-    # @param validity [RelatonBib:Validity, NilClass]
-    # @param fetched [Date, NilClass] default nil
-    # @param doctype [String]
+    # @param classification [RelatonBib::Classification, nil]
+    # @param validity [RelatonBib:Validity, nil]
+    # @param fetched [Date, nil] default nil
+    # @param doctype [RelatonBib::DocumentType, nil]
     # @param keyword [Array<RelatonBib::Keyword>]
-    # @param commentperiod [RelatonNist::CommentPeriod, NilClass]
+    # @param commentperiod [RelatonNist::CommentPeriod, nil]
     #
     # @param date [Array<Hash>]
     # @option date [String] :type

data/lib/relaton_nist/nist_bibliography.rb

@@ -84,7 +84,7 @@ module RelatonNist
         result = nistbib_search_filter(code, year, opts) || (return nil)
         ret = nistbib_results_filter(result, year, opts)
         if ret[:ret]
-          Util.warn "(#{result.reference}) Found: `#{ret[:ret].docidentifier.first.id}`"
+          Util.info "Found: `#{ret[:ret].docidentifier.first.id}`", key: result.reference
           ret[:ret]
         else
           fetch_ref_err(result.reference, year, ret[:years])
@@ -173,14 +173,14 @@ module RelatonNist
       # @return [nil] nil
       #
       def fetch_ref_err(ref, year, missed_years)
-        Util.warn "(#{ref}) No found."
+        Util.info "No found.", key: ref
         unless missed_years.empty?
-          Util.warn "(There was no match for #{year}, though there " \
-                    "were matches found for `#{missed_years.join('`, `')}`.)"
+          Util.info "(There was no match for #{year}, though there " \
+                    "were matches found for `#{missed_years.join('`, `')}`.)", key: ref
         end
         if /\d-\d/.match? ref
-          Util.warn "The provided document part may not exist, " \
-                    "or the document may no longer be published in parts."
+          Util.info "The provided document part may not exist, " \
+                    "or the document may no longer be published in parts.", key: ref
         end
         nil
       end

data/lib/relaton_nist/tech_pubs_parser.rb

@@ -152,7 +152,7 @@ module RelatonNist
     # @return [Array<Hash>]
     def parse_contributor
       contribs = @doc.xpath("contributors/person_name").map do |p|
-        person = RelatonBib::Person.new(name: fullname(p), affiliation: affiliation)
+        person = RelatonBib::Person.new(name: fullname(p), affiliation: affiliation, identifier: identifier(p))
         { entity: person, role: [{ type: p["contributor_role"] }] }
       end
       contribs + @doc.xpath("publisher").map do |p|
@@ -160,6 +160,12 @@ module RelatonNist
       end
     end
 
+    def identifier(person)
+      person.xpath("ORCID").map do |id|
+        RelatonBib::PersonIdentifier.new "orcid", id.text
+      end
+    end
+
     #
     # Create full name object from person name element.
     #
@@ -169,12 +175,11 @@ module RelatonNist
     #
     def fullname(person)
       fname, initials = forename_initial person
-      surname = localized_string person.at("surname").text
-      ident = person.xpath("ORCID").map do |id|
-        RelatonBib::PersonIdentifier.new "orcid", id.text
-      end
-      RelatonBib::FullName.new(surname: surname, forename: fname,
-                               initials: initials, identifier: ident)
+      surname = localized_string person.at("surname")&.text
+      completename = localized_string person.text unless surname
+      RelatonBib::FullName.new(
+        surname: surname, forename: fname, initials: initials, completename: completename,
+      )
     end
 
     #
@@ -296,6 +301,7 @@ module RelatonNist
     # @return [RelatonBib::LocalizedString] localized string
     #
     def localized_string(content)
+      return unless content
       RelatonBib::LocalizedString.new content, @doc["language"], "Latn"
     end
   end

data/lib/relaton_nist/util.rb

@@ -1,9 +1,6 @@
 module RelatonNist
   module Util
     extend RelatonBib::Util
-
-    def self.logger
-      RelatonNist.configuration.logger
-    end
+    PROGNAME = "relaton-nist".freeze
   end
 end

data/lib/relaton_nist/version.rb

@@ -1,3 +1,3 @@
 module RelatonNist
-  VERSION = "1.18.0".freeze
+  VERSION = "1.19.0".freeze
 end

data/lib/relaton_nist.rb

@@ -2,7 +2,6 @@ require "singleton"
 require "relaton/index"
 require "relaton_bib"
 require "relaton_nist/version"
-require "relaton_nist/config"
 require "relaton_nist/util"
 require "relaton_nist/nist_bibliography"
 require "relaton_nist/data_fetcher"

data/relaton_nist.gemspec

@@ -23,7 +23,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
-  spec.add_dependency "relaton-bib", "~> 1.18.0"
+  spec.add_dependency "base64"
+  spec.add_dependency "relaton-bib", "~> 1.19.0"
   spec.add_dependency "relaton-index", "~> 0.2.0"
   spec.add_dependency "rubyzip"
 end

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: relaton-nist
 version: !ruby/object:Gem::Version
-  version: 1.18.0
+  version: 1.19.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-01-08 00:00:00.000000000 Z
+date: 2024-07-03 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: relaton-bib
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.18.0
+        version: 1.19.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.18.0
+        version: 1.19.0
 - !ruby/object:Gem::Dependency
   name: relaton-index
   requirement: !ruby/object:Gem::Requirement
@@ -78,7 +92,6 @@ files:
 - grammars/relaton-nist.rng
 - lib/relaton_nist.rb
 - lib/relaton_nist/comment_period.rb
-- lib/relaton_nist/config.rb
 - lib/relaton_nist/data_fetcher.rb
 - lib/relaton_nist/document_relation.rb
 - lib/relaton_nist/document_status.rb
@@ -115,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.3.27
 signing_key: 
 specification_version: 4
 summary: 'RelatonNist: retrive NIST standards.'

data/lib/relaton_nist/config.rb

@@ -1,10 +0,0 @@
-module RelatonNist
-  module Config
-    include RelatonBib::Config
-  end
-  extend Config
-
-  class Configuration < RelatonBib::Configuration
-    PROGNAME = "relaton-nist".freeze
-  end
-end