relaton-ietf 0.1.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f9bf4b1db7471743fbce87d242ebd9f8a7a59630
-  data.tar.gz: deb0f7674386a76f577671a1f6f883249ffe0beb
+SHA256:
+  metadata.gz: 33879fa83239ce32ea3250fed0bd411ed656fc7303bbff65dbb5d5ecb747ea94
+  data.tar.gz: 1b83f019952a45692196cb5b96907cda925c47961d979ad8ba4f49a5d8c027da
 SHA512:
-  metadata.gz: fc38e9bdf1be20eaeb09b3b6b42783af101a40ac3f1e3238d46d23a1612cb5dbc8748d43079db05338c0d9dc28ae4998dcd1684f81236367297276675c398876
-  data.tar.gz: 38d10c12570ff5836b1421776b8eedde6f3ccc7118ef78b2db4fb25ef51a7a5229600a2eedc7ef5cee7d5a8b1f4e2be59bbc8b1b8d23e5ae8faab38fe6b05a2f
+  metadata.gz: 3eaba13be94a5c8dd3e0708cc2dee4d92f96195f0c08796a6123f61e17455845eca11e053eb8b0e1e26fd01f49954ab14ee1702b8d4b95a95215b37ddbaa4afa
+  data.tar.gz: 6fde3c29eb5e8109b6cb38d4f5937022bb67dae504568a45a9e000c1a172541a1f9f00efe027516f7d49de85251af4d56d99a2a4c2da79714c02c25a923e03ec

data/Gemfile.lock

@@ -2,7 +2,7 @@ PATH
   remote: .
   specs:
     relaton-ietf (0.1.0)
