relaton-iana 1.9.2

data/grammars/reqt.rng

@@ -0,0 +1,194 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<grammar xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
+  <!--
+    Presupposes isodoc.rnc, is included in it
+    include "isodoc.rnc" { }
+  -->
+  <define name="requirement">
+    <element name="requirement">
+      <ref name="RequirementType"/>
+    </element>
+  </define>
+  <define name="recommendation">
+    <element name="recommendation">
+      <ref name="RequirementType"/>
+    </element>
+  </define>
+  <define name="permission">
+    <element name="permission">
+      <ref name="RequirementType"/>
+    </element>
+  </define>
+  <define name="RequirementType">
+    <optional>
+      <attribute name="obligation">
+        <ref name="ObligationType"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="unnumbered">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="number"/>
+    </optional>
+    <optional>
+      <attribute name="subsequence"/>
+    </optional>
+    <optional>
+      <attribute name="keep-with-next">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="keep-lines-together">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
+    <attribute name="id">
+      <data type="ID"/>
+    </attribute>
+    <optional>
+      <attribute name="filename"/>
+    </optional>
+    <optional>
+      <attribute name="model"/>
+    </optional>
+    <optional>
+      <attribute name="type"/>
+    </optional>
+    <optional>
+      <ref name="reqtitle"/>
+    </optional>
+    <optional>
+      <ref name="label"/>
+    </optional>
+    <optional>
+      <ref name="subject"/>
+    </optional>
+    <zeroOrMore>
+      <ref name="reqinherit"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="classification"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <choice>
+        <ref name="measurementtarget"/>
+        <ref name="specification"/>
+        <ref name="verification"/>
+        <ref name="import"/>
+        <ref name="description"/>
+      </choice>
+    </zeroOrMore>
+    <optional>
+      <ref name="reqt_references"/>
+    </optional>
+    <zeroOrMore>
+      <choice>
+        <ref name="requirement"/>
+        <ref name="recommendation"/>
+        <ref name="permission"/>
+      </choice>
+    </zeroOrMore>
+  </define>
+  <define name="reqtitle">
+    <element name="title">
+      <ref name="FormattedString"/>
+    </element>
+  </define>
+  <define name="label">
+    <element name="label">
+      <text/>
+    </element>
+  </define>
+  <define name="subject">
+    <element name="subject">
+      <text/>
+    </element>
+  </define>
+  <define name="reqinherit">
+    <element name="inherit">
+      <text/>
+    </element>
+  </define>
+  <define name="measurementtarget">
+    <element name="measurement-target">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="specification">
+    <element name="specification">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="verification">
+    <element name="verification">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="import">
+    <element name="import">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="description">
+    <element name="description">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="reqt_references">
+    <element name="references">
+      <oneOrMore>
+        <ref name="bibitem"/>
+      </oneOrMore>
+    </element>
+  </define>
+  <define name="RequirementSubpart">
+    <optional>
+      <attribute name="type"/>
+    </optional>
+    <optional>
+      <attribute name="exclude">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="keep-with-next">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="keep-lines-together">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
+    <oneOrMore>
+      <ref name="BasicBlock"/>
+    </oneOrMore>
+  </define>
+  <define name="ObligationType">
+    <choice>
+      <value>requirement</value>
+      <value>recommendation</value>
+      <value>permission</value>
+    </choice>
+  </define>
+  <define name="classification">
+    <element name="classification">
+      <ref name="classification_tag"/>
+      <ref name="classification_value"/>
+    </element>
+  </define>
+  <define name="classification_tag">
+    <element name="tag">
+      <text/>
+    </element>
+  </define>
+  <define name="classification_value">
+    <element name="value">
+      <text/>
+    </element>
+  </define>
+</grammar>

data/lib/relaton_iana/data_fetcher.rb

