relaton-ietf 1.7.4 → 1.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7b4e48f7bfedc080ef41fa038f678b702a45a500637e71be5444b87b74d460b
-  data.tar.gz: c8ccfe769f17ef85df427835b4f1116f125453b99b2f20ea29f97f74b9d39654
+  metadata.gz: 7026502f569da127c8de60c69942d7c30959b942edf9b60e26145672f5f3e362
+  data.tar.gz: f8873f10d5cdf54fba4c5a097988eccfdc5607dfcc754b739bcc8380c70719e0
 SHA512:
-  metadata.gz: ab65e6e326efce9ebdff092f34814e774f73388aef294ab1b96e2286ffcaca74a7bd69d4c0701bf85beba62b6a3e5c9a3eacddf854566649f8e224634e07e303
-  data.tar.gz: e8624b553831ccbcefbbb4385127c75f9535b4f2d3d786af5ab040ec1d75a3509813fb6cdc269df26a24b91f223f166edb015682507ae61d30df89c672a2d4c4
+  metadata.gz: 93e3c02df7e66931b857c8578cc80ed91f02ddb72fb2779413611789f0768bcff3a76fd8e1d11b625390ae14f0a115584ccba7d4afc31144e76168ca0aa929b7
+  data.tar.gz: 6c827a3ea89d38f28e6ec5b0b2c3bbe490ec1ea88f400821d14ff21c548dfda0527ba741b743505fe06dfa2661821caf428689cbc474535a77b5f6baac38b33f

data/README.adoc

@@ -33,19 +33,30 @@ Or install it yourself as:
 
 == Usage
 
-=== Search document
+=== Fetching documents
 
 [source,ruby]
 ----
 require 'relaton_ietf'
 
-item = RelatonIetf::IetfBibliography.search 'RFC 8341'
+# 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.search '1111'
-RelatonBib::RequestError: 1111: not recognised for RFC
+RelatonIetf::IetfBibliography.get 'IETF 1111'
+[relaton-ietf] ("IETF 1111") fetching...
+[relaton-ietf] ("IETF 1111") not found
 => nil
 ----
 

data/lib/relaton_ietf/hash_converter.rb

@@ -5,7 +5,7 @@ module RelatonIetf
       # Ovverides superclass's method
       #
       # @param item [Hash]
-      # @retirn [RelatonIec::IecBibliographicItem]
+      # @retirn [RelatonIetf::IetfBibliographicItem]
       def bib_item(item)
         IetfBibliographicItem.new(**item)
       end

data/lib/relaton_ietf/ietf_bibliography.rb

@@ -20,7 +20,11 @@ module RelatonIetf
       def get(code, _year = nil, _opts = {})
         warn "[relaton-ietf] (\"#{code}\") fetching..."
         result = search code
-        warn "[relaton-ietf] (\"#{code}\") found #{result.docidentifier.first.id}"
+        if result
+          warn "[relaton-ietf] (\"#{code}\") found #{result.docidentifier.first.id}"
+        else
+          warn "[relaton-ietf] (\"#{code}\") not found"
+        end
         result
       end
     end

data/lib/relaton_ietf/scrapper.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "net/http"
-require "nokogiri"
 require "relaton_bib"
 require "relaton_ietf/ietf_bibliographic_item"
 
@@ -17,16 +16,16 @@ module RelatonIetf
       # @param text [String]
       # @param is_relation [TrueClass, FalseClass]
       # @return [RelatonIetf::IetfBibliographicItem]
-      def scrape_page(text, is_relation = false)
+      def scrape_page(text, is_relation: false)
         # Remove initial "IETF " string if specified
         ref = text.gsub(/^IETF /, "")
-        /^(RFC|BCP|FYI|STD)\s(?<num>\d+)/ =~ ref
+        /^(?:RFC|BCP|FYI|STD)\s(?<num>\d+)/ =~ ref
         ref.sub! /(?<=^(?:RFC|BCP|FYI|STD)\s)(\d+)/, num.rjust(4, "0") if num
         rfc_item ref, is_relation
       rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError,
              Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError,
              Net::ProtocolError, SocketError
-        raise RelatonBib::RequestError, "No document found for #{ref} reference."
+        raise RelatonBib::RequestError, "No document found for #{ref} reference"
       end
 
       # @param reference [Nokogiri::XML::Element, nil]
@@ -34,7 +33,7 @@ module RelatonIetf
       # @param url [String, NilClass]
       # @param ver [String, NilClass] Internet Draft version
       # @return [RelatonIetf::IetfBibliographicItem]
-      def fetch_rfc(reference, is_relation = false, url = nil, ver = nil) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+      def fetch_rfc(reference, is_relation: false, url: nil, ver: nil) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
         return unless reference
 
         ietf_item(
@@ -54,7 +53,7 @@ module RelatonIetf
           series: series(reference),
           place: ["Fremont, CA"],
           keyword: reference.xpath("front/keyword").map(&:text),
-          doctype: doctype(reference[:anchor])
+          doctype: doctype(reference[:anchor]),
         )
       end
 
@@ -92,6 +91,7 @@ module RelatonIetf
       end
 
       # @param ref [String]