-      relaton-iso-bib (~> 0.1.0)
+      relaton-iso-bib (~> 0.2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -15,9 +15,9 @@ GEM
       safe_yaml (~> 1.0.0)
     debase (0.2.2)
       debase-ruby_core_source (>= 0.10.2)
-    debase-ruby_core_source (0.10.4)
+    debase-ruby_core_source (0.10.5)
     diff-lcs (1.3)
-    docile (1.3.1)
+    docile (1.3.2)
     equivalent-xml (0.6.0)
       nokogiri (>= 1.4.3)
     hashdiff (0.4.0)
@@ -35,28 +35,28 @@ GEM
       pry (~> 0.10)
     public_suffix (3.1.0)
     rake (10.5.0)
-    relaton-bib (0.1.6)
+    relaton-bib (0.2.0)
       addressable
       nokogiri (~> 1.8.4)
-    relaton-iso-bib (0.1.0)
+    relaton-iso-bib (0.2.0)
       isoics (~> 0.1.6)
       nokogiri (~> 1.8.4)
-      relaton-bib (~> 0.1.5)
+      relaton-bib (~> 0.2.0)
       ruby_deep_clone (~> 0.8.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
       rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
+    rspec-core (3.8.1)
       rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.3)
+    rspec-expectations (3.8.4)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+    rspec-mocks (3.8.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    ruby-debug-ide (0.6.1)
+    rspec-support (3.8.2)
+    ruby-debug-ide (0.7.0)
       rake (>= 0.8.1)
     ruby_deep_clone (0.8.0)
     safe_yaml (1.0.5)
@@ -66,10 +66,10 @@ GEM
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
     vcr (5.0.0)
-    webmock (3.5.1)
+    webmock (3.6.0)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
-      hashdiff
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   ruby

data/README.adoc

@@ -115,6 +115,19 @@ item.to_xml bibdata: true
 </bibdata>"
 ----
 
+=== Parse a file locally
+
+[source,ruby]
+----
+item = Relaton::Provider::Ietf.from_rfcxml File.read("rfc.xml")
+=> #<RelatonIetf::IetfBibliographicItem:0x007fa8cda79ab8
+...
+
+item.to_xml bibdata: true
+=>"<bibdata>
+...
+----
+
 == Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/metanorma/relaton-ietf.

data/lib/relaton/provider_ietf.rb

@@ -0,0 +1,15 @@
+module Relaton
+  module Provider
+    class Ietf
+      class << self
+        # @param xml [String]
+        # @return [RelatonIetf::IetfBibliographicItem]
+        def from_rfcxml(xml)
+          doc = Nokogiri::XML xml
+          reference = doc.at "/rfc"
+          RelatonIetf::Scrapper.bib_item reference, "rfc"
+        end
+      end
+    end
+  end
+end

data/lib/relaton_ietf.rb

@@ -9,3 +9,5 @@ if defined? Relaton
   require_relative "relaton/processor"
   Relaton::Registry.instance.register(Relaton::RelatonIetf::Processor)
 end
+
+require "relaton/provider_ietf"

data/lib/relaton_ietf/ietf_bibliographi_item.rb

@@ -3,8 +3,14 @@ module RelatonIetf
     # @return [String, NilClass]
     attr_reader :doctype
 
+    # @return [Array<String>]
+    attr_reader :keywords
+
+    # @param doctype [String]
+    # @param keywords [Array<String>]
     def initialize(**args)
       @doctype = args.delete :doctype
+      @keywords = args.delete(:keywords) || []
       super
     end
 
@@ -17,6 +23,7 @@ module RelatonIetf
         if opts[:bibdata]
           b.ext do
             b.doctype doctype if doctype
+            keywords.each { |k| b.keyword k }
           end
         end
       end

data/lib/relaton_ietf/scrapper.rb

@@ -51,8 +51,6 @@ module RelatonIetf
         end
       end
 
-      private
-
       # rubocop:disable Metrics/MethodLength
 
       # @return [RelatonIetf::IetfBibliographicItem]
@@ -66,14 +64,18 @@ module RelatonIetf
           script: ["Latn"],
           link: [{ type: "src", content: reference[:target] }],
           titles: titles(reference),
+          abstract: abstracts(reference),
           contributors: contributors(reference),
           dates: dates(reference),
           series: series(reference),
           doctype: doctype,
+          keywords: reference.xpath("front/keyword").map(&:text),
         )
       end
       # rubocop:enable Metrics/MethodLength
 
+      private
+
       # @return [String]
       def language(reference)
         reference[:lang] || "en"
@@ -85,6 +87,15 @@ module RelatonIetf
         [{ content: title.text, language: language(reference), script: "Latn" }]
       end
 
+      def abstracts(ref)
+        ref.xpath("./front/abstract").map do |a|
+          RelatonBib::FormattedString.new(
+            content: a.text.gsub(/\\n\\t{2,4}/, " ").strip,
+            language: language(ref), script: "Latn"
+          )
+        end
+      end
+
       # @return [Array<Hash>]
       def contributors(reference)
         persons(reference) + organizations(reference)
@@ -205,7 +216,7 @@ module RelatonIetf
       # @return [Array<RelatonBib::DocumentIdentifier>]
       #
       def docids(reference)
-        id = reference[:anchor].sub(/^(RFC)/, "\\1 ")
+        id = (reference[:anchor] || reference[:docName]).sub(/^(RFC)/, "\\1 ")
         ret = []
         ret << RelatonBib::DocumentIdentifier.new(type: "IETF", id: id)
         ret + reference.xpath("./seriesinfo").map do |si|

data/lib/relaton_ietf/version.rb

@@ -1,3 +1,3 @@
 module RelatonIetf
-  VERSION = "0.1.0".freeze
+  VERSION = "0.5.0".freeze
 end

data/relaton_ietf.gemspec

@@ -40,5 +40,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "vcr"
   spec.add_development_dependency "webmock"
 
-  spec.add_dependency "relaton-iso-bib", "~> 0.1.0"
+  spec.add_dependency "relaton-iso-bib", "~> 0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-ietf
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-05 00:00:00.000000000 Z
+date: 2019-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -156,14 +156,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.2.0
 description: "RelatonIetf: retrieve IETF Standards for bibliographic use \nusing the
   BibliographicItem model.\n\nFormerly known as rfcbib.\n"
 email:
@@ -186,6 +186,7 @@ files:
 - bin/console
 - bin/setup
 - lib/relaton/processor.rb
+- lib/relaton/provider_ietf.rb
 - lib/relaton_ietf.rb
 - lib/relaton_ietf/ietf_bibliographi_item.rb
 - lib/relaton_ietf/ietf_bibliography.rb
@@ -213,7 +214,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: 'RelatonIetf: retrieve IETF Standards for bibliographic use using the BibliographicItem