@@ -0,0 +1,115 @@
+module RelatonIana
+  class DataFetcher
+    SOURCE = "https://raw.githubusercontent.com/ietf-ribose/iana-registries/main/"
+
+    #
+    # Data fetcher initializer
+    #
+    # @param [String] output directory to save files
+    # @param [String] format format of output files (xml, yaml, bibxml)
+    #
+    def initialize(output, format)
+      @output = output
+      @format = format
+      @ext = format.sub(/^bib/, "")
+      @files = []
+    end
+
+    #
+    # Initialize fetcher and run fetch
+    #
+    # @param [Strin] output directory to save files, default: "data"
+    # @param [Strin] format format of output files (xml, yaml, bibxml), default: yaml
+    #
+    def self.fetch(output: "data", format: "yaml")
+      t1 = Time.now
+      puts "Started at: #{t1}"
+      FileUtils.mkdir_p output unless Dir.exist? output
+      new(output, format).fetch
+      t2 = Time.now
+      puts "Stopped at: #{t2}"
+      puts "Done in: #{(t2 - t1).round} sec."
+    end
+
+    #
+    # Parse documents
+    #
+    def fetch(page = 1) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      params = {
+        q: "repo:ietf-ribose/iana-registries extension:xml",
+        page: page, per_page: 100
+      }
+      if ENV["GITHUB_TOKEN"]
+        headers = { "Authorization" => "token #{ENV['GITHUB_TOKEN']}" }
+      end
+      attempt = 0
+      json = {}
+      until attempt > 3 || json["items"]
+        if attempt.positive?
+          warn "Rate limit is reached. Retrying in 30 sec."
+          sleep 30
+        end
+        attempt += 1
+        resp = Faraday.get "https://api.github.com/search/code", params, headers
+        json = JSON.parse resp.body
+      end
+      raise StandardError, json["message"] if json["message"]
+
+      json["items"].each do |item|
+        fetch_doc URI.join(SOURCE, item["path"]).to_s
+      end
+      fetch(page + 1) if (json["total_count"] - (page * 100)).positive?
+    end
+
+    def fetch_doc(url) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+      resp = Net::HTTP.get_response URI(url)
+      if resp.code == "200"
+        return unless resp.body.include? "<registry"
+
+        xml = Nokogiri::XML(resp.body)
+        registry = xml.at("/xmlns:registry")
+        doc = Parser.parse registry
+        save_doc doc
+        registry.xpath("./xmlns:registry").each do |r|
+          save_doc Parser.parse(r, doc)
+        end
+      end
+    rescue StandardError => e
+      warn "Error: #{e.message}. URL: #{url}"
+    end
+
+    #
+    # Save document to file
+    #
+    # @param [RelatonW3c::W3cBibliographicItem, nil] bib bibliographic item
+    #
+    def save_doc(bib) # rubocop:disable Metrics/MethodLength
+      return unless bib
+
+      c = case @format
+          when "xml" then bib.to_xml(bibdata: true)
+          when "yaml" then bib.to_hash.to_yaml
+          else bib.send("to_#{@format}")
+          end
+      file = file_name(bib)
+      if @files.include? file
+        warn "File #{file} already exists. Document: #{bib.docnumber}"
+      else
+        @files << file
+      end
+      File.write file, c, encoding: "UTF-8"
+    end
+
+    #
+    # Generate file name
+    #
+    # @param [RelatonW3c::W3cBibliographicItem] bib bibliographic item
+    #
+    # @return [String] file name
+    #
+    def file_name(bib)
+      name = bib.docnumber.gsub(/[\s,:\/]/, "_").squeeze("_")
+      File.join @output, "#{name}.#{@ext}"
+    end
+  end
+end

data/lib/relaton_iana/iana_bibliographic_item.rb

@@ -0,0 +1,5 @@
+module RelatonIana
+  # IANA Bibliographic Item
+  class IanaBibliographicItem < RelatonBib::BibliographicItem
+  end
+end

