relaton-nist 1.19.0 → 1.19.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd31209270fb62d1b7dabbddf7f379eb7b33a21832f3e290dd9ed49c94d715c4
-  data.tar.gz: 8f15ad43f7d1edfd0a9135a6b750bf1414c3fd24216fd30c730586b9cd342f5c
+  metadata.gz: 7a4b4d939bc25c7c8968747b391784b5e0238a6961b5544d6f48cd77848addf9
+  data.tar.gz: f5684a7aa32f04b30fed89c1d43dc0c5247562a94bf97b1d65f6b0c80de2f054
 SHA512:
-  metadata.gz: ea6daf8959d56b98ab2e02e63315c2ecf7bd483824ec2ad0832fc9239e32d57e556942d86edbaa4c88655904d2e04e9a05c50cb4bbf38486773ab3cb0986c851
-  data.tar.gz: 2ca580e13556eb72455cc61f9a783d30894675d3f98630dd2de589a3a2a894380bc96a26453eb345e727eec37a7ecb8535b35aa011b34cab9580b858fc0e70ae
+  metadata.gz: aa2d613dc42ac689b422b73d0b930459bbfdad99ca8e0e4302a8f586931f89f90ae0189d6d052e8e003659b75df4f5a07941835d4f03f4e98ead50ebcfef738d
+  data.tar.gz: 19b7411e9f15891b7513dd934a678702fcfaccc80512385e2354d69ca66f2cf3617b2f8e88ce47b7141ee885dc933e59931731dec14e1b90e550964184f4ff92

data/README.adoc

@@ -10,7 +10,8 @@ image:https://img.shields.io/github/commits-since/relaton/relaton-nist/latest.sv
 
 == Purpose
 
-`relaton-nist` provides bibliographic information of NIST publications using the
+Relaton for NIST provides bibliographic information of NIST publications using
+the
 https://github.com/metanorma/metanorma-model-nist#nist-bibliographic-item-model[NistBibliographicItem model].
 
 Relaton for NIST has been developed in cooperation with the NIST Cybersecurity
@@ -18,18 +19,25 @@ Resource Center (CSRC) and the Computer Security Division (ITL/CSD).
 
 == Data sources
 
-Relaton for NIST retrieves bibliographic information from two sources:
+=== General
 