+      # @param is_relation [Boolen, nil]
       # @return [RelatonIetf::IetfBibliographicItem]
       def rfc_item(ref, is_relation)
         /(?<=-)(?<ver>\d{2})$/ =~ ref
@@ -102,14 +102,15 @@ module RelatonIetf
 
         uri = "#{GH_URL}#{ref.sub(/\s|\u00a0/, '.')}.xml"
         doc = Nokogiri::XML get_page(uri)
-        fetch_rfc doc.at("/referencegroup", "/reference"), is_relation, uri, ver
+        r = doc.at("/referencegroup", "/reference")
+        fetch_rfc r, is_relation: is_relation, url: uri, ver: ver
       end
 
       # @param reference [Nokogiri::XML::Element]
       # @return [Hash]
       def relations(reference)
         reference.xpath("reference").map do |ref|
-          { type: "includes", bibitem: fetch_rfc(ref, true) }
+          { type: "includes", bibitem: fetch_rfc(ref, is_relation: true) }
         end
       end
 
@@ -117,9 +118,10 @@ module RelatonIetf
       # @return [String] HTTP response body
       def get_page(uri)
         res = Net::HTTP.get_response(URI(uri))
-        if res.code != "200"
-          raise RelatonBib::RequestError, "No document found at #{uri}"
-        end
+        return unless res.code == "200"
+
+        #   raise RelatonBib::RequestError, "No document found at #{uri}"
+        # end
 
         res.body
       end
@@ -144,7 +146,11 @@ module RelatonIetf
         return if reference.at "./fornt/title"
 
         cont = (reference[:anchor] || reference[:docName] || reference[:number])
-        RelatonBib::FormattedRef.new content: cont, language: language(reference), script: "Latn" if cont
+        if cont
+          RelatonBib::FormattedRef.new(
+            content: cont, language: language(reference), script: "Latn",
+          )
+        end
       end
 
       # @param reference [Nokogiri::XML::Element]
@@ -172,14 +178,15 @@ module RelatonIetf
           entity = RelatonBib::Person.new(
             name: full_name(author, reference),
             affiliation: [affiliation(author)],
-            contact: contacts(author.at("./address"))
+            contact: contacts(author.at("./address")),
           )
           { entity: entity, role: [contributor_role(author)] }
         end
       end
 
       # @param reference [Nokogiri::XML::Element]
-      # @return [Array<Hash{Symbol=>RelatonBib::Organization,Symbol=>Array<String>}>]
+      # @return [Array<Hash{Symbol=>RelatonBib::Organization,
+      #   Symbol=>Array<String>}>]
       def organizations(reference)
         publisher = { entity: new_org, role: [type: "publisher"] }
         orgs = reference.xpath("./seriesinfo").reduce([publisher]) do |mem, si|
@@ -188,7 +195,7 @@ module RelatonIetf
           mem << { entity: new_org(si[:stream], nil), role: [type: "author"] }
         end
         orgs + reference.xpath(
-          "front/author[not(@surname)][not(@fullname)]/organization"
+          "front/author[not(@surname)][not(@fullname)]/organization",
         ).map do |org|
           { entity: new_org(org.text, nil), role: [type: "author"] }
         end
@@ -202,7 +209,7 @@ module RelatonIetf
         RelatonBib::FullName.new(
           completename: localized_string(author[:fullname], lang),
           initial: [localized_string(author[:initials], lang)].compact,
-          surname: localized_string(author[:surname], lang)
+          surname: localized_string(author[:surname], lang),
         )
       end
 
@@ -237,7 +244,7 @@ module RelatonIetf
           city: postal.at("./city")&.text,
           postcode: postal.at("./code")&.text,
           country: postal.at("./country")&.text,
-          state: postal.at("./region")&.text
+          state: postal.at("./region")&.text,
         )
       end
 
@@ -309,7 +316,7 @@ module RelatonIetf
         ret = []
         if id
           ret << RelatonBib::DocumentIdentifier.new(
-            type: "IETF", id: id.sub(/^(RFC)/, "\\1 ")
+            type: "IETF", id: id.sub(/^(RFC)/, "\\1 "),
           )
         end
         if (id = reference[:anchor])
@@ -336,10 +343,10 @@ module RelatonIetf
 
           RelatonBib::Series.new(
             title: RelatonBib::TypedTitleString.new(
-              content: si[:name], language: language(reference), script: "Latn"
+              content: si[:name], language: language(reference), script: "Latn",
             ),
             number: si[:value],
-            type: "main"
+            type: "main",
           )
         end.compact
       end

data/lib/relaton_ietf/version.rb

@@ -1,3 +1,3 @@
 module RelatonIetf
-  VERSION = "1.7.4".freeze
+  VERSION = "1.7.5".freeze
 end

data/relaton_ietf.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   # spec.add_development_dependency "debase"
   spec.add_development_dependency "equivalent-xml", "~> 0.6"
   spec.add_development_dependency "pry-byebug"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   # spec.add_development_dependency "ruby-debug-ide"
   spec.add_development_dependency "ruby-jing"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-ietf
 version: !ruby/object:Gem::Version
-  version: 1.7.4
+  version: 1.7.5
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-19 00:00:00.000000000 Z
+date: 2021-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: equivalent-xml
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -190,7 +190,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: 'RelatonIetf: retrieve IETF Standards for bibliographic use using the BibliographicItem