data/lib/relaton_iana/iana_bibliography.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module RelatonIana
+  # Methods for search IANA standards.
+  module IanaBibliography
+    SOURCE = "https://raw.githubusercontent.com/relaton/relaton-data-iana/main/data/"
+
+    # @param text [String]
+    # @return [RelatonBib::BibliographicItem]
+    def search(text) # rubocop:disable Metrics/MethodLength
+      file = text.sub(/^IANA\s/, "").gsub(/[\s,:\/]/, "_")
+      url = "#{SOURCE}#{file}.yaml"
+      resp = Net::HTTP.get_response URI(url)
+      hash = YAML.safe_load resp.body
+      RelatonBib::BibliographicItem.from_hash hash
+    rescue SocketError, Timeout::Error, Errno::EINVAL, Errno::ECONNRESET,
+           EOFError, Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError,
+           Net::ProtocolError, Errno::ETIMEDOUT => e
+      raise RelatonBib::RequestError, e.message
+    end
+
+    # @param ref [String] the W3C standard Code to look up
+    # @param year [String, NilClass] not used
+    # @param opts [Hash] options
+    # @return [RelatonBib::BibliographicItem]
+    def get(ref, _year = nil, _opts = {})
+      warn "[relaton-iana] (\"#{ref}\") fetching..."
+      result = search(ref)
+      return unless result
+
+      warn "[relaton-iana] (\"#{ref}\") found #{result.docidentifier[0].id}"
+      result
+    end
+
+    extend IanaBibliography
+  end
+end

data/lib/relaton_iana/parser.rb

@@ -0,0 +1,119 @@
+module RelatonIana
+  class Parser
+    #
+    # Document parser initalization
+    #
+    # @param [Nokogiri::XML::Element] xml
+    #
+    def initialize(xml, rootdoc)
+      @xml = xml
+      @rootdoc = rootdoc
+    end
+
+    #
+    # Initialize document parser and run it
+    #
+    # @param [Nokogiri::XML::Element] xml
+    #
+    # @return [RelatonBib:BibliographicItem, nil] bibliographic item
+    #
+    def self.parse(xml, rootdoc = nil)
+      new(xml, rootdoc).parse
+    end
+
+    #
+    # Parse document
+    #
+    # @return [RelatonBib:BibliographicItem, nil] bibliographic item
+    #
+    def parse # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+      return unless @xml
+
+      RelatonBib::BibliographicItem.new(
+        type: "standard",
+        fetched: Date.today.to_s,
+        language: ["en"],
+        script: ["Latn"],
+        title: parse_title,
+        link: parse_link,
+        docid: parse_docid,
+        docnumber: docnumber,
+        date: parse_date,
+        contributor: contributor,
+      )
+    end
+
+    #
+    # Parse title
+    #
+    # @return [RelatonBib::TypedTitleStringCollection] title
+    #
+    def parse_title
+      content = @xml.at("./xmlns:title")&.text || @xml[:id]
+      t = RelatonBib::TypedTitleString.new content: content
+      RelatonBib::TypedTitleStringCollection.new [t]
+    end
+
+    #
+    # Parse link
+    #
+    # @return [Array<RelatonBib::TypedUri>] link
+    #
+    def parse_link
+      if @rootdoc then @rootdoc.link
+      else
+        uri = URI.join @xml.namespace.href.sub(/(?<=[^\/])$/, "/"), @xml[:id]
+        [RelatonBib::TypedUri.new(type: "src", content: uri.to_s)]
+      end
+    end
+
+    #
+    # Parse docidentifier
+    #
+    # @return [Arra<RelatonBib::DocumentIdentifier>] docidentifier
+    #
+    def parse_docid
+      [RelatonBib::DocumentIdentifier.new(type: "IANA", id: pub_id)]
+    end
+
+    #
+    # Generate PubID
+    #
+    # @return [String] PubID
+    #
+    def pub_id
+      "IANA #{docnumber}"
+    end
+
+    def docnumber
+      dn = ""
+      dn += "#{@rootdoc.docnumber}/" if @rootdoc
+      dn + @xml["id"]
+    end
+
+    #
+    # Parse date
+    #
+    # @return [Array<RelatonBib::BibliographicDate>] date
+    #
+    def parse_date
+      d = @xml.xpath("./xmlns:created|./xmlns:published|./xmlns:updated").map do |d|
+        RelatonBib::BibliographicDate.new(type: d.name, on: d.text)
+      end
+      d.none? && @rootdoc ? @rootdoc.date : d
+    end
+
+    #
+    # Create contributor
+    #
+    # @return [Array<RelatonBib::Contribution>] contributor
+    #
+    def contributor
+      org = RelatonBib::Organization.new(
+        name: "Internet Assigned Numbers Authority", abbreviation: "IANA",
+      )
+      role = { type: "publisher" }
+      [RelatonBib::ContributionInfo.new(entity: org, role: [role])]
+    end
+  end
+end