-* bibliographic feed from the NIST Cybersecurity Resource Center (CSRC) of
-all CSRC publications (in Relaton JSON)
-* bibliographic dataset from the NIST Library through the Information Services
-Office (ISO) that contains information about all NIST Technical Publications
-(https://github.com/usnistgov/NIST-Tech-Pubs[GitHub])
+Relaton for NIST retrieves bibliographic information from two sources,
+in the following priority:
+
+. NIST Cybersecurity Resource Center (CSRC)
+
+. NIST Library of the NIST Information Services Office (ISO)
+
+
+=== NIST Cybersecurity Resource Center (CSRC)
+
+The NIST CSRC bibliographic feed is used as the primary source for all CSRC
+publications.
 
 Bibliographic information offered through CSRC is provided with enhanced
-metadata that is not available in the NIST Library dataset, including:
+metadata unavailable from the NIST Library dataset, including:
 
-* public drafts (the NIST Library dataset only contains final publications)
+* versioned drafts (the NIST Library dataset only contains the latest publication: latest draft or final publication)
 * revision information: revision number, iteration
 * document stage information: retired, withdrawn, etc.
 * bibliographic dates, including issued date, updated date, published date,
@@ -37,20 +45,38 @@ metadata that is not available in the NIST Library dataset, including:
 * document relationships: supersession and replacements
 * contacts: enhanced name parts and affiliation information
 
-Relaton for NIST, therefore, uses the following order of priority for the data
-sources:
-
-. bibliographic feed from NIST CSRC
-. NIST Library dataset
-
-The NIST CSRC provides:
+The NIST CSRC provides the following documents:
 
 * NIST SP 800-*
 * NIST SP 500-*
 * NIST SP 1800-*
 * NIST FIPS {31, 39, 41, 46, 46-$$*$$, 48, 65, 73, 74, 81, 83, 87, 102, 112, 113, 139, 140-$$*$$, 141, 171, 180, 180-$$*$$, 181, 186, 186-$$*$$, 188, 190, 191, 196, 197, 198, 198-1, 199, 200, 201, 201-*, 202}
 
-The NIST Library dataset provides documents listed in the https://github.com/relaton/relaton-data-nist/blob/main/index-v1.yaml[index].
+As this feed is provided by CSRC in the native Relaton JSON format, no data
+transform is necessary.
+
+
+=== NIST Library
+
+The NIST Library offers the full NIST Technical Publications dataset at
+https://github.com/usnistgov/NIST-Tech-Pubs[GitHub].
+
+The library data is managed internally using MARC21, and the GitHub repository
+offers this information via MARC21 XML and MODS (in XML).
+
+Relaton for NIST uses the MODS dataset obtained from the following location:
+
+* https://github.com/usnistgov/NIST-Tech-Pubs/releases[NIST-Tech-Pubs/releases],
+the `allrecords-MODS.xml` file
+
+The MODS XML file is parsed using the
+https://github.com/relaton/loc_mods[`loc_mods`] library and its data mapped to
+the Relaton model.
+
+The NIST Library dataset provides documents listed in the
+https://github.com/relaton/relaton-data-nist/blob/main/index-v1.yaml[index].
+
+
 
 == Installation
 
@@ -63,104 +89,85 @@ gem 'relaton-nist'
 
 And then execute:
 
-    $ bundle
+[source,sh]
+----
+$ bundle
+----
 
 Or install it yourself as:
 
-    $ gem install relaton_nist
+[source,sh]
+----
+$ gem install relaton_nist
+----
 
 == Usage
 
-=== Search for a standard using keywords
+=== Retrieving an entry
 
+==== By NIST PubID
+
+Relaton supports using the
+https://www.nist.gov/system/files/documents/2022/04/01/PubID_Syntax_NIST_TechPubs.pdf[NIST PubID]
+as the retrieval key for bibliographic entries.
+
+NOTE: Relaton for NIST is the first public implementation of the
+https://www.nist.gov/news-events/news/2021/08/nist-technical-series-publications-proposed-publication-identifier-syntax[NIST PubID].
+
+
+.Retrieving a bibliographic entry using NIST PubID
+[example]
+====
 [source,ruby]
 ----
-require 'relaton_nist'
-=> true
+> require 'relaton_nist'
+=>
+true
 
-hit_collection = RelatonNist::NistBibliography.search("NISTIR 8200")
+> 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 ...
-=> <RelatonNist::HitCollection:0x00000000004b28 @ref=NIST IR 8200 @fetched=false>
+=>
+<RelatonNist::HitCollection:0x00000000004b28 @ref=NIST IR 8200 @fetched=false>
 
-item = hit_collection[0].fetch
-=> #<RelatonNist::NistBibliographicItem:0x007fc049aa6778
- ...
+> item = hit_collection[0].fetch
+=>
+#<RelatonNist::NistBibliographicItem:0x007fc049aa6778
+# ...
 ----
+====
 
-=== XML serialization
-[source,ruby]
-----
-item.to_xml
-=> "<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>
-      ...
-    <bibitem>"
-----
-With argument `bibdata: true` it outputs XML wrapped by `bibdata` element and adds flavor `ext` element.
-[source,ruby]
-----
-item.to_xml bibdata: true
-=> "<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>
-      ...
-      <ext schema-version="v1.0.0">
-        <doctype>standard</doctype>
-      </ext>
-  </bibdata>"
-----
 
-=== Get code, and year
+The publication year can also be given if the publication has seen multiple
+revisions or editions.
+
+.Retrieving a bibliographic entry using NIST PubID with year
+[example]
+====
 [source,ruby]
 ----
-RelatonNist::NistBibliography.get("NIST IR 8200", "2018")
+> RelatonNist::NistBibliography.get("NIST IR 8200", "2018")
 [relaton-nist] (NIST SP 8200:2018) Fetching from csrc.nist.gov ...
 [relaton-nist] (NIST IR 8200:2018) Fetching from Relaton repository...
 [relaton-nist] (NIST IR 8200:2018) Found: `NIST IR 8200`
-=> #<RelatonNist::NistBibliographicItem:0x00007fab74a572c0
-...
+=>
+#<RelatonNist::NistBibliographicItem:0x00007fab74a572c0
+# ...
 ----
+====
 
-=== Get short citation
-A short citation is a convention about a citation's format. The format for NIST publications is:
-----
-NIST {abbrev(series)} {docnumber} {(edition), optional} {(stage), optional}
-# or
-{abbrev(series)} {docnumber} {(edition), optional} {(stage), optional}
-----
-- `(stage)` is empty if the state is "final" (published). In case the state is "draft" it should be:
-  * PD for public draft
-  * IPD for initial iteration public draft or 2PD, 3PD and so one for following iterations
-  * FPD for final public draft
-- `(edition)` is the date of publication or update
-- `docnumber` is the full NIST number, including revision, e.g., 800-52
-
-The format for FIPS publications is:
-----
-FIPS {docnumber}
-# or
-NIST FIPS {docnumber}
-----
-[source,ruby]
-----
-RelatonNist::NistBibliography.get("NIST SP 800-205 (February 2019) (IPD)")
-[relaton-nist] (NIST SP 800-205) Fetching from csrc.nist.gov ...
-[relaton-nist] (NIST SP 800-205) Found: `NIST SP 800-205 (Draft)`
-=> #<RelatonNist::NistBibliographicItem:0x00000001105afdc8
-...
-----
 
-=== Get specific part, volume, version, revision, and addendum
+A NIST PubID can contain these optional parameters `{ptN}{vN}{verN}{rN}{/Add}`:
 
-Referehces can contain optional parameters `{ptN}{vN}{verN}{rN}{/Add}`:
-- Part is specified as `ptN` (SP 800-57pt1)
-- Volume is specified as `vN` (SP 800-60v1)
-- Version is specified as `verN` (SP 800-45ver2)
-- Revision is specified as `rN` (SP 800-40r3)
-- Addendum is specified as `/Add` (SP 800-38A/Add)
+* Part is specified as `ptN` (SP 800-57pt1)
+* Volume is specified as `vN` (SP 800-60v1)
+* Version is specified as `verN` (SP 800-45ver2)
+* Revision is specified as `rN` (SP 800-40r3) or `-N`
+* Addendum is specified as `/Add` (SP 800-38A/Add)
 
+.Retrieving a bibliographic entry with a PubID that contains revision
+[example]
+====
 [source,ruby]
 ----
 item = RelatonNist::NistBibliography.get 'NIST SP 800-67r1'
@@ -171,7 +178,14 @@ item = RelatonNist::NistBibliography.get 'NIST SP 800-67r1'
 
 item.docidentifier.first.id
 => "NIST SP 800-67 Rev. 1"
+----
+====
 
+.Retrieving a bibliographic entry with a PubID that specifies an addendum
+[example]
+====
+[source,ruby]
+----
 item = RelatonNist::NistBibliography.get 'NIST SP 800-38A/Add'
 [relaton-nist] (NIST SP 800-38A/Add) Fetching from csrc.nist.gov ...
 [relaton-nist] (NIST SP 800-38A/Add) Found: `NIST SP 800-38A-Add`
@@ -181,11 +195,132 @@ item = RelatonNist::NistBibliography.get 'NIST SP 800-38A/Add'
 item.docidentifier.first.id
 => "NIST SP 800-38A-Add"
 ----
+====
+
+==== By NIST PubID abbreviated form
+
+The NIST PubID "abbreviated form" is the form of PubID printed on the inner
+cover of a NIST publication.
+
+The NIST PubID abbreviated format has the following syntax:
+
+* `NIST {abbrev(series)} {docnumber} {(edition), optional} {(stage), optional}`, or
+* `{abbrev(series)} {docnumber} {(edition), optional} {(stage), optional}`
+
+Where,
 
-=== Typed links
+`(stage)`::
+empty if the state is "final" (published).
+In case the state is "draft" it should be:
+`PD`::: for the public draft
+`IPD`::: for the initial public draft
+`{n}PD`::: for subsequent public drafts, such as 2PD, 3PD and so on.
+`FPD`::: for the final public draft
 
-NIST documents may have `src` and `doi` link types.
+`(edition)`:: the date of publication or update
+`docnumber`:: the full NIST document number, e.g., 800-52.
 
+.Retrieving an entry using the NIST PubID abbreviated form
+[example]
+====
+[source,ruby]
+----
+> RelatonNist::NistBibliography.get("NIST SP 800-205 (February 2019) (IPD)")
+[relaton-nist] (NIST SP 800-205) Fetching from csrc.nist.gov ...
+[relaton-nist] (NIST SP 800-205) Found: `NIST SP 800-205 (Draft)`
+=>
+#<RelatonNist::NistBibliographicItem:0x00000001105afdc8
+# ...
+----
+====
+
+==== By FIPS PubID
+
+The format for FIPS publications is:
+
+* `FIPS {docnumber}`, or
+* `NIST FIPS {docnumber}`
+
+
+.Retrieving an entry using the FIPS PubID
+[example]
+====
+[source,ruby]
+----
+> RelatonNist::NistBibliography.get("NIST FIPS 140-3")
+[relaton-nist] INFO: (NIST FIPS 140-3) Fetching from csrc.nist.gov ...
+[relaton-nist] INFO: (NIST FIPS 140-3) Found: `NIST FIPS 140-3`
+=>
+# #<RelatonNist::NistBibliographicItem:0x000000013b68fb50
+# ...
+----
+====
+
+
+=== Serializing an entry
+
+==== To Relaton XML
+
+.Serializing an entry to Relaton XML
+[example]
+====
+[source,ruby]
+----
+> item.to_xml
+#=> "<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>
+#      ...
+#    <bibitem>"
+----
+====
+
+When the option `bibdata: true` is given, the method outputs XML wrapped by
+the `bibdata` element and adds a flavor-specific `ext` element.
+
+.Serializing an entry to Relaton XML with `bibdata: true`
+[example]
+====
+[source,ruby]
+----
+> item.to_xml bibdata: true
+=>
+"<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>
+#      ...
+#      <ext schema-version="v1.0.0">
+#        <doctype>standard</doctype>
+#      </ext>
+#  </bibdata>"
+----
+====
+
+
+
+=== Accessing attributes
+
+==== Identifier components
+
+A NIST PubID can contain these optional parameters `{ptN}{vN}{verN}{rN}{/Add}`.
+
+They can be accessed through the following methods:
+
+* `part`
+* `volume`
+* `version`
+* `revision`
+* `addendum`
+
+
+==== Typed links
+
+NIST publications may have `src` and `doi` links, obtained using the `#link`
+method.
+
+.Accessing links of a NIST bibliographic item
+[example]
+====
 [source,ruby]
 ----
 item.link
@@ -196,8 +331,20 @@ item.link
   @type="src">,
  #<RelatonBib::TypedUri:0x00000001110879a8 @content=#<Addressable::URI:0x8d4 URI:https://doi.org/10.6028/NIST.SP.800-38A-Add>, @language=nil, @script=nil, @type="doi">]
 ----
+====
+
+
+=== Loading entries
 
-=== Create bibliographic item from YAML
+// ==== From XML
+
+==== From YAML
+
+Offline Relaton YAML files can be loaded directly as bibliographic items.
+
+.Loading a Relaton YAML file
+[example]
+====
 [source,ruby]
 ----
 hash = YAML.load_file 'spec/examples/nist_bib_item.yml'
@@ -208,40 +355,65 @@ RelatonNist::NistBibliographicItem.from_hash hash
 => #<RelatonNist::NistBibliographicItem:0x007f8b708505b8
 ...
 ----
+====
+
 
-=== Fetch data
+=== Fetching data
 
-This gem uses the https://raw.githubusercontent.com/usnistgov/NIST-Tech-Pubs/nist-pages/xml/allrecords.xml dataset as one of data sources.
+On a search, the CSRC data sources are fetched and stored in the user's cache.
 
-The method `RelatonNist::DataFetcher.fetch(output: "data", format: "yaml")` fetches all the documents from the datast and save them to the `./data` folder in YAML format.
-Arguments:
+This gem uses the https://github.com/usnistgov/NIST-Tech-Pubs/releases/download/May2024/allrecords-MODS.xml dataset as NIST-Tech-Pubs data source.
 
-- `output` - folder to save documents (default './data').
-- `format` - the format in which the documents are saved. Possible formats are: `yaml`, `xml`, `bibxxml` (default `yaml`).
+The following method fetches all the documents from the NIST-Tech-Pubs dataset, then saves them to the `./data` folder in YAML format.
 
+.Fetching all data with default configuration
+[example]
+====
 [source,ruby]
 ----
-RelatonNist::DataFetcher.fetch
+> RelatonNist::DataFetcher.fetch
 Started at: 2021-09-01 18:01:01 +0200
 Stopped at: 2021-09-01 18:01:43 +0200
 Done in: 42 sec.
 => nil
 ----
+====
 
-=== Logging
+.Fetching all data to the `data` folder
+[example]
+====
+[source,ruby]
+----
+> RelatonNist::DataFetcher.fetch(output: "data", format: "yaml")
+----
+====
+
+Options:
+
+`output`:: folder to save documents (default `./data`).
+`format`:: format in which the documents are saved. Possible formats are:
+`yaml`::: (default) save in Relaton YAML format
+`xml`::: save in Relaton XML format
+`bibxml`::: save in the IETF BibXML format
 
-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
+=== Logging
+
+Relaton for NIST uses https://github.com/relaton/relaton-logger[relaton-logger]
+for logging.
 
-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.
+By default, it logs to `$STDOUT`. To change log levels and add other loggers,
+refer to the https://github.com/relaton/relaton-logger#usage[relaton-logger]
+documentation.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 == Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/metanorma/relaton-nist.
+Bug reports and pull requests are welcome.
 
 == License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+Copyright Ribose.
+
+The gem is available as open source under the terms of the
+https://opensource.org/licenses/MIT[MIT License].

data/lib/relaton_nist/data_fetcher.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
 require "yaml"
+require "loc_mods"
+require_relative "mods_parser"
 
 module RelatonNist
   class DataFetcher
-    URL = "https://raw.githubusercontent.com/usnistgov/NIST-Tech-Pubs/nist-pages/xml/allrecords.xml"
+    URL = "https://github.com/usnistgov/NIST-Tech-Pubs/releases/download/May2024/allrecords-MODS.xml"
 
     def initialize(output, format)
       @output = output
@@ -63,21 +65,23 @@ module RelatonNist
       t2 = Time.now
       puts "Stopped at: #{t2}"
       puts "Done in: #{(t2 - t1).round} sec."
-    rescue StandardError => e
-      Util.error "#{e.message}\n#{e.backtrace[0..5].join("\n")}"
+    # rescue StandardError => e
+    #   Util.error "#{e.message}\n#{e.backtrace[0..5].join("\n")}"
     end
 
     def fetch_tech_pubs
-      docs = Nokogiri::XML OpenURI.open_uri URL
-      docs.xpath(
-        "/body/query/doi_record/report-paper/report-paper_metadata",
-      ).each { |doc| write_file TechPubsParser.parse(doc, series) }
+      docs = LocMods::Collection.from_xml OpenURI.open_uri(URL)
+      # docs.xpath(
+      #   "/body/query/doi_record/report-paper/report-paper_metadata",
+      # )
+      docs.mods.each { |doc| write_file ModsParser.new(doc, series).parse }
     end
 
     def add_static_files
       Dir["./static/*.yaml"].each do |file|
         hash = YAML.load_file file
-        write_file RelatonNist::NistBibliographicItem.from_hash(hash)
+        bib = RelatonNist::NistBibliographicItem.from_hash(hash)
+        index.add_or_update bib.docidentifier[0].id, file
       end
     end
 

data/lib/relaton_nist/mods_parser.rb

@@ -0,0 +1,209 @@
+module RelatonNist
+  class ModsParser
+    RELATION_TYPES = {
+      "otherVersion" => "editionOf",
+      "preceding" => "updates",
+      "succeeding" => "updatedBy",
+    }.freeze
+
+    ATTRS = %i[type docid title link abstract date doctype contributor relation place series].freeze
+
+    def initialize(doc, series)
+      @doc = doc
+      @series = series
+    end
+
+    # @return [RelatonNist::NistBibliographicItem]
+    def parse
+      args = ATTRS.each_with_object({}) do |attr, hash|
+        hash[attr] = send("parse_#{attr}")
+      end
+      NistBibliographicItem.new(**args)
+    end
+
+    def parse_type
+      "standard"
+    end
+
+    # @return [Array<RelatonBib::DocumentIdentifier>]
+    def parse_docid
+      [
+        { type: "NIST", id: pub_id, primary: true },
+        { type: "DOI", id: doi },
+      ].map { |id| RelatonBib::DocumentIdentifier.new(**id) }
+    end
+
+    # @return [String]
+    def pub_id
+      get_id_from_str doi
+    end
+
+    def get_id_from_str(str)
+      str.match(/\/((?:NBS|NIST).+)/)[1].gsub(".", " ")
+    end
+
+    # @return [String]
+    def doi
+      url = @doc.location.reduce(nil) { |m, l| m || l.url.detect { |u| u.usage == "primary display" } }
+      id = url.content.match(/10\.6028\/.+/)[0]
+      case id
+      when "10.6028/NBS.CIRC.sup" then "10.6028/NBS.CIRC.24e7sup"
+      when "10.6028/NBS.CIRC.supJun1925-Jun1926" then "10.6028/NBS.CIRC.24e7sup2"
+      when "10.6028/NBS.CIRC.supJun1925-Jun1927" then "10.6028/NBS.CIRC.24e7sup3"
+      when "10.6028/NBS.CIRC.24supJuly1922" then "10.6028/NBS.CIRC.24e6sup"
+      when "10.6028/NBS.CIRC.24supJan1924" then "10.6028/NBS.CIRC.24e6sup2"
+      else id
+      end
+    end
+
+    # @return [Array<RelatonBib::TypedTitleString>]
+    def parse_title
+      title = @doc.title_info.reduce([]) do |a, ti|
+        next a if ti.type == "alternative"
+
+        a += ti.title.map { |t| create_title(t, "title-main", ti.non_sort[0]) }
+        a + ti.sub_title.map { |t| create_title(t, "title-part") }
+      end
+      if title.size > 1
+        content = title.map { |t| t.title.content }.join(" - ")
+        title << create_title(content, "main")
+      elsif title.size == 1
+        title[0].instance_variable_set :@type, "main"
+      end
+      title
+    end
+
+    def create_title(title, type, non_sort = nil)
+      content = title.gsub("\n", " ").squeeze(" ").strip
+      content = "#{non_sort.content}#{content}".squeeze(" ") if non_sort
+      RelatonBib::TypedTitleString.new content: content, type: type, language: "en", script: "Latn"
+    end
+
+    def parse_link
+      @doc.location.map do |location|
+        url = location.url.first
+        type = url.usage == "primary display" ? "doi" : "src"
+        RelatonBib::TypedUri.new content: url.content, type: type
+      end
+    end
+
+    def parse_abstract
+      @doc.abstract.map do |a|
+        content = a.content.gsub("\n", " ").squeeze(" ").strip
+        RelatonBib::FormattedString.new content: content, language: "en", script: "Latn"
+      end
+    end
+
+    def parse_date
+      date = @doc.origin_info[0].date_issued.map do |di|
+        create_date(di, "issued")
+      # end + @doc.record_info[0].record_creation_date.map do |rcd|
+      #   create_date(rcd, "created")
+      # end + @doc.record_info[0].record_change_date.map do |rcd|
+      #   create_date(rcd, "updated")
+      end
+      date.compact
+    end
+
+    def create_date(date, type)
+      RelatonBib::BibliographicDate.new type: type, on: decode_date(date)
+    rescue Date::Error
+    end
+
+    def decode_date(date)
+      if date.encoding == "marc" && date.content.size == 6
+        Date.strptime(date.content, "%y%m%d").to_s
+      elsif date.encoding == "iso8601"
+        Date.strptime(date.content, "%Y%m%d").to_s
+      else date.content
+      end
+    end
+
+    def parse_doctype
+      RelatonBib::DocumentType.new(type: "standard")
+    end
+
+    def parse_contributor
+      # eaxclude primary contributors to avoid duplication
+      @doc.name.reject { |n| n.usage == "primary" }.map do |name|
+        entity, default_role = create_entity(name)
+        next unless entity
+
+        role = name.role.reduce([]) do |a, r|
+          a + r.role_term.map { |rt| { type: rt.content } }
+        end
+        role << { type: default_role } if role.empty?
+        RelatonBib::ContributionInfo.new entity: entity, role: role
+      end.compact
+    end
+
+    def create_entity(name)
+      case name.type
+      when "personal" then [create_person(name), "author"]
+      when "corporate" then [create_org(name), "publisher"]
+      end
+    end
+
+    def create_person(name)
+      # exclude typed name parts because they are not actual name parts
+      cname = name.name_part.reject(&:type).map(&:content).join(" ")
+      complatename = RelatonBib::LocalizedString.new cname, "en"
+      fname = RelatonBib::FullName.new completename: complatename
+      name_id = name.name_identifier[0]
+      identifier = RelatonBib::PersonIdentifier.new "uri", name_id.content if name_id
+      RelatonBib::Person.new name: fname, identifier: [identifier]
+    end
+
+    def create_org(name)
+      names = name.name_part.reject(&:type).map { |n| n.content.gsub("\n", " ").squeeze(" ").strip }
+      url = name.name_identifier[0]&.content
+      id = RelatonBib::OrgIdentifier.new "uri", url if url
+      RelatonBib::Organization.new name: names, identifier: [id]
+    end
+
+    def parse_relation
+      @doc.related_item.reject { |ri| ri.type == "series" }.map do |ri|
+        type = RELATION_TYPES[ri.type]
+        RelatonBib::DocumentRelation.new(type: type, bibitem: create_related_item(ri))
+      end
+    end
+
+    def create_related_item(item)
+      item_id = get_id_from_str related_item_id(item)
+      docid = RelatonBib::DocumentIdentifier.new type: "NIST", id: item_id
+      fref = RelatonBib::FormattedRef.new content: item_id
+      NistBibliographicItem.new(docid: [docid], formattedref: fref)
+    end
+
+    def related_item_id(item)
+      if item.other_type && item.other_type[0..6] == "10.6028"
+        item.other_type
+      else
+        item.name[0].name_part[0].content
+      end
+    end
+
+    def parse_place
+      @doc.origin_info.select { |p| p.event_type == "publisher"}.map do |p|
+        place = p.place[0].place_term[0].content
+        /(?<city>\w+), (?<state>\w+)/ =~ place
+        RelatonBib::Place.new city: city, region: create_region(state)
+      end
+    end
+
+    def create_region(state)
+      [RelatonBib::Place::RegionType.new(iso: state)]
+    rescue ArgumentError
+      []
+    end
+
+    def parse_series
+      @doc.related_item.select { |ri| ri.type == "series" }.map do |ri|
+        tinfo = ri.title_info[0]
+        tcontent = tinfo.title[0].strip
+        title = RelatonBib::TypedTitleString.new content: tcontent
+        RelatonBib::Series.new title: title, number: tinfo.part_number[0]
+      end
+    end
+  end
+end

data/lib/relaton_nist/nist_bibliography.rb

@@ -123,7 +123,7 @@ module RelatonNist
           next if iter && r.status.iteration != iteration
           return { ret: r } if !year
 
-          r.date.select { |d| d.type == "published" }.each do |d|
+          r.date.select { |d| d.type == "published" || d.type == "issued" }.each do |d|
             return { ret: r } if year.to_i == d.on(:year)
 
             missed_years << d.on(:year)

data/lib/relaton_nist/version.rb

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

data/relaton_nist.gemspec

@@ -24,7 +24,8 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
   spec.add_dependency "base64"
-  spec.add_dependency "relaton-bib", "~> 1.19.0"
+  spec.add_dependency "loc_mods", "~> 0.2.0"
+  spec.add_dependency "relaton-bib", "~> 1.19.2"
   spec.add_dependency "relaton-index", "~> 0.2.0"
   spec.add_dependency "rubyzip"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-nist
 version: !ruby/object:Gem::Version
-  version: 1.19.0
+  version: 1.19.3
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-07-03 00:00:00.000000000 Z
+date: 2024-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -24,20 +24,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: loc_mods
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: relaton-bib
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.19.0
+        version: 1.19.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.19.0
+        version: 1.19.2
 - !ruby/object:Gem::Dependency
   name: relaton-index
   requirement: !ruby/object:Gem::Requirement
@@ -98,6 +112,7 @@ files:
 - lib/relaton_nist/hash_converter.rb
 - lib/relaton_nist/hit.rb
 - lib/relaton_nist/hit_collection.rb
+- lib/relaton_nist/mods_parser.rb
 - lib/relaton_nist/nist_bibliographic_item.rb
 - lib/relaton_nist/nist_bibliography.rb
 - lib/relaton_nist/processor.rb