Formerly known as rfcbib.

RelatonIetf is a Ruby gem that search and fetch standards from the Internet Engineering Task Force (IETF), including RFCs.

The standards scrape form https://www.rfc-editor.org/search/rfc_search.php

Installation

Add this line to your application’s Gemfile:

gem 'relaton-ietf'

And then execute:

$ bundle

Or install it yourself as:

$ gem install relaton-ietf

Usage

Fetching documents

require 'relaton_ietf'

# Fetch RFC document
item = RelatonIetf::IetfBibliography.get 'IETF RFC 8341'
[relaton-ietf] ("IETF RFC 8341") fetching...
[relaton-ietf] ("IETF RFC 8341") found RFC 8341
=> #<RelatonIetf::IetfBibliographicItem:0x007fd1875e7f58
...

# Fetch Internet-Draft document
RelatonIetf::IetfBibliography.get 'IETF I-D.abarth-cake-02'
[relaton-ietf] ("IETF I-D.abarth-cake-02") fetching...
[relaton-ietf] ("IETF I-D.abarth-cake-02") found I-D.abarth-cake
=> #<RelatonIetf::IetfBibliographicItem:0x00007fa7c81688f8
...

# Return nil if document doesn't exist.
RelatonIetf::IetfBibliography.get 'IETF 1111'
[relaton-ietf] ("IETF 1111") fetching...
[relaton-ietf] ("IETF 1111") not found
=> nil

Serialization

item.to_xml
=>"<bibitem id="RFC8341">
  <fetched>2019-06-05</fetched>
  <title format="text/plain" language="en" script="Latn">Network Configuration Access Control Model</title>
  <uri type="src">https://www.rfc-editor.org/info/rfc8341</uri>
  <docidentifier type="IETF">RFC 8341</docidentifier>
  <docidentifier type=\"rfc-anchor\">RFC8341</docidentifier>
  <docidentifier type="DOI">10.17487/RFC8341</docidentifier>
  ....
</bibitem>"

With bibdata: true option XML output wrapped with bibdata element and ext element added.

item.to_xml bibdata: true
=>"<bibdata>
  <fetched>2019-06-05</fetched>
  <title format="text/plain" language="en" script="Latn">Network Configuration Access Control Model</title>
  <uri type="src">https://www.rfc-editor.org/info/rfc8341</uri>
  ...
  <ext>
    <doctype>rfc</doctype>
  </ext>
</bibdata>"

Typed links

IETF documents may have src, xml, and doi link type.

• src - web pulication

• xml - BibXML publication

• doi - DOI reference

item.link
=> [#<RelatonBib::TypedUri:0x00007fe8b287a120 @content=#<Addressable::URI:0x7e4 URI:https://raw.githubusercontent.com/relaton/relaton-data-ietf/master/data/reference.RFC.8341.xml>, @type="xml">,
 #<RelatonBib::TypedUri:0x00007fe8b2237ec0 @content=#<Addressable::URI:0x7f8 URI:https://www.rfc-editor.org/info/rfc8341>, @type="src">]

Parse a file locally

item = Relaton::Provider::Ietf.from_rfcxml File.read("spec/examples/rfc.xml")
=> #<RelatonIetf::IetfBibliographicItem:0x007fa8cda79ab8
...

item.to_xml bibdata: true
=>"<bibdata>
  <fetched>2020-09-15</fetched>
  <title format="text/plain" language="en" script="Latn">ACVP Secure Hash Algorithm (SHA) JSON Specification</title>
  ...
</bibdata>"

Create bibliographic item form YAML

hash = YAML.load_file 'spec/examples/ietf_bib_item.yml'
=> {"id"=>"RFC 8341",
...

RelatonIetf::IetfBibliographicItem.from_hash hash
=> #<RelatonIetf::IetfBibliographicItem:0x007f9a929dde40
...

Fetch data

There is a IETF datasets what can be converted into RelatonXML/BibXML/BibYAML formats:

• ietf-rfcsubseries - https://www.rfc-editor.org/rfc-index.xml (<bcp-entry>, <fyi-entry>, <std-entry>)

• ietf-internet-drafts - https://www.ietf.org/lib/dt/sprint/bibxml-ids.tgz

• ietf-rfc-entries - https://www.rfc-editor.org/rfc-index.xml (<rfc-entry>)

The method RelatonIetf::DataFetcher.fetch(source, output: "data", format: "yaml") converts all the documents from the dataset and save them to the ./data folder in YAML format.

Arguments:

• source - dataset name (ietf-rfcsubseries or ietf-internet-drafts)

• output - folder to save documents (default './data').

• format - format in which the documents are saved. Possimle formats are: yaml, xml, bibxml (default yaml).

For ietf-rfcsubseries dataset only special XML format is supported:

<referencegroup anchor="BCP14" target="https://www.rfc-editor.org/info/bcp14">
  <xi:include href="https://www.rfc-editor.org/refs/bibxml/reference.RFC.2119.xml" />
  <xi:include href="https://www.rfc-editor.org/refs/bibxml/reference.RFC.8174.xml" />
</referencegroup>

RelatonIetf::DataFetcher.fetch "ietf-internet-drafts"
Started at: 2021-12-17 10:23:20 +0100
Stopped at: 2021-12-17 10:29:19 +0100
Done in: 360 sec.
=> nil

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/metanorma/relaton-ietf.

License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).