data/lib/relaton_iana/processor.rb

@@ -0,0 +1,54 @@
+require "relaton/processor"
+
+module RelatonIana
+  class Processor < Relaton::Processor
+    attr_reader :idtype
+
+    def initialize # rubocop:disable Lint/MissingSuper
+      @short = :relaton_iana
+      @prefix = "IANA"
+      @defaultprefix = %r{^IANA\s}
+      @idtype = "IANA"
+      @datasets = %w[iana-registries]
+    end
+
+    # @param code [String]
+    # @param date [String, NilClass] year
+    # @param opts [Hash]
+    # @return [RelatonBib::BibliographicItem]
+    def get(code, date, opts)
+      ::RelatonIana::IanaBibliography.get(code, date, opts)
+    end
+
+    #
+    # Fetch all the documents from https://github.com/ietf-ribose/iana-registries
+    #
+    # @param [String] _source source name
+    # @param [Hash] opts
+    # @option opts [String] :output directory to output documents
+    # @option opts [String] :format
+    #
+    def fetch_data(_source, opts)
+      DataFetcher.fetch(**opts)
+    end
+
+    # @param xml [String]
+    # @return [RelatonBib::BibliographicItem]
+    def from_xml(xml)
+      ::RelatonBib::XMLParser.from_xml xml
+    end
+
+    # @param hash [Hash]
+    # @return [RelatonIana::BibliographicItem]
+    def hash_to_bib(hash)
+      item_hash = ::RelatonBib::HashConverter.hash_to_bib(hash)
+      ::RelatonWBib::BibliographicItem.new(**item_hash)
+    end
+
+    # Returns hash of XML grammar
+    # @return [String]
+    def grammar_hash
+      @grammar_hash ||= ::RelatonIana.grammar_hash
+    end
+  end
+end

data/lib/relaton_iana/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RelatonIana
+  VERSION = "1.9.2"
+end

data/lib/relaton_iana.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "relaton_bib"
+require_relative "relaton_iana/version"
+require_relative "relaton_iana/iana_bibliography"
+require_relative "relaton_iana/parser"
+require_relative "relaton_iana/data_fetcher"
+
+module RelatonIana
+  class Error < StandardError; end
+
+  # Returns hash of XML reammar
+  # @return [String]
+  def self.grammar_hash
+    gem_path = File.expand_path "..", __dir__
+    grammars_path = File.join gem_path, "grammars", "*"
+    grammars = Dir[grammars_path].sort.map { |gp| File.read gp }.join
+    Digest::MD5.hexdigest grammars
+  end
+end

data/relaton_iana.gemspec

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require_relative "lib/relaton_iana/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "relaton-iana"
+  spec.version       = RelatonIana::VERSION
+  spec.authors       = ["Ribose Inc."]
+  spec.email         = ["open.source@ribose.com"]
+
+  spec.summary       = "RelatonIana: Ruby XMLDOC impementation."
+  spec.description   = "RelatonIana: Ruby XMLDOC impementation."
+  spec.homepage      = "https://github.com/relaton/relaton-iana"
+  spec.license       = "BSD-2-Clause"
+  spec.required_ruby_version = ">= 2.5.0"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'https://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "equivalent-xml", "~> 0.6"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop-performance"
+  spec.add_development_dependency "rubocop-rails"
+  spec.add_development_dependency "ruby-jing"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+
+  spec.add_dependency "faraday", "~> 1.8.0"
+  spec.add_dependency "relaton-bib", "~> 1.9.0"